class Book

Same name in this branch
  1. 11.x core/modules/book/src/Plugin/migrate/source/Book.php \Drupal\book\Plugin\migrate\source\Book
Same name in other branches
  1. 9 core/modules/book/src/Plugin/migrate/destination/Book.php \Drupal\book\Plugin\migrate\destination\Book
  2. 9 core/modules/book/src/Plugin/migrate/source/Book.php \Drupal\book\Plugin\migrate\source\Book
  3. 8.9.x core/modules/book/src/Plugin/migrate/destination/Book.php \Drupal\book\Plugin\migrate\destination\Book
  4. 8.9.x core/modules/book/src/Plugin/migrate/source/d6/Book.php \Drupal\book\Plugin\migrate\source\d6\Book
  5. 8.9.x core/modules/book/src/Plugin/migrate/source/Book.php \Drupal\book\Plugin\migrate\source\Book
  6. 10 core/modules/book/src/Plugin/migrate/destination/Book.php \Drupal\book\Plugin\migrate\destination\Book
  7. 10 core/modules/book/src/Plugin/migrate/source/Book.php \Drupal\book\Plugin\migrate\source\Book

Plugin annotation


@MigrateDestination(
  id = "book",
  provider = "book"
)

Hierarchy

Expanded class hierarchy of Book

72 string references to 'Book'
block.block.olivero_book_navigation.yml in core/themes/olivero/config/optional/block.block.olivero_book_navigation.yml
core/themes/olivero/config/optional/block.block.olivero_book_navigation.yml
Block::prepareRow in core/modules/block/src/Plugin/migrate/source/Block.php
Adds additional data to the row.
BlockConfigSchemaTest::setUp in core/modules/book/tests/src/Kernel/Block/BlockConfigSchemaTest.php
book.info.yml in core/modules/book/book.info.yml
core/modules/book/book.info.yml
book.migrate_drupal.yml in core/modules/book/migrations/state/book.migrate_drupal.yml
core/modules/book/migrations/state/book.migrate_drupal.yml

... See full list

File

core/modules/book/src/Plugin/migrate/destination/Book.php, line 15

Namespace

Drupal\book\Plugin\migrate\destination
View source
class Book extends EntityContentBase {
    
    /**
     * {@inheritdoc}
     */
    protected static function getEntityTypeId($plugin_id) {
        return 'node';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function updateEntity(EntityInterface $entity, Row $row) {
        if ($entity->book) {
            $book = $row->getDestinationProperty('book');
            foreach ($book as $key => $value) {
                $entity->book[$key] = $value;
            }
        }
        else {
            $entity->book = $row->getDestinationProperty('book');
        }
        return parent::updateEntity($entity, $row);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Book::getEntityTypeId protected static function Finds the entity type from configuration or plugin ID. Overrides EntityFieldDefinitionTrait::getEntityTypeId
Book::updateEntity protected function Updates an entity with the new values from row. Overrides EntityContentBase::updateEntity
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. 7
Entity::getEntityId protected function Gets the entity ID of the row. 2
Entity::getKey protected function Returns a specific entity key.
EntityContentBase::$accountSwitcher protected property The account switcher service.
EntityContentBase::$fieldTypeManager protected property Field type plugin manager.
EntityContentBase::create public static function Creates an instance of the plugin. Overrides Entity::create 2
EntityContentBase::getHighestId public function Returns the highest ID tracked by the implementing plugin. Overrides HighestIdInterface::getHighestId 2
EntityContentBase::getIds public function Gets the destination IDs. Overrides MigrateDestinationInterface::getIds 2
EntityContentBase::import public function Overrides MigrateDestinationInterface::import 2
EntityContentBase::isEntityValidationRequired public function Returns a state of whether an entity needs to be validated before saving. Overrides MigrateValidatableEntityInterface::isEntityValidationRequired
EntityContentBase::isTranslationDestination public function
EntityContentBase::processStubRow protected function Populates as much of the stub row as possible. Overrides Entity::processStubRow 3
EntityContentBase::rollback public function Delete the specified destination object from the target Drupal. Overrides Entity::rollback 1
EntityContentBase::save protected function Saves the entity. 3
EntityContentBase::validateEntity public function Validates the entity. Overrides MigrateValidatableEntityInterface::validateEntity
EntityContentBase::__construct public function Constructs a content entity. Overrides Entity::__construct 3
EntityFieldDefinitionTrait::getDefinitionFromEntity protected function Gets the field definition from a specific entity base field.
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.