Devel Render

$0 array (6)

#node => Drupal\node\Entity\Node#1843 (35) $0['#node']

Entity Fields (35)
Properties (31)
Methods (136)
Static methods (19)
Static properties (1)
Class constants (9)
Iterator

nid -> string (4) "3009" $0['#node']->nid->value

uuid -> string (36) "531f50ef-e5d1-49fb-878b-ceb919606c86" $0['#node']->uuid->value

vid -> string (4) "2676" $0['#node']->vid->value

langcode -> string (3) "und" $0['#node']->langcode->value

type -> string (4) "blog" $0['#node']->type->target_id

revision_timestamp -> string (10) "1747342175" $0['#node']->revision_timestamp->value

2025-05-15T20:49:35+00:00

revision_uid -> string (4) "9934" $0['#node']->revision_uid->target_id

revision_log -> Drupal\Core\Field\FieldItemList#4537 (0) $0['#node']->revision_log

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

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

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

protected definition -> array (9)

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

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

protected string -> string (20) "Revision log message"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public count(): int Returns the string length.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

label string (20) "Revision log message"

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

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

protected string -> string (43) "Briefly describe the changes you have made."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public count(): int Returns the string length.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

description string (43) "Briefly describe the changes you have made."

revisionable => boolean true

default_value => array (1)

0 => array (1)

value => string (0) ""

display => array (1)

form => array (1)

options => array (3) Depth Limit

provider => string (4) "node"

field_name => string (12) "revision_log"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

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

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

protected definition -> array (2)
type => string (22) "field_item:string_long"
settings => array (1)
case_sensitive => boolean false
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4071 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

protected type -> string (11) "string_long"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setSettings(array $settings) {@inheritdoc}

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

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 */

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

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 */

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

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|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 (12) "revision_log"

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

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

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

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getEntity() {@inheritdoc} $0['#node']->revision_log->getEntity()

/**
 * {@inheritdoc}
 */

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

public setLangcode($langcode) {@inheritdoc} $0['#node']->revision_log->setLangcode()

/**
 * {@inheritdoc}
 */

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

public getLangcode() {@inheritdoc} $0['#node']->revision_log->getLangcode()

/**
 * {@inheritdoc}
 */

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

public getFieldDefinition() {@inheritdoc} $0['#node']->revision_log->getFieldDefinition()

/**
 * {@inheritdoc}
 */

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

public getSettings() {@inheritdoc} $0['#node']->revision_log->getSettings()

/**
 * {@inheritdoc}
 */

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

public getSetting($setting_name) {@inheritdoc} $0['#node']->revision_log->getSetting()

/**
 * {@inheritdoc}
 */

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

public filterEmptyItems() {@inheritdoc} $0['#node']->revision_log->filterEmptyItems()

/**
 * {@inheritdoc}
 */

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

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->revision_log->setValue()

/**
 * {@inheritdoc}
 */

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

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->revision_log->access()

/**
 * {@inheritdoc}
 */

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

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->revision_log->defaultAccess()

/**
 * {@inheritdoc}
 */

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

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->revision_log->applyDefaultValue()

/**
 * {@inheritdoc}
 */

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

public preSave() {@inheritdoc} $0['#node']->revision_log->preSave()

/**
 * {@inheritdoc}
 */

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

public postSave($update) {@inheritdoc} $0['#node']->revision_log->postSave()

/**
 * {@inheritdoc}
 */

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

public delete() {@inheritdoc} $0['#node']->revision_log->delete()

/**
 * {@inheritdoc}
 */

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

public deleteRevision() {@inheritdoc} $0['#node']->revision_log->deleteRevision()

/**
 * {@inheritdoc}
 */

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

protected delegateMethod($method): array Calls a method on each FieldItem.

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

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

public view($display_options = array()) {@inheritdoc} $0['#node']->revision_log->view()

/**
 * {@inheritdoc}
 */

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

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->revision_log->generateSampleItems()

/**
 * {@inheritdoc}
 */

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

public getConstraints() {@inheritdoc} $0['#node']->revision_log->getConstraints()

/**
 * {@inheritdoc}
 */

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

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->revision_log->defaultValuesForm()

/**
 * {@inheritdoc}
 */

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

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->revision_log->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

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

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->revision_log->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

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

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

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

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

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->revision_log->equals()

/**
 * {@inheritdoc}
 */

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

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->revision_log->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

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

public getValue() {@inheritdoc} $0['#node']->revision_log->getValue()

/**
 * {@inheritdoc}
 */

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

public getString() {@inheritdoc} $0['#node']->revision_log->getString()

/**
 * {@inheritdoc}
 */

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

public get($index) {@inheritdoc} $0['#node']->revision_log->get()

/**
 * {@inheritdoc}
 */

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

public set($index, $value) {@inheritdoc} $0['#node']->revision_log->set()

/**
 * {@inheritdoc}
 */

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

public removeItem($index) {@inheritdoc} $0['#node']->revision_log->removeItem()

/**
 * {@inheritdoc}
 */

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

protected rekey($from_index = 0) Renumbers the items in the list.

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

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

public first() {@inheritdoc} $0['#node']->revision_log->first()

/**
 * {@inheritdoc}
 */

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

public offsetExists($offset): bool {@inheritdoc} $0['#node']->revision_log->offsetExists()

/**
 * {@inheritdoc}
 */

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

public offsetUnset($offset): void {@inheritdoc} $0['#node']->revision_log->offsetUnset()

/**
 * {@inheritdoc}
 */

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

public offsetGet($offset): mixed {@inheritdoc} $0['#node']->revision_log->offsetGet()

/**
 * {@inheritdoc}
 */

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

public offsetSet($offset, $value): void {@inheritdoc} $0['#node']->revision_log->offsetSet()

/**
 * {@inheritdoc}
 */

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

public appendItem($value = null) {@inheritdoc} $0['#node']->revision_log->appendItem()

/**
 * {@inheritdoc}
 */

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

public getItemDefinition() {@inheritdoc} $0['#node']->revision_log->getItemDefinition()

/**
 * {@inheritdoc}
 */

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

public getIterator(): ArrayIterator {@inheritdoc} $0['#node']->revision_log->getIterator()

/**
 * {@inheritdoc}
 */

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

public count(): int {@inheritdoc} $0['#node']->revision_log->count()

/**
 * {@inheritdoc}
 */

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

public isEmpty() {@inheritdoc} $0['#node']->revision_log->isEmpty()

/**
 * {@inheritdoc}
 */

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

public filter($callback) {@inheritdoc} $0['#node']->revision_log->filter()

/**
 * {@inheritdoc}
 */

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

public onChange($delta) {@inheritdoc} $0['#node']->revision_log->onChange()

/**
 * {@inheritdoc}
 */

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

public __clone() Magic method: Implements a deep clone. clone $0['#node']->revision_log

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

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

public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc} $0['#node']->revision_log->last()

/**
 * {@inheritdoc}
 */

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

public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context. new \Drupal\Core\Field\FieldItemList()

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

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

public getPluginId() {@inheritdoc} $0['#node']->revision_log->getPluginId()

/**
 * {@inheritdoc}
 */

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

public getPluginDefinition() {@inheritdoc} $0['#node']->revision_log->getPluginDefinition()

/**
 * {@inheritdoc}
 */

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

public getDataDefinition() {@inheritdoc} $0['#node']->revision_log->getDataDefinition()

/**
 * {@inheritdoc}
 */

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

public validate() {@inheritdoc} $0['#node']->revision_log->validate()

/**
 * {@inheritdoc}
 */

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

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc} $0['#node']->revision_log->setContext()

/**
 * {@inheritdoc}
 */

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

public getName() {@inheritdoc} $0['#node']->revision_log->getName()

/**
 * {@inheritdoc}
 */

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

public getRoot() {@inheritdoc} $0['#node']->revision_log->getRoot()

/**
 * {@inheritdoc}
 */

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

public getPropertyPath() {@inheritdoc} $0['#node']->revision_log->getPropertyPath()

/**
 * {@inheritdoc}
 */

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

public getParent() {@inheritdoc} $0['#node']->revision_log->getParent()

/**
 * {@inheritdoc}
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

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

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

protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.

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

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

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

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

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

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

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

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

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use. $0['#node']->revision_log->setStringTranslation()

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

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

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager. $0['#node']->revision_log->setTypedDataManager()

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

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

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager. $0['#node']->revision_log->getTypedDataManager()

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

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

public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339
```
public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```
⇄
Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
iterator_to_array($0['#node']->revision_log, false)

status -> string (1) "0" $0['#node']->status->value

uid -> string (4) "9934" $0['#node']->uid->target_id

title -> string (55) "The Truth About Depression and the "Just Be Happy" Myth" $0['#node']->title->value

created -> string (10) "1706162726" $0['#node']->created->value

2024-01-25T06:05:26+00:00

changed -> string (10) "1779779521" $0['#node']->changed->value

2026-05-26T07:12:01+00:00

promote -> string (1) "0" $0['#node']->promote->value

sticky -> string (1) "0" $0['#node']->sticky->value

default_langcode -> string (1) "1" $0['#node']->default_langcode->value

revision_default -> string (1) "1" $0['#node']->revision_default->value

revision_translation_affected -> string (1) "1" $0['#node']->revision_translation_affected->value

moderation_state -> Drupal\content_moderation\Plugin\Field\ModerationStateFieldItemList#4606 (0) $0['#node']->moderation_state

No values
Properties (10)
Methods (75)
Static methods (2)
Iterator

No values uninitialized

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

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

protected definition -> array (12)

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

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

protected string -> string (16) "Moderation state"
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 (16) "Moderation state"

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

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

protected string -> string (46) "The moderation state of this piece of content."
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 (46) "The moderation state of this piece of content."

computed => boolean true

class => string (67) "Drupal\content_moderation\Plugin\Field\ModerationStateFieldItemList"

display => array (2)

Table (2)
Contents (2)

 options configurable
view array (3) Depth Limit false
form array (3) Depth Limit true

view => array (2)
options => array (3) Depth Limit
configurable => boolean false
form => array (2)
options => array (3) Depth Limit
configurable => boolean true

	options	configurable
view	`array` (3) `Depth Limit`	`false`
form	`array` (3) `Depth Limit`	`true`

constraints => array (1)

ModerationState => array (0)

read-only => boolean false

translatable => boolean true

provider => string (18) "content_moderation"

field_name => string (16) "moderation_state"

entity_type => string (4) "node"

bundle => string (4) "blog"

protected typedDataManager -> null

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

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

protected definition -> array (2)
type => string (17) "field_item:string"
settings => array (3)
max_length => integer 255
is_ascii => boolean false
case_sensitive => boolean false
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4167 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

protected type -> string (6) "string"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setSettings(array $settings) {@inheritdoc}

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

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 */

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

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 */

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

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

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

/**
 * {@inheritdoc}
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

/**
 * 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 (16) "moderation_state"

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

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

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

protected list -> array (0)

protected langcode -> string (3) "und"

protected valueComputed -> boolean true

protected computeValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:25

protected getModerationStateId(): string|null Gets the moderation state ID linked to a content entity revision.

/**
 * Gets the moderation state ID linked to a content entity revision.
 *
 * @return string|null
 *   The moderation state ID linked to a content entity revision.
 */

Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:42

protected loadContentModerationStateRevision(Drupal\Core\Entity\ContentEntityInterface $entity): \Drupal\content_moderation\Entity\ContentModerationStateInterface|null Load the content moderation state revision associated with an entity.

/**
 * Load the content moderation state revision associated with an entity.
 *
 * @param \Drupal\Core\Entity\ContentEntityInterface $entity
 *   The entity the content moderation state entity will be loaded from.
 *
 * @return \Drupal\content_moderation\Entity\ContentModerationStateInterface|null
 *   The content_moderation_state revision or FALSE if none exists.
 */

Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:73

public get($index) {@inheritdoc} $0['#node']->moderation_state->get()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:118

public onChange($delta) {@inheritdoc} $0['#node']->moderation_state->onChange()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:128

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->moderation_state->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:137

protected updateModeratedEntity($moderation_state_id) Updates the default revision flag and the publishing status of the entity.

/**
 * Updates the default revision flag and the publishing status of the entity.
 *
 * @param string $moderation_state_id
 *   The ID of the new moderation state.
 */

Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:155

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->moderation_state->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:189

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getEntity() {@inheritdoc} $0['#node']->moderation_state->getEntity()

/**
 * {@inheritdoc}
 */

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

public setLangcode($langcode) {@inheritdoc} $0['#node']->moderation_state->setLangcode()

/**
 * {@inheritdoc}
 */

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

public getLangcode() {@inheritdoc} $0['#node']->moderation_state->getLangcode()

/**
 * {@inheritdoc}
 */

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

public getFieldDefinition() {@inheritdoc} $0['#node']->moderation_state->getFieldDefinition()

/**
 * {@inheritdoc}
 */

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

public getSettings() {@inheritdoc} $0['#node']->moderation_state->getSettings()

/**
 * {@inheritdoc}
 */

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

public getSetting($setting_name) {@inheritdoc} $0['#node']->moderation_state->getSetting()

/**
 * {@inheritdoc}
 */

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

public filterEmptyItems() {@inheritdoc} $0['#node']->moderation_state->filterEmptyItems()

/**
 * {@inheritdoc}
 */

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

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->moderation_state->access()

/**
 * {@inheritdoc}
 */

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

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->moderation_state->defaultAccess()

/**
 * {@inheritdoc}
 */

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

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->moderation_state->applyDefaultValue()

/**
 * {@inheritdoc}
 */

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

public preSave() {@inheritdoc} $0['#node']->moderation_state->preSave()

/**
 * {@inheritdoc}
 */

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

public postSave($update) {@inheritdoc} $0['#node']->moderation_state->postSave()

/**
 * {@inheritdoc}
 */

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

public delete() {@inheritdoc} $0['#node']->moderation_state->delete()

/**
 * {@inheritdoc}
 */

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

public deleteRevision() {@inheritdoc} $0['#node']->moderation_state->deleteRevision()

/**
 * {@inheritdoc}
 */

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

protected delegateMethod($method): array Calls a method on each FieldItem.

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

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

public view($display_options = array()) {@inheritdoc} $0['#node']->moderation_state->view()

/**
 * {@inheritdoc}
 */

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

public getConstraints() {@inheritdoc} $0['#node']->moderation_state->getConstraints()

/**
 * {@inheritdoc}
 */

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

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->moderation_state->defaultValuesForm()

/**
 * {@inheritdoc}
 */

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

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->moderation_state->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

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

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->moderation_state->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

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

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

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

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

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->moderation_state->equals()

/**
 * {@inheritdoc}
 */

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

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->moderation_state->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

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

public getValue() {@inheritdoc} $0['#node']->moderation_state->getValue()

/**
 * {@inheritdoc}
 */

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

public getString() {@inheritdoc} $0['#node']->moderation_state->getString()

/**
 * {@inheritdoc}
 */

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

public set($index, $value) {@inheritdoc} $0['#node']->moderation_state->set()

/**
 * {@inheritdoc}
 */

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

public removeItem($index) {@inheritdoc} $0['#node']->moderation_state->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['#node']->moderation_state->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['#node']->moderation_state->offsetExists()

/**
 * {@inheritdoc}
 */

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

public offsetUnset($offset): void {@inheritdoc} $0['#node']->moderation_state->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['#node']->moderation_state->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['#node']->moderation_state->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['#node']->moderation_state->appendItem()

/**
 * {@inheritdoc}
 */

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

public getItemDefinition() {@inheritdoc} $0['#node']->moderation_state->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['#node']->moderation_state->getIterator()

/**
 * {@inheritdoc}
 */

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

public count(): int {@inheritdoc} $0['#node']->moderation_state->count()

/**
 * {@inheritdoc}
 */

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

public isEmpty() {@inheritdoc} $0['#node']->moderation_state->isEmpty()

/**
 * {@inheritdoc}
 */

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

public filter($callback) {@inheritdoc} $0['#node']->moderation_state->filter()

/**
 * {@inheritdoc}
 */

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

public __clone() Magic method: Implements a deep clone. clone $0['#node']->moderation_state

/**
 * 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['#node']->moderation_state->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['#node']->moderation_state->getPluginId()

/**
 * {@inheritdoc}
 */

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

public getPluginDefinition() {@inheritdoc} $0['#node']->moderation_state->getPluginDefinition()

/**
 * {@inheritdoc}
 */

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

public getDataDefinition() {@inheritdoc} $0['#node']->moderation_state->getDataDefinition()

/**
 * {@inheritdoc}
 */

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

public validate() {@inheritdoc} $0['#node']->moderation_state->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['#node']->moderation_state->setContext()

/**
 * {@inheritdoc}
 */

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

public getName() {@inheritdoc} $0['#node']->moderation_state->getName()

/**
 * {@inheritdoc}
 */

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

public getRoot() {@inheritdoc} $0['#node']->moderation_state->getRoot()

/**
 * {@inheritdoc}
 */

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

public getPropertyPath() {@inheritdoc} $0['#node']->moderation_state->getPropertyPath()

/**
 * {@inheritdoc}
 */

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

public getParent() {@inheritdoc} $0['#node']->moderation_state->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

/**
 * 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['#node']->moderation_state->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['#node']->moderation_state->getTypedDataManager()

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

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

protected ensureComputedValue() Ensures that values are only computed once.

/**
 * Ensures that values are only computed once.
 */

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

public traitGet($index) {@inheritdoc} $0['#node']->moderation_state->traitGet()

/**
 * {@inheritdoc}
 */

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

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['#node']->moderation_state, false)

metatag -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#4608 (3) $0['#node']->metatag

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

0 => array (2)
$0['#node']->metatag->getValue()[0]
tag => string (4) "meta"
$0['#node']->metatag->getValue()[0]['tag']
attributes => array (2)
$0['#node']->metatag->getValue()[0]['attributes']
name => string (5) "title"
$0['#node']->metatag->getValue()[0]['attributes']['name']
content => string (72) "The Truth About Depression and the "Just Be Happy" Myth | Counselling BC"
$0['#node']->metatag->getValue()[0]['attributes']['content']
1 => array (2)
$0['#node']->metatag->getValue()[1]
tag => string (4) "meta"
$0['#node']->metatag->getValue()[1]['tag']
attributes => array (2)
$0['#node']->metatag->getValue()[1]['attributes']
name => string (11) "description"
$0['#node']->metatag->getValue()[1]['attributes']['name']
content => string (466) "Millions of people all over the world are affected by depression. However, d...
$0['#node']->metatag->getValue()[1]['attributes']['content']
Millions of people all over the world are affected by depression. However, despite its prevalence, misconceptions and misunderstandings about this condition persist, leading to ineffective and potentially harmful advice. One common myth is the notion that telling someone with depression to "just be happy" or to think positively will magically alleviate their symptoms. However, as mental health professionals and experts emphasize, the reality is far more complex.
2 => array (2)
$0['#node']->metatag->getValue()[2]
tag => string (4) "link"
$0['#node']->metatag->getValue()[2]['tag']
attributes => array (2)
$0['#node']->metatag->getValue()[2]['attributes']
rel => string (9) "canonical"
$0['#node']->metatag->getValue()[2]['attributes']['rel']
href => string (114) "https://counsellingbc-next-develop-john.seed.fuseinteractive.ca/blog/truth-a...
$0['#node']->metatag->getValue()[2]['attributes']['href']
https://counsellingbc-next-develop-john.seed.fuseinteractive.ca/blog/truth-about-depression-and-just-be-happy-myth

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

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

protected definition -> array (10)

label => Drupal\Core\StringTranslation\TranslatableMarkup#4128 (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#4129 (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 (4) "node"

cardinality => integer -1

provider => string (7) "metatag"

field_name => string (7) "metatag"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4130 (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#4127 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#6456 (2)

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

protected definition -> array (3)
type => string (6) "string"
label => Drupal\Core\StringTranslation\TranslatableMarkup#6458 Depth Limit
required => boolean true
protected typedDataManager -> null

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

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

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

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

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

attributes => Drupal\Core\TypedData\MapDataDefinition#7173 (4)

Properties (4)
Methods (39)
Static methods (4)

protected definition -> array (3)
type => string (3) "map"
label => Drupal\Core\StringTranslation\TranslatableMarkup#6449 Depth Limit
required => boolean true
protected typedDataManager -> null
protected propertyDefinitions -> null
protected mainPropertyName -> null

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:40

public setPropertyDefinition($name, ?Drupal\Core\TypedData\DataDefinitionInterface $definition = null): $this Sets the definition of a map property.

/**
 * Sets the definition of a map property.
 *
 * @param string $name
 *   The name of the property to define.
 * @param \Drupal\Core\TypedData\DataDefinitionInterface|null $definition
 *   (optional) The property definition to set, or NULL to unset it.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:57

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:70

public setMainPropertyName($name): $this Sets the main property name.

/**
 * Sets the main property name.
 *
 * @param string|null $name
 *   The name of the main property, or NULL if there is none.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:82

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:25

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:42

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\MapDataDefinition::create($type = 'map'): static Creates a new map definition.

/**
 * Creates a new map definition.
 *
 * @param string $type
 *   (optional) The data type of the map. Defaults to 'map'.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:25

public static Drupal\Core\TypedData\MapDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:33

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (3)

0 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#7060 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4130 (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#4127 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10) Depth Limit
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4130 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2) Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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#4608 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (2)

name => string (5) "title"

content => string (72) "The Truth About Depression and the "Just Be Happy" Myth | Counselling BC"

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

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#7058 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4130 (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#4127 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10) Depth Limit
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4130 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2) Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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#4608 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (2)

name => string (11) "description"

content => string (466) "Millions of people all over the world are affected by depression. However, d...

Millions of people all over the world are affected by depression. However, despite its prevalence, misconceptions and misunderstandings about this condition persist, leading to ineffective and potentially harmful advice. One common myth is the notion that telling someone with depression to "just be happy" or to think positively will magically alleviate their symptoms. However, as mental health professionals and experts emphasize, the reality is far more complex.

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#7059 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4130 (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#4127 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10) Depth Limit
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4130 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2) Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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#4608 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected values -> array (2)

tag => string (4) "link"

attributes => array (2)

rel => string (9) "canonical"

href => string (114) "https://counsellingbc-next-develop-john.seed.fuseinteractive.ca/blog/truth-a...

https://counsellingbc-next-develop-john.seed.fuseinteractive.ca/blog/truth-about-depression-and-just-be-happy-myth

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 (3) "und"

protected metatagsGenerated -> boolean true

protected valueComputed -> boolean true

protected valueNeedsRecomputing() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/MetatagEntityFieldItemList.php:30

protected computeValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/MetatagEntityFieldItemList.php:37

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->metatag->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->metatag->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->metatag->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->metatag->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->metatag->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->metatag->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->metatag->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->metatag->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->metatag->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->metatag->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->metatag->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:145

public preSave() {@inheritdoc} $0['#node']->metatag->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->metatag->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->metatag->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->metatag->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->metatag->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->metatag->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->metatag->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->metatag->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->metatag->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->metatag->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->metatag->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->metatag->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->metatag->getValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42

public getString() {@inheritdoc} $0['#node']->metatag->getString()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61

public get($index) {@inheritdoc} $0['#node']->metatag->get()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69

public set($index, $value) {@inheritdoc} $0['#node']->metatag->set()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89

public removeItem($index) {@inheritdoc} $0['#node']->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['#node']->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['#node']->metatag->offsetExists()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:121

public offsetUnset($offset): void {@inheritdoc} $0['#node']->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['#node']->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['#node']->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['#node']->metatag->appendItem()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97

public getItemDefinition() {@inheritdoc} $0['#node']->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['#node']->metatag->getIterator()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:129

public count(): int {@inheritdoc} $0['#node']->metatag->count()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:137

public isEmpty() {@inheritdoc} $0['#node']->metatag->isEmpty()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113

public filter($callback) {@inheritdoc} $0['#node']->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['#node']->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['#node']->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['#node']->metatag->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['#node']->metatag->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->metatag->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->metatag->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->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['#node']->metatag->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->metatag->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->metatag->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->metatag->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->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['#node']->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['#node']->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['#node']->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['#node']->metatag, false)

path -> Drupal\pathauto\PathautoFieldItemList#4610 (3) $0['#node']->path

Field properties (3)
Properties (10)
Methods (71)
Static methods (2)
Iterator

alias -> string (51) "/blog/truth-about-depression-and-just-be-happy-myth"
$0['#node']->path->alias
pid -> string (4) "7105"
$0['#node']->path->pid
langcode -> string (3) "und"
$0['#node']->path->langcode

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4131 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (8)

label => Drupal\Core\StringTranslation\TranslatableMarkup#4132 (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 (9) "URL alias"

translatable => boolean true

display => array (1)

form => array (2)

options => array (2) Depth Limit

configurable => boolean true

computed => boolean true

provider => string (4) "path"

field_name => string (4) "path"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4133 (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#4131 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (4) "path"

protected propertyDefinitions -> array (4)

alias => Drupal\Core\TypedData\DataDefinition#7084 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (2)
type => string (6) "string"
label => Drupal\Core\StringTranslation\TranslatableMarkup#7096 Depth Limit
protected typedDataManager -> null

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

pid => Drupal\Core\TypedData\DataDefinition#7468 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (2)
type => string (7) "integer"
label => Drupal\Core\StringTranslation\TranslatableMarkup#7452 Depth Limit
protected typedDataManager -> null

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

langcode => Drupal\Core\TypedData\DataDefinition#7464 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (2)
type => string (6) "string"
label => Drupal\Core\StringTranslation\TranslatableMarkup#7451 Depth Limit
protected typedDataManager -> null

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

pathauto => Drupal\Core\TypedData\DataDefinition#7450 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (5)
type => string (7) "integer"
label => Drupal\Core\StringTranslation\TranslatableMarkup#7449 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#7446 Depth Limit
computed => boolean true
class => string (30) "\Drupal\pathauto\PathautoState"
protected typedDataManager -> null

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (4) "path"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (1)

0 => Drupal\pathauto\PathautoItem#8598 (9)

Properties (9)
Methods (49)
Static methods (21)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4133 (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#4131 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (8) Depth Limit
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4133 Recursion
protected type -> string (4) "path"
protected propertyDefinitions -> array (4) Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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\pathauto\PathautoFieldItemList#4610 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected values -> array (3)

alias => string (51) "/blog/truth-about-depression-and-just-be-happy-myth"

pid => string (4) "7105"

langcode => string (3) "und"

protected properties -> array (1)

pathauto => Drupal\pathauto\PathautoState#8599 (9)

Properties (9)
Methods (29)
Static methods (3)
Class constants (2)

protected definition -> Drupal\Core\TypedData\DataDefinition#7450 Depth Limit
protected name -> string (8) "pathauto"
protected parent -> Drupal\pathauto\PathautoItem#8598 Recursion
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)
protected stringTranslation -> null
protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted
protected value -> null
protected originalValue -> null

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:47

protected getOriginalValue(): mixed Gets the data value currently stored in database.

/**
 * Gets the data value currently stored in database.
 *
 * @return mixed
 *   The data value.
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:68

public setValue($value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:86

public hasValue() Returns TRUE if a value was set.

/**
 * Returns TRUE if a value was set.
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:97

public persist() Persists the state.

/**
 * Persists the state.
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:104

public purge() Deletes the stored state.

/**
 * Deletes the stored state.
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:117

protected getCollection(): string Returns the key value collection that should be used for the given entity.

/**
 * Returns the key value collection that should be used for the given entity.
 *
 * @return string
 *   The key value collection name.
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:128

/**
 * 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}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:112

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:138

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * 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\pathauto\PathautoState::bulkDelete($entity_type_id, array $pids_by_id) Deletes the URL aliases for multiple entities of the same type.

/**
 * Deletes the URL aliases for multiple entities of the same type.
 *
 * @param string $entity_type_id
 *   The entity type ID of entities being deleted.
 * @param int[] $pids_by_id
 *   A list of path IDs keyed by entity ID.
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:140

public static Drupal\pathauto\PathautoState::getPathautoStateKey($entity_id): int|string Gets the key-value store entry key for 'pathauto_state.*' collections.

/**
 * Gets the key-value store entry key for 'pathauto_state.*' collections.
 *
 * Normally we want to use the entity ID as key for 'pathauto_state.*'
 * collection entries. But some entity types may use string IDs. When such IDs
 * are exceeding 128 characters, which is the limit for the 'name' column in
 * the {key_value} table, the insertion of the ID in {key_value} will fail.
 * Thus we test if we can use the plain ID or we need to store a hashed
 * version of the entity ID. Also, it is not possible to rely on the UUID as
 * entity types might not have one or might use a non-standard format.
 *
 * The code is inspired by
 * \Drupal\Core\Cache\DatabaseBackend::normalizeCid().
 *
 * @param int|string $entity_id
 *   The entity id for which to compute the key.
 *
 * @return int|string
 *   The key used to store the value in the key-value store.
 *
 * @see \Drupal\Core\Cache\DatabaseBackend::normalizeCid()
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:184

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

public const Drupal\pathauto\PathautoState::SKIP :: integer 0
public const Drupal\pathauto\PathautoState::CREATE :: integer 1

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoItem.php:30

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoItem.php:43

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathItem
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:61

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php: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\pathauto\PathautoItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoItem.php:17

public static Drupal\path\Plugin\Field\FieldType\PathItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:43

public static Drupal\path\Plugin\Field\FieldType\PathItem::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:134

public static Drupal\path\Plugin\Field\FieldType\PathItem::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:143

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

public static Drupal\path\Plugin\Field\FieldType\PathItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:30

public static Drupal\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

/**
 * 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 (3) "und"

protected valueComputed -> boolean true

protected delegateMethod($method) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoFieldItemList.php:20

protected computeValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/pathauto/src/PathautoFieldItemList.php:40

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->path->defaultAccess()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:48

public delete() {@inheritdoc} $0['#node']->path->delete()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:58

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->path->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->path->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->path->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->path->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->path->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->path->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->path->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->path->setValue()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->path->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->path->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:145

public preSave() {@inheritdoc} $0['#node']->path->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->path->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public deleteRevision() {@inheritdoc} $0['#node']->path->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

public view($display_options = array()) {@inheritdoc} $0['#node']->path->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->path->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->path->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->path->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->path->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->path->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->path->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->path->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->path->getValue()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42

public getString() {@inheritdoc} $0['#node']->path->getString()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61

public get($index) {@inheritdoc} $0['#node']->path->get()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69

public set($index, $value) {@inheritdoc} $0['#node']->path->set()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89

public removeItem($index) {@inheritdoc} $0['#node']->path->removeItem()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
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['#node']->path->first()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171

public offsetExists($offset): bool {@inheritdoc} $0['#node']->path->offsetExists()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:121

public offsetUnset($offset): void {@inheritdoc} $0['#node']->path->offsetUnset()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186

public offsetGet($offset): mixed {@inheritdoc} $0['#node']->path->offsetGet()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193

public offsetSet($offset, $value): void {@inheritdoc} $0['#node']->path->offsetSet()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200

public appendItem($value = null) {@inheritdoc} $0['#node']->path->appendItem()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97

public getItemDefinition() {@inheritdoc} $0['#node']->path->getItemDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233

public getIterator(): ArrayIterator {@inheritdoc} $0['#node']->path->getIterator()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:129

public count(): int {@inheritdoc} $0['#node']->path->count()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:137

public isEmpty() {@inheritdoc} $0['#node']->path->isEmpty()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113

public filter($callback) {@inheritdoc} $0['#node']->path->filter()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272

public onChange($delta) {@inheritdoc} $0['#node']->path->onChange()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294

public __clone() Magic method: Implements a deep clone. clone $0['#node']->path

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304

public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc} $0['#node']->path->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['#node']->path->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->path->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->path->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->path->validate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc} $0['#node']->path->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->path->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->path->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->path->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->path->getParent()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * 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['#node']->path->setStringTranslation()

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager. $0['#node']->path->setTypedDataManager()

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager. $0['#node']->path->getTypedDataManager()

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

protected ensureComputedValue() Ensures that values are only computed once.

/**
 * Ensures that values are only computed once.
 */

Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:32

public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339
```
public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```
⇄
Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
iterator_to_array($0['#node']->path, false)

rh_action -> Drupal\Core\Field\FieldItemList#4612 (0) $0['#node']->rh_action

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4134 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (7)

field_name => string (9) "rh_action"

label => Drupal\Core\StringTranslation\TranslatableMarkup#4135 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (18) "Rabbit Hole action"
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 (18) "Rabbit Hole action"

description => Drupal\Core\StringTranslation\TranslatableMarkup#4136 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (52) "Specifies which action that Rabbit Hole should take."
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 (52) "Specifies which action that Rabbit Hole should take."

translatable => boolean true

provider => string (7) "rh_node"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4137 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (17) "field_item:string"
settings => array (3)
max_length => integer 255
is_ascii => boolean false
case_sensitive => boolean false
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4134 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (6) "string"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (9) "rh_action"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->rh_action->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->rh_action->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->rh_action->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->rh_action->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->rh_action->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->rh_action->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->rh_action->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->rh_action->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->rh_action->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->rh_action->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->rh_action->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->rh_action->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->rh_action->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->rh_action->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->rh_action->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->rh_action->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->rh_action->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->rh_action->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_action->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_action->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_action->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->rh_action->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->rh_action->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action

/**
 * 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['#node']->rh_action->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['#node']->rh_action->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->rh_action->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->rh_action->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->rh_action->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['#node']->rh_action->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->rh_action->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->rh_action->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->rh_action->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action->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['#node']->rh_action, false)

rh_redirect -> Drupal\Core\Field\FieldItemList#4614 (0) $0['#node']->rh_redirect

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4138 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (7)

field_name => string (11) "rh_redirect"

label => Drupal\Core\StringTranslation\TranslatableMarkup#4139 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (26) "Rabbit Hole redirect path."
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 (26) "Rabbit Hole redirect path."

description => Drupal\Core\StringTranslation\TranslatableMarkup#4140 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (52) "The path to where the user should get redirected to."
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 (52) "The path to where the user should get redirected to."

translatable => boolean true

provider => string (7) "rh_node"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4141 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (17) "field_item:string"
settings => array (3)
max_length => integer 255
is_ascii => boolean false
case_sensitive => boolean false
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4138 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (6) "string"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (11) "rh_redirect"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->rh_redirect->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->rh_redirect->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->rh_redirect->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->rh_redirect->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->rh_redirect->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->rh_redirect->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->rh_redirect->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->rh_redirect->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->rh_redirect->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->rh_redirect->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->rh_redirect->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->rh_redirect->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->rh_redirect->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->rh_redirect->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->rh_redirect->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->rh_redirect->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->rh_redirect->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->rh_redirect->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_redirect->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_redirect->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_redirect->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->rh_redirect->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->rh_redirect->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect

/**
 * 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['#node']->rh_redirect->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['#node']->rh_redirect->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->rh_redirect->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->rh_redirect->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->rh_redirect->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['#node']->rh_redirect->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->rh_redirect->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->rh_redirect->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->rh_redirect->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->rh_redirect->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

/**
 * 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['#node']->rh_redirect->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['#node']->rh_redirect->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['#node']->rh_redirect, false)

rh_redirect_response -> Drupal\Core\Field\FieldItemList#4616 (0) $0['#node']->rh_redirect_response

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4142 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (7)

field_name => string (20) "rh_redirect_response"

label => Drupal\Core\StringTranslation\TranslatableMarkup#4143 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (34) "Rabbit Hole redirect response code"
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 (34) "Rabbit Hole redirect response code"

description => Drupal\Core\StringTranslation\TranslatableMarkup#4144 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (77) "Specifies the HTTP response code that should be used when perform a redirect."
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 (77) "Specifies the HTTP response code that should be used when perform a redirect."

translatable => boolean true

provider => string (7) "rh_node"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4145 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (18) "field_item:integer"
settings => array (6)
unsigned => boolean false
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#4142 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (7) "integer"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (20) "rh_redirect_response"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->rh_redirect_response->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->rh_redirect_response->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->rh_redirect_response->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->rh_redirect_response->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->rh_redirect_response->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->rh_redirect_response->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->rh_redirect_response->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->rh_redirect_response->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->rh_redirect_response->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->rh_redirect_response->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->rh_redirect_response->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->rh_redirect_response->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->rh_redirect_response->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->rh_redirect_response->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->rh_redirect_response->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->rh_redirect_response->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->rh_redirect_response->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->rh_redirect_response->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_redirect_response->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_redirect_response->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_redirect_response->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->rh_redirect_response->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->rh_redirect_response->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response

/**
 * 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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->rh_redirect_response->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->rh_redirect_response->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->rh_redirect_response->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['#node']->rh_redirect_response->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->rh_redirect_response->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->rh_redirect_response->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->rh_redirect_response->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->rh_redirect_response->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

/**
 * 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['#node']->rh_redirect_response->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['#node']->rh_redirect_response->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['#node']->rh_redirect_response, false)

rh_redirect_fallback_action -> Drupal\Core\Field\FieldItemList#4618 (0) $0['#node']->rh_redirect_fallback_action

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4146 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (7)

field_name => string (27) "rh_redirect_fallback_action"

label => Drupal\Core\StringTranslation\TranslatableMarkup#4147 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (36) "Rabbit Hole redirect fallback action"
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 (36) "Rabbit Hole redirect fallback action"

description => Drupal\Core\StringTranslation\TranslatableMarkup#4148 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (84) "Specifies the action that should be used when the redirect path is invalid o...
```
Specifies the action that should be used when the redirect path is invalid or empty.
```
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 (84) "Specifies the action that should be used when the redirect path is invalid o...
```
Specifies the action that should be used when the redirect path is invalid or empty.
```

translatable => boolean true

provider => string (7) "rh_node"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4149 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (17) "field_item:string"
settings => array (3)
max_length => integer 255
is_ascii => boolean false
case_sensitive => boolean false
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4146 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (6) "string"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (27) "rh_redirect_fallback_action"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->rh_redirect_fallback_action->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action

/**
 * 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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->rh_redirect_fallback_action->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

/**
 * 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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action->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['#node']->rh_redirect_fallback_action, false)

publish_on -> Drupal\Core\Field\FieldItemList#4620 (0) $0['#node']->publish_on

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4150 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#4151 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (10) "Publish 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

label string (10) "Publish on"

display => array (1)

form => array (2)

options => array (2) Depth Limit

configurable => boolean true

translatable => boolean true

revisionable => boolean true

constraints => array (1)

SchedulerPublishOn => null

provider => string (9) "scheduler"

field_name => string (10) "publish_on"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4152 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (20) "field_item:timestamp"
settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4150 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 (9) "timestamp"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (10) "publish_on"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->publish_on->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->publish_on->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->publish_on->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->publish_on->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->publish_on->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->publish_on->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->publish_on->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->publish_on->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->publish_on->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->publish_on->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->publish_on->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->publish_on->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->publish_on->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->publish_on->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->publish_on->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->publish_on->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->publish_on->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->publish_on->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->publish_on->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->publish_on->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->publish_on->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->publish_on->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->publish_on->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on

/**
 * 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['#node']->publish_on->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['#node']->publish_on->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->publish_on->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->publish_on->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->publish_on->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['#node']->publish_on->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->publish_on->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->publish_on->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->publish_on->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on->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['#node']->publish_on, false)

unpublish_on -> Drupal\Core\Field\FieldItemList#4622 (0) $0['#node']->unpublish_on

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4153 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#4154 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (12) "Unpublish 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

label string (12) "Unpublish on"

display => array (1)

form => array (2)

options => array (2) Depth Limit

configurable => boolean true

translatable => boolean true

revisionable => boolean true

constraints => array (1)

SchedulerUnpublishOn => null

provider => string (9) "scheduler"

field_name => string (12) "unpublish_on"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4155 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (20) "field_item:timestamp"
settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4153 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 (9) "timestamp"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (12) "unpublish_on"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->unpublish_on->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->unpublish_on->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->unpublish_on->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->unpublish_on->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->unpublish_on->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->unpublish_on->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->unpublish_on->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->unpublish_on->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->unpublish_on->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->unpublish_on->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->unpublish_on->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->unpublish_on->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->unpublish_on->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->unpublish_on->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->unpublish_on->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->unpublish_on->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->unpublish_on->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->unpublish_on->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->unpublish_on->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->unpublish_on->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->unpublish_on->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->unpublish_on->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->unpublish_on->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on

/**
 * 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['#node']->unpublish_on->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['#node']->unpublish_on->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->unpublish_on->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->unpublish_on->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->unpublish_on->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['#node']->unpublish_on->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->unpublish_on->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->unpublish_on->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->unpublish_on->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->unpublish_on->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

/**
 * 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['#node']->unpublish_on->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['#node']->unpublish_on->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['#node']->unpublish_on, false)

publish_state -> Drupal\Core\Field\FieldItemList#4624 (0) $0['#node']->publish_state

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4156 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#4157 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (13) "Publish state"
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 (13) "Publish state"

display => array (2)

Table (2)
Contents (2)

 options configurable
view array (3) Depth Limit false
form array (2) Depth Limit true

view => array (2)
options => array (3) Depth Limit
configurable => boolean false
form => array (2)
options => array (2) Depth Limit
configurable => boolean true

	options	configurable
view	`array` (3) `Depth Limit`	`false`
form	`array` (2) `Depth Limit`	`true`

translatable => boolean true

revisionable => boolean true

constraints => array (2)

SchedulerPublishState => null

SchedulerModerationTransitionAccess => null

provider => string (40) "scheduler_content_moderation_integration"

field_name => string (13) "publish_state"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4158 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (22) "field_item:list_string"
settings => array (2)
allowed_values => array (0)
allowed_values_function => string (55) "_scheduler_content_moderation_integration_states_values"
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4156 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (11) "list_string"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (13) "publish_state"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->publish_state->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->publish_state->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->publish_state->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->publish_state->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->publish_state->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->publish_state->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->publish_state->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->publish_state->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->publish_state->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->publish_state->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->publish_state->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->publish_state->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->publish_state->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->publish_state->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->publish_state->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->publish_state->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->publish_state->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->publish_state->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->publish_state->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->publish_state->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->publish_state->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->publish_state->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->publish_state->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state

/**
 * 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['#node']->publish_state->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['#node']->publish_state->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->publish_state->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->publish_state->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->publish_state->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['#node']->publish_state->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->publish_state->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->publish_state->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->publish_state->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->publish_state->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

/**
 * 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['#node']->publish_state->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['#node']->publish_state->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['#node']->publish_state, false)

unpublish_state -> Drupal\Core\Field\FieldItemList#4626 (0) $0['#node']->unpublish_state

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4159 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#4160 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (15) "Unpublish state"
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 (15) "Unpublish state"

display => array (2)

Table (2)
Contents (2)

 options configurable
view array (3) Depth Limit false
form array (2) Depth Limit true

view => array (2)
options => array (3) Depth Limit
configurable => boolean false
form => array (2)
options => array (2) Depth Limit
configurable => boolean true

	options	configurable
view	`array` (3) `Depth Limit`	`false`
form	`array` (2) `Depth Limit`	`true`

translatable => boolean true

revisionable => boolean true

constraints => array (2)

SchedulerUnPublishState => null

SchedulerModerationTransitionAccess => null

provider => string (40) "scheduler_content_moderation_integration"

field_name => string (15) "unpublish_state"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4161 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (22) "field_item:list_string"
settings => array (2)
allowed_values => array (0)
allowed_values_function => string (55) "_scheduler_content_moderation_integration_states_values"
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4159 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (11) "list_string"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (15) "unpublish_state"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->unpublish_state->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->unpublish_state->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->unpublish_state->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->unpublish_state->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->unpublish_state->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->unpublish_state->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->unpublish_state->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->unpublish_state->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->unpublish_state->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->unpublish_state->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->unpublish_state->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->unpublish_state->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->unpublish_state->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->unpublish_state->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->unpublish_state->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->unpublish_state->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->unpublish_state->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->unpublish_state->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->unpublish_state->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->unpublish_state->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->unpublish_state->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->unpublish_state->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->unpublish_state->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state

/**
 * 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['#node']->unpublish_state->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['#node']->unpublish_state->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->unpublish_state->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->unpublish_state->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->unpublish_state->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['#node']->unpublish_state->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->unpublish_state->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->unpublish_state->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->unpublish_state->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->unpublish_state->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

/**
 * 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['#node']->unpublish_state->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['#node']->unpublish_state->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['#node']->unpublish_state, false)

menu_link -> Drupal\token\MenuLinkFieldItemList#4628 (0) $0['#node']->menu_link

No values
Properties (10)
Methods (72)
Static methods (3)
Iterator

No values uninitialized

protected definition -> Drupal\Core\Field\BaseFieldDefinition#4162 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (12)

label => Drupal\Core\StringTranslation\TranslatableMarkup#4163 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (9) "Menu link"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * 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) "Menu link"

description => Drupal\Core\StringTranslation\TranslatableMarkup#4164 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (68) "Computed menu link for the node (only available during node saving)."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * 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 (68) "Computed menu link for the node (only available during node saving)."

revisionable => boolean true

class => string (35) "\Drupal\token\MenuLinkFieldItemList"

translatable => boolean true

internal => boolean true

display => array (2)

view => array (1)

options => array (2) Depth Limit

form => array (1)

options => array (1) Depth Limit

computed => boolean true

provider => string (5) "token"

field_name => string (9) "menu_link"

entity_type => string (4) "node"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4165 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (27) "field_item:entity_reference"
settings => array (3)
target_type => string (17) "menu_link_content"
handler => string (7) "default"
handler_settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#4162 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (16) "entity_reference"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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 (9) "menu_link"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected valueComputed -> boolean true

protected computeValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/token/src/MenuLinkFieldItemList.php:20

public getConstraints() {@inheritdoc} $0['#node']->menu_link->getConstraints()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:16

public referencedEntities() {@inheritdoc} $0['#node']->menu_link->referencedEntities()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:26

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->menu_link->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:107

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->menu_link->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->menu_link->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->menu_link->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->menu_link->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->menu_link->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->menu_link->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->menu_link->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->menu_link->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->menu_link->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->menu_link->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->menu_link->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:145

public preSave() {@inheritdoc} $0['#node']->menu_link->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->menu_link->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->menu_link->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->menu_link->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->menu_link->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->menu_link->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->menu_link->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->menu_link->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->menu_link->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->menu_link->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->menu_link->getValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42

public getString() {@inheritdoc} $0['#node']->menu_link->getString()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61

public get($index) {@inheritdoc} $0['#node']->menu_link->get()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69

public set($index, $value) {@inheritdoc} $0['#node']->menu_link->set()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89

public removeItem($index) {@inheritdoc} $0['#node']->menu_link->removeItem()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:105

protected rekey($from_index = 0) Renumbers the items in the list.

/**
 * Renumbers the items in the list.
 *
 * @param int $from_index
 *   Optionally, the index at which to start the renumbering, if it is known
 *   that items before that can safely be skipped (for example, when removing
 *   an item at a given index).
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:158

public first() {@inheritdoc} $0['#node']->menu_link->first()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171

public offsetExists($offset): bool {@inheritdoc} $0['#node']->menu_link->offsetExists()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:121

public offsetUnset($offset): void {@inheritdoc} $0['#node']->menu_link->offsetUnset()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186

public offsetGet($offset): mixed {@inheritdoc} $0['#node']->menu_link->offsetGet()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193

public offsetSet($offset, $value): void {@inheritdoc} $0['#node']->menu_link->offsetSet()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200

public appendItem($value = null) {@inheritdoc} $0['#node']->menu_link->appendItem()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97

public getItemDefinition() {@inheritdoc} $0['#node']->menu_link->getItemDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233

public getIterator(): ArrayIterator {@inheritdoc} $0['#node']->menu_link->getIterator()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:129

public count(): int {@inheritdoc} $0['#node']->menu_link->count()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:137

public isEmpty() {@inheritdoc} $0['#node']->menu_link->isEmpty()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113

public filter($callback) {@inheritdoc} $0['#node']->menu_link->filter()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272

public onChange($delta) {@inheritdoc} $0['#node']->menu_link->onChange()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294

public __clone() Magic method: Implements a deep clone. clone $0['#node']->menu_link

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304

public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc} $0['#node']->menu_link->last()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:314

/**
 * 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['#node']->menu_link->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->menu_link->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->menu_link->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->menu_link->validate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc} $0['#node']->menu_link->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->menu_link->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->menu_link->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->menu_link->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->menu_link->getParent()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * 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['#node']->menu_link->setStringTranslation()

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager. $0['#node']->menu_link->setTypedDataManager()

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager. $0['#node']->menu_link->getTypedDataManager()

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

protected ensureComputedValue() Ensures that values are only computed once.

/**
 * Ensures that values are only computed once.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:32

public static Drupal\Core\Field\EntityReferenceFieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:62
```
public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```
public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339
```
⇄
Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
iterator_to_array($0['#node']->menu_link, false)

body -> Drupal\text\Plugin\Field\FieldType\TextFieldItemList#4741 (3) $0['#node']->body

Field properties (3)
Properties (9)
Methods (69)
Static methods (2)
Iterator

value -> string (3271) "Millions of people all over the world are affected by depression. However... $0['#node']->body->value

<p>Millions of people all over the world are affected by depression. However, despite its prevalence, misconceptions and misunderstandings about this condition persist, leading to ineffective and potentially harmful advice. One common myth is the notion that telling someone with depression to &quot;just be happy&quot; or to think positively will magically alleviate their symptoms. However, as mental health professionals and experts emphasize, the reality is far more complex.</p><p>Depression is not merely a result of negative thinking or a lack of willpower. It is a multifaceted condition rooted in various causes, such as genetic predispositions, traumatic experiences, or chronic stress. While altering one&rsquo;s thoughts may improve mood temporarily, it is not always enough to provide a long-term solution for those struggling with depression.</p><p>The Role of Emotions:</p><p>Emotions serve as messengers, attempting to convey vital information about our physical and mental well-being. Depression, like any other emotion, is trying to communicate something essential about ourselves. Whether it signifies unhealed wounds, a lack of purpose, or feelings of shame and inadequacy, depression highlights areas that deserve our attention and understanding.</p><p>The Internal Family Systems (IFS) Perspective:</p><p>Within the Internal Family Systems framework, depression is often linked to our &quot;exile parts.&quot; These are the deep emotional aspects of ourselves we hide away. Our mind, acting as the protector, always wants to shield us from experiencing pain, shame, grief, and loss. However, when we suppress these intense emotions, we inadvertently suppress positive emotions as well. Consequently, depression emerges as a symptom, signaling our inner struggle.</p><p>The Importance of Support and Validation:</p><p>Telling someone with depression to simply be happy is not only unhelpful but can be harmful. It can reinforce feelings of shame, guilt, and worthlessness, which can exacerbate their depression.</p><p>Instead of dismissively telling someone with depression to &quot;just be happy,&quot; or to think positively, a more supportive and beneficial approach is to show compassion and validation.</p><p>Depression is not a sign of weakness or personal failure, it&rsquo;s a sign that our wounded parts are crying out for attention. It is a genuine mental health condition that deserves understanding, empathy, and sometimes professional guidance.</p><p>To support your loved ones who are experiencing depression, it is helpful to show that you care by listening to them and understanding their emotions. Encourage them to seek professional help from a therapist or mental health specialist who can offer them the proper support they need and deserve.</p><p>Seeking Professional Help:</p><p>For individuals grappling with depression, seeking help from friends or mental health professionals is vital. Opening up about their struggles and finding a therapist who specializes in treating depression can make a significant difference in their healing journey. Professional guidance and support can provide effective tools to navigate the complex emotions and underlying causes of depression.</p><p>&nbsp;</p><p>Author: Heidi Kwok, M.A. RCC</p>

summary -> string (0) "" $0['#node']->body->summary

format -> string (10) "basic_html" $0['#node']->body->format

protected definition -> Drupal\field\Entity\FieldConfig#4171 (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 (0)

protected cacheTags -> array (0)

protected cacheMaxAge -> integer -1

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected originalId -> string (14) "node.blog.body"

protected status -> boolean true

protected uuid -> string (36) "5a25a705-4f52-4d68-bc06-98ea6a1adb88"

private isUninstalling -> boolean false

protected langcode -> string (2) "en"

protected third_party_settings -> array (0)

protected _core -> array (0)

protected trustedData -> boolean false

protected dependencies -> array (2)

config => array (4)

0 => string (23) "field.storage.node.body"

1 => string (24) "filter.format.basic_html"

2 => string (23) "filter.format.full_html"

3 => string (14) "node.type.blog"

module => array (1)

0 => string (4) "text"

protected isSyncing -> boolean false

protected id -> string (14) "node.blog.body"

protected field_name -> string (4) "body"

protected field_type -> string (17) "text_with_summary"

protected entity_type -> string (4) "node"

protected bundle -> string (4) "blog"

protected label -> string (4) "Body"

protected description -> string (0) ""

protected settings -> array (3)

display_summary => boolean true

required_summary => boolean false

allowed_formats => array (2)

0 => string (9) "full_html"

1 => string (10) "basic_html"

protected required -> boolean false

protected translatable -> boolean false

protected default_value -> array (0)

protected default_value_callback -> string (0) ""

protected fieldStorage -> Drupal\field\Entity\FieldStorageConfig#4744 (34)

Properties (34)
Methods (125)
Static methods (15)
Static properties (1)
Class constants (2)

protected entityTypeId -> string (20) "field_storage_config"

protected enforceIsNew -> null

protected typedData -> null

protected originalEntity -> null

protected cacheContexts -> array (0)

protected cacheTags -> array (0)

protected cacheMaxAge -> integer -1

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected originalId -> string (9) "node.body"

protected status -> boolean true

protected uuid -> string (36) "e80ec892-223a-4d16-97aa-77515f9116fc"

private isUninstalling -> boolean false

protected langcode -> string (3) "und"

protected third_party_settings -> array (0)

protected _core -> array (0)

protected trustedData -> boolean false

protected dependencies -> array (1)

module => array (2)

0 => string (4) "node"

1 => string (4) "text"

protected isSyncing -> boolean false

protected id -> string (9) "node.body"

protected field_name -> string (4) "body"

protected entity_type -> string (4) "node"

protected type -> string (17) "text_with_summary"

protected module -> string (4) "text"

protected settings -> array (0)

protected cardinality -> integer 1

protected translatable -> boolean true

protected locked -> boolean false

protected persist_with_no_fields -> boolean false

public custom_storage -> boolean false

protected indexes -> array (0)

protected deleted -> boolean false

protected schema -> null

protected propertyDefinitions -> array (5)

value => Drupal\Core\TypedData\DataDefinition#4768 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (3) Depth Limit
protected typedDataManager -> null

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

format => Drupal\Core\TypedData\DataDefinition#4770 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (3) Depth Limit
protected typedDataManager -> null

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

processed => Drupal\Core\TypedData\DataDefinition#4772 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (7) Depth Limit
protected typedDataManager -> null

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

summary => Drupal\Core\TypedData\DataDefinition#4775 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (2) Depth Limit
protected typedDataManager -> null

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

summary_processed => Drupal\Core\TypedData\DataDefinition#4777 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (6) Depth Limit
protected typedDataManager -> null

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.

/**
 * Constructs a FieldStorageConfig object.
 *
 * In most cases, Field entities are created via
 * FieldStorageConfig::create($values)), where $values is the same parameter
 * as in this constructor.
 *
 * @param array $values
 *   An array of field properties, keyed by property name. Most array
 *   elements will be used to set the corresponding properties on the class;
 *   see the class property documentation for details. Some array elements
 *   have special meanings and a few are required. Special elements are:
 *   - name: required. As a temporary Backwards Compatibility layer right now,
 *     a 'field_name' property can be accepted in place of 'id'.
 *   - entity_type: required.
 *   - type: required.
 * @param string $entity_type
 *   (optional) The entity type on which the field should be created.
 *   Defaults to "field_storage_config".
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:265

public id() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:286

public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:293

public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().

/**
 * Overrides \Drupal\Core\Entity\EntityBase::preSave().
 *
 * @throws \Drupal\Core\Field\FieldException
 *   If the field definition is invalid.
 * @throws \Drupal\Core\Entity\EntityStorageException
 *   In case of failures at the configuration storage level.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:320

protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.

/**
 * Prepares saving a new field definition.
 *
 * @param \Drupal\Core\Entity\EntityStorageInterface $storage
 *   The entity storage.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   If the field definition is invalid.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:350

public calculateDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:376

protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.

/**
 * Prepares saving an updated field definition.
 *
 * @param \Drupal\Core\Entity\EntityStorageInterface $storage
 *   The entity storage.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:397

public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:421

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:479

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:505

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:512

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:519

public getBundles() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:527

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:540

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:547

public getTypeProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:554

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:561

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:568

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:582

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:601

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:609

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:617

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:624

public setTranslatable($translatable) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:632

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:640

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:647

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:654

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:661

public setCardinality($cardinality) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:678

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:686

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:713

public isLocked() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:721

public setLocked($locked) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:728

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:736

public hasData(): bool Determines whether a field has any data.

/**
 * Determines whether a field has any data.
 *
 * @return bool
 *   TRUE if the field has data for any entity; FALSE otherwise.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:746

public __sleep(): array Implements the magic __sleep() method.

/**
 * Implements the magic __sleep() method.
 *
 * Using the Serialize interface and serialize() / unserialize() methods
 * breaks entity forms in PHP 5.4.
 *
 * @todo Investigate in https://www.drupal.org/node/1977206.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:758

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:769

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:776

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:783

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:798

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:816

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824

protected getFieldItemClass() Helper to retrieve the field item class.

/**
 * Helper to retrieve the field item class.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:831

public isDeletable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:856

public getIndexes() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866

public setIndexes(array $indexes) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:873

public getOriginalId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127

public setOriginalId($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134

public isNew() Overrides EntityBase::isNew().

/**
 * Overrides EntityBase::isNew().
 *
 * EntityInterface::enforceIsNew() is only supported for newly created
 * configuration entities but has no effect after saving, since each
 * configuration entity is unique.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158

public set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166

public enable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184

public disable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192

public setStatus($status) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200

public status() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208

public setUninstalling($uninstalling) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215

public isUninstalling() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222

public createDuplicate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254

protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.

/**
 * Gets the typed config manager.
 *
 * @return \Drupal\Core\Config\TypedConfigManagerInterface
 *   The typed configuration plugin manager.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290

public toUrl($rel = null, array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408

public getCacheTagsToInvalidate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417

protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().

/**
 * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
 *
 * Note that this function should only be called from implementations of
 * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
 * as dependencies are recalculated during every entity save.
 *
 * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432

public getDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446

public getConfigDependencyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460

public getConfigTarget() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467

public onDependencyRemoval(array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:478

protected invalidateTagsOnSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Override to never invalidate the entity's cache tag; the config system
 * already invalidates it.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509

public setThirdPartySetting($module, $key, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531

public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539

public getThirdPartySettings($module) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551

public unsetThirdPartySetting($module, $key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558

public getThirdPartyProviders() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571

public isInstallable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612

public trustData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619

public hasTrustedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627

public save() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634

protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.

/**
 * Gets the entity type manager.
 *
 * @return \Drupal\Core\Entity\EntityTypeManagerInterface
 *   The entity type manager.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85

protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.

/**
 * Gets the entity type bundle info service.
 *
 * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
 *   The entity type bundle info service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95

protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.

/**
 * Gets the language manager.
 *
 * @return \Drupal\Core\Language\LanguageManagerInterface
 *   The language manager service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105

protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.

/**
 * Gets the UUID generator.
 *
 * @return \Drupal\Component\Uuid\UuidInterface
 *   The UUID service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115

public uuid() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129

public enforceIsNew($value = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143

public getEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152

public bundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159

public label() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166

public hasLinkTemplate($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253

protected linkTemplates(): array Gets an array link templates.

/**
 * Gets an array link templates.
 *
 * @return array
 *   An array of link templates containing paths.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:264

public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271

protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.

/**
 * Gets an array of placeholders for this entity.
 *
 * Individual entity classes may override this method to add additional
 * placeholders if desired. If so, they should be sure to replicate the
 * property caching logic.
 *
 * @param string $rel
 *   The link relationship type, for example: canonical or edit-form.
 *
 * @return array
 *   An array of URI placeholders.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:294

public uriRelationships() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315

public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337

public language() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376

public getEntityType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408

public referencedEntities() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473

protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.

/**
 * The list cache tags to invalidate for this entity.
 *
 * @return string[]
 *   Set of list cache tags.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517

public getTypedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628

public getConfigDependencyKey() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673

public getOriginal(): ?static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696

public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745

public addCacheableDependency($other_object) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15

public addCacheContexts(array $cache_contexts) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32

public addCacheTags(array $cache_tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42

public mergeCacheMaxAge($max_age) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52

protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.

/**
 * Sets cacheability; useful for value object constructors.
 *
 * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
 *   The cacheability to set.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39

public traitSleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.

/**
 * Calculates and returns dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 *
 * @return array
 *   An array of dependencies keyed by the type of dependency.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33

protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.

/**
 * Calculates and adds dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88

protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.

/**
 * Wraps the module handler.
 *
 * @return \Drupal\Core\Extension\ModuleHandlerInterface
 *   The module handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98

protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.

/**
 * Wraps the theme handler.
 *
 * @return \Drupal\Core\Extension\ThemeHandlerInterface
 *   The theme handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108

protected addDependencyTrait($type, $name): $this Adds a dependency.

/**
 * Adds a dependency.
 *
 * @param string $type
 *   Type of dependency being added: 'module', 'theme', 'config', 'content'.
 * @param string $name
 *   If $type is 'module' or 'theme', the name of the module or theme. If
 *   $type is 'config' or 'content', the result of
 *   EntityInterface::getConfigDependencyName().
 *
 * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
 *
 * @return $this
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31

protected addDependencies(array $dependencies) Adds multiple dependencies.

/**
 * Adds multiple dependencies.
 *
 * @param array $dependencies
 *   An array of dependencies keyed by the type of dependency. One example:
 *   @code
 *   [
 *     'module' => [
 *       'node',
 *       'field',
 *       'image',
 *     ],
 *   ];
 *   @endcode
 *
 * @see \Drupal\Core\Entity\DependencyTrait::addDependency
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64

public setSyncing($syncing) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22

public isSyncing() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31

private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.

/**
 * Returns the typed data class name for this entity.
 *
 * @return string
 *   The string representing the typed data class name.
 *
 * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644

public static Drupal\field\Entity\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:435

public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:464

public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|null Loads a field config entity based on the entity type and field name.

/**
 * Loads a field config entity based on the entity type and field name.
 *
 * @param string $entity_type_id
 *   ID of the entity type.
 * @param string $field_name
 *   Name of the field.
 *
 * @return \Drupal\field\FieldStorageConfigInterface|null
 *   The field config entity if one exists for the provided field name,
 *   otherwise NULL.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849

public static Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Callback for uasort() to sort configuration entities by weight and label.

/**
 * Callback for uasort() to sort configuration entities by weight and label.
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:240

protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Override to never invalidate the individual entities' cache tags; the
 * config system already invalidates them.
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:519

protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.

/**
 * Gets the configuration manager.
 *
 * @return \Drupal\Core\Config\ConfigManager
 *   The configuration manager.
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605

public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435

public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460

public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524

public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534

public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544

public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:578

public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453

public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447

protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.

/**
 * Invalidates an entity's cache tags upon delete.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type definition.
 * @param \Drupal\Core\Entity\EntityInterface[] $entities
 *   An array of entities.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582

protected static Drupal\field\Entity\FieldStorageConfig::$inDeletion :: boolean false
public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4742 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (28) "field_item:text_with_summary"
settings => array (3)
display_summary => boolean true
required_summary => boolean false
allowed_formats => array (2) Depth Limit
protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted
protected fieldDefinition -> Drupal\field\Entity\FieldConfig#4171 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected constraints -> array (0)

protected propertyConstraints -> array (0)

protected deleted -> boolean false

public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.

/**
 * Constructs a FieldConfig object.
 *
 * In most cases, Field entities are created via
 * FieldConfig::create($values), where $values is the same
 * parameter as in this constructor.
 *
 * @param array $values
 *   An array of field properties, keyed by property name. The
 *   storage associated with the field can be specified either with:
 *   - field_storage: the FieldStorageConfigInterface object,
 *   or by referring to an existing field storage in the current configuration
 *   with:
 *   - field_name: The field name.
 *   - entity_type: The entity type.
 *   Additionally, a 'bundle' property is required to indicate the entity
 *   bundle to which the field is attached to. Other array elements will be
 *   used to set the corresponding properties on the class; see the class
 *   property documentation for details.
 * @param string $entity_type
 *   (optional) The entity type on which the field should be created.
 *   Defaults to "field_config".
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110

public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143

public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().

/**
 * Overrides \Drupal\Core\Entity\EntityBase::preSave().
 *
 * @throws \Drupal\Core\Field\FieldException
 *   If the field definition is invalid.
 * @throws \Drupal\Core\Entity\EntityStorageException
 *   In case of failures at the configuration storage level.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165

public calculateDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201

protected linkTemplates() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264

protected urlRouteParameters($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298

public isDisplayConfigurable($context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361

public id() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228

public onDependencyRemoval(array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262

public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324

public setLabel($label) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340

public setDescription($description) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356

public setTranslatable($translatable) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409

public setRequired($required) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465

public __sleep(): array Implements the magic __sleep() method.

/**
 * Implements the magic __sleep() method.
 *
 * Using the Serialize interface and serialize() / unserialize() methods
 * breaks entity forms in PHP 5.4.
 *
 * @todo Investigate in https://www.drupal.org/node/1977206.
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578

public setConstraints(array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593

public setPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601

public addPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629

public getOriginalId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127

public setOriginalId($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134

public isNew() Overrides EntityBase::isNew().

/**
 * Overrides EntityBase::isNew().
 *
 * EntityInterface::enforceIsNew() is only supported for newly created
 * configuration entities but has no effect after saving, since each
 * configuration entity is unique.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158

public set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166

public enable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184

public disable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192

public setStatus($status) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200

public status() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208

public setUninstalling($uninstalling) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215

public isUninstalling() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222

public createDuplicate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254

protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.

/**
 * Gets the typed config manager.
 *
 * @return \Drupal\Core\Config\TypedConfigManagerInterface
 *   The typed configuration plugin manager.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290

public toUrl($rel = null, array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408

public getCacheTagsToInvalidate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417

protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().

/**
 * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
 *
 * Note that this function should only be called from implementations of
 * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
 * as dependencies are recalculated during every entity save.
 *
 * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432

public getDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446

public getConfigDependencyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460

public getConfigTarget() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467

protected invalidateTagsOnSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Override to never invalidate the entity's cache tag; the config system
 * already invalidates it.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509

public setThirdPartySetting($module, $key, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531

public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539

public getThirdPartySettings($module) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551

public unsetThirdPartySetting($module, $key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558

public getThirdPartyProviders() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571

public isInstallable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612

public trustData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619

public hasTrustedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627

public save() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634

protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.

/**
 * Gets the entity type manager.
 *
 * @return \Drupal\Core\Entity\EntityTypeManagerInterface
 *   The entity type manager.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85

protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.

/**
 * Gets the entity type bundle info service.
 *
 * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
 *   The entity type bundle info service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95

protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.

/**
 * Gets the language manager.
 *
 * @return \Drupal\Core\Language\LanguageManagerInterface
 *   The language manager service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105

protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.

/**
 * Gets the UUID generator.
 *
 * @return \Drupal\Component\Uuid\UuidInterface
 *   The UUID service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115

public uuid() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129

public enforceIsNew($value = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143

public getEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152

public bundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159

public label() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166

public hasLinkTemplate($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253

public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271

public uriRelationships() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315

public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337

public language() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376

public getEntityType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408

public referencedEntities() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473

protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.

/**
 * The list cache tags to invalidate for this entity.
 *
 * @return string[]
 *   Set of list cache tags.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517

public getTypedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628

public getConfigDependencyKey() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673

public getOriginal(): ?static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696

public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745

public addCacheableDependency($other_object) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15

public addCacheContexts(array $cache_contexts) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32

public addCacheTags(array $cache_tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42

public mergeCacheMaxAge($max_age) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52

protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.

/**
 * Sets cacheability; useful for value object constructors.
 *
 * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
 *   The cacheability to set.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39

public traitSleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.

/**
 * Calculates and returns dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 *
 * @return array
 *   An array of dependencies keyed by the type of dependency.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33

protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.

/**
 * Calculates and adds dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88

protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.

/**
 * Wraps the module handler.
 *
 * @return \Drupal\Core\Extension\ModuleHandlerInterface
 *   The module handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98

protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.

/**
 * Wraps the theme handler.
 *
 * @return \Drupal\Core\Extension\ThemeHandlerInterface
 *   The theme handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108

protected addDependencyTrait($type, $name): $this Adds a dependency.

/**
 * Adds a dependency.
 *
 * @param string $type
 *   Type of dependency being added: 'module', 'theme', 'config', 'content'.
 * @param string $name
 *   If $type is 'module' or 'theme', the name of the module or theme. If
 *   $type is 'config' or 'content', the result of
 *   EntityInterface::getConfigDependencyName().
 *
 * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
 *
 * @return $this
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31

protected addDependencies(array $dependencies) Adds multiple dependencies.

/**
 * Adds multiple dependencies.
 *
 * @param array $dependencies
 *   An array of dependencies keyed by the type of dependency. One example:
 *   @code
 *   [
 *     'module' => [
 *       'node',
 *       'field',
 *       'image',
 *     ],
 *   ];
 *   @endcode
 *
 * @see \Drupal\Core\Entity\DependencyTrait::addDependency
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64

public setSyncing($syncing) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22

public isSyncing() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31

private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.

/**
 * Returns the typed data class name for this entity.
 *
 * @return string
 *   The string representing the typed data class name.
 *
 * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644

public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211

public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237

public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and field name.

/**
 * Loads a field config entity based on the entity type and field name.
 *
 * @param string $entity_type_id
 *   ID of the entity type.
 * @param string $bundle
 *   Bundle name.
 * @param string $field_name
 *   Name of the field.
 *
 * @return \Drupal\field\FieldConfigInterface|null
 *   The field config entity if one exists for the provided field
 *   name, otherwise NULL.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:379

public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491

public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500

/**
 * 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#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (1)

0 => Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem#4784 (9)

Properties (9)
Methods (49)
Static methods (24)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4742 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (28) "field_item:text_with_summary"

settings => array (3) Depth Limit

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected fieldDefinition -> Drupal\field\Entity\FieldConfig#4171 (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 (0)
protected cacheTags -> array (0)
protected cacheMaxAge -> integer -1
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)
protected originalId -> string (14) "node.blog.body"
protected status -> boolean true
protected uuid -> string (36) "5a25a705-4f52-4d68-bc06-98ea6a1adb88"
private isUninstalling -> boolean false
protected langcode -> string (2) "en"
protected third_party_settings -> array (0)
protected _core -> array (0)
protected trustedData -> boolean false
protected dependencies -> array (2) Depth Limit
protected isSyncing -> boolean false
protected id -> string (14) "node.blog.body"
protected field_name -> string (4) "body"
protected field_type -> string (17) "text_with_summary"
protected entity_type -> string (4) "node"
protected bundle -> string (4) "blog"
protected label -> string (4) "Body"
protected description -> string (0) ""
protected settings -> array (3) Depth Limit
protected required -> boolean false
protected translatable -> boolean false
protected default_value -> array (0)
protected default_value_callback -> string (0) ""
protected fieldStorage -> Drupal\field\Entity\FieldStorageConfig#4744 Depth Limit
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#4742 Recursion
protected constraints -> array (0)
protected propertyConstraints -> array (0)
protected deleted -> boolean false

public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.

/**
 * Constructs a FieldConfig object.
 *
 * In most cases, Field entities are created via
 * FieldConfig::create($values), where $values is the same
 * parameter as in this constructor.
 *
 * @param array $values
 *   An array of field properties, keyed by property name. The
 *   storage associated with the field can be specified either with:
 *   - field_storage: the FieldStorageConfigInterface object,
 *   or by referring to an existing field storage in the current configuration
 *   with:
 *   - field_name: The field name.
 *   - entity_type: The entity type.
 *   Additionally, a 'bundle' property is required to indicate the entity
 *   bundle to which the field is attached to. Other array elements will be
 *   used to set the corresponding properties on the class; see the class
 *   property documentation for details.
 * @param string $entity_type
 *   (optional) The entity type on which the field should be created.
 *   Defaults to "field_config".
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110

public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143

public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().

/**
 * Overrides \Drupal\Core\Entity\EntityBase::preSave().
 *
 * @throws \Drupal\Core\Field\FieldException
 *   If the field definition is invalid.
 * @throws \Drupal\Core\Entity\EntityStorageException
 *   In case of failures at the configuration storage level.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165

public calculateDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201

protected linkTemplates() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264

protected urlRouteParameters($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298

public isDisplayConfigurable($context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361

public id() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228

public onDependencyRemoval(array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262

public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324

public setLabel($label) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340

public setDescription($description) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356

public setTranslatable($translatable) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409

public setRequired($required) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465

public __sleep(): array Implements the magic __sleep() method.

/**
 * Implements the magic __sleep() method.
 *
 * Using the Serialize interface and serialize() / unserialize() methods
 * breaks entity forms in PHP 5.4.
 *
 * @todo Investigate in https://www.drupal.org/node/1977206.
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578

public setConstraints(array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593

public setPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601

public addPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629

public getOriginalId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127

public setOriginalId($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134

public isNew() Overrides EntityBase::isNew().

/**
 * Overrides EntityBase::isNew().
 *
 * EntityInterface::enforceIsNew() is only supported for newly created
 * configuration entities but has no effect after saving, since each
 * configuration entity is unique.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158

public set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166

public enable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184

public disable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192

public setStatus($status) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200

public status() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208

public setUninstalling($uninstalling) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215

public isUninstalling() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222

public createDuplicate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254

protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.

/**
 * Gets the typed config manager.
 *
 * @return \Drupal\Core\Config\TypedConfigManagerInterface
 *   The typed configuration plugin manager.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290

public toUrl($rel = null, array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408

public getCacheTagsToInvalidate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417

protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().

/**
 * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
 *
 * Note that this function should only be called from implementations of
 * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
 * as dependencies are recalculated during every entity save.
 *
 * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432

public getDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446

public getConfigDependencyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460

public getConfigTarget() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467

protected invalidateTagsOnSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Override to never invalidate the entity's cache tag; the config system
 * already invalidates it.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509

public setThirdPartySetting($module, $key, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531

public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539

public getThirdPartySettings($module) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551

public unsetThirdPartySetting($module, $key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558

public getThirdPartyProviders() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571

public isInstallable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612

public trustData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619

public hasTrustedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627

public save() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634

protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.

/**
 * Gets the entity type manager.
 *
 * @return \Drupal\Core\Entity\EntityTypeManagerInterface
 *   The entity type manager.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85

protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.

/**
 * Gets the entity type bundle info service.
 *
 * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
 *   The entity type bundle info service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95

protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.

/**
 * Gets the language manager.
 *
 * @return \Drupal\Core\Language\LanguageManagerInterface
 *   The language manager service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105

protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.

/**
 * Gets the UUID generator.
 *
 * @return \Drupal\Component\Uuid\UuidInterface
 *   The UUID service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115

public uuid() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129

public enforceIsNew($value = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143

public getEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152

public bundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159

public label() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166

public hasLinkTemplate($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253

public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271

public uriRelationships() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315

public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337

public language() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376

public getEntityType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408

public referencedEntities() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473

protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.

/**
 * The list cache tags to invalidate for this entity.
 *
 * @return string[]
 *   Set of list cache tags.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517

public getTypedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628

public getConfigDependencyKey() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673

public getOriginal(): ?static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696

public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745

public addCacheableDependency($other_object) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15

public addCacheContexts(array $cache_contexts) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32

public addCacheTags(array $cache_tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42

public mergeCacheMaxAge($max_age) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52

protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.

/**
 * Sets cacheability; useful for value object constructors.
 *
 * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
 *   The cacheability to set.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39

public traitSleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.

/**
 * Calculates and returns dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 *
 * @return array
 *   An array of dependencies keyed by the type of dependency.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33

protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.

/**
 * Calculates and adds dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88

protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.

/**
 * Wraps the module handler.
 *
 * @return \Drupal\Core\Extension\ModuleHandlerInterface
 *   The module handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98

protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.

/**
 * Wraps the theme handler.
 *
 * @return \Drupal\Core\Extension\ThemeHandlerInterface
 *   The theme handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108

protected addDependencyTrait($type, $name): $this Adds a dependency.

/**
 * Adds a dependency.
 *
 * @param string $type
 *   Type of dependency being added: 'module', 'theme', 'config', 'content'.
 * @param string $name
 *   If $type is 'module' or 'theme', the name of the module or theme. If
 *   $type is 'config' or 'content', the result of
 *   EntityInterface::getConfigDependencyName().
 *
 * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
 *
 * @return $this
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31

protected addDependencies(array $dependencies) Adds multiple dependencies.

/**
 * Adds multiple dependencies.
 *
 * @param array $dependencies
 *   An array of dependencies keyed by the type of dependency. One example:
 *   @code
 *   [
 *     'module' => [
 *       'node',
 *       'field',
 *       'image',
 *     ],
 *   ];
 *   @endcode
 *
 * @see \Drupal\Core\Entity\DependencyTrait::addDependency
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64

public setSyncing($syncing) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22

public isSyncing() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31

private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.

/**
 * Returns the typed data class name for this entity.
 *
 * @return string
 *   The string representing the typed data class name.
 *
 * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644

public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211

public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237

/**
 * 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

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected name -> integer 0

protected parent -> Drupal\text\Plugin\Field\FieldType\TextFieldItemList#4741 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected values -> array (3)

value => string (3271) "Millions of people all over the world are affected by depression. However...

<p>Millions of people all over the world are affected by depression. However, despite its prevalence, misconceptions and misunderstandings about this condition persist, leading to ineffective and potentially harmful advice. One common myth is the notion that telling someone with depression to &quot;just be happy&quot; or to think positively will magically alleviate their symptoms. However, as mental health professionals and experts emphasize, the reality is far more complex.</p><p>Depression is not merely a result of negative thinking or a lack of willpower. It is a multifaceted condition rooted in various causes, such as genetic predispositions, traumatic experiences, or chronic stress. While altering one&rsquo;s thoughts may improve mood temporarily, it is not always enough to provide a long-term solution for those struggling with depression.</p><p>The Role of Emotions:</p><p>Emotions serve as messengers, attempting to convey vital information about our physical and mental well-being. Depression, like any other emotion, is trying to communicate something essential about ourselves. Whether it signifies unhealed wounds, a lack of purpose, or feelings of shame and inadequacy, depression highlights areas that deserve our attention and understanding.</p><p>The Internal Family Systems (IFS) Perspective:</p><p>Within the Internal Family Systems framework, depression is often linked to our &quot;exile parts.&quot; These are the deep emotional aspects of ourselves we hide away. Our mind, acting as the protector, always wants to shield us from experiencing pain, shame, grief, and loss. However, when we suppress these intense emotions, we inadvertently suppress positive emotions as well. Consequently, depression emerges as a symptom, signaling our inner struggle.</p><p>The Importance of Support and Validation:</p><p>Telling someone with depression to simply be happy is not only unhelpful but can be harmful. It can reinforce feelings of shame, guilt, and worthlessness, which can exacerbate their depression.</p><p>Instead of dismissively telling someone with depression to &quot;just be happy,&quot; or to think positively, a more supportive and beneficial approach is to show compassion and validation.</p><p>Depression is not a sign of weakness or personal failure, it&rsquo;s a sign that our wounded parts are crying out for attention. It is a genuine mental health condition that deserves understanding, empathy, and sometimes professional guidance.</p><p>To support your loved ones who are experiencing depression, it is helpful to show that you care by listening to them and understanding their emotions. Encourage them to seek professional help from a therapist or mental health specialist who can offer them the proper support they need and deserve.</p><p>Seeking Professional Help:</p><p>For individuals grappling with depression, seeking help from friends or mental health professionals is vital. Opening up about their struggles and finding a therapist who specializes in treating depression can make a significant difference in their healing journey. Professional guidance and support can provide effective tools to navigate the complex emotions and underlying causes of depression.</p><p>&nbsp;</p><p>Author: Heidi Kwok, M.A. RCC</p>

summary => string (0) ""

format => string (10) "basic_html"

protected properties -> array (4)

processed => Drupal\text\TextProcessed#4785 (8)

Properties (8)
Methods (28)
Static methods (1)

protected definition -> Drupal\Core\TypedData\DataDefinition#4772 Depth Limit
protected name -> string (9) "processed"
protected parent -> Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem#4784 Recursion
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)
protected stringTranslation -> null
protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted
protected processed -> Drupal\filter\FilterProcessResult#7075 Depth Limit

public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:31

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:43

public setValue($value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:73

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:84

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:92

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:100

protected getRenderer(): \Drupal\Core\Render\RendererInterface Returns the renderer service.

/**
 * Returns the renderer service.
 *
 * @return \Drupal\Core\Render\RendererInterface
 *   The renderer service.
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:111

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:112

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:138

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```

summary_processed => Drupal\text\TextProcessed#4786 (8)

Properties (8)
Methods (28)
Static methods (1)

protected definition -> Drupal\Core\TypedData\DataDefinition#4777 Depth Limit
protected name -> string (17) "summary_processed"
protected parent -> Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem#4784 Recursion
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)
protected stringTranslation -> null
protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted
protected processed -> null

public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:31

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:43

public setValue($value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:73

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:84

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:92

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:100

protected getRenderer(): \Drupal\Core\Render\RendererInterface Returns the renderer service.

/**
 * Returns the renderer service.
 *
 * @return \Drupal\Core\Render\RendererInterface
 *   The renderer service.
 */

Defined in <drupal>/core/modules/text/src/TextProcessed.php:111

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:112

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:138

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```

summary => Drupal\Core\TypedData\Plugin\DataType\StringData#7063 (8)

Properties (8)
Methods (25)
Static methods (1)

protected definition -> Drupal\Core\TypedData\DataDefinition#4775 Depth Limit
protected name -> string (7) "summary"
protected parent -> Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem#4784 Recursion
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)
protected stringTranslation -> null
protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted
protected value -> string (0) ""

public getCastedValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/StringData.php:27

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\PrimitiveBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/PrimitiveBase.php:20

public setValue($value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\PrimitiveBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/PrimitiveBase.php:27

/**
 * 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}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:112

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:138

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```

value => Drupal\Core\TypedData\Plugin\DataType\StringData#7062 (8)

Properties (8)
Methods (25)
Static methods (1)

protected definition -> Drupal\Core\TypedData\DataDefinition#4768 Depth Limit

protected name -> string (5) "value"

protected parent -> Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem#4784 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected value -> string (3271) "Millions of people all over the world are affected by depression. However...

<p>Millions of people all over the world are affected by depression. However, despite its prevalence, misconceptions and misunderstandings about this condition persist, leading to ineffective and potentially harmful advice. One common myth is the notion that telling someone with depression to &quot;just be happy&quot; or to think positively will magically alleviate their symptoms. However, as mental health professionals and experts emphasize, the reality is far more complex.</p><p>Depression is not merely a result of negative thinking or a lack of willpower. It is a multifaceted condition rooted in various causes, such as genetic predispositions, traumatic experiences, or chronic stress. While altering one&rsquo;s thoughts may improve mood temporarily, it is not always enough to provide a long-term solution for those struggling with depression.</p><p>The Role of Emotions:</p><p>Emotions serve as messengers, attempting to convey vital information about our physical and mental well-being. Depression, like any other emotion, is trying to communicate something essential about ourselves. Whether it signifies unhealed wounds, a lack of purpose, or feelings of shame and inadequacy, depression highlights areas that deserve our attention and understanding.</p><p>The Internal Family Systems (IFS) Perspective:</p><p>Within the Internal Family Systems framework, depression is often linked to our &quot;exile parts.&quot; These are the deep emotional aspects of ourselves we hide away. Our mind, acting as the protector, always wants to shield us from experiencing pain, shame, grief, and loss. However, when we suppress these intense emotions, we inadvertently suppress positive emotions as well. Consequently, depression emerges as a symptom, signaling our inner struggle.</p><p>The Importance of Support and Validation:</p><p>Telling someone with depression to simply be happy is not only unhelpful but can be harmful. It can reinforce feelings of shame, guilt, and worthlessness, which can exacerbate their depression.</p><p>Instead of dismissively telling someone with depression to &quot;just be happy,&quot; or to think positively, a more supportive and beneficial approach is to show compassion and validation.</p><p>Depression is not a sign of weakness or personal failure, it&rsquo;s a sign that our wounded parts are crying out for attention. It is a genuine mental health condition that deserves understanding, empathy, and sometimes professional guidance.</p><p>To support your loved ones who are experiencing depression, it is helpful to show that you care by listening to them and understanding their emotions. Encourage them to seek professional help from a therapist or mental health specialist who can offer them the proper support they need and deserve.</p><p>Seeking Professional Help:</p><p>For individuals grappling with depression, seeking help from friends or mental health professionals is vital. Opening up about their struggles and finding a therapist who specializes in treating depression can make a significant difference in their healing journey. Professional guidance and support can provide effective tools to navigate the complex emotions and underlying causes of depression.</p><p>&nbsp;</p><p>Author: Heidi Kwok, M.A. RCC</p>

public getCastedValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/StringData.php:27

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\PrimitiveBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/PrimitiveBase.php:20

public setValue($value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\PrimitiveBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/PrimitiveBase.php:27

/**
 * 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}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:112

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:138

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:87

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:95

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:119

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\text\Plugin\Field\FieldType\TextItemBase
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:99

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\text\Plugin\Field\FieldType\TextItemBase
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:116

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php: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 getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:33

public static Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:43

public static Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:62

public static Drupal\text\Plugin\Field\FieldType\TextItemBase::validateAllowedFormats(array &$element, Drupal\Core\Form\FormStateInterface $form_state) Render API callback: Processes the allowed formats value.

/**
 * Render API callback: Processes the allowed formats value.
 *
 * Ensure the element's value is an indexed array of selected format IDs.
 * This function is assigned as an #element_validate callback.
 *
 * @see static::fieldSettingsForm()
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:51

public static Drupal\text\Plugin\Field\FieldType\TextItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:59

public static Drupal\text\Plugin\Field\FieldType\TextItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:131

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

public static Drupal\text\Plugin\Field\FieldType\TextItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:20

public static Drupal\text\Plugin\Field\FieldType\TextItemBase::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:76

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

protected langcode -> string (3) "und"

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->body->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextFieldItemList.php:16

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->body->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->body->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->body->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->body->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->body->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->body->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->body->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->body->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->body->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->body->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->body->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->body->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->body->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->body->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->body->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->body->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->body->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->body->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->body->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->body->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->body->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->body->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->body->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->body->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->body->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->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['#node']->body->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->body->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->body->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->body->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->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['#node']->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['#node']->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['#node']->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['#node']->body, false)

field_blog_audio -> Drupal\file\Plugin\Field\FieldType\FileFieldItemList#4788 (0) $0['#node']->field_blog_audio

No values
Properties (9)
Methods (70)
Static methods (3)
Iterator

No values uninitialized

protected definition -> Drupal\field\Entity\FieldConfig#4172 (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 (0)
protected cacheTags -> array (0)
protected cacheMaxAge -> integer -1
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)
protected originalId -> string (26) "node.blog.field_blog_audio"
protected status -> boolean true
protected uuid -> string (36) "863fb7c8-df42-4f1a-bcbd-c7dbc59b0a6c"
private isUninstalling -> boolean false
protected langcode -> string (2) "en"
protected third_party_settings -> array (1)
filefield_paths => array (6)
enabled => boolean true
file_path => array (2)
value => string (17) "assets/blog/audio"
options => array (3) Depth Limit
file_name => array (2)
value => string (59) "[file:ffp-name-only-original].[file:ffp-extension-original]"
options => array (3) Depth Limit
redirect => boolean false
retroactive_update => boolean false
active_updating => boolean false
protected _core -> array (0)
protected trustedData -> boolean false
protected dependencies -> array (2)
- Table (2)
- Contents (2)
- ```
 0 1
config field.storage.node.field_blog_audio node.type.blog
module file filefield_paths
```
- config => array (2)
  0 => string (35) "field.storage.node.field_blog_audio"
  1 => string (14) "node.type.blog"
  module => array (2)
  0 => string (4) "file"
  1 => string (15) "filefield_paths"
protected isSyncing -> boolean false
protected id -> string (26) "node.blog.field_blog_audio"
protected field_name -> string (16) "field_blog_audio"
protected field_type -> string (4) "file"
protected entity_type -> string (4) "node"
protected bundle -> string (4) "blog"
protected label -> string (5) "Audio"
protected description -> string (0) ""
protected settings -> array (6)
handler => string (12) "default:file"
handler_settings => array (0)
file_directory => string (10) "blog_audio"
file_extensions => string (3) "mp3"
max_filesize => string (0) ""
description_field => boolean false
protected required -> boolean false
protected translatable -> boolean false
protected default_value -> array (0)
protected default_value_callback -> string (0) ""
protected fieldStorage -> null
protected itemDefinition -> null
protected constraints -> array (0)
protected propertyConstraints -> array (0)
protected deleted -> boolean false

	0	1
config	field.storage.node.field_blog_audio	node.type.blog
module	file	filefield_paths

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 name -> string (16) "field_blog_audio"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->field_blog_audio->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:16

public postSave($update) {@inheritdoc} $0['#node']->field_blog_audio->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:21

public delete() {@inheritdoc} $0['#node']->field_blog_audio->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:79

public deleteRevision() {@inheritdoc} $0['#node']->field_blog_audio->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:94

public getConstraints() {@inheritdoc} $0['#node']->field_blog_audio->getConstraints()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:16

public referencedEntities() {@inheritdoc} $0['#node']->field_blog_audio->referencedEntities()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:26

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->field_blog_audio->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:107

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->field_blog_audio->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->field_blog_audio->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->field_blog_audio->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->field_blog_audio->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->field_blog_audio->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->field_blog_audio->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->field_blog_audio->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->field_blog_audio->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->field_blog_audio->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->field_blog_audio->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->field_blog_audio->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->field_blog_audio->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->field_blog_audio->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->field_blog_audio->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->field_blog_audio->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->field_blog_audio->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->field_blog_audio->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio->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['#node']->field_blog_audio

/**
 * 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['#node']->field_blog_audio->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['#node']->field_blog_audio->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->field_blog_audio->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->field_blog_audio->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->field_blog_audio->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['#node']->field_blog_audio->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->field_blog_audio->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->field_blog_audio->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->field_blog_audio->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->field_blog_audio->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

/**
 * 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['#node']->field_blog_audio->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['#node']->field_blog_audio->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\EntityReferenceFieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:62
```
public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```
public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339
```
⇄
Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
iterator_to_array($0['#node']->field_blog_audio, false)

field_blog_categories -> string (3) "335" $0['#node']->field_blog_categories->target_id

field_blog_video -> Drupal\Core\Field\FieldItemList#4910 (0) $0['#node']->field_blog_video

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\field\Entity\FieldConfig#4174 (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 (0)
protected cacheTags -> array (0)
protected cacheMaxAge -> integer -1
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)
protected originalId -> string (26) "node.blog.field_blog_video"
protected status -> boolean true
protected uuid -> string (36) "f17638b1-c229-40b6-bfab-f9c7cc9a2a5c"
private isUninstalling -> boolean false
protected langcode -> string (2) "en"
protected third_party_settings -> array (0)
protected _core -> array (0)
protected trustedData -> boolean false
protected dependencies -> array (2)
config => array (2)
0 => string (35) "field.storage.node.field_blog_video"
1 => string (14) "node.type.blog"
module => array (1)
0 => string (17) "video_embed_field"
protected isSyncing -> boolean false
protected id -> string (26) "node.blog.field_blog_video"
protected field_name -> string (16) "field_blog_video"
protected field_type -> string (17) "video_embed_field"
protected entity_type -> string (4) "node"
protected bundle -> string (4) "blog"
protected label -> string (5) "Video"
protected description -> string (149) "Enter the URL to a video hosted on YouTube or Vimeo. Examples: https://y...
```
Enter the URL to a video hosted on YouTube or Vimeo. Examples: https://youtube.com/watch?v=012345678 or https://vimeo.com/012345678
```
protected settings -> array (1)
allowed_providers => array (3)
vimeo => string (5) "vimeo"
youtube => string (7) "youtube"
youtube_playlist => string (1) "0"
protected required -> boolean false
protected translatable -> boolean false
protected default_value -> array (0)
protected default_value_callback -> string (0) ""
protected fieldStorage -> null
protected itemDefinition -> null
protected constraints -> array (0)
protected propertyConstraints -> array (0)
protected deleted -> boolean false

public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.

/**
 * Constructs a FieldConfig object.
 *
 * In most cases, Field entities are created via
 * FieldConfig::create($values), where $values is the same
 * parameter as in this constructor.
 *
 * @param array $values
 *   An array of field properties, keyed by property name. The
 *   storage associated with the field can be specified either with:
 *   - field_storage: the FieldStorageConfigInterface object,
 *   or by referring to an existing field storage in the current configuration
 *   with:
 *   - field_name: The field name.
 *   - entity_type: The entity type.
 *   Additionally, a 'bundle' property is required to indicate the entity
 *   bundle to which the field is attached to. Other array elements will be
 *   used to set the corresponding properties on the class; see the class
 *   property documentation for details.
 * @param string $entity_type
 *   (optional) The entity type on which the field should be created.
 *   Defaults to "field_config".
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110

public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143

public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().

/**
 * Overrides \Drupal\Core\Entity\EntityBase::preSave().
 *
 * @throws \Drupal\Core\Field\FieldException
 *   If the field definition is invalid.
 * @throws \Drupal\Core\Entity\EntityStorageException
 *   In case of failures at the configuration storage level.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165

public calculateDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201

protected linkTemplates() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264

protected urlRouteParameters($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298

public isDisplayConfigurable($context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361

public id() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228

public onDependencyRemoval(array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262

public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324

public setLabel($label) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340

public setDescription($description) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356

public setTranslatable($translatable) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409

public setRequired($required) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465

public __sleep(): array Implements the magic __sleep() method.

/**
 * Implements the magic __sleep() method.
 *
 * Using the Serialize interface and serialize() / unserialize() methods
 * breaks entity forms in PHP 5.4.
 *
 * @todo Investigate in https://www.drupal.org/node/1977206.
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578

public setConstraints(array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593

public setPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601

public addPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629

public getOriginalId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127

public setOriginalId($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134

public isNew() Overrides EntityBase::isNew().

/**
 * Overrides EntityBase::isNew().
 *
 * EntityInterface::enforceIsNew() is only supported for newly created
 * configuration entities but has no effect after saving, since each
 * configuration entity is unique.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158

public set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166

public enable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184

public disable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192

public setStatus($status) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200

public status() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208

public setUninstalling($uninstalling) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215

public isUninstalling() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222

public createDuplicate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254

protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.

/**
 * Gets the typed config manager.
 *
 * @return \Drupal\Core\Config\TypedConfigManagerInterface
 *   The typed configuration plugin manager.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290

public toUrl($rel = null, array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408

public getCacheTagsToInvalidate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417

protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().

/**
 * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
 *
 * Note that this function should only be called from implementations of
 * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
 * as dependencies are recalculated during every entity save.
 *
 * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432

public getDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446

public getConfigDependencyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460

public getConfigTarget() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467

protected invalidateTagsOnSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Override to never invalidate the entity's cache tag; the config system
 * already invalidates it.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509

public setThirdPartySetting($module, $key, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531

public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539

public getThirdPartySettings($module) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551

public unsetThirdPartySetting($module, $key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558

public getThirdPartyProviders() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571

public isInstallable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612

public trustData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619

public hasTrustedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627

public save() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634

protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.

/**
 * Gets the entity type manager.
 *
 * @return \Drupal\Core\Entity\EntityTypeManagerInterface
 *   The entity type manager.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85

protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.

/**
 * Gets the entity type bundle info service.
 *
 * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
 *   The entity type bundle info service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95

protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.

/**
 * Gets the language manager.
 *
 * @return \Drupal\Core\Language\LanguageManagerInterface
 *   The language manager service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105

protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.

/**
 * Gets the UUID generator.
 *
 * @return \Drupal\Component\Uuid\UuidInterface
 *   The UUID service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115

public uuid() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129

public enforceIsNew($value = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143

public getEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152

public bundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159

public label() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166

public hasLinkTemplate($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253

public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271

public uriRelationships() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315

public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337

public language() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376

public getEntityType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408

public referencedEntities() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473

protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.

/**
 * The list cache tags to invalidate for this entity.
 *
 * @return string[]
 *   Set of list cache tags.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517

public getTypedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628

public getConfigDependencyKey() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673

public getOriginal(): ?static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696

public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745

public addCacheableDependency($other_object) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15

public addCacheContexts(array $cache_contexts) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32

public addCacheTags(array $cache_tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42

public mergeCacheMaxAge($max_age) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52

protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.

/**
 * Sets cacheability; useful for value object constructors.
 *
 * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
 *   The cacheability to set.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39

public traitSleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.

/**
 * Calculates and returns dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 *
 * @return array
 *   An array of dependencies keyed by the type of dependency.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33

protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.

/**
 * Calculates and adds dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88

protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.

/**
 * Wraps the module handler.
 *
 * @return \Drupal\Core\Extension\ModuleHandlerInterface
 *   The module handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98

protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.

/**
 * Wraps the theme handler.
 *
 * @return \Drupal\Core\Extension\ThemeHandlerInterface
 *   The theme handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108

protected addDependencyTrait($type, $name): $this Adds a dependency.

/**
 * Adds a dependency.
 *
 * @param string $type
 *   Type of dependency being added: 'module', 'theme', 'config', 'content'.
 * @param string $name
 *   If $type is 'module' or 'theme', the name of the module or theme. If
 *   $type is 'config' or 'content', the result of
 *   EntityInterface::getConfigDependencyName().
 *
 * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
 *
 * @return $this
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31

protected addDependencies(array $dependencies) Adds multiple dependencies.

/**
 * Adds multiple dependencies.
 *
 * @param array $dependencies
 *   An array of dependencies keyed by the type of dependency. One example:
 *   @code
 *   [
 *     'module' => [
 *       'node',
 *       'field',
 *       'image',
 *     ],
 *   ];
 *   @endcode
 *
 * @see \Drupal\Core\Entity\DependencyTrait::addDependency
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64

public setSyncing($syncing) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22

public isSyncing() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31

private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.

/**
 * Returns the typed data class name for this entity.
 *
 * @return string
 *   The string representing the typed data class name.
 *
 * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644

public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211

public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237

/**
 * 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 name -> string (16) "field_blog_video"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#4387 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1298 Blacklisted

protected list -> array (0)

protected langcode -> string (3) "und"

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0['#node']->field_blog_video->getEntity()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0['#node']->field_blog_video->setLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0['#node']->field_blog_video->getLangcode()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0['#node']->field_blog_video->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0['#node']->field_blog_video->getSettings()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0['#node']->field_blog_video->getSetting()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0['#node']->field_blog_video->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0['#node']->field_blog_video->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->field_blog_video->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0['#node']->field_blog_video->defaultAccess()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0['#node']->field_blog_video->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0['#node']->field_blog_video->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0['#node']->field_blog_video->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0['#node']->field_blog_video->delete()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0['#node']->field_blog_video->deleteRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0['#node']->field_blog_video->view()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0['#node']->field_blog_video->generateSampleItems()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0['#node']->field_blog_video->getConstraints()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->field_blog_video->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->field_blog_video->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0['#node']->field_blog_video->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0['#node']->field_blog_video->equals()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0['#node']->field_blog_video->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video

/**
 * 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['#node']->field_blog_video->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['#node']->field_blog_video->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0['#node']->field_blog_video->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0['#node']->field_blog_video->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0['#node']->field_blog_video->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['#node']->field_blog_video->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0['#node']->field_blog_video->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0['#node']->field_blog_video->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0['#node']->field_blog_video->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0['#node']->field_blog_video->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

/**
 * 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['#node']->field_blog_video->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['#node']->field_blog_video->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['#node']->field_blog_video, false)

field_metatag -> string (13) "{"robots":""}" $0['#node']->field_metatag->value

Json (1)

robots => string (0) ""
json_decode($0['#node']->field_metatag->value, true)['robots']

protected entityTypeId -> string (4) "node"

protected enforceIsNew -> null

protected typedData -> null

protected originalEntity -> null

protected cacheContexts -> array (0)

protected cacheTags -> array (0)

protected cacheMaxAge -> integer -1

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected values -> array (30)

nid => array (1)

x-default => string (4) "3009"

vid => array (1)

x-default => string (4) "2676"

type => array (1)

x-default => string (4) "blog"

uuid => array (1)

x-default => string (36) "531f50ef-e5d1-49fb-878b-ceb919606c86"

langcode => array (1)

x-default => string (3) "und"

revision_uid => array (1)

x-default => string (4) "9934"

revision_timestamp => array (1)

x-default => string (10) "1747342175"

2025-05-15T20:49:35+00:00

revision_log => array (1)

x-default => null

revision_default => array (1)

x-default => string (1) "1"

isDefaultRevision => array (1)

x-default => string (1) "1"

status => array (1)

x-default => string (1) "0"

uid => array (1)

x-default => string (4) "9934"

title => array (1)

x-default => string (55) "The Truth About Depression and the "Just Be Happy" Myth"

created => array (1)

x-default => string (10) "1706162726"

2024-01-25T06:05:26+00:00

changed => array (1)

x-default => string (10) "1779779521"

2026-05-26T07:12:01+00:00

promote => array (1)

x-default => string (1) "0"

sticky => array (1)

x-default => string (1) "0"

default_langcode => array (1)

x-default => string (1) "1"

revision_translation_affected => array (1)

x-default => string (1) "1"

publish_on => array (1)

x-default => null

unpublish_on => array (1)

x-default => null

publish_state => array (1)

x-default => null

unpublish_state => array (1)

x-default => null

rh_action => array (1)

x-default => null

rh_redirect => array (1)

x-default => null

rh_redirect_response => array (1)

x-default => null

rh_redirect_fallback_action => array (1)

x-default => null

body => array (1)

x-default => array (1)

0 => array (3)

value => string (3271) "Millions of people all over the world are affected by depression. However...

<p>Millions of people all over the world are affected by depression. However, despite its prevalence, misconceptions and misunderstandings about this condition persist, leading to ineffective and potentially harmful advice. One common myth is the notion that telling someone with depression to &quot;just be happy&quot; or to think positively will magically alleviate their symptoms. However, as mental health professionals and experts emphasize, the reality is far more complex.</p><p>Depression is not merely a result of negative thinking or a lack of willpower. It is a multifaceted condition rooted in various causes, such as genetic predispositions, traumatic experiences, or chronic stress. While altering one&rsquo;s thoughts may improve mood temporarily, it is not always enough to provide a long-term solution for those struggling with depression.</p><p>The Role of Emotions:</p><p>Emotions serve as messengers, attempting to convey vital information about our physical and mental well-being. Depression, like any other emotion, is trying to communicate something essential about ourselves. Whether it signifies unhealed wounds, a lack of purpose, or feelings of shame and inadequacy, depression highlights areas that deserve our attention and understanding.</p><p>The Internal Family Systems (IFS) Perspective:</p><p>Within the Internal Family Systems framework, depression is often linked to our &quot;exile parts.&quot; These are the deep emotional aspects of ourselves we hide away. Our mind, acting as the protector, always wants to shield us from experiencing pain, shame, grief, and loss. However, when we suppress these intense emotions, we inadvertently suppress positive emotions as well. Consequently, depression emerges as a symptom, signaling our inner struggle.</p><p>The Importance of Support and Validation:</p><p>Telling someone with depression to simply be happy is not only unhelpful but can be harmful. It can reinforce feelings of shame, guilt, and worthlessness, which can exacerbate their depression.</p><p>Instead of dismissively telling someone with depression to &quot;just be happy,&quot; or to think positively, a more supportive and beneficial approach is to show compassion and validation.</p><p>Depression is not a sign of weakness or personal failure, it&rsquo;s a sign that our wounded parts are crying out for attention. It is a genuine mental health condition that deserves understanding, empathy, and sometimes professional guidance.</p><p>To support your loved ones who are experiencing depression, it is helpful to show that you care by listening to them and understanding their emotions. Encourage them to seek professional help from a therapist or mental health specialist who can offer them the proper support they need and deserve.</p><p>Seeking Professional Help:</p><p>For individuals grappling with depression, seeking help from friends or mental health professionals is vital. Opening up about their struggles and finding a therapist who specializes in treating depression can make a significant difference in their healing journey. Professional guidance and support can provide effective tools to navigate the complex emotions and underlying causes of depression.</p><p>&nbsp;</p><p>Author: Heidi Kwok, M.A. RCC</p>

summary => string (0) ""

format => string (10) "basic_html"

field_blog_categories => array (1)

x-default => array (1)

0 => array (1)

target_id => string (3) "335"

field_metatag => array (1)

x-default => array (1)

0 => array (1)

value => string (13) "{"robots":""}"

Json (1)

robots => string (0) ""

protected fields -> array (0)

protected fieldDefinitions -> null

protected languages -> array (3)

en => Drupal\Core\Language\Language#209 (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 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"

und => Drupal\Core\Language\Language#1926 (5)

Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)

protected name -> Drupal\Core\StringTranslation\TranslatableMarkup#1927 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (13) "Not specified"
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

name string (13) "Not specified"

protected id -> string (3) "und"

protected direction -> string (3) "ltr"

protected weight -> integer 1

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#1928 (5)

Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)

protected name -> Drupal\Core\StringTranslation\TranslatableMarkup#1929 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (14) "Not applicable"
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

name string (14) "Not applicable"

protected id -> string (3) "zxx"

protected direction -> string (3) "ltr"

protected weight -> integer 2

protected locked -> boolean true

public __construct(array $values = array()) Constructs a new class instance.

/**
 * Constructs a new class instance.
 *
 * @param array $values
 *   An array of property values, keyed by property name, used to construct
 *   the language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101

public getId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108

public getDirection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115

public getWeight() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122

public isDefault() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129

public isLocked() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136

public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.

/**
 * Sort language objects.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   The array of language objects keyed by langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146

protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.

/**
 * Gets the default langcode.
 *
 * @return string
 *   The current default langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173

public static Drupal\Core\Language\Language::$defaultValues :: array (5)
id => string (2) "en"
\Drupal\Core\Language\Language::$defaultValues['id']
name => string (7) "English"
\Drupal\Core\Language\Language::$defaultValues['name']
direction => string (3) "ltr"
\Drupal\Core\Language\Language::$defaultValues['direction']
weight => integer 0
\Drupal\Core\Language\Language::$defaultValues['weight']
locked => boolean false
\Drupal\Core\Language\Language::$defaultValues['locked']
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 (3) "und"

protected translations -> array (1)

x-default => array (1)

status => integer 1

protected translationInitialize -> boolean false

protected newRevision -> boolean false

protected isDefaultRevision -> string (1) "1"

protected entityKeys -> array (4)

bundle => string (4) "blog"

id => string (4) "3009"

revision => string (4) "2676"

uuid => string (36) "531f50ef-e5d1-49fb-878b-ceb919606c86"

protected translatableEntityKeys -> array (8)

label => array (1)

x-default => string (55) "The Truth About Depression and the "Just Be Happy" Myth"

langcode => array (1)

x-default => string (3) "und"

status => array (1)

x-default => string (1) "0"

published => array (1)

x-default => string (1) "0"

uid => array (1)

x-default => string (4) "9934"

owner => array (1)

x-default => string (4) "9934"

default_langcode => array (1)

x-default => string (1) "1"

revision_translation_affected => array (1)

x-default => string (1) "1"

protected validated -> boolean false

protected validationRequired -> boolean false

protected loadedRevisionId -> string (4) "2676"

protected revisionTranslationAffectedKey -> string (29) "revision_translation_affected"

protected enforceRevisionTranslationAffected -> array (0)

protected isSyncing -> boolean false

public in_preview -> null $0['#node']->in_preview

public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc} $0['#node']->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:117

public preSaveRevision(Drupal\Core\Entity\EntityStorageInterface $storage, stdClass $record) {@inheritdoc} $0['#node']->preSaveRevision()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:139

public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc} $0['#node']->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:154

public getType() {@inheritdoc} $0['#node']->getType()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:204

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0['#node']->access()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:211

public getTitle() {@inheritdoc} $0['#node']->getTitle()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:219

public setTitle($title) {@inheritdoc} $0['#node']->setTitle()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:226

public getCreatedTime() {@inheritdoc} $0['#node']->getCreatedTime()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:234

public setCreatedTime($timestamp) {@inheritdoc} $0['#node']->setCreatedTime()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:241

public isPromoted() {@inheritdoc} $0['#node']->isPromoted()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:249

public setPromoted($promoted) {@inheritdoc} $0['#node']->setPromoted()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:256

public isSticky() {@inheritdoc} $0['#node']->isSticky()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:264

public setSticky($sticky) {@inheritdoc} $0['#node']->setSticky()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:271

public __construct(array $values, $entity_type, $bundle = false, $translations = array()) {@inheritdoc} new \Drupal\node\Entity\Node()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php: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['#node']->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['#node']->setNewRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:305

public getLoadedRevisionId() {@inheritdoc} $0['#node']->getLoadedRevisionId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:327

public updateLoadedRevisionId() {@inheritdoc} $0['#node']->updateLoadedRevisionId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:334

public isNewRevision() {@inheritdoc} $0['#node']->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['#node']->isDefaultRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:349

public wasDefaultRevision() {@inheritdoc} $0['#node']->wasDefaultRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:362

public isLatestRevision() {@inheritdoc} $0['#node']->isLatestRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:377

public isLatestTranslationAffectedRevision() {@inheritdoc} $0['#node']->isLatestTranslationAffectedRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:387

public isRevisionTranslationAffected() {@inheritdoc} $0['#node']->isRevisionTranslationAffected()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:397

public setRevisionTranslationAffected($affected) {@inheritdoc} $0['#node']->setRevisionTranslationAffected()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:404

public isRevisionTranslationAffectedEnforced() {@inheritdoc} $0['#node']->isRevisionTranslationAffectedEnforced()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:414

public setRevisionTranslationAffectedEnforced($enforced) {@inheritdoc} $0['#node']->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['#node']->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['#node']->isDefaultTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:444

public getRevisionId() {@inheritdoc} $0['#node']->getRevisionId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:454

public isTranslatable() {@inheritdoc} $0['#node']->isTranslatable()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:461

public validate() {@inheritdoc} $0['#node']->validate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:518

public isValidationRequired() {@inheritdoc} $0['#node']->isValidationRequired()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:527

public setValidationRequired($required) {@inheritdoc} $0['#node']->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['#node']->id()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:569

public bundle() {@inheritdoc} $0['#node']->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['#node']->getBundleEntity()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:583

public uuid() {@inheritdoc} $0['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:714

public getFieldDefinitions() {@inheritdoc} $0['#node']->getFieldDefinitions()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:726

public toArray() {@inheritdoc} $0['#node']->toArray()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:736

public language() {@inheritdoc} $0['#node']->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['#node']->onChange()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:827

public getTranslation($langcode) {@inheritdoc} $0['#node']->getTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:893

public getUntranslated() {@inheritdoc} $0['#node']->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['#node']->hasTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:980

public isNewTranslation() {@inheritdoc} $0['#node']->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['#node']->addTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:997

public removeTranslation($langcode) {@inheritdoc} $0['#node']->removeTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1018

public getTranslationStatus($langcode) {@inheritdoc} $0['#node']->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['#node']->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['#node']->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['#node']->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['#node']

/**
 * 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['#node']->label()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1336

public referencedEntities() {@inheritdoc} $0['#node']->referencedEntities()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1345

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:1372

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:1474

public hasTranslationChanges() {@inheritdoc} $0['#node']->hasTranslationChanges()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1485

public isDefaultTranslationAffectedOnly() {@inheritdoc} $0['#node']->isDefaultTranslationAffectedOnly()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1547

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['#node']->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['#node']->enforceIsNew()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143

public getEntityTypeId() {@inheritdoc} $0['#node']->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['#node']->toUrl()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:175

public hasLinkTemplate($rel) {@inheritdoc} $0['#node']->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['#node']->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['#node']->uriRelationships()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315

public save() {@inheritdoc} $0['#node']->save()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:368

public delete() {@inheritdoc} $0['#node']->delete()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376

public getEntityType() {@inheritdoc} $0['#node']->getEntityType()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408

public getCacheContexts() {@inheritdoc} $0['#node']->getCacheContexts()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473

protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.

/**
 * The list cache tags to invalidate for this entity.
 *
 * @return string[]
 *   Set of list cache tags.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483

public getCacheTagsToInvalidate() {@inheritdoc} $0['#node']->getCacheTagsToInvalidate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:497

public getCacheTags() {@inheritdoc} $0['#node']->getCacheTags()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507

public getCacheMaxAge() {@inheritdoc} $0['#node']->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['#node']->getOriginalId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:599

public setOriginalId($id) {@inheritdoc} $0['#node']->setOriginalId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:607

public getTypedData() {@inheritdoc} $0['#node']->getTypedData()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628

public getConfigDependencyKey() {@inheritdoc} $0['#node']->getConfigDependencyKey()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673

public getConfigDependencyName() {@inheritdoc} $0['#node']->getConfigDependencyName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:680

public getConfigTarget() {@inheritdoc} $0['#node']->getConfigTarget()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:687

public getOriginal(): ?static {@inheritdoc} $0['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->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['#node']->setSyncing()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22

public isSyncing() {@inheritdoc} $0['#node']->isSyncing()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31

public getChangedTimeAcrossTranslations(): int|null Returns the timestamp of the last entity change across all translations. $0['#node']->getChangedTimeAcrossTranslations()

/**
 * Returns the timestamp of the last entity change across all translations.
 *
 * @return int|null
 *   The timestamp of the last entity save operation across all translations.
 *   Some entities allow a NULL value indicating the changed time is unknown.
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:17

public getChangedTime(): int|null Gets the timestamp of the last entity change for the current translation. $0['#node']->getChangedTime()

/**
 * Gets the timestamp of the last entity change for the current translation.
 *
 * @return int|null
 *   The timestamp of the last entity save operation. Some entities allow a
 *   NULL value indicating the changed time is unknown.
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:33

public setChangedTime($timestamp): $this Sets the timestamp of the last entity change for the current translation. $0['#node']->setChangedTime()

/**
 * Sets the timestamp of the last entity change for the current translation.
 *
 * @param int $timestamp
 *   The timestamp of the last entity save operation.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:46

public isPublished() {@inheritdoc} $0['#node']->isPublished()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:47

public setPublished() {@inheritdoc} $0['#node']->setPublished()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:54

public setUnpublished() {@inheritdoc} $0['#node']->setUnpublished()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:64

public getRevisionCreationTime() {@inheritdoc} $0['#node']->getRevisionCreationTime()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:69

public setRevisionCreationTime($timestamp) {@inheritdoc} $0['#node']->setRevisionCreationTime()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:76

public getRevisionUser() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser(). $0['#node']->getRevisionUser()

/**
 * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:84

public setRevisionUser(Drupal\user\UserInterface $account) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser(). $0['#node']->setRevisionUser()

/**
 * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:91

public getRevisionUserId() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId(). $0['#node']->getRevisionUserId()

/**
 * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:99

public setRevisionUserId($user_id) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId(). $0['#node']->setRevisionUserId()

/**
 * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:106

public getRevisionLogMessage() {@inheritdoc} $0['#node']->getRevisionLogMessage()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:114

public setRevisionLogMessage($revision_log_message) {@inheritdoc} $0['#node']->setRevisionLogMessage()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:121

public getOwnerId() {@inheritdoc} $0['#node']->getOwnerId()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:48

public setOwnerId($uid) {@inheritdoc} $0['#node']->setOwnerId()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:55

public getOwner() {@inheritdoc} $0['#node']->getOwner()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:65

public setOwner(Drupal\user\UserInterface $account) {@inheritdoc} $0['#node']->setOwner()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:73

private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.

/**
 * Returns the typed data class name for this entity.
 *
 * @return string
 *   The string representing the typed data class name.
 *
 * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644

public static Drupal\node\Entity\Node::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:180

public static Drupal\node\Entity\Node::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $nodes) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:196

public static Drupal\node\Entity\Node::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/Entity/Node.php:279

public static Drupal\Core\Entity\ContentEntityBase::create(array $values = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1192

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:1464

public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435

public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460

public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524

public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534

protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.

/**
 * Invalidates an entity's cache tags upon delete.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type definition.
 * @param \Drupal\Core\Entity\EntityInterface[] $entities
 *   An array of entities.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582

public static Drupal\Core\Entity\EditorialContentEntityBase::publishedBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for publishing status.

/**
 * Returns an array of base field definitions for publishing status.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type to add the publishing status field to.
 *
 * @return \Drupal\Core\Field\BaseFieldDefinition[]
 *   An array of base field definitions.
 *
 * @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException
 *   Thrown when the entity type does not implement EntityPublishedInterface
 *   or if it does not have a "published" entity key.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:27

public static Drupal\Core\Entity\EditorialContentEntityBase::revisionLogBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\FieldDefinitionInterface[] Provides revision-related base field definitions for an entity type.

/**
 * Provides revision-related base field definitions for an entity type.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type definition.
 *
 * @return \Drupal\Core\Field\FieldDefinitionInterface[]
 *   An array of base field definitions for the entity type, keyed by field
 *   name.
 *
 * @see \Drupal\Core\Entity\FieldableEntityInterface::baseFieldDefinitions()
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:28

public static Drupal\node\Entity\Node::ownerBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for entity owners.

/**
 * Returns an array of base field definitions for entity owners.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type to add the owner field to.
 *
 * @return \Drupal\Core\Field\BaseFieldDefinition[]
 *   An array of base field definitions.
 *
 * @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException
 *   Thrown when the entity type does not implement EntityOwnerInterface or
 *   if it does not have an "owner" entity key.
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:28

public static Drupal\node\Entity\Node::getDefaultEntityOwner(): mixed Default value callback for 'owner' base field.

/**
 * Default value callback for 'owner' base field.
 *
 * @return mixed
 *   A default value for the owner field.
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:86

public static Drupal\Core\Entity\EditorialContentEntityBase::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php:19

public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447

public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453

public static Drupal\Core\Entity\ContentEntityBase::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1406

public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544

protected static Drupal\Core\Entity\ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck :: array (0)
public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_REMOVED :: integer 0
public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_EXISTING :: integer 1
public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_CREATED :: integer 2
public const Drupal\node\NodeInterface::NOT_PUBLISHED :: integer 0
public const Drupal\node\NodeInterface::PUBLISHED :: integer 1
public const Drupal\node\NodeInterface::NOT_PROMOTED :: integer 0
public const Drupal\node\NodeInterface::PROMOTED :: integer 1
public const Drupal\node\NodeInterface::NOT_STICKY :: integer 0
public const Drupal\node\NodeInterface::STICKY :: integer 1
⇄
Drupal\Core\Entity\FieldableEntityInterface Iterator Contents uninitialized Blacklisted
iterator_to_array($0['#node'], false)

#view_mode => string (4) "full" $0['#view_mode']

#cache => array (5) $0['#cache']

tags => array (2) $0['#cache']['tags']

0 => string (9) "node_view" $0['#cache']['tags'][0]

1 => string (9) "node:3009" $0['#cache']['tags'][1]

contexts => array (1) $0['#cache']['contexts']

0 => string (31) "route.name.is_layout_builder_ui" $0['#cache']['contexts'][0]

max-age => integer -1 $0['#cache']['max-age']

keys => array (4) $0['#cache']['keys']

0 => string (11) "entity_view" $0['#cache']['keys'][0]

1 => string (4) "node" $0['#cache']['keys'][1]

2 => string (4) "3009" $0['#cache']['keys'][2]

3 => string (4) "full" $0['#cache']['keys'][3]

bin => string (6) "render" $0['#cache']['bin']

#theme => string (4) "node" $0['#theme']

#weight => integer 0 $0['#weight']

#pre_render => array (1) $0['#pre_render']

0 => array (2) $0['#pre_render'][0]

0 => Drupal\node\NodeViewBuilder#1925 (12) $0['#pre_render'][0][0]

Properties (12)
Methods (24)
Static methods (5)
Class constants (2)

protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#653 Blacklisted

protected stringTranslation -> Drupal\Core\StringTranslation\TranslationManager#263 (3)

Properties (3)
Methods (10)

protected translators -> array (1)

30 => array (1)

0 => Drupal\Core\StringTranslation\Translator\CustomStrings#256 Depth Limit

protected sortedTranslators -> array (1)

0 => Drupal\Core\StringTranslation\Translator\CustomStrings#256 (4)

Properties (4)
Methods (6)

protected translations -> array (1) Depth Limit
protected settings -> Drupal\Core\Site\Settings#20 Depth Limit
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)

public __construct(Drupal\Core\Site\Settings $settings) Constructs a CustomStrings object.

/**
 * Constructs a CustomStrings object.
 *
 * @param \Drupal\Core\Site\Settings $settings
 *   The settings read only object.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/Translator/CustomStrings.php:31

protected getLanguage($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/Translator/CustomStrings.php:39

public getStringTranslation($langcode, $string, $context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\StringTranslation\Translator\StaticTranslation
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/Translator/StaticTranslation.php:33

public reset() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\StringTranslation\Translator\StaticTranslation
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/Translator/StaticTranslation.php:48

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected defaultLangcode -> string (2) "en"

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

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected entityTypeId -> string (4) "node"

protected entityType -> Drupal\Core\Entity\ContentEntityType#917 (42)

Properties (42)
Methods (83)
Class constants (2)

protected id -> string (4) "node"

protected class -> string (23) "Drupal\node\Entity\Node"

protected provider -> string (4) "node"

protected static_cache -> boolean true

protected render_cache -> boolean true

protected persistent_cache -> boolean true

protected entity_keys -> array (12)

id => string (3) "nid"

revision => string (3) "vid"

bundle => string (4) "type"

label => string (5) "title"

langcode => string (8) "langcode"

uuid => string (4) "uuid"

status => string (6) "status"

published => string (6) "status"

uid => string (3) "uid"

owner => string (3) "uid"

default_langcode => string (16) "default_langcode"

revision_translation_affected => string (29) "revision_translation_affected"

protected originalClass -> string (23) "Drupal\node\Entity\Node"

protected decoratedClasses -> array (1)

0 => string (23) "Drupal\node\Entity\Node"

protected handlers -> array (12)

storage => string (23) "Drupal\node\NodeStorage"

storage_schema => string (29) "Drupal\node\NodeStorageSchema"

view_builder => string (27) "Drupal\node\NodeViewBuilder"

access => string (36) "Drupal\node\NodeAccessControlHandler"

views_data => string (25) "Drupal\node\NodeViewsData"

form => array (5)

default => string (25) "Drupal\node\Form\NodeForm"

delete => string (31) "Drupal\node\Form\NodeDeleteForm"

edit => string (25) "Drupal\node\Form\NodeForm"

delete-multiple-confirm => string (31) "Drupal\node\Form\DeleteMultiple"

layout_builder => string (46) "Drupal\layout_builder\Form\OverridesEntityForm"

route_provider => array (2)

html => string (36) "Drupal\node\Entity\NodeRouteProvider"

moderation => string (70) "Drupal\content_moderation\Entity\Routing\EntityModerationRouteProvider"

list_builder => string (27) "Drupal\node\NodeListBuilder"

translation => string (34) "Drupal\node\NodeTranslationHandler"

inline_form => string (46) "\Drupal\inline_entity_form\Form\NodeInlineForm"

moderation => string (62) "Drupal\content_moderation\Entity\Handler\NodeModerationHandler"

query_access => string (53) "Drupal\entity\QueryAccess\EventOnlyQueryAccessHandler"

protected admin_permission -> null

protected collection_permission -> string (23) "access content overview"

protected permission_granularity -> string (6) "bundle"

protected links -> array (17)

canonical => string (12) "/node/{node}"

add-page => string (9) "/node/add"

add-form => string (21) "/node/add/{node_type}"

edit-form => string (17) "/node/{node}/edit"

delete-form => string (19) "/node/{node}/delete"

delete-multiple-form => string (26) "/admin/content/node/delete"

version-history => string (22) "/node/{node}/revisions"

revision => string (43) "/node/{node}/revisions/{node_revision}/view"

create => string (5) "/node"

latest-version => string (19) "/node/{node}/latest"

devel-load => string (18) "/devel/node/{node}"

devel-load-with-references => string (39) "/devel/load-with-references/node/{node}"

devel-path-alias => string (29) "/devel/path-alias/node/{node}"

devel-render => string (25) "/devel/render/node/{node}"

devel-definition => string (29) "/devel/definition/node/{node}"

token-devel => string (24) "/devel/token/node/{node}"

display => string (27) "/node/{node}/manage-display"

protected bundle_entity_type -> string (9) "node_type"

protected bundle_of -> null

protected bundle_label -> Drupal\Core\StringTranslation\TranslatableMarkup#918 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (12) "Content type"
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

bundle_label string (12) "Content type"

protected base_table -> string (4) "node"

protected revision_data_table -> string (19) "node_field_revision"

protected revision_table -> string (13) "node_revision"

protected data_table -> string (15) "node_field_data"

protected internal -> boolean false

protected translatable -> boolean true

protected show_revision_ui -> boolean true

protected label -> Drupal\Core\StringTranslation\TranslatableMarkup#919 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (7) "Content"
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) "Content"

protected label_collection -> Drupal\Core\StringTranslation\TranslatableMarkup#920 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (7) "Content"
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_collection string (7) "Content"

protected label_singular -> Drupal\Core\StringTranslation\TranslatableMarkup#921 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (12) "content item"
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_singular string (12) "content item"

protected label_plural -> Drupal\Core\StringTranslation\TranslatableMarkup#922 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (13) "content items"
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_plural string (13) "content items"

protected label_count -> array (2)

singular => string (19) "@count content item"

plural => string (20) "@count content items"

protected uri_callback -> null

protected group -> string (7) "content"

protected group_label -> Drupal\Core\StringTranslation\TranslatableMarkup#923 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (7) "Content"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (1)
context => string (17) "Entity type group"
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

group_label string (7) "Content"

protected field_ui_base_route -> string (26) "entity.node_type.edit_form"

protected common_reference_target -> boolean true

protected list_cache_contexts -> array (1)

0 => string (21) "user.node_grants:view"

protected list_cache_tags -> array (1)

0 => string (9) "node_list"

protected constraints -> array (3)

EntityChanged => null

EntityUntranslatableFields => null

MenuSettings => array (0)

protected additional -> array (1)

token_type => string (4) "node"

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected revision_metadata_keys -> array (4)

revision_user => string (12) "revision_uid"

revision_created => string (18) "revision_timestamp"

revision_log_message => string (12) "revision_log"

revision_default => string (16) "revision_default"

public __construct($definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:21

public getConfigDependencyKey() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:37

protected checkStorageClass($class) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @throws \InvalidArgumentException
 *   If the provided class does not implement
 *   \Drupal\Core\Entity\ContentEntityStorageInterface.
 *
 * @see \Drupal\Core\Entity\ContentEntityStorageInterface
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:50

public getRevisionMetadataKeys() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:60

public getRevisionMetadataKey($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:67

public hasRevisionMetadataKey($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:75

public setRevisionMetadataKey($key, $field_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:83

public get($property) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:381

public set($property, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:394

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:410

public isStaticallyCacheable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:417

public isRenderCacheable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:424

public isPersistentlyCacheable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:431

public getKeys() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:438

public getKey($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:445

public hasKey($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:453

public getOriginalClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:461

public getDecoratedClasses(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:468

public setClass($class) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:475

public entityClassImplements($interface) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:491

public getHandlerClasses() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:498

public getHandlerClass($handler_type, $nested = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:505

public setHandlerClass($handler_type, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:516

public hasHandlerClass($handler_type, $nested = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:524

public getStorageClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:539

public setStorageClass($class) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:546

public getFormClass($operation) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:565

public setFormClass($operation, $class) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:572

public hasFormClasses() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:580

public hasRouteProviders() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:587

public getListBuilderClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:594

public setListBuilderClass($class) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:601

public hasListBuilderClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:609

public getViewBuilderClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:616

public setViewBuilderClass($class) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:623

public hasViewBuilderClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:631

public getRouteProviderClasses() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:638

public getAccessControlClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:645

public setAccessClass($class) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:652

public getAdminPermission() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:660

public getCollectionPermission(): ?string {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:667

public getPermissionGranularity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:674

public getLinkTemplates() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:681

public getLinkTemplate($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:688

public hasLinkTemplate($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:696

public setLinkTemplate($key, $path) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:704

public getBundleEntityType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:716

public getBundleOf() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:723

public getBundleLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:730

public getBaseTable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:745

public showRevisionUi() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:752

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:759

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:766

public getRevisionDataTable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:774

public getRevisionTable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:781

public getDataTable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:788

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:795

public getCollectionLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:802

public getSingularLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:813

public getPluralLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:824

public getCountLabel($count) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:835

public getUriCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:849

public setUriCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:856

public getGroup() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:864

public getGroupLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:871

public getListCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:878

public getListCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:885

public getBundleListCacheTags(string $bundle): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:892

public isCommonReferenceTarget() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:909

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:916

public setConstraints(array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:923

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:931

public getBundleConfigDependency($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:939

public id() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Component\Plugin\Definition\PluginDefinition
Defined in <drupal>/core/lib/Drupal/Component/Plugin/Definition/PluginDefinition.php:35

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Component\Plugin\Definition\PluginDefinition
Defined in <drupal>/core/lib/Drupal/Component/Plugin/Definition/PluginDefinition.php:50

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Component\Plugin\Definition\PluginDefinition
Defined in <drupal>/core/lib/Drupal/Component/Plugin/Definition/PluginDefinition.php:57

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityType
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\Entity\EntityType
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\Entity\EntityType
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\Entity\EntityType
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\Entity\EntityType
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\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public const Drupal\Core\Entity\EntityTypeInterface::ID_MAX_LENGTH :: integer 32
public const Drupal\Core\Entity\EntityTypeInterface::BUNDLE_MAX_LENGTH :: integer 32

protected entityRepository -> Drupal\Core\Entity\EntityRepository#1231 (3)

Properties (3)
Methods (11)
Class constants (1)

protected entityTypeManager -> Drupal\Core\Entity\EntityTypeManager#269 Blacklisted

protected languageManager -> Drupal\Core\Language\LanguageManager#211 (5)

Properties (5)
Methods (20)
Static methods (2)

protected languages -> array (1)

en => array (1) Depth Limit

protected defaultLanguage -> Drupal\Core\Language\LanguageDefault#218 (1)

Properties (1)
Methods (3)

protected language -> Drupal\Core\Language\Language#209 Depth Limit

public __construct(array $values) Constructs the default language object.

/**
 * Constructs the default language object.
 *
 * @param array $values
 *   The properties used to construct the default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:30

public get(): \Drupal\Core\Language\LanguageInterface Gets the default language.

/**
 * Gets the default language.
 *
 * @return \Drupal\Core\Language\LanguageInterface
 *   The default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:40

public set(Drupal\Core\Language\LanguageInterface $language) Sets the default language.

/**
 * Sets the default language.
 *
 * @param \Drupal\Core\Language\LanguageInterface $language
 *   The default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:50

protected definedLanguageTypesInfo -> uninitialized

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs the language manager.

/**
 * Constructs the language manager.
 *
 * @param \Drupal\Core\Language\LanguageDefault $default_language
 *   The default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:46

public isMultilingual() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:53

public getLanguageTypes() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:60

public getDefinedLanguageTypesInfo(): array Returns information about all defined language types.

/**
 * Returns information about all defined language types.
 *
 * Defines the three core language types:
 * - Interface language is the only configurable language type in core. It is
 *   used by t() as the default language if none is specified.
 * - Content language is by default non-configurable and inherits the
 *   interface language negotiated value. It is used by the Field API to
 *   determine the display language for fields if no explicit value is
 *   specified.
 * - URL language is by default non-configurable and is determined through the
 *   URL language negotiation method or the URL fallback language negotiation
 *   method if no language can be detected. It is used by l() as the default
 *   language if none is specified.
 *
 * @return array
 *   An associative array of language type information arrays keyed by
 *   language type machine name, in the format of
 *   hook_language_types_info().
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:84

public getCurrentLanguage($type = 'language_interface') {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:107

public reset($type = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:114

public getDefaultLanguage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:121

public getLanguages($flags = 1) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:128

public getNativeLanguages() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:147

public getLanguage($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:155

public getLanguageName($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:163

public getDefaultLockedLanguages($weight = 0) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:179

public isLanguageLocked($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:207

public getFallbackCandidates(array $context = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:215

public getLanguageSwitchLinks($type, Drupal\Core\Url $url) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:222

public setConfigOverrideLanguage(?Drupal\Core\Language\LanguageInterface $language = null): $this Sets the configuration override language.

/**
 * Sets the configuration override language.
 *
 * This function is a noop since the configuration cannot be overridden by
 * language unless the Language module is enabled. That replaces the default
 * language manager with a configurable language manager.
 *
 * @param \Drupal\Core\Language\LanguageInterface $language
 *   The language to override configuration with.
 *
 * @return $this
 *
 * @see \Drupal\language\ConfigurableLanguageManager::setConfigOverrideLanguage()
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:387

public getConfigOverrideLanguage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:394

protected filterLanguages(array $languages, $flags = 1): \Drupal\Core\Language\LanguageInterface[] Filters the full list of languages based on the value of the flag.

/**
 * Filters the full list of languages based on the value of the flag.
 *
 * The locked languages are removed by default.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   Array with languages to be filtered.
 * @param int $flags
 *   (optional) Specifies the state of the languages that have to be returned.
 *   It can be: LanguageInterface::STATE_CONFIGURABLE,
 *   LanguageInterface::STATE_LOCKED, or LanguageInterface::STATE_ALL.
 *
 * @return \Drupal\Core\Language\LanguageInterface[]
 *   An associative array of languages, keyed by the language code.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:413

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

public static Drupal\Core\Language\LanguageManager::getStandardLanguageList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:229

public static Drupal\Core\Language\LanguageManager::getUnitedNationsLanguageList(): array The 6 official languages used at the United Nations.

/**
 * The 6 official languages used at the United Nations.
 *
 * This list is based on https://www.un.org/en/our-work/official-languages
 * and it uses the same format as getStandardLanguageList().
 *
 * @return array
 *   An array with language codes as keys, and English and native language
 *   names as values.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:360

protected contextRepository -> Drupal\Core\Plugin\Context\LazyContextRepository#1233 (3)

Properties (3)
Methods (3)

protected contextProviderServiceIDs -> array (6)
0 => string (33) "language.current_language_context"
1 => string (23) "node.node_route_context"
2 => string (41) "taxonomy_term.taxonomy_term_route_context"
3 => string (25) "user.current_user_context"
4 => string (29) "webform.webform_route_context"
5 => string (40) "webform.webform_submission_route_context"
protected container -> Drupal\Core\DependencyInjection\Container#37 Blacklisted
protected contexts -> array (0)

public __construct(Symfony\Component\DependencyInjection\ContainerInterface $container, array $context_provider_service_ids) Constructs a LazyContextRepository object.

/**
 * Constructs a LazyContextRepository object.
 *
 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 *   The current service container.
 * @param string[] $context_provider_service_ids
 *   The set of the available context provider service IDs.
 */

Defined in <drupal>/core/lib/Drupal/Core/Plugin/Context/LazyContextRepository.php:42

public getRuntimeContexts(array $context_ids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Plugin/Context/LazyContextRepository.php:50

public getAvailableContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Plugin/Context/LazyContextRepository.php:86

public __construct(Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager, Drupal\Core\Language\LanguageManagerInterface $language_manager, Drupal\Core\Plugin\Context\ContextRepositoryInterface $context_repository) Constructs a new EntityRepository.

/**
 * Constructs a new EntityRepository.
 *
 * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
 *   The entity type manager.
 * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
 *   The language manager.
 * @param \Drupal\Core\Plugin\Context\ContextRepositoryInterface $context_repository
 *   The context repository service.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:48

public loadEntityByUuid($entity_type_id, $uuid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:57

public loadEntityByConfigTarget($entity_type_id, $target) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:72

public getTranslationFromContext(Drupal\Core\Entity\EntityInterface $entity, $langcode = null, $context = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:94

public getActive($entity_type_id, $entity_id, ?array $contexts = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:130

public getActiveMultiple($entity_type_id, array $entity_ids, ?array $contexts = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:137

public getCanonical($entity_type_id, $entity_id, ?array $contexts = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:174

public getCanonicalMultiple($entity_type_id, array $entity_ids, ?array $contexts = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:181

protected getContentLanguageFromContexts(array $contexts): string|null Retrieves the current content language from the specified contexts.

/**
 * Retrieves the current content language from the specified contexts.
 *
 * This is a BC layer to support plugin context system identifiers, the
 * langcode key should be used instead and is preferred when given.
 *
 * @param string[] $contexts
 *   An array of context items.
 *
 * @return string|null
 *   A language code or NULL if no language context was provided.
 *
 * @internal
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:222

protected getLatestTranslationAffectedRevision(Drupal\Core\Entity\RevisionableInterface $entity, $langcode): \Drupal\Core\Entity\RevisionableInterface Returns the latest revision translation of the specified entity.

/**
 * Returns the latest revision translation of the specified entity.
 *
 * @param \Drupal\Core\Entity\RevisionableInterface $entity
 *   The default revision of the entity being converted.
 * @param string $langcode
 *   The language of the revision translation to be loaded.
 *
 * @return \Drupal\Core\Entity\RevisionableInterface
 *   The latest translation-affecting revision for the specified entity, or
 *   just the latest revision, if the specified entity is not translatable or
 *   does not have a matching translation yet.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:253

protected loadRevision(Drupal\Core\Entity\RevisionableInterface $entity, $revision_id): \Drupal\Core\Entity\RevisionableInterface Loads the specified entity revision.

/**
 * Loads the specified entity revision.
 *
 * @param \Drupal\Core\Entity\RevisionableInterface $entity
 *   The default revision of the entity being converted.
 * @param string $revision_id
 *   The identifier of the revision to be loaded.
 *
 * @return \Drupal\Core\Entity\RevisionableInterface
 *   An entity revision object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:299

public const Drupal\Core\Entity\EntityRepositoryInterface::CONTEXT_ID_LEGACY_CONTEXT_OPERATION :: string (43) "@entity.repository:legacy_context_operation"

protected entityDisplayRepository -> Drupal\Core\Entity\EntityDisplayRepository#1186 (7)

Properties (7)
Methods (23)
Class constants (1)

protected displayModeInfo -> array (1)

view_mode => array (13)

block => array (1) Depth Limit

block_content => array (2) Depth Limit

config_split => array (1) Depth Limit

file => array (7) Depth Limit

media => array (7) Depth Limit

menu_link_content => array (1) Depth Limit

node => array (7) Depth Limit

path_alias => array (1) Depth Limit

profile => array (4) Depth Limit

shortcut => array (1) Depth Limit

taxonomy_term => array (2) Depth Limit

tour => array (1) Depth Limit

user => array (3) Depth Limit

protected languageManager -> Drupal\Core\Language\LanguageManager#211 (5)

Properties (5)
Methods (20)
Static methods (2)

protected languages -> array (1)

en => array (1) Depth Limit

protected defaultLanguage -> Drupal\Core\Language\LanguageDefault#218 (1)

Properties (1)
Methods (3)

protected language -> Drupal\Core\Language\Language#209 Depth Limit

public __construct(array $values) Constructs the default language object.

/**
 * Constructs the default language object.
 *
 * @param array $values
 *   The properties used to construct the default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:30

public get(): \Drupal\Core\Language\LanguageInterface Gets the default language.

/**
 * Gets the default language.
 *
 * @return \Drupal\Core\Language\LanguageInterface
 *   The default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:40

public set(Drupal\Core\Language\LanguageInterface $language) Sets the default language.

/**
 * Sets the default language.
 *
 * @param \Drupal\Core\Language\LanguageInterface $language
 *   The default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:50

protected definedLanguageTypesInfo -> uninitialized

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs the language manager.

/**
 * Constructs the language manager.
 *
 * @param \Drupal\Core\Language\LanguageDefault $default_language
 *   The default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:46

public isMultilingual() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:53

public getLanguageTypes() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:60

public getDefinedLanguageTypesInfo(): array Returns information about all defined language types.

/**
 * Returns information about all defined language types.
 *
 * Defines the three core language types:
 * - Interface language is the only configurable language type in core. It is
 *   used by t() as the default language if none is specified.
 * - Content language is by default non-configurable and inherits the
 *   interface language negotiated value. It is used by the Field API to
 *   determine the display language for fields if no explicit value is
 *   specified.
 * - URL language is by default non-configurable and is determined through the
 *   URL language negotiation method or the URL fallback language negotiation
 *   method if no language can be detected. It is used by l() as the default
 *   language if none is specified.
 *
 * @return array
 *   An associative array of language type information arrays keyed by
 *   language type machine name, in the format of
 *   hook_language_types_info().
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:84

public getCurrentLanguage($type = 'language_interface') {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:107

public reset($type = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:114

public getDefaultLanguage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:121

public getLanguages($flags = 1) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:128

public getNativeLanguages() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:147

public getLanguage($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:155

public getLanguageName($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:163

public getDefaultLockedLanguages($weight = 0) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:179

public isLanguageLocked($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:207

public getFallbackCandidates(array $context = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:215

public getLanguageSwitchLinks($type, Drupal\Core\Url $url) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:222

public setConfigOverrideLanguage(?Drupal\Core\Language\LanguageInterface $language = null): $this Sets the configuration override language.

/**
 * Sets the configuration override language.
 *
 * This function is a noop since the configuration cannot be overridden by
 * language unless the Language module is enabled. That replaces the default
 * language manager with a configurable language manager.
 *
 * @param \Drupal\Core\Language\LanguageInterface $language
 *   The language to override configuration with.
 *
 * @return $this
 *
 * @see \Drupal\language\ConfigurableLanguageManager::setConfigOverrideLanguage()
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:387

public getConfigOverrideLanguage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:394

protected filterLanguages(array $languages, $flags = 1): \Drupal\Core\Language\LanguageInterface[] Filters the full list of languages based on the value of the flag.

/**
 * Filters the full list of languages based on the value of the flag.
 *
 * The locked languages are removed by default.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   Array with languages to be filtered.
 * @param int $flags
 *   (optional) Specifies the state of the languages that have to be returned.
 *   It can be: LanguageInterface::STATE_CONFIGURABLE,
 *   LanguageInterface::STATE_LOCKED, or LanguageInterface::STATE_ALL.
 *
 * @return \Drupal\Core\Language\LanguageInterface[]
 *   An associative array of languages, keyed by the language code.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:413

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

public static Drupal\Core\Language\LanguageManager::getStandardLanguageList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:229

public static Drupal\Core\Language\LanguageManager::getUnitedNationsLanguageList(): array The 6 official languages used at the United Nations.

/**
 * The 6 official languages used at the United Nations.
 *
 * This list is based on https://www.un.org/en/our-work/official-languages
 * and it uses the same format as getStandardLanguageList().
 *
 * @return array
 *   An array with language codes as keys, and English and native language
 *   names as values.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:360

protected entityTypeManager -> Drupal\Core\Entity\EntityTypeManager#269 Blacklisted

protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#653 Blacklisted

protected cacheBackend -> Drupal\Core\Cache\ChainedFastBackend#349 (4)

Properties (4)
Methods (17)
Class constants (2)

protected bin -> string (15) "cache_discovery"

protected consistentBackend -> Drupal\Core\Cache\DatabaseBackend#347 (6)

Properties (6)
Methods (20)
Class constants (4)

protected maxRows -> integer 5000
protected bin -> string (15) "cache_discovery"
protected connection -> Drupal\mysql\Driver\Database\mysql\Connection#23 Blacklisted
protected checksumProvider -> Drupal\Core\Cache\DatabaseCacheTagsChecksum#616 Depth Limit
protected serializer -> Drupal\Component\Serialization\PhpSerialize#619 Depth Limit
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit

public __construct(Drupal\Core\Database\Connection $connection, Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider, $bin, Drupal\Component\Serialization\ObjectAwareSerializationInterface $serializer, Drupal\Component\Datetime\TimeInterface $time, $max_rows = null) Constructs a DatabaseBackend object.

/**
 * Constructs a DatabaseBackend object.
 *
 * @param \Drupal\Core\Database\Connection $connection
 *   The database connection.
 * @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
 *   The cache tags checksum provider.
 * @param string $bin
 *   The cache bin for which the object is created.
 * @param \Drupal\Component\Serialization\ObjectAwareSerializationInterface|int|string|null $serializer
 *   (optional) The serializer to use.
 * @param \Drupal\Component\Datetime\TimeInterface|int|string|null $time
 *   The time service.
 * @param int $max_rows
 *   (optional) The maximum number of rows that are allowed in this cache bin
 *   table.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:88

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:108

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:117

protected prepareItem($cache, $allow_invalid): mixed|false Prepares a cached item.

/**
 * Prepares a cached item.
 *
 * Checks that items are either permanent or did not expire, and unserializes
 * data as appropriate.
 *
 * @param object $cache
 *   An item loaded from self::get() or self::getMultiple().
 * @param bool $allow_invalid
 *   If FALSE, the method returns FALSE if the cache item is not valid.
 *
 * @return mixed|false
 *   The item with data unserialized as appropriate and a property indicating
 *   whether the item is valid, or FALSE if there is no valid item to load.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:176

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:206

public setMultiple(array $items) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:219

protected doSetMultiple(array $items) Stores multiple items in the persistent cache.

/**
 * Stores multiple items in the persistent cache.
 *
 * @param array $items
 *   An array of cache items, keyed by cid.
 *
 * @see \Drupal\Core\Cache\CacheBackendInterface::setMultiple()
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:247

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:315

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:322

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:345

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:362

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:369

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:389

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:404

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:437

protected ensureBinExists() Check if the cache bin exists and create it if not.

/**
 * Check if the cache bin exists and create it if not.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:449

protected catchException(Exception $e, $table_name = null) Act on an exception when cache might be stale.

/**
 * Act on an exception when cache might be stale.
 *
 * If the table does not yet exist, that's fine, but if the table exists and
 * yet the query failed, then the cache is stale and the exception needs to
 * propagate.
 *
 * @param \Exception $e
 *   The exception.
 * @param string|null $table_name
 *   The table name. Defaults to $this->bin.
 *
 * @throws \Exception
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:481

protected normalizeCid($cid): string Normalizes a cache ID in order to comply with database limitations.

/**
 * Normalizes a cache ID in order to comply with database limitations.
 *
 * @param string $cid
 *   The passed in cache ID.
 *
 * @return string
 *   An ASCII-encoded cache ID that is at most 255 characters long.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:496

public schemaDefinition() Defines the schema for the {cache_*} bin tables.

/**
 * Defines the schema for the {cache_*} bin tables.
 *
 * @internal
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:519

public getMaxRows(): int Gets the maximum number of rows for this cache bin table.

/**
 * Gets the maximum number of rows for this cache bin table.
 *
 * @return int
 *   The maximum number of rows that this cache bin table is allowed to store.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:587

public const Drupal\Core\Cache\DatabaseBackend::DEFAULT_MAX_ROWS :: integer 5000
public const Drupal\Core\Cache\DatabaseBackend::MAXIMUM_NONE :: integer -1
public const Drupal\Core\Cache\DatabaseBackend::MAX_ITEMS_PER_CACHE_SET :: integer 100
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

protected fastBackend -> Drupal\Core\Cache\ApcuBackend#343 (5)

Properties (5)
Methods (17)
Class constants (1)

protected bin -> string (9) "discovery"
protected sitePrefix -> string (102) "drupal.apcu_backend.8ea27d7326d9ebea..ee6752e49a37f146cc48af66abc7f3bc8c6297...
```
drupal.apcu_backend.8ea27d7326d9ebea..ee6752e49a37f146cc48af66abc7f3bc8c62978f0d1160941cb918715e1c943d
```
protected binPrefix -> string (115) "drupal.apcu_backend.8ea27d7326d9ebea..ee6752e49a37f146cc48af66abc7f3bc8c6297...
```
drupal.apcu_backend.8ea27d7326d9ebea..ee6752e49a37f146cc48af66abc7f3bc8c62978f0d1160941cb918715e1c943d::discovery::
```
protected checksumProvider -> Drupal\Core\Cache\DatabaseCacheTagsChecksum#616 Depth Limit
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit

public __construct($bin, $site_prefix, Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider, Drupal\Component\Datetime\TimeInterface $time) Constructs a new ApcuBackend instance.

/**
 * Constructs a new ApcuBackend instance.
 *
 * @param string $bin
 *   The name of the cache bin.
 * @param string $site_prefix
 *   The prefix to use for all keys in the storage that belong to this site.
 * @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
 *   The cache tags checksum provider.
 * @param \Drupal\Component\Datetime\TimeInterface|null $time
 *   The time service.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:55

public getApcuKey($cid): string Prepends the APCu user variable prefix for this bin to a cache item ID.

/**
 * Prepends the APCu user variable prefix for this bin to a cache item ID.
 *
 * @param string $cid
 *   The cache item ID to prefix.
 *
 * @return string
 *   The APCu key for the cache item ID.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:76

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:83

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:91

protected getAll($prefix = ''): \APCUIterator Returns all cached items, optionally limited by a cache ID prefix.

/**
 * Returns all cached items, optionally limited by a cache ID prefix.
 *
 * APCu is a memory cache, shared across all server processes. To prevent
 * cache item clashes with other applications/installations, every cache item
 * is prefixed with a unique string for this site. Therefore, functions like
 * apcu_clear_cache() cannot be used, and instead, a list of all cache items
 * belonging to this application need to be retrieved through this method
 * instead.
 *
 * @param string $prefix
 *   (optional) A cache ID prefix to limit the result to.
 *
 * @return \APCUIterator
 *   An APCUIterator containing matched items.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:142

protected prepareItem($cache, $allow_invalid): mixed Prepares a cached item.

/**
 * Prepares a cached item.
 *
 * Checks that the item is either permanent or did not expire.
 *
 * @param object $cache
 *   An item loaded from self::get() or self::getMultiple().
 * @param bool $allow_invalid
 *   If TRUE, a cache item may be returned even if it is expired or has been
 *   invalidated. See ::get().
 *
 * @return mixed
 *   The cache item or FALSE if the item expired.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:160

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:185

public setMultiple(array $items = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:205

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:214

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:221

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:228

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:235

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:242

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:249

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:256

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:265

protected getIterator($search = null, $format = 4294967295, $chunk_size = 100, $list = 1): \APCUIterator Instantiates and returns the APCUIterator class.

/**
 * Instantiates and returns the APCUIterator class.
 *
 * @param mixed $search
 *   A PCRE regular expression that matches against APC key names, either as a
 *   string for a single regular expression, or as an array of regular
 *   expressions. Or, optionally pass in NULL to skip the search.
 * @param int $format
 *   The desired format, as configured with one or more of the APC_ITER_*
 *   constants.
 * @param int $chunk_size
 *   The chunk size. Must be a value greater than 0. The default value is 100.
 * @param int $list
 *   The type to list. Either pass in APC_LIST_ACTIVE or APC_LIST_DELETED.
 *
 * @return \APCUIterator
 *   An APCUIterator class.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:291

public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

protected lastWriteTimestamp -> double 1784189088.028

public __construct(Drupal\Core\Cache\CacheBackendInterface $consistent_backend, Drupal\Core\Cache\CacheBackendInterface $fast_backend, $bin) Constructs a ChainedFastBackend object.

/**
 * Constructs a ChainedFastBackend object.
 *
 * @param \Drupal\Core\Cache\CacheBackendInterface $consistent_backend
 *   The consistent cache backend.
 * @param \Drupal\Core\Cache\CacheBackendInterface $fast_backend
 *   The fast cache backend.
 * @param string $bin
 *   The cache bin for which the object is created.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:93

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:103

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:112

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:204

public setMultiple(array $items) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:221

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:229

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:237

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:245

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:253

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:260

public invalidateTags(array $tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:268

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:280

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:288

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:296

public reset()

/**
 * @todo Document in https://www.drupal.org/node/2311945.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:304

protected getLastWriteTimestamp() Gets the last write timestamp.

/**
 * Gets the last write timestamp.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:311

protected markAsOutdated() Marks the fast cache bin as outdated because of a write.

/**
 * Marks the fast cache bin as outdated because of a write.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:322

public const Drupal\Core\Cache\ChainedFastBackend::LAST_WRITE_TIMESTAMP_PREFIX :: string (21) "last_write_timestamp_"
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

protected useCaches -> boolean true

protected stringTranslation -> null

public __construct(Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\Cache\CacheBackendInterface $cache_backend, Drupal\Core\Language\LanguageManagerInterface $language_manager) Constructs a new EntityDisplayRepository.

/**
 * Constructs a new EntityDisplayRepository.
 *
 * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
 *   The entity type manager.
 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
 *   The module handler.
 * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
 *   The cache backend.
 * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
 *   The language manager.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:60

public getAllViewModes() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:70

public getViewModes($entity_type_id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:77

public getAllFormModes() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:84

public getFormModes($entity_type_id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:91

protected getAllDisplayModesByEntityType($display_type): array Gets the entity display mode info for all entity types.

/**
 * Gets the entity display mode info for all entity types.
 *
 * @param string $display_type
 *   The display type to be retrieved. It can be "view_mode" or "form_mode".
 *
 * @return array
 *   The display mode info for all entity types.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:104

protected getDisplayModesByEntityType($display_type, $entity_type_id): array Gets the entity display mode info for a specific entity type.

/**
 * Gets the entity display mode info for a specific entity type.
 *
 * @param string $display_type
 *   The display type to be retrieved. It can be "view_mode" or "form_mode".
 * @param string $entity_type_id
 *   The entity type whose display mode info should be returned.
 *
 * @return array
 *   The display mode info for a specific entity type.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:140

public getViewModeOptions($entity_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:156

public getFormModeOptions($entity_type_id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:163

public getViewModeOptionsByBundle($entity_type_id, $bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:170

public getFormModeOptionsByBundle($entity_type_id, $bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:177

protected getDisplayModeOptions($display_type, $entity_type_id): array Gets an array of display mode options.

/**
 * Gets an array of display mode options.
 *
 * @param string $display_type
 *   The display type to be retrieved. It can be "view_mode" or "form_mode".
 * @param string $entity_type_id
 *   The entity type whose display mode options should be returned.
 *
 * @return array
 *   An array of display mode labels, keyed by the display mode ID.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:192

protected getDisplayModeOptionsByBundle($display_type, $entity_type_id, $bundle): array Returns an array of enabled display mode options by bundle.

/**
 * Returns an array of enabled display mode options by bundle.
 *
 * @param string $display_type
 *   The display type to be retrieved. It can be "view_mode" or "form_mode".
 * @param string $entity_type_id
 *   The entity type whose display mode options should be returned.
 * @param string $bundle
 *   The name of the bundle.
 *
 * @return array
 *   An array of display mode labels, keyed by the display mode ID.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:213

public clearDisplayModeInfo() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:244

public getViewDisplay($entity_type, $bundle, $view_mode = 'default') {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:252

public getFormDisplay($entity_type, $bundle, $form_mode = 'default') {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:275

protected cacheGet($cid): object|false Fetches from the cache backend, respecting the use caches flag.

/**
 * Fetches from the cache backend, respecting the use caches flag.
 *
 * @param string $cid
 *   The cache ID of the data to retrieve.
 *
 * @return object|false
 *   The cache item or FALSE on failure.
 *
 * @see \Drupal\Core\Cache\CacheBackendInterface::get()
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php:35

protected cacheSet($cid, $data, $expire = -1, array $tags = array()) Stores data in the persistent cache, respecting the use caches flag.

/**
 * Stores data in the persistent cache, respecting the use caches flag.
 *
 * @param string $cid
 *   The cache ID of the data to store.
 * @param mixed $data
 *   The data to store in the cache.
 *   Some storage engines only allow objects up to a maximum of 1MB in size to
 *   be stored by default. When caching large arrays or similar, take care to
 *   ensure $data does not exceed this size.
 * @param int $expire
 *   One of the following values:
 *   - CacheBackendInterface::CACHE_PERMANENT: Indicates that the item should
 *     not be removed unless it is deleted explicitly.
 *   - A Unix timestamp: Indicates that the item will be considered invalid
 *     after this time, i.e. it will not be returned by get() unless
 *     $allow_invalid has been set to TRUE. When the item has expired, it may
 *     be permanently deleted by the garbage collector at any time.
 * @param array $tags
 *   An array of tags to be stored with the cache item. These should normally
 *   identify objects used to build the cache item, which should trigger
 *   cache invalidation when updated. For example if a cached item represents
 *   a node, both the node ID and the author's user ID might be passed in as
 *   tags. For example, ['node' => [123], 'user' => [92]].
 *
 * @see \Drupal\Core\Cache\CacheBackendInterface::set()
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php:69

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
 */

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.
 */

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.
 */

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.
 */

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
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public const Drupal\Core\Entity\EntityDisplayRepositoryInterface::DEFAULT_DISPLAY_MODE :: string (7) "default"

protected cacheBin -> string (6) "render"

protected languageManager -> Drupal\Core\Language\LanguageManager#211 (5)

Properties (5)
Methods (20)
Static methods (2)

protected languages -> array (1)
en => array (1)
3 => array (3) Depth Limit
protected defaultLanguage -> Drupal\Core\Language\LanguageDefault#218 (1)
- Properties (1)
- Methods (3)
- protected language -> Drupal\Core\Language\Language#209 (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 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) Depth Limit
 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"
- public __construct(array $values) Constructs the default language object.
 /** * Constructs the default language object. * * @param array $values * The properties used to construct the default language. */ Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:30
 public get(): \Drupal\Core\Language\LanguageInterface Gets the default language.
 /** * Gets the default language. * * @return \Drupal\Core\Language\LanguageInterface * The default language. */ Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:40
 public set(Drupal\Core\Language\LanguageInterface $language) Sets the default language.
 /** * Sets the default language. * * @param \Drupal\Core\Language\LanguageInterface $language * The default language. */ Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:50
protected definedLanguageTypesInfo -> uninitialized
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)

public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs the language manager.

/**
 * Constructs the language manager.
 *
 * @param \Drupal\Core\Language\LanguageDefault $default_language
 *   The default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:46

public isMultilingual() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:53

public getLanguageTypes() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:60

public getDefinedLanguageTypesInfo(): array Returns information about all defined language types.

/**
 * Returns information about all defined language types.
 *
 * Defines the three core language types:
 * - Interface language is the only configurable language type in core. It is
 *   used by t() as the default language if none is specified.
 * - Content language is by default non-configurable and inherits the
 *   interface language negotiated value. It is used by the Field API to
 *   determine the display language for fields if no explicit value is
 *   specified.
 * - URL language is by default non-configurable and is determined through the
 *   URL language negotiation method or the URL fallback language negotiation
 *   method if no language can be detected. It is used by l() as the default
 *   language if none is specified.
 *
 * @return array
 *   An associative array of language type information arrays keyed by
 *   language type machine name, in the format of
 *   hook_language_types_info().
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:84

public getCurrentLanguage($type = 'language_interface') {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:107

public reset($type = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:114

public getDefaultLanguage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:121

public getLanguages($flags = 1) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:128

public getNativeLanguages() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:147

public getLanguage($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:155

public getLanguageName($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:163

public getDefaultLockedLanguages($weight = 0) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:179

public isLanguageLocked($langcode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:207

public getFallbackCandidates(array $context = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:215

public getLanguageSwitchLinks($type, Drupal\Core\Url $url) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:222

public setConfigOverrideLanguage(?Drupal\Core\Language\LanguageInterface $language = null): $this Sets the configuration override language.

/**
 * Sets the configuration override language.
 *
 * This function is a noop since the configuration cannot be overridden by
 * language unless the Language module is enabled. That replaces the default
 * language manager with a configurable language manager.
 *
 * @param \Drupal\Core\Language\LanguageInterface $language
 *   The language to override configuration with.
 *
 * @return $this
 *
 * @see \Drupal\language\ConfigurableLanguageManager::setConfigOverrideLanguage()
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:387

public getConfigOverrideLanguage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:394

protected filterLanguages(array $languages, $flags = 1): \Drupal\Core\Language\LanguageInterface[] Filters the full list of languages based on the value of the flag.

/**
 * Filters the full list of languages based on the value of the flag.
 *
 * The locked languages are removed by default.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   Array with languages to be filtered.
 * @param int $flags
 *   (optional) Specifies the state of the languages that have to be returned.
 *   It can be: LanguageInterface::STATE_CONFIGURABLE,
 *   LanguageInterface::STATE_LOCKED, or LanguageInterface::STATE_ALL.
 *
 * @return \Drupal\Core\Language\LanguageInterface[]
 *   An associative array of languages, keyed by the language code.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:413

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

public static Drupal\Core\Language\LanguageManager::getStandardLanguageList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:229

public static Drupal\Core\Language\LanguageManager::getUnitedNationsLanguageList(): array The 6 official languages used at the United Nations.

/**
 * The 6 official languages used at the United Nations.
 *
 * This list is based on https://www.un.org/en/our-work/official-languages
 * and it uses the same format as getStandardLanguageList().
 *
 * @return array
 *   An array with language codes as keys, and English and native language
 *   names as values.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:360

protected themeRegistry -> Drupal\Core\Theme\Registry#1140 (18)

Properties (18)
Methods (19)
Class constants (2)

protected theme -> Drupal\Core\Theme\ActiveTheme#1978 (11)

Properties (11)
Methods (12)

protected name -> string (9) "catharsis"

protected logo -> string (32) "themes/custom/catharsis/logo.svg"

protected path -> string (23) "themes/custom/catharsis"

Directory

drwxrwxr-x 33 33 4096 Jul 14 15:29 themes/custom/catharsis

protected engine -> string (4) "twig"

protected owner -> string (36) "core/themes/engines/twig/twig.engine"

File (5.7KB)

-rw-rw-r-- 33 33 5815 Jun 23 00:19 core/themes/engines/twig/twig.engine

protected baseThemeExtensions -> array (0)

protected extension -> Drupal\Core\Extension\Extension#1980 (17)

Properties (17)
Methods (14)

protected type -> string (5) "theme"
protected pathname -> string (42) "themes/custom/catharsis/catharsis.info.yml"
- File (843B)
- ```
-rw-rw-r-- 33 33 843 Jul 13 22:45 themes/custom/catharsis/catharsis.info.yml
```
protected filename -> string (15) "catharsis.theme"
protected splFileInfo -> null
protected root -> string (17) "/var/www/html/web"
- Directory
- ```
drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web
```
public info -> array (21) Depth Limit
subpath -> string (23) "themes/custom/catharsis"
- Directory
- ```
drwxrwxr-x 33 33 4096 Jul 14 15:29 themes/custom/catharsis
```
origin -> string (0) ""
owner -> string (36) "core/themes/engines/twig/twig.engine"
- File (5.7KB)
- ```
-rw-rw-r-- 33 33 5815 Jun 23 00:19 core/themes/engines/twig/twig.engine
```
prefix -> string (4) "twig"
status -> integer 1
required_by -> array (0)
requires -> array (0)
sort -> integer 0
module_dependencies -> array (0)
libraries -> array (1) Depth Limit
engine -> string (4) "twig"

public __construct($root, $type, $pathname, $filename = null) Constructs a new Extension object.

/**
 * Constructs a new Extension object.
 *
 * @param string $root
 *   The app root.
 * @param string $type
 *   The type of the extension; e.g., 'module'.
 * @param string $pathname
 *   The relative path and filename of the extension's info file; e.g.,
 *   'core/modules/node/node.info.yml'.
 * @param string $filename
 *   (optional) The filename of the main extension file; e.g., 'node.module'.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:73

public getType(): string Returns the type of the extension.

/**
 * Returns the type of the extension.
 *
 * @return string
 *   The extension type. This is usually 'module' or 'theme'.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:88

public getName(): string Returns the internal name of the extension.

/**
 * Returns the internal name of the extension.
 *
 * @return string
 *   The machine name of the extension.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:98

public getPath(): string Returns the relative path of the extension.

/**
 * Returns the relative path of the extension.
 *
 * @return string
 *   The relative path of the extension.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:108

public getPathname(): string Returns the relative path and filename of the extension's info file.

/**
 * Returns the relative path and filename of the extension's info file.
 *
 * @return string
 *   The relative path and filename of the extension's .info file.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:118

public getFilename(): string Returns the filename of the extension's info file.

/**
 * Returns the filename of the extension's info file.
 *
 * @return string
 *   The base name of the extension .info file.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:128

public getExtensionPathname(): string|null Returns the relative path of the main extension file, if any.

/**
 * Returns the relative path of the main extension file, if any.
 *
 * @return string|null
 *   The relative path for the main extension file, usually the *.module file.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:138

public getExtensionFilename(): string|null Returns the name of the main extension file, if any.

/**
 * Returns the name of the main extension file, if any.
 *
 * @return string|null
 *   The filename of the main extension file, usually the *.module file.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:150

public load(): bool Loads the main extension file, if any.

/**
 * Loads the main extension file, if any.
 *
 * @return bool
 *   TRUE if this extension has a main extension file, FALSE otherwise.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:160

public getFileInfo(): SplFileInfo Returns SplFileInfo instance for the extension's info file.

/**
 * Returns SplFileInfo instance for the extension's info file.
 *
 * @return \SplFileInfo
 *   The object to access a file information of info file.
 *
 * @see https://www.php.net/manual/class.splfileinfo.php
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:176

public __sleep(): array Magic method implementation to serialize the extension object.

/**
 * Magic method implementation to serialize the extension object.
 *
 * @return array
 *   The names of all variables that should be serialized.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:189

public __wakeup(): void Magic method implementation to unserialize the extension object.

/**
 * Magic method implementation to unserialize the extension object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:202

public isExperimental(): bool Checks if an extension is marked as experimental.

/**
 * Checks if an extension is marked as experimental.
 *
 * @return bool
 *   TRUE if an extension is marked as experimental, FALSE otherwise.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:219

public isObsolete(): bool Checks if an extension is marked as obsolete.

/**
 * Checks if an extension is marked as obsolete.
 *
 * @return bool
 *   TRUE if an extension is marked as obsolete, FALSE otherwise.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:230

protected libraries -> array (1)

0 => string (16) "catharsis/global"

protected regions -> array (18)

header => string (6) "Header"

account_menu => string (12) "Account Menu"

primary_menu => string (12) "Primary Menu"

secondary_menu => string (14) "Secondary Menu"

mobile_menu => string (11) "Mobile Menu"

hero => string (4) "Hero"

page_title => string (10) "Page Title"

system => string (6) "System"

content_top => string (11) "Content Top"

content => string (7) "Content"

content_bottom => string (14) "Content Bottom"

sidebar_primary => string (15) "Primary Sidebar"

sidebar_secondary => string (17) "Secondary Sidebar"

footer_above => string (12) "Footer Above"

footer_brand => string (12) "Footer Brand"

footer_primary => string (14) "Footer Primary"

footer_secondary => string (16) "Footer Secondary"

footer_bottom => string (13) "Footer Bottom"

protected librariesOverride -> array (0)

protected librariesExtend -> array (0)

public __construct(array $values) Constructs an ActiveTheme object.

/**
 * Constructs an ActiveTheme object.
 *
 * @param array $values
 *   The properties of the object, keyed by the names.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:99

public getName(): string Returns the machine name of the theme.

/**
 * Returns the machine name of the theme.
 *
 * @return string
 *   The machine name for the theme.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:132

public getPath(): string Returns the path to the theme directory.

/**
 * Returns the path to the theme directory.
 *
 * @return string
 *   The file path of the theme directory.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:142

public getEngine(): string Returns the theme engine.

/**
 * Returns the theme engine.
 *
 * @return string
 *   The engine of the theme.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:152

public getOwner(): mixed Returns the path to the theme engine for root themes.

/**
 * Returns the path to the theme engine for root themes.
 *
 * @return mixed
 *   The path to the theme engine for root themes.
 *
 * @see \Drupal\Core\Extension\ThemeExtensionList::doList()
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:164

public getExtension(): \Drupal\Core\Extension\Extension Returns the extension object.

/**
 * Returns the extension object.
 *
 * @return \Drupal\Core\Extension\Extension
 *   The extension object for the theme.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:175

public getLibraries(): mixed Returns the libraries provided by the theme.

/**
 * Returns the libraries provided by the theme.
 *
 * @return mixed
 *   The libraries provided by the theme.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:185

public getBaseThemeExtensions(): \Drupal\Core\Extension\Extension[] Returns an array of base theme extension objects keyed by name.

/**
 * Returns an array of base theme extension objects keyed by name.
 *
 * The order starts with the base theme of $this and ends with the root of
 * the dependency chain. For most use cases, parent themes are expected to
 * be called first, so this order needs to be reversed with array_reverse()
 *
 * @return \Drupal\Core\Extension\Extension[]
 *   An array of base theme extension objects keyed by name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:199

public getLogo(): string Returns the logo provided by the theme.

/**
 * Returns the logo provided by the theme.
 *
 * @return string
 *   The logo path.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:209

public getRegions(): string[] The regions used by the theme.

/**
 * The regions used by the theme.
 *
 * @return string[]
 *   The list of region machine names supported by the theme.
 *
 * @see system_region_list()
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:221

public getLibrariesOverride(): array Returns the libraries or library assets overridden by the active theme.

/**
 * Returns the libraries or library assets overridden by the active theme.
 *
 * @return array
 *   The list of libraries overrides.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:231

public getLibrariesExtend(): array Returns the libraries extended by the active theme.

/**
 * Returns the libraries extended by the active theme.
 *
 * @return array
 *   The list of libraries-extend definitions.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:241

protected lock -> Drupal\Core\ProxyClass\Lock\DatabaseLockBackend#340 (5)

Properties (5)
Methods (11)

protected drupalProxyOriginalServiceId -> string (34) "drupal.proxy_original_service.lock"
protected service -> null
protected container -> Drupal\Core\DependencyInjection\Container#37 Blacklisted
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)

public __construct(Symfony\Component\DependencyInjection\ContainerInterface $container, $drupal_proxy_original_service_id) Constructs a ProxyClass Drupal proxy object.

/**
 * Constructs a ProxyClass Drupal proxy object.
 *
 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 *   The container.
 * @param string $drupal_proxy_original_service_id
 *   The service ID of the original service.
 */

Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:49

protected lazyLoadItself(): object Lazy loads the real service from the container.

/**
 * Lazy loads the real service from the container.
 *
 * @return object
 *   Returns the constructed real service.
 */

Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:61

public acquire($name, $timeout = 30.0) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:73

public lockMayBeAvailable($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:81

public release($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:89

public releaseAll($lock_id = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:97

public schemaDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:105

public wait($name, $delay = 30) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:113

public getLockId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:121

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected registry -> array (0)

protected cache -> Drupal\Core\Cache\DatabaseBackend#182 (6)

Properties (6)
Methods (20)
Class constants (4)

protected maxRows -> integer 5000

protected bin -> string (13) "cache_default"

protected connection -> Drupal\mysql\Driver\Database\mysql\Connection#23 Blacklisted

protected checksumProvider -> Drupal\Core\Cache\DatabaseCacheTagsChecksum#616 (5)

Properties (5)
Methods (14)
Class constants (1)

protected connection -> Drupal\mysql\Driver\Database\mysql\Connection#23 Blacklisted
protected invalidatedTags -> array (0)
protected delayedTags -> array (0)
protected tagCache -> array (10) Depth Limit
protected preloadTags -> array (0)

public __construct(Drupal\Core\Database\Connection $connection) Constructs a DatabaseCacheTagsChecksum object.

/**
 * Constructs a DatabaseCacheTagsChecksum object.
 *
 * @param \Drupal\Core\Database\Connection $connection
 *   The database connection.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:28

protected doInvalidateTags(array $tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:35

protected getTagInvalidationCounts(array $tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:58

public purge(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:75

protected ensureTableExists() Check if the cache tags table exists and create it if not.

/**
 * Check if the cache tags table exists and create it if not.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:91

public schemaDefinition() Defines the schema for the {cachetags} table.

/**
 * Defines the schema for the {cachetags} table.
 *
 * @internal
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:113

public getDatabaseConnection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:139

public rootTransactionEndCallback($success) Callback to be invoked just after a database transaction gets committed.

/**
 * Callback to be invoked just after a database transaction gets committed.
 *
 * Executes all delayed tag invalidations.
 *
 * @param bool $success
 *   Whether or not the transaction was successful.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:48

public invalidateTags(array $tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:58

public getCurrentChecksum(array $tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:89

public isValid($checksum, array $tags) Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::isValid()

/**
 * Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::isValid()
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:111

protected calculateChecksum(array $tags): int Calculates the current checksum for a given set of tags.

/**
 * Calculates the current checksum for a given set of tags.
 *
 * @param string[] $tags
 *   The array of tags to calculate the checksum for.
 *
 * @return int
 *   The calculated checksum.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:139

public reset() Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::reset()

/**
 * Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::reset()
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:176

public registerCacheTagsForPreload(array $cache_tags): void Implements \Drupal\Core\Cache\CacheTagsChecksumPreloadInterface::registerCach...

/**
 * Implements \Drupal\Core\Cache\CacheTagsChecksumPreloadInterface::registerCacheTagsForPreload()
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:184

public const Drupal\Core\Cache\CacheTagsChecksumInterface::INVALID_CHECKSUM_WHILE_IN_TRANSACTION :: integer -1

protected serializer -> Drupal\Component\Serialization\PhpSerialize#619

Static methods (3)

public static Drupal\Component\Serialization\PhpSerialize::encode($data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Component/Serialization/PhpSerialize.php:13

public static Drupal\Component\Serialization\PhpSerialize::decode($raw) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Component/Serialization/PhpSerialize.php:20

public static Drupal\Component\Serialization\PhpSerialize::getFileExtension() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Component/Serialization/PhpSerialize.php:27

protected time -> Drupal\Component\Datetime\Time#613 (2)

Properties (2)
Methods (7)

protected requestStack -> Symfony\Component\HttpFoundation\RequestStack#30 Depth Limit
protected proxyRequestTime -> uninitialized

public __construct(?Symfony\Component\HttpFoundation\RequestStack $request_stack = null) Constructs a Time object.

/**
 * Constructs a Time object.
 *
 * @param \Symfony\Component\HttpFoundation\RequestStack|null $request_stack
 *   (Optional) The request stack.
 */

Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:34

public getRequestTime() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:41

public getRequestMicroTime() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:54

public getCurrentTime() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:67

public getCurrentMicroTime() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:74

protected getProxyRequestTime(): int Returns a mimic of the timestamp of the current request.

/**
 * Returns a mimic of the timestamp of the current request.
 *
 * @return int
 *   A value returned by time().
 */

Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:84

protected getProxyRequestMicroTime(): float Returns a mimic of the timestamp of the current request.

/**
 * Returns a mimic of the timestamp of the current request.
 *
 * @return float
 *   A value returned by microtime().
 */

Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:97

/**
 * Constructs a DatabaseBackend object.
 *
 * @param \Drupal\Core\Database\Connection $connection
 *   The database connection.
 * @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
 *   The cache tags checksum provider.
 * @param string $bin
 *   The cache bin for which the object is created.
 * @param \Drupal\Component\Serialization\ObjectAwareSerializationInterface|int|string|null $serializer
 *   (optional) The serializer to use.
 * @param \Drupal\Component\Datetime\TimeInterface|int|string|null $time
 *   The time service.
 * @param int $max_rows
 *   (optional) The maximum number of rows that are allowed in this cache bin
 *   table.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:88

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:108

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:117

protected prepareItem($cache, $allow_invalid): mixed|false Prepares a cached item.

/**
 * Prepares a cached item.
 *
 * Checks that items are either permanent or did not expire, and unserializes
 * data as appropriate.
 *
 * @param object $cache
 *   An item loaded from self::get() or self::getMultiple().
 * @param bool $allow_invalid
 *   If FALSE, the method returns FALSE if the cache item is not valid.
 *
 * @return mixed|false
 *   The item with data unserialized as appropriate and a property indicating
 *   whether the item is valid, or FALSE if there is no valid item to load.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:176

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:206

public setMultiple(array $items) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:219

protected doSetMultiple(array $items) Stores multiple items in the persistent cache.

/**
 * Stores multiple items in the persistent cache.
 *
 * @param array $items
 *   An array of cache items, keyed by cid.
 *
 * @see \Drupal\Core\Cache\CacheBackendInterface::setMultiple()
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:247

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:315

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:322

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:345

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:362

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:369

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:389

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:404

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:437

protected ensureBinExists() Check if the cache bin exists and create it if not.

/**
 * Check if the cache bin exists and create it if not.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:449

protected catchException(Exception $e, $table_name = null) Act on an exception when cache might be stale.

/**
 * Act on an exception when cache might be stale.
 *
 * If the table does not yet exist, that's fine, but if the table exists and
 * yet the query failed, then the cache is stale and the exception needs to
 * propagate.
 *
 * @param \Exception $e
 *   The exception.
 * @param string|null $table_name
 *   The table name. Defaults to $this->bin.
 *
 * @throws \Exception
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:481

protected normalizeCid($cid): string Normalizes a cache ID in order to comply with database limitations.

/**
 * Normalizes a cache ID in order to comply with database limitations.
 *
 * @param string $cid
 *   The passed in cache ID.
 *
 * @return string
 *   An ASCII-encoded cache ID that is at most 255 characters long.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:496

public schemaDefinition() Defines the schema for the {cache_*} bin tables.

/**
 * Defines the schema for the {cache_*} bin tables.
 *
 * @internal
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:519

public getMaxRows(): int Gets the maximum number of rows for this cache bin table.

/**
 * Gets the maximum number of rows for this cache bin table.
 *
 * @return int
 *   The maximum number of rows that this cache bin table is allowed to store.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:587

public const Drupal\Core\Cache\DatabaseBackend::DEFAULT_MAX_ROWS :: integer 5000
public const Drupal\Core\Cache\DatabaseBackend::MAXIMUM_NONE :: integer -1
public const Drupal\Core\Cache\DatabaseBackend::MAX_ITEMS_PER_CACHE_SET :: integer 100
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#653 Blacklisted

protected runtimeRegistry -> array (1)

catharsis => Drupal\Core\Utility\ThemeRegistry#1945 (12)

Properties (12)
Methods (17)

protected cid -> string (32) "theme_registry:runtime:catharsis"
protected tags -> array (0)
protected cache -> Drupal\Core\Cache\ChainedFastBackend#665 Depth Limit
protected lock -> Drupal\Core\ProxyClass\Lock\DatabaseLockBackend#340 Depth Limit
protected keysToPersist -> array (0)
protected keysToRemove -> array (0)
protected storage -> array (430) Depth Limit
protected cacheCreated -> null
protected cacheInvalidated -> boolean false
protected cacheLoaded -> boolean true
protected persistable -> boolean true
protected completeRegistry -> null

public __construct($cid, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Lock\LockBackendInterface $lock, $tags = array(), $modules_loaded = false) Constructs a ThemeRegistry object.

/**
 * Constructs a ThemeRegistry object.
 *
 * @param string $cid
 *   The cid for the array being cached.
 * @param \Drupal\Core\Cache\CacheBackendInterface $cache
 *   The cache backend.
 * @param \Drupal\Core\Lock\LockBackendInterface $lock
 *   The lock backend.
 * @param array $tags
 *   (optional) The tags to specify for the cache item.
 * @param bool $modules_loaded
 *   Whether all modules have already been loaded.
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:53

public initializeRegistry(): array Initializes the full theme registry.

/**
 * Initializes the full theme registry.
 *
 * @return array
 *   An array with the keys of the full theme registry, but the values
 *   initialized to NULL.
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:88

public has($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:98

public get($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:109

public resolveCacheMiss($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:124

protected updateCache($lock = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:138

public getPreprocessInvokes(): array Gets preprocess invoke map.

/**
 * Gets preprocess invoke map.
 *
 * @return array
 *   An array of preprocess invokes for preprocess functions in modules.
 *
 * @internal
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:179

public getGlobalPreprocess(): array Gets global preprocess callbacks.

/**
 * Gets global preprocess callbacks.
 *
 * @return array
 *   An array of preprocess callbacks that should be called for every theme
 *   hook.
 *
 * @internal
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:192

protected getCid(): string Gets the cache ID.

/**
 * Gets the cache ID.
 *
 * @return string
 *   The cache ID.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:127

public set($key, $value) Implements \Drupal\Core\Cache\CacheCollectorInterface::set().

/**
 * Implements \Drupal\Core\Cache\CacheCollectorInterface::set().
 *
 * This is not persisted by default. In practice this means that setting a
 * value will only apply while the object is in scope and will not be written
 * back to the persistent cache. This follows a similar pattern to static vs.
 * persistent caching in procedural code. Extending classes may wish to alter
 * this behavior, for example by adding a call to persist(). If you are
 * writing data to somewhere in addition to the cache item in ::set(), you
 * should call static::updateCache() at the end of your ::set implementation.
 * This avoids a race condition if another request starts with an empty cache
 * before your ::set() call. For example: Drupal\Core\State\State.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:166

public delete($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:177

protected persist($key, $persist = true) Flags an offset value to be written to the persistent cache.

/**
 * Flags an offset value to be written to the persistent cache.
 *
 * @param string $key
 *   The key that was requested.
 * @param bool $persist
 *   (optional) Whether the offset should be persisted or not, defaults to
 *   TRUE. When called with $persist = FALSE the offset will be un-flagged so
 *   that it will not be written at the end of the request.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:196

public reset() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:289

public clear() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:299

public destruct() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:312

protected lazyLoadCache() Loads the cache if not already done.

/**
 * Loads the cache if not already done.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:319

protected invalidateCache() Invalidate the cache.

/**
 * Invalidate the cache.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:335

protected initialized -> boolean false

protected themeName -> null

protected root -> string (17) "/var/www/html/web"

Directory

drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web

protected themeHandler -> Drupal\Core\Extension\ThemeHandler#1129 (4)

Properties (4)
Methods (13)

protected list -> array (5)

claro => Drupal\Core\Extension\Extension#1967 Depth Limit

olivero => Drupal\Core\Extension\Extension#1965 Depth Limit

gin => Drupal\Core\Extension\Extension#1958 Depth Limit

tonic => Drupal\Core\Extension\Extension#1977 Depth Limit

catharsis => Drupal\Core\Extension\Extension#1976 Depth Limit

protected configFactory -> Drupal\Core\Config\ConfigFactory#356 Blacklisted

protected themeList -> Drupal\Core\Extension\ThemeExtensionList#1139 (15)

Properties (15)
Methods (27)
Static methods (1)

protected type -> string (5) "theme"
protected root -> string (17) "/var/www/html/web"
- Directory
- ```
drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web
```
protected cache -> Drupal\Core\Cache\ChainedFastBackend#665 Depth Limit
protected defaults -> array (11) Depth Limit
protected infoParser -> Drupal\Core\Extension\InfoParser#1136 Depth Limit
protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#653 Blacklisted
protected extensions -> array (8) Depth Limit
protected extensionInfo -> null
protected pathNames -> array (8) Depth Limit
protected addedPathNames -> array (0)
protected state -> Drupal\Core\State\State#337 Depth Limit
protected installProfile -> string (6) "ignite"
protected configFactory -> Drupal\Core\Config\ConfigFactory#356 Blacklisted
protected engineList -> Drupal\Core\Extension\ThemeEngineExtensionList#1144 Depth Limit
protected installedThemes -> null

public __construct($root, $type, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\InfoParserInterface $info_parser, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\State\StateInterface $state, Drupal\Core\Config\ConfigFactoryInterface $config_factory, Drupal\Core\Extension\ThemeEngineExtensionList $engine_list, $install_profile) Constructs a new ThemeExtensionList instance.

/**
 * Constructs a new ThemeExtensionList instance.
 *
 * @param string $root
 *   The app root.
 * @param string $type
 *   The extension type.
 * @param \Drupal\Core\Cache\CacheBackendInterface $cache
 *   The cache.
 * @param \Drupal\Core\Extension\InfoParserInterface $info_parser
 *   The info parser.
 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
 *   The module handler.
 * @param \Drupal\Core\State\StateInterface $state
 *   The state service.
 * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
 *   The config factory.
 * @param \Drupal\Core\Extension\ThemeEngineExtensionList $engine_list
 *   The theme engine extension listing.
 * @param string $install_profile
 *   The install profile used by the site.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:101

protected doList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:111

protected fillInSubThemeData(array &$themes, array $sub_themes) Fills in data for themes that are also sub-themes.

/**
 * Fills in data for themes that are also sub-themes.
 *
 * @param array $themes
 *   The array of partly processed theme information.
 * @param array $sub_themes
 *   A list of themes from the $theme array that are also sub-themes.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:172

public getBaseThemes(array $themes, $theme): array Finds all the base themes for the specified theme.

/**
 * Finds all the base themes for the specified theme.
 *
 * Themes can inherit templates and function implementations from earlier
 * themes.
 *
 * @param \Drupal\Core\Extension\Extension[] $themes
 *   An array of available themes.
 * @param string $theme
 *   The name of the theme whose base we are looking for.
 *
 * @return array
 *   Returns an array of all of the theme's ancestors; the first element's
 *   value will be NULL if an error occurred.
 *
 * @deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. There
 *   is no direct replacement.
 *
 * @see https://www.drupal.org/node/3413187
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:219

protected doGetBaseThemes(array $themes, $theme, array $used_themes = array()): array Finds the base themes for the specific theme.

/**
 * Finds the base themes for the specific theme.
 *
 * @param array $themes
 *   An array of available themes.
 * @param string $theme
 *   The name of the theme whose base we are looking for.
 * @param array $used_themes
 *   (optional) A recursion parameter preventing endless loops. Defaults to
 *   an empty array.
 *
 * @return array
 *   An array of base themes.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:238

protected createExtensionInfo(Drupal\Core\Extension\Extension $extension) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:271

protected getInstalledExtensionNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:299

public reset() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:310

protected getExtensionDiscovery(): \Drupal\Core\Extension\ExtensionDiscovery Returns the extension discovery.

/**
 * Returns the extension discovery.
 *
 * @return \Drupal\Core\Extension\ExtensionDiscovery
 *   The extension discovery.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:153

protected getListCacheId(): string Returns the extension list cache ID.

/**
 * Returns the extension list cache ID.
 *
 * @return string
 *   The list cache ID.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:193

protected getInfoCacheId(): string Returns the extension info cache ID.

/**
 * Returns the extension info cache ID.
 *
 * @return string
 *   The info cache ID.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:203

protected getPathNamesCacheId(): string Returns the extension filenames cache ID.

/**
 * Returns the extension filenames cache ID.
 *
 * @return string
 *   The filename cache ID.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:213

public exists($extension_name): bool Determines if an extension exists in the filesystem.

/**
 * Determines if an extension exists in the filesystem.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 *
 * @return bool
 *   TRUE if the extension exists (regardless installed or not) and FALSE if
 *   not.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:227

public getName($extension_name): string Returns the human-readable name of the extension.

/**
 * Returns the human-readable name of the extension.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 *
 * @return string
 *   The human-readable name of the extension.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:244

public get($extension_name): \Drupal\Core\Extension\Extension Returns a single extension.

/**
 * Returns a single extension.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 *
 * @return \Drupal\Core\Extension\Extension
 *   A processed extension object for the extension with the specified machine
 *   name.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:261

public getList(): \Drupal\Core\Extension\Extension[] Returns all available extensions.

/**
 * Returns all available extensions.
 *
 * @return \Drupal\Core\Extension\Extension[]
 *   Processed extension objects, keyed by machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:276

protected doScanExtensions(): \Drupal\Core\Extension\Extension[] Scans the available extensions.

/**
 * Scans the available extensions.
 *
 * Overriding this method gives other code the chance to add additional
 * extensions to this raw listing.
 *
 * @return \Drupal\Core\Extension\Extension[]
 *   Unprocessed extension objects, keyed by machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:299

public getExtensionInfo($extension_name): mixed[] Returns information about a specified extension.

/**
 * Returns information about a specified extension.
 *
 * This function returns the contents of the .info.yml file for the specified
 * extension.
 *
 * @param string $extension_name
 *   The name of an extension whose information shall be returned.
 *
 * @return mixed[]
 *   An associative array of extension information.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:343

public getAllAvailableInfo(): array[] Returns an array of info files information of available extensions.

/**
 * Returns an array of info files information of available extensions.
 *
 * This function returns the processed contents (with added defaults) of the
 * .info.yml files.
 *
 * @return array[]
 *   An associative array of extension information arrays, keyed by extension
 *   name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:361

public getAllInstalledInfo(): array[] Returns an array of info files information of installed extensions.

/**
 * Returns an array of info files information of installed extensions.
 *
 * This function returns the processed contents (with added defaults) of the
 * .info.yml files.
 *
 * @return array[]
 *   An associative array of extension information arrays, keyed by extension
 *   name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:395

protected recalculateInfo(): array[] Generates the information from .info.yml files for extensions of this type.

/**
 * Generates the information from .info.yml files for extensions of this type.
 *
 * @return array[]
 *   An array of arrays of .info.yml entries keyed by the machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:405

public getPathNames(): string[] Returns a list of extension file paths keyed by machine name.

/**
 * Returns a list of extension file paths keyed by machine name.
 *
 * @return string[]
 *   An associative array of extension file paths, keyed by the extension
 *   machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:418

protected recalculatePathNames(): string[] Generates a sorted list of .info.yml file locations for all extensions.

/**
 * Generates a sorted list of .info.yml file locations for all extensions.
 *
 * @return string[]
 *   An array of .info.yml file locations keyed by the extension machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:439

public setPathname($extension_name, $pathname) Sets the pathname for an extension.

/**
 * Sets the pathname for an extension.
 *
 * This method is used in the Drupal bootstrapping phase, when the extension
 * system is not fully initialized, to manually set locations of modules and
 * profiles needed to complete bootstrapping.
 *
 * It is not recommended to call this method except in those rare cases.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 * @param string $pathname
 *   The pathname of the extension which is to be set explicitly rather
 *   than by consulting the dynamic extension listing.
 *
 * @internal
 *
 * @see ::getPathname
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:467

public getPathname($extension_name): string Gets the info file path for an extension.

/**
 * Gets the info file path for an extension.
 *
 * The info path, whether provided, cached, or retrieved from the database, is
 * only returned if the file exists.
 *
 * This function plays a key role in allowing Drupal's extensions (modules,
 * themes, profiles, theme_engines, etc.) to be located in different places
 * depending on a site's configuration. For example, a module 'foo' may
 * legally be located in any of these four places:
 *
 * - core/modules/foo/foo.info.yml
 * - modules/foo/foo.info.yml
 * - sites/all/modules/foo/foo.info.yml
 * - sites/example.com/modules/foo/foo.info.yml
 *
 * while a theme 'bar' may be located in any of the following four places:
 *
 * - core/themes/bar/bar.info.yml
 * - themes/bar/bar.info.yml
 * - sites/all/themes/bar/bar.info.yml
 * - sites/example.com/themes/bar/bar.info.yml
 *
 * An installation profile maybe be located in any of the following places:
 *
 * - core/profiles/baz/baz.info.yml
 * - profiles/baz/baz.info.yml
 *
 * Calling ExtensionList::getPathname('foo') will give you one of the above,
 * depending on where the extension is located and what type it is.
 *
 * @param string $extension_name
 *   The machine name of the extension for which the pathname is requested.
 *
 * @return string
 *   The drupal-root relative filename and path of the requested extension's
 *   .info.yml file.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:512

public getPath($extension_name): string Gets the path to an extension of a specific type (module, theme, etc.).

/**
 * Gets the path to an extension of a specific type (module, theme, etc.).
 *
 * The path is the directory in which the .info file is located. This name is
 * coming from \SplFileInfo.
 *
 * @param string $extension_name
 *   The machine name of the extension for which the path is requested.
 *
 * @return string
 *   The Drupal-root-relative path to the specified extension.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:540

public checkIncompatibility($name): bool Tests the compatibility of an extension.

/**
 * Tests the compatibility of an extension.
 *
 * @param string $name
 *   The extension name to check.
 *
 * @return bool
 *   TRUE if the extension is incompatible and FALSE if not.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:583

public static Drupal\Core\Extension\ExtensionList::sortByName(Drupal\Core\Extension\Extension $a, Drupal\Core\Extension\Extension $b): int Array sorting callback; sorts extensions by their name.

/**
 * Array sorting callback; sorts extensions by their name.
 *
 * @param \Drupal\Core\Extension\Extension $a
 *   The first extension to compare.
 * @param \Drupal\Core\Extension\Extension $b
 *   The second extension to compare.
 *
 * @return int
 *   Less than 0 if $a is less than $b, more than 0 if $a is greater than $b,
 *   and 0 if they are equal.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:600

protected root -> string (17) "/var/www/html/web"

Directory

drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web

public __construct($root, Drupal\Core\Config\ConfigFactoryInterface $config_factory, Drupal\Core\Extension\ThemeExtensionList $theme_list) Constructs a new ThemeHandler.

/**
 * Constructs a new ThemeHandler.
 *
 * @param string $root
 *   The app root.
 * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
 *   The config factory to get the installed themes.
 * @param \Drupal\Core\Extension\ThemeExtensionList $theme_list
 *   An extension discovery instance.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:51

public getDefault() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:60

public listInfo() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:67

public addTheme(Drupal\Core\Extension\Extension $theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:91

public refreshInfo() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:109

public reset() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:123

public rebuildThemeData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:131

public getBaseThemes(array $themes, $theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:139

public getName($theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:147

public getThemeDirectories() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:154

public themeExists($theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:165

public getTheme($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:173

public hasUi($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:184

protected themeInitialization -> Drupal\Core\Theme\ThemeInitialization#1154 (6)

Properties (6)
Methods (6)

protected themeHandler -> Drupal\Core\Extension\ThemeHandler#1129 (4)

Properties (4)
Methods (13)

protected list -> array (5) Depth Limit
protected configFactory -> Drupal\Core\Config\ConfigFactory#356 Blacklisted
protected themeList -> Drupal\Core\Extension\ThemeExtensionList#1139 Depth Limit
protected root -> string (17) "/var/www/html/web"
- Directory
- ```
drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web
```

public __construct($root, Drupal\Core\Config\ConfigFactoryInterface $config_factory, Drupal\Core\Extension\ThemeExtensionList $theme_list) Constructs a new ThemeHandler.

/**
 * Constructs a new ThemeHandler.
 *
 * @param string $root
 *   The app root.
 * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
 *   The config factory to get the installed themes.
 * @param \Drupal\Core\Extension\ThemeExtensionList $theme_list
 *   An extension discovery instance.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:51

public getDefault() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:60

public listInfo() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:67

public addTheme(Drupal\Core\Extension\Extension $theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:91

public refreshInfo() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:109

public reset() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:123

public rebuildThemeData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:131

public getBaseThemes(array $themes, $theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:139

public getName($theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:147

public getThemeDirectories() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:154

public themeExists($theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:165

public getTheme($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:173

public hasUi($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:184

protected cache -> Drupal\Core\Cache\ChainedFastBackend#665 (4)

Properties (4)
Methods (17)
Class constants (2)

protected bin -> string (15) "cache_bootstrap"
protected consistentBackend -> Drupal\Core\Cache\DatabaseBackend#641 Depth Limit
protected fastBackend -> Drupal\Core\Cache\ApcuBackend#623 Depth Limit
protected lastWriteTimestamp -> double 1784181808.18

public __construct(Drupal\Core\Cache\CacheBackendInterface $consistent_backend, Drupal\Core\Cache\CacheBackendInterface $fast_backend, $bin) Constructs a ChainedFastBackend object.

/**
 * Constructs a ChainedFastBackend object.
 *
 * @param \Drupal\Core\Cache\CacheBackendInterface $consistent_backend
 *   The consistent cache backend.
 * @param \Drupal\Core\Cache\CacheBackendInterface $fast_backend
 *   The fast cache backend.
 * @param string $bin
 *   The cache bin for which the object is created.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:93

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:103

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:112

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:204

public setMultiple(array $items) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:221

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:229

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:237

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:245

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:253

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:260

public invalidateTags(array $tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:268

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:280

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:288

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:296

public reset()

/**
 * @todo Document in https://www.drupal.org/node/2311945.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:304

protected getLastWriteTimestamp() Gets the last write timestamp.

/**
 * Gets the last write timestamp.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:311

protected markAsOutdated() Marks the fast cache bin as outdated because of a write.

/**
 * Marks the fast cache bin as outdated because of a write.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:322

public const Drupal\Core\Cache\ChainedFastBackend::LAST_WRITE_TIMESTAMP_PREFIX :: string (21) "last_write_timestamp_"
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

protected root -> string (17) "/var/www/html/web"

Directory

drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web

protected extensions -> null

protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#653 Blacklisted

private themeEngines -> Symfony\Component\DependencyInjection\ServiceLocator#1153 Blacklisted

public __construct($root, Drupal\Core\Extension\ThemeHandlerInterface $theme_handler, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Psr\Container\ContainerInterface $themeEngines) Constructs a new ThemeInitialization object.

/**
 * Constructs a new ThemeInitialization object.
 *
 * @param string $root
 *   The app root.
 * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
 *   The theme handler.
 * @param \Drupal\Core\Cache\CacheBackendInterface $cache
 *   The cache backend.
 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
 *   The module handler to use to load modules.
 * @param \Psr\Container\ContainerInterface $themeEngines
 *   The theme engines.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:67

public initTheme($theme_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:86

public getActiveThemeByName($theme_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:96

public loadActiveTheme(Drupal\Core\Theme\ActiveTheme $active_theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:143

public getActiveTheme(Drupal\Core\Extension\Extension $theme, array $base_themes = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:164

protected getExtensions(): array Gets all extensions.

/**
 * Gets all extensions.
 *
 * @return array
 *   An associative array whose keys are the names of the extensions.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:271

protected themeManager -> Drupal\Core\Theme\ThemeManager#1164 (13)

Properties (13)
Methods (17)

protected themeRegistry -> Drupal\Core\Theme\Registry#1140 Recursion

protected activeTheme -> Drupal\Core\Theme\ActiveTheme#1978 (11)

Properties (11)
Methods (12)

protected name -> string (9) "catharsis"
protected logo -> string (32) "themes/custom/catharsis/logo.svg"
protected path -> string (23) "themes/custom/catharsis"
- Directory
- ```
drwxrwxr-x 33 33 4096 Jul 14 15:29 themes/custom/catharsis
```
protected engine -> string (4) "twig"
protected owner -> string (36) "core/themes/engines/twig/twig.engine"
- File (5.7KB)
- ```
-rw-rw-r-- 33 33 5815 Jun 23 00:19 core/themes/engines/twig/twig.engine
```
protected baseThemeExtensions -> array (0)
protected extension -> Drupal\Core\Extension\Extension#1980 Depth Limit
protected libraries -> array (1) Depth Limit
protected regions -> array (18) Depth Limit
protected librariesOverride -> array (0)
protected librariesExtend -> array (0)

public __construct(array $values) Constructs an ActiveTheme object.

/**
 * Constructs an ActiveTheme object.
 *
 * @param array $values
 *   The properties of the object, keyed by the names.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:99

public getName(): string Returns the machine name of the theme.

/**
 * Returns the machine name of the theme.
 *
 * @return string
 *   The machine name for the theme.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:132

public getPath(): string Returns the path to the theme directory.

/**
 * Returns the path to the theme directory.
 *
 * @return string
 *   The file path of the theme directory.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:142

public getEngine(): string Returns the theme engine.

/**
 * Returns the theme engine.
 *
 * @return string
 *   The engine of the theme.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:152

public getOwner(): mixed Returns the path to the theme engine for root themes.

/**
 * Returns the path to the theme engine for root themes.
 *
 * @return mixed
 *   The path to the theme engine for root themes.
 *
 * @see \Drupal\Core\Extension\ThemeExtensionList::doList()
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:164

public getExtension(): \Drupal\Core\Extension\Extension Returns the extension object.

/**
 * Returns the extension object.
 *
 * @return \Drupal\Core\Extension\Extension
 *   The extension object for the theme.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:175

public getLibraries(): mixed Returns the libraries provided by the theme.

/**
 * Returns the libraries provided by the theme.
 *
 * @return mixed
 *   The libraries provided by the theme.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:185

public getBaseThemeExtensions(): \Drupal\Core\Extension\Extension[] Returns an array of base theme extension objects keyed by name.

/**
 * Returns an array of base theme extension objects keyed by name.
 *
 * The order starts with the base theme of $this and ends with the root of
 * the dependency chain. For most use cases, parent themes are expected to
 * be called first, so this order needs to be reversed with array_reverse()
 *
 * @return \Drupal\Core\Extension\Extension[]
 *   An array of base theme extension objects keyed by name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:199

public getLogo(): string Returns the logo provided by the theme.

/**
 * Returns the logo provided by the theme.
 *
 * @return string
 *   The logo path.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:209

public getRegions(): string[] The regions used by the theme.

/**
 * The regions used by the theme.
 *
 * @return string[]
 *   The list of region machine names supported by the theme.
 *
 * @see system_region_list()
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:221

public getLibrariesOverride(): array Returns the libraries or library assets overridden by the active theme.

/**
 * Returns the libraries or library assets overridden by the active theme.
 *
 * @return array
 *   The list of libraries overrides.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:231

public getLibrariesExtend(): array Returns the libraries extended by the active theme.

/**
 * Returns the libraries extended by the active theme.
 *
 * @return array
 *   The list of libraries-extend definitions.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:241

protected defaultVariables -> null

protected allHookImplementations -> null

protected themeHookImplementations -> null

protected root -> string (17) "/var/www/html/web"

Directory

drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web

protected themeNegotiator -> Drupal\Core\Theme\ThemeNegotiator#1167 (3)

Properties (3)
Methods (3)

protected negotiators -> array (9) Depth Limit
protected themeAccess -> Drupal\Core\Theme\ThemeAccessCheck#1169 Depth Limit
protected classResolver -> Drupal\Core\DependencyInjection\ClassResolver#655 Depth Limit

public __construct(Drupal\Core\Theme\ThemeAccessCheck $theme_access, Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver, array $negotiators) Constructs a new ThemeNegotiator.

/**
 * Constructs a new ThemeNegotiator.
 *
 * @param \Drupal\Core\Theme\ThemeAccessCheck $theme_access
 *   The access checker for themes.
 * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
 *   The class resolver.
 * @param string[] $negotiators
 *   An array of negotiator IDs.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeNegotiator.php:47

public applies(Drupal\Core\Routing\RouteMatchInterface $route_match) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeNegotiator.php:56

public determineActiveTheme(Drupal\Core\Routing\RouteMatchInterface $route_match) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeNegotiator.php:63

protected themeInitialization -> Drupal\Core\Theme\ThemeInitialization#1154 (6)

Properties (6)
Methods (6)

protected themeHandler -> Drupal\Core\Extension\ThemeHandler#1129 Depth Limit
protected cache -> Drupal\Core\Cache\ChainedFastBackend#665 Depth Limit
protected root -> string (17) "/var/www/html/web"
- Directory
- ```
drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web
```
protected extensions -> null
protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#653 Blacklisted
private themeEngines -> Symfony\Component\DependencyInjection\ServiceLocator#1153 Blacklisted

/**
 * Constructs a new ThemeInitialization object.
 *
 * @param string $root
 *   The app root.
 * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
 *   The theme handler.
 * @param \Drupal\Core\Cache\CacheBackendInterface $cache
 *   The cache backend.
 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
 *   The module handler to use to load modules.
 * @param \Psr\Container\ContainerInterface $themeEngines
 *   The theme engines.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:67

public initTheme($theme_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:86

public getActiveThemeByName($theme_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:96

public loadActiveTheme(Drupal\Core\Theme\ActiveTheme $active_theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:143

public getActiveTheme(Drupal\Core\Extension\Extension $theme, array $base_themes = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:164

protected getExtensions(): array Gets all extensions.

/**
 * Gets all extensions.
 *
 * @return array
 *   An associative array whose keys are the names of the extensions.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:271

protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#653 Blacklisted

protected callableResolver -> Drupal\Core\Utility\CallableResolver#658 (1)

Properties (1)
Methods (2)

protected readonly classResolver -> Drupal\Core\DependencyInjection\ClassResolver#655 Depth Limit

public __construct(Drupal\Core\DependencyInjection\ClassResolverInterface $classResolver) Constructs a CallableResolver object.

/**
 * Constructs a CallableResolver object.
 *
 * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $classResolver
 *   The class resolver.
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/CallableResolver.php:45

public getCallableFromDefinition(callable|array|string $definition): callable Gets a callable from a definition.

/**
 * Gets a callable from a definition.
 *
 * @param callable|array|string $definition
 *   A callable definition.
 *
 * @return callable
 *   A callable.
 *
 * @throws \InvalidArgumentException
 *   Thrown when no valid callable could be resolved from the definition.
 */

Defined in <drupal>/core/lib/Drupal/Core/Utility/CallableResolver.php:62

protected themeEngines -> Symfony\Component\DependencyInjection\ServiceLocator#1153 Blacklisted

protected keyValueFactory -> Drupal\Core\KeyValueStore\KeyValueFactory#659 (3)

Properties (3)
Methods (2)
Class constants (3)

protected stores -> array (1) Depth Limit
protected container -> Drupal\Core\DependencyInjection\Container#37 Blacklisted
protected options -> array (1) Depth Limit

public __construct(Symfony\Component\DependencyInjection\ContainerInterface $container, array $options = array())

/**
 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 *   The service container.
 * @param array $options
 *   (optional) Collection-specific storage override options.
 */

Defined in <drupal>/core/lib/Drupal/Core/KeyValueStore/KeyValueFactory.php:62

public get($collection) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/KeyValueStore/KeyValueFactory.php:70

public const Drupal\Core\KeyValueStore\KeyValueFactory::SPECIFIC_PREFIX :: string (17) "keyvalue_service_"
public const Drupal\Core\KeyValueStore\KeyValueFactory::DEFAULT_SETTING :: string (7) "default"
public const Drupal\Core\KeyValueStore\KeyValueFactory::DEFAULT_SERVICE :: string (17) "keyvalue.database"

protected cache -> Drupal\Core\Cache\ChainedFastBackend#665 (4)

Properties (4)
Methods (17)
Class constants (2)

protected bin -> string (15) "cache_bootstrap"
protected consistentBackend -> Drupal\Core\Cache\DatabaseBackend#641 Depth Limit
protected fastBackend -> Drupal\Core\Cache\ApcuBackend#623 Depth Limit
protected lastWriteTimestamp -> double 1784181808.18

public __construct(Drupal\Core\Cache\CacheBackendInterface $consistent_backend, Drupal\Core\Cache\CacheBackendInterface $fast_backend, $bin) Constructs a ChainedFastBackend object.

/**
 * Constructs a ChainedFastBackend object.
 *
 * @param \Drupal\Core\Cache\CacheBackendInterface $consistent_backend
 *   The consistent cache backend.
 * @param \Drupal\Core\Cache\CacheBackendInterface $fast_backend
 *   The fast cache backend.
 * @param string $bin
 *   The cache bin for which the object is created.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:93

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:103

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:112

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:204

public setMultiple(array $items) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:221

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:229

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:237

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:245

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:253

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:260

public invalidateTags(array $tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:268

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:280

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:288

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:296

public reset()

/**
 * @todo Document in https://www.drupal.org/node/2311945.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:304

protected getLastWriteTimestamp() Gets the last write timestamp.

/**
 * Gets the last write timestamp.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:311

protected markAsOutdated() Marks the fast cache bin as outdated because of a write.

/**
 * Marks the fast cache bin as outdated because of a write.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:322

public const Drupal\Core\Cache\ChainedFastBackend::LAST_WRITE_TIMESTAMP_PREFIX :: string (21) "last_write_timestamp_"
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

public __construct(string $root, Drupal\Core\Theme\ThemeNegotiatorInterface $themeNegotiator, Drupal\Core\Theme\ThemeInitializationInterface $themeInitialization, Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler, Drupal\Core\Utility\CallableResolver $callableResolver, Symfony\Contracts\Service\ServiceCollectionInterface $themeEngines, ?Drupal\Core\KeyValueStore\KeyValueFactoryInterface $keyValueFactory = null, ?Drupal\Core\Cache\CacheBackendInterface $cache = null)

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:58

public setThemeRegistry(Drupal\Core\Theme\Registry $theme_registry): $this Sets the theme registry.

/**
 * Sets the theme registry.
 *
 * @param \Drupal\Core\Theme\Registry $theme_registry
 *   The theme registry.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:89

public getActiveTheme(?Drupal\Core\Routing\RouteMatchInterface $route_match = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:97

public hasActiveTheme() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:107

public resetActiveTheme() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:114

public setActiveTheme(Drupal\Core\Theme\ActiveTheme $active_theme) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:123

public render($hook, array $variables) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:134

protected buildThemeHookSuggestions(string $hook, string $info_base_hook, array &$variables): array Builds theme hook suggestions for a theme hook with variables.

/**
 * Builds theme hook suggestions for a theme hook with variables.
 *
 * @param string $hook
 *   Theme hook that was called.
 * @param string $info_base_hook
 *   Theme registry info for $hook['base hook'] key or empty string.
 * @param array $variables
 *   Theme variables that were passed along with the call.
 *
 * @return string[]
 *   Suggested theme hook names to use instead of $hook, in the order of
 *   ascending specificity.
 *   The caller will pick the last of those suggestions that has a known theme
 *   registry entry.
 *
 * @internal
 *   This method may change at any time. It is not for use outside this class.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:451

protected initTheme(?Drupal\Core\Routing\RouteMatchInterface $route_match = null) Initializes the active theme for a given route match.

/**
 * Initializes the active theme for a given route match.
 *
 * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
 *   The current route match.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:485

public invokeAllWith(string $hook, callable $callback): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:502

public invoke(string $theme, string $hook, array $args = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:517

public alterForTheme(Drupal\Core\Theme\ActiveTheme $theme, $type, &$data, &$context1 = null, &$context2 = null) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @todo Should we cache some of these information?
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:532

protected getImplementationsForTheme(string $theme_key, string $hook): array Gets a hook implementation list for a specific hook.

/**
 * Gets a hook implementation list for a specific hook.
 *
 * @param string $theme_key
 *   The theme machine name.
 * @param string $hook
 *   The hook name.
 *
 * @return array
 *   Array with hook implementations.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:578

protected getThemeChain(Drupal\Core\Theme\ActiveTheme $active_theme): array Gets theme and base themes in reverse order.

/**
 * Gets theme and base themes in reverse order.
 *
 * @param \Drupal\Core\Theme\ActiveTheme $active_theme
 *   A manually specified theme.
 *
 * @return list<string>
 *   The list of theme keys with the active theme last.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:609

public alter($type, &$data, &$context1 = null, &$context2 = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:618

public getDefaultTemplateVariables(): array Returns default template variables.

/**
 * Returns default template variables.
 *
 * These are set for every template before template preprocessing hooks.
 *
 * See the @link themeable Default theme implementations topic @endlink for
 * details.
 *
 * @return array
 *   An array of default template variables.
 *
 * @internal
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:636

public getThemeEngine(string $name): ?Drupal\Core\Theme\ThemeEngineInterface {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:661

protected runtimeCache -> Drupal\Core\Cache\ChainedFastBackend#665 (4)

Properties (4)
Methods (17)
Class constants (2)

protected bin -> string (15) "cache_bootstrap"

protected consistentBackend -> Drupal\Core\Cache\DatabaseBackend#641 (6)

Properties (6)
Methods (20)
Class constants (4)

protected maxRows -> integer 5000
protected bin -> string (15) "cache_bootstrap"
protected connection -> Drupal\mysql\Driver\Database\mysql\Connection#23 Blacklisted
protected checksumProvider -> Drupal\Core\Cache\DatabaseCacheTagsChecksum#616 Depth Limit
protected serializer -> Drupal\Component\Serialization\PhpSerialize#619 Depth Limit
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit

/**
 * Constructs a DatabaseBackend object.
 *
 * @param \Drupal\Core\Database\Connection $connection
 *   The database connection.
 * @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
 *   The cache tags checksum provider.
 * @param string $bin
 *   The cache bin for which the object is created.
 * @param \Drupal\Component\Serialization\ObjectAwareSerializationInterface|int|string|null $serializer
 *   (optional) The serializer to use.
 * @param \Drupal\Component\Datetime\TimeInterface|int|string|null $time
 *   The time service.
 * @param int $max_rows
 *   (optional) The maximum number of rows that are allowed in this cache bin
 *   table.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:88

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:108

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:117

protected prepareItem($cache, $allow_invalid): mixed|false Prepares a cached item.

/**
 * Prepares a cached item.
 *
 * Checks that items are either permanent or did not expire, and unserializes
 * data as appropriate.
 *
 * @param object $cache
 *   An item loaded from self::get() or self::getMultiple().
 * @param bool $allow_invalid
 *   If FALSE, the method returns FALSE if the cache item is not valid.
 *
 * @return mixed|false
 *   The item with data unserialized as appropriate and a property indicating
 *   whether the item is valid, or FALSE if there is no valid item to load.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:176

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:206

public setMultiple(array $items) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:219

protected doSetMultiple(array $items) Stores multiple items in the persistent cache.

/**
 * Stores multiple items in the persistent cache.
 *
 * @param array $items
 *   An array of cache items, keyed by cid.
 *
 * @see \Drupal\Core\Cache\CacheBackendInterface::setMultiple()
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:247

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:315

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:322

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:345

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:362

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:369

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:389

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:404

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:437

protected ensureBinExists() Check if the cache bin exists and create it if not.

/**
 * Check if the cache bin exists and create it if not.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:449

protected catchException(Exception $e, $table_name = null) Act on an exception when cache might be stale.

/**
 * Act on an exception when cache might be stale.
 *
 * If the table does not yet exist, that's fine, but if the table exists and
 * yet the query failed, then the cache is stale and the exception needs to
 * propagate.
 *
 * @param \Exception $e
 *   The exception.
 * @param string|null $table_name
 *   The table name. Defaults to $this->bin.
 *
 * @throws \Exception
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:481

protected normalizeCid($cid): string Normalizes a cache ID in order to comply with database limitations.

/**
 * Normalizes a cache ID in order to comply with database limitations.
 *
 * @param string $cid
 *   The passed in cache ID.
 *
 * @return string
 *   An ASCII-encoded cache ID that is at most 255 characters long.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:496

public schemaDefinition() Defines the schema for the {cache_*} bin tables.

/**
 * Defines the schema for the {cache_*} bin tables.
 *
 * @internal
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:519

public getMaxRows(): int Gets the maximum number of rows for this cache bin table.

/**
 * Gets the maximum number of rows for this cache bin table.
 *
 * @return int
 *   The maximum number of rows that this cache bin table is allowed to store.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:587

public const Drupal\Core\Cache\DatabaseBackend::DEFAULT_MAX_ROWS :: integer 5000
public const Drupal\Core\Cache\DatabaseBackend::MAXIMUM_NONE :: integer -1
public const Drupal\Core\Cache\DatabaseBackend::MAX_ITEMS_PER_CACHE_SET :: integer 100
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

protected fastBackend -> Drupal\Core\Cache\ApcuBackend#623 (5)

Properties (5)
Methods (17)
Class constants (1)

protected bin -> string (9) "bootstrap"
protected sitePrefix -> string (102) "drupal.apcu_backend.8ea27d7326d9ebea..ee6752e49a37f146cc48af66abc7f3bc8c6297...
```
drupal.apcu_backend.8ea27d7326d9ebea..ee6752e49a37f146cc48af66abc7f3bc8c62978f0d1160941cb918715e1c943d
```
protected binPrefix -> string (115) "drupal.apcu_backend.8ea27d7326d9ebea..ee6752e49a37f146cc48af66abc7f3bc8c6297...
```
drupal.apcu_backend.8ea27d7326d9ebea..ee6752e49a37f146cc48af66abc7f3bc8c62978f0d1160941cb918715e1c943d::bootstrap::
```
protected checksumProvider -> Drupal\Core\Cache\DatabaseCacheTagsChecksum#616 Depth Limit
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit

public __construct($bin, $site_prefix, Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider, Drupal\Component\Datetime\TimeInterface $time) Constructs a new ApcuBackend instance.

/**
 * Constructs a new ApcuBackend instance.
 *
 * @param string $bin
 *   The name of the cache bin.
 * @param string $site_prefix
 *   The prefix to use for all keys in the storage that belong to this site.
 * @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
 *   The cache tags checksum provider.
 * @param \Drupal\Component\Datetime\TimeInterface|null $time
 *   The time service.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:55

public getApcuKey($cid): string Prepends the APCu user variable prefix for this bin to a cache item ID.

/**
 * Prepends the APCu user variable prefix for this bin to a cache item ID.
 *
 * @param string $cid
 *   The cache item ID to prefix.
 *
 * @return string
 *   The APCu key for the cache item ID.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:76

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:83

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:91

protected getAll($prefix = ''): \APCUIterator Returns all cached items, optionally limited by a cache ID prefix.

/**
 * Returns all cached items, optionally limited by a cache ID prefix.
 *
 * APCu is a memory cache, shared across all server processes. To prevent
 * cache item clashes with other applications/installations, every cache item
 * is prefixed with a unique string for this site. Therefore, functions like
 * apcu_clear_cache() cannot be used, and instead, a list of all cache items
 * belonging to this application need to be retrieved through this method
 * instead.
 *
 * @param string $prefix
 *   (optional) A cache ID prefix to limit the result to.
 *
 * @return \APCUIterator
 *   An APCUIterator containing matched items.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:142

protected prepareItem($cache, $allow_invalid): mixed Prepares a cached item.

/**
 * Prepares a cached item.
 *
 * Checks that the item is either permanent or did not expire.
 *
 * @param object $cache
 *   An item loaded from self::get() or self::getMultiple().
 * @param bool $allow_invalid
 *   If TRUE, a cache item may be returned even if it is expired or has been
 *   invalidated. See ::get().
 *
 * @return mixed
 *   The cache item or FALSE if the item expired.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:160

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:185

public setMultiple(array $items = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:205

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:214

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:221

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:228

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:235

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:242

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:249

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:256

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:265

protected getIterator($search = null, $format = 4294967295, $chunk_size = 100, $list = 1): \APCUIterator Instantiates and returns the APCUIterator class.

/**
 * Instantiates and returns the APCUIterator class.
 *
 * @param mixed $search
 *   A PCRE regular expression that matches against APC key names, either as a
 *   string for a single regular expression, or as an array of regular
 *   expressions. Or, optionally pass in NULL to skip the search.
 * @param int $format
 *   The desired format, as configured with one or more of the APC_ITER_*
 *   constants.
 * @param int $chunk_size
 *   The chunk size. Must be a value greater than 0. The default value is 100.
 * @param int $list
 *   The type to list. Either pass in APC_LIST_ACTIVE or APC_LIST_DELETED.
 *
 * @return \APCUIterator
 *   An APCUIterator class.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:291

public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

protected lastWriteTimestamp -> double 1784181808.18

public __construct(Drupal\Core\Cache\CacheBackendInterface $consistent_backend, Drupal\Core\Cache\CacheBackendInterface $fast_backend, $bin) Constructs a ChainedFastBackend object.

/**
 * Constructs a ChainedFastBackend object.
 *
 * @param \Drupal\Core\Cache\CacheBackendInterface $consistent_backend
 *   The consistent cache backend.
 * @param \Drupal\Core\Cache\CacheBackendInterface $fast_backend
 *   The fast cache backend.
 * @param string $bin
 *   The cache bin for which the object is created.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:93

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:103

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:112

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:204

public setMultiple(array $items) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:221

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:229

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:237

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:245

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:253

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:260

public invalidateTags(array $tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:268

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:280

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:288

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:296

public reset()

/**
 * @todo Document in https://www.drupal.org/node/2311945.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:304

protected getLastWriteTimestamp() Gets the last write timestamp.

/**
 * Gets the last write timestamp.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:311

protected markAsOutdated() Marks the fast cache bin as outdated because of a write.

/**
 * Marks the fast cache bin as outdated because of a write.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:322

public const Drupal\Core\Cache\ChainedFastBackend::LAST_WRITE_TIMESTAMP_PREFIX :: string (21) "last_write_timestamp_"
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

protected moduleList -> Drupal\Core\Extension\ModuleExtensionList#1156 (15)

Properties (15)
Methods (32)
Static methods (1)

protected type -> string (6) "module"

protected root -> string (17) "/var/www/html/web"

Directory

drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web

protected cache -> Drupal\Core\Cache\DatabaseBackend#182 (6)

Properties (6)
Methods (20)
Class constants (4)

protected maxRows -> integer 5000
protected bin -> string (13) "cache_default"
protected connection -> Drupal\mysql\Driver\Database\mysql\Connection#23 Blacklisted
protected checksumProvider -> Drupal\Core\Cache\DatabaseCacheTagsChecksum#616 Depth Limit
protected serializer -> Drupal\Component\Serialization\PhpSerialize#619 Depth Limit
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit

/**
 * Constructs a DatabaseBackend object.
 *
 * @param \Drupal\Core\Database\Connection $connection
 *   The database connection.
 * @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
 *   The cache tags checksum provider.
 * @param string $bin
 *   The cache bin for which the object is created.
 * @param \Drupal\Component\Serialization\ObjectAwareSerializationInterface|int|string|null $serializer
 *   (optional) The serializer to use.
 * @param \Drupal\Component\Datetime\TimeInterface|int|string|null $time
 *   The time service.
 * @param int $max_rows
 *   (optional) The maximum number of rows that are allowed in this cache bin
 *   table.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:88

public get($cid, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:108

public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:117

protected prepareItem($cache, $allow_invalid): mixed|false Prepares a cached item.

/**
 * Prepares a cached item.
 *
 * Checks that items are either permanent or did not expire, and unserializes
 * data as appropriate.
 *
 * @param object $cache
 *   An item loaded from self::get() or self::getMultiple().
 * @param bool $allow_invalid
 *   If FALSE, the method returns FALSE if the cache item is not valid.
 *
 * @return mixed|false
 *   The item with data unserialized as appropriate and a property indicating
 *   whether the item is valid, or FALSE if there is no valid item to load.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:176

public set($cid, $data, $expire = -1, array $tags = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:206

public setMultiple(array $items) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:219

protected doSetMultiple(array $items) Stores multiple items in the persistent cache.

/**
 * Stores multiple items in the persistent cache.
 *
 * @param array $items
 *   An array of cache items, keyed by cid.
 *
 * @see \Drupal\Core\Cache\CacheBackendInterface::setMultiple()
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:247

public delete($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:315

public deleteMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:322

public deleteAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:345

public invalidate($cid) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:362

public invalidateMultiple(array $cids) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:369

public invalidateAll() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:389

public garbageCollection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:404

public removeBin() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:437

protected ensureBinExists() Check if the cache bin exists and create it if not.

/**
 * Check if the cache bin exists and create it if not.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:449

protected catchException(Exception $e, $table_name = null) Act on an exception when cache might be stale.

/**
 * Act on an exception when cache might be stale.
 *
 * If the table does not yet exist, that's fine, but if the table exists and
 * yet the query failed, then the cache is stale and the exception needs to
 * propagate.
 *
 * @param \Exception $e
 *   The exception.
 * @param string|null $table_name
 *   The table name. Defaults to $this->bin.
 *
 * @throws \Exception
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:481

protected normalizeCid($cid): string Normalizes a cache ID in order to comply with database limitations.

/**
 * Normalizes a cache ID in order to comply with database limitations.
 *
 * @param string $cid
 *   The passed in cache ID.
 *
 * @return string
 *   An ASCII-encoded cache ID that is at most 255 characters long.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:496

public schemaDefinition() Defines the schema for the {cache_*} bin tables.

/**
 * Defines the schema for the {cache_*} bin tables.
 *
 * @internal
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:519

public getMaxRows(): int Gets the maximum number of rows for this cache bin table.

/**
 * Gets the maximum number of rows for this cache bin table.
 *
 * @return int
 *   The maximum number of rows that this cache bin table is allowed to store.
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:587

public const Drupal\Core\Cache\DatabaseBackend::DEFAULT_MAX_ROWS :: integer 5000
public const Drupal\Core\Cache\DatabaseBackend::MAXIMUM_NONE :: integer -1
public const Drupal\Core\Cache\DatabaseBackend::MAX_ITEMS_PER_CACHE_SET :: integer 100
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1

protected defaults -> array (5)

dependencies => array (0)

description => string (0) ""

package => string (5) "Other"

version => null

php => string (5) "8.3.0"

protected infoParser -> Drupal\Core\Extension\InfoParser#1136 (2)

Properties (2)
Methods (3)

protected root -> string (17) "/var/www/html/web"
- Directory
- ```
drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web
```
protected fileCache -> Drupal\Component\FileCache\FileCache#1137 Depth Limit

public __construct(string $app_root) InfoParser constructor.

/**
 * InfoParser constructor.
 *
 * @param string $app_root
 *   The root directory of the Drupal installation.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/InfoParser.php:27

public parse($filename) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/InfoParser.php:44

protected getRequiredKeys(): array Returns an array of keys required to exist in .info.yml file.

/**
 * Returns an array of keys required to exist in .info.yml file.
 *
 * @return array
 *   An array of required keys.
 */

Inherited from Drupal\Core\Extension\InfoParserDynamic
Defined in <drupal>/core/lib/Drupal/Core/Extension/InfoParserDynamic.php:107

protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#653 Blacklisted

protected extensions -> null

protected extensionInfo -> null

protected pathNames -> null

protected addedPathNames -> array (159)

admin_toolbar => string (52) "modules/contrib/admin_toolbar/admin_toolbar.info.yml"

File (379B)

-rw-r--r-- 33 33 379 Dec 30 2025 modules/contrib/admin_toolbar/admin_toolbar.info.yml

admin_toolbar_links_access_filter => string (106) "modules/contrib/admin_toolbar/admin_toolbar_links_access_filter/admin_toolba...

File (616B)
Contents

-rw-r--r-- 33 33 616 Dec 30 2025 modules/contrib/admin_toolbar/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.info.yml

modules/contrib/admin_toolbar/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.info.yml

admin_toolbar_tools => string (78) "modules/contrib/admin_toolbar/admin_toolbar_tools/admin_toolbar_tools.info.yml"

File (384B)

-rw-r--r-- 33 33 384 Dec 30 2025 modules/contrib/admin_toolbar/admin_toolbar_tools/admin_toolbar_tools.info.yml

allowed_formats => string (56) "modules/contrib/allowed_formats/allowed_formats.info.yml"

File (417B)

-rw-r--r-- 33 33 417 Aug 08 2024 modules/contrib/allowed_formats/allowed_formats.info.yml

automated_cron => string (51) "core/modules/automated_cron/automated_cron.info.yml"

File (209B)

-rw-rw-r-- 33 33 209 Jun 23 00:19 core/modules/automated_cron/automated_cron.info.yml

better_exposed_filters => string (70) "modules/contrib/better_exposed_filters/better_exposed_filters.info.yml"

File (375B)

-rw-r--r-- 33 33 375 May 19 17:45 modules/contrib/better_exposed_filters/better_exposed_filters.info.yml

block => string (33) "core/modules/block/block.info.yml"

File (214B)

-rw-rw-r-- 33 33 214 Jun 23 00:19 core/modules/block/block.info.yml

block_content => string (49) "core/modules/block_content/block_content.info.yml"

File (242B)

-rw-rw-r-- 33 33 242 Jun 23 00:19 core/modules/block_content/block_content.info.yml

bootstrap_styles => string (58) "modules/contrib/bootstrap_styles/bootstrap_styles.info.yml"

File (475B)

-rw-r--r-- 33 33 475 Jan 18 09:43 modules/contrib/bootstrap_styles/bootstrap_styles.info.yml

breakpoint => string (43) "core/modules/breakpoint/breakpoint.info.yml"

File (142B)

-rw-rw-r-- 33 33 142 Jun 23 00:19 core/modules/breakpoint/breakpoint.info.yml

captcha => string (40) "modules/contrib/captcha/captcha.info.yml"

File (327B)

-rw-r--r-- 33 33 327 Feb 09 06:32 modules/contrib/captcha/captcha.info.yml

cbc_admin => string (43) "modules/custom/cbc_admin/cbc_admin.info.yml"

File (215B)

-rw-rw-r-- 33 33 215 Jul 13 22:45 modules/custom/cbc_admin/cbc_admin.info.yml

cbc_social => string (45) "modules/custom/cbc_social/cbc_social.info.yml"

File (159B)

-rw-rw-r-- 33 33 159 Jul 13 22:45 modules/custom/cbc_social/cbc_social.info.yml

cbc_subscription => string (57) "modules/custom/cbc_subscription/cbc_subscription.info.yml"

File (260B)

-rw-rw-r-- 33 33 260 Jul 13 22:45 modules/custom/cbc_subscription/cbc_subscription.info.yml

cbc_webform => string (47) "modules/custom/cbc_webform/cbc_webform.info.yml"

File (217B)

-rw-rw-r-- 33 33 217 Jul 13 22:45 modules/custom/cbc_webform/cbc_webform.info.yml

chosen => string (38) "modules/contrib/chosen/chosen.info.yml"

File (387B)

-rw-r--r-- 33 33 387 May 24 03:43 modules/contrib/chosen/chosen.info.yml

chosen_field => string (65) "modules/contrib/chosen/modules/chosen_field/chosen_field.info.yml"

File (386B)

-rw-r--r-- 33 33 386 May 24 03:43 modules/contrib/chosen/modules/chosen_field/chosen_field.info.yml

chosen_lib => string (61) "modules/contrib/chosen/modules/chosen_lib/chosen_lib.info.yml"

File (311B)

-rw-r--r-- 33 33 311 May 24 03:43 modules/contrib/chosen/modules/chosen_lib/chosen_lib.info.yml

ckeditor5 => string (41) "core/modules/ckeditor5/ckeditor5.info.yml"

File (150B)

-rw-rw-r-- 33 33 150 Jun 23 00:19 core/modules/ckeditor5/ckeditor5.info.yml

ckeditor5_plugin_pack => string (68) "modules/contrib/ckeditor5_plugin_pack/ckeditor5_plugin_pack.info.yml"

File (427B)

-rw-r--r-- 33 33 427 Jun 03 02:14 modules/contrib/ckeditor5_plugin_pack/ckeditor5_plugin_pack.info.yml

ckeditor5_plugin_pack_font => string (108) "modules/contrib/ckeditor5_plugin_pack/modules/ckeditor5_plugin_pack_font/cke...

File (393B)
Contents

-rw-r--r-- 33 33 393 Jun 03 02:14 modules/contrib/ckeditor5_plugin_pack/modules/ckeditor5_plugin_pack_font/ckeditor5_plugin_pack_font.info.yml

modules/contrib/ckeditor5_plugin_pack/modules/ckeditor5_plugin_pack_font/ckeditor5_plugin_pack_font.info.yml

ckeditor5_plugin_pack_free_wproofreader => string (134) "modules/contrib/ckeditor5_plugin_pack/modules/ckeditor5_plugin_pack_free_wpr...

File (520B)
Contents

-rw-r--r-- 33 33 520 Jun 03 02:14 modules/contrib/ckeditor5_plugin_pack/modules/ckeditor5_plugin_pack_free_wproofreader/ckeditor5_plugin_pack_free_wproofreader.info.yml

modules/contrib/ckeditor5_plugin_pack/modules/ckeditor5_plugin_pack_free_wproofreader/ckeditor5_plugin_pack_free_wproofreader.info.yml

ckeditor5_plugin_pack_word_count => string (120) "modules/contrib/ckeditor5_plugin_pack/modules/ckeditor5_plugin_pack_word_cou...

File (372B)
Contents

-rw-r--r-- 33 33 372 Jun 03 02:14 modules/contrib/ckeditor5_plugin_pack/modules/ckeditor5_plugin_pack_word_count/ckeditor5_plugin_pack_word_count.info.yml

modules/contrib/ckeditor5_plugin_pack/modules/ckeditor5_plugin_pack_word_count/ckeditor5_plugin_pack_word_count.info.yml

ckeditor5_premium_features => string (78) "modules/contrib/ckeditor5_premium_features/ckeditor5_premium_features.info.yml"

File (477B)

-rw-r--r-- 33 33 477 Jun 03 03:44 modules/contrib/ckeditor5_premium_features/ckeditor5_premium_features.info.yml

ckeditor5_premium_features_wproofreader => string (139) "modules/contrib/ckeditor5_premium_features/modules/ckeditor5_premium_feature...

File (503B)
Contents

-rw-r--r-- 33 33 503 Jun 03 03:44 modules/contrib/ckeditor5_premium_features/modules/ckeditor5_premium_features_wproofreader/ckeditor5_premium_features_wproofreader.info.yml

modules/contrib/ckeditor5_premium_features/modules/ckeditor5_premium_features_wproofreader/ckeditor5_premium_features_wproofreader.info.yml

ckeditor_html_embed => string (64) "modules/contrib/ckeditor_html_embed/ckeditor_html_embed.info.yml"

File (366B)

-rw-r--r-- 33 33 366 Jul 09 2025 modules/contrib/ckeditor_html_embed/ckeditor_html_embed.info.yml

components => string (46) "modules/contrib/components/components.info.yml"

File (426B)

-rw-r--r-- 33 33 426 Dec 04 2025 modules/contrib/components/components.info.yml

conditional_fields => string (62) "modules/contrib/conditional_fields/conditional_fields.info.yml"

File (428B)

-rw-r--r-- 33 33 428 Dec 11 2024 modules/contrib/conditional_fields/conditional_fields.info.yml

config => string (35) "core/modules/config/config.info.yml"

File (166B)

-rw-rw-r-- 33 33 166 Jun 23 00:19 core/modules/config/config.info.yml

config_ignore => string (52) "modules/contrib/config_ignore/config_ignore.info.yml"

File (335B)

-rw-r--r-- 33 33 335 Apr 25 02:37 modules/contrib/config_ignore/config_ignore.info.yml

config_split => string (50) "modules/contrib/config_split/config_split.info.yml"

File (350B)

-rw-r--r-- 33 33 350 Feb 12 2025 modules/contrib/config_split/config_split.info.yml

config_update => string (52) "modules/contrib/config_update/config_update.info.yml"

File (351B)

-rw-r--r-- 33 33 351 Aug 25 2024 modules/contrib/config_update/config_update.info.yml

content_moderation => string (59) "core/modules/content_moderation/content_moderation.info.yml"

File (253B)

-rw-rw-r-- 33 33 253 Jun 23 00:19 core/modules/content_moderation/content_moderation.info.yml

content_moderation_notifications => string (90) "modules/contrib/content_moderation_notifications/content_moderation_notifica...

File (515B)
Contents

-rw-r--r-- 33 33 515 Oct 03 2025 modules/contrib/content_moderation_notifications/content_moderation_notifications.info.yml

modules/contrib/content_moderation_notifications/content_moderation_notifications.info.yml

contextual => string (43) "core/modules/contextual/contextual.info.yml"

File (161B)

-rw-rw-r-- 33 33 161 Jun 23 00:19 core/modules/contextual/contextual.info.yml

cshs => string (34) "modules/contrib/cshs/cshs.info.yml"

File (366B)

-rw-r--r-- 33 33 366 Dec 08 2025 modules/contrib/cshs/cshs.info.yml

ctools_views => string (65) "modules/contrib/ctools/modules/ctools_views/ctools_views.info.yml"

File (399B)

-rw-r--r-- 33 33 399 Jun 11 2024 modules/contrib/ctools/modules/ctools_views/ctools_views.info.yml

custom_field => string (50) "modules/contrib/custom_field/custom_field.info.yml"

File (397B)

-rw-r--r-- 33 33 397 May 22 22:00 modules/contrib/custom_field/custom_field.info.yml

datetime => string (39) "core/modules/datetime/datetime.info.yml"

File (161B)

-rw-rw-r-- 33 33 161 Jun 23 00:19 core/modules/datetime/datetime.info.yml

datetime_range => string (51) "core/modules/datetime_range/datetime_range.info.yml"

File (164B)

-rw-rw-r-- 33 33 164 Jun 23 00:19 core/modules/datetime_range/datetime_range.info.yml

dblog => string (33) "core/modules/dblog/dblog.info.yml"

File (155B)

-rw-rw-r-- 33 33 155 Jun 23 00:19 core/modules/dblog/dblog.info.yml

devel => string (36) "modules/contrib/devel/devel.info.yml"

File (345B)

-rw-r--r-- 33 33 345 Nov 26 2025 modules/contrib/devel/devel.info.yml

dynamic_page_cache => string (59) "core/modules/dynamic_page_cache/dynamic_page_cache.info.yml"

File (162B)

-rw-rw-r-- 33 33 162 Jun 23 00:19 core/modules/dynamic_page_cache/dynamic_page_cache.info.yml

editor => string (35) "core/modules/editor/editor.info.yml"

File (255B)

-rw-rw-r-- 33 33 255 Jun 23 00:19 core/modules/editor/editor.info.yml

editor_advanced_link => string (66) "modules/contrib/editor_advanced_link/editor_advanced_link.info.yml"

File (402B)

-rw-r--r-- 33 33 402 Jan 19 05:56 modules/contrib/editor_advanced_link/editor_advanced_link.info.yml

entity => string (38) "modules/contrib/entity/entity.info.yml"

File (280B)

-rw-r--r-- 33 33 280 Feb 19 2025 modules/contrib/entity/entity.info.yml

facets => string (38) "modules/contrib/facets/facets.info.yml"

File (393B)

-rw-r--r-- 33 33 393 Apr 24 05:47 modules/contrib/facets/facets.info.yml

facets_exposed_filters => string (85) "modules/contrib/facets/modules/facets_exposed_filters/facets_exposed_filters...

File (455B)
Contents

-rw-r--r-- 33 33 455 Apr 24 05:47 modules/contrib/facets/modules/facets_exposed_filters/facets_exposed_filters.info.yml

modules/contrib/facets/modules/facets_exposed_filters/facets_exposed_filters.info.yml

field => string (33) "core/modules/field/field.info.yml"

File (124B)

-rw-rw-r-- 33 33 124 Jun 23 00:19 core/modules/field/field.info.yml

field_group => string (48) "modules/contrib/field_group/field_group.info.yml"

File (331B)

-rw-r--r-- 33 33 331 Apr 23 2025 modules/contrib/field_group/field_group.info.yml

field_permissions => string (60) "modules/contrib/field_permissions/field_permissions.info.yml"

File (381B)

-rw-r--r-- 33 33 381 Jan 09 10:26 modules/contrib/field_permissions/field_permissions.info.yml

field_ui => string (39) "core/modules/field_ui/field_ui.info.yml"

File (155B)

-rw-rw-r-- 33 33 155 Jun 23 00:19 core/modules/field_ui/field_ui.info.yml

file => string (31) "core/modules/file/file.info.yml"

File (187B)

-rw-rw-r-- 33 33 187 Jun 23 00:19 core/modules/file/file.info.yml

filefield_paths => string (56) "modules/contrib/filefield_paths/filefield_paths.info.yml"

File (468B)

-rw-r--r-- 33 33 468 Dec 12 2025 modules/contrib/filefield_paths/filefield_paths.info.yml

filter => string (35) "core/modules/filter/filter.info.yml"

File (184B)

-rw-rw-r-- 33 33 184 Jun 23 00:19 core/modules/filter/filter.info.yml

flag => string (34) "modules/contrib/flag/flag.info.yml"

File (302B)

-rw-r--r-- 33 33 302 Oct 27 2025 modules/contrib/flag/flag.info.yml

gin_toolbar => string (48) "modules/contrib/gin_toolbar/gin_toolbar.info.yml"

File (230B)

-rw-r--r-- 33 33 230 Jan 16 00:54 modules/contrib/gin_toolbar/gin_toolbar.info.yml

help => string (31) "core/modules/help/help.info.yml"

File (139B)

-rw-rw-r-- 33 33 139 Jun 23 00:19 core/modules/help/help.info.yml

history => string (37) "core/modules/history/history.info.yml"

File (175B)

-rw-rw-r-- 33 33 175 Jun 23 00:19 core/modules/history/history.info.yml

honeypot => string (42) "modules/contrib/honeypot/honeypot.info.yml"

File (353B)

-rw-r--r-- 33 33 353 Feb 17 2025 modules/contrib/honeypot/honeypot.info.yml

ignition => string (41) "modules/custom/ignition/ignition.info.yml"

File (310B)

-rw-rw-r-- 33 33 310 Jul 13 22:45 modules/custom/ignition/ignition.info.yml

image => string (33) "core/modules/image/image.info.yml"

File (228B)

-rw-rw-r-- 33 33 228 Jun 23 00:19 core/modules/image/image.info.yml

inline_entity_form => string (62) "modules/contrib/inline_entity_form/inline_entity_form.info.yml"

File (363B)

-rw-r--r-- 33 33 363 Jun 05 14:41 modules/contrib/inline_entity_form/inline_entity_form.info.yml

key => string (32) "modules/contrib/key/key.info.yml"

File (304B)

-rw-r--r-- 33 33 304 Jan 20 07:00 modules/contrib/key/key.info.yml

kint => string (39) "modules/contrib/kint-kint/kint.info.yml"

File (326B)

-rw-r--r-- 33 33 326 Jan 27 09:59 modules/contrib/kint-kint/kint.info.yml

layout_builder => string (51) "core/modules/layout_builder/layout_builder.info.yml"

File (330B)

-rw-rw-r-- 33 33 330 Jun 23 00:19 core/modules/layout_builder/layout_builder.info.yml

layout_builder_blocks => string (68) "modules/contrib/layout_builder_blocks/layout_builder_blocks.info.yml"

File (419B)

-rw-r--r-- 33 33 419 Jan 18 08:17 modules/contrib/layout_builder_blocks/layout_builder_blocks.info.yml

layout_builder_modal => string (66) "modules/contrib/layout_builder_modal/layout_builder_modal.info.yml"

File (421B)

-rw-r--r-- 33 33 421 Oct 16 2024 modules/contrib/layout_builder_modal/layout_builder_modal.info.yml

layout_builder_restrictions => string (80) "modules/contrib/layout_builder_restrictions/layout_builder_restrictions.info...

File (441B)
Contents

-rw-r--r-- 33 33 441 Jul 17 2025 modules/contrib/layout_builder_restrictions/layout_builder_restrictions.info.yml

modules/contrib/layout_builder_restrictions/layout_builder_restrictions.info.yml

layout_discovery => string (55) "core/modules/layout_discovery/layout_discovery.info.yml"

File (142B)

-rw-rw-r-- 33 33 142 Jun 23 00:19 core/modules/layout_discovery/layout_discovery.info.yml

link => string (31) "core/modules/link/link.info.yml"

File (162B)

-rw-rw-r-- 33 33 162 Jun 23 00:19 core/modules/link/link.info.yml

linkit => string (38) "modules/contrib/linkit/linkit.info.yml"

File (364B)

-rw-r--r-- 33 33 364 Jun 12 10:01 modules/contrib/linkit/linkit.info.yml

mail_login => string (46) "modules/contrib/mail_login/mail_login.info.yml"

File (315B)

-rw-r--r-- 33 33 315 Jul 12 2025 modules/contrib/mail_login/mail_login.info.yml

mailer_transport => string (81) "modules/contrib/symfony_mailer/modules/mailer_transport/mailer_transport.inf...

File (272B)
Contents

-rw-r--r-- 33 33 272 Jun 27 2025 modules/contrib/symfony_mailer/modules/mailer_transport/mailer_transport.info.yml

modules/contrib/symfony_mailer/modules/mailer_transport/mailer_transport.info.yml

maxlength => string (44) "modules/contrib/maxlength/maxlength.info.yml"

File (301B)

-rw-r--r-- 33 33 301 Aug 28 2025 modules/contrib/maxlength/maxlength.info.yml

media => string (33) "core/modules/media/media.info.yml"

File (225B)

-rw-rw-r-- 33 33 225 Jun 23 00:19 core/modules/media/media.info.yml

media_library => string (49) "core/modules/media_library/media_library.info.yml"

File (278B)

-rw-rw-r-- 33 33 278 Jun 23 00:19 core/modules/media_library/media_library.info.yml

media_library_form_element => string (78) "modules/contrib/media_library_form_element/media_library_form_element.info.yml"

File (335B)

-rw-r--r-- 33 33 335 Sep 30 2025 modules/contrib/media_library_form_element/media_library_form_element.info.yml

menu_block => string (46) "modules/contrib/menu_block/menu_block.info.yml"

File (289B)

-rw-r--r-- 33 33 289 Feb 26 2025 modules/contrib/menu_block/menu_block.info.yml

menu_breadcrumb => string (56) "modules/contrib/menu_breadcrumb/menu_breadcrumb.info.yml"

File (332B)

-rw-r--r-- 33 33 332 Sep 10 2025 modules/contrib/menu_breadcrumb/menu_breadcrumb.info.yml

menu_link_attributes => string (66) "modules/contrib/menu_link_attributes/menu_link_attributes.info.yml"

File (369B)

-rw-r--r-- 33 33 369 Mar 23 01:39 modules/contrib/menu_link_attributes/menu_link_attributes.info.yml

menu_link_content => string (57) "core/modules/menu_link_content/menu_link_content.info.yml"

File (150B)

-rw-rw-r-- 33 33 150 Jun 23 00:19 core/modules/menu_link_content/menu_link_content.info.yml

menu_position => string (52) "modules/contrib/menu_position/menu_position.info.yml"

File (379B)

-rw-r--r-- 33 33 379 Jan 29 11:11 modules/contrib/menu_position/menu_position.info.yml

menu_ui => string (37) "core/modules/menu_ui/menu_ui.info.yml"

File (196B)

-rw-rw-r-- 33 33 196 Jun 23 00:19 core/modules/menu_ui/menu_ui.info.yml

metatag => string (40) "modules/contrib/metatag/metatag.info.yml"

File (355B)

-rw-r--r-- 33 33 355 Sep 23 2025 modules/contrib/metatag/metatag.info.yml

metatag_open_graph => string (70) "modules/contrib/metatag/metatag_open_graph/metatag_open_graph.info.yml"

File (324B)

-rw-r--r-- 33 33 324 Sep 23 2025 modules/contrib/metatag/metatag_open_graph/metatag_open_graph.info.yml

metatag_routes => string (62) "modules/contrib/metatag/metatag_routes/metatag_routes.info.yml"

File (366B)

-rw-r--r-- 33 33 366 Sep 23 2025 modules/contrib/metatag/metatag_routes/metatag_routes.info.yml

migrate => string (37) "core/modules/migrate/migrate.info.yml"

File (129B)

-rw-rw-r-- 33 33 129 Jun 23 00:19 core/modules/migrate/migrate.info.yml

mysql => string (33) "core/modules/mysql/mysql.info.yml"

File (107B)

-rw-rw-r-- 33 33 107 Jun 23 00:19 core/modules/mysql/mysql.info.yml

node => string (31) "core/modules/node/node.info.yml"

File (214B)

-rw-rw-r-- 33 33 214 Jun 23 00:19 core/modules/node/node.info.yml

optional_end_date => string (60) "modules/contrib/optional_end_date/optional_end_date.info.yml"

File (341B)

-rw-r--r-- 33 33 341 Sep 12 2024 modules/contrib/optional_end_date/optional_end_date.info.yml

options => string (37) "core/modules/options/options.info.yml"

File (242B)

-rw-rw-r-- 33 33 242 Jun 23 00:19 core/modules/options/options.info.yml

override_node_options => string (68) "modules/contrib/override_node_options/override_node_options.info.yml"

File (415B)

-rw-r--r-- 33 33 415 Nov 27 2024 modules/contrib/override_node_options/override_node_options.info.yml

page_cache => string (43) "core/modules/page_cache/page_cache.info.yml"

File (179B)

-rw-rw-r-- 33 33 179 Jun 23 00:19 core/modules/page_cache/page_cache.info.yml

path => string (31) "core/modules/path/path.info.yml"

File (213B)

-rw-rw-r-- 33 33 213 Jun 23 00:19 core/modules/path/path.info.yml

path_alias => string (43) "core/modules/path_alias/path_alias.info.yml"

File (146B)

-rw-rw-r-- 33 33 146 Jun 23 00:19 core/modules/path_alias/path_alias.info.yml

phpass => string (35) "core/modules/phpass/phpass.info.yml"

File (192B)

-rw-rw-r-- 33 33 192 Jun 23 00:19 core/modules/phpass/phpass.info.yml

profile => string (40) "modules/contrib/profile/profile.info.yml"

File (373B)

-rw-r--r-- 33 33 373 Dec 09 2025 modules/contrib/profile/profile.info.yml

rabbit_hole => string (48) "modules/contrib/rabbit_hole/rabbit_hole.info.yml"

File (395B)

-rw-r--r-- 33 33 395 Mar 16 16:43 modules/contrib/rabbit_hole/rabbit_hole.info.yml

recaptcha => string (44) "modules/contrib/recaptcha/recaptcha.info.yml"

File (399B)

-rw-r--r-- 33 33 399 Aug 13 2024 modules/contrib/recaptcha/recaptcha.info.yml

recreate_block_content => string (70) "modules/contrib/recreate_block_content/recreate_block_content.info.yml"

File (328B)

-rw-r--r-- 33 33 328 Nov 28 2024 modules/contrib/recreate_block_content/recreate_block_content.info.yml

redirect => string (42) "modules/contrib/redirect/redirect.info.yml"

File (357B)

-rw-r--r-- 33 33 357 Apr 23 22:03 modules/contrib/redirect/redirect.info.yml

reroute_email => string (52) "modules/contrib/reroute_email/reroute_email.info.yml"

File (359B)

-rw-r--r-- 33 33 359 Oct 28 2024 modules/contrib/reroute_email/reroute_email.info.yml

reroute_email_symfony_mailer => string (104) "modules/contrib/reroute_email/modules/reroute_email_symfony_mailer/reroute_e...

File (429B)
Contents

-rw-r--r-- 33 33 429 Oct 28 2024 modules/contrib/reroute_email/modules/reroute_email_symfony_mailer/reroute_email_symfony_mailer.info.yml

modules/contrib/reroute_email/modules/reroute_email_symfony_mailer/reroute_email_symfony_mailer.info.yml

responsive_image => string (55) "core/modules/responsive_image/responsive_image.info.yml"

File (267B)

-rw-rw-r-- 33 33 267 Jun 23 00:19 core/modules/responsive_image/responsive_image.info.yml

rh_node => string (60) "modules/contrib/rabbit_hole/modules/rh_node/rh_node.info.yml"

File (405B)

-rw-r--r-- 33 33 405 Mar 16 16:43 modules/contrib/rabbit_hole/modules/rh_node/rh_node.info.yml

rh_taxonomy => string (68) "modules/contrib/rabbit_hole/modules/rh_taxonomy/rh_taxonomy.info.yml"

File (415B)

-rw-r--r-- 33 33 415 Mar 16 16:43 modules/contrib/rabbit_hole/modules/rh_taxonomy/rh_taxonomy.info.yml

role_delegation => string (56) "modules/contrib/role_delegation/role_delegation.info.yml"

File (370B)

-rw-r--r-- 33 33 370 Jan 30 02:24 modules/contrib/role_delegation/role_delegation.info.yml

role_expire => string (48) "modules/contrib/role_expire/role_expire.info.yml"

File (295B)

-rw-r--r-- 33 33 295 Oct 31 2024 modules/contrib/role_expire/role_expire.info.yml

scheduler => string (44) "modules/contrib/scheduler/scheduler.info.yml"

File (620B)

-rw-r--r-- 33 33 620 Jun 05 03:10 modules/contrib/scheduler/scheduler.info.yml

scheduler_content_moderation_integration => string (106) "modules/contrib/scheduler_content_moderation_integration/scheduler_content_m...

File (458B)
Contents

-rw-r--r-- 33 33 458 Apr 21 14:31 modules/contrib/scheduler_content_moderation_integration/scheduler_content_moderation_integration.info.yml

modules/contrib/scheduler_content_moderation_integration/scheduler_content_moderation_integration.info.yml

search_api => string (46) "modules/contrib/search_api/search_api.info.yml"

File (352B)

-rw-r--r-- 33 33 352 Jun 08 01:22 modules/contrib/search_api/search_api.info.yml

search_api_db => string (71) "modules/contrib/search_api/modules/search_api_db/search_api_db.info.yml"

File (364B)

-rw-r--r-- 33 33 364 Jun 08 01:22 modules/contrib/search_api/modules/search_api_db/search_api_db.info.yml

select2 => string (40) "modules/contrib/select2/select2.info.yml"

File (338B)

-rw-r--r-- 33 33 338 Jan 09 2025 modules/contrib/select2/select2.info.yml

shortcut => string (39) "core/modules/shortcut/shortcut.info.yml"

File (204B)

-rw-rw-r-- 33 33 204 Jun 23 00:19 core/modules/shortcut/shortcut.info.yml

simple_sitemap => string (54) "modules/contrib/simple_sitemap/simple_sitemap.info.yml"

File (506B)

-rw-r--r-- 33 33 506 Nov 26 2025 modules/contrib/simple_sitemap/simple_sitemap.info.yml

smart_trim => string (46) "modules/contrib/smart_trim/smart_trim.info.yml"

File (435B)

-rw-r--r-- 33 33 435 Jan 11 11:58 modules/contrib/smart_trim/smart_trim.info.yml

spark => string (35) "modules/custom/spark/spark.info.yml"

File (189B)

-rw-rw-r-- 33 33 189 Jul 13 22:45 modules/custom/spark/spark.info.yml

stage_file_proxy => string (58) "modules/contrib/stage_file_proxy/stage_file_proxy.info.yml"

File (395B)

-rw-r--r-- 33 33 395 Sep 11 2025 modules/contrib/stage_file_proxy/stage_file_proxy.info.yml

stripe_api => string (46) "modules/contrib/stripe_api/stripe_api.info.yml"

File (347B)

-rw-r--r-- 33 33 347 Nov 06 2025 modules/contrib/stripe_api/stripe_api.info.yml

symfony_mailer => string (54) "modules/contrib/symfony_mailer/symfony_mailer.info.yml"

File (387B)

-rw-r--r-- 33 33 387 Jun 27 2025 modules/contrib/symfony_mailer/symfony_mailer.info.yml

symfony_mailer_log => string (62) "modules/contrib/symfony_mailer_log/symfony_mailer_log.info.yml"

File (345B)

-rw-r--r-- 33 33 345 Jun 05 11:38 modules/contrib/symfony_mailer_log/symfony_mailer_log.info.yml

symfony_mailer_queue => string (66) "modules/contrib/symfony_mailer_queue/symfony_mailer_queue.info.yml"

File (398B)

-rw-r--r-- 33 33 398 Feb 09 09:18 modules/contrib/symfony_mailer_queue/symfony_mailer_queue.info.yml

system => string (35) "core/modules/system/system.info.yml"

File (168B)

-rw-rw-r-- 33 33 168 Jun 23 00:19 core/modules/system/system.info.yml

taxonomy => string (39) "core/modules/taxonomy/taxonomy.info.yml"

File (208B)

-rw-rw-r-- 33 33 208 Jun 23 00:19 core/modules/taxonomy/taxonomy.info.yml

text => string (31) "core/modules/text/text.info.yml"

File (195B)

-rw-rw-r-- 33 33 195 Jun 23 00:19 core/modules/text/text.info.yml

token => string (36) "modules/contrib/token/token.info.yml"

File (276B)

-rw-r--r-- 33 33 276 Jan 08 22:49 modules/contrib/token/token.info.yml

token_filter => string (50) "modules/contrib/token_filter/token_filter.info.yml"

File (306B)

-rw-r--r-- 33 33 306 Jun 23 2024 modules/contrib/token_filter/token_filter.info.yml

toolbar => string (37) "core/modules/toolbar/toolbar.info.yml"

File (182B)

-rw-rw-r-- 33 33 182 Jun 23 00:19 core/modules/toolbar/toolbar.info.yml

tour => string (34) "modules/contrib/tour/tour.info.yml"

File (303B)

-rw-r--r-- 33 33 303 Jan 29 17:06 modules/contrib/tour/tour.info.yml

ui_patterns => string (48) "modules/contrib/ui_patterns/ui_patterns.info.yml"

File (261B)

-rw-r--r-- 33 33 261 Apr 08 02:40 modules/contrib/ui_patterns/ui_patterns.info.yml

ui_patterns_ds => string (74) "modules/contrib/ui_patterns/modules/ui_patterns_ds/ui_patterns_ds.info.yml"

File (409B)

-rw-r--r-- 33 33 409 Apr 08 02:40 modules/contrib/ui_patterns/modules/ui_patterns_ds/ui_patterns_ds.info.yml

ui_patterns_field_group => string (92) "modules/contrib/ui_patterns/modules/ui_patterns_field_group/ui_patterns_fiel...

File (370B)
Contents

-rw-r--r-- 33 33 370 Apr 08 02:40 modules/contrib/ui_patterns/modules/ui_patterns_field_group/ui_patterns_field_group.info.yml

modules/contrib/ui_patterns/modules/ui_patterns_field_group/ui_patterns_field_group.info.yml

ui_patterns_layouts => string (84) "modules/contrib/ui_patterns/modules/ui_patterns_layouts/ui_patterns_layouts....

File (383B)
Contents

-rw-r--r-- 33 33 383 Apr 08 02:40 modules/contrib/ui_patterns/modules/ui_patterns_layouts/ui_patterns_layouts.info.yml

modules/contrib/ui_patterns/modules/ui_patterns_layouts/ui_patterns_layouts.info.yml

ui_patterns_library => string (84) "modules/contrib/ui_patterns/modules/ui_patterns_library/ui_patterns_library....

File (385B)
Contents

-rw-r--r-- 33 33 385 Apr 08 02:40 modules/contrib/ui_patterns/modules/ui_patterns_library/ui_patterns_library.info.yml

modules/contrib/ui_patterns/modules/ui_patterns_library/ui_patterns_library.info.yml

ui_patterns_settings => string (66) "modules/contrib/ui_patterns_settings/ui_patterns_settings.info.yml"

File (346B)

-rw-r--r-- 33 33 346 Sep 14 2024 modules/contrib/ui_patterns_settings/ui_patterns_settings.info.yml

ui_patterns_views => string (80) "modules/contrib/ui_patterns/modules/ui_patterns_views/ui_patterns_views.info...

File (346B)
Contents

-rw-r--r-- 33 33 346 Apr 08 02:40 modules/contrib/ui_patterns/modules/ui_patterns_views/ui_patterns_views.info.yml

modules/contrib/ui_patterns/modules/ui_patterns_views/ui_patterns_views.info.yml

update => string (35) "core/modules/update/update.info.yml"

File (185B)

-rw-rw-r-- 33 33 185 Jun 23 00:19 core/modules/update/update.info.yml

user => string (31) "core/modules/user/user.info.yml"

File (222B)

-rw-rw-r-- 33 33 222 Jun 23 00:19 core/modules/user/user.info.yml

video_embed_field => string (60) "modules/contrib/video_embed_field/video_embed_field.info.yml"

File (456B)

-rw-r--r-- 33 33 456 Apr 20 09:56 modules/contrib/video_embed_field/video_embed_field.info.yml

view_unpublished => string (58) "modules/contrib/view_unpublished/view_unpublished.info.yml"

File (344B)

-rw-r--r-- 33 33 344 Aug 24 2024 modules/contrib/view_unpublished/view_unpublished.info.yml

views_ajax_history => string (62) "modules/contrib/views_ajax_history/views_ajax_history.info.yml"

File (330B)

-rw-r--r-- 33 33 330 Dec 30 2024 modules/contrib/views_ajax_history/views_ajax_history.info.yml

views_flag_refresh => string (62) "modules/contrib/views_flag_refresh/views_flag_refresh.info.yml"

File (442B)

-rw-r--r-- 33 33 442 Jun 16 16:31 modules/contrib/views_flag_refresh/views_flag_refresh.info.yml

views_infinite_scroll => string (68) "modules/contrib/views_infinite_scroll/views_infinite_scroll.info.yml"

File (335B)

-rw-r--r-- 33 33 335 Aug 22 2024 modules/contrib/views_infinite_scroll/views_infinite_scroll.info.yml

views_random_seed => string (60) "modules/contrib/views_random_seed/views_random_seed.info.yml"

File (332B)

-rw-r--r-- 33 33 332 Aug 03 2024 modules/contrib/views_random_seed/views_random_seed.info.yml

views_taxonomy_term_name_into_id => string (90) "modules/contrib/views_taxonomy_term_name_into_id/views_taxonomy_term_name_in...

File (454B)
Contents

-rw-r--r-- 33 33 454 Nov 11 2025 modules/contrib/views_taxonomy_term_name_into_id/views_taxonomy_term_name_into_id.info.yml

modules/contrib/views_taxonomy_term_name_into_id/views_taxonomy_term_name_into_id.info.yml

views_ui => string (39) "core/modules/views_ui/views_ui.info.yml"

File (200B)

-rw-rw-r-- 33 33 200 Jun 23 00:19 core/modules/views_ui/views_ui.info.yml

webform => string (40) "modules/contrib/webform/webform.info.yml"

File (385B)

-rw-r--r-- 33 33 385 Jul 07 08:38 modules/contrib/webform/webform.info.yml

webform_ui => string (62) "modules/contrib/webform/modules/webform_ui/webform_ui.info.yml"

File (330B)

-rw-r--r-- 33 33 330 Jul 07 08:38 modules/contrib/webform/modules/webform_ui/webform_ui.info.yml

webform_views => string (52) "modules/contrib/webform_views/webform_views.info.yml"

File (333B)

-rw-r--r-- 33 33 333 Jan 11 17:05 modules/contrib/webform_views/webform_views.info.yml

workflows => string (41) "core/modules/workflows/workflows.info.yml"

File (267B)

-rw-rw-r-- 33 33 267 Jun 23 00:19 core/modules/workflows/workflows.info.yml

cbc_profile => string (47) "modules/custom/cbc_profile/cbc_profile.info.yml"

File (182B)

-rw-rw-r-- 33 33 182 Jul 13 22:45 modules/custom/cbc_profile/cbc_profile.info.yml

ds => string (30) "modules/contrib/ds/ds.info.yml"

File (399B)

-rw-r--r-- 33 33 399 Feb 13 08:31 modules/contrib/ds/ds.info.yml

extlink => string (40) "modules/contrib/extlink/extlink.info.yml"

File (320B)

-rw-r--r-- 33 33 320 Sep 08 2025 modules/contrib/extlink/extlink.info.yml

menu_admin_per_menu => string (64) "modules/contrib/menu_admin_per_menu/menu_admin_per_menu.info.yml"

File (425B)

-rw-r--r-- 33 33 425 Jun 18 2025 modules/contrib/menu_admin_per_menu/menu_admin_per_menu.info.yml

pathauto => string (42) "modules/contrib/pathauto/pathauto.info.yml"

File (439B)

-rw-r--r-- 33 33 439 May 04 14:44 modules/contrib/pathauto/pathauto.info.yml

selective_better_exposed_filters => string (90) "modules/contrib/selective_better_exposed_filters/selective_better_exposed_fi...

File (429B)
Contents

-rw-r--r-- 33 33 429 Jun 30 2024 modules/contrib/selective_better_exposed_filters/selective_better_exposed_filters.info.yml

modules/contrib/selective_better_exposed_filters/selective_better_exposed_filters.info.yml

views => string (33) "core/modules/views/views.info.yml"

File (203B)

-rw-rw-r-- 33 33 203 Jun 23 00:19 core/modules/views/views.info.yml

ignite => string (38) "profiles/custom/ignite/ignite.info.yml"

File (1.8KB)

-rw-rw-r-- 33 33 1841 Jul 13 22:45 profiles/custom/ignite/ignite.info.yml

protected state -> Drupal\Core\State\State#337 (12)

Properties (12)
Methods (20)
Static properties (1)

protected cid -> string (5) "state"
protected tags -> array (0)
protected cache -> Drupal\Core\Cache\ChainedFastBackend#665 Depth Limit
protected lock -> Drupal\Core\ProxyClass\Lock\DatabaseLockBackend#340 Depth Limit
protected keysToPersist -> array (0)
protected keysToRemove -> array (0)
protected storage -> array (12) Depth Limit
protected cacheCreated -> double 1784181811.428
protected cacheInvalidated -> boolean false
protected cacheLoaded -> boolean true
protected keyValueStore -> Drupal\Core\KeyValueStore\DatabaseStorage#341 Depth Limit
protected keysSetDuringRequest -> array (0)

public __construct(Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Lock\LockBackendInterface $lock) Constructs a State object.

/**
 * Constructs a State object.
 *
 * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
 *   The key value store to use.
 * @param \Drupal\Core\Cache\CacheBackendInterface $cache
 *   The cache backend.
 * @param \Drupal\Core\Lock\LockBackendInterface $lock
 *   The lock backend.
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:53

public get($key, $default = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:61

protected resolveCacheMiss($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:75

public getMultiple(array $keys) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:85

public set($key, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:97

public setMultiple(array $data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:119

public delete($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:131

public deleteMultiple(array $keys) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:139

public resetCache() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:149

public getValuesSetDuringRequest(string $key): ?array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:156

protected registerKeySetDuringRequest(string $key, mixed $value, mixed $previousValue): void Registers a key that was set during the request.

/**
 * Registers a key that was set during the request.
 *
 * @param string $key
 *   The key that was set.
 * @param mixed $value
 *   The value that was set.
 * @param mixed $previousValue
 *   The previous value that was stored.
 */

Defined in <drupal>/core/lib/Drupal/Core/State/State.php:170

protected getCid(): string Gets the cache ID.

/**
 * Gets the cache ID.
 *
 * @return string
 *   The cache ID.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:127

public has($key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:134

protected persist($key, $persist = true) Flags an offset value to be written to the persistent cache.

/**
 * Flags an offset value to be written to the persistent cache.
 *
 * @param string $key
 *   The key that was requested.
 * @param bool $persist
 *   (optional) Whether the offset should be persisted or not, defaults to
 *   TRUE. When called with $persist = FALSE the offset will be un-flagged so
 *   that it will not be written at the end of the request.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:196

protected updateCache($lock = true) Writes a value to the persistent cache immediately.

/**
 * Writes a value to the persistent cache immediately.
 *
 * @param bool $lock
 *   (optional) Whether to acquire a lock before writing to cache. Defaults to
 *   TRUE.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:222

public reset() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:289

public clear() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:299

public destruct() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:312

protected lazyLoadCache() Loads the cache if not already done.

/**
 * Loads the cache if not already done.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:319

protected invalidateCache() Invalidate the cache.

/**
 * Invalidate the cache.
 */

Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:335

private static Drupal\Core\State\State::$deprecatedState :: array (0)

protected installProfile -> string (6) "ignite"

protected configFactory -> Drupal\Core\Config\ConfigFactory#356 Blacklisted

protected profileList -> Drupal\Core\Extension\ProfileExtensionList#1161 (12)

Properties (12)
Methods (24)
Static methods (1)

protected type -> string (7) "profile"
protected root -> string (17) "/var/www/html/web"
- Directory
- ```
drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web
```
protected cache -> Drupal\Core\Cache\DatabaseBackend#182 Depth Limit
protected defaults -> array (6) Depth Limit
protected infoParser -> Drupal\Core\Extension\InfoParser#1136 Depth Limit
protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#653 Blacklisted
protected extensions -> null
protected extensionInfo -> null
protected pathNames -> null
protected addedPathNames -> array (0)
protected state -> Drupal\Core\State\State#337 Depth Limit
protected installProfile -> string (6) "ignite"

protected getInstalledExtensionNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ProfileExtensionList.php:31

/**
 * Constructs a new instance.
 *
 * @param string $root
 *   The app root.
 * @param string $type
 *   The extension type.
 * @param \Drupal\Core\Cache\CacheBackendInterface $cache
 *   The cache.
 * @param \Drupal\Core\Extension\InfoParserInterface $info_parser
 *   The info parser.
 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
 *   The module handler.
 * @param \Drupal\Core\State\StateInterface $state
 *   The state.
 * @param string $install_profile
 *   The install profile used by the site.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:137

protected getExtensionDiscovery(): \Drupal\Core\Extension\ExtensionDiscovery Returns the extension discovery.

/**
 * Returns the extension discovery.
 *
 * @return \Drupal\Core\Extension\ExtensionDiscovery
 *   The extension discovery.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:153

public reset(): $this Resets the stored extension list.

/**
 * Resets the stored extension list.
 *
 * We don't reset statically added filenames, as it is a static cache which
 * logically can't change. This is done for performance reasons of the
 * installer.
 *
 * @return $this
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:166

protected getListCacheId(): string Returns the extension list cache ID.

/**
 * Returns the extension list cache ID.
 *
 * @return string
 *   The list cache ID.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:193

protected getInfoCacheId(): string Returns the extension info cache ID.

/**
 * Returns the extension info cache ID.
 *
 * @return string
 *   The info cache ID.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:203

protected getPathNamesCacheId(): string Returns the extension filenames cache ID.

/**
 * Returns the extension filenames cache ID.
 *
 * @return string
 *   The filename cache ID.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:213

public exists($extension_name): bool Determines if an extension exists in the filesystem.

/**
 * Determines if an extension exists in the filesystem.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 *
 * @return bool
 *   TRUE if the extension exists (regardless installed or not) and FALSE if
 *   not.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:227

public getName($extension_name): string Returns the human-readable name of the extension.

/**
 * Returns the human-readable name of the extension.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 *
 * @return string
 *   The human-readable name of the extension.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:244

public get($extension_name): \Drupal\Core\Extension\Extension Returns a single extension.

/**
 * Returns a single extension.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 *
 * @return \Drupal\Core\Extension\Extension
 *   A processed extension object for the extension with the specified machine
 *   name.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:261

public getList(): \Drupal\Core\Extension\Extension[] Returns all available extensions.

/**
 * Returns all available extensions.
 *
 * @return \Drupal\Core\Extension\Extension[]
 *   Processed extension objects, keyed by machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:276

protected doScanExtensions(): \Drupal\Core\Extension\Extension[] Scans the available extensions.

/**
 * Scans the available extensions.
 *
 * Overriding this method gives other code the chance to add additional
 * extensions to this raw listing.
 *
 * @return \Drupal\Core\Extension\Extension[]
 *   Unprocessed extension objects, keyed by machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:299

protected doList(): \Drupal\Core\Extension\Extension[] Builds the list of extensions.

/**
 * Builds the list of extensions.
 *
 * @return \Drupal\Core\Extension\Extension[]
 *   Processed extension objects, keyed by machine name.
 *
 * @throws \Drupal\Core\Extension\InfoParserException
 *   If one of the .info.yml files is incomplete, or causes a parsing error.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:312

public getExtensionInfo($extension_name): mixed[] Returns information about a specified extension.

/**
 * Returns information about a specified extension.
 *
 * This function returns the contents of the .info.yml file for the specified
 * extension.
 *
 * @param string $extension_name
 *   The name of an extension whose information shall be returned.
 *
 * @return mixed[]
 *   An associative array of extension information.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:343

public getAllAvailableInfo(): array[] Returns an array of info files information of available extensions.

/**
 * Returns an array of info files information of available extensions.
 *
 * This function returns the processed contents (with added defaults) of the
 * .info.yml files.
 *
 * @return array[]
 *   An associative array of extension information arrays, keyed by extension
 *   name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:361

public getAllInstalledInfo(): array[] Returns an array of info files information of installed extensions.

/**
 * Returns an array of info files information of installed extensions.
 *
 * This function returns the processed contents (with added defaults) of the
 * .info.yml files.
 *
 * @return array[]
 *   An associative array of extension information arrays, keyed by extension
 *   name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:395

protected recalculateInfo(): array[] Generates the information from .info.yml files for extensions of this type.

/**
 * Generates the information from .info.yml files for extensions of this type.
 *
 * @return array[]
 *   An array of arrays of .info.yml entries keyed by the machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:405

public getPathNames(): string[] Returns a list of extension file paths keyed by machine name.

/**
 * Returns a list of extension file paths keyed by machine name.
 *
 * @return string[]
 *   An associative array of extension file paths, keyed by the extension
 *   machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:418

protected recalculatePathNames(): string[] Generates a sorted list of .info.yml file locations for all extensions.

/**
 * Generates a sorted list of .info.yml file locations for all extensions.
 *
 * @return string[]
 *   An array of .info.yml file locations keyed by the extension machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:439

public setPathname($extension_name, $pathname) Sets the pathname for an extension.

/**
 * Sets the pathname for an extension.
 *
 * This method is used in the Drupal bootstrapping phase, when the extension
 * system is not fully initialized, to manually set locations of modules and
 * profiles needed to complete bootstrapping.
 *
 * It is not recommended to call this method except in those rare cases.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 * @param string $pathname
 *   The pathname of the extension which is to be set explicitly rather
 *   than by consulting the dynamic extension listing.
 *
 * @internal
 *
 * @see ::getPathname
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:467

public getPathname($extension_name): string Gets the info file path for an extension.

/**
 * Gets the info file path for an extension.
 *
 * The info path, whether provided, cached, or retrieved from the database, is
 * only returned if the file exists.
 *
 * This function plays a key role in allowing Drupal's extensions (modules,
 * themes, profiles, theme_engines, etc.) to be located in different places
 * depending on a site's configuration. For example, a module 'foo' may
 * legally be located in any of these four places:
 *
 * - core/modules/foo/foo.info.yml
 * - modules/foo/foo.info.yml
 * - sites/all/modules/foo/foo.info.yml
 * - sites/example.com/modules/foo/foo.info.yml
 *
 * while a theme 'bar' may be located in any of the following four places:
 *
 * - core/themes/bar/bar.info.yml
 * - themes/bar/bar.info.yml
 * - sites/all/themes/bar/bar.info.yml
 * - sites/example.com/themes/bar/bar.info.yml
 *
 * An installation profile maybe be located in any of the following places:
 *
 * - core/profiles/baz/baz.info.yml
 * - profiles/baz/baz.info.yml
 *
 * Calling ExtensionList::getPathname('foo') will give you one of the above,
 * depending on where the extension is located and what type it is.
 *
 * @param string $extension_name
 *   The machine name of the extension for which the pathname is requested.
 *
 * @return string
 *   The drupal-root relative filename and path of the requested extension's
 *   .info.yml file.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:512

public getPath($extension_name): string Gets the path to an extension of a specific type (module, theme, etc.).

/**
 * Gets the path to an extension of a specific type (module, theme, etc.).
 *
 * The path is the directory in which the .info file is located. This name is
 * coming from \SplFileInfo.
 *
 * @param string $extension_name
 *   The machine name of the extension for which the path is requested.
 *
 * @return string
 *   The Drupal-root-relative path to the specified extension.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:540

protected createExtensionInfo(Drupal\Core\Extension\Extension $extension): array Creates the info value for an extension object.

/**
 * Creates the info value for an extension object.
 *
 * @param \Drupal\Core\Extension\Extension $extension
 *   The extension whose info is to be altered.
 *
 * @return array
 *   The extension info array.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:553

public checkIncompatibility($name): bool Tests the compatibility of an extension.

/**
 * Tests the compatibility of an extension.
 *
 * @param string $name
 *   The extension name to check.
 *
 * @return bool
 *   TRUE if the extension is incompatible and FALSE if not.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:583

/**
 * Array sorting callback; sorts extensions by their name.
 *
 * @param \Drupal\Core\Extension\Extension $a
 *   The first extension to compare.
 * @param \Drupal\Core\Extension\Extension $b
 *   The second extension to compare.
 *
 * @return int
 *   Less than 0 if $a is less than $b, more than 0 if $a is greater than $b,
 *   and 0 if they are equal.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:600

protected stringTranslation -> null

public __construct($root, $type, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\InfoParserInterface $info_parser, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\State\StateInterface $state, Drupal\Core\Config\ConfigFactoryInterface $config_factory, Drupal\Core\Extension\ExtensionList $profile_list, $install_profile, array $container_modules_info = array()) Constructs a new ModuleExtensionList instance.

/**
 * Constructs a new ModuleExtensionList instance.
 *
 * @param string $root
 *   The app root.
 * @param string $type
 *   The extension type.
 * @param \Drupal\Core\Cache\CacheBackendInterface $cache
 *   The cache.
 * @param \Drupal\Core\Extension\InfoParserInterface $info_parser
 *   The info parser.
 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
 *   The module handler.
 * @param \Drupal\Core\State\StateInterface $state
 *   The state.
 * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
 *   The config factory.
 * @param \Drupal\Core\Extension\ExtensionList $profile_list
 *   The site profile listing.
 * @param string $install_profile
 *   The install profile used by the site.
 * @param array[] $container_modules_info
 *   (optional) The module locations coming from the compiled container.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:73

protected getExtensionDiscovery() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:88

protected getProfileDirectories(Drupal\Core\Extension\ExtensionDiscovery $discovery): string[] Finds all installation profile paths.

/**
 * Finds all installation profile paths.
 *
 * @param \Drupal\Core\Extension\ExtensionDiscovery $discovery
 *   The extension discovery.
 *
 * @return string[]
 *   Paths to all installation profiles.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:107

protected getActiveProfile(): \Drupal\Core\Extension\Extension|null Gets the processed active profile object, or null.

/**
 * Gets the processed active profile object, or null.
 *
 * @return \Drupal\Core\Extension\Extension|null
 *   The active profile, if there is one.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:125

protected doScanExtensions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:137

protected doList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:153

protected getInstalledExtensionNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:197

protected ensureRequiredDependencies(Drupal\Core\Extension\Extension $module, array $modules = array()) Marks dependencies of required modules as 'required', recursively.

/**
 * Marks dependencies of required modules as 'required', recursively.
 *
 * @param \Drupal\Core\Extension\Extension $module
 *   The module extension object.
 * @param \Drupal\Core\Extension\Extension[] $modules
 *   Extension objects for all available modules.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:209

public reset(): $this Resets the stored extension list.

/**
 * Resets the stored extension list.
 *
 * We don't reset statically added filenames, as it is a static cache which
 * logically can't change. This is done for performance reasons of the
 * installer.
 *
 * @return $this
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:166

protected getListCacheId(): string Returns the extension list cache ID.

/**
 * Returns the extension list cache ID.
 *
 * @return string
 *   The list cache ID.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:193

protected getInfoCacheId(): string Returns the extension info cache ID.

/**
 * Returns the extension info cache ID.
 *
 * @return string
 *   The info cache ID.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:203

protected getPathNamesCacheId(): string Returns the extension filenames cache ID.

/**
 * Returns the extension filenames cache ID.
 *
 * @return string
 *   The filename cache ID.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:213

public exists($extension_name): bool Determines if an extension exists in the filesystem.

/**
 * Determines if an extension exists in the filesystem.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 *
 * @return bool
 *   TRUE if the extension exists (regardless installed or not) and FALSE if
 *   not.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:227

public getName($extension_name): string Returns the human-readable name of the extension.

/**
 * Returns the human-readable name of the extension.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 *
 * @return string
 *   The human-readable name of the extension.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:244

public get($extension_name): \Drupal\Core\Extension\Extension Returns a single extension.

/**
 * Returns a single extension.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 *
 * @return \Drupal\Core\Extension\Extension
 *   A processed extension object for the extension with the specified machine
 *   name.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:261

public getList(): \Drupal\Core\Extension\Extension[] Returns all available extensions.

/**
 * Returns all available extensions.
 *
 * @return \Drupal\Core\Extension\Extension[]
 *   Processed extension objects, keyed by machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:276

public getExtensionInfo($extension_name): mixed[] Returns information about a specified extension.

/**
 * Returns information about a specified extension.
 *
 * This function returns the contents of the .info.yml file for the specified
 * extension.
 *
 * @param string $extension_name
 *   The name of an extension whose information shall be returned.
 *
 * @return mixed[]
 *   An associative array of extension information.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:343

public getAllAvailableInfo(): array[] Returns an array of info files information of available extensions.

/**
 * Returns an array of info files information of available extensions.
 *
 * This function returns the processed contents (with added defaults) of the
 * .info.yml files.
 *
 * @return array[]
 *   An associative array of extension information arrays, keyed by extension
 *   name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:361

public getAllInstalledInfo(): array[] Returns an array of info files information of installed extensions.

/**
 * Returns an array of info files information of installed extensions.
 *
 * This function returns the processed contents (with added defaults) of the
 * .info.yml files.
 *
 * @return array[]
 *   An associative array of extension information arrays, keyed by extension
 *   name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:395

protected recalculateInfo(): array[] Generates the information from .info.yml files for extensions of this type.

/**
 * Generates the information from .info.yml files for extensions of this type.
 *
 * @return array[]
 *   An array of arrays of .info.yml entries keyed by the machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:405

public getPathNames(): string[] Returns a list of extension file paths keyed by machine name.

/**
 * Returns a list of extension file paths keyed by machine name.
 *
 * @return string[]
 *   An associative array of extension file paths, keyed by the extension
 *   machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:418

protected recalculatePathNames(): string[] Generates a sorted list of .info.yml file locations for all extensions.

/**
 * Generates a sorted list of .info.yml file locations for all extensions.
 *
 * @return string[]
 *   An array of .info.yml file locations keyed by the extension machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:439

public setPathname($extension_name, $pathname) Sets the pathname for an extension.

/**
 * Sets the pathname for an extension.
 *
 * This method is used in the Drupal bootstrapping phase, when the extension
 * system is not fully initialized, to manually set locations of modules and
 * profiles needed to complete bootstrapping.
 *
 * It is not recommended to call this method except in those rare cases.
 *
 * @param string $extension_name
 *   The machine name of the extension.
 * @param string $pathname
 *   The pathname of the extension which is to be set explicitly rather
 *   than by consulting the dynamic extension listing.
 *
 * @internal
 *
 * @see ::getPathname
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:467

public getPathname($extension_name): string Gets the info file path for an extension.

/**
 * Gets the info file path for an extension.
 *
 * The info path, whether provided, cached, or retrieved from the database, is
 * only returned if the file exists.
 *
 * This function plays a key role in allowing Drupal's extensions (modules,
 * themes, profiles, theme_engines, etc.) to be located in different places
 * depending on a site's configuration. For example, a module 'foo' may
 * legally be located in any of these four places:
 *
 * - core/modules/foo/foo.info.yml
 * - modules/foo/foo.info.yml
 * - sites/all/modules/foo/foo.info.yml
 * - sites/example.com/modules/foo/foo.info.yml
 *
 * while a theme 'bar' may be located in any of the following four places:
 *
 * - core/themes/bar/bar.info.yml
 * - themes/bar/bar.info.yml
 * - sites/all/themes/bar/bar.info.yml
 * - sites/example.com/themes/bar/bar.info.yml
 *
 * An installation profile maybe be located in any of the following places:
 *
 * - core/profiles/baz/baz.info.yml
 * - profiles/baz/baz.info.yml
 *
 * Calling ExtensionList::getPathname('foo') will give you one of the above,
 * depending on where the extension is located and what type it is.
 *
 * @param string $extension_name
 *   The machine name of the extension for which the pathname is requested.
 *
 * @return string
 *   The drupal-root relative filename and path of the requested extension's
 *   .info.yml file.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied machine name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:512

public getPath($extension_name): string Gets the path to an extension of a specific type (module, theme, etc.).

/**
 * Gets the path to an extension of a specific type (module, theme, etc.).
 *
 * The path is the directory in which the .info file is located. This name is
 * coming from \SplFileInfo.
 *
 * @param string $extension_name
 *   The machine name of the extension for which the path is requested.
 *
 * @return string
 *   The Drupal-root-relative path to the specified extension.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:540

protected createExtensionInfo(Drupal\Core\Extension\Extension $extension): array Creates the info value for an extension object.

/**
 * Creates the info value for an extension object.
 *
 * @param \Drupal\Core\Extension\Extension $extension
 *   The extension whose info is to be altered.
 *
 * @return array
 *   The extension info array.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:553

public checkIncompatibility($name): bool Tests the compatibility of an extension.

/**
 * Tests the compatibility of an extension.
 *
 * @param string $name
 *   The extension name to check.
 *
 * @return bool
 *   TRUE if the extension is incompatible and FALSE if not.
 *
 * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
 *   If there is no extension with the supplied name.
 */

Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:583

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
 */

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.
 */

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.
 */

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.
 */

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
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

/**
 * Array sorting callback; sorts extensions by their name.
 *
 * @param \Drupal\Core\Extension\Extension $a
 *   The first extension to compare.
 * @param \Drupal\Core\Extension\Extension $b
 *   The second extension to compare.
 *
 * @return int
 *   Less than 0 if $a is less than $b, more than 0 if $a is greater than $b,
 *   and 0 if they are equal.
 */

Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:600

protected preprocessForSuggestions -> null

protected themeHookList -> null

protected keyValueFactory -> Drupal\Core\KeyValueStore\KeyValueFactory#659 (3)

Properties (3)
Methods (2)
Class constants (3)

protected stores -> array (1)
state => Drupal\Core\KeyValueStore\DatabaseStorage#341 Depth Limit
protected container -> Drupal\Core\DependencyInjection\Container#37 Blacklisted
protected options -> array (1)
default => string (17) "keyvalue.database"

public __construct(Symfony\Component\DependencyInjection\ContainerInterface $container, array $options = array())

/**
 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 *   The service container.
 * @param array $options
 *   (optional) Collection-specific storage override options.
 */

Defined in <drupal>/core/lib/Drupal/Core/KeyValueStore/KeyValueFactory.php:62

public get($collection) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/KeyValueStore/KeyValueFactory.php:70

public const Drupal\Core\KeyValueStore\KeyValueFactory::SPECIFIC_PREFIX :: string (17) "keyvalue_service_"
public const Drupal\Core\KeyValueStore\KeyValueFactory::DEFAULT_SETTING :: string (7) "default"
public const Drupal\Core\KeyValueStore\KeyValueFactory::DEFAULT_SERVICE :: string (17) "keyvalue.database"

protected kernel -> Drupal\Core\DrupalKernel#2 (22)

Properties (22)
Methods (50)
Static methods (7)
Static properties (1)
Class constants (3)

protected phpArrayDumperClass -> string (68) "\Drupal\Component\DependencyInjection\Dumper\OptimizedPhpArrayDumper"

protected defaultBootstrapContainerDefinition -> array (2)

parameters => array (0)

services => array (6) Depth Limit

protected bootstrapContainerClass -> string (55) "\Drupal\Component\DependencyInjection\PhpArrayContainer"

protected bootstrapContainer -> Drupal\Component\DependencyInjection\PhpArrayContainer#21 Blacklisted

protected container -> Drupal\Core\DependencyInjection\Container#37 Blacklisted

protected environment -> string (4) "prod"

protected booted -> boolean true

protected prepared -> boolean true

protected moduleList -> null

protected moduleData -> array (0)

protected themeList -> uninitialized

protected themeExtensions -> array (0)

protected classLoader -> Composer\Autoload\ClassLoader#1 (11)

Properties (11)
Methods (22)
Static methods (2)
Static properties (2)

private vendorDir -> string (20) "/var/www/html/vendor"
- Directory
- ```
drwxrwxr-x 33 33 4096 Jul 13 23:03 /var/www/html/vendor
```
private prefixLengthsPsr4 -> array (23) Depth Limit
private prefixDirsPsr4 -> array (331) Depth Limit
private fallbackDirsPsr4 -> array (0)
private prefixesPsr0 -> array (4) Depth Limit
private fallbackDirsPsr0 -> array (0)
private useIncludePath -> boolean false
private classMap -> array (1308) Depth Limit
private classMapAuthoritative -> boolean false
private missingClasses -> array (1) Depth Limit
private apcuPrefix -> string (113) "drupal.class_loader:2942441263.8ea27d7326d9ebea..28114eb7259a89ee2d87416b038...
```
drupal.class_loader:2942441263.8ea27d7326d9ebea..28114eb7259a89ee2d87416b0386cf99af26573a487b1976b3908db7f49a62c2
```

public __construct($vendorDir = null)

/**
 * @param string|null $vendorDir
 */

Defined in <vendor>/composer/ClassLoader.php:106

public getPrefixes(): array<string, list<string>>

/**
 * @return array<string, list<string>>
 */

Defined in <vendor>/composer/ClassLoader.php:115

public getPrefixesPsr4(): array<string, list<string>>

/**
 * @return array<string, list<string>>
 */

Defined in <vendor>/composer/ClassLoader.php:127

public getFallbackDirs(): list<string>

/**
 * @return list<string>
 */

Defined in <vendor>/composer/ClassLoader.php:135

public getFallbackDirsPsr4(): list<string>

/**
 * @return list<string>
 */

Defined in <vendor>/composer/ClassLoader.php:143

public getClassMap(): array<string, string> Array of classname => path

/**
 * @return array<string, string> Array of classname => path
 */

Defined in <vendor>/composer/ClassLoader.php:151

public addClassMap(array $classMap): void

/**
 * @param array<string, string> $classMap Class to filename map
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:161

public add($prefix, $paths, $prepend = false): void Registers a set of PSR-0 directories for a given prefix, either appending or ...

/**
 * Registers a set of PSR-0 directories for a given prefix, either
 * appending or prepending to the ones previously set for this prefix.
 *
 * @param string              $prefix  The prefix
 * @param list<string>|string $paths   The PSR-0 root directories
 * @param bool                $prepend Whether to prepend the directories
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:180

public addPsr4($prefix, $paths, $prepend = false): void Registers a set of PSR-4 directories for a given namespace, either appending ...

/**
 * Registers a set of PSR-4 directories for a given namespace, either
 * appending or prepending to the ones previously set for this namespace.
 *
 * @param string              $prefix  The prefix/namespace, with trailing '\\'
 * @param list<string>|string $paths   The PSR-4 base directories
 * @param bool                $prepend Whether to prepend the directories
 *
 * @throws \InvalidArgumentException
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:230

public set($prefix, $paths): void Registers a set of PSR-0 directories for a given prefix, replacing any others...

/**
 * Registers a set of PSR-0 directories for a given prefix,
 * replacing any others previously set for this prefix.
 *
 * @param string              $prefix The prefix
 * @param list<string>|string $paths  The PSR-0 base directories
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:278

public setPsr4($prefix, $paths): void Registers a set of PSR-4 directories for a given namespace, replacing any oth...

/**
 * Registers a set of PSR-4 directories for a given namespace,
 * replacing any others previously set for this namespace.
 *
 * @param string              $prefix The prefix/namespace, with trailing '\\'
 * @param list<string>|string $paths  The PSR-4 base directories
 *
 * @throws \InvalidArgumentException
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:298

public setUseIncludePath($useIncludePath): void Turns on searching the include path for class files.

/**
 * Turns on searching the include path for class files.
 *
 * @param bool $useIncludePath
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:319

public getUseIncludePath(): bool Can be used to check if the autoloader uses the include path to check for cla...

/**
 * Can be used to check if the autoloader uses the include path to check
 * for classes.
 *
 * @return bool
 */

Defined in <vendor>/composer/ClassLoader.php:330

public setClassMapAuthoritative($classMapAuthoritative): void Turns off searching the prefix and fallback directories for classes that have...

/**
 * Turns off searching the prefix and fallback directories for classes
 * that have not been registered with the class map.
 *
 * @param bool $classMapAuthoritative
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:343

public isClassMapAuthoritative(): bool Should class lookup fail if not found in the current class map?

/**
 * Should class lookup fail if not found in the current class map?
 *
 * @return bool
 */

Defined in <vendor>/composer/ClassLoader.php:353

public setApcuPrefix($apcuPrefix): void APCu prefix to use to cache found/not-found classes, if the extension is enab...

/**
 * APCu prefix to use to cache found/not-found classes, if the extension is enabled.
 *
 * @param string|null $apcuPrefix
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:365

public getApcuPrefix(): string|null The APCu prefix in use, or null if APCu caching is not enabled.

/**
 * The APCu prefix in use, or null if APCu caching is not enabled.
 *
 * @return string|null
 */

Defined in <vendor>/composer/ClassLoader.php:375

public register($prepend = false): void Registers this instance as an autoloader.

/**
 * Registers this instance as an autoloader.
 *
 * @param bool $prepend Whether to prepend the autoloader or not
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:387

public unregister(): void Unregisters this instance as an autoloader.

/**
 * Unregisters this instance as an autoloader.
 *
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:408

public loadClass($class): true|null True if loaded, null otherwise Loads the given class or interface.

/**
 * Loads the given class or interface.
 *
 * @param  string    $class The name of the class
 * @return true|null True if loaded, null otherwise
 */

Defined in <vendor>/composer/ClassLoader.php:423

public findFile($class): string|false The path if found, false otherwise Finds the path to the file where the class is defined.

/**
 * Finds the path to the file where the class is defined.
 *
 * @param string $class The name of the class
 *
 * @return string|false The path if found, false otherwise
 */

Defined in <vendor>/composer/ClassLoader.php:442

private findFileWithExtension($class, $ext): string|false

/**
 * @param  string       $class
 * @param  string       $ext
 * @return string|false
 */

Defined in <vendor>/composer/ClassLoader.php:492

public static Composer\Autoload\ClassLoader::getRegisteredLoaders(): array<string, self> Returns the currently registered loaders keyed by their corresponding vendor ...

/**
 * Returns the currently registered loaders keyed by their corresponding vendor directories.
 *
 * @return array<string, self>
 */

Defined in <vendor>/composer/ClassLoader.php:482

private static Composer\Autoload\ClassLoader::initializeIncludeClosure(): void

/**
 * @return void
 */

Defined in <vendor>/composer/ClassLoader.php:561

private static Composer\Autoload\ClassLoader::$includeFile :: Closure#3 Depth Limit
private static Composer\Autoload\ClassLoader::$registeredLoaders :: array (1) Depth Limit

protected configStorage -> null

protected allowDumping -> boolean true

protected containerNeedsRebuild -> boolean false

protected containerNeedsDumping -> boolean false

protected serviceYamls -> null

protected serviceProviderClasses -> null

protected serviceProviders -> null

protected sitePath -> string (13) "sites/default"

Directory

drwxrwxr-x 33 33 4096 Jul 13 22:49 sites/default

protected root -> string (17) "/var/www/html/web"

Directory

drwxrwxr-x 33 33 4096 Jul 13 23:02 /var/www/html/web

public __construct($environment, $class_loader, $allow_dumping = true, $app_root = null) Constructs a DrupalKernel object.

/**
 * Constructs a DrupalKernel object.
 *
 * @param string $environment
 *   String indicating the environment, e.g. 'prod' or 'dev'.
 * @param \Composer\Autoload\ClassLoader $class_loader
 *   The class loader. Normally \Composer\Autoload\ClassLoader, as included by
 *   the front controller, but may also be decorated.
 * @param bool $allow_dumping
 *   (optional) FALSE to stop the container from being written to or read
 *   from disk. Defaults to TRUE.
 * @param string $app_root
 *   (optional) The path to the application root as a string. If not supplied,
 *   the application root will be computed.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:329

public setSitePath($path) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:471

public getSitePath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:481

public getAppRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:488

public boot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:495

public shutdown() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:549

public getContainer() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:566

public getCachedContainerDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:573

public loadLegacyIncludes() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:586

public preHandle(Symfony\Component\HttpFoundation\Request $request) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:597

public discoverServiceProviders() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:636

public getServiceProviders($origin) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:707

public terminate(Symfony\Component\HttpFoundation\Request $request, Symfony\Component\HttpFoundation\Response $response): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:714

public handle(Symfony\Component\HttpFoundation\Request $request, $type = 1, $catch = true): Symfony\Component\HttpFoundation\Response {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:736

protected handleException(Exception $e, $request, $type): \Symfony\Component\HttpFoundation\Response Converts an exception into a response.

/**
 * Converts an exception into a response.
 *
 * @param \Exception $e
 *   An exception.
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   A Request instance.
 * @param int $type
 *   The type of the request (one of HttpKernelInterface::MAIN_REQUEST or
 *   HttpKernelInterface::SUB_REQUEST)
 *
 * @return \Symfony\Component\HttpFoundation\Response
 *   A Response instance
 *
 * @throws \Exception
 *   If the passed in exception cannot be turned into a response.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:784

protected moduleData($module): \Drupal\Core\Extension\Extension|false Returns module data on the filesystem.

/**
 * Returns module data on the filesystem.
 *
 * @param string $module
 *   The name of the module.
 *
 * @return \Drupal\Core\Extension\Extension|false
 *   Returns an Extension object if the module is found, FALSE otherwise.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:808

private setExtensionData(): void Sets extension data to class properties using ExtensionDiscovery.

/**
 * Sets extension data to class properties using ExtensionDiscovery.
 *
 * This function is expensive to call as it scans the filesystem for
 * extensions. Use ::moduleData() and ::themeExtensions() instead.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:821

public updateModules(array $module_list, array $module_filenames = array()) Implements Drupal\Core\DrupalKernelInterface::updateModules().

/**
 * Implements Drupal\Core\DrupalKernelInterface::updateModules().
 *
 * @todo Remove obsolete $module_list parameter. Only $module_filenames is
 *   needed.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:846

protected themeExtensions($theme): Drupal\Core\Extension\Extension|false Returns theme data on the filesystem.

/**
 * Returns theme data on the filesystem.
 *
 * This allows us to update the container parameters and namespaces during
 * compile, theme install and theme uninstall. This ensures that the
 * container remains in sync before compiler passes.
 *
 * @param string $theme
 *   The name of the theme.
 *
 * @return \Drupal\Core\Extension\Extension|false
 *   Returns an Extension object if the theme is found, FALSE otherwise.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:896

public updateThemes(array $register_themes = array()): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:906

protected getContainerCacheKey(): string Returns the container cache key based on the environment.

/**
 * Returns the container cache key based on the environment.
 *
 * The 'environment' consists of:
 * - The kernel environment string.
 * - A hash based on all the installed package versions.
 * - The deployment identifier from settings.php. This allows custom
 *   deployments to force a container rebuild.
 * - The operating system running PHP. This allows compiler passes to optimize
 *   services for different operating systems.
 * - The paths to any additional container YAMLs from settings.php.
 *
 * @return string
 *   The cache key used for the service container.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:960

protected getKernelParameters(): array Returns the kernel parameters.

/**
 * Returns the kernel parameters.
 *
 * @return array
 *   An associative array of kernel parameters
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:978

protected initializeContainer(): \Symfony\Component\DependencyInjection\ContainerInterface Initializes the service container.

/**
 * Initializes the service container.
 *
 * @return \Symfony\Component\DependencyInjection\ContainerInterface
 *   An initialized container object.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:990

protected initializeSettings(Symfony\Component\HttpFoundation\Request $request) Locate site path and initialize settings singleton.

/**
 * Locate site path and initialize settings singleton.
 *
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The current request.
 *
 * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
 *   In case the host name in the request is not trusted.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1198

protected initializeRequestGlobals(Symfony\Component\HttpFoundation\Request $request) Bootstraps the legacy global request variables.

/**
 * Bootstraps the legacy global request variables.
 *
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The current request.
 *
 * @todo D8: Eliminate this entirely in favor of Request object.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1221

protected getServicesToPersist(Symfony\Component\DependencyInjection\ContainerInterface $container) Returns service instances to persist from an old container to a new one.

/**
 * Returns service instances to persist from an old container to a new one.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1256

protected persistServices(Symfony\Component\DependencyInjection\ContainerInterface $container, array $persist) Moves persistent service instances into a new container.

/**
 * Moves persistent service instances into a new container.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1270

public rebuildContainer() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1283

public resetContainer(): Symfony\Component\DependencyInjection\ContainerInterface {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1300

public invalidateContainer() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1393

protected attachSynthetic(Symfony\Component\DependencyInjection\ContainerInterface $container): \Symfony\Component\DependencyInjection\ContainerInterface Attach synthetic values on to kernel.

/**
 * Attach synthetic values on to kernel.
 *
 * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
 *   Container object.
 *
 * @return \Symfony\Component\DependencyInjection\ContainerInterface
 *   The container object with the kernel and the class loader added.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1417

protected compileContainer(): \Drupal\Core\DependencyInjection\ContainerBuilder Compiles a new service container.

/**
 * Compiles a new service container.
 *
 * @return \Drupal\Core\DependencyInjection\ContainerBuilder
 *   The compiled service container
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1441

protected initializeServiceProviders() Registers all service providers to the kernel.

/**
 * Registers all service providers to the kernel.
 *
 * @throws \LogicException
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1552

protected getContainerBuilder(): \Drupal\Core\DependencyInjection\ContainerBuilder Gets a new ContainerBuilder instance used to build the service container.

/**
 * Gets a new ContainerBuilder instance used to build the service container.
 *
 * @return \Drupal\Core\DependencyInjection\ContainerBuilder
 *   The Drupal dependency injection container builder.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1576

protected cacheDrupalContainer(array $container_definition): bool Stores the container definition in a cache.

/**
 * Stores the container definition in a cache.
 *
 * @param array $container_definition
 *   The container definition to cache.
 *
 * @return bool
 *   TRUE if the container was successfully cached.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1589

protected getHttpKernel(): \Symfony\Component\HttpKernel\HttpKernelInterface Gets a http kernel from the container.

/**
 * Gets a http kernel from the container.
 *
 * @return \Symfony\Component\HttpKernel\HttpKernelInterface
 *   The Symfony HTTP kernel service.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1610

protected getConfigStorage(): \Drupal\Core\Config\StorageInterface Gets the active configuration storage to use during building the container.

/**
 * Gets the active configuration storage to use during building the container.
 *
 * @return \Drupal\Core\Config\StorageInterface
 *   The configuration storage.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1620

protected getModulesParameter(): array Returns an array of Extension class parameters for all enabled modules.

/**
 * Returns an array of Extension class parameters for all enabled modules.
 *
 * @return array
 *   An associated array of module class parameters, keyed by module name, for
 *   all enabled modules.
 *
 * @deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. Use
 *   getExtensionsParameter() instead.
 *
 * @see https://www.drupal.org/node/3551652
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1646

protected getExtensionsParameter(array $extension_list, callable $get_data): array Returns an array of Extension class parameters for all enabled extensions.

/**
 * Returns an array of Extension class parameters for all enabled extensions.
 *
 * @param array $extension_list
 *   The list of extensions to return filenames for.
 * @param callable $get_data
 *   The method to get data for the extension type.
 *
 * @return array
 *   An associated array of extension class parameters, keyed by extension
 *   name, for all enabled themes.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1663

protected getModuleFileNames(): array Gets the filenames for each enabled module.

/**
 * Gets the filenames for each enabled module.
 *
 * @return array
 *   Array where each key is a module name, and each value is a path to the
 *   respective *.info.yml file.
 *
 * @deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. Use
 *   getExtensionFileNames() instead.
 *
 * @see https://www.drupal.org/node/3551652
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1689

protected getExtensionFileNames(array $extension_list, callable $get_data): array Gets the filenames for each enabled extension.

/**
 * Gets the filenames for each enabled extension.
 *
 * @param array $extension_list
 *   The list of extensions to return filenames for.
 * @param callable $get_data
 *   The method to get data for the extension type.
 *
 * @return array
 *   Array where each key is a theme name, and each value is a path to the
 *   respective *.info.yml file.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1706

protected getModuleNamespacesPsr4($module_file_names): string[] Gets the PSR-4 base directories for module namespaces.

/**
 * Gets the PSR-4 base directories for module namespaces.
 *
 * @param string[] $module_file_names
 *   Array where each key is a module name, and each value is a path to
 *   the respective *.info.yml file.
 *
 * @return string[]
 *   Array where each key is a module namespace like 'Drupal\system', and
 *   each value is the PSR-4 base directory associated with the module
 *   namespace.
 *
 * @deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. Use
 *   getExtensionNamespacesPsr4() instead.
 *
 * @see https://www.drupal.org/node/3551652
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1733

protected getExtensionNamespacesPsr4(array $extension_file_names): array Gets the PSR-4 base directories for extension namespaces.

/**
 * Gets the PSR-4 base directories for extension namespaces.
 *
 * @param string[] $extension_file_names
 *   Array where each key is an extension name, and each value is a path to
 *   the respective *.info.yml file.
 *
 * @return string[]
 *   Array where each key is an extension namespace like 'Drupal\system', and
 *   each value is the PSR-4 base directory associated with the extension
 *   namespace.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1750

protected classLoaderAddMultiplePsr4(array $namespaces = array(), $class_loader = null) Registers a list of namespaces with PSR-4 directories for class loading.

/**
 * Registers a list of namespaces with PSR-4 directories for class loading.
 *
 * @param array $namespaces
 *   Array where each key is a namespace like 'Drupal\system', and each value
 *   is either a PSR-4 base directory, or an array of PSR-4 base directories
 *   associated with this namespace.
 * @param object $class_loader
 *   The class loader. Normally \Composer\Autoload\ClassLoader, as included by
 *   the front controller, but may also be decorated.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1769

protected addServiceFiles(array $service_yamls) Add service files.

/**
 * Add service files.
 *
 * @param string[] $service_yamls
 *   A list of service files.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1891

protected getInstallProfile(): string|false|null Gets the active install profile.

/**
 * Gets the active install profile.
 *
 * @return string|false|null
 *   The name of the active install profile or distribution, FALSE if there is
 *   no install profile or NULL if Drupal is being installed.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1902

protected initializeEphemeralSession(Symfony\Component\HttpFoundation\Request $request): void Initializes a session backed by in-memory store and puts it on the request.

/**
 * Initializes a session backed by in-memory store and puts it on the request.
 *
 * A simple in-memory store is sufficient for command line tools and tests.
 * Web requests will be processed by the session middleware where the mock
 * session is replaced by a session object backed with persistent storage and
 * a real session handler.
 *
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request.
 *
 * @see \Drupal\Core\StackMiddleware\Session::handle()
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1923

protected getExtensions(): array|false Get the core.extension config object.

/**
 * Get the core.extension config object.
 *
 * @return array|false
 *   The core.extension config object if it exists or FALSE.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1935

protected isCli(): bool Returns whether the current PHP process runs on CLI.

/**
 * Returns whether the current PHP process runs on CLI.
 *
 * @return bool
 *   TRUE if the current PHP process is running on CLI, otherwise FALSE.
 */

Defined in <drupal>/core/lib/Drupal/Core/Installer/InstallerRedirectTrait.php:23

protected shouldRedirectToInstaller(Throwable $exception, ?Drupal\Core\Database\Connection $connection = null): bool Determines if an exception handler should redirect to the installer.

/**
 * Determines if an exception handler should redirect to the installer.
 *
 * @param \Throwable $exception
 *   The exception to check.
 * @param \Drupal\Core\Database\Connection|null $connection
 *   (optional) The default database connection. If not provided, a less
 *   comprehensive check will be performed. This can be the case if the
 *   exception occurs early enough that a database connection object isn't
 *   available from the container yet.
 *
 * @return bool
 *   TRUE if the exception handler should redirect to the installer because
 *   Drupal is not installed yet, or FALSE otherwise.
 */

Defined in <drupal>/core/lib/Drupal/Core/Installer/InstallerRedirectTrait.php:42

public static Drupal\Core\DrupalKernel::createFromRequest(Symfony\Component\HttpFoundation\Request $request, $class_loader, $environment, $allow_dumping = true, $app_root = null): static Create a DrupalKernel object from a request.

/**
 * Create a DrupalKernel object from a request.
 *
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request.
 * @param \Composer\Autoload\ClassLoader $class_loader
 *   The class loader. Normally Composer's ClassLoader, as included by the
 *   front controller, but may also be decorated.
 * @param string $environment
 *   String indicating the environment, e.g. 'prod' or 'dev'.
 * @param bool $allow_dumping
 *   (optional) FALSE to stop the container from being written to or read
 *   from disk. Defaults to TRUE.
 * @param string $app_root
 *   (optional) The path to the application root as a string. If not supplied,
 *   the application root will be computed.
 *
 * @return static
 *
 * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
 *   In case the host name in the request is not trusted.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:307

protected static Drupal\Core\DrupalKernel::guessApplicationRoot(): string Determine the application root directory based on this file's location.

/**
 * Determine the application root directory based on this file's location.
 *
 * @return string
 *   The application root.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:345

public static Drupal\Core\DrupalKernel::findSitePath(Symfony\Component\HttpFoundation\Request $request, $require_settings = true, $app_root = null): string Returns the appropriate site directory for a request.

/**
 * Returns the appropriate site directory for a request.
 *
 * Once the kernel has been created DrupalKernelInterface::getSitePath() is
 * preferred since it gets the statically cached result of this method.
 *
 * Site directories contain all site specific code. This includes settings.php
 * for bootstrap level configuration, file configuration stores, public file
 * storage and site specific modules and themes.
 *
 * A file named sites.php must be present in the sites directory for
 * multisite. If it doesn't exist, then 'sites/default' will be used.
 *
 * Finds a matching site directory file by stripping the website's hostname
 * from left to right and pathname from right to left. By default, the
 * directory must contain a 'settings.php' file for it to match. If the
 * parameter $require_settings is set to FALSE, then a directory without a
 * 'settings.php' file will match as well. The first configuration file found
 * will be used and the remaining ones will be ignored. If no configuration
 * file is found, returns a default value 'sites/default'. See
 * default.settings.php for examples on how the URL is converted to a
 * directory.
 *
 * The sites.php file in the sites directory can define aliases in an
 * associative array named $sites. The array is written in the format
 * '<port>.<domain>.<path>' => 'directory'. As an example, to create a
 * directory alias for https://www.drupal.org:8080/my-site/test whose
 * configuration file is in sites/example.com, the array should be defined as:
 * @code
 * $sites = [
 *   '8080.www.drupal.org.my-site.test' => 'example.com',
 * ];
 * @endcode
 *
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The current request.
 * @param bool $require_settings
 *   Only directories with an existing settings.php file will be recognized.
 *   Defaults to TRUE. During initial installation, this is set to FALSE so
 *   that Drupal can detect a matching directory, then create a new
 *   settings.php file in it.
 * @param string $app_root
 *   (optional) The path to the application root as a string. If not supplied,
 *   the application root will be computed.
 *
 * @return string
 *   The path of the matching directory.
 *
 * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
 *   In case the host name in the request is invalid.
 *
 * @see \Drupal\Core\DrupalKernelInterface::getSitePath()
 * @see \Drupal\Core\DrupalKernelInterface::setSitePath()
 * @see default.settings.php
 * @see example.sites.php
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:409

public static Drupal\Core\DrupalKernel::bootEnvironment($app_root = null) Setup a consistent PHP environment.

/**
 * Setup a consistent PHP environment.
 *
 * This method sets PHP environment options we want to be sure are set
 * correctly for security or just saneness.
 *
 * @param string $app_root
 *   (optional) The path to the application root as a string. If not supplied,
 *   the application root will be computed.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1118

protected static Drupal\Core\DrupalKernel::validateHostnameLength($host): bool Validates a hostname length.

/**
 * Validates a hostname length.
 *
 * @param string $host
 *   A hostname.
 *
 * @return bool
 *   TRUE if the length is appropriate, or FALSE otherwise.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1795

public static Drupal\Core\DrupalKernel::validateHostname(Symfony\Component\HttpFoundation\Request $request): bool Validates the hostname supplied from the HTTP request.

/**
 * Validates the hostname supplied from the HTTP request.
 *
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request object.
 *
 * @return bool
 *   TRUE if the hostname is valid, or FALSE otherwise.
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1814

protected static Drupal\Core\DrupalKernel::setupTrustedHosts(Symfony\Component\HttpFoundation\Request $request, $host_patterns): bool Sets up the lists of trusted HTTP Host headers.

/**
 * Sets up the lists of trusted HTTP Host headers.
 *
 * Since the HTTP Host header can be set by the user making the request, it
 * is possible to create an attack vectors against a site by overriding this.
 * Symfony provides a mechanism for creating a list of trusted Host values.
 *
 * Host patterns (as regular expressions) can be configured through
 * settings.php for multisite installations, sites using ServerAlias without
 * canonical redirection, or configurations where the site responds to default
 * requests. For example,
 *
 * @code
 * $settings['trusted_host_patterns'] = [
 *   '^example\.com$',
 *   '^*.example\.com$',
 * ];
 * @endcode
 *
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request object.
 * @param array $host_patterns
 *   The array of trusted host patterns.
 *
 * @return bool
 *   TRUE if the Host header is trusted, FALSE otherwise.
 *
 * @see https://www.drupal.org/docs/installing-drupal/trusted-host-settings
 * @see \Drupal\Core\Http\TrustedHostsRequestFactory
 */

Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1861

protected static Drupal\Core\DrupalKernel::$isEnvironmentInitialized :: boolean true
public const Drupal\Core\DrupalKernelInterface::CONTAINER_INITIALIZE_SUBREQUEST_FINISHED :: string (55) "kernel.container.finish_container_initialize_subrequest"
public const Symfony\Component\HttpKernel\HttpKernelInterface::MAIN_REQUEST :: integer 1
public const Symfony\Component\HttpKernel\HttpKernelInterface::SUB_REQUEST :: integer 2

public __construct($root, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Lock\LockBackendInterface $lock, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\Extension\ThemeHandlerInterface $theme_handler, Drupal\Core\Theme\ThemeInitializationInterface $theme_initialization, Drupal\Core\Cache\CacheBackendInterface $runtime_cache, Drupal\Core\Extension\ModuleExtensionList $module_list, Symfony\Component\HttpKernel\HttpKernelInterface $kernel, $theme_name = null, ?Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory = null) Constructs a \Drupal\Core\Theme\Registry object.

/**
 * Constructs a \Drupal\Core\Theme\Registry object.
 *
 * @param string $root
 *   The app root.
 * @param \Drupal\Core\Cache\CacheBackendInterface $cache
 *   The cache backend interface to use for the complete theme registry data.
 * @param \Drupal\Core\Lock\LockBackendInterface $lock
 *   The lock backend.
 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
 *   The module handler to use to load modules.
 * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
 *   The theme handler.
 * @param \Drupal\Core\Theme\ThemeInitializationInterface $theme_initialization
 *   The theme initialization.
 * @param \Drupal\Core\Cache\CacheBackendInterface $runtime_cache
 *   The cache backend interface to use for the runtime theme registry data.
 * @param \Drupal\Core\Extension\ModuleExtensionList $module_list
 *   The module list.
 * @param \Symfony\Component\HttpKernel\HttpKernelInterface $kernel
 *   The kernel.
 * @param string $theme_name
 *   (optional) The name of the theme for which to construct the registry.
 * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface|null $key_value_factory
 *   The key value factory.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:233

public setThemeManager(Drupal\Core\Theme\ThemeManagerInterface $theme_manager) Sets the theme manager.

/**
 * Sets the theme manager.
 *
 * @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
 *   The theme manager.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:256

protected init($theme_name = null) Initializes a theme with a certain name.

/**
 * Initializes a theme with a certain name.
 *
 * This function does to much magic, so it should be replaced by another
 * services which holds the current active theme information.
 *
 * @param string $theme_name
 *   (optional) The name of the theme for which to construct the registry.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:269

public get(): array Returns the complete theme registry from cache or rebuilds it.

/**
 * Returns the complete theme registry from cache or rebuilds it.
 *
 * @return array
 *   The complete theme registry data array.
 *
 * @see Registry::$registry
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:292

protected cacheGet(): ?array Gets the theme registry cache.

/**
 * Gets the theme registry cache.
 *
 * @return array|null
 *   The complete theme registry data array for the active theme for this
 *   registry.
 *
 * @see Registry::$registry
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:345

public getRuntime(): \Drupal\Core\Utility\ThemeRegistry Returns the incomplete, runtime theme registry.

/**
 * Returns the incomplete, runtime theme registry.
 *
 * @return \Drupal\Core\Utility\ThemeRegistry
 *   A shared instance of the ThemeRegistry class, provides an ArrayObject
 *   that allows it to be accessed with array syntax and isset(), and is more
 *   lightweight than the full registry.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:365

protected setCache() Persists the theme registry in the cache backend.

/**
 * Persists the theme registry in the cache backend.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:376

public getBaseHook($hook): string|false Returns the base hook for a given hook suggestion.

/**
 * Returns the base hook for a given hook suggestion.
 *
 * @param string $hook
 *   The name of a theme hook whose base hook to find.
 *
 * @return string|false
 *   The name of the base hook or FALSE.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:389

protected build(): array Builds the theme registry cache.

/**
 * Builds the theme registry cache.
 *
 * Theme hook definitions are collected in the following order:
 * - Modules
 * - Base theme engines
 * - Base themes
 * - Theme engine
 * - Theme
 *
 * All theme hook definitions are essentially just collated and merged in the
 * above order. However, various extension-specific default values and
 * customizations are required; e.g., to record the effective file path for
 * theme template. Therefore, this method first collects all extensions per
 * type, and then dispatches the processing for each extension to
 * processExtension().
 *
 * After completing the collection, modules are allowed to alter it. Lastly,
 * any derived and incomplete theme hook definitions that are hook suggestions
 * for base hooks (e.g., 'block__node' for the base hook 'block') need to be
 * determined based on the full registry and classified as 'base hook'.
 *
 * See the @link themeable Default theme implementations topic @endlink for
 * details.
 *
 * @return array
 *   The built theme registry.
 *
 * @see hook_theme_registry_alter()
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:438

protected processExtension(array &$cache, $name, $type, $theme, $path) Process a single implementation of hook_theme().

/**
 * Process a single implementation of hook_theme().
 *
 * @param array $cache
 *   The theme registry that will eventually be cached; It is an associative
 *   array keyed by theme hooks, whose values are associative arrays
 *   describing the hook:
 *   - 'type': The passed-in $type.
 *   - 'theme path': The passed-in $path.
 *   - 'template': The filename of the template generating output for this
 *     theme hook. The template is in the directory defined by the 'path' key
 *     of hook_theme() or defaults to "$path/templates".
 *   - 'variables': The variables for this theme hook as defined in
 *     hook_theme(). If there is more than one implementation and 'variables'
 *     is not specified in a later one, then the previous definition is kept.
 *   - 'render element': The renderable element for this theme hook as defined
 *     in hook_theme(). If there is more than one implementation and
 *     'render element' is not specified in a later one, then the previous
 *     definition is kept.
 *   - See the @link themeable Theme system overview topic @endlink for
 *     detailed documentation.
 * @param string $name
 *   The name of the module, theme engine, base theme engine, theme or base
 *   theme implementing hook_theme().
 * @param string $type
 *   One of 'module', 'theme_engine', 'base_theme_engine', 'theme',
 *   'base_theme', or 'install'. Unlike regular hooks that can only be
 *   implemented by modules, each of these can implement hook_theme(). This
 *   function is called in aforementioned order and new entries override
 *   older ones. For example, if a theme hook is both defined by a module and
 *   a theme, then the definition in the theme will be used.
 * @param string $theme
 *   The actual name of theme, module, etc. that is being processed.
 * @param string $path
 *   The directory where $name is. For example, modules/system or
 *   themes/olivero.
 *
 * @see \Drupal\Core\Theme\ThemeManagerInterface::render()
 * @see hook_theme()
 * @see \Drupal\Core\Extension\ThemeHandler::listInfo()
 * @see twig_render_template()
 *
 * @throws \BadFunctionCallException
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:550

protected completeSuggestion($hook, array &$cache) Completes the definition of the requested suggestion hook.

/**
 * Completes the definition of the requested suggestion hook.
 *
 * @param string $hook
 *   The name of the suggestion hook to complete.
 * @param array $cache
 *   The theme registry, as documented in
 *   \Drupal\Core\Theme\Registry::processExtension().
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:751

protected mergePreprocessFunctions($destination_hook_name, $source_hook_name, $parent_hook, array &$cache) Merges the source hook's preprocess functions into the destination hook's.

/**
 * Merges the source hook's preprocess functions into the destination hook's.
 *
 * @param string $destination_hook_name
 *   The name of the hook to merge preprocess functions to.
 * @param string $source_hook_name
 *   The name of the hook to merge preprocess functions from.
 * @param array $parent_hook
 *   The parent hook if it exists. Either an incomplete hook from suggestions
 *   or a base hook.
 * @param array $cache
 *   The theme registry, as documented in
 *   \Drupal\Core\Theme\Registry::processExtension().
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:791

protected postProcessExtension(array &$cache, Drupal\Core\Theme\ActiveTheme $theme) Completes the theme registry adding discovered functions and hooks.

/**
 * Completes the theme registry adding discovered functions and hooks.
 *
 * @param array $cache
 *   The theme registry as documented in
 *   \Drupal\Core\Theme\Registry::processExtension().
 * @param \Drupal\Core\Theme\ActiveTheme $theme
 *   Current active theme.
 *
 * @see ::processExtension()
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:819

public reset() Invalidates theme registry caches.

/**
 * Invalidates theme registry caches.
 *
 * To be called when the list of enabled extensions is changed.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:925

public destruct() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:955

public getPrefixGroupedUserFunctions($prefixes = array()): array Gets all user functions grouped by the word before the first underscore.

/**
 * Gets all user functions grouped by the word before the first underscore.
 *
 * @param string[] $prefixes
 *   An array of function prefixes by which the list can be limited.
 *
 * @return array
 *   Functions grouped by the first prefix.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:970

protected collectModulePreprocess(array &$cache, string $hook): array Collect module implementations of a single hook.

/**
 * Collect module implementations of a single hook.
 *
 * @param array $cache
 *   The preprocess hook.
 * @param string $hook
 *   The theme registry, as documented in
 *   \Drupal\Core\Theme\Registry::processExtension().
 *
 * @return array
 *   A list of preprocess functions.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:1005

protected hasThemeHookImplementation(string $theme, string $hook): bool Returns whether a theme implements a given hook.

/**
 * Returns whether a theme implements a given hook.
 *
 * @param string $theme
 *   Name of the theme.
 * @param string $hook
 *   Name of the hook.
 *
 * @return bool
 *   True if the theme implements the given hook.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:1031

protected getPreprocessForSuggestions(): array Returns discovered preprocess suggestions.

/**
 * Returns discovered preprocess suggestions.
 *
 * @return array<string, string>
 *   Preprocess suggestions discovered in themes and modules.
 */

Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:1044

private const Drupal\Core\Theme\Registry::PREPROCESS_INVOKES :: string (18) "preprocess invokes"
private const Drupal\Core\Theme\Registry::GLOBAL_PREPROCESS :: string (17) "global preprocess"

protected singleFieldDisplays -> null

public buildComponents(array &$build, array $entities, array $displays, $view_mode) {@inheritdoc} $0['#pre_render'][0][0]->buildComponents()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/NodeViewBuilder.php:23

protected getBuildDefaults(Drupal\Core\Entity\EntityInterface $entity, $view_mode) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/NodeViewBuilder.php:65

public __construct(Drupal\Core\Entity\EntityTypeInterface $entity_type, Drupal\Core\Entity\EntityRepositoryInterface $entity_repository, Drupal\Core\Language\LanguageManagerInterface $language_manager, Drupal\Core\Theme\Registry $theme_registry, Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository) Constructs a new EntityViewBuilder. new \Drupal\node\NodeViewBuilder()

/**
 * Constructs a new EntityViewBuilder.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type definition.
 * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
 *   The entity repository service.
 * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
 *   The language manager.
 * @param \Drupal\Core\Theme\Registry $theme_registry
 *   The theme registry.
 * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
 *   The entity display repository.
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:97

public view(Drupal\Core\Entity\EntityInterface $entity, $view_mode = 'full', $langcode = null) {@inheritdoc} $0['#pre_render'][0][0]->view()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:122

public viewMultiple(array $entities = array(), $view_mode = 'full', $langcode = null) {@inheritdoc} $0['#pre_render'][0][0]->viewMultiple()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:145

public build(array $build): array Builds an entity's view; augments entity defaults. $0['#pre_render'][0][0]->build()

/**
 * Builds an entity's view; augments entity defaults.
 *
 * This function is assigned as a #pre_render callback in ::view().
 *
 * It transforms the renderable array for a single entity to the same
 * structure as if we were rendering multiple entities, and then calls the
 * default ::buildMultiple() #pre_render callback.
 *
 * @param array $build
 *   A renderable array containing build information and context for an entity
 *   view.
 *
 * @return array
 *   The updated renderable array.
 *
 * @see \Drupal\Core\Render\RendererInterface::render()
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:238

public buildMultiple(array $build_list): array Builds multiple entities' views; augments entity defaults. $0['#pre_render'][0][0]->buildMultiple()

/**
 * Builds multiple entities' views; augments entity defaults.
 *
 * This function is assigned as a #pre_render callback in ::viewMultiple().
 *
 * By delaying the building of an entity until the #pre_render processing in
 * \Drupal::service('renderer')->render(), the processing cost of assembling
 * an entity's renderable array is saved on cache-hit requests.
 *
 * @param array $build_list
 *   A renderable  array containing build information and context for an
 *   entity view.
 *
 * @return array
 *   The updated renderable array.
 *
 * @see \Drupal\Core\Render\RendererInterface::render()
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:262

protected addContextualLinks(array &$build, Drupal\Core\Entity\EntityInterface $entity) Add contextual links.

/**
 * Add contextual links.
 *
 * @param array $build
 *   The render array that is being created.
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be prepared.
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:356

protected alterBuild(array &$build, Drupal\Core\Entity\EntityInterface $entity, Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode) Specific per-entity building.

/**
 * Specific per-entity building.
 *
 * @param array $build
 *   The render array that is being created.
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be prepared.
 * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display
 *   The entity view display holding the display options configured for the
 *   entity components.
 * @param string $view_mode
 *   The view mode that should be used to prepare the entity.
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:391

public getCacheTags() {@inheritdoc} $0['#pre_render'][0][0]->getCacheTags()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:396

public resetCache(?array $entities = null) {@inheritdoc} $0['#pre_render'][0][0]->resetCache()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:403

protected isViewModeCacheable($view_mode): bool Determines whether the view mode is cacheable.

/**
 * Determines whether the view mode is cacheable.
 *
 * @param string $view_mode
 *   Name of the view mode that should be rendered.
 *
 * @return bool
 *   TRUE if the view mode can be cached, FALSE otherwise.
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:436

public viewField(Drupal\Core\Field\FieldItemListInterface $items, $display_options = array()) {@inheritdoc} $0['#pre_render'][0][0]->viewField()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:448

public viewFieldItem(Drupal\Core\Field\FieldItemInterface $item, $display = array()) {@inheritdoc} $0['#pre_render'][0][0]->viewFieldItem()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:473

protected getSingleFieldDisplay($entity, $field_name, $display_options): \Drupal\Core\Entity\Display\EntityViewDisplayInterface Gets an EntityViewDisplay for rendering an individual field.

/**
 * Gets an EntityViewDisplay for rendering an individual field.
 *
 * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
 *   The entity.
 * @param string $field_name
 *   The field name.
 * @param string|array $display_options
 *   The display options passed to the viewField() method.
 *
 * @return \Drupal\Core\Entity\Display\EntityViewDisplayInterface
 *   The EntityViewDisplay objects created for individual field rendering.
 */

Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:507

protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Gets the module handler.

/**
 * Gets the module handler.
 *
 * @return \Drupal\Core\Extension\ModuleHandlerInterface
 *   The module handler.
 */

Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityHandlerBase.php:31

public setModuleHandler(Drupal\Core\Extension\ModuleHandlerInterface $module_handler): $this Sets the module handler for this handler. $0['#pre_render'][0][0]->setModuleHandler()

/**
 * Sets the module handler for this handler.
 *
 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
 *   The module handler.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityHandlerBase.php:46

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
 */

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.
 */

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.
 */

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.
 */

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['#pre_render'][0][0]->setStringTranslation()

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

public static Drupal\node\NodeViewBuilder::renderLinks($node_entity_id, $view_mode, $langcode, $is_in_preview, $revision_id = null): array Render API callback: Builds a node's links.

/**
 * Render API callback: Builds a node's links.
 *
 * This function is assigned as a #lazy_builder callback.
 *
 * @param string $node_entity_id
 *   The node entity ID.
 * @param string $view_mode
 *   The view mode in which the node entity is being viewed.
 * @param string $langcode
 *   The language in which the node entity is being viewed.
 * @param bool $is_in_preview
 *   Whether the node is currently being previewed.
 * @param int|string $revision_id
 *   (optional) The identifier of the node revision to be loaded. If none
 *   is provided, the default revision will be loaded.
 *
 * @return array
 *   A renderable array representing the node links.
 */

Defined in <drupal>/core/modules/node/src/NodeViewBuilder.php:96

protected static Drupal\node\NodeViewBuilder::buildLinks(Drupal\node\NodeInterface $entity, $view_mode): array Build the default links (Read more) for a node.

/**
 * Build the default links (Read more) for a node.
 *
 * @param \Drupal\node\NodeInterface $entity
 *   The node object.
 * @param string $view_mode
 *   A view mode identifier.
 *
 * @return array
 *   An array that can be processed by Link::preRenderLinks().
 *
 * @see \Drupal\Core\Render\Element\Link::preRenderLinks()
 */

Defined in <drupal>/core/modules/node/src/NodeViewBuilder.php:133

public static Drupal\node\NodeViewBuilder::trustedCallbacks() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/node/src/NodeViewBuilder.php:163

public static Drupal\Core\Entity\EntityViewBuilder::createInstance(Symfony\Component\DependencyInjection\ContainerInterface $container, Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:109

public static Drupal\Core\Entity\EntityViewBuilder::trustedCallbacks() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:138

public const Drupal\Core\Security\TrustedCallbackInterface::THROW_EXCEPTION :: string (9) "exception"
public const Drupal\Core\Security\TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION :: string (20) "silenced_deprecation"

1 => string (5) "build" $0['#pre_render'][0][1]

Secondary tabs

Warning message