class ViewStorageController

Defines the storage controller class for View entities.

Hierarchy

Expanded class hierarchy of ViewStorageController

1 file declares its use of ViewStorageController
ViewStorageTest.php in drupal/core/modules/views/lib/Drupal/views/Tests/ViewStorageTest.php
Definition of Drupal\views\Tests\ViewStorageTest.

File

drupal/core/modules/views/lib/Drupal/views/ViewStorageController.php, line 16
Definition of Drupal\views\ViewStorageController.

Namespace

Drupal\views
View source
class ViewStorageController extends ConfigStorageController {

  /**
   * Overrides Drupal\config\ConfigStorageController::load();
   */
  public function load(array $ids = NULL) {
    $entities = parent::load($ids);

    // Only return views for enabled modules.
    return array_filter($entities, function ($entity) {
      if (module_exists($entity
        ->get('module'))) {
        return TRUE;
      }
      return FALSE;
    });
  }

  /**
   * Overrides Drupal\config\ConfigStorageController::attachLoad();
   */
  protected function attachLoad(&$queried_entities, $revision_id = FALSE) {
    foreach ($queried_entities as $id => $entity) {
      $this
        ->attachDisplays($entity);
    }
    parent::attachLoad($queried_entities, $revision_id);
  }

  /**
   * Overrides Drupal\config\ConfigStorageController::postSave().
   */
  public function postSave(EntityInterface $entity, $update) {
    parent::postSave($entity, $update);

    // Clear caches.
    views_invalidate_cache();
  }

  /**
   * Overrides Drupal\config\ConfigStorageController::create().
   */
  public function create(array $values) {

    // If there is no information about displays available add at least the
    // default display.
    $values += array(
      'display' => array(
        'default' => array(
          'display_plugin' => 'default',
          'id' => 'default',
          'display_title' => 'Master',
          'position' => 0,
          'display_options' => array(),
        ),
      ),
    );
    $entity = parent::create($values);
    $this
      ->attachDisplays($entity);
    return $entity;
  }

  /**
   * Add defaults to the display options.
   *
   * @param Drupal\Core\Entity\EntityInterface $entity
   */
  protected function attachDisplays(EntityInterface $entity) {
    if (isset($entity->display) && is_array($entity->display)) {
      $displays = array();
      foreach ($entity
        ->get('display') as $key => $options) {
        $options += array(
          'display_options' => array(),
          'display_plugin' => NULL,
          'id' => NULL,
          'display_title' => '',
          'position' => NULL,
        );

        // Add the defaults for the display.
        $displays[$key] = $options;
      }
      $entity
        ->set('display', $displays);
    }
  }

  /**
   * Overrides Drupal\config\ConfigStorageController::getProperties();
   */
  protected function getProperties(EntityInterface $entity) {
    $names = array(
      'api_version',
      'base_field',
      'base_table',
      'core',
      'description',
      'disabled',
      'display',
      'human_name',
      'module',
      'name',
      'tag',
      'uuid',
    );
    $properties = array();
    foreach ($names as $name) {
      $properties[$name] = $entity
        ->get($name);
    }
    return $properties;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigStorageController::$entityInfo protected property Array of information about the entity.
ConfigStorageController::$entityType protected property Entity type for this controller instance.
ConfigStorageController::$hookLoadArguments protected property Additional arguments to pass to hook_TYPE_load().
ConfigStorageController::$idKey protected property Name of the entity's ID field in the entity database table.
ConfigStorageController::$uuidKey protected property Name of the entity's UUID property.
ConfigStorageController::buildQuery protected function Builds the query to load the entity.
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::getFieldDefinitions public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::getFieldDefinitions(). Overrides EntityStorageControllerInterface::getFieldDefinitions
ConfigStorageController::getQueryServicename public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::getQueryServicename(). Overrides EntityStorageControllerInterface::getQueryServicename
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
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.
ConfigStorageController::preDelete protected function Acts on entities before they are deleted.
ConfigStorageController::preSave protected function Acts on an entity before the presave hook is invoked.
ConfigStorageController::resetCache public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::resetCache(). Overrides EntityStorageControllerInterface::resetCache
ConfigStorageController::save public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::save(). Overrides EntityStorageControllerInterface::save
ConfigStorageController::__construct public function Implements Drupal\Core\Entity\EntityStorageControllerInterface::__construct().
ViewStorageController::attachDisplays protected function Add defaults to the display options.
ViewStorageController::attachLoad protected function Overrides Drupal\config\ConfigStorageController::attachLoad(); Overrides ConfigStorageController::attachLoad
ViewStorageController::create public function Overrides Drupal\config\ConfigStorageController::create(). Overrides ConfigStorageController::create
ViewStorageController::getProperties protected function Overrides Drupal\config\ConfigStorageController::getProperties(); Overrides ConfigStorageController::getProperties
ViewStorageController::load public function Overrides Drupal\config\ConfigStorageController::load(); Overrides ConfigStorageController::load
ViewStorageController::postSave public function Overrides Drupal\config\ConfigStorageController::postSave(). Overrides ConfigStorageController::postSave