EntityImageStyle
class EntityImageStyle extends EntityConfigBase (View source)
Every migration that uses this destination must have an optional dependency on the d6_file migration to ensure it runs first.
Traits
Provides a trait for managing an object's dependencies.
The entity field definition trait.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected bool | $supportsRollback | Indicates whether the destination can be rolled back. |
from DestinationBase |
| protected int | $rollbackAction | The rollback action to be saved for the last imported item. |
from DestinationBase |
| protected MigrationInterface | $migration | The migration. |
from DestinationBase |
| protected array | $dependencies | The object's dependencies. |
from DependencyTrait |
| protected EntityStorageInterface | $storage | The entity storage. |
from Entity |
| protected array | $bundles | The list of the bundles of this entity type. |
from Entity |
| protected LanguageManagerInterface | $languageManager | The language manager. |
from EntityConfigBase |
| protected ConfigFactoryInterface | $configFactory | The configuration factory. |
from EntityConfigBase |
Methods
Construct a new entity.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Delete the specified destination object from the target Drupal.
For a destination item being updated, set the appropriate rollback action.
Gets the destination module handling the destination data.
Gets the field definition from a specific entity base field.
Finds the entity type from configuration or plugin ID.
Creates an instance of the plugin.
Get whether this destination is for translations.
Updates a (possible nested) entity property with a value.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, LanguageManagerInterface $language_manager, ConfigFactoryInterface $config_factory)
Construct a new entity.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
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
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
int
rollbackAction()
The rollback action for the last imported item.
checkRequirements()
Checks if requirements for this plugin are OK.
rollback(array $destination_identifier)
Delete the specified destination object from the target Drupal.
bool
supportsRollback()
Whether the destination can be rolled back or not.
protected
setRollbackAction(array $id_map, int $update_action = MigrateIdMapInterface::ROLLBACK_PRESERVE)
For a destination item being updated, set the appropriate rollback action.
string|null
getDestinationModule()
Gets the destination module handling the destination data.
protected $this
addDependency(string $type, string $name)
Adds a dependency.
protected
addDependencies(array $dependencies)
Adds multiple dependencies.
protected array
getDefinitionFromEntity(string $key)
Gets the field definition from a specific entity base field.
The method takes the field ID as an argument and returns the field storage definition to be used in getIds() by querying the destination entity base field definition.
static protected string
getEntityTypeId(string $plugin_id)
Finds the entity type from configuration or plugin ID.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition, MigrationInterface $migration = NULL)
Creates an instance of the plugin.
string
getBundle(Row $row)
Gets the bundle for the row taking into account the default.
array
fields()
Returns an array of destination fields.
Derived classes must implement fields(), returning a list of available destination fields.
protected EntityInterface
getEntity(Row $row, array $old_destination_id_values)
Creates or loads an entity.
protected string
getEntityId(Row $row)
Gets the entity ID of the row.
protected string|bool
getKey(string $key)
Returns a specific entity key.
array
calculateDependencies()
Calculates dependencies for the configured plugin.
Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.
array|bool
import(Row $row, array $old_destination_id_values = [])
Import the row.
Derived classes must implement import(), to construct one new object (pre-populated) using ID mappings in the Migration.
protected bool
isTranslationDestination()
Get whether this destination is for translations.
array[]
getIds()
Gets the destination IDs.
To support MigrateIdMap maps, derived destination classes should return field definition(s) corresponding to the primary key of the destination being implemented. These are used to construct the destination key fields of the map table for a migration using this destination.
protected
updateEntity(EntityInterface $entity, Row $row)
Updates an entity with the contents of a row.
protected
updateEntityProperty(EntityInterface $entity, array $parents, string|object $value)
Updates a (possible nested) entity property with a value.
protected string
generateId(Row $row, array $ids)
Generates an entity ID.