class EntityViewMode

Same name in this branch
  1. 9 core/lib/Drupal/Core/Entity/Entity/EntityViewMode.php \Drupal\Core\Entity\Entity\EntityViewMode
Same name in other branches
  1. 8.9.x core/modules/migrate/src/Plugin/migrate/destination/EntityViewMode.php \Drupal\migrate\Plugin\migrate\destination\EntityViewMode
  2. 8.9.x core/lib/Drupal/Core/Entity/Entity/EntityViewMode.php \Drupal\Core\Entity\Entity\EntityViewMode
  3. 10 core/modules/migrate/src/Plugin/migrate/destination/EntityViewMode.php \Drupal\migrate\Plugin\migrate\destination\EntityViewMode
  4. 10 core/lib/Drupal/Core/Entity/Entity/EntityViewMode.php \Drupal\Core\Entity\Entity\EntityViewMode
  5. 11.x core/modules/migrate/src/Plugin/migrate/destination/EntityViewMode.php \Drupal\migrate\Plugin\migrate\destination\EntityViewMode
  6. 11.x core/lib/Drupal/Core/Entity/Entity/EntityViewMode.php \Drupal\Core\Entity\Entity\EntityViewMode

Provides entity view mode destination plugin.

See EntityConfigBase for the available configuration options.

Example:


source:
  plugin: d7_view_mode
process:
  mode: view_mode
  label: view_mode
  targetEntityType: entity_type
destination:
  plugin: entity:entity_view_mode

This will add the results of the process ("mode", "label" and "targetEntityType") to an "entity_view_mode" entity.

Plugin annotation


@MigrateDestination(
  id = "entity:entity_view_mode"
)

Hierarchy

Expanded class hierarchy of EntityViewMode

See also

\Drupal\migrate\Plugin\migrate\destination\EntityConfigBase

File

core/modules/migrate/src/Plugin/migrate/destination/EntityViewMode.php, line 31

Namespace

Drupal\migrate\Plugin\migrate\destination
View source
class EntityViewMode extends EntityConfigBase {
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['targetEntityType']['type'] = 'string';
        $ids['mode']['type'] = 'string';
        return $ids;
    }
    
    /**
     * {@inheritdoc}
     */
    public function rollback(array $destination_identifier) {
        $destination_identifier = implode('.', $destination_identifier);
        parent::rollback([
            $destination_identifier,
        ]);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DestinationBase::$migration protected property The migration.
DestinationBase::$rollbackAction protected property The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback protected property Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule public function Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule 1
DestinationBase::rollbackAction public function The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction protected function For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback public function Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
Entity::$bundles protected property The list of the bundles of this entity type.
Entity::$entityFieldManager protected property The entity field manager.
Entity::$storage protected property The entity storage.
Entity::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
Entity::fields public function Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getBundle public function Gets the bundle for the row taking into account the default.
Entity::getEntity protected function Creates or loads an entity. 5
Entity::getEntityId protected function Gets the entity ID of the row. 2
Entity::getKey protected function Returns a specific entity key.
EntityConfigBase::$configFactory protected property The configuration factory.
EntityConfigBase::$languageManager protected property The language manager.
EntityConfigBase::create public static function Creates an instance of the plugin. Overrides Entity::create 1
EntityConfigBase::generateId protected function Generates an entity ID.
EntityConfigBase::import public function Import the row. Overrides MigrateDestinationInterface::import 5
EntityConfigBase::isTranslationDestination protected function Get whether this destination is for translations.
EntityConfigBase::updateEntity protected function Updates an entity with the contents of a row. 1
EntityConfigBase::updateEntityProperty protected function Updates a (possible nested) entity property with a value. 1
EntityConfigBase::__construct public function Construct a new entity. Overrides Entity::__construct 1
EntityFieldDefinitionTrait::getDefinitionFromEntity protected function Gets the field definition from a specific entity base field.
EntityFieldDefinitionTrait::getEntityTypeId protected static function Finds the entity type from configuration or plugin ID. 3
EntityViewMode::getIds public function Gets the destination IDs. Overrides EntityConfigBase::getIds
EntityViewMode::rollback public function Delete the specified destination object from the target Drupal. Overrides EntityConfigBase::rollback
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.