class EntityOperations implements ContainerInjectionInterface (View source)

internal  
 

Defines a class for reacting to entity events.

Traits

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

Properties

protected TranslationInterface $stringTranslation

The string translation service.

from  StringTranslationTrait
protected EntityTypeManagerInterface $entityTypeManager

The entity type manager service.

protected WorkspaceManagerInterface $workspaceManager

The workspace manager service.

protected WorkspaceAssociationInterface $workspaceAssociation

The workspace association service.

Methods

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

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

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

Formats a string containing a count of items.

getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

getStringTranslation()

Gets the string translation service.

$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

__construct(EntityTypeManagerInterface $entity_type_manager, WorkspaceManagerInterface $workspace_manager, WorkspaceAssociationInterface $workspace_association)

Constructs a new EntityOperations instance.

static 
create(ContainerInterface $container)

Instantiates a new instance of this class.

entityPreload(array $ids, $entity_type_id)

Acts on entity IDs before they are loaded.

entityPresave(EntityInterface $entity)

Acts on an entity before it is created or updated.

entityInsert(EntityInterface $entity)

Responds to the creation of a new entity.

entityUpdate(EntityInterface $entity)

Responds to updates to an entity.

entityPredelete(EntityInterface $entity)

Acts on an entity before it is deleted.

entityFormAlter(array $form, FormStateInterface $form_state, string $form_id)

Alters entity forms to disallow concurrent editing in multiple workspaces.

static 
entityFormEntityBuild($entity_type_id, RevisionableInterface $entity, $form, FormStateInterface $form_state)

Entity builder that marks all supported entities as pending revisions.

bool
shouldSkipPreOperations(EntityTypeInterface $entity_type)

Determines whether we need to react on pre-save or pre-delete operations.

Details

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

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

protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

__construct(EntityTypeManagerInterface $entity_type_manager, WorkspaceManagerInterface $workspace_manager, WorkspaceAssociationInterface $workspace_association)

Constructs a new EntityOperations instance.

Parameters

EntityTypeManagerInterface $entity_type_manager

The entity type manager service.

WorkspaceManagerInterface $workspace_manager

The workspace manager service.

WorkspaceAssociationInterface $workspace_association

The workspace association service.

static create(ContainerInterface $container)

Instantiates a new instance of this class.

This is a factory method that returns a new instance of this class. The factory should pass any needed dependencies into the constructor of this class, but not the container itself. Every call to this method must return a new instance of this class; that is, it may not implement a singleton.

Parameters

ContainerInterface $container

The service container this instance should use.

entityPreload(array $ids, $entity_type_id)

Acts on entity IDs before they are loaded.

Parameters

array $ids
$entity_type_id

See also

hook_entity_preload()

entityPresave(EntityInterface $entity)

Acts on an entity before it is created or updated.

Parameters

EntityInterface $entity

The entity being saved.

See also

hook_entity_presave()

entityInsert(EntityInterface $entity)

Responds to the creation of a new entity.

Parameters

EntityInterface $entity

The entity that was just saved.

See also

hook_entity_insert()

entityUpdate(EntityInterface $entity)

Responds to updates to an entity.

Parameters

EntityInterface $entity

The entity that was just saved.

See also

hook_entity_update()

entityPredelete(EntityInterface $entity)

Acts on an entity before it is deleted.

Parameters

EntityInterface $entity

The entity being deleted.

See also

hook_entity_predelete()

entityFormAlter(array $form, FormStateInterface $form_state, string $form_id)

Alters entity forms to disallow concurrent editing in multiple workspaces.

Parameters

array $form

An associative array containing the structure of the form.

FormStateInterface $form_state

The current state of the form.

string $form_id

The form ID.

See also

hook_form_alter()

static entityFormEntityBuild($entity_type_id, RevisionableInterface $entity, $form, FormStateInterface $form_state)

Entity builder that marks all supported entities as pending revisions.

Parameters

$entity_type_id
RevisionableInterface $entity
$form
FormStateInterface $form_state

protected bool shouldSkipPreOperations(EntityTypeInterface $entity_type)

Determines whether we need to react on pre-save or pre-delete operations.

Parameters

EntityTypeInterface $entity_type

The entity type to check.

Return Value

bool

Returns TRUE if the pre-save or pre-delete entity operations should not be altered in the current request, FALSE otherwise.