1. class
  2. Drupal
  3. \
  4. book
  5. \
  6. BookUninstallValidator

BookUninstallValidator

class BookUninstallValidator implements ModuleUninstallValidatorInterface (View source)

Prevents book module from being uninstalled whilst any book nodes exist or there are any book outline stored.

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected BookOutlineStorageInterface $bookOutlineStorage

The book outline storage.
protected EntityTypeManagerInterface $entityTypeManager

The entity type manager.

Methods

TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__construct(BookOutlineStorageInterface $book_outline_storage, EntityTypeManagerInterface $entity_type_manager, TranslationInterface $string_translation)

Constructs a new BookUninstallValidator.

string[]
validate(string $module)

Determines the reasons a module can not be uninstalled.

bool
hasBookOutlines()

Checks if there are any books in an outline.

bool
hasBookNodes()

Determines if there is any book nodes or not.

Details

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

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

Parameters

string $string

A string containing the English text to translate.
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.
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 Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

at line 42
__construct(BookOutlineStorageInterface $book_outline_storage, EntityTypeManagerInterface $entity_type_manager, TranslationInterface $string_translation)

Constructs a new BookUninstallValidator.

Parameters

BookOutlineStorageInterface $book_outline_storage

The book outline storage.
EntityTypeManagerInterface $entity_type_manager

The entity type manager.
TranslationInterface $string_translation

The string translation service.

at line 51
string[] validate(string $module)

Determines the reasons a module can not be uninstalled.

Parameters

string $module

A module name.

Return Value

string[]

An array of reasons the module can not be uninstalled, empty if it can. Each reason should not end with any punctuation since multiple reasons can be displayed together.

at line 74
protected bool hasBookOutlines()

Checks if there are any books in an outline.

Return Value

bool

TRUE if there are books, FALSE if not.

at line 84
protected bool hasBookNodes()

Determines if there is any book nodes or not.

Return Value

bool

TRUE if there are book nodes, FALSE otherwise.