class BlockStorageController

Defines the storage controller class for Block entities.

Hierarchy

Expanded class hierarchy of BlockStorageController

1 file declares its use of BlockStorageController
BlockStorageUnitTest.php in drupal/core/modules/block/lib/Drupal/block/Tests/BlockStorageUnitTest.php
Contains \Drupal\block\Tests\BlockStorageUnitTest.

File

drupal/core/modules/block/lib/Drupal/block/BlockStorageController.php, line 16
Contains \Drupal\block\BlockStorageController.

Namespace

Drupal\block
View source
class BlockStorageController extends ConfigStorageController {

  /**
   * {@inheritdoc}
   */
  public function load(array $ids = NULL) {
    $entities = parent::load($ids);

    // Only blocks with a valid plugin should be loaded.
    return array_filter($entities, function ($entity) {
      return $entity
        ->getPlugin();
    });
  }

  /**
   * {@inheritdoc}
   */
  protected function preSave(EntityInterface $entity) {
    parent::preSave($entity);
    $entity
      ->set('settings', $entity
      ->getPlugin()
      ->getConfig());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockStorageController::load public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::load(). Overrides ConfigStorageController::load
BlockStorageController::preSave protected function Acts on an entity before the presave hook is invoked. Overrides ConfigStorageController::preSave
ConfigStorageController::$configFactory protected property The config factory service.
ConfigStorageController::$configStorage protected property The config storage service.
ConfigStorageController::$statusKey protected property Name of the entity's status key or FALSE if a status is not supported.
ConfigStorageController::$uuidKey protected property Name of the entity's UUID property. Overrides EntityStorageControllerBase::$uuidKey
ConfigStorageController::attachLoad protected function Attaches data to entities upon loading. 4
ConfigStorageController::buildQuery protected function Builds the query to load the entity.
ConfigStorageController::create public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::create(). Overrides EntityStorageControllerInterface::create 2
ConfigStorageController::createInstance public static function Instantiates a new instance of this entity controller. Overrides EntityControllerInterface::createInstance 2
ConfigStorageController::delete public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::delete(). Overrides EntityStorageControllerInterface::delete
ConfigStorageController::deleteRevision public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::deleteRevision(). Overrides EntityStorageControllerInterface::deleteRevision
ConfigStorageController::getConfigPrefix public function Returns the config prefix used by the configuration entity type.
ConfigStorageController::getFieldDefinitions public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::getFieldDefinitions(). Overrides EntityStorageControllerInterface::getFieldDefinitions
ConfigStorageController::getIDFromConfigName public static function Extracts the configuration entity ID from the full configuration name.
ConfigStorageController::getQueryServicename public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::getQueryServicename(). Overrides EntityStorageControllerInterface::getQueryServicename
ConfigStorageController::importCreate public function Create configuration upon synchronizing configuration changes. 1
ConfigStorageController::importDelete public function Delete configuration upon synchronizing configuration changes. 2
ConfigStorageController::importUpdate public function Updates configuration upon synchronizing configuration changes. 1
ConfigStorageController::invokeHook protected function Invokes a hook on behalf of the entity.
ConfigStorageController::loadByProperties public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::loadByProperties(). Overrides EntityStorageControllerInterface::loadByProperties 2
ConfigStorageController::loadRevision public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::loadRevision(). Overrides EntityStorageControllerInterface::loadRevision
ConfigStorageController::postDelete protected function Acts on deleted entities before the delete hook is invoked. 5
ConfigStorageController::postSave protected function Acts on a saved entity before the insert or update hook is invoked. 7
ConfigStorageController::preDelete protected function Acts on entities before they are deleted. 3
ConfigStorageController::save public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::save(). Overrides EntityStorageControllerInterface::save
ConfigStorageController::__construct public function Constructs a ConfigStorageController object. Overrides EntityStorageControllerBase::__construct 2
EntityStorageControllerBase::$cache protected property Whether this entity type should use the static cache. 1
EntityStorageControllerBase::$entityCache protected property Static cache of entities.
EntityStorageControllerBase::$entityInfo protected property Array of information about the entity.
EntityStorageControllerBase::$entityType protected property Entity type for this controller instance.
EntityStorageControllerBase::$hookLoadArguments protected property Additional arguments to pass to hook_TYPE_load().
EntityStorageControllerBase::$idKey protected property Name of the entity's ID field in the entity database table.
EntityStorageControllerBase::cacheGet protected function Gets entities from the static cache.
EntityStorageControllerBase::cacheSet protected function Stores entities in the static entity cache.
EntityStorageControllerBase::loadUnchanged public function Loads an unchanged entity from the database. Overrides EntityStorageControllerInterface::loadUnchanged
EntityStorageControllerBase::resetCache public function Resets the internal, static entity cache. Overrides EntityStorageControllerInterface::resetCache 3