⧉value => string (333) "<p>God calls us to be His hands and feet, and we believe that using our skil...
<p>God calls us to be His hands and feet, and we believe that using our skills to serve the Kingdom of God is a blessing and a privilege. Whether you are passionate about helping children in need, using your professional skills to serve in crises, or looking for an exciting new employment opportunity, we have something for you.</p>
⧉public __construct($layout_id, array $layout_settings = array(), array $components = array(), array $third_party_settings = array()) Constructs a new Section.
/**
* Constructs a new Section.
*
* @param string $layout_id
* The layout plugin ID.
* @param array $layout_settings
* (optional) The layout plugin settings.
* @param \Drupal\layout_builder\SectionComponent[] $components
* (optional) The components.
* @param array[] $third_party_settings
* (optional) Any third party settings.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:65
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this section.
/**
* Returns the renderable array for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the section is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the section.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:85
⧉public getLayout(array $contexts = array()): \Drupal\Core\Layout\LayoutInterface Gets the layout plugin for this section.
/**
* Gets the layout plugin for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
*
* @return \Drupal\Core\Layout\LayoutInterface
* The layout plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:115
⧉public getLayoutId(): string Gets the layout plugin ID for this section.
/**
* Gets the layout plugin ID for this section.
*
* @return string
* The layout plugin ID.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:132
⧉public getLayoutSettings(): mixed[] Gets the layout plugin settings for this section.
/**
* Gets the layout plugin settings for this section.
*
* @return mixed[]
* The layout plugin settings.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:145
⧉public setLayoutSettings(array $layout_settings): $this Sets the layout plugin settings for this section.
/**
* Sets the layout plugin settings for this section.
*
* @param mixed[] $layout_settings
* The layout plugin settings.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:157
⧉public getDefaultRegion(): string Gets the default region.
/**
* Gets the default region.
*
* @return string
* The machine-readable name of the default region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:168
⧉public getComponents(): \Drupal\layout_builder\SectionComponent[] Returns the components of the section.
/**
* Returns the components of the section.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components, keyed by the component UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:178
⧉public getComponent($uuid): \Drupal\layout_builder\SectionComponent Gets the component for a given UUID.
/**
* Gets the component for a given UUID.
*
* @param string $uuid
* The UUID of the component to retrieve.
*
* @return \Drupal\layout_builder\SectionComponent
* The component.
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:194
⧉public removeComponent($uuid): $this Removes a given component from a region.
/**
* Removes a given component from a region.
*
* @param string $uuid
* The UUID of the component to remove.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:223
⧉public appendComponent(Drupal\layout_builder\SectionComponent $component): $this Appends a component to the end of a region.
/**
* Appends a component to the end of a region.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component being appended.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:236
⧉public getComponentsByRegion($region): \Drupal\layout_builder\SectionComponent[] Gets the components for a specific region.
/**
* Gets the components for a specific region.
*
* @param string $region
* The region name.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components in the specified region, sorted by weight.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:268
⧉public insertAfterComponent($preceding_uuid, Drupal\layout_builder\SectionComponent $component): $this Inserts a component after a specified existing component.
/**
* Inserts a component after a specified existing component.
*
* @param string $preceding_uuid
* The UUID of the existing component to insert after.
* @param \Drupal\layout_builder\SectionComponent $component
* The component being inserted.
*
* @return $this
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:291
⧉public insertComponent($delta, Drupal\layout_builder\SectionComponent $new_component): $this Inserts a component at a specified delta.
/**
* Inserts a component at a specified delta.
*
* @param int $delta
* The zero-based delta in which to insert the component.
* @param \Drupal\layout_builder\SectionComponent $new_component
* The component being inserted.
*
* @return $this
*
* @throws \OutOfBoundsException
* Thrown when the specified delta is invalid.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:314
⧉public toArray(): array Returns an array representation of the section.
/**
* Returns an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:355
⧉public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:396
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:440
⧉protected setComponent(Drupal\layout_builder\SectionComponent $component): $this Helper method to set a component.
/**
* Helper method to set a component.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:210
⧉protected getNextHighestWeight($region): int Returns the next highest weight of the component in a region.
/**
* Returns the next highest weight of the component in a region.
*
* @param string $region
* The region name.
*
* @return int
* A number higher than the highest weight of the component in the region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:251
⧉protected layoutPluginManager(): \Drupal\Core\Layout\LayoutPluginManagerInterface Wraps the layout plugin manager.
/**
* Wraps the layout plugin manager.
*
* @return \Drupal\Core\Layout\LayoutPluginManagerInterface
* The layout plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:343
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:450
⇄⧉public static fromArray(array $section): static Creates an object from an array representation of the section.
/**
* Creates an object from an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $section
* An array of section data in the format returned by ::toArray().
*
* @return static
* The section object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:377
⧉public __construct($layout_id, array $layout_settings = array(), array $components = array(), array $third_party_settings = array()) Constructs a new Section.
/**
* Constructs a new Section.
*
* @param string $layout_id
* The layout plugin ID.
* @param array $layout_settings
* (optional) The layout plugin settings.
* @param \Drupal\layout_builder\SectionComponent[] $components
* (optional) The components.
* @param array[] $third_party_settings
* (optional) Any third party settings.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:65
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this section.
/**
* Returns the renderable array for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the section is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the section.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:85
⧉public getLayout(array $contexts = array()): \Drupal\Core\Layout\LayoutInterface Gets the layout plugin for this section.
/**
* Gets the layout plugin for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
*
* @return \Drupal\Core\Layout\LayoutInterface
* The layout plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:115
⧉public getLayoutId(): string Gets the layout plugin ID for this section.
/**
* Gets the layout plugin ID for this section.
*
* @return string
* The layout plugin ID.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:132
⧉public getLayoutSettings(): mixed[] Gets the layout plugin settings for this section.
/**
* Gets the layout plugin settings for this section.
*
* @return mixed[]
* The layout plugin settings.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:145
⧉public setLayoutSettings(array $layout_settings): $this Sets the layout plugin settings for this section.
/**
* Sets the layout plugin settings for this section.
*
* @param mixed[] $layout_settings
* The layout plugin settings.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:157
⧉public getDefaultRegion(): string Gets the default region.
/**
* Gets the default region.
*
* @return string
* The machine-readable name of the default region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:168
⧉public getComponents(): \Drupal\layout_builder\SectionComponent[] Returns the components of the section.
/**
* Returns the components of the section.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components, keyed by the component UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:178
⧉public getComponent($uuid): \Drupal\layout_builder\SectionComponent Gets the component for a given UUID.
/**
* Gets the component for a given UUID.
*
* @param string $uuid
* The UUID of the component to retrieve.
*
* @return \Drupal\layout_builder\SectionComponent
* The component.
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:194
⧉public removeComponent($uuid): $this Removes a given component from a region.
/**
* Removes a given component from a region.
*
* @param string $uuid
* The UUID of the component to remove.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:223
⧉public appendComponent(Drupal\layout_builder\SectionComponent $component): $this Appends a component to the end of a region.
/**
* Appends a component to the end of a region.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component being appended.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:236
⧉public getComponentsByRegion($region): \Drupal\layout_builder\SectionComponent[] Gets the components for a specific region.
/**
* Gets the components for a specific region.
*
* @param string $region
* The region name.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components in the specified region, sorted by weight.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:268
⧉public insertAfterComponent($preceding_uuid, Drupal\layout_builder\SectionComponent $component): $this Inserts a component after a specified existing component.
/**
* Inserts a component after a specified existing component.
*
* @param string $preceding_uuid
* The UUID of the existing component to insert after.
* @param \Drupal\layout_builder\SectionComponent $component
* The component being inserted.
*
* @return $this
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:291
⧉public insertComponent($delta, Drupal\layout_builder\SectionComponent $new_component): $this Inserts a component at a specified delta.
/**
* Inserts a component at a specified delta.
*
* @param int $delta
* The zero-based delta in which to insert the component.
* @param \Drupal\layout_builder\SectionComponent $new_component
* The component being inserted.
*
* @return $this
*
* @throws \OutOfBoundsException
* Thrown when the specified delta is invalid.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:314
⧉public toArray(): array Returns an array representation of the section.
/**
* Returns an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:355
⧉public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:396
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:440
⧉protected setComponent(Drupal\layout_builder\SectionComponent $component): $this Helper method to set a component.
/**
* Helper method to set a component.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:210
⧉protected getNextHighestWeight($region): int Returns the next highest weight of the component in a region.
/**
* Returns the next highest weight of the component in a region.
*
* @param string $region
* The region name.
*
* @return int
* A number higher than the highest weight of the component in the region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:251
⧉protected layoutPluginManager(): \Drupal\Core\Layout\LayoutPluginManagerInterface Wraps the layout plugin manager.
/**
* Wraps the layout plugin manager.
*
* @return \Drupal\Core\Layout\LayoutPluginManagerInterface
* The layout plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:343
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:450
⇄⧉public static fromArray(array $section): static Creates an object from an array representation of the section.
/**
* Creates an object from an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $section
* An array of section data in the format returned by ::toArray().
*
* @return static
* The section object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:377
protected fields -> array (0)
protected fieldDefinitions -> null
⧉protected languages -> array (3)
⧉en => Drupal\Core\Language\Language (5)
Properties (5)
Available methods (9)
Static class properties (16)
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 <ROOT>/core/lib/Drupal/Core/Language/Language.php:77
⧉public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:101
⧉public getId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:108
⧉public getDirection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:115
⧉public getWeight() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:122
⧉public isDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:129
⧉public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:136
⇄⧉public static sort(&$languages) Sort language objects.
\Drupal\Core\Language\Language::sort(&$languages)
/**
* Sort language objects.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* The array of language objects keyed by langcode.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:146
⧉protected static getDefaultLangcode(): string Gets the default langcode.
/**
* Gets the default langcode.
*
* @return string
* The current default langcode.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:173
⧉protected name -> Drupal\Core\StringTranslation\TranslatableMarkup (5)
Properties (5)
Available methods (14)
protected string -> string (13) "Not specified"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
⧉public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
⧉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", array('@name' => $account->getDisplayName()));
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (optional) An associative array of replacements to make after
* translation. Based on the first character of the key, the value is
* escaped and/or themed. See
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
* details.
* @param array $options
* (optional) An associative array of additional options, with the following
* elements:
* - 'langcode' (defaults to the current language): A language code, to
* translate to a language other than what is used to display the page.
* - 'context' (defaults to the empty context): The context the source
* string belongs to.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
⧉public 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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
⧉public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
⧉public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
⧉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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
⧉protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
⧉protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
⧉protected static placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
⧉protected static 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.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:266
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 <ROOT>/core/lib/Drupal/Core/Language/Language.php:77
⧉public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:101
⧉public getId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:108
⧉public getDirection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:115
⧉public getWeight() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:122
⧉public isDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:129
⧉public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:136
⇄⧉public static sort(&$languages) Sort language objects.
\Drupal\Core\Language\Language::sort(&$languages)
/**
* Sort language objects.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* The array of language objects keyed by langcode.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:146
⧉protected static getDefaultLangcode(): string Gets the default langcode.
/**
* Gets the default langcode.
*
* @return string
* The current default langcode.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:173
⧉protected name -> Drupal\Core\StringTranslation\TranslatableMarkup (5)
Properties (5)
Available methods (14)
protected string -> string (14) "Not applicable"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
⧉public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
⧉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", array('@name' => $account->getDisplayName()));
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (optional) An associative array of replacements to make after
* translation. Based on the first character of the key, the value is
* escaped and/or themed. See
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
* details.
* @param array $options
* (optional) An associative array of additional options, with the following
* elements:
* - 'langcode' (defaults to the current language): A language code, to
* translate to a language other than what is used to display the page.
* - 'context' (defaults to the empty context): The context the source
* string belongs to.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
⧉public 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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
⧉public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
⧉public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
⧉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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
⧉protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
⧉protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
⧉protected static placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
⧉protected static 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.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:266
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 <ROOT>/core/lib/Drupal/Core/Language/Language.php:77
⧉public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:101
⧉public getId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:108
⧉public getDirection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:115
⧉public getWeight() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:122
⧉public isDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:129
⧉public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:136
⇄⧉public static sort(&$languages) Sort language objects.
\Drupal\Core\Language\Language::sort(&$languages)
/**
* Sort language objects.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* The array of language objects keyed by langcode.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:146
⧉protected static getDefaultLangcode(): string Gets the default langcode.
/**
* Gets the default langcode.
*
* @return string
* The current default langcode.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:173
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/node/src/Entity/Node.php:253
⇄⧉public getChangedTimeAcrossTranslations(): int 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
* The timestamp of the last entity save operation across all
* translations.
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/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 <ROOT>/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($timestamp)
/**
* 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 <ROOT>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:46
⇄⧉public isPublished() {@inheritdoc}
$0['#node']->isPublished()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:47
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:54
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:64
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:69
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:76
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:84
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:91
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:99
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:106
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:114
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:121
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
⇄⧉public isSyncing() {@inheritdoc}
$0['#node']->isSyncing()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1007
⇄⧉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 <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1024
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1044
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1071
⧉public __isset($name) Implements the magic method for isset().
/**
* Implements the magic method for isset().
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1105
⧉public __unset($name) Implements the magic method for unset().
/**
* Implements the magic method for unset().
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1114
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1145
⇄⧉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 <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1174
⇄⧉public label() {@inheritdoc}
$0['#node']->label()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1260
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
⇄⧉public traitSleep() {@inheritdoc}
$0['#node']->traitSleep()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
⧉public __wakeup() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
⇄⧉public isNew() {@inheritdoc}
$0['#node']->isNew()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:120
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:647
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityChangesDetectionTrait.php:21
⧉protected getLanguages() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:268
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:507
⧉protected getTranslatedField($name, $langcode): \Drupal\Core\Field\FieldItemListInterface Gets a translated field.
/**
* Gets a translated field.
*
* @return \Drupal\Core\Field\FieldItemListInterface
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:574
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:734
⧉protected updateFieldLangcodes($langcode) Updates language for already instantiated fields.
/**
* Updates language for already instantiated fields.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:767
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:897
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1296
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1398
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/**
* Gets the entity type manager.
*
* @return \Drupal\Core\Entity\EntityTypeManagerInterface
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
⧉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
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/**
* Gets the language manager.
*
* @return \Drupal\Core\Language\LanguageManagerInterface
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/**
* Gets the UUID generator.
*
* @return \Drupal\Component\Uuid\UuidInterface
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:233
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:263
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:446
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:517
⇄⧉public static 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 <ROOT>/core/modules/user/src/EntityOwnerTrait.php:28
⇄⧉public static getDefaultEntityOwner(): mixed Default value callback for 'owner' base field.
\Drupal\node\Entity\Node::getDefaultEntityOwner()
/**
* Default value callback for 'owner' base field.
*
* @return mixed
* A default value for the owner field.
*/
Defined in <ROOT>/core/modules/user/src/EntityOwnerTrait.php:86
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/node/src/Entity/Node.php:261
⇄⧉public static 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.
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:27
⇄⧉public static 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()
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:28
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:494
⧉protected static 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.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:542
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:266
⧉public driver()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:272
⧉public version() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:279
⧉public isMariaDb(): bool Determines whether the MySQL distribution is MariaDB or not.
/**
* Determines whether the MySQL distribution is MariaDB or not.
*
* @return bool
* Returns TRUE if the distribution is MariaDB, or FALSE if not.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:293
⧉public databaseType()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:326
/**
* Overrides \Drupal\Core\Database\Connection::createDatabase().
*
* @param string $database
* The name of the database to create.
*
* @throws \Drupal\Core\Database\DatabaseNotFoundException
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:338
⧉public mapConditionOperator($operator)
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:352
⧉public nextId($existing_id0)
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:357
⧉public nextIdDelete()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:377
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:449
⧉public getConnectionOptions(): array Returns the connection information for this connection object.
/**
* Returns the connection information for this connection object.
*
* Note that Database::getConnectionInfo() is for requesting information
* about an arbitrary database connection that is defined. This method
* is for requesting the connection information of this specific
* open connection object.
*
* @return array
* An array of the connection information. The exact list of
* properties is driver-dependent.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:352
⧉public attachDatabase(string $database): void Allows the connection to access additional databases.
/**
* Allows the connection to access additional databases.
*
* Database systems usually group tables in 'databases' or 'schemas', that
* can be accessed with syntax like 'SELECT * FROM database.table'. Normally
* Drupal accesses tables in a single database/schema, but in some cases it
* may be necessary to access tables from other databases/schemas in the same
* database server. This method can be called to ensure that the additional
* database/schema is accessible.
*
* For MySQL, PostgreSQL and most other databases no action need to be taken
* to query data in another database or schema. For SQLite this is however
* necessary and the database driver for SQLite will override this method.
*
* @param string $database
* The database to be attached to the connection.
*
* @internal
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:375
⧉public getPrefix(): string Returns the prefix of the tables.
/**
* Returns the prefix of the tables.
*
* @return string $prefix
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:383
⧉public prefixTables($sql): string Appends a database prefix to all tables in a query.
/**
* Appends a database prefix to all tables in a query.
*
* Queries sent to Drupal should wrap all table names in curly brackets. This
* function searches for this syntax and adds Drupal's table prefix to all
* tables, allowing Drupal to coexist with other systems in the same database
* and/or schema if necessary.
*
* @param string $sql
* A string containing a partial or entire SQL query.
*
* @return string
* The properly-prefixed string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:416
⧉public quoteIdentifiers($sql): string Quotes all identifiers in a query.
/**
* Quotes all identifiers in a query.
*
* Queries sent to Drupal should wrap all unquoted identifiers in square
* brackets. This function searches for this syntax and replaces them with the
* database specific identifier. In ANSI SQL this a double quote.
*
* Note that :variable[] is used to denote array arguments but
* Connection::expandArguments() is always called first.
*
* @param string $sql
* A string containing a partial or entire SQL query.
*
* @return string
* The string containing a partial or entire SQL query with all identifiers
* quoted.
*
* @internal
* This method should only be called by database API code.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:440
⧉public tablePrefix($table = 'default') Find the prefix for a table.
/**
* Find the prefix for a table.
*
* This function is for when you want to know the prefix of a table. This
* is not used in prefixTables due to performance reasons.
*
* @param string $table
* (optional) The table to find the prefix for.
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0.
* Instead, you should just use Connection::getPrefix().
*
* @see https://www.drupal.org/node/3260849
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:458
⧉public getUnprefixedTablesMap(): array Gets a list of individually prefixed table names.
/**
* Gets a list of individually prefixed table names.
*
* @return array
* An array of un-prefixed table names, keyed by their fully qualified table
* names (i.e. prefix + table_name).
*
* @deprecated in drupal:10.0.0 and is removed from drupal:11.0.0. There is
* no replacement.
*
* @see https://www.drupal.org/node/3257198
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:475
⧉public getFullQualifiedTableName($table): string Get a fully qualified table name.
/**
* Get a fully qualified table name.
*
* @param string $table
* The name of the table in question.
*
* @return string
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:488
⧉public prepareStatement(string $query, array $options, bool $allow_row_count = false): Drupal\Core\Database\StatementInterface Returns a prepared statement given a SQL string.
/**
* Returns a prepared statement given a SQL string.
*
* This method caches prepared statements, reusing them when possible. It also
* prefixes tables names enclosed in curly braces and, optionally, quotes
* identifiers enclosed in square brackets.
*
* @param string $query
* The query string as SQL, with curly braces surrounding the table names,
* and square brackets surrounding identifiers.
* @param array $options
* An associative array of options to control how the query is run. See
* the documentation for self::defaultOptions() for details. The content of
* the 'pdo' key will be passed to the prepared statement.
* @param bool $allow_row_count
* (optional) A flag indicating if row count is allowed on the statement
* object. Defaults to FALSE.
*
* @return \Drupal\Core\Database\StatementInterface
* A prepared statement ready for its execute() method.
*
* @throws \InvalidArgumentException
* If multiple statements are included in the string, and delimiters are
* not allowed in the query.
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:520
⧉public setTarget($target = null) Tells this connection object what its target value is.
/**
* Tells this connection object what its target value is.
*
* This is needed for logging and auditing. It's sloppy to do in the
* constructor because the constructor for child classes has a different
* signature. We therefore also ensure that this function is only ever
* called once.
*
* @param string $target
* (optional) The target this connection is for.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:593
⧉public getTarget(): string|null Returns the target this connection is associated with.
/**
* Returns the target this connection is associated with.
*
* @return string|null
* The target string of this connection, or NULL if no target is set.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:605
⧉public setKey($key) Tells this connection object what its key is.
/**
* Tells this connection object what its key is.
*
* @param string $key
* The key this connection is for.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:615
⧉public getKey(): string|null Returns the key this connection is associated with.
/**
* Returns the key this connection is associated with.
*
* @return string|null
* The key of this connection, or NULL if no key is set.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:627
⧉public setLogger(Drupal\Core\Database\Log $logger) Associates a logging object with this connection.
/**
* Associates a logging object with this connection.
*
* @param \Drupal\Core\Database\Log $logger
* The logging object we want to use.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:637
⧉public getLogger(): \Drupal\Core\Database\Log|null Gets the current logging object for this connection.
/**
* Gets the current logging object for this connection.
*
* @return \Drupal\Core\Database\Log|null
* The current logging object for this connection. If there isn't one,
* NULL is returned.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:648
⧉public makeSequenceName($table, $field): string Creates the appropriate sequence name for a given table and serial field.
/**
* Creates the appropriate sequence name for a given table and serial field.
*
* This information is exposed to all database drivers, although it is only
* useful on some of them. This method is table prefix-aware.
*
* Note that if a sequence was generated automatically by the database, its
* name might not match the one returned by this function. Therefore, in those
* cases, it is generally advised to use a database-specific way of retrieving
* the name of an auto-created sequence. For example, PostgreSQL provides a
* dedicated function for this purpose: pg_get_serial_sequence().
*
* @param string $table
* The table name to use for the sequence.
* @param string $field
* The field name to use for the sequence.
*
* @return string
* A table prefix-parsed string for the sequence name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:672
⧉public makeComment($comments): string Flatten an array of query comments into a single comment string.
/**
* Flatten an array of query comments into a single comment string.
*
* The comment string will be sanitized to avoid SQL injection attacks.
*
* @param string[] $comments
* An array of query comment strings.
*
* @return string
* A sanitized comment string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:690
⧉public query($query, array $args = array(), $options = array()): \Drupal\Core\Database\StatementInterface|int|string|null Executes a query string against the database.
/**
* Executes a query string against the database.
*
* This method provides a central handler for the actual execution of every
* query. All queries executed by Drupal are executed as prepared statements.
*
* @param string $query
* The query to execute. This is a string containing an SQL query with
* placeholders.
* @param array $args
* The associative array of arguments for the prepared statement.
* @param array $options
* An associative array of options to control how the query is run. The
* given options will be merged with self::defaultOptions(). See the
* documentation for self::defaultOptions() for details.
* Typically, $options['return'] will be set by a default or by a query
* builder, and should not be set by a user.
*
* @return \Drupal\Core\Database\StatementInterface|int|string|null
* This method will return one of the following:
* - If either $options['return'] === self::RETURN_STATEMENT, or
* $options['return'] is not set (due to self::defaultOptions()),
* returns the executed statement.
* - If $options['return'] === self::RETURN_AFFECTED,
* returns the number of rows matched by the query
* (not the number affected).
* - If $options['return'] === self::RETURN_INSERT_ID,
* returns the generated insert ID of the last query as a string.
* - If $options['return'] === self::RETURN_NULL, returns NULL.
*
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
* @throws \Drupal\Core\Database\IntegrityConstraintViolationException
* @throws \InvalidArgumentException
*
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:774
⧉public getDriverClass($class): string Gets the driver-specific override class if any for the specified class.
/**
* Gets the driver-specific override class if any for the specified class.
*
* @param string $class
* The class for which we want the potentially driver-specific class.
*
* @return string
* The name of the class that should be used for this driver.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:901
⧉public exceptionHandler(): \Drupal\Core\Database\ExceptionHandler Returns the database exceptions handler.
/**
* Returns the database exceptions handler.
*
* @return \Drupal\Core\Database\ExceptionHandler
* The database exceptions handler.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:967
⧉public select($table, $alias = null, array $options = array()): \Drupal\Core\Database\Query\SelectInterface Prepares and returns a SELECT query object.
/**
* Prepares and returns a SELECT query object.
*
* @param string|\Drupal\Core\Database\Query\SelectInterface $table
* The base table name or subquery for this query, used in the FROM clause.
* If a string, the table specified will also be used as the "base" table
* for query_alter hook implementations.
* @param string $alias
* (optional) The alias of the base table of this query.
* @param $options
* An array of options on the query.
*
* @return \Drupal\Core\Database\Query\SelectInterface
* An appropriate SelectQuery object for this database connection. Note that
* it may be a driver-specific subclass of SelectQuery, depending on the
* driver.
*
* @see \Drupal\Core\Database\Query\Select
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:991
⧉public insert($table, array $options = array()): \Drupal\Core\Database\Query\Insert Prepares and returns an INSERT query object.
/**
* Prepares and returns an INSERT query object.
*
* @param string $table
* The table to use for the insert statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Insert
* A new Insert query object.
*
* @see \Drupal\Core\Database\Query\Insert
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1013
⧉public lastInsertId(?string $name = null): string Returns the ID of the last inserted row or sequence value.
/**
* Returns the ID of the last inserted row or sequence value.
*
* This method should normally be used only within database driver code.
*
* This is a proxy to invoke lastInsertId() from the wrapped connection.
* If a sequence name is not specified for the name parameter, this returns a
* string representing the row ID of the last row that was inserted into the
* database.
* If a sequence name is specified for the name parameter, this returns a
* string representing the last value retrieved from the specified sequence
* object.
*
* @param string|null $name
* (Optional) Name of the sequence object from which the ID should be
* returned.
*
* @return string
* The value returned by the wrapped connection.
*
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
* In case of failure.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1041
⧉public merge($table, array $options = array()): \Drupal\Core\Database\Query\Merge Prepares and returns a MERGE query object.
/**
* Prepares and returns a MERGE query object.
*
* @param string $table
* The table to use for the merge statement.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Merge
* A new Merge query object.
*
* @see \Drupal\Core\Database\Query\Merge
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1061
⧉public upsert($table, array $options = array()): \Drupal\Core\Database\Query\Upsert Prepares and returns an UPSERT query object.
/**
* Prepares and returns an UPSERT query object.
*
* @param string $table
* The table to use for the upsert query.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Upsert
* A new Upsert query object.
*
* @see \Drupal\Core\Database\Query\Upsert
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1079
⧉public update($table, array $options = array()): \Drupal\Core\Database\Query\Update Prepares and returns an UPDATE query object.
/**
* Prepares and returns an UPDATE query object.
*
* @param string $table
* The table to use for the update statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Update
* A new Update query object.
*
* @see \Drupal\Core\Database\Query\Update
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1100
⧉public delete($table, array $options = array()): \Drupal\Core\Database\Query\Delete Prepares and returns a DELETE query object.
/**
* Prepares and returns a DELETE query object.
*
* @param string $table
* The table to use for the delete statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Delete
* A new Delete query object.
*
* @see \Drupal\Core\Database\Query\Delete
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1121
⧉public truncate($table, array $options = array()): \Drupal\Core\Database\Query\Truncate Prepares and returns a TRUNCATE query object.
/**
* Prepares and returns a TRUNCATE query object.
*
* @param string $table
* The table to use for the truncate statement.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Truncate
* A new Truncate query object.
*
* @see \Drupal\Core\Database\Query\Truncate
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1139
⧉public schema(): \Drupal\Core\Database\Schema Returns a DatabaseSchema object for manipulating the schema.
/**
* Returns a DatabaseSchema object for manipulating the schema.
*
* This method will lazy-load the appropriate schema library file.
*
* @return \Drupal\Core\Database\Schema
* The database Schema object for this connection.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1152
⧉public condition($conjunction): \Drupal\Core\Database\Query\Condition Prepares and returns a CONDITION query object.
/**
* Prepares and returns a CONDITION query object.
*
* @param string $conjunction
* The operator to use to combine conditions: 'AND' or 'OR'.
*
* @return \Drupal\Core\Database\Query\Condition
* A new Condition query object.
*
* @see \Drupal\Core\Database\Query\Condition
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1171
⧉public escapeDatabase($database): string Escapes a database name string.
/**
* Escapes a database name string.
*
* Force all database names to be strictly alphanumeric-plus-underscore.
* For some database drivers, it may also wrap the database name in
* database-specific escape characters.
*
* @param string $database
* An unsanitized database name.
*
* @return string
* The sanitized database name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1192
⧉public escapeTable($table): string Escapes a table name string.
/**
* Escapes a table name string.
*
* Force all table names to be strictly alphanumeric-plus-underscore.
* Database drivers should never wrap the table name in database-specific
* escape characters. This is done in Connection::prefixTables(). The
* database-specific escape characters are added in Connection::setPrefix().
*
* @param string $table
* An unsanitized table name.
*
* @return string
* The sanitized table name.
*
* @see \Drupal\Core\Database\Connection::prefixTables()
* @see \Drupal\Core\Database\Connection::setPrefix()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1215
⧉public escapeField($field): string Escapes a field name string.
/**
* Escapes a field name string.
*
* Force all field names to be strictly alphanumeric-plus-underscore.
* For some database drivers, it may also wrap the field name in
* database-specific escape characters.
*
* @param string $field
* An unsanitized field name.
*
* @return string
* The sanitized field name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1235
⧉public escapeAlias($field): string Escapes an alias name string.
/**
* Escapes an alias name string.
*
* Force all alias names to be strictly alphanumeric-plus-underscore. In
* contrast to DatabaseConnection::escapeField() /
* DatabaseConnection::escapeTable(), this doesn't allow the period (".")
* because that is not allowed in aliases.
*
* @param string $field
* An unsanitized alias name.
*
* @return string
* The sanitized alias name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1260
⧉public escapeLike($string): string Escapes characters that work as wildcard characters in a LIKE pattern.
/**
* Escapes characters that work as wildcard characters in a LIKE pattern.
*
* The wildcard characters "%" and "_" as well as backslash are prefixed with
* a backslash. Use this to do a search for a verbatim string without any
* wildcard behavior.
*
* For example, the following does a case-insensitive query for all rows whose
* name starts with $prefix:
* @code
* $result = $injected_connection->query(
* 'SELECT * FROM person WHERE name LIKE :pattern',
* array(':pattern' => $injected_connection->escapeLike($prefix) . '%')
* );
* @endcode
*
* Backslash is defined as escape character for LIKE patterns in
* Drupal\Core\Database\Query\Condition::mapConditionOperator().
*
* @param string $string
* The string to escape.
*
* @return string
* The escaped string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1293
⧉public inTransaction(): bool Determines if there is an active transaction open.
/**
* Determines if there is an active transaction open.
*
* @return bool
* TRUE if we're currently in a transaction, FALSE otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1303
⧉public transactionDepth(): int Determines the current transaction depth.
/**
* Determines the current transaction depth.
*
* @return int
* The current transaction depth.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1313
⧉public startTransaction($name = ''): \Drupal\Core\Database\Transaction Returns a new DatabaseTransaction object on this connection.
/**
* Returns a new DatabaseTransaction object on this connection.
*
* @param string $name
* (optional) The name of the savepoint.
*
* @return \Drupal\Core\Database\Transaction
* A Transaction object.
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1328
⧉public pushTransaction($name) Increases the depth of transaction nesting.
/**
* Increases the depth of transaction nesting.
*
* If no transaction is already active, we begin a new transaction.
*
* @param string $name
* The name of the transaction.
*
* @throws \Drupal\Core\Database\TransactionNameNonUniqueException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1406
⧉public popTransaction($name) Decreases the depth of transaction nesting.
/**
* Decreases the depth of transaction nesting.
*
* If we pop off the last transaction layer, then we either commit or roll
* back the transaction as necessary. If no transaction is active, we return
* because the transaction may have manually been rolled back.
*
* @param string $name
* The name of the savepoint.
*
* @throws \Drupal\Core\Database\TransactionNoActiveException
* @throws \Drupal\Core\Database\TransactionCommitFailedException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1436
⧉public addRootTransactionEndCallback(callable $callback) Adds a root transaction end callback.
/**
* Adds a root transaction end callback.
*
* These callbacks are invoked immediately after the transaction has been
* committed.
*
* It can for example be used to avoid deadlocks on write-heavy tables that
* do not need to be part of the transaction, like cache tag invalidations.
*
* Another use case is that services using alternative backends like Redis and
* Memcache cache implementations can replicate the transaction-behavior of
* the database cache backend and avoid race conditions.
*
* An argument is passed to the callbacks that indicates whether the
* transaction was successful or not.
*
* @param callable $callback
* The callback to invoke.
*
* @see \Drupal\Core\Database\Connection::doCommit()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1471
⧉public clientVersion(): string Returns the version of the database client.
/**
* Returns the version of the database client.
*
* Assumes the client connection is \PDO. Non-PDO based drivers need to
* override this method.
*
* @return string
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1581
⧉public supportsTransactionalDDL(): bool Determines if this driver supports transactional DDL.
/**
* Determines if this driver supports transactional DDL.
*
* DDL queries are those that change the schema, such as ALTER queries.
*
* @return bool
* TRUE if this connection supports transactions for DDL queries, FALSE
* otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1594
⧉public commit() Throws an exception to deny direct access to transaction commits.
/**
* Throws an exception to deny direct access to transaction commits.
*
* We do not want to allow users to commit transactions at any time, only
* by destroying the transaction object or allowing it to go out of scope.
* A direct commit bypasses all of the safety checks we've built on top of
* the database client's transaction routines.
*
* @throws \Drupal\Core\Database\TransactionExplicitCommitNotAllowedException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1646
⧉public quote($string, $parameter_type = 2): string|bool Quotes a string for use in a query.
/**
* Quotes a string for use in a query.
*
* @param string $string
* The string to be quoted.
* @param int $parameter_type
* (optional) Provides a data type hint for drivers that have alternate
* quoting styles. Defaults to \PDO::PARAM_STR.
*
* @return string|bool
* A quoted string that is theoretically safe to pass into an SQL statement.
* Returns FALSE if the driver does not support quoting in this way.
*
* @see \PDO::quote()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1684
⧉public __sleep() Prevents the database connection from being serialized.
/**
* Prevents the database connection from being serialized.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1711
⧉public getProvider(): string Get the module name of the module that is providing the database driver.
/**
* Get the module name of the module that is providing the database driver.
*
* @return string
* The module name of the module that is providing the database driver, or
* "core" when the driver is not provided as part of a module.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1841
⧉public getPagerManager(): Drupal\Core\Pager\PagerManagerInterface Get the pager manager service, if available.
/**
* Get the pager manager service, if available.
*
* @return \Drupal\Core\Pager\PagerManagerInterface
* The pager manager service, if available.
*
* @throws \Drupal\Core\DependencyInjection\ContainerNotInitializedException
* If the container has not been initialized yet.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1861
⧉public hasJson(): bool Runs a simple query to validate json datatype support.
/**
* Runs a simple query to validate json datatype support.
*
* @return bool
* Returns the query result.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1871
⧉public isEventEnabled(string $eventName): bool Returns the status of a database API event toggle.
/**
* Returns the status of a database API event toggle.
*
* @param string $eventName
* The name of the event to check.
*
* @return bool
* TRUE if the event is going to be fired by the database API, FALSE
* otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1890
⧉public enableEvents(array $eventNames): static Enables database API events dispatching.
/**
* Enables database API events dispatching.
*
* @param string[] $eventNames
* A list of database events to be enabled.
*
* @return static
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1902
⧉public disableEvents(array $eventNames): static Disables database API events dispatching.
/**
* Disables database API events dispatching.
*
* @param string[] $eventNames
* A list of database events to be disabled.
*
* @return static
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1918
⧉public dispatchEvent(Drupal\Core\Database\Event\DatabaseEvent $event, ?string $eventName = null): Drupal\Core\Database\Event\DatabaseEvent Dispatches a database API event via the container dispatcher.
/**
* Dispatches a database API event via the container dispatcher.
*
* @param \Drupal\Core\Database\Event\DatabaseEvent $event
* The database event.
* @param string|null $eventName
* (Optional) the name of the event to dispatch.
*
* @return \Drupal\Core\Database\Event\DatabaseEvent
* The database event.
*
* @throws \Drupal\Core\Database\Exception\EventException
* If the container is not initialized.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1940
⧉public findCallerFromDebugBacktrace(): array Determine the last non-database method that called the database API.
/**
* Determine the last non-database method that called the database API.
*
* Traversing the call stack from the very first call made during the
* request, we define "the routine that called this query" as the last entry
* in the call stack that is not any method called from the namespace of the
* database driver, is not inside the Drupal\Core\Database namespace and does
* have a file (which excludes call_user_func_array(), anonymous functions
* and similar). That makes the climbing logic very simple, and handles the
* variable stack depth caused by the query builders.
*
* See the @link http://php.net/debug_backtrace debug_backtrace() @endlink
* function.
*
* @return array
* This method returns a stack trace entry similar to that generated by
* debug_backtrace(). However, it flattens the trace entry and the trace
* entry before it so that we get the function and args of the function that
* called into the database system, not the function and args of the
* database call itself.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1968
⧉protected getMariaDbVersionMatch(): ?string Gets the MariaDB portion of the server version.
/**
* Gets the MariaDB portion of the server version.
*
* @return string
* The MariaDB portion of the server version if present, or NULL if not.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:303
⧉protected getServerVersion(): string Gets the server version.
/**
* Gets the server version.
*
* @return string
* The PDO server version.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:319
⧉protected popCommittableTransactions() Overridden to work around issues to MySQL not supporting transactional DDL.
/**
* Overridden to work around issues to MySQL not supporting transactional DDL.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:404
⧉protected doCommit() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:479
⧉protected defaultOptions(): array Returns the default query options for any given query.
/**
* Returns the default query options for any given query.
*
* A given query can be customized with a number of option flags in an
* associative array:
* - fetch: This element controls how rows from a result set will be
* returned. Legal values include \PDO::FETCH_ASSOC, \PDO::FETCH_BOTH,
* \PDO::FETCH_OBJ, \PDO::FETCH_NUM, or a string representing the name of a
* class. If a string is specified, each record will be fetched into a new
* object of that class. The behavior of all other values is defined by PDO.
* See http://php.net/manual/pdostatement.fetch.php
* - return: (deprecated) Depending on the type of query, different return
* values may be meaningful. This directive instructs the system which type
* of return value is desired. The system will generally set the correct
* value automatically, so it is extremely rare that a module developer will
* ever need to specify this value. Setting it incorrectly will likely lead
* to unpredictable results or fatal errors. Legal values include:
* - Database::RETURN_STATEMENT: Return the prepared statement object for
* the query. This is usually only meaningful for SELECT queries, where
* the statement object is how one accesses the result set returned by the
* query.
* - Database::RETURN_AFFECTED: Return the number of rows found (matched) by
* the WHERE clause of an UPDATE or DELETE query (not the number of rows
* actually changed). Note that although named RETURN_AFFECTED for
* historical reasons, the number of rows matched is returned for
* consistency across database engines.
* - Database::RETURN_INSERT_ID: Return the sequence ID (primary key)
* created by an INSERT statement on a table that contains a serial
* column.
* - Database::RETURN_NULL: Do not return anything, as there is no
* meaningful value to return. That is the case for INSERT queries on
* tables that do not contain a serial column.
* - allow_delimiter_in_query: By default, queries which have the ; delimiter
* any place in them will cause an exception. This reduces the chance of SQL
* injection attacks that terminate the original query and add one or more
* additional queries (such as inserting new user accounts). In rare cases,
* such as creating an SQL function, a ; is needed and can be allowed by
* changing this option to TRUE.
* - allow_square_brackets: By default, queries which contain square brackets
* will have them replaced with the identifier quote character for the
* database type. In rare cases, such as creating an SQL function, []
* characters might be needed and can be allowed by changing this option to
* TRUE.
* - pdo: By default, queries will execute with the client connection options
* set on the connection. In particular cases, it could be necessary to
* override the driver options on the statement level. In such case, pass
* the required setting as an array here, and they will be passed to the
* prepared statement.
*
* @return array
* An array of default query options.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:331
⧉protected setPrefix($prefix) Set the prefix used by this database connection.
/**
* Set the prefix used by this database connection.
*
* @param string $prefix
* A single prefix.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:393
⧉protected preprocessStatement(string $query, array $options): string Returns a string SQL statement ready for preparation.
/**
* Returns a string SQL statement ready for preparation.
*
* This method replaces table names in curly braces and identifiers in square
* brackets with platform specific replacements, appropriately escaping them
* and wrapping them with platform quote characters.
*
* @param string $query
* The query string as SQL, with curly braces surrounding the table names,
* and square brackets surrounding identifiers.
* @param array $options
* An associative array of options to control how the query is run. See
* the documentation for self::defaultOptions() for details.
*
* @return string
* A string SQL statement ready for preparation.
*
* @throws \InvalidArgumentException
* If multiple statements are included in the string, and delimiters are
* not allowed in the query.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:557
⧉protected filterComment($comment = ''): string Sanitize a query comment string.
/**
* Sanitize a query comment string.
*
* Ensure a query comment does not include strings such as "* /" that might
* terminate the comment early. This avoids SQL injection attacks via the
* query comment. The comment strings in this example are separated by a
* space to avoid PHP parse errors.
*
* For example, the comment:
* @code
* \Drupal::database()->update('example')
* ->condition('id', $id)
* ->fields(array('field2' => 10))
* ->comment('Exploit * / DROP TABLE node; --')
* ->execute()
* @endcode
*
* Would result in the following SQL statement being generated:
* @code
* "/ * Exploit * / DROP TABLE node. -- * / UPDATE example SET field2=..."
* @endcode
*
* Unless the comment is sanitized first, the SQL server would drop the
* node table and ignore the rest of the SQL statement.
*
* @param string $comment
* A query comment string.
*
* @return string
* A sanitized version of the query comment string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:733
⧉protected expandArguments(&$query, &$args): bool Expands out shorthand placeholders.
/**
* Expands out shorthand placeholders.
*
* Drupal supports an alternate syntax for doing arrays of values. We
* therefore need to expand them out into a full, executable query string.
*
* @param string $query
* The query string to modify.
* @param array $args
* The arguments for the query.
*
* @return bool
* TRUE if the query was modified, FALSE otherwise.
*
* @throws \InvalidArgumentException
* This exception is thrown when:
* - A placeholder that ends in [] is supplied, and the supplied value is
* not an array.
* - A placeholder that does not end in [] is supplied, and the supplied
* value is an array.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:847
⧉protected getDebugBacktrace(): array Gets the debug backtrace.
/**
* Gets the debug backtrace.
*
* Wraps the debug_backtrace function to allow mocking results in PHPUnit
* tests.
*
* @return array[]
* The debug backtrace.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:2024
/**
* Creates an array of database connection options from a URL.
*
* @param string $url
* The URL.
* @param string $root
* The root directory of the Drupal installation. Some database drivers,
* like for example SQLite, need this information.
*
* @return array
* The connection options.
*
* @throws \InvalidArgumentException
* Exception thrown when the provided URL does not meet the minimum
* requirements.
*
* @internal
* This method should only be called from
* \Drupal\Core\Database\Database::convertDbUrlToConnectionInfo().
*
* @see \Drupal\Core\Database\Database::convertDbUrlToConnectionInfo()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1737
⇄⧉public static createUrlFromConnectionOptions(array $connection_options): string Creates a URL from an array of database connection options.
/**
* Creates a URL from an array of database connection options.
*
* @param array $connection_options
* The array of connection options for a database connection. An additional
* key of 'module' is added by Database::getConnectionInfoAsUrl() for
* drivers provided my contributed or custom modules for convenience.
*
* @return string
* The connection info as a URL.
*
* @throws \InvalidArgumentException
* Exception thrown when the provided array of connection options does not
* meet the minimum requirements.
*
* @internal
* This method should only be called from
* \Drupal\Core\Database\Database::getConnectionInfoAsUrl().
*
* @see \Drupal\Core\Database\Database::getConnectionInfoAsUrl()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1798
⇄⧉public static removeDatabaseEntriesFromDebugBacktrace(array $backtrace, string $driver_namespace): array Removes database related calls from a backtrace array.
/**
* Removes database related calls from a backtrace array.
*
* @param array $backtrace
* A standard PHP backtrace. Passed by reference.
* @param string $driver_namespace
* The PHP namespace of the database driver.
*
* @return array
* The cleaned backtrace array.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1999
⧉protected static getSQLState(Exception $e): string Extracts the SQLSTATE error from a PDOException.
/**
* Extracts the SQLSTATE error from a PDOException.
*
* @param \Exception $e
* The exception
*
* @return string
* The five character error code.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1697
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:28
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:43
/**
* Implements \Drupal\Core\Cache\CacheTagsInvalidatorInterface::invalidateTags()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:53
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::getCurrentChecksum()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:83
⧉public schemaDefinition() Defines the schema for the {cachetags} table.
/**
* Defines the schema for the {cachetags} table.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:97
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::isValid()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:105
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:58
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:75
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:128
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
⧉public __construct($root, array $module_list, Drupal\Core\Cache\CacheBackendInterface $cache_backend) Constructs a ModuleHandler object.
/**
* Constructs a ModuleHandler object.
*
* @param string $root
* The app root.
* @param array $module_list
* An associative array whose keys are the names of installed modules and
* whose values are Extension class parameters. This is normally the
* %container.modules% parameter being set up by DrupalKernel.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend for storing module hook implementation information.
*
* @see \Drupal\Core\DrupalKernel
* @see \Drupal\Core\CoreServiceProvider
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:110
⧉public load($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:122
⧉public loadAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:138
⧉public reload() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:150
⧉public isLoaded() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:158
⧉public getModuleList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:165
⧉public getModule($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:172
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:708
⧉public getName($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:719
⧉protected add($type, $name, $path) Adds a module or profile to the list of currently active modules.
/**
* Adds a module or profile to the list of currently active modules.
*
* @param string $type
* The extension type; either 'module' or 'profile'.
* @param string $name
* The module name; e.g., 'node'.
* @param string $path
* The module path; e.g., 'core/modules/node'.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:213
/**
* Builds hook_hook_info() information.
*
* @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:308
⧉protected getImplementationInfo($hook): mixed[] Provides information about modules' implementations of a hook.
/**
* Provides information about modules' implementations of a hook.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:583
⧉protected buildImplementationInfo($hook): mixed[] Builds hook implementation information for a given hook name.
/**
* Builds hook implementation information for a given hook name.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*
* @throws \RuntimeException
* Exception thrown when an invalid implementation is added by
* hook_module_implements_alter().
*
* @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:629
⧉protected verifyImplementations(&$implementations, $hook): bool Verifies an array of implementations loaded from cache.
/**
* Verifies an array of implementations loaded from cache.
*
* Verification is done by including the lazy-loaded $module.$group.inc file,
* and checking function_exists().
*
* @param string[] $implementations
* Implementation "group" by module name.
* @param string $hook
* The hook name.
*
* @return bool
* TRUE, if all implementations exist.
* FALSE, if one or more implementations don't exist and need to be removed
* from the cache.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:680
⧉private triggerDeprecationError($description, $hook) Triggers an E_USER_DEPRECATED error if any module implements the hook.
/**
* Triggers an E_USER_DEPRECATED error if any module implements the hook.
*
* @param string $description
* Helpful text describing what to do instead of implementing this hook.
* @param string $hook
* The name of the hook.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:446
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:52
⧉public addTranslator(Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator, $priority0): $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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:66
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:147
⧉public setDefaultLangcode($langcode) Sets the default langcode.
/**
* Sets the default langcode.
*
* @param string $langcode
* A language code.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:157
⧉public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:164
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:129
⧉public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
⧉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", array('@name' => $account->getDisplayName()));
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (optional) An associative array of replacements to make after
* translation. Based on the first character of the key, the value is
* escaped and/or themed. See
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
* details.
* @param array $options
* (optional) An associative array of additional options, with the following
* elements:
* - 'langcode' (defaults to the current language): A language code, to
* translate to a language other than what is used to display the page.
* - 'context' (defaults to the empty context): The context the source
* string belongs to.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
⧉public 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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
⧉public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
⧉public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
⧉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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
⧉protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
⧉protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
⧉protected static placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
⧉protected static 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.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:266
⧉public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
⧉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", array('@name' => $account->getDisplayName()));
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (optional) An associative array of replacements to make after
* translation. Based on the first character of the key, the value is
* escaped and/or themed. See
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
* details.
* @param array $options
* (optional) An associative array of additional options, with the following
* elements:
* - 'langcode' (defaults to the current language): A language code, to
* translate to a language other than what is used to display the page.
* - 'context' (defaults to the empty context): The context the source
* string belongs to.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
⧉public 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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
⧉public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
⧉public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
⧉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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
⧉protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
⧉protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
⧉protected static placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
⧉protected static 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.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:266
⧉public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
⧉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", array('@name' => $account->getDisplayName()));
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (optional) An associative array of replacements to make after
* translation. Based on the first character of the key, the value is
* escaped and/or themed. See
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
* details.
* @param array $options
* (optional) An associative array of additional options, with the following
* elements:
* - 'langcode' (defaults to the current language): A language code, to
* translate to a language other than what is used to display the page.
* - 'context' (defaults to the empty context): The context the source
* string belongs to.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
⧉public 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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
⧉public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
⧉public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
⧉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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
⧉protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
⧉protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
⧉protected static placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
⧉protected static 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.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:266
⧉public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
⧉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", array('@name' => $account->getDisplayName()));
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (optional) An associative array of replacements to make after
* translation. Based on the first character of the key, the value is
* escaped and/or themed. See
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
* details.
* @param array $options
* (optional) An associative array of additional options, with the following
* elements:
* - 'langcode' (defaults to the current language): A language code, to
* translate to a language other than what is used to display the page.
* - 'context' (defaults to the empty context): The context the source
* string belongs to.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
⧉public 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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
⧉public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
⧉public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
⧉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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
⧉protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
⧉protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
⧉protected static placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
⧉protected static 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.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:266
⧉public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
⧉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", array('@name' => $account->getDisplayName()));
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (optional) An associative array of replacements to make after
* translation. Based on the first character of the key, the value is
* escaped and/or themed. See
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
* details.
* @param array $options
* (optional) An associative array of additional options, with the following
* elements:
* - 'langcode' (defaults to the current language): A language code, to
* translate to a language other than what is used to display the page.
* - 'context' (defaults to the empty context): The context the source
* string belongs to.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
⧉public 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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
⧉public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
⧉public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
⧉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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
⧉protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
⧉protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
⧉protected static placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
⧉protected static 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.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:266
⧉public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
⧉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", array('@name' => $account->getDisplayName()));
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (optional) An associative array of replacements to make after
* translation. Based on the first character of the key, the value is
* escaped and/or themed. See
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
* details.
* @param array $options
* (optional) An associative array of additional options, with the following
* elements:
* - 'langcode' (defaults to the current language): A language code, to
* translate to a language other than what is used to display the page.
* - 'context' (defaults to the empty context): The context the source
* string belongs to.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
⧉public 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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
⧉public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
⧉public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
⧉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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
⧉protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
⧉protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
⧉protected static placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
⧉protected static 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.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:266
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityType.php:82
⧉public __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
⧉public __wakeup() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:118
⧉public get($property) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityType.php:341
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityType.php:872
⧉public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\Definition\PluginDefinition
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Definition/PluginDefinition.php:35
⧉public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\Definition\PluginDefinition
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Definition/PluginDefinition.php:50
⧉public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\Definition\PluginDefinition
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Definition/PluginDefinition.php:57
/**
* {@inheritdoc}
*
* @throws \InvalidArgumentException
* If the provided class does not implement
* \Drupal\Core\Entity\ContentEntityStorageInterface.
*
* @see \Drupal\Core\Entity\ContentEntityStorageInterface
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityType.php:49
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
⧉protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:79
⧉protected getNumberOfPlurals($langcode = null) 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()
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:88
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:102
/**
* Constructs an AnnotatedClassDiscovery object.
*
* @param string $subdir
* Either the plugin's subdirectory, for example 'Plugin/views/filter', or
* empty string if plugins are located at the top level of the namespace.
* @param \Traversable $root_namespaces
* An object that implements \Traversable which contains the root paths
* keyed by the corresponding namespace to look for plugin implementations.
* If $subdir is not an empty string, it will be appended to each namespace.
* @param string $plugin_definition_annotation_name
* (optional) The name of the annotation that contains the plugin definition.
* Defaults to 'Drupal\Component\Annotation\Plugin'.
* @param string[] $annotation_namespaces
* (optional) Additional namespaces to scan for annotation definitions.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php:56
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:20
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:59
⧉public getDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery
Defined in <ROOT>/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php:107
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php:88
⧉protected getProviderFromNamespace($namespace): string|null Extracts the provider name from a Drupal namespace.
/**
* Extracts the provider name from a Drupal namespace.
*
* @param string $namespace
* The namespace to extract the provider from.
*
* @return string|null
* The matching provider name, or NULL otherwise.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php:105
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php:118
⧉protected doGetDefinition(array $definitions, $plugin_id, $exception_on_invalid): array|null Gets a specific plugin definition.
/**
* Gets a specific plugin definition.
*
* @param array $definitions
* An array of the available plugin definitions.
* @param string $plugin_id
* A plugin id.
* @param bool $exception_on_invalid
* If TRUE, an invalid plugin ID will cause an exception to be thrown; if
* FALSE, NULL will be returned.
*
* @return array|null
* A plugin definition, or NULL if the plugin ID is invalid and
* $exception_on_invalid is TRUE.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
* Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.
*/
Inherited from Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:43
⧉public __construct($root, array $module_list, Drupal\Core\Cache\CacheBackendInterface $cache_backend) Constructs a ModuleHandler object.
/**
* Constructs a ModuleHandler object.
*
* @param string $root
* The app root.
* @param array $module_list
* An associative array whose keys are the names of installed modules and
* whose values are Extension class parameters. This is normally the
* %container.modules% parameter being set up by DrupalKernel.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend for storing module hook implementation information.
*
* @see \Drupal\Core\DrupalKernel
* @see \Drupal\Core\CoreServiceProvider
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:110
⧉public load($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:122
⧉public loadAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:138
⧉public reload() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:150
⧉public isLoaded() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:158
⧉public getModuleList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:165
⧉public getModule($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:172
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:708
⧉public getName($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:719
⧉protected add($type, $name, $path) Adds a module or profile to the list of currently active modules.
/**
* Adds a module or profile to the list of currently active modules.
*
* @param string $type
* The extension type; either 'module' or 'profile'.
* @param string $name
* The module name; e.g., 'node'.
* @param string $path
* The module path; e.g., 'core/modules/node'.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:213
/**
* Builds hook_hook_info() information.
*
* @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:308
⧉protected getImplementationInfo($hook): mixed[] Provides information about modules' implementations of a hook.
/**
* Provides information about modules' implementations of a hook.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:583
⧉protected buildImplementationInfo($hook): mixed[] Builds hook implementation information for a given hook name.
/**
* Builds hook implementation information for a given hook name.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*
* @throws \RuntimeException
* Exception thrown when an invalid implementation is added by
* hook_module_implements_alter().
*
* @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:629
⧉protected verifyImplementations(&$implementations, $hook): bool Verifies an array of implementations loaded from cache.
/**
* Verifies an array of implementations loaded from cache.
*
* Verification is done by including the lazy-loaded $module.$group.inc file,
* and checking function_exists().
*
* @param string[] $implementations
* Implementation "group" by module name.
* @param string $hook
* The hook name.
*
* @return bool
* TRUE, if all implementations exist.
* FALSE, if one or more implementations don't exist and need to be removed
* from the cache.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:680
⧉private triggerDeprecationError($description, $hook) Triggers an E_USER_DEPRECATED error if any module implements the hook.
/**
* Triggers an E_USER_DEPRECATED error if any module implements the hook.
*
* @param string $description
* Helpful text describing what to do instead of implementing this hook.
* @param string $hook
* The name of the hook.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:446
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:52
⧉public addTranslator(Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator, $priority0): $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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:66
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:147
⧉public setDefaultLangcode($langcode) Sets the default langcode.
/**
* Sets the default langcode.
*
* @param string $langcode
* A language code.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:157
⧉public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:164
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:129
⧉public __construct(Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory, Drupal\Core\Cache\CacheBackendInterface $cache) Constructs a new EntityLastInstalledSchemaRepository.
/**
* Constructs a new EntityLastInstalledSchemaRepository.
*
* @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
* The key-value factory.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache backend.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityLastInstalledSchemaRepository.php:44
/**
* @return void
*/
Defined in .../symfony/dependency-injection/ContainerAwareTrait.php:29
⧉public __construct(Traversable $namespaces, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\StringTranslation\TranslationInterface $string_translation, Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver, Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface $entity_last_installed_schema_repository) Constructs a new Entity plugin manager.
/**
* Constructs a new Entity plugin manager.
*
* @param \Traversable $namespaces
* An object that implements \Traversable which contains the root paths
* keyed by the corresponding namespace to look for plugin implementations,
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache backend to use.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* The string translation.
* @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
* The class resolver.
* @param \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface $entity_last_installed_schema_repository
* The entity last installed schema repository.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityTypeManager.php:85
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityTypeManager.php:131
⧉public getActiveDefinition($entity_type_id): \Drupal\Core\Entity\EntityTypeInterface Gets the active definition for a content entity type.
/**
* Gets the active definition for a content entity type.
*
* @param string $entity_type_id
* The entity type ID.
*
* @return \Drupal\Core\Entity\EntityTypeInterface
* The active entity type definition.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityTypeManager.php:153
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:59
/**
* Initialize the cache backend.
*
* Plugin definitions are cached using the provided cache backend.
*
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend instance to use.
* @param string $cache_key
* Cache key prefix to use.
* @param array $cache_tags
* (optional) When providing a list of cache tags, the cached plugin
* definitions are tagged with the provided cache tags. These cache tags can
* then be used to clear the corresponding cached plugin definitions. Note
* that this should be used with care! For clearing all cached plugin
* definitions of a plugin manager, call that plugin manager's
* clearCachedDefinitions() method. Only use cache tags when cached plugin
* definitions should be cleared along with other, related cache entries.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:157
⧉public getDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:178
⧉public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:357
⧉public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:364
⧉public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:371
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\PluginManagerBase
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/PluginManagerBase.php:71
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\PluginManagerBase
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/PluginManagerBase.php:134
⧉protected findDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityTypeManager.php:115
⧉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()
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php:35
⧉protected doGetDefinition(array $definitions, $plugin_id, $exception_on_invalid): array|null Gets a specific plugin definition.
/**
* Gets a specific plugin definition.
*
* @param array $definitions
* An array of the available plugin definitions.
* @param string $plugin_id
* A plugin id.
* @param bool $exception_on_invalid
* If TRUE, an invalid plugin ID will cause an exception to be thrown; if
* FALSE, NULL will be returned.
*
* @return array|null
* A plugin definition, or NULL if the plugin ID is invalid and
* $exception_on_invalid is TRUE.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
* Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:43
⧉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 array('node' => array(123), 'user' => array(92)).
*
* @see \Drupal\Core\Cache\CacheBackendInterface::set()
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php:69
⧉protected alterInfo($alter_hook) Sets the alter hook name.
/**
* Sets the alter hook name.
*
* @param string $alter_hook
* Name of the alter hook; for example, to invoke
* hook_mymodule_data_alter() pass in "mymodule_data".
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:171
⧉protected getCachedDefinitions(): array|null Returns the cached plugin definitions of the decorated discovery class.
/**
* Returns the cached plugin definitions of the decorated discovery class.
*
* @return array|null
* On success this will return an array of plugin definitions. On failure
* this should return NULL, indicating to other methods that this has not
* yet been defined. Success with no values should return as an empty array
* and would actually be returned by the getDefinitions() method.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:212
⧉protected setCachedDefinitions($definitions) Sets a cache of plugin definitions for the decorated discovery class.
/**
* Sets a cache of plugin definitions for the decorated discovery class.
*
* @param array $definitions
* List of definitions to store in cache.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:225
⧉protected getDiscovery() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:266
⧉protected getFactory() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:277
⧉protected extractProviderFromDefinition($plugin_definition): string|null Extracts the provider from a plugin definition.
/**
* Extracts the provider from a plugin definition.
*
* @param mixed $plugin_definition
* The plugin definition. Usually either an array or an instance of
* \Drupal\Component\Plugin\Definition\PluginDefinitionInterface
*
* @return string|null
* The provider string, if it exists. NULL otherwise.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:317
⧉protected alterDefinitions(&$definitions) Invokes the hook to alter the definitions if the alter hook is set.
/**
* Invokes the hook to alter the definitions if the alter hook is set.
*
* @param $definitions
* The discovered plugin definitions.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:338
⧉protected providerExists($provider): bool Determines if the provider of a definition exists.
/**
* Determines if the provider of a definition exists.
*
* @return bool
* TRUE if provider exists, FALSE otherwise.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:350
⧉protected handlePluginNotFound($plugin_id, array $configuration): object Allows plugin managers to specify custom behavior if a plugin is not found.
/**
* Allows plugin managers to specify custom behavior if a plugin is not found.
*
* @param string $plugin_id
* The ID of the missing requested plugin.
* @param array $configuration
* An array of configuration relevant to the plugin instance.
*
* @return object
* A fallback plugin instance.
*
* @throws \BadMethodCallException
* When ::getFallbackPluginId() is not implemented in the concrete plugin
* manager class.
*/
Inherited from Drupal\Component\Plugin\PluginManagerBase
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/PluginManagerBase.php:102
⧉protected getFallbackPluginId($plugin_id, array $configuration = array()): string Gets a fallback id for a missing plugin.
/**
* Gets a fallback id for a missing plugin.
*
* This method should be implemented in extending classes that also implement
* FallbackPluginManagerInterface. It is called by
* PluginManagerBase::handlePluginNotFound on the abstract class, and
* therefore should be defined as well on the abstract class to prevent static
* analysis errors.
*
* @param string $plugin_id
* The ID of the missing requested plugin.
* @param array $configuration
* An array of configuration relevant to the plugin instance.
*
* @return string
* The id of an existing plugin to use when the plugin does not exist.
*
* @throws \BadMethodCallException
* If the method is not implemented in the concrete plugin manager class.
*/
Inherited from Drupal\Component\Plugin\PluginManagerBase
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/PluginManagerBase.php:127
⧉protected language -> Drupal\Core\Language\Language (5) 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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Language/LanguageDefault.php:50
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
⧉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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:46
⧉public isMultilingual() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:53
⧉public getLanguageTypes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:60
⧉public __wakeup() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
⧉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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:84
/**
* 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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:387
/**
* {@inheritdoc}
*/
Defined in <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:413
/**
* 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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:360
⧉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 <ROOT>/core/lib/Drupal/Core/Plugin/Context/LazyContextRepository.php:42
/**
* {@inheritdoc}
*/
Defined in <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Entity/EntityRepository.php:47
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityRepository.php:180
⧉protected getContentLanguageFromContexts(array $contexts): string|null Retrieves the current content language from the specified contexts.
/**
* Retrieves the current content language from the specified contexts.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of context items.
*
* @return string|null
* A language code or NULL if no language context was provided.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityRepository.php:218
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityRepository.php:243
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityRepository.php:289
⧉protected language -> Drupal\Core\Language\Language (5) 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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Language/LanguageDefault.php:50
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
⧉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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:46
⧉public isMultilingual() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:53
⧉public getLanguageTypes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:60
⧉public __wakeup() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
⧉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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:84
/**
* 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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:387
/**
* {@inheritdoc}
*/
Defined in <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:413
/**
* 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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:360
/**
* Constructs an AnnotatedClassDiscovery object.
*
* @param string $subdir
* Either the plugin's subdirectory, for example 'Plugin/views/filter', or
* empty string if plugins are located at the top level of the namespace.
* @param \Traversable $root_namespaces
* An object that implements \Traversable which contains the root paths
* keyed by the corresponding namespace to look for plugin implementations.
* If $subdir is not an empty string, it will be appended to each namespace.
* @param string $plugin_definition_annotation_name
* (optional) The name of the annotation that contains the plugin definition.
* Defaults to 'Drupal\Component\Annotation\Plugin'.
* @param string[] $annotation_namespaces
* (optional) Additional namespaces to scan for annotation definitions.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php:56
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:20
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:59
⧉public getDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery
Defined in <ROOT>/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php:107
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php:88
⧉protected getProviderFromNamespace($namespace): string|null Extracts the provider name from a Drupal namespace.
/**
* Extracts the provider name from a Drupal namespace.
*
* @param string $namespace
* The namespace to extract the provider from.
*
* @return string|null
* The matching provider name, or NULL otherwise.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php:105
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php:118
⧉protected doGetDefinition(array $definitions, $plugin_id, $exception_on_invalid): array|null Gets a specific plugin definition.
/**
* Gets a specific plugin definition.
*
* @param array $definitions
* An array of the available plugin definitions.
* @param string $plugin_id
* A plugin id.
* @param bool $exception_on_invalid
* If TRUE, an invalid plugin ID will cause an exception to be thrown; if
* FALSE, NULL will be returned.
*
* @return array|null
* A plugin definition, or NULL if the plugin ID is invalid and
* $exception_on_invalid is TRUE.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
* Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.
*/
Inherited from Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:43
⧉public __construct($root, array $module_list, Drupal\Core\Cache\CacheBackendInterface $cache_backend) Constructs a ModuleHandler object.
/**
* Constructs a ModuleHandler object.
*
* @param string $root
* The app root.
* @param array $module_list
* An associative array whose keys are the names of installed modules and
* whose values are Extension class parameters. This is normally the
* %container.modules% parameter being set up by DrupalKernel.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend for storing module hook implementation information.
*
* @see \Drupal\Core\DrupalKernel
* @see \Drupal\Core\CoreServiceProvider
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:110
⧉public load($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:122
⧉public loadAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:138
⧉public reload() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:150
⧉public isLoaded() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:158
⧉public getModuleList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:165
⧉public getModule($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:172
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:708
⧉public getName($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:719
⧉protected add($type, $name, $path) Adds a module or profile to the list of currently active modules.
/**
* Adds a module or profile to the list of currently active modules.
*
* @param string $type
* The extension type; either 'module' or 'profile'.
* @param string $name
* The module name; e.g., 'node'.
* @param string $path
* The module path; e.g., 'core/modules/node'.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:213
/**
* Builds hook_hook_info() information.
*
* @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:308
⧉protected getImplementationInfo($hook): mixed[] Provides information about modules' implementations of a hook.
/**
* Provides information about modules' implementations of a hook.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:583
⧉protected buildImplementationInfo($hook): mixed[] Builds hook implementation information for a given hook name.
/**
* Builds hook implementation information for a given hook name.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*
* @throws \RuntimeException
* Exception thrown when an invalid implementation is added by
* hook_module_implements_alter().
*
* @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:629
⧉protected verifyImplementations(&$implementations, $hook): bool Verifies an array of implementations loaded from cache.
/**
* Verifies an array of implementations loaded from cache.
*
* Verification is done by including the lazy-loaded $module.$group.inc file,
* and checking function_exists().
*
* @param string[] $implementations
* Implementation "group" by module name.
* @param string $hook
* The hook name.
*
* @return bool
* TRUE, if all implementations exist.
* FALSE, if one or more implementations don't exist and need to be removed
* from the cache.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:680
⧉private triggerDeprecationError($description, $hook) Triggers an E_USER_DEPRECATED error if any module implements the hook.
/**
* Triggers an E_USER_DEPRECATED error if any module implements the hook.
*
* @param string $description
* Helpful text describing what to do instead of implementing this hook.
* @param string $hook
* The name of the hook.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:446
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:52
⧉public addTranslator(Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator, $priority0): $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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:66
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:147
⧉public setDefaultLangcode($langcode) Sets the default langcode.
/**
* Sets the default langcode.
*
* @param string $langcode
* A language code.
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:157
⧉public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:164
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:129
⧉public __construct(Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory, Drupal\Core\Cache\CacheBackendInterface $cache) Constructs a new EntityLastInstalledSchemaRepository.
/**
* Constructs a new EntityLastInstalledSchemaRepository.
*
* @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
* The key-value factory.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache backend.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityLastInstalledSchemaRepository.php:44
/**
* @return void
*/
Defined in .../symfony/dependency-injection/ContainerAwareTrait.php:29
⧉public __construct(Traversable $namespaces, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\StringTranslation\TranslationInterface $string_translation, Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver, Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface $entity_last_installed_schema_repository) Constructs a new Entity plugin manager.
/**
* Constructs a new Entity plugin manager.
*
* @param \Traversable $namespaces
* An object that implements \Traversable which contains the root paths
* keyed by the corresponding namespace to look for plugin implementations,
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache backend to use.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* The string translation.
* @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
* The class resolver.
* @param \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface $entity_last_installed_schema_repository
* The entity last installed schema repository.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityTypeManager.php:85
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityTypeManager.php:131
⧉public getActiveDefinition($entity_type_id): \Drupal\Core\Entity\EntityTypeInterface Gets the active definition for a content entity type.
/**
* Gets the active definition for a content entity type.
*
* @param string $entity_type_id
* The entity type ID.
*
* @return \Drupal\Core\Entity\EntityTypeInterface
* The active entity type definition.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityTypeManager.php:153
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:59
/**
* Initialize the cache backend.
*
* Plugin definitions are cached using the provided cache backend.
*
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend instance to use.
* @param string $cache_key
* Cache key prefix to use.
* @param array $cache_tags
* (optional) When providing a list of cache tags, the cached plugin
* definitions are tagged with the provided cache tags. These cache tags can
* then be used to clear the corresponding cached plugin definitions. Note
* that this should be used with care! For clearing all cached plugin
* definitions of a plugin manager, call that plugin manager's
* clearCachedDefinitions() method. Only use cache tags when cached plugin
* definitions should be cleared along with other, related cache entries.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:157
⧉public getDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:178
⧉public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:357
⧉public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:364
⧉public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:371
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\PluginManagerBase
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/PluginManagerBase.php:71
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\PluginManagerBase
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/PluginManagerBase.php:134
⧉protected findDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityTypeManager.php:115
⧉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()
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php:35
⧉protected doGetDefinition(array $definitions, $plugin_id, $exception_on_invalid): array|null Gets a specific plugin definition.
/**
* Gets a specific plugin definition.
*
* @param array $definitions
* An array of the available plugin definitions.
* @param string $plugin_id
* A plugin id.
* @param bool $exception_on_invalid
* If TRUE, an invalid plugin ID will cause an exception to be thrown; if
* FALSE, NULL will be returned.
*
* @return array|null
* A plugin definition, or NULL if the plugin ID is invalid and
* $exception_on_invalid is TRUE.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
* Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php:43
⧉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 array('node' => array(123), 'user' => array(92)).
*
* @see \Drupal\Core\Cache\CacheBackendInterface::set()
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php:69
⧉protected alterInfo($alter_hook) Sets the alter hook name.
/**
* Sets the alter hook name.
*
* @param string $alter_hook
* Name of the alter hook; for example, to invoke
* hook_mymodule_data_alter() pass in "mymodule_data".
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:171
⧉protected getCachedDefinitions(): array|null Returns the cached plugin definitions of the decorated discovery class.
/**
* Returns the cached plugin definitions of the decorated discovery class.
*
* @return array|null
* On success this will return an array of plugin definitions. On failure
* this should return NULL, indicating to other methods that this has not
* yet been defined. Success with no values should return as an empty array
* and would actually be returned by the getDefinitions() method.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:212
⧉protected setCachedDefinitions($definitions) Sets a cache of plugin definitions for the decorated discovery class.
/**
* Sets a cache of plugin definitions for the decorated discovery class.
*
* @param array $definitions
* List of definitions to store in cache.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:225
⧉protected getDiscovery() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:266
⧉protected getFactory() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:277
⧉protected extractProviderFromDefinition($plugin_definition): string|null Extracts the provider from a plugin definition.
/**
* Extracts the provider from a plugin definition.
*
* @param mixed $plugin_definition
* The plugin definition. Usually either an array or an instance of
* \Drupal\Component\Plugin\Definition\PluginDefinitionInterface
*
* @return string|null
* The provider string, if it exists. NULL otherwise.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:317
⧉protected alterDefinitions(&$definitions) Invokes the hook to alter the definitions if the alter hook is set.
/**
* Invokes the hook to alter the definitions if the alter hook is set.
*
* @param $definitions
* The discovered plugin definitions.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:338
⧉protected providerExists($provider): bool Determines if the provider of a definition exists.
/**
* Determines if the provider of a definition exists.
*
* @return bool
* TRUE if provider exists, FALSE otherwise.
*/
Inherited from Drupal\Core\Plugin\DefaultPluginManager
Defined in <ROOT>/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php:350
⧉protected handlePluginNotFound($plugin_id, array $configuration): object Allows plugin managers to specify custom behavior if a plugin is not found.
/**
* Allows plugin managers to specify custom behavior if a plugin is not found.
*
* @param string $plugin_id
* The ID of the missing requested plugin.
* @param array $configuration
* An array of configuration relevant to the plugin instance.
*
* @return object
* A fallback plugin instance.
*
* @throws \BadMethodCallException
* When ::getFallbackPluginId() is not implemented in the concrete plugin
* manager class.
*/
Inherited from Drupal\Component\Plugin\PluginManagerBase
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/PluginManagerBase.php:102
⧉protected getFallbackPluginId($plugin_id, array $configuration = array()): string Gets a fallback id for a missing plugin.
/**
* Gets a fallback id for a missing plugin.
*
* This method should be implemented in extending classes that also implement
* FallbackPluginManagerInterface. It is called by
* PluginManagerBase::handlePluginNotFound on the abstract class, and
* therefore should be defined as well on the abstract class to prevent static
* analysis errors.
*
* @param string $plugin_id
* The ID of the missing requested plugin.
* @param array $configuration
* An array of configuration relevant to the plugin instance.
*
* @return string
* The id of an existing plugin to use when the plugin does not exist.
*
* @throws \BadMethodCallException
* If the method is not implemented in the concrete plugin manager class.
*/
Inherited from Drupal\Component\Plugin\PluginManagerBase
Defined in <ROOT>/core/lib/Drupal/Component/Plugin/PluginManagerBase.php:127
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
⧉public __construct($root, array $module_list, Drupal\Core\Cache\CacheBackendInterface $cache_backend) Constructs a ModuleHandler object.
/**
* Constructs a ModuleHandler object.
*
* @param string $root
* The app root.
* @param array $module_list
* An associative array whose keys are the names of installed modules and
* whose values are Extension class parameters. This is normally the
* %container.modules% parameter being set up by DrupalKernel.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend for storing module hook implementation information.
*
* @see \Drupal\Core\DrupalKernel
* @see \Drupal\Core\CoreServiceProvider
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:110
⧉public load($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:122
⧉public loadAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:138
⧉public reload() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:150
⧉public isLoaded() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:158
⧉public getModuleList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:165
⧉public getModule($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:172
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:708
⧉public getName($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:719
⧉protected add($type, $name, $path) Adds a module or profile to the list of currently active modules.
/**
* Adds a module or profile to the list of currently active modules.
*
* @param string $type
* The extension type; either 'module' or 'profile'.
* @param string $name
* The module name; e.g., 'node'.
* @param string $path
* The module path; e.g., 'core/modules/node'.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:213
/**
* Builds hook_hook_info() information.
*
* @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:308
⧉protected getImplementationInfo($hook): mixed[] Provides information about modules' implementations of a hook.
/**
* Provides information about modules' implementations of a hook.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:583
⧉protected buildImplementationInfo($hook): mixed[] Builds hook implementation information for a given hook name.
/**
* Builds hook implementation information for a given hook name.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*
* @throws \RuntimeException
* Exception thrown when an invalid implementation is added by
* hook_module_implements_alter().
*
* @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:629
⧉protected verifyImplementations(&$implementations, $hook): bool Verifies an array of implementations loaded from cache.
/**
* Verifies an array of implementations loaded from cache.
*
* Verification is done by including the lazy-loaded $module.$group.inc file,
* and checking function_exists().
*
* @param string[] $implementations
* Implementation "group" by module name.
* @param string $hook
* The hook name.
*
* @return bool
* TRUE, if all implementations exist.
* FALSE, if one or more implementations don't exist and need to be removed
* from the cache.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:680
⧉private triggerDeprecationError($description, $hook) Triggers an E_USER_DEPRECATED error if any module implements the hook.
/**
* Triggers an E_USER_DEPRECATED error if any module implements the hook.
*
* @param string $description
* Helpful text describing what to do instead of implementing this hook.
* @param string $hook
* The name of the hook.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:446
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:266
⧉public driver()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:272
⧉public version() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:279
⧉public isMariaDb(): bool Determines whether the MySQL distribution is MariaDB or not.
/**
* Determines whether the MySQL distribution is MariaDB or not.
*
* @return bool
* Returns TRUE if the distribution is MariaDB, or FALSE if not.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:293
⧉public databaseType()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:326
/**
* Overrides \Drupal\Core\Database\Connection::createDatabase().
*
* @param string $database
* The name of the database to create.
*
* @throws \Drupal\Core\Database\DatabaseNotFoundException
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:338
⧉public mapConditionOperator($operator)
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:352
⧉public nextId($existing_id0)
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:357
⧉public nextIdDelete()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:377
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:449
⧉public getConnectionOptions(): array Returns the connection information for this connection object.
/**
* Returns the connection information for this connection object.
*
* Note that Database::getConnectionInfo() is for requesting information
* about an arbitrary database connection that is defined. This method
* is for requesting the connection information of this specific
* open connection object.
*
* @return array
* An array of the connection information. The exact list of
* properties is driver-dependent.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:352
⧉public attachDatabase(string $database): void Allows the connection to access additional databases.
/**
* Allows the connection to access additional databases.
*
* Database systems usually group tables in 'databases' or 'schemas', that
* can be accessed with syntax like 'SELECT * FROM database.table'. Normally
* Drupal accesses tables in a single database/schema, but in some cases it
* may be necessary to access tables from other databases/schemas in the same
* database server. This method can be called to ensure that the additional
* database/schema is accessible.
*
* For MySQL, PostgreSQL and most other databases no action need to be taken
* to query data in another database or schema. For SQLite this is however
* necessary and the database driver for SQLite will override this method.
*
* @param string $database
* The database to be attached to the connection.
*
* @internal
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:375
⧉public getPrefix(): string Returns the prefix of the tables.
/**
* Returns the prefix of the tables.
*
* @return string $prefix
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:383
⧉public prefixTables($sql): string Appends a database prefix to all tables in a query.
/**
* Appends a database prefix to all tables in a query.
*
* Queries sent to Drupal should wrap all table names in curly brackets. This
* function searches for this syntax and adds Drupal's table prefix to all
* tables, allowing Drupal to coexist with other systems in the same database
* and/or schema if necessary.
*
* @param string $sql
* A string containing a partial or entire SQL query.
*
* @return string
* The properly-prefixed string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:416
⧉public quoteIdentifiers($sql): string Quotes all identifiers in a query.
/**
* Quotes all identifiers in a query.
*
* Queries sent to Drupal should wrap all unquoted identifiers in square
* brackets. This function searches for this syntax and replaces them with the
* database specific identifier. In ANSI SQL this a double quote.
*
* Note that :variable[] is used to denote array arguments but
* Connection::expandArguments() is always called first.
*
* @param string $sql
* A string containing a partial or entire SQL query.
*
* @return string
* The string containing a partial or entire SQL query with all identifiers
* quoted.
*
* @internal
* This method should only be called by database API code.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:440
⧉public tablePrefix($table = 'default') Find the prefix for a table.
/**
* Find the prefix for a table.
*
* This function is for when you want to know the prefix of a table. This
* is not used in prefixTables due to performance reasons.
*
* @param string $table
* (optional) The table to find the prefix for.
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0.
* Instead, you should just use Connection::getPrefix().
*
* @see https://www.drupal.org/node/3260849
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:458
⧉public getUnprefixedTablesMap(): array Gets a list of individually prefixed table names.
/**
* Gets a list of individually prefixed table names.
*
* @return array
* An array of un-prefixed table names, keyed by their fully qualified table
* names (i.e. prefix + table_name).
*
* @deprecated in drupal:10.0.0 and is removed from drupal:11.0.0. There is
* no replacement.
*
* @see https://www.drupal.org/node/3257198
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:475
⧉public getFullQualifiedTableName($table): string Get a fully qualified table name.
/**
* Get a fully qualified table name.
*
* @param string $table
* The name of the table in question.
*
* @return string
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:488
⧉public prepareStatement(string $query, array $options, bool $allow_row_count = false): Drupal\Core\Database\StatementInterface Returns a prepared statement given a SQL string.
/**
* Returns a prepared statement given a SQL string.
*
* This method caches prepared statements, reusing them when possible. It also
* prefixes tables names enclosed in curly braces and, optionally, quotes
* identifiers enclosed in square brackets.
*
* @param string $query
* The query string as SQL, with curly braces surrounding the table names,
* and square brackets surrounding identifiers.
* @param array $options
* An associative array of options to control how the query is run. See
* the documentation for self::defaultOptions() for details. The content of
* the 'pdo' key will be passed to the prepared statement.
* @param bool $allow_row_count
* (optional) A flag indicating if row count is allowed on the statement
* object. Defaults to FALSE.
*
* @return \Drupal\Core\Database\StatementInterface
* A prepared statement ready for its execute() method.
*
* @throws \InvalidArgumentException
* If multiple statements are included in the string, and delimiters are
* not allowed in the query.
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:520
⧉public setTarget($target = null) Tells this connection object what its target value is.
/**
* Tells this connection object what its target value is.
*
* This is needed for logging and auditing. It's sloppy to do in the
* constructor because the constructor for child classes has a different
* signature. We therefore also ensure that this function is only ever
* called once.
*
* @param string $target
* (optional) The target this connection is for.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:593
⧉public getTarget(): string|null Returns the target this connection is associated with.
/**
* Returns the target this connection is associated with.
*
* @return string|null
* The target string of this connection, or NULL if no target is set.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:605
⧉public setKey($key) Tells this connection object what its key is.
/**
* Tells this connection object what its key is.
*
* @param string $key
* The key this connection is for.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:615
⧉public getKey(): string|null Returns the key this connection is associated with.
/**
* Returns the key this connection is associated with.
*
* @return string|null
* The key of this connection, or NULL if no key is set.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:627
⧉public setLogger(Drupal\Core\Database\Log $logger) Associates a logging object with this connection.
/**
* Associates a logging object with this connection.
*
* @param \Drupal\Core\Database\Log $logger
* The logging object we want to use.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:637
⧉public getLogger(): \Drupal\Core\Database\Log|null Gets the current logging object for this connection.
/**
* Gets the current logging object for this connection.
*
* @return \Drupal\Core\Database\Log|null
* The current logging object for this connection. If there isn't one,
* NULL is returned.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:648
⧉public makeSequenceName($table, $field): string Creates the appropriate sequence name for a given table and serial field.
/**
* Creates the appropriate sequence name for a given table and serial field.
*
* This information is exposed to all database drivers, although it is only
* useful on some of them. This method is table prefix-aware.
*
* Note that if a sequence was generated automatically by the database, its
* name might not match the one returned by this function. Therefore, in those
* cases, it is generally advised to use a database-specific way of retrieving
* the name of an auto-created sequence. For example, PostgreSQL provides a
* dedicated function for this purpose: pg_get_serial_sequence().
*
* @param string $table
* The table name to use for the sequence.
* @param string $field
* The field name to use for the sequence.
*
* @return string
* A table prefix-parsed string for the sequence name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:672
⧉public makeComment($comments): string Flatten an array of query comments into a single comment string.
/**
* Flatten an array of query comments into a single comment string.
*
* The comment string will be sanitized to avoid SQL injection attacks.
*
* @param string[] $comments
* An array of query comment strings.
*
* @return string
* A sanitized comment string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:690
⧉public query($query, array $args = array(), $options = array()): \Drupal\Core\Database\StatementInterface|int|string|null Executes a query string against the database.
/**
* Executes a query string against the database.
*
* This method provides a central handler for the actual execution of every
* query. All queries executed by Drupal are executed as prepared statements.
*
* @param string $query
* The query to execute. This is a string containing an SQL query with
* placeholders.
* @param array $args
* The associative array of arguments for the prepared statement.
* @param array $options
* An associative array of options to control how the query is run. The
* given options will be merged with self::defaultOptions(). See the
* documentation for self::defaultOptions() for details.
* Typically, $options['return'] will be set by a default or by a query
* builder, and should not be set by a user.
*
* @return \Drupal\Core\Database\StatementInterface|int|string|null
* This method will return one of the following:
* - If either $options['return'] === self::RETURN_STATEMENT, or
* $options['return'] is not set (due to self::defaultOptions()),
* returns the executed statement.
* - If $options['return'] === self::RETURN_AFFECTED,
* returns the number of rows matched by the query
* (not the number affected).
* - If $options['return'] === self::RETURN_INSERT_ID,
* returns the generated insert ID of the last query as a string.
* - If $options['return'] === self::RETURN_NULL, returns NULL.
*
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
* @throws \Drupal\Core\Database\IntegrityConstraintViolationException
* @throws \InvalidArgumentException
*
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:774
⧉public getDriverClass($class): string Gets the driver-specific override class if any for the specified class.
/**
* Gets the driver-specific override class if any for the specified class.
*
* @param string $class
* The class for which we want the potentially driver-specific class.
*
* @return string
* The name of the class that should be used for this driver.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:901
⧉public exceptionHandler(): \Drupal\Core\Database\ExceptionHandler Returns the database exceptions handler.
/**
* Returns the database exceptions handler.
*
* @return \Drupal\Core\Database\ExceptionHandler
* The database exceptions handler.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:967
⧉public select($table, $alias = null, array $options = array()): \Drupal\Core\Database\Query\SelectInterface Prepares and returns a SELECT query object.
/**
* Prepares and returns a SELECT query object.
*
* @param string|\Drupal\Core\Database\Query\SelectInterface $table
* The base table name or subquery for this query, used in the FROM clause.
* If a string, the table specified will also be used as the "base" table
* for query_alter hook implementations.
* @param string $alias
* (optional) The alias of the base table of this query.
* @param $options
* An array of options on the query.
*
* @return \Drupal\Core\Database\Query\SelectInterface
* An appropriate SelectQuery object for this database connection. Note that
* it may be a driver-specific subclass of SelectQuery, depending on the
* driver.
*
* @see \Drupal\Core\Database\Query\Select
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:991
⧉public insert($table, array $options = array()): \Drupal\Core\Database\Query\Insert Prepares and returns an INSERT query object.
/**
* Prepares and returns an INSERT query object.
*
* @param string $table
* The table to use for the insert statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Insert
* A new Insert query object.
*
* @see \Drupal\Core\Database\Query\Insert
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1013
⧉public lastInsertId(?string $name = null): string Returns the ID of the last inserted row or sequence value.
/**
* Returns the ID of the last inserted row or sequence value.
*
* This method should normally be used only within database driver code.
*
* This is a proxy to invoke lastInsertId() from the wrapped connection.
* If a sequence name is not specified for the name parameter, this returns a
* string representing the row ID of the last row that was inserted into the
* database.
* If a sequence name is specified for the name parameter, this returns a
* string representing the last value retrieved from the specified sequence
* object.
*
* @param string|null $name
* (Optional) Name of the sequence object from which the ID should be
* returned.
*
* @return string
* The value returned by the wrapped connection.
*
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
* In case of failure.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1041
⧉public merge($table, array $options = array()): \Drupal\Core\Database\Query\Merge Prepares and returns a MERGE query object.
/**
* Prepares and returns a MERGE query object.
*
* @param string $table
* The table to use for the merge statement.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Merge
* A new Merge query object.
*
* @see \Drupal\Core\Database\Query\Merge
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1061
⧉public upsert($table, array $options = array()): \Drupal\Core\Database\Query\Upsert Prepares and returns an UPSERT query object.
/**
* Prepares and returns an UPSERT query object.
*
* @param string $table
* The table to use for the upsert query.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Upsert
* A new Upsert query object.
*
* @see \Drupal\Core\Database\Query\Upsert
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1079
⧉public update($table, array $options = array()): \Drupal\Core\Database\Query\Update Prepares and returns an UPDATE query object.
/**
* Prepares and returns an UPDATE query object.
*
* @param string $table
* The table to use for the update statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Update
* A new Update query object.
*
* @see \Drupal\Core\Database\Query\Update
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1100
⧉public delete($table, array $options = array()): \Drupal\Core\Database\Query\Delete Prepares and returns a DELETE query object.
/**
* Prepares and returns a DELETE query object.
*
* @param string $table
* The table to use for the delete statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Delete
* A new Delete query object.
*
* @see \Drupal\Core\Database\Query\Delete
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1121
⧉public truncate($table, array $options = array()): \Drupal\Core\Database\Query\Truncate Prepares and returns a TRUNCATE query object.
/**
* Prepares and returns a TRUNCATE query object.
*
* @param string $table
* The table to use for the truncate statement.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Truncate
* A new Truncate query object.
*
* @see \Drupal\Core\Database\Query\Truncate
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1139
⧉public schema(): \Drupal\Core\Database\Schema Returns a DatabaseSchema object for manipulating the schema.
/**
* Returns a DatabaseSchema object for manipulating the schema.
*
* This method will lazy-load the appropriate schema library file.
*
* @return \Drupal\Core\Database\Schema
* The database Schema object for this connection.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1152
⧉public condition($conjunction): \Drupal\Core\Database\Query\Condition Prepares and returns a CONDITION query object.
/**
* Prepares and returns a CONDITION query object.
*
* @param string $conjunction
* The operator to use to combine conditions: 'AND' or 'OR'.
*
* @return \Drupal\Core\Database\Query\Condition
* A new Condition query object.
*
* @see \Drupal\Core\Database\Query\Condition
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1171
⧉public escapeDatabase($database): string Escapes a database name string.
/**
* Escapes a database name string.
*
* Force all database names to be strictly alphanumeric-plus-underscore.
* For some database drivers, it may also wrap the database name in
* database-specific escape characters.
*
* @param string $database
* An unsanitized database name.
*
* @return string
* The sanitized database name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1192
⧉public escapeTable($table): string Escapes a table name string.
/**
* Escapes a table name string.
*
* Force all table names to be strictly alphanumeric-plus-underscore.
* Database drivers should never wrap the table name in database-specific
* escape characters. This is done in Connection::prefixTables(). The
* database-specific escape characters are added in Connection::setPrefix().
*
* @param string $table
* An unsanitized table name.
*
* @return string
* The sanitized table name.
*
* @see \Drupal\Core\Database\Connection::prefixTables()
* @see \Drupal\Core\Database\Connection::setPrefix()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1215
⧉public escapeField($field): string Escapes a field name string.
/**
* Escapes a field name string.
*
* Force all field names to be strictly alphanumeric-plus-underscore.
* For some database drivers, it may also wrap the field name in
* database-specific escape characters.
*
* @param string $field
* An unsanitized field name.
*
* @return string
* The sanitized field name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1235
⧉public escapeAlias($field): string Escapes an alias name string.
/**
* Escapes an alias name string.
*
* Force all alias names to be strictly alphanumeric-plus-underscore. In
* contrast to DatabaseConnection::escapeField() /
* DatabaseConnection::escapeTable(), this doesn't allow the period (".")
* because that is not allowed in aliases.
*
* @param string $field
* An unsanitized alias name.
*
* @return string
* The sanitized alias name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1260
⧉public escapeLike($string): string Escapes characters that work as wildcard characters in a LIKE pattern.
/**
* Escapes characters that work as wildcard characters in a LIKE pattern.
*
* The wildcard characters "%" and "_" as well as backslash are prefixed with
* a backslash. Use this to do a search for a verbatim string without any
* wildcard behavior.
*
* For example, the following does a case-insensitive query for all rows whose
* name starts with $prefix:
* @code
* $result = $injected_connection->query(
* 'SELECT * FROM person WHERE name LIKE :pattern',
* array(':pattern' => $injected_connection->escapeLike($prefix) . '%')
* );
* @endcode
*
* Backslash is defined as escape character for LIKE patterns in
* Drupal\Core\Database\Query\Condition::mapConditionOperator().
*
* @param string $string
* The string to escape.
*
* @return string
* The escaped string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1293
⧉public inTransaction(): bool Determines if there is an active transaction open.
/**
* Determines if there is an active transaction open.
*
* @return bool
* TRUE if we're currently in a transaction, FALSE otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1303
⧉public transactionDepth(): int Determines the current transaction depth.
/**
* Determines the current transaction depth.
*
* @return int
* The current transaction depth.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1313
⧉public startTransaction($name = ''): \Drupal\Core\Database\Transaction Returns a new DatabaseTransaction object on this connection.
/**
* Returns a new DatabaseTransaction object on this connection.
*
* @param string $name
* (optional) The name of the savepoint.
*
* @return \Drupal\Core\Database\Transaction
* A Transaction object.
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1328
⧉public pushTransaction($name) Increases the depth of transaction nesting.
/**
* Increases the depth of transaction nesting.
*
* If no transaction is already active, we begin a new transaction.
*
* @param string $name
* The name of the transaction.
*
* @throws \Drupal\Core\Database\TransactionNameNonUniqueException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1406
⧉public popTransaction($name) Decreases the depth of transaction nesting.
/**
* Decreases the depth of transaction nesting.
*
* If we pop off the last transaction layer, then we either commit or roll
* back the transaction as necessary. If no transaction is active, we return
* because the transaction may have manually been rolled back.
*
* @param string $name
* The name of the savepoint.
*
* @throws \Drupal\Core\Database\TransactionNoActiveException
* @throws \Drupal\Core\Database\TransactionCommitFailedException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1436
⧉public addRootTransactionEndCallback(callable $callback) Adds a root transaction end callback.
/**
* Adds a root transaction end callback.
*
* These callbacks are invoked immediately after the transaction has been
* committed.
*
* It can for example be used to avoid deadlocks on write-heavy tables that
* do not need to be part of the transaction, like cache tag invalidations.
*
* Another use case is that services using alternative backends like Redis and
* Memcache cache implementations can replicate the transaction-behavior of
* the database cache backend and avoid race conditions.
*
* An argument is passed to the callbacks that indicates whether the
* transaction was successful or not.
*
* @param callable $callback
* The callback to invoke.
*
* @see \Drupal\Core\Database\Connection::doCommit()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1471
⧉public clientVersion(): string Returns the version of the database client.
/**
* Returns the version of the database client.
*
* Assumes the client connection is \PDO. Non-PDO based drivers need to
* override this method.
*
* @return string
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1581
⧉public supportsTransactionalDDL(): bool Determines if this driver supports transactional DDL.
/**
* Determines if this driver supports transactional DDL.
*
* DDL queries are those that change the schema, such as ALTER queries.
*
* @return bool
* TRUE if this connection supports transactions for DDL queries, FALSE
* otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1594
⧉public commit() Throws an exception to deny direct access to transaction commits.
/**
* Throws an exception to deny direct access to transaction commits.
*
* We do not want to allow users to commit transactions at any time, only
* by destroying the transaction object or allowing it to go out of scope.
* A direct commit bypasses all of the safety checks we've built on top of
* the database client's transaction routines.
*
* @throws \Drupal\Core\Database\TransactionExplicitCommitNotAllowedException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1646
⧉public quote($string, $parameter_type = 2): string|bool Quotes a string for use in a query.
/**
* Quotes a string for use in a query.
*
* @param string $string
* The string to be quoted.
* @param int $parameter_type
* (optional) Provides a data type hint for drivers that have alternate
* quoting styles. Defaults to \PDO::PARAM_STR.
*
* @return string|bool
* A quoted string that is theoretically safe to pass into an SQL statement.
* Returns FALSE if the driver does not support quoting in this way.
*
* @see \PDO::quote()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1684
⧉public __sleep() Prevents the database connection from being serialized.
/**
* Prevents the database connection from being serialized.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1711
⧉public getProvider(): string Get the module name of the module that is providing the database driver.
/**
* Get the module name of the module that is providing the database driver.
*
* @return string
* The module name of the module that is providing the database driver, or
* "core" when the driver is not provided as part of a module.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1841
⧉public getPagerManager(): Drupal\Core\Pager\PagerManagerInterface Get the pager manager service, if available.
/**
* Get the pager manager service, if available.
*
* @return \Drupal\Core\Pager\PagerManagerInterface
* The pager manager service, if available.
*
* @throws \Drupal\Core\DependencyInjection\ContainerNotInitializedException
* If the container has not been initialized yet.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1861
⧉public hasJson(): bool Runs a simple query to validate json datatype support.
/**
* Runs a simple query to validate json datatype support.
*
* @return bool
* Returns the query result.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1871
⧉public isEventEnabled(string $eventName): bool Returns the status of a database API event toggle.
/**
* Returns the status of a database API event toggle.
*
* @param string $eventName
* The name of the event to check.
*
* @return bool
* TRUE if the event is going to be fired by the database API, FALSE
* otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1890
⧉public enableEvents(array $eventNames): static Enables database API events dispatching.
/**
* Enables database API events dispatching.
*
* @param string[] $eventNames
* A list of database events to be enabled.
*
* @return static
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1902
⧉public disableEvents(array $eventNames): static Disables database API events dispatching.
/**
* Disables database API events dispatching.
*
* @param string[] $eventNames
* A list of database events to be disabled.
*
* @return static
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1918
⧉public dispatchEvent(Drupal\Core\Database\Event\DatabaseEvent $event, ?string $eventName = null): Drupal\Core\Database\Event\DatabaseEvent Dispatches a database API event via the container dispatcher.
/**
* Dispatches a database API event via the container dispatcher.
*
* @param \Drupal\Core\Database\Event\DatabaseEvent $event
* The database event.
* @param string|null $eventName
* (Optional) the name of the event to dispatch.
*
* @return \Drupal\Core\Database\Event\DatabaseEvent
* The database event.
*
* @throws \Drupal\Core\Database\Exception\EventException
* If the container is not initialized.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1940
⧉public findCallerFromDebugBacktrace(): array Determine the last non-database method that called the database API.
/**
* Determine the last non-database method that called the database API.
*
* Traversing the call stack from the very first call made during the
* request, we define "the routine that called this query" as the last entry
* in the call stack that is not any method called from the namespace of the
* database driver, is not inside the Drupal\Core\Database namespace and does
* have a file (which excludes call_user_func_array(), anonymous functions
* and similar). That makes the climbing logic very simple, and handles the
* variable stack depth caused by the query builders.
*
* See the @link http://php.net/debug_backtrace debug_backtrace() @endlink
* function.
*
* @return array
* This method returns a stack trace entry similar to that generated by
* debug_backtrace(). However, it flattens the trace entry and the trace
* entry before it so that we get the function and args of the function that
* called into the database system, not the function and args of the
* database call itself.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1968
⧉protected getMariaDbVersionMatch(): ?string Gets the MariaDB portion of the server version.
/**
* Gets the MariaDB portion of the server version.
*
* @return string
* The MariaDB portion of the server version if present, or NULL if not.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:303
⧉protected getServerVersion(): string Gets the server version.
/**
* Gets the server version.
*
* @return string
* The PDO server version.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:319
⧉protected popCommittableTransactions() Overridden to work around issues to MySQL not supporting transactional DDL.
/**
* Overridden to work around issues to MySQL not supporting transactional DDL.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:404
⧉protected doCommit() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:479
⧉protected defaultOptions(): array Returns the default query options for any given query.
/**
* Returns the default query options for any given query.
*
* A given query can be customized with a number of option flags in an
* associative array:
* - fetch: This element controls how rows from a result set will be
* returned. Legal values include \PDO::FETCH_ASSOC, \PDO::FETCH_BOTH,
* \PDO::FETCH_OBJ, \PDO::FETCH_NUM, or a string representing the name of a
* class. If a string is specified, each record will be fetched into a new
* object of that class. The behavior of all other values is defined by PDO.
* See http://php.net/manual/pdostatement.fetch.php
* - return: (deprecated) Depending on the type of query, different return
* values may be meaningful. This directive instructs the system which type
* of return value is desired. The system will generally set the correct
* value automatically, so it is extremely rare that a module developer will
* ever need to specify this value. Setting it incorrectly will likely lead
* to unpredictable results or fatal errors. Legal values include:
* - Database::RETURN_STATEMENT: Return the prepared statement object for
* the query. This is usually only meaningful for SELECT queries, where
* the statement object is how one accesses the result set returned by the
* query.
* - Database::RETURN_AFFECTED: Return the number of rows found (matched) by
* the WHERE clause of an UPDATE or DELETE query (not the number of rows
* actually changed). Note that although named RETURN_AFFECTED for
* historical reasons, the number of rows matched is returned for
* consistency across database engines.
* - Database::RETURN_INSERT_ID: Return the sequence ID (primary key)
* created by an INSERT statement on a table that contains a serial
* column.
* - Database::RETURN_NULL: Do not return anything, as there is no
* meaningful value to return. That is the case for INSERT queries on
* tables that do not contain a serial column.
* - allow_delimiter_in_query: By default, queries which have the ; delimiter
* any place in them will cause an exception. This reduces the chance of SQL
* injection attacks that terminate the original query and add one or more
* additional queries (such as inserting new user accounts). In rare cases,
* such as creating an SQL function, a ; is needed and can be allowed by
* changing this option to TRUE.
* - allow_square_brackets: By default, queries which contain square brackets
* will have them replaced with the identifier quote character for the
* database type. In rare cases, such as creating an SQL function, []
* characters might be needed and can be allowed by changing this option to
* TRUE.
* - pdo: By default, queries will execute with the client connection options
* set on the connection. In particular cases, it could be necessary to
* override the driver options on the statement level. In such case, pass
* the required setting as an array here, and they will be passed to the
* prepared statement.
*
* @return array
* An array of default query options.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:331
⧉protected setPrefix($prefix) Set the prefix used by this database connection.
/**
* Set the prefix used by this database connection.
*
* @param string $prefix
* A single prefix.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:393
⧉protected preprocessStatement(string $query, array $options): string Returns a string SQL statement ready for preparation.
/**
* Returns a string SQL statement ready for preparation.
*
* This method replaces table names in curly braces and identifiers in square
* brackets with platform specific replacements, appropriately escaping them
* and wrapping them with platform quote characters.
*
* @param string $query
* The query string as SQL, with curly braces surrounding the table names,
* and square brackets surrounding identifiers.
* @param array $options
* An associative array of options to control how the query is run. See
* the documentation for self::defaultOptions() for details.
*
* @return string
* A string SQL statement ready for preparation.
*
* @throws \InvalidArgumentException
* If multiple statements are included in the string, and delimiters are
* not allowed in the query.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:557
⧉protected filterComment($comment = ''): string Sanitize a query comment string.
/**
* Sanitize a query comment string.
*
* Ensure a query comment does not include strings such as "* /" that might
* terminate the comment early. This avoids SQL injection attacks via the
* query comment. The comment strings in this example are separated by a
* space to avoid PHP parse errors.
*
* For example, the comment:
* @code
* \Drupal::database()->update('example')
* ->condition('id', $id)
* ->fields(array('field2' => 10))
* ->comment('Exploit * / DROP TABLE node; --')
* ->execute()
* @endcode
*
* Would result in the following SQL statement being generated:
* @code
* "/ * Exploit * / DROP TABLE node. -- * / UPDATE example SET field2=..."
* @endcode
*
* Unless the comment is sanitized first, the SQL server would drop the
* node table and ignore the rest of the SQL statement.
*
* @param string $comment
* A query comment string.
*
* @return string
* A sanitized version of the query comment string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:733
⧉protected expandArguments(&$query, &$args): bool Expands out shorthand placeholders.
/**
* Expands out shorthand placeholders.
*
* Drupal supports an alternate syntax for doing arrays of values. We
* therefore need to expand them out into a full, executable query string.
*
* @param string $query
* The query string to modify.
* @param array $args
* The arguments for the query.
*
* @return bool
* TRUE if the query was modified, FALSE otherwise.
*
* @throws \InvalidArgumentException
* This exception is thrown when:
* - A placeholder that ends in [] is supplied, and the supplied value is
* not an array.
* - A placeholder that does not end in [] is supplied, and the supplied
* value is an array.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:847
⧉protected getDebugBacktrace(): array Gets the debug backtrace.
/**
* Gets the debug backtrace.
*
* Wraps the debug_backtrace function to allow mocking results in PHPUnit
* tests.
*
* @return array[]
* The debug backtrace.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:2024
/**
* Creates an array of database connection options from a URL.
*
* @param string $url
* The URL.
* @param string $root
* The root directory of the Drupal installation. Some database drivers,
* like for example SQLite, need this information.
*
* @return array
* The connection options.
*
* @throws \InvalidArgumentException
* Exception thrown when the provided URL does not meet the minimum
* requirements.
*
* @internal
* This method should only be called from
* \Drupal\Core\Database\Database::convertDbUrlToConnectionInfo().
*
* @see \Drupal\Core\Database\Database::convertDbUrlToConnectionInfo()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1737
⇄⧉public static createUrlFromConnectionOptions(array $connection_options): string Creates a URL from an array of database connection options.
/**
* Creates a URL from an array of database connection options.
*
* @param array $connection_options
* The array of connection options for a database connection. An additional
* key of 'module' is added by Database::getConnectionInfoAsUrl() for
* drivers provided my contributed or custom modules for convenience.
*
* @return string
* The connection info as a URL.
*
* @throws \InvalidArgumentException
* Exception thrown when the provided array of connection options does not
* meet the minimum requirements.
*
* @internal
* This method should only be called from
* \Drupal\Core\Database\Database::getConnectionInfoAsUrl().
*
* @see \Drupal\Core\Database\Database::getConnectionInfoAsUrl()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1798
⇄⧉public static removeDatabaseEntriesFromDebugBacktrace(array $backtrace, string $driver_namespace): array Removes database related calls from a backtrace array.
/**
* Removes database related calls from a backtrace array.
*
* @param array $backtrace
* A standard PHP backtrace. Passed by reference.
* @param string $driver_namespace
* The PHP namespace of the database driver.
*
* @return array
* The cleaned backtrace array.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1999
⧉protected static getSQLState(Exception $e): string Extracts the SQLSTATE error from a PDOException.
/**
* Extracts the SQLSTATE error from a PDOException.
*
* @param \Exception $e
* The exception
*
* @return string
* The five character error code.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1697
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:28
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:43
/**
* Implements \Drupal\Core\Cache\CacheTagsInvalidatorInterface::invalidateTags()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:53
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::getCurrentChecksum()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:83
⧉public schemaDefinition() Defines the schema for the {cachetags} table.
/**
* Defines the schema for the {cachetags} table.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:97
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::isValid()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:105
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:58
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:75
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:128
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:60
⧉public getAllViewModes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:70
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:91
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:118
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:272
⧉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 <ROOT>/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 array('node' => array(123), 'user' => array(92)).
*
* @see \Drupal\Core\Cache\CacheBackendInterface::set()
*/
Defined in <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
⧉protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:79
⧉protected getNumberOfPlurals($langcode = null) 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()
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:88
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:102
⧉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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:137
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:189
⧉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 $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 <ROOT>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:210
⧉protected language -> Drupal\Core\Language\Language (5)
Properties (5)
Available methods (9)
Static class properties (16)
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 <ROOT>/core/lib/Drupal/Core/Language/Language.php:77
⧉public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:101
⧉public getId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:108
⧉public getDirection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:115
⧉public getWeight() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:122
⧉public isDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:129
⧉public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:136
⇄⧉public static sort(&$languages) Sort language objects.
\Drupal\Core\Language\Language::sort(&$languages)
/**
* Sort language objects.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* The array of language objects keyed by langcode.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:146
⧉protected static getDefaultLangcode(): string Gets the default langcode.
/**
* Gets the default langcode.
*
* @return string
* The current default langcode.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:173
⧉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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Language/LanguageDefault.php:50
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
⧉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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:46
⧉public isMultilingual() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:53
⧉public getLanguageTypes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:60
⧉public __wakeup() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
⧉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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:84
/**
* 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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:387
/**
* {@inheritdoc}
*/
Defined in <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:413
/**
* 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 <ROOT>/core/lib/Drupal/Core/Language/LanguageManager.php:360
public base_theme -> string (16) "bootstrap_barrio"
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:71
⧉public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:85
⧉public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:94
⧉public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:103
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:112
⧉public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:121
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:130
⧉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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:141
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:151
⧉public __call($method, array $args) Re-routes method calls to SplFileInfo.
/**
* Re-routes method calls to SplFileInfo.
*
* Offers all SplFileInfo methods to consumers; e.g., $extension->getMTime().
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
* \Drupal\Core\Extension\Extension::getFileInfo() instead.
*
* @see https://www.drupal.org/node/2959989
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:169
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:182
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:195
⧉public __wakeup() Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:208
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/Extension.php:245
⧉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 <ROOT>/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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:131
⧉public getPath(): string Returns the path to the theme directory.
/**
* Returns the path to the theme directory.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:140
⧉public getEngine(): string Returns the theme engine.
/**
* Returns the theme engine.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:149
⧉public getOwner(): mixed Returns the path to the theme engine for root themes.
/**
* Returns the path to the theme engine for root themes.
*
* @see \Drupal\Core\Extension\ThemeExtensionList::doList()
*
* @return mixed
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:160
⧉public getExtension(): \Drupal\Core\Extension\Extension Returns the extension object.
/**
* Returns the extension object.
*
* @return \Drupal\Core\Extension\Extension
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:169
⧉public getLibraries(): mixed Returns the libraries provided by the theme.
/**
* Returns the libraries provided by the theme.
*
* @return mixed
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:178
⧉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.
*
* @return \Drupal\Core\Extension\Extension[]
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:190
⧉public getLogo(): string Returns the logo provided by the theme.
/**
* Returns the logo provided by the theme.
*
* @return string
* The logo path.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:200
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:212
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:232
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
⧉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 <ROOT>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:49
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:113
⧉public getLockId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:121
⧉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 <ROOT>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:61
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:266
⧉public driver()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:272
⧉public version() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:279
⧉public isMariaDb(): bool Determines whether the MySQL distribution is MariaDB or not.
/**
* Determines whether the MySQL distribution is MariaDB or not.
*
* @return bool
* Returns TRUE if the distribution is MariaDB, or FALSE if not.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:293
⧉public databaseType()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:326
/**
* Overrides \Drupal\Core\Database\Connection::createDatabase().
*
* @param string $database
* The name of the database to create.
*
* @throws \Drupal\Core\Database\DatabaseNotFoundException
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:338
⧉public mapConditionOperator($operator)
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:352
⧉public nextId($existing_id0)
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:357
⧉public nextIdDelete()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:377
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:449
⧉public getConnectionOptions(): array Returns the connection information for this connection object.
/**
* Returns the connection information for this connection object.
*
* Note that Database::getConnectionInfo() is for requesting information
* about an arbitrary database connection that is defined. This method
* is for requesting the connection information of this specific
* open connection object.
*
* @return array
* An array of the connection information. The exact list of
* properties is driver-dependent.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:352
⧉public attachDatabase(string $database): void Allows the connection to access additional databases.
/**
* Allows the connection to access additional databases.
*
* Database systems usually group tables in 'databases' or 'schemas', that
* can be accessed with syntax like 'SELECT * FROM database.table'. Normally
* Drupal accesses tables in a single database/schema, but in some cases it
* may be necessary to access tables from other databases/schemas in the same
* database server. This method can be called to ensure that the additional
* database/schema is accessible.
*
* For MySQL, PostgreSQL and most other databases no action need to be taken
* to query data in another database or schema. For SQLite this is however
* necessary and the database driver for SQLite will override this method.
*
* @param string $database
* The database to be attached to the connection.
*
* @internal
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:375
⧉public getPrefix(): string Returns the prefix of the tables.
/**
* Returns the prefix of the tables.
*
* @return string $prefix
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:383
⧉public prefixTables($sql): string Appends a database prefix to all tables in a query.
/**
* Appends a database prefix to all tables in a query.
*
* Queries sent to Drupal should wrap all table names in curly brackets. This
* function searches for this syntax and adds Drupal's table prefix to all
* tables, allowing Drupal to coexist with other systems in the same database
* and/or schema if necessary.
*
* @param string $sql
* A string containing a partial or entire SQL query.
*
* @return string
* The properly-prefixed string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:416
⧉public quoteIdentifiers($sql): string Quotes all identifiers in a query.
/**
* Quotes all identifiers in a query.
*
* Queries sent to Drupal should wrap all unquoted identifiers in square
* brackets. This function searches for this syntax and replaces them with the
* database specific identifier. In ANSI SQL this a double quote.
*
* Note that :variable[] is used to denote array arguments but
* Connection::expandArguments() is always called first.
*
* @param string $sql
* A string containing a partial or entire SQL query.
*
* @return string
* The string containing a partial or entire SQL query with all identifiers
* quoted.
*
* @internal
* This method should only be called by database API code.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:440
⧉public tablePrefix($table = 'default') Find the prefix for a table.
/**
* Find the prefix for a table.
*
* This function is for when you want to know the prefix of a table. This
* is not used in prefixTables due to performance reasons.
*
* @param string $table
* (optional) The table to find the prefix for.
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0.
* Instead, you should just use Connection::getPrefix().
*
* @see https://www.drupal.org/node/3260849
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:458
⧉public getUnprefixedTablesMap(): array Gets a list of individually prefixed table names.
/**
* Gets a list of individually prefixed table names.
*
* @return array
* An array of un-prefixed table names, keyed by their fully qualified table
* names (i.e. prefix + table_name).
*
* @deprecated in drupal:10.0.0 and is removed from drupal:11.0.0. There is
* no replacement.
*
* @see https://www.drupal.org/node/3257198
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:475
⧉public getFullQualifiedTableName($table): string Get a fully qualified table name.
/**
* Get a fully qualified table name.
*
* @param string $table
* The name of the table in question.
*
* @return string
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:488
⧉public prepareStatement(string $query, array $options, bool $allow_row_count = false): Drupal\Core\Database\StatementInterface Returns a prepared statement given a SQL string.
/**
* Returns a prepared statement given a SQL string.
*
* This method caches prepared statements, reusing them when possible. It also
* prefixes tables names enclosed in curly braces and, optionally, quotes
* identifiers enclosed in square brackets.
*
* @param string $query
* The query string as SQL, with curly braces surrounding the table names,
* and square brackets surrounding identifiers.
* @param array $options
* An associative array of options to control how the query is run. See
* the documentation for self::defaultOptions() for details. The content of
* the 'pdo' key will be passed to the prepared statement.
* @param bool $allow_row_count
* (optional) A flag indicating if row count is allowed on the statement
* object. Defaults to FALSE.
*
* @return \Drupal\Core\Database\StatementInterface
* A prepared statement ready for its execute() method.
*
* @throws \InvalidArgumentException
* If multiple statements are included in the string, and delimiters are
* not allowed in the query.
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:520
⧉public setTarget($target = null) Tells this connection object what its target value is.
/**
* Tells this connection object what its target value is.
*
* This is needed for logging and auditing. It's sloppy to do in the
* constructor because the constructor for child classes has a different
* signature. We therefore also ensure that this function is only ever
* called once.
*
* @param string $target
* (optional) The target this connection is for.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:593
⧉public getTarget(): string|null Returns the target this connection is associated with.
/**
* Returns the target this connection is associated with.
*
* @return string|null
* The target string of this connection, or NULL if no target is set.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:605
⧉public setKey($key) Tells this connection object what its key is.
/**
* Tells this connection object what its key is.
*
* @param string $key
* The key this connection is for.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:615
⧉public getKey(): string|null Returns the key this connection is associated with.
/**
* Returns the key this connection is associated with.
*
* @return string|null
* The key of this connection, or NULL if no key is set.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:627
⧉public setLogger(Drupal\Core\Database\Log $logger) Associates a logging object with this connection.
/**
* Associates a logging object with this connection.
*
* @param \Drupal\Core\Database\Log $logger
* The logging object we want to use.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:637
⧉public getLogger(): \Drupal\Core\Database\Log|null Gets the current logging object for this connection.
/**
* Gets the current logging object for this connection.
*
* @return \Drupal\Core\Database\Log|null
* The current logging object for this connection. If there isn't one,
* NULL is returned.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:648
⧉public makeSequenceName($table, $field): string Creates the appropriate sequence name for a given table and serial field.
/**
* Creates the appropriate sequence name for a given table and serial field.
*
* This information is exposed to all database drivers, although it is only
* useful on some of them. This method is table prefix-aware.
*
* Note that if a sequence was generated automatically by the database, its
* name might not match the one returned by this function. Therefore, in those
* cases, it is generally advised to use a database-specific way of retrieving
* the name of an auto-created sequence. For example, PostgreSQL provides a
* dedicated function for this purpose: pg_get_serial_sequence().
*
* @param string $table
* The table name to use for the sequence.
* @param string $field
* The field name to use for the sequence.
*
* @return string
* A table prefix-parsed string for the sequence name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:672
⧉public makeComment($comments): string Flatten an array of query comments into a single comment string.
/**
* Flatten an array of query comments into a single comment string.
*
* The comment string will be sanitized to avoid SQL injection attacks.
*
* @param string[] $comments
* An array of query comment strings.
*
* @return string
* A sanitized comment string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:690
⧉public query($query, array $args = array(), $options = array()): \Drupal\Core\Database\StatementInterface|int|string|null Executes a query string against the database.
/**
* Executes a query string against the database.
*
* This method provides a central handler for the actual execution of every
* query. All queries executed by Drupal are executed as prepared statements.
*
* @param string $query
* The query to execute. This is a string containing an SQL query with
* placeholders.
* @param array $args
* The associative array of arguments for the prepared statement.
* @param array $options
* An associative array of options to control how the query is run. The
* given options will be merged with self::defaultOptions(). See the
* documentation for self::defaultOptions() for details.
* Typically, $options['return'] will be set by a default or by a query
* builder, and should not be set by a user.
*
* @return \Drupal\Core\Database\StatementInterface|int|string|null
* This method will return one of the following:
* - If either $options['return'] === self::RETURN_STATEMENT, or
* $options['return'] is not set (due to self::defaultOptions()),
* returns the executed statement.
* - If $options['return'] === self::RETURN_AFFECTED,
* returns the number of rows matched by the query
* (not the number affected).
* - If $options['return'] === self::RETURN_INSERT_ID,
* returns the generated insert ID of the last query as a string.
* - If $options['return'] === self::RETURN_NULL, returns NULL.
*
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
* @throws \Drupal\Core\Database\IntegrityConstraintViolationException
* @throws \InvalidArgumentException
*
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:774
⧉public getDriverClass($class): string Gets the driver-specific override class if any for the specified class.
/**
* Gets the driver-specific override class if any for the specified class.
*
* @param string $class
* The class for which we want the potentially driver-specific class.
*
* @return string
* The name of the class that should be used for this driver.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:901
⧉public exceptionHandler(): \Drupal\Core\Database\ExceptionHandler Returns the database exceptions handler.
/**
* Returns the database exceptions handler.
*
* @return \Drupal\Core\Database\ExceptionHandler
* The database exceptions handler.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:967
⧉public select($table, $alias = null, array $options = array()): \Drupal\Core\Database\Query\SelectInterface Prepares and returns a SELECT query object.
/**
* Prepares and returns a SELECT query object.
*
* @param string|\Drupal\Core\Database\Query\SelectInterface $table
* The base table name or subquery for this query, used in the FROM clause.
* If a string, the table specified will also be used as the "base" table
* for query_alter hook implementations.
* @param string $alias
* (optional) The alias of the base table of this query.
* @param $options
* An array of options on the query.
*
* @return \Drupal\Core\Database\Query\SelectInterface
* An appropriate SelectQuery object for this database connection. Note that
* it may be a driver-specific subclass of SelectQuery, depending on the
* driver.
*
* @see \Drupal\Core\Database\Query\Select
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:991
⧉public insert($table, array $options = array()): \Drupal\Core\Database\Query\Insert Prepares and returns an INSERT query object.
/**
* Prepares and returns an INSERT query object.
*
* @param string $table
* The table to use for the insert statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Insert
* A new Insert query object.
*
* @see \Drupal\Core\Database\Query\Insert
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1013
⧉public lastInsertId(?string $name = null): string Returns the ID of the last inserted row or sequence value.
/**
* Returns the ID of the last inserted row or sequence value.
*
* This method should normally be used only within database driver code.
*
* This is a proxy to invoke lastInsertId() from the wrapped connection.
* If a sequence name is not specified for the name parameter, this returns a
* string representing the row ID of the last row that was inserted into the
* database.
* If a sequence name is specified for the name parameter, this returns a
* string representing the last value retrieved from the specified sequence
* object.
*
* @param string|null $name
* (Optional) Name of the sequence object from which the ID should be
* returned.
*
* @return string
* The value returned by the wrapped connection.
*
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
* In case of failure.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1041
⧉public merge($table, array $options = array()): \Drupal\Core\Database\Query\Merge Prepares and returns a MERGE query object.
/**
* Prepares and returns a MERGE query object.
*
* @param string $table
* The table to use for the merge statement.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Merge
* A new Merge query object.
*
* @see \Drupal\Core\Database\Query\Merge
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1061
⧉public upsert($table, array $options = array()): \Drupal\Core\Database\Query\Upsert Prepares and returns an UPSERT query object.
/**
* Prepares and returns an UPSERT query object.
*
* @param string $table
* The table to use for the upsert query.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Upsert
* A new Upsert query object.
*
* @see \Drupal\Core\Database\Query\Upsert
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1079
⧉public update($table, array $options = array()): \Drupal\Core\Database\Query\Update Prepares and returns an UPDATE query object.
/**
* Prepares and returns an UPDATE query object.
*
* @param string $table
* The table to use for the update statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Update
* A new Update query object.
*
* @see \Drupal\Core\Database\Query\Update
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1100
⧉public delete($table, array $options = array()): \Drupal\Core\Database\Query\Delete Prepares and returns a DELETE query object.
/**
* Prepares and returns a DELETE query object.
*
* @param string $table
* The table to use for the delete statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Delete
* A new Delete query object.
*
* @see \Drupal\Core\Database\Query\Delete
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1121
⧉public truncate($table, array $options = array()): \Drupal\Core\Database\Query\Truncate Prepares and returns a TRUNCATE query object.
/**
* Prepares and returns a TRUNCATE query object.
*
* @param string $table
* The table to use for the truncate statement.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Truncate
* A new Truncate query object.
*
* @see \Drupal\Core\Database\Query\Truncate
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1139
⧉public schema(): \Drupal\Core\Database\Schema Returns a DatabaseSchema object for manipulating the schema.
/**
* Returns a DatabaseSchema object for manipulating the schema.
*
* This method will lazy-load the appropriate schema library file.
*
* @return \Drupal\Core\Database\Schema
* The database Schema object for this connection.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1152
⧉public condition($conjunction): \Drupal\Core\Database\Query\Condition Prepares and returns a CONDITION query object.
/**
* Prepares and returns a CONDITION query object.
*
* @param string $conjunction
* The operator to use to combine conditions: 'AND' or 'OR'.
*
* @return \Drupal\Core\Database\Query\Condition
* A new Condition query object.
*
* @see \Drupal\Core\Database\Query\Condition
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1171
⧉public escapeDatabase($database): string Escapes a database name string.
/**
* Escapes a database name string.
*
* Force all database names to be strictly alphanumeric-plus-underscore.
* For some database drivers, it may also wrap the database name in
* database-specific escape characters.
*
* @param string $database
* An unsanitized database name.
*
* @return string
* The sanitized database name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1192
⧉public escapeTable($table): string Escapes a table name string.
/**
* Escapes a table name string.
*
* Force all table names to be strictly alphanumeric-plus-underscore.
* Database drivers should never wrap the table name in database-specific
* escape characters. This is done in Connection::prefixTables(). The
* database-specific escape characters are added in Connection::setPrefix().
*
* @param string $table
* An unsanitized table name.
*
* @return string
* The sanitized table name.
*
* @see \Drupal\Core\Database\Connection::prefixTables()
* @see \Drupal\Core\Database\Connection::setPrefix()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1215
⧉public escapeField($field): string Escapes a field name string.
/**
* Escapes a field name string.
*
* Force all field names to be strictly alphanumeric-plus-underscore.
* For some database drivers, it may also wrap the field name in
* database-specific escape characters.
*
* @param string $field
* An unsanitized field name.
*
* @return string
* The sanitized field name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1235
⧉public escapeAlias($field): string Escapes an alias name string.
/**
* Escapes an alias name string.
*
* Force all alias names to be strictly alphanumeric-plus-underscore. In
* contrast to DatabaseConnection::escapeField() /
* DatabaseConnection::escapeTable(), this doesn't allow the period (".")
* because that is not allowed in aliases.
*
* @param string $field
* An unsanitized alias name.
*
* @return string
* The sanitized alias name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1260
⧉public escapeLike($string): string Escapes characters that work as wildcard characters in a LIKE pattern.
/**
* Escapes characters that work as wildcard characters in a LIKE pattern.
*
* The wildcard characters "%" and "_" as well as backslash are prefixed with
* a backslash. Use this to do a search for a verbatim string without any
* wildcard behavior.
*
* For example, the following does a case-insensitive query for all rows whose
* name starts with $prefix:
* @code
* $result = $injected_connection->query(
* 'SELECT * FROM person WHERE name LIKE :pattern',
* array(':pattern' => $injected_connection->escapeLike($prefix) . '%')
* );
* @endcode
*
* Backslash is defined as escape character for LIKE patterns in
* Drupal\Core\Database\Query\Condition::mapConditionOperator().
*
* @param string $string
* The string to escape.
*
* @return string
* The escaped string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1293
⧉public inTransaction(): bool Determines if there is an active transaction open.
/**
* Determines if there is an active transaction open.
*
* @return bool
* TRUE if we're currently in a transaction, FALSE otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1303
⧉public transactionDepth(): int Determines the current transaction depth.
/**
* Determines the current transaction depth.
*
* @return int
* The current transaction depth.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1313
⧉public startTransaction($name = ''): \Drupal\Core\Database\Transaction Returns a new DatabaseTransaction object on this connection.
/**
* Returns a new DatabaseTransaction object on this connection.
*
* @param string $name
* (optional) The name of the savepoint.
*
* @return \Drupal\Core\Database\Transaction
* A Transaction object.
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1328
⧉public pushTransaction($name) Increases the depth of transaction nesting.
/**
* Increases the depth of transaction nesting.
*
* If no transaction is already active, we begin a new transaction.
*
* @param string $name
* The name of the transaction.
*
* @throws \Drupal\Core\Database\TransactionNameNonUniqueException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1406
⧉public popTransaction($name) Decreases the depth of transaction nesting.
/**
* Decreases the depth of transaction nesting.
*
* If we pop off the last transaction layer, then we either commit or roll
* back the transaction as necessary. If no transaction is active, we return
* because the transaction may have manually been rolled back.
*
* @param string $name
* The name of the savepoint.
*
* @throws \Drupal\Core\Database\TransactionNoActiveException
* @throws \Drupal\Core\Database\TransactionCommitFailedException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1436
⧉public addRootTransactionEndCallback(callable $callback) Adds a root transaction end callback.
/**
* Adds a root transaction end callback.
*
* These callbacks are invoked immediately after the transaction has been
* committed.
*
* It can for example be used to avoid deadlocks on write-heavy tables that
* do not need to be part of the transaction, like cache tag invalidations.
*
* Another use case is that services using alternative backends like Redis and
* Memcache cache implementations can replicate the transaction-behavior of
* the database cache backend and avoid race conditions.
*
* An argument is passed to the callbacks that indicates whether the
* transaction was successful or not.
*
* @param callable $callback
* The callback to invoke.
*
* @see \Drupal\Core\Database\Connection::doCommit()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1471
⧉public clientVersion(): string Returns the version of the database client.
/**
* Returns the version of the database client.
*
* Assumes the client connection is \PDO. Non-PDO based drivers need to
* override this method.
*
* @return string
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1581
⧉public supportsTransactionalDDL(): bool Determines if this driver supports transactional DDL.
/**
* Determines if this driver supports transactional DDL.
*
* DDL queries are those that change the schema, such as ALTER queries.
*
* @return bool
* TRUE if this connection supports transactions for DDL queries, FALSE
* otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1594
⧉public commit() Throws an exception to deny direct access to transaction commits.
/**
* Throws an exception to deny direct access to transaction commits.
*
* We do not want to allow users to commit transactions at any time, only
* by destroying the transaction object or allowing it to go out of scope.
* A direct commit bypasses all of the safety checks we've built on top of
* the database client's transaction routines.
*
* @throws \Drupal\Core\Database\TransactionExplicitCommitNotAllowedException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1646
⧉public quote($string, $parameter_type = 2): string|bool Quotes a string for use in a query.
/**
* Quotes a string for use in a query.
*
* @param string $string
* The string to be quoted.
* @param int $parameter_type
* (optional) Provides a data type hint for drivers that have alternate
* quoting styles. Defaults to \PDO::PARAM_STR.
*
* @return string|bool
* A quoted string that is theoretically safe to pass into an SQL statement.
* Returns FALSE if the driver does not support quoting in this way.
*
* @see \PDO::quote()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1684
⧉public __sleep() Prevents the database connection from being serialized.
/**
* Prevents the database connection from being serialized.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1711
⧉public getProvider(): string Get the module name of the module that is providing the database driver.
/**
* Get the module name of the module that is providing the database driver.
*
* @return string
* The module name of the module that is providing the database driver, or
* "core" when the driver is not provided as part of a module.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1841
⧉public getPagerManager(): Drupal\Core\Pager\PagerManagerInterface Get the pager manager service, if available.
/**
* Get the pager manager service, if available.
*
* @return \Drupal\Core\Pager\PagerManagerInterface
* The pager manager service, if available.
*
* @throws \Drupal\Core\DependencyInjection\ContainerNotInitializedException
* If the container has not been initialized yet.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1861
⧉public hasJson(): bool Runs a simple query to validate json datatype support.
/**
* Runs a simple query to validate json datatype support.
*
* @return bool
* Returns the query result.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1871
⧉public isEventEnabled(string $eventName): bool Returns the status of a database API event toggle.
/**
* Returns the status of a database API event toggle.
*
* @param string $eventName
* The name of the event to check.
*
* @return bool
* TRUE if the event is going to be fired by the database API, FALSE
* otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1890
⧉public enableEvents(array $eventNames): static Enables database API events dispatching.
/**
* Enables database API events dispatching.
*
* @param string[] $eventNames
* A list of database events to be enabled.
*
* @return static
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1902
⧉public disableEvents(array $eventNames): static Disables database API events dispatching.
/**
* Disables database API events dispatching.
*
* @param string[] $eventNames
* A list of database events to be disabled.
*
* @return static
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1918
⧉public dispatchEvent(Drupal\Core\Database\Event\DatabaseEvent $event, ?string $eventName = null): Drupal\Core\Database\Event\DatabaseEvent Dispatches a database API event via the container dispatcher.
/**
* Dispatches a database API event via the container dispatcher.
*
* @param \Drupal\Core\Database\Event\DatabaseEvent $event
* The database event.
* @param string|null $eventName
* (Optional) the name of the event to dispatch.
*
* @return \Drupal\Core\Database\Event\DatabaseEvent
* The database event.
*
* @throws \Drupal\Core\Database\Exception\EventException
* If the container is not initialized.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1940
⧉public findCallerFromDebugBacktrace(): array Determine the last non-database method that called the database API.
/**
* Determine the last non-database method that called the database API.
*
* Traversing the call stack from the very first call made during the
* request, we define "the routine that called this query" as the last entry
* in the call stack that is not any method called from the namespace of the
* database driver, is not inside the Drupal\Core\Database namespace and does
* have a file (which excludes call_user_func_array(), anonymous functions
* and similar). That makes the climbing logic very simple, and handles the
* variable stack depth caused by the query builders.
*
* See the @link http://php.net/debug_backtrace debug_backtrace() @endlink
* function.
*
* @return array
* This method returns a stack trace entry similar to that generated by
* debug_backtrace(). However, it flattens the trace entry and the trace
* entry before it so that we get the function and args of the function that
* called into the database system, not the function and args of the
* database call itself.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1968
⧉protected getMariaDbVersionMatch(): ?string Gets the MariaDB portion of the server version.
/**
* Gets the MariaDB portion of the server version.
*
* @return string
* The MariaDB portion of the server version if present, or NULL if not.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:303
⧉protected getServerVersion(): string Gets the server version.
/**
* Gets the server version.
*
* @return string
* The PDO server version.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:319
⧉protected popCommittableTransactions() Overridden to work around issues to MySQL not supporting transactional DDL.
/**
* Overridden to work around issues to MySQL not supporting transactional DDL.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:404
⧉protected doCommit() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:479
⧉protected defaultOptions(): array Returns the default query options for any given query.
/**
* Returns the default query options for any given query.
*
* A given query can be customized with a number of option flags in an
* associative array:
* - fetch: This element controls how rows from a result set will be
* returned. Legal values include \PDO::FETCH_ASSOC, \PDO::FETCH_BOTH,
* \PDO::FETCH_OBJ, \PDO::FETCH_NUM, or a string representing the name of a
* class. If a string is specified, each record will be fetched into a new
* object of that class. The behavior of all other values is defined by PDO.
* See http://php.net/manual/pdostatement.fetch.php
* - return: (deprecated) Depending on the type of query, different return
* values may be meaningful. This directive instructs the system which type
* of return value is desired. The system will generally set the correct
* value automatically, so it is extremely rare that a module developer will
* ever need to specify this value. Setting it incorrectly will likely lead
* to unpredictable results or fatal errors. Legal values include:
* - Database::RETURN_STATEMENT: Return the prepared statement object for
* the query. This is usually only meaningful for SELECT queries, where
* the statement object is how one accesses the result set returned by the
* query.
* - Database::RETURN_AFFECTED: Return the number of rows found (matched) by
* the WHERE clause of an UPDATE or DELETE query (not the number of rows
* actually changed). Note that although named RETURN_AFFECTED for
* historical reasons, the number of rows matched is returned for
* consistency across database engines.
* - Database::RETURN_INSERT_ID: Return the sequence ID (primary key)
* created by an INSERT statement on a table that contains a serial
* column.
* - Database::RETURN_NULL: Do not return anything, as there is no
* meaningful value to return. That is the case for INSERT queries on
* tables that do not contain a serial column.
* - allow_delimiter_in_query: By default, queries which have the ; delimiter
* any place in them will cause an exception. This reduces the chance of SQL
* injection attacks that terminate the original query and add one or more
* additional queries (such as inserting new user accounts). In rare cases,
* such as creating an SQL function, a ; is needed and can be allowed by
* changing this option to TRUE.
* - allow_square_brackets: By default, queries which contain square brackets
* will have them replaced with the identifier quote character for the
* database type. In rare cases, such as creating an SQL function, []
* characters might be needed and can be allowed by changing this option to
* TRUE.
* - pdo: By default, queries will execute with the client connection options
* set on the connection. In particular cases, it could be necessary to
* override the driver options on the statement level. In such case, pass
* the required setting as an array here, and they will be passed to the
* prepared statement.
*
* @return array
* An array of default query options.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:331
⧉protected setPrefix($prefix) Set the prefix used by this database connection.
/**
* Set the prefix used by this database connection.
*
* @param string $prefix
* A single prefix.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:393
⧉protected preprocessStatement(string $query, array $options): string Returns a string SQL statement ready for preparation.
/**
* Returns a string SQL statement ready for preparation.
*
* This method replaces table names in curly braces and identifiers in square
* brackets with platform specific replacements, appropriately escaping them
* and wrapping them with platform quote characters.
*
* @param string $query
* The query string as SQL, with curly braces surrounding the table names,
* and square brackets surrounding identifiers.
* @param array $options
* An associative array of options to control how the query is run. See
* the documentation for self::defaultOptions() for details.
*
* @return string
* A string SQL statement ready for preparation.
*
* @throws \InvalidArgumentException
* If multiple statements are included in the string, and delimiters are
* not allowed in the query.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:557
⧉protected filterComment($comment = ''): string Sanitize a query comment string.
/**
* Sanitize a query comment string.
*
* Ensure a query comment does not include strings such as "* /" that might
* terminate the comment early. This avoids SQL injection attacks via the
* query comment. The comment strings in this example are separated by a
* space to avoid PHP parse errors.
*
* For example, the comment:
* @code
* \Drupal::database()->update('example')
* ->condition('id', $id)
* ->fields(array('field2' => 10))
* ->comment('Exploit * / DROP TABLE node; --')
* ->execute()
* @endcode
*
* Would result in the following SQL statement being generated:
* @code
* "/ * Exploit * / DROP TABLE node. -- * / UPDATE example SET field2=..."
* @endcode
*
* Unless the comment is sanitized first, the SQL server would drop the
* node table and ignore the rest of the SQL statement.
*
* @param string $comment
* A query comment string.
*
* @return string
* A sanitized version of the query comment string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:733
⧉protected expandArguments(&$query, &$args): bool Expands out shorthand placeholders.
/**
* Expands out shorthand placeholders.
*
* Drupal supports an alternate syntax for doing arrays of values. We
* therefore need to expand them out into a full, executable query string.
*
* @param string $query
* The query string to modify.
* @param array $args
* The arguments for the query.
*
* @return bool
* TRUE if the query was modified, FALSE otherwise.
*
* @throws \InvalidArgumentException
* This exception is thrown when:
* - A placeholder that ends in [] is supplied, and the supplied value is
* not an array.
* - A placeholder that does not end in [] is supplied, and the supplied
* value is an array.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:847
⧉protected getDebugBacktrace(): array Gets the debug backtrace.
/**
* Gets the debug backtrace.
*
* Wraps the debug_backtrace function to allow mocking results in PHPUnit
* tests.
*
* @return array[]
* The debug backtrace.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:2024
/**
* Creates an array of database connection options from a URL.
*
* @param string $url
* The URL.
* @param string $root
* The root directory of the Drupal installation. Some database drivers,
* like for example SQLite, need this information.
*
* @return array
* The connection options.
*
* @throws \InvalidArgumentException
* Exception thrown when the provided URL does not meet the minimum
* requirements.
*
* @internal
* This method should only be called from
* \Drupal\Core\Database\Database::convertDbUrlToConnectionInfo().
*
* @see \Drupal\Core\Database\Database::convertDbUrlToConnectionInfo()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1737
⇄⧉public static createUrlFromConnectionOptions(array $connection_options): string Creates a URL from an array of database connection options.
/**
* Creates a URL from an array of database connection options.
*
* @param array $connection_options
* The array of connection options for a database connection. An additional
* key of 'module' is added by Database::getConnectionInfoAsUrl() for
* drivers provided my contributed or custom modules for convenience.
*
* @return string
* The connection info as a URL.
*
* @throws \InvalidArgumentException
* Exception thrown when the provided array of connection options does not
* meet the minimum requirements.
*
* @internal
* This method should only be called from
* \Drupal\Core\Database\Database::getConnectionInfoAsUrl().
*
* @see \Drupal\Core\Database\Database::getConnectionInfoAsUrl()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1798
⇄⧉public static removeDatabaseEntriesFromDebugBacktrace(array $backtrace, string $driver_namespace): array Removes database related calls from a backtrace array.
/**
* Removes database related calls from a backtrace array.
*
* @param array $backtrace
* A standard PHP backtrace. Passed by reference.
* @param string $driver_namespace
* The PHP namespace of the database driver.
*
* @return array
* The cleaned backtrace array.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1999
⧉protected static getSQLState(Exception $e): string Extracts the SQLSTATE error from a PDOException.
/**
* Extracts the SQLSTATE error from a PDOException.
*
* @param \Exception $e
* The exception
*
* @return string
* The five character error code.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1697
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:28
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:43
/**
* Implements \Drupal\Core\Cache\CacheTagsInvalidatorInterface::invalidateTags()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:53
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::getCurrentChecksum()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:83
⧉public schemaDefinition() Defines the schema for the {cachetags} table.
/**
* Defines the schema for the {cachetags} table.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:97
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::isValid()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:105
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:58
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:75
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:128
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
⧉public __construct($root, array $module_list, Drupal\Core\Cache\CacheBackendInterface $cache_backend) Constructs a ModuleHandler object.
/**
* Constructs a ModuleHandler object.
*
* @param string $root
* The app root.
* @param array $module_list
* An associative array whose keys are the names of installed modules and
* whose values are Extension class parameters. This is normally the
* %container.modules% parameter being set up by DrupalKernel.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend for storing module hook implementation information.
*
* @see \Drupal\Core\DrupalKernel
* @see \Drupal\Core\CoreServiceProvider
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:110
⧉public load($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:122
⧉public loadAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:138
⧉public reload() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:150
⧉public isLoaded() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:158
⧉public getModuleList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:165
⧉public getModule($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:172
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:708
⧉public getName($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:719
⧉protected add($type, $name, $path) Adds a module or profile to the list of currently active modules.
/**
* Adds a module or profile to the list of currently active modules.
*
* @param string $type
* The extension type; either 'module' or 'profile'.
* @param string $name
* The module name; e.g., 'node'.
* @param string $path
* The module path; e.g., 'core/modules/node'.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:213
/**
* Builds hook_hook_info() information.
*
* @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:308
⧉protected getImplementationInfo($hook): mixed[] Provides information about modules' implementations of a hook.
/**
* Provides information about modules' implementations of a hook.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:583
⧉protected buildImplementationInfo($hook): mixed[] Builds hook implementation information for a given hook name.
/**
* Builds hook implementation information for a given hook name.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*
* @throws \RuntimeException
* Exception thrown when an invalid implementation is added by
* hook_module_implements_alter().
*
* @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:629
⧉protected verifyImplementations(&$implementations, $hook): bool Verifies an array of implementations loaded from cache.
/**
* Verifies an array of implementations loaded from cache.
*
* Verification is done by including the lazy-loaded $module.$group.inc file,
* and checking function_exists().
*
* @param string[] $implementations
* Implementation "group" by module name.
* @param string $hook
* The hook name.
*
* @return bool
* TRUE, if all implementations exist.
* FALSE, if one or more implementations don't exist and need to be removed
* from the cache.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:680
⧉private triggerDeprecationError($description, $hook) Triggers an E_USER_DEPRECATED error if any module implements the hook.
/**
* Triggers an E_USER_DEPRECATED error if any module implements the hook.
*
* @param string $description
* Helpful text describing what to do instead of implementing this hook.
* @param string $hook
* The name of the hook.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:446
/**
* 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 <ROOT>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:51
⧉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 <ROOT>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:86
⧉public has($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:96
⧉public get($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:107
/**
* 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().
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:162
⧉public delete($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:174
⧉public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:303
⧉public clear() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:313
⧉public destruct() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:326
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:136
⧉protected getCid(): string Gets the cache ID.
/**
* Gets the cache ID.
*
* @return string
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:127
⧉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 unflagged so
* that it will not be written at the end of the request.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:193
⧉protected normalizeLockName($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.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:285
⧉protected lazyLoadCache() Loads the cache if not already done.
/**
* Loads the cache if not already done.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:333
⧉protected invalidateCache() Invalidate the cache.
/**
* Invalidate the cache.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheCollector.php:349
/**
* Constructs the Config factory.
*
* @param \Drupal\Core\Config\StorageInterface $storage
* The configuration storage engine.
* @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $event_dispatcher
* An event dispatcher instance to use for configuration events.
* @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config
* The typed configuration manager.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:72
⧉public getEditable($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:81
⧉public get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:88
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:327
⧉public onConfigSave(Drupal\Core\Config\ConfigCrudEvent $event) Updates stale static cache entries when configuration is saved.
/**
* Updates stale static cache entries when configuration is saved.
*
* @param ConfigCrudEvent $event
* The configuration event.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:337
⧉public onConfigDelete(Drupal\Core\Config\ConfigCrudEvent $event) Removes stale static cache entries when configuration is deleted.
/**
* Removes stale static cache entries when configuration is deleted.
*
* @param \Drupal\Core\Config\ConfigCrudEvent $event
* The configuration event.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:366
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:394
⧉protected doGet($name, $immutable = true): \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig Returns a configuration object for a given name.
/**
* Returns a configuration object for a given name.
*
* @param string $name
* The name of the configuration object to construct.
* @param bool $immutable
* (optional) Create an immutable configuration object. Defaults to TRUE.
*
* @return \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig
* A configuration object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:103
⧉protected doLoadMultiple(array $names, $immutable = true): \Drupal\Core\Config\Config[]|\Drupal\Core\Config\ImmutableConfig[] Returns a list of configuration objects for the given names.
/**
* Returns a list of configuration objects for the given names.
*
* @param array $names
* List of names of configuration objects.
* @param bool $immutable
* (optional) Create an immutable configuration objects. Defaults to TRUE.
*
* @return \Drupal\Core\Config\Config[]|\Drupal\Core\Config\ImmutableConfig[]
* List of successfully loaded configuration objects, keyed by name.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:150
⧉protected loadOverrides(array $names): array Get arbitrary overrides for the named configuration objects from modules.
/**
* Get arbitrary overrides for the named configuration objects from modules.
*
* @param array $names
* The names of the configuration objects to get overrides for.
*
* @return array
* An array of overrides keyed by the configuration object name.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:204
⧉protected propagateConfigOverrideCacheability($cache_key, $name) Propagates cacheability of config overrides to cached config objects.
/**
* Propagates cacheability of config overrides to cached config objects.
*
* @param string $cache_key
* The key of the cached config object to update.
* @param string $name
* The name of the configuration object to construct.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:222
⧉protected getConfigCacheKey($name, $immutable): string Gets the static cache key for a given config name.
/**
* Gets the static cache key for a given config name.
*
* @param string $name
* The name of the configuration object.
* @param bool $immutable
* Whether or not the object is mutable.
*
* @return string
* The cache key.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:291
⧉protected getConfigCacheKeys($name): array Gets all the cache keys that match the provided config name.
/**
* Gets all the cache keys that match the provided config name.
*
* @param string $name
* The name of the configuration object.
*
* @return array
* An array of cache keys that match the provided config name.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:308
⧉protected createConfigObject($name, $immutable): \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig Creates a configuration object.
/**
* Creates a configuration object.
*
* @param string $name
* Configuration object name.
* @param bool $immutable
* Determines whether a mutable or immutable config object is returned.
*
* @return \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig
* The configuration object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:409
/**
* 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 <ROOT>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:101
⧉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.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:214
⧉public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:304
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:242
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:259
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:274
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:341
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:359
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:393
⧉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[]
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:414
⧉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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:583
⧉protected doList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:172
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:232
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:293
⧉protected getExtensionDiscovery(): \Drupal\Core\Extension\ExtensionDiscovery Returns the extension discovery.
/**
* Returns the extension discovery.
*
* @return \Drupal\Core\Extension\ExtensionDiscovery
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:150
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:191
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:201
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:211
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:297
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:403
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:439
⇄⧉public static 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.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:600
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ThemeHandler.php:51
⧉public getDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ThemeHandler.php:60
⧉public listInfo() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ThemeHandler.php:67
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ThemeHandler.php:51
⧉public getDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ThemeHandler.php:60
⧉public listInfo() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ThemeHandler.php:67
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
⧉public __construct($root, array $module_list, Drupal\Core\Cache\CacheBackendInterface $cache_backend) Constructs a ModuleHandler object.
/**
* Constructs a ModuleHandler object.
*
* @param string $root
* The app root.
* @param array $module_list
* An associative array whose keys are the names of installed modules and
* whose values are Extension class parameters. This is normally the
* %container.modules% parameter being set up by DrupalKernel.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend for storing module hook implementation information.
*
* @see \Drupal\Core\DrupalKernel
* @see \Drupal\Core\CoreServiceProvider
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:110
⧉public load($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:122
⧉public loadAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:138
⧉public reload() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:150
⧉public isLoaded() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:158
⧉public getModuleList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:165
⧉public getModule($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:172
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:708
⧉public getName($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:719
⧉protected add($type, $name, $path) Adds a module or profile to the list of currently active modules.
/**
* Adds a module or profile to the list of currently active modules.
*
* @param string $type
* The extension type; either 'module' or 'profile'.
* @param string $name
* The module name; e.g., 'node'.
* @param string $path
* The module path; e.g., 'core/modules/node'.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:213
/**
* Builds hook_hook_info() information.
*
* @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:308
⧉protected getImplementationInfo($hook): mixed[] Provides information about modules' implementations of a hook.
/**
* Provides information about modules' implementations of a hook.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:583
⧉protected buildImplementationInfo($hook): mixed[] Builds hook implementation information for a given hook name.
/**
* Builds hook implementation information for a given hook name.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*
* @throws \RuntimeException
* Exception thrown when an invalid implementation is added by
* hook_module_implements_alter().
*
* @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:629
⧉protected verifyImplementations(&$implementations, $hook): bool Verifies an array of implementations loaded from cache.
/**
* Verifies an array of implementations loaded from cache.
*
* Verification is done by including the lazy-loaded $module.$group.inc file,
* and checking function_exists().
*
* @param string[] $implementations
* Implementation "group" by module name.
* @param string $hook
* The hook name.
*
* @return bool
* TRUE, if all implementations exist.
* FALSE, if one or more implementations don't exist and need to be removed
* from the cache.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:680
⧉private triggerDeprecationError($description, $hook) Triggers an E_USER_DEPRECATED error if any module implements the hook.
/**
* Triggers an E_USER_DEPRECATED error if any module implements the hook.
*
* @param string $description
* Helpful text describing what to do instead of implementing this hook.
* @param string $hook
* The name of the hook.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:446
⧉public __construct($root, Drupal\Core\Extension\ThemeHandlerInterface $theme_handler, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\ModuleHandlerInterface $module_handler) 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.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:62
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:160
⧉protected getExtensions(): array Gets all extensions.
/**
* Gets all extensions.
*
* @return array
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:266
⧉protected resolveStyleSheetPlaceholders($css_file): string Gets CSS file where tokens have been resolved.
/**
* Gets CSS file where tokens have been resolved.
*
* @param string $css_file
* CSS file which may contain tokens.
*
* @return string
* CSS file where placeholders are replaced.
*
* @todo Remove in Drupal 9.0.x.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:284
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/ThemeNegotiator.php:47
⧉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 <ROOT>/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
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:131
⧉public getPath(): string Returns the path to the theme directory.
/**
* Returns the path to the theme directory.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:140
⧉public getEngine(): string Returns the theme engine.
/**
* Returns the theme engine.
*
* @return string
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:149
⧉public getOwner(): mixed Returns the path to the theme engine for root themes.
/**
* Returns the path to the theme engine for root themes.
*
* @see \Drupal\Core\Extension\ThemeExtensionList::doList()
*
* @return mixed
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:160
⧉public getExtension(): \Drupal\Core\Extension\Extension Returns the extension object.
/**
* Returns the extension object.
*
* @return \Drupal\Core\Extension\Extension
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:169
⧉public getLibraries(): mixed Returns the libraries provided by the theme.
/**
* Returns the libraries provided by the theme.
*
* @return mixed
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:178
⧉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.
*
* @return \Drupal\Core\Extension\Extension[]
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:190
⧉public getLogo(): string Returns the logo provided by the theme.
/**
* Returns the logo provided by the theme.
*
* @return string
* The logo path.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:200
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:212
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/ActiveTheme.php:232
⧉public __construct($root, Drupal\Core\Extension\ThemeHandlerInterface $theme_handler, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\ModuleHandlerInterface $module_handler) 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.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:62
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:160
⧉protected getExtensions(): array Gets all extensions.
/**
* Gets all extensions.
*
* @return array
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:266
⧉protected resolveStyleSheetPlaceholders($css_file): string Gets CSS file where tokens have been resolved.
/**
* Gets CSS file where tokens have been resolved.
*
* @param string $css_file
* CSS file which may contain tokens.
*
* @return string
* CSS file where placeholders are replaced.
*
* @todo Remove in Drupal 9.0.x.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:284
⧉public __construct($root, array $module_list, Drupal\Core\Cache\CacheBackendInterface $cache_backend) Constructs a ModuleHandler object.
/**
* Constructs a ModuleHandler object.
*
* @param string $root
* The app root.
* @param array $module_list
* An associative array whose keys are the names of installed modules and
* whose values are Extension class parameters. This is normally the
* %container.modules% parameter being set up by DrupalKernel.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend for storing module hook implementation information.
*
* @see \Drupal\Core\DrupalKernel
* @see \Drupal\Core\CoreServiceProvider
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:110
⧉public load($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:122
⧉public loadAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:138
⧉public reload() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:150
⧉public isLoaded() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:158
⧉public getModuleList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:165
⧉public getModule($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:172
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:708
⧉public getName($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:719
⧉protected add($type, $name, $path) Adds a module or profile to the list of currently active modules.
/**
* Adds a module or profile to the list of currently active modules.
*
* @param string $type
* The extension type; either 'module' or 'profile'.
* @param string $name
* The module name; e.g., 'node'.
* @param string $path
* The module path; e.g., 'core/modules/node'.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:213
/**
* Builds hook_hook_info() information.
*
* @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:308
⧉protected getImplementationInfo($hook): mixed[] Provides information about modules' implementations of a hook.
/**
* Provides information about modules' implementations of a hook.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:583
⧉protected buildImplementationInfo($hook): mixed[] Builds hook implementation information for a given hook name.
/**
* Builds hook implementation information for a given hook name.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*
* @throws \RuntimeException
* Exception thrown when an invalid implementation is added by
* hook_module_implements_alter().
*
* @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:629
⧉protected verifyImplementations(&$implementations, $hook): bool Verifies an array of implementations loaded from cache.
/**
* Verifies an array of implementations loaded from cache.
*
* Verification is done by including the lazy-loaded $module.$group.inc file,
* and checking function_exists().
*
* @param string[] $implementations
* Implementation "group" by module name.
* @param string $hook
* The hook name.
*
* @return bool
* TRUE, if all implementations exist.
* FALSE, if one or more implementations don't exist and need to be removed
* from the cache.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:680
⧉private triggerDeprecationError($description, $hook) Triggers an E_USER_DEPRECATED error if any module implements the hook.
/**
* Triggers an E_USER_DEPRECATED error if any module implements the hook.
*
* @param string $description
* Helpful text describing what to do instead of implementing this hook.
* @param string $hook
* The name of the hook.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:446
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/ThemeManager.php:442
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/ThemeManager.php:382
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:266
⧉public driver()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:272
⧉public version() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:279
⧉public isMariaDb(): bool Determines whether the MySQL distribution is MariaDB or not.
/**
* Determines whether the MySQL distribution is MariaDB or not.
*
* @return bool
* Returns TRUE if the distribution is MariaDB, or FALSE if not.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:293
⧉public databaseType()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:326
/**
* Overrides \Drupal\Core\Database\Connection::createDatabase().
*
* @param string $database
* The name of the database to create.
*
* @throws \Drupal\Core\Database\DatabaseNotFoundException
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:338
⧉public mapConditionOperator($operator)
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:352
⧉public nextId($existing_id0)
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:357
⧉public nextIdDelete()
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:377
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:449
⧉public getConnectionOptions(): array Returns the connection information for this connection object.
/**
* Returns the connection information for this connection object.
*
* Note that Database::getConnectionInfo() is for requesting information
* about an arbitrary database connection that is defined. This method
* is for requesting the connection information of this specific
* open connection object.
*
* @return array
* An array of the connection information. The exact list of
* properties is driver-dependent.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:352
⧉public attachDatabase(string $database): void Allows the connection to access additional databases.
/**
* Allows the connection to access additional databases.
*
* Database systems usually group tables in 'databases' or 'schemas', that
* can be accessed with syntax like 'SELECT * FROM database.table'. Normally
* Drupal accesses tables in a single database/schema, but in some cases it
* may be necessary to access tables from other databases/schemas in the same
* database server. This method can be called to ensure that the additional
* database/schema is accessible.
*
* For MySQL, PostgreSQL and most other databases no action need to be taken
* to query data in another database or schema. For SQLite this is however
* necessary and the database driver for SQLite will override this method.
*
* @param string $database
* The database to be attached to the connection.
*
* @internal
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:375
⧉public getPrefix(): string Returns the prefix of the tables.
/**
* Returns the prefix of the tables.
*
* @return string $prefix
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:383
⧉public prefixTables($sql): string Appends a database prefix to all tables in a query.
/**
* Appends a database prefix to all tables in a query.
*
* Queries sent to Drupal should wrap all table names in curly brackets. This
* function searches for this syntax and adds Drupal's table prefix to all
* tables, allowing Drupal to coexist with other systems in the same database
* and/or schema if necessary.
*
* @param string $sql
* A string containing a partial or entire SQL query.
*
* @return string
* The properly-prefixed string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:416
⧉public quoteIdentifiers($sql): string Quotes all identifiers in a query.
/**
* Quotes all identifiers in a query.
*
* Queries sent to Drupal should wrap all unquoted identifiers in square
* brackets. This function searches for this syntax and replaces them with the
* database specific identifier. In ANSI SQL this a double quote.
*
* Note that :variable[] is used to denote array arguments but
* Connection::expandArguments() is always called first.
*
* @param string $sql
* A string containing a partial or entire SQL query.
*
* @return string
* The string containing a partial or entire SQL query with all identifiers
* quoted.
*
* @internal
* This method should only be called by database API code.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:440
⧉public tablePrefix($table = 'default') Find the prefix for a table.
/**
* Find the prefix for a table.
*
* This function is for when you want to know the prefix of a table. This
* is not used in prefixTables due to performance reasons.
*
* @param string $table
* (optional) The table to find the prefix for.
*
* @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0.
* Instead, you should just use Connection::getPrefix().
*
* @see https://www.drupal.org/node/3260849
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:458
⧉public getUnprefixedTablesMap(): array Gets a list of individually prefixed table names.
/**
* Gets a list of individually prefixed table names.
*
* @return array
* An array of un-prefixed table names, keyed by their fully qualified table
* names (i.e. prefix + table_name).
*
* @deprecated in drupal:10.0.0 and is removed from drupal:11.0.0. There is
* no replacement.
*
* @see https://www.drupal.org/node/3257198
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:475
⧉public getFullQualifiedTableName($table): string Get a fully qualified table name.
/**
* Get a fully qualified table name.
*
* @param string $table
* The name of the table in question.
*
* @return string
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:488
⧉public prepareStatement(string $query, array $options, bool $allow_row_count = false): Drupal\Core\Database\StatementInterface Returns a prepared statement given a SQL string.
/**
* Returns a prepared statement given a SQL string.
*
* This method caches prepared statements, reusing them when possible. It also
* prefixes tables names enclosed in curly braces and, optionally, quotes
* identifiers enclosed in square brackets.
*
* @param string $query
* The query string as SQL, with curly braces surrounding the table names,
* and square brackets surrounding identifiers.
* @param array $options
* An associative array of options to control how the query is run. See
* the documentation for self::defaultOptions() for details. The content of
* the 'pdo' key will be passed to the prepared statement.
* @param bool $allow_row_count
* (optional) A flag indicating if row count is allowed on the statement
* object. Defaults to FALSE.
*
* @return \Drupal\Core\Database\StatementInterface
* A prepared statement ready for its execute() method.
*
* @throws \InvalidArgumentException
* If multiple statements are included in the string, and delimiters are
* not allowed in the query.
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:520
⧉public setTarget($target = null) Tells this connection object what its target value is.
/**
* Tells this connection object what its target value is.
*
* This is needed for logging and auditing. It's sloppy to do in the
* constructor because the constructor for child classes has a different
* signature. We therefore also ensure that this function is only ever
* called once.
*
* @param string $target
* (optional) The target this connection is for.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:593
⧉public getTarget(): string|null Returns the target this connection is associated with.
/**
* Returns the target this connection is associated with.
*
* @return string|null
* The target string of this connection, or NULL if no target is set.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:605
⧉public setKey($key) Tells this connection object what its key is.
/**
* Tells this connection object what its key is.
*
* @param string $key
* The key this connection is for.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:615
⧉public getKey(): string|null Returns the key this connection is associated with.
/**
* Returns the key this connection is associated with.
*
* @return string|null
* The key of this connection, or NULL if no key is set.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:627
⧉public setLogger(Drupal\Core\Database\Log $logger) Associates a logging object with this connection.
/**
* Associates a logging object with this connection.
*
* @param \Drupal\Core\Database\Log $logger
* The logging object we want to use.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:637
⧉public getLogger(): \Drupal\Core\Database\Log|null Gets the current logging object for this connection.
/**
* Gets the current logging object for this connection.
*
* @return \Drupal\Core\Database\Log|null
* The current logging object for this connection. If there isn't one,
* NULL is returned.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:648
⧉public makeSequenceName($table, $field): string Creates the appropriate sequence name for a given table and serial field.
/**
* Creates the appropriate sequence name for a given table and serial field.
*
* This information is exposed to all database drivers, although it is only
* useful on some of them. This method is table prefix-aware.
*
* Note that if a sequence was generated automatically by the database, its
* name might not match the one returned by this function. Therefore, in those
* cases, it is generally advised to use a database-specific way of retrieving
* the name of an auto-created sequence. For example, PostgreSQL provides a
* dedicated function for this purpose: pg_get_serial_sequence().
*
* @param string $table
* The table name to use for the sequence.
* @param string $field
* The field name to use for the sequence.
*
* @return string
* A table prefix-parsed string for the sequence name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:672
⧉public makeComment($comments): string Flatten an array of query comments into a single comment string.
/**
* Flatten an array of query comments into a single comment string.
*
* The comment string will be sanitized to avoid SQL injection attacks.
*
* @param string[] $comments
* An array of query comment strings.
*
* @return string
* A sanitized comment string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:690
⧉public query($query, array $args = array(), $options = array()): \Drupal\Core\Database\StatementInterface|int|string|null Executes a query string against the database.
/**
* Executes a query string against the database.
*
* This method provides a central handler for the actual execution of every
* query. All queries executed by Drupal are executed as prepared statements.
*
* @param string $query
* The query to execute. This is a string containing an SQL query with
* placeholders.
* @param array $args
* The associative array of arguments for the prepared statement.
* @param array $options
* An associative array of options to control how the query is run. The
* given options will be merged with self::defaultOptions(). See the
* documentation for self::defaultOptions() for details.
* Typically, $options['return'] will be set by a default or by a query
* builder, and should not be set by a user.
*
* @return \Drupal\Core\Database\StatementInterface|int|string|null
* This method will return one of the following:
* - If either $options['return'] === self::RETURN_STATEMENT, or
* $options['return'] is not set (due to self::defaultOptions()),
* returns the executed statement.
* - If $options['return'] === self::RETURN_AFFECTED,
* returns the number of rows matched by the query
* (not the number affected).
* - If $options['return'] === self::RETURN_INSERT_ID,
* returns the generated insert ID of the last query as a string.
* - If $options['return'] === self::RETURN_NULL, returns NULL.
*
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
* @throws \Drupal\Core\Database\IntegrityConstraintViolationException
* @throws \InvalidArgumentException
*
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:774
⧉public getDriverClass($class): string Gets the driver-specific override class if any for the specified class.
/**
* Gets the driver-specific override class if any for the specified class.
*
* @param string $class
* The class for which we want the potentially driver-specific class.
*
* @return string
* The name of the class that should be used for this driver.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:901
⧉public exceptionHandler(): \Drupal\Core\Database\ExceptionHandler Returns the database exceptions handler.
/**
* Returns the database exceptions handler.
*
* @return \Drupal\Core\Database\ExceptionHandler
* The database exceptions handler.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:967
⧉public select($table, $alias = null, array $options = array()): \Drupal\Core\Database\Query\SelectInterface Prepares and returns a SELECT query object.
/**
* Prepares and returns a SELECT query object.
*
* @param string|\Drupal\Core\Database\Query\SelectInterface $table
* The base table name or subquery for this query, used in the FROM clause.
* If a string, the table specified will also be used as the "base" table
* for query_alter hook implementations.
* @param string $alias
* (optional) The alias of the base table of this query.
* @param $options
* An array of options on the query.
*
* @return \Drupal\Core\Database\Query\SelectInterface
* An appropriate SelectQuery object for this database connection. Note that
* it may be a driver-specific subclass of SelectQuery, depending on the
* driver.
*
* @see \Drupal\Core\Database\Query\Select
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:991
⧉public insert($table, array $options = array()): \Drupal\Core\Database\Query\Insert Prepares and returns an INSERT query object.
/**
* Prepares and returns an INSERT query object.
*
* @param string $table
* The table to use for the insert statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Insert
* A new Insert query object.
*
* @see \Drupal\Core\Database\Query\Insert
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1013
⧉public lastInsertId(?string $name = null): string Returns the ID of the last inserted row or sequence value.
/**
* Returns the ID of the last inserted row or sequence value.
*
* This method should normally be used only within database driver code.
*
* This is a proxy to invoke lastInsertId() from the wrapped connection.
* If a sequence name is not specified for the name parameter, this returns a
* string representing the row ID of the last row that was inserted into the
* database.
* If a sequence name is specified for the name parameter, this returns a
* string representing the last value retrieved from the specified sequence
* object.
*
* @param string|null $name
* (Optional) Name of the sequence object from which the ID should be
* returned.
*
* @return string
* The value returned by the wrapped connection.
*
* @throws \Drupal\Core\Database\DatabaseExceptionWrapper
* In case of failure.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1041
⧉public merge($table, array $options = array()): \Drupal\Core\Database\Query\Merge Prepares and returns a MERGE query object.
/**
* Prepares and returns a MERGE query object.
*
* @param string $table
* The table to use for the merge statement.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Merge
* A new Merge query object.
*
* @see \Drupal\Core\Database\Query\Merge
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1061
⧉public upsert($table, array $options = array()): \Drupal\Core\Database\Query\Upsert Prepares and returns an UPSERT query object.
/**
* Prepares and returns an UPSERT query object.
*
* @param string $table
* The table to use for the upsert query.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Upsert
* A new Upsert query object.
*
* @see \Drupal\Core\Database\Query\Upsert
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1079
⧉public update($table, array $options = array()): \Drupal\Core\Database\Query\Update Prepares and returns an UPDATE query object.
/**
* Prepares and returns an UPDATE query object.
*
* @param string $table
* The table to use for the update statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Update
* A new Update query object.
*
* @see \Drupal\Core\Database\Query\Update
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1100
⧉public delete($table, array $options = array()): \Drupal\Core\Database\Query\Delete Prepares and returns a DELETE query object.
/**
* Prepares and returns a DELETE query object.
*
* @param string $table
* The table to use for the delete statement.
* @param array $options
* (optional) An associative array of options to control how the query is
* run. The given options will be merged with
* \Drupal\Core\Database\Connection::defaultOptions().
*
* @return \Drupal\Core\Database\Query\Delete
* A new Delete query object.
*
* @see \Drupal\Core\Database\Query\Delete
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1121
⧉public truncate($table, array $options = array()): \Drupal\Core\Database\Query\Truncate Prepares and returns a TRUNCATE query object.
/**
* Prepares and returns a TRUNCATE query object.
*
* @param string $table
* The table to use for the truncate statement.
* @param array $options
* (optional) An array of options on the query.
*
* @return \Drupal\Core\Database\Query\Truncate
* A new Truncate query object.
*
* @see \Drupal\Core\Database\Query\Truncate
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1139
⧉public schema(): \Drupal\Core\Database\Schema Returns a DatabaseSchema object for manipulating the schema.
/**
* Returns a DatabaseSchema object for manipulating the schema.
*
* This method will lazy-load the appropriate schema library file.
*
* @return \Drupal\Core\Database\Schema
* The database Schema object for this connection.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1152
⧉public condition($conjunction): \Drupal\Core\Database\Query\Condition Prepares and returns a CONDITION query object.
/**
* Prepares and returns a CONDITION query object.
*
* @param string $conjunction
* The operator to use to combine conditions: 'AND' or 'OR'.
*
* @return \Drupal\Core\Database\Query\Condition
* A new Condition query object.
*
* @see \Drupal\Core\Database\Query\Condition
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1171
⧉public escapeDatabase($database): string Escapes a database name string.
/**
* Escapes a database name string.
*
* Force all database names to be strictly alphanumeric-plus-underscore.
* For some database drivers, it may also wrap the database name in
* database-specific escape characters.
*
* @param string $database
* An unsanitized database name.
*
* @return string
* The sanitized database name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1192
⧉public escapeTable($table): string Escapes a table name string.
/**
* Escapes a table name string.
*
* Force all table names to be strictly alphanumeric-plus-underscore.
* Database drivers should never wrap the table name in database-specific
* escape characters. This is done in Connection::prefixTables(). The
* database-specific escape characters are added in Connection::setPrefix().
*
* @param string $table
* An unsanitized table name.
*
* @return string
* The sanitized table name.
*
* @see \Drupal\Core\Database\Connection::prefixTables()
* @see \Drupal\Core\Database\Connection::setPrefix()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1215
⧉public escapeField($field): string Escapes a field name string.
/**
* Escapes a field name string.
*
* Force all field names to be strictly alphanumeric-plus-underscore.
* For some database drivers, it may also wrap the field name in
* database-specific escape characters.
*
* @param string $field
* An unsanitized field name.
*
* @return string
* The sanitized field name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1235
⧉public escapeAlias($field): string Escapes an alias name string.
/**
* Escapes an alias name string.
*
* Force all alias names to be strictly alphanumeric-plus-underscore. In
* contrast to DatabaseConnection::escapeField() /
* DatabaseConnection::escapeTable(), this doesn't allow the period (".")
* because that is not allowed in aliases.
*
* @param string $field
* An unsanitized alias name.
*
* @return string
* The sanitized alias name.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1260
⧉public escapeLike($string): string Escapes characters that work as wildcard characters in a LIKE pattern.
/**
* Escapes characters that work as wildcard characters in a LIKE pattern.
*
* The wildcard characters "%" and "_" as well as backslash are prefixed with
* a backslash. Use this to do a search for a verbatim string without any
* wildcard behavior.
*
* For example, the following does a case-insensitive query for all rows whose
* name starts with $prefix:
* @code
* $result = $injected_connection->query(
* 'SELECT * FROM person WHERE name LIKE :pattern',
* array(':pattern' => $injected_connection->escapeLike($prefix) . '%')
* );
* @endcode
*
* Backslash is defined as escape character for LIKE patterns in
* Drupal\Core\Database\Query\Condition::mapConditionOperator().
*
* @param string $string
* The string to escape.
*
* @return string
* The escaped string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1293
⧉public inTransaction(): bool Determines if there is an active transaction open.
/**
* Determines if there is an active transaction open.
*
* @return bool
* TRUE if we're currently in a transaction, FALSE otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1303
⧉public transactionDepth(): int Determines the current transaction depth.
/**
* Determines the current transaction depth.
*
* @return int
* The current transaction depth.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1313
⧉public startTransaction($name = ''): \Drupal\Core\Database\Transaction Returns a new DatabaseTransaction object on this connection.
/**
* Returns a new DatabaseTransaction object on this connection.
*
* @param string $name
* (optional) The name of the savepoint.
*
* @return \Drupal\Core\Database\Transaction
* A Transaction object.
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1328
⧉public pushTransaction($name) Increases the depth of transaction nesting.
/**
* Increases the depth of transaction nesting.
*
* If no transaction is already active, we begin a new transaction.
*
* @param string $name
* The name of the transaction.
*
* @throws \Drupal\Core\Database\TransactionNameNonUniqueException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1406
⧉public popTransaction($name) Decreases the depth of transaction nesting.
/**
* Decreases the depth of transaction nesting.
*
* If we pop off the last transaction layer, then we either commit or roll
* back the transaction as necessary. If no transaction is active, we return
* because the transaction may have manually been rolled back.
*
* @param string $name
* The name of the savepoint.
*
* @throws \Drupal\Core\Database\TransactionNoActiveException
* @throws \Drupal\Core\Database\TransactionCommitFailedException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1436
⧉public addRootTransactionEndCallback(callable $callback) Adds a root transaction end callback.
/**
* Adds a root transaction end callback.
*
* These callbacks are invoked immediately after the transaction has been
* committed.
*
* It can for example be used to avoid deadlocks on write-heavy tables that
* do not need to be part of the transaction, like cache tag invalidations.
*
* Another use case is that services using alternative backends like Redis and
* Memcache cache implementations can replicate the transaction-behavior of
* the database cache backend and avoid race conditions.
*
* An argument is passed to the callbacks that indicates whether the
* transaction was successful or not.
*
* @param callable $callback
* The callback to invoke.
*
* @see \Drupal\Core\Database\Connection::doCommit()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1471
⧉public clientVersion(): string Returns the version of the database client.
/**
* Returns the version of the database client.
*
* Assumes the client connection is \PDO. Non-PDO based drivers need to
* override this method.
*
* @return string
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1581
⧉public supportsTransactionalDDL(): bool Determines if this driver supports transactional DDL.
/**
* Determines if this driver supports transactional DDL.
*
* DDL queries are those that change the schema, such as ALTER queries.
*
* @return bool
* TRUE if this connection supports transactions for DDL queries, FALSE
* otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1594
⧉public commit() Throws an exception to deny direct access to transaction commits.
/**
* Throws an exception to deny direct access to transaction commits.
*
* We do not want to allow users to commit transactions at any time, only
* by destroying the transaction object or allowing it to go out of scope.
* A direct commit bypasses all of the safety checks we've built on top of
* the database client's transaction routines.
*
* @throws \Drupal\Core\Database\TransactionExplicitCommitNotAllowedException
*
* @see \Drupal\Core\Database\Transaction
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1646
⧉public quote($string, $parameter_type = 2): string|bool Quotes a string for use in a query.
/**
* Quotes a string for use in a query.
*
* @param string $string
* The string to be quoted.
* @param int $parameter_type
* (optional) Provides a data type hint for drivers that have alternate
* quoting styles. Defaults to \PDO::PARAM_STR.
*
* @return string|bool
* A quoted string that is theoretically safe to pass into an SQL statement.
* Returns FALSE if the driver does not support quoting in this way.
*
* @see \PDO::quote()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1684
⧉public __sleep() Prevents the database connection from being serialized.
/**
* Prevents the database connection from being serialized.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1711
⧉public getProvider(): string Get the module name of the module that is providing the database driver.
/**
* Get the module name of the module that is providing the database driver.
*
* @return string
* The module name of the module that is providing the database driver, or
* "core" when the driver is not provided as part of a module.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1841
⧉public getPagerManager(): Drupal\Core\Pager\PagerManagerInterface Get the pager manager service, if available.
/**
* Get the pager manager service, if available.
*
* @return \Drupal\Core\Pager\PagerManagerInterface
* The pager manager service, if available.
*
* @throws \Drupal\Core\DependencyInjection\ContainerNotInitializedException
* If the container has not been initialized yet.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1861
⧉public hasJson(): bool Runs a simple query to validate json datatype support.
/**
* Runs a simple query to validate json datatype support.
*
* @return bool
* Returns the query result.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1871
⧉public isEventEnabled(string $eventName): bool Returns the status of a database API event toggle.
/**
* Returns the status of a database API event toggle.
*
* @param string $eventName
* The name of the event to check.
*
* @return bool
* TRUE if the event is going to be fired by the database API, FALSE
* otherwise.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1890
⧉public enableEvents(array $eventNames): static Enables database API events dispatching.
/**
* Enables database API events dispatching.
*
* @param string[] $eventNames
* A list of database events to be enabled.
*
* @return static
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1902
⧉public disableEvents(array $eventNames): static Disables database API events dispatching.
/**
* Disables database API events dispatching.
*
* @param string[] $eventNames
* A list of database events to be disabled.
*
* @return static
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1918
⧉public dispatchEvent(Drupal\Core\Database\Event\DatabaseEvent $event, ?string $eventName = null): Drupal\Core\Database\Event\DatabaseEvent Dispatches a database API event via the container dispatcher.
/**
* Dispatches a database API event via the container dispatcher.
*
* @param \Drupal\Core\Database\Event\DatabaseEvent $event
* The database event.
* @param string|null $eventName
* (Optional) the name of the event to dispatch.
*
* @return \Drupal\Core\Database\Event\DatabaseEvent
* The database event.
*
* @throws \Drupal\Core\Database\Exception\EventException
* If the container is not initialized.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1940
⧉public findCallerFromDebugBacktrace(): array Determine the last non-database method that called the database API.
/**
* Determine the last non-database method that called the database API.
*
* Traversing the call stack from the very first call made during the
* request, we define "the routine that called this query" as the last entry
* in the call stack that is not any method called from the namespace of the
* database driver, is not inside the Drupal\Core\Database namespace and does
* have a file (which excludes call_user_func_array(), anonymous functions
* and similar). That makes the climbing logic very simple, and handles the
* variable stack depth caused by the query builders.
*
* See the @link http://php.net/debug_backtrace debug_backtrace() @endlink
* function.
*
* @return array
* This method returns a stack trace entry similar to that generated by
* debug_backtrace(). However, it flattens the trace entry and the trace
* entry before it so that we get the function and args of the function that
* called into the database system, not the function and args of the
* database call itself.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1968
⧉protected getMariaDbVersionMatch(): ?string Gets the MariaDB portion of the server version.
/**
* Gets the MariaDB portion of the server version.
*
* @return string
* The MariaDB portion of the server version if present, or NULL if not.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:303
⧉protected getServerVersion(): string Gets the server version.
/**
* Gets the server version.
*
* @return string
* The PDO server version.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:319
⧉protected popCommittableTransactions() Overridden to work around issues to MySQL not supporting transactional DDL.
/**
* Overridden to work around issues to MySQL not supporting transactional DDL.
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:404
⧉protected doCommit() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/mysql/src/Driver/Database/mysql/Connection.php:479
⧉protected defaultOptions(): array Returns the default query options for any given query.
/**
* Returns the default query options for any given query.
*
* A given query can be customized with a number of option flags in an
* associative array:
* - fetch: This element controls how rows from a result set will be
* returned. Legal values include \PDO::FETCH_ASSOC, \PDO::FETCH_BOTH,
* \PDO::FETCH_OBJ, \PDO::FETCH_NUM, or a string representing the name of a
* class. If a string is specified, each record will be fetched into a new
* object of that class. The behavior of all other values is defined by PDO.
* See http://php.net/manual/pdostatement.fetch.php
* - return: (deprecated) Depending on the type of query, different return
* values may be meaningful. This directive instructs the system which type
* of return value is desired. The system will generally set the correct
* value automatically, so it is extremely rare that a module developer will
* ever need to specify this value. Setting it incorrectly will likely lead
* to unpredictable results or fatal errors. Legal values include:
* - Database::RETURN_STATEMENT: Return the prepared statement object for
* the query. This is usually only meaningful for SELECT queries, where
* the statement object is how one accesses the result set returned by the
* query.
* - Database::RETURN_AFFECTED: Return the number of rows found (matched) by
* the WHERE clause of an UPDATE or DELETE query (not the number of rows
* actually changed). Note that although named RETURN_AFFECTED for
* historical reasons, the number of rows matched is returned for
* consistency across database engines.
* - Database::RETURN_INSERT_ID: Return the sequence ID (primary key)
* created by an INSERT statement on a table that contains a serial
* column.
* - Database::RETURN_NULL: Do not return anything, as there is no
* meaningful value to return. That is the case for INSERT queries on
* tables that do not contain a serial column.
* - allow_delimiter_in_query: By default, queries which have the ; delimiter
* any place in them will cause an exception. This reduces the chance of SQL
* injection attacks that terminate the original query and add one or more
* additional queries (such as inserting new user accounts). In rare cases,
* such as creating an SQL function, a ; is needed and can be allowed by
* changing this option to TRUE.
* - allow_square_brackets: By default, queries which contain square brackets
* will have them replaced with the identifier quote character for the
* database type. In rare cases, such as creating an SQL function, []
* characters might be needed and can be allowed by changing this option to
* TRUE.
* - pdo: By default, queries will execute with the client connection options
* set on the connection. In particular cases, it could be necessary to
* override the driver options on the statement level. In such case, pass
* the required setting as an array here, and they will be passed to the
* prepared statement.
*
* @return array
* An array of default query options.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:331
⧉protected setPrefix($prefix) Set the prefix used by this database connection.
/**
* Set the prefix used by this database connection.
*
* @param string $prefix
* A single prefix.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:393
⧉protected preprocessStatement(string $query, array $options): string Returns a string SQL statement ready for preparation.
/**
* Returns a string SQL statement ready for preparation.
*
* This method replaces table names in curly braces and identifiers in square
* brackets with platform specific replacements, appropriately escaping them
* and wrapping them with platform quote characters.
*
* @param string $query
* The query string as SQL, with curly braces surrounding the table names,
* and square brackets surrounding identifiers.
* @param array $options
* An associative array of options to control how the query is run. See
* the documentation for self::defaultOptions() for details.
*
* @return string
* A string SQL statement ready for preparation.
*
* @throws \InvalidArgumentException
* If multiple statements are included in the string, and delimiters are
* not allowed in the query.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:557
⧉protected filterComment($comment = ''): string Sanitize a query comment string.
/**
* Sanitize a query comment string.
*
* Ensure a query comment does not include strings such as "* /" that might
* terminate the comment early. This avoids SQL injection attacks via the
* query comment. The comment strings in this example are separated by a
* space to avoid PHP parse errors.
*
* For example, the comment:
* @code
* \Drupal::database()->update('example')
* ->condition('id', $id)
* ->fields(array('field2' => 10))
* ->comment('Exploit * / DROP TABLE node; --')
* ->execute()
* @endcode
*
* Would result in the following SQL statement being generated:
* @code
* "/ * Exploit * / DROP TABLE node. -- * / UPDATE example SET field2=..."
* @endcode
*
* Unless the comment is sanitized first, the SQL server would drop the
* node table and ignore the rest of the SQL statement.
*
* @param string $comment
* A query comment string.
*
* @return string
* A sanitized version of the query comment string.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:733
⧉protected expandArguments(&$query, &$args): bool Expands out shorthand placeholders.
/**
* Expands out shorthand placeholders.
*
* Drupal supports an alternate syntax for doing arrays of values. We
* therefore need to expand them out into a full, executable query string.
*
* @param string $query
* The query string to modify.
* @param array $args
* The arguments for the query.
*
* @return bool
* TRUE if the query was modified, FALSE otherwise.
*
* @throws \InvalidArgumentException
* This exception is thrown when:
* - A placeholder that ends in [] is supplied, and the supplied value is
* not an array.
* - A placeholder that does not end in [] is supplied, and the supplied
* value is an array.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:847
⧉protected getDebugBacktrace(): array Gets the debug backtrace.
/**
* Gets the debug backtrace.
*
* Wraps the debug_backtrace function to allow mocking results in PHPUnit
* tests.
*
* @return array[]
* The debug backtrace.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:2024
/**
* Creates an array of database connection options from a URL.
*
* @param string $url
* The URL.
* @param string $root
* The root directory of the Drupal installation. Some database drivers,
* like for example SQLite, need this information.
*
* @return array
* The connection options.
*
* @throws \InvalidArgumentException
* Exception thrown when the provided URL does not meet the minimum
* requirements.
*
* @internal
* This method should only be called from
* \Drupal\Core\Database\Database::convertDbUrlToConnectionInfo().
*
* @see \Drupal\Core\Database\Database::convertDbUrlToConnectionInfo()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1737
⇄⧉public static createUrlFromConnectionOptions(array $connection_options): string Creates a URL from an array of database connection options.
/**
* Creates a URL from an array of database connection options.
*
* @param array $connection_options
* The array of connection options for a database connection. An additional
* key of 'module' is added by Database::getConnectionInfoAsUrl() for
* drivers provided my contributed or custom modules for convenience.
*
* @return string
* The connection info as a URL.
*
* @throws \InvalidArgumentException
* Exception thrown when the provided array of connection options does not
* meet the minimum requirements.
*
* @internal
* This method should only be called from
* \Drupal\Core\Database\Database::getConnectionInfoAsUrl().
*
* @see \Drupal\Core\Database\Database::getConnectionInfoAsUrl()
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1798
⇄⧉public static removeDatabaseEntriesFromDebugBacktrace(array $backtrace, string $driver_namespace): array Removes database related calls from a backtrace array.
/**
* Removes database related calls from a backtrace array.
*
* @param array $backtrace
* A standard PHP backtrace. Passed by reference.
* @param string $driver_namespace
* The PHP namespace of the database driver.
*
* @return array
* The cleaned backtrace array.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1999
⧉protected static getSQLState(Exception $e): string Extracts the SQLSTATE error from a PDOException.
/**
* Extracts the SQLSTATE error from a PDOException.
*
* @param \Exception $e
* The exception
*
* @return string
* The five character error code.
*/
Inherited from Drupal\Core\Database\Connection
Defined in <ROOT>/core/lib/Drupal/Core/Database/Connection.php:1697
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:28
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:43
/**
* Implements \Drupal\Core\Cache\CacheTagsInvalidatorInterface::invalidateTags()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:53
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::getCurrentChecksum()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:83
⧉public schemaDefinition() Defines the schema for the {cachetags} table.
/**
* Defines the schema for the {cachetags} table.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:97
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::isValid()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:105
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:58
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:75
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:128
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
/**
* 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 int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:82
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:344
⧉public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:363
⧉public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:377
⧉public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:410
⧉public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:489
⧉public getMaxRows(): int The maximum number of rows that this cache bin table is allowed to store.
/**
* The maximum number of rows that this cache bin table is allowed to store.
*
* @return int
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:556
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:151
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:222
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:422
⧉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 $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:454
⧉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 <ROOT>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:469
/**
* InfoParserDynamic constructor.
*
* @param string|null $app_root
* The root directory of the Drupal installation.
*/
Inherited from Drupal\Core\Extension\InfoParserDynamic
Defined in <ROOT>/core/lib/Drupal/Core/Extension/InfoParserDynamic.php:27
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/InfoParserDynamic.php:111
⧉public __construct($root, array $module_list, Drupal\Core\Cache\CacheBackendInterface $cache_backend) Constructs a ModuleHandler object.
/**
* Constructs a ModuleHandler object.
*
* @param string $root
* The app root.
* @param array $module_list
* An associative array whose keys are the names of installed modules and
* whose values are Extension class parameters. This is normally the
* %container.modules% parameter being set up by DrupalKernel.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend for storing module hook implementation information.
*
* @see \Drupal\Core\DrupalKernel
* @see \Drupal\Core\CoreServiceProvider
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:110
⧉public load($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:122
⧉public loadAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:138
⧉public reload() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:150
⧉public isLoaded() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:158
⧉public getModuleList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:165
⧉public getModule($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:172
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:708
⧉public getName($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:719
⧉protected add($type, $name, $path) Adds a module or profile to the list of currently active modules.
/**
* Adds a module or profile to the list of currently active modules.
*
* @param string $type
* The extension type; either 'module' or 'profile'.
* @param string $name
* The module name; e.g., 'node'.
* @param string $path
* The module path; e.g., 'core/modules/node'.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:213
/**
* Builds hook_hook_info() information.
*
* @see \Drupal\Core\Extension\ModuleHandler::getHookInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:308
⧉protected getImplementationInfo($hook): mixed[] Provides information about modules' implementations of a hook.
/**
* Provides information about modules' implementations of a hook.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:583
⧉protected buildImplementationInfo($hook): mixed[] Builds hook implementation information for a given hook name.
/**
* Builds hook implementation information for a given hook name.
*
* @param string $hook
* The name of the hook (e.g. "help" or "menu").
*
* @return mixed[]
* An array whose keys are the names of the modules which are implementing
* this hook and whose values are either a string identifying a file in
* which the implementation is to be found, or FALSE, if the implementation
* is in the module file.
*
* @throws \RuntimeException
* Exception thrown when an invalid implementation is added by
* hook_module_implements_alter().
*
* @see \Drupal\Core\Extension\ModuleHandler::getImplementationInfo()
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:629
⧉protected verifyImplementations(&$implementations, $hook): bool Verifies an array of implementations loaded from cache.
/**
* Verifies an array of implementations loaded from cache.
*
* Verification is done by including the lazy-loaded $module.$group.inc file,
* and checking function_exists().
*
* @param string[] $implementations
* Implementation "group" by module name.
* @param string $hook
* The hook name.
*
* @return bool
* TRUE, if all implementations exist.
* FALSE, if one or more implementations don't exist and need to be removed
* from the cache.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:680
⧉private triggerDeprecationError($description, $hook) Triggers an E_USER_DEPRECATED error if any module implements the hook.
/**
* Triggers an E_USER_DEPRECATED error if any module implements the hook.
*
* @param string $description
* Helpful text describing what to do instead of implementing this hook.
* @param string $hook
* The name of the hook.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleHandler.php:446
⧉public __construct(Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory) Constructs a State object.
/**
* Constructs a State object.
*
* @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
* The key value store to use.
*/
Defined in <ROOT>/core/lib/Drupal/Core/State/State.php:32
/**
* Constructs the Config factory.
*
* @param \Drupal\Core\Config\StorageInterface $storage
* The configuration storage engine.
* @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $event_dispatcher
* An event dispatcher instance to use for configuration events.
* @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config
* The typed configuration manager.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:72
⧉public getEditable($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:81
⧉public get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:88
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:327
⧉public onConfigSave(Drupal\Core\Config\ConfigCrudEvent $event) Updates stale static cache entries when configuration is saved.
/**
* Updates stale static cache entries when configuration is saved.
*
* @param ConfigCrudEvent $event
* The configuration event.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:337
⧉public onConfigDelete(Drupal\Core\Config\ConfigCrudEvent $event) Removes stale static cache entries when configuration is deleted.
/**
* Removes stale static cache entries when configuration is deleted.
*
* @param \Drupal\Core\Config\ConfigCrudEvent $event
* The configuration event.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:366
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:394
⧉protected doGet($name, $immutable = true): \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig Returns a configuration object for a given name.
/**
* Returns a configuration object for a given name.
*
* @param string $name
* The name of the configuration object to construct.
* @param bool $immutable
* (optional) Create an immutable configuration object. Defaults to TRUE.
*
* @return \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig
* A configuration object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:103
⧉protected doLoadMultiple(array $names, $immutable = true): \Drupal\Core\Config\Config[]|\Drupal\Core\Config\ImmutableConfig[] Returns a list of configuration objects for the given names.
/**
* Returns a list of configuration objects for the given names.
*
* @param array $names
* List of names of configuration objects.
* @param bool $immutable
* (optional) Create an immutable configuration objects. Defaults to TRUE.
*
* @return \Drupal\Core\Config\Config[]|\Drupal\Core\Config\ImmutableConfig[]
* List of successfully loaded configuration objects, keyed by name.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:150
⧉protected loadOverrides(array $names): array Get arbitrary overrides for the named configuration objects from modules.
/**
* Get arbitrary overrides for the named configuration objects from modules.
*
* @param array $names
* The names of the configuration objects to get overrides for.
*
* @return array
* An array of overrides keyed by the configuration object name.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:204
⧉protected propagateConfigOverrideCacheability($cache_key, $name) Propagates cacheability of config overrides to cached config objects.
/**
* Propagates cacheability of config overrides to cached config objects.
*
* @param string $cache_key
* The key of the cached config object to update.
* @param string $name
* The name of the configuration object to construct.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:222
⧉protected getConfigCacheKey($name, $immutable): string Gets the static cache key for a given config name.
/**
* Gets the static cache key for a given config name.
*
* @param string $name
* The name of the configuration object.
* @param bool $immutable
* Whether or not the object is mutable.
*
* @return string
* The cache key.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:291
⧉protected getConfigCacheKeys($name): array Gets all the cache keys that match the provided config name.
/**
* Gets all the cache keys that match the provided config name.
*
* @param string $name
* The name of the configuration object.
*
* @return array
* An array of cache keys that match the provided config name.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:308
⧉protected createConfigObject($name, $immutable): \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig Creates a configuration object.
/**
* Creates a configuration object.
*
* @param string $name
* Configuration object name.
* @param bool $immutable
* Determines whether a mutable or immutable config object is returned.
*
* @return \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig
* The configuration object.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Config/ConfigFactory.php:409
⧉protected state -> Drupal\Core\State\State (2) Depth Limit
protected installProfile -> string (8) "standard"
⧉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, $install_profile) Constructs a new instance.
/**
* 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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:135
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:163
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:242
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:259
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:274
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:341
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:359
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:393
⧉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[]
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:414
⧉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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:583
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ProfileExtensionList.php:31
⧉protected getExtensionDiscovery(): \Drupal\Core\Extension\ExtensionDiscovery Returns the extension discovery.
/**
* Returns the extension discovery.
*
* @return \Drupal\Core\Extension\ExtensionDiscovery
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:150
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:191
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:201
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:211
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:297
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:310
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:403
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:439
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:553
⇄⧉public static 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.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:600
/**
* 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 <ROOT>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:73
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:118
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:163
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:225
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:242
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:259
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:274
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:341
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:359
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:393
⧉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[]
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:414
⧉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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
⧉protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:79
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:88
⧉protected getNumberOfPlurals($langcode = null) 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()
*/
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:88
⧉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 <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:102
⧉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 <ROOT>/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 <ROOT>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:125
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:199
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:211
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:191
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:201
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:211
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:403
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:439
⧉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 <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:553
⇄⧉public static 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.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <ROOT>/core/lib/Drupal/Core/Extension/ExtensionList.php:600
/**
* 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 string $theme_name
* (optional) The name of the theme for which to construct the registry.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:184
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:202
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:238
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:264
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:288
/**
* Invalidates theme registry caches.
*
* To be called when the list of enabled extensions is changed.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:759
⧉public destruct() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:778
⧉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 $prefixes
* An array of function prefixes by which the list can be limited.
*
* @return array
* Functions grouped by the first prefix.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:793
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:215
⧉protected setCache() Persists the theme registry in the cache backend.
/**
* Persists the theme registry in the cache backend.
*/
Defined in <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:275
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:337
⧉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', or
* 'base_theme'. 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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:439
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:603
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:643
⧉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 <ROOT>/core/lib/Drupal/Core/Theme/Registry.php:671
/**
* 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 <ROOT>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:97
/**
* 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 <ROOT>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:236
/**
* 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 <ROOT>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:260
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:471
⧉public __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
⇄⧉public setModuleHandler(Drupal\Core\Extension\ModuleHandlerInterface $module_handler): $this Sets the module handler for this handler.
/**
* 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 <ROOT>/core/lib/Drupal/Core/Entity/EntityHandlerBase.php:46
⧉public __wakeup() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
⇄⧉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\EntityHandlerBase
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:118
/**
* 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 <ROOT>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:354
/**
* 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 <ROOT>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:389
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:434
⧉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\EntityInterface $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
*/
Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:504
⧉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 <ROOT>/core/lib/Drupal/Core/Entity/EntityHandlerBase.php:31
⧉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\EntityHandlerBase
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
⧉protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:79
⧉protected getNumberOfPlurals($langcode = null) 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()
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:88
⧉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\EntityHandlerBase
Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:102
/**
* #lazy_builder callback; builds a node's links.
*
* @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 $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 <ROOT>/core/modules/node/src/NodeViewBuilder.php:89
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityViewBuilder
Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:109
⧉protected static 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 drupal_pre_render_links().
*/
Defined in <ROOT>/core/modules/node/src/NodeViewBuilder.php:124