class View

Same name in this branch

Defines a View configuration entity class.

Plugin annotation


@EntityType(
  id = "view",
  label = @Translation("View"),
  module = "views",
  controllers = {
    "storage" = "Drupal\views\ViewStorageController"
  },
  config_prefix = "views.view",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid",
    "status" = "status"
  }
)

Hierarchy

class \Drupal\Core\Entity\Entity implements \IteratorAggregate, EntityInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface
  - class \Drupal\views\Plugin\Core\Entity\View implements ViewStorageInterface

Expanded class hierarchy of View

4 files declare their use of View

13 string references to 'View'

File

drupal/core/modules/views/lib/Drupal/views/Plugin/Core/Entity/View.php, line 37: Definition of Drupal\views\Plugin\Core\Entity\View.

Namespace

Drupal\views\Plugin\Core\Entity

View source

class View extends ConfigEntityBase implements ViewStorageInterface {

  /**
   * The name of the base table this view will use.
   *
   * @var string
   */
  protected $base_table = 'node';

  /**
   * The unique ID of the view.
   *
   * @var string
   */
  public $id = NULL;

  /**
   * The label of the view.
   */
  protected $label;

  /**
   * The description of the view, which is used only in the interface.
   *
   * @var string
   */
  protected $description = '';

  /**
   * The "tags" of a view.
   *
   * The tags are stored as a single string, though it is used as multiple tags
   * for example in the views overview.
   *
   * @var string
   */
  protected $tag = '';

  /**
   * The core version the view was created for.
   *
   * @var int
   */
  protected $core = DRUPAL_CORE_COMPATIBILITY;

  /**
   * Stores all display handlers of this view.
   *
   * An array containing Drupal\views\Plugin\views\display\DisplayPluginBase
   * objects.
   *
   * @var array
   */
  protected $display = array();

  /**
   * The name of the base field to use.
   *
   * @var string
   */
  protected $base_field = 'nid';

  /**
   * The UUID for this entity.
   *
   * @var string
   */
  public $uuid = NULL;

  /**
   * Stores a reference to the executable version of this view.
   *
   * @var Drupal\views\ViewExecutable
   */
  protected $executable;

  /**
   * The module implementing this view.
   *
   * @var string
   */
  protected $module = 'views';

  /**
   * Overrides Drupal\Core\Entity\EntityInterface::get().
   */
  public function get($property_name, $langcode = NULL) {

    // Ensure that an executable View is available.
    if ($property_name == 'executable' && !isset($this->{$property_name})) {
      $this
        ->set('executable', Views::executableFactory()
        ->get($this));
    }
    return parent::get($property_name, $langcode);
  }

  /**
   * Overrides Drupal\Core\Entity\EntityInterface::uri().
   */
  public function uri() {
    return array(
      'path' => 'admin/structure/views/view/' . $this
        ->id(),
      'options' => array(
        'entity_type' => $this->entityType,
        'entity' => $this,
      ),
    );
  }

  /**
   * Overrides Drupal\Core\Config\Entity\ConfigEntityBase::createDuplicate().
   */
  public function createDuplicate() {
    $duplicate = parent::createDuplicate();
    unset($duplicate->executable);
    return $duplicate;
  }

  /**
   * Overrides \Drupal\Core\Entity\Entity::label().
   *
   * When a certain view doesn't have a label return the ID.
   */
  public function label($langcode = NULL) {
    if (!($label = $this
      ->get('label'))) {
      $label = $this
        ->id();
    }
    return $label;
  }

  /**
   * Adds a new display handler to the view, automatically creating an ID.
   *
   * @param string $plugin_id
   *   (optional) The plugin type from the Views plugin annotation. Defaults to
   *   'page'.
   * @param string $title
   *   (optional) The title of the display. Defaults to NULL.
   * @param string $id
   *   (optional) The ID to use, e.g., 'default', 'page_1', 'block_2'. Defaults
   *   to NULL.
   *
   * @return string|false
   *   The key to the display in $view->display, or FALSE if no plugin ID was
   *   provided.
   */
  public function addDisplay($plugin_id = 'page', $title = NULL, $id = NULL) {
    if (empty($plugin_id)) {
      return FALSE;
    }
    $plugin = Views::pluginManager('display')
      ->getDefinition($plugin_id);
    if (empty($plugin)) {
      $plugin['title'] = t('Broken');
    }
    if (empty($id)) {
      $id = $this
        ->generateDisplayId($plugin_id);

      // Generate a unique human-readable name by inspecting the counter at the
      // end of the previous display ID, e.g., 'page_1'.
      if ($id !== 'default') {
        preg_match("/[0-9]+/", $id, $count);
        $count = $count[0];
      }
      else {
        $count = '';
      }
      if (empty($title)) {

        // If there is no title provided, use the plugin title, and if there are
        // multiple displays, append the count.
        $title = $plugin['title'];
        if ($count > 1) {
          $title .= ' ' . $count;
        }
      }
    }
    $display_options = array(
      'display_plugin' => $plugin_id,
      'id' => $id,
      'display_title' => $title,
      'position' => count($this->display),
      'display_options' => array(),
    );

    // Add the display options to the view.
    $this->display[$id] = $display_options;
    return $id;
  }

  /**
   * Generates a display ID of a certain plugin type.
   *
   * @param string $plugin_id
   *   Which plugin should be used for the new display ID.
   */
  protected function generateDisplayId($plugin_id) {

    // 'default' is singular and is unique, so just go with 'default'
    // for it. For all others, start counting.
    if ($plugin_id == 'default') {
      return 'default';
    }

    // Initial ID.
    $id = $plugin_id . '_1';
    $count = 1;

    // Loop through IDs based upon our style plugin name until
    // we find one that is unused.
    while (!empty($this->display[$id])) {
      $id = $plugin_id . '_' . ++$count;
    }
    return $id;
  }

  /**
   * Creates a new display and a display handler instance for it.
   *
   * @param string $plugin_id
   *   (optional) The plugin type from the Views plugin annotation. Defaults to
   *   'page'.
   * @param string $title
   *   (optional) The title of the display. Defaults to NULL.
   * @param string $id
   *   (optional) The ID to use, e.g., 'default', 'page_1', 'block_2'. Defaults
   *   to NULL.
   *
   * @return string|\Drupal\views\Plugin\views\display\DisplayPluginBase
   *   A new display plugin instance if executable is set, the new display ID
   *   otherwise.
   */
  public function newDisplay($plugin_id = 'page', $title = NULL, $id = NULL) {
    $id = $this
      ->addDisplay($plugin_id, $title, $id);

    // We can't use get() here as it will create an ViewExecutable instance if
    // there is not already one.
    if (isset($this->executable)) {
      $executable = $this
        ->get('executable');
      $executable
        ->initDisplay();
      $executable->displayHandlers
        ->addInstanceID($id);
      return $executable->displayHandlers
        ->get($id);
    }
    return $id;
  }

  /**
   * {@inheritdoc}
   */
  public function &getDisplay($display_id) {
    return $this->display[$display_id];
  }

  /**
   * Gets a list of displays included in the view.
   *
   * @return array
   *   An array of display types that this view includes.
   */
  function getDisplaysList() {
    $manager = Views::pluginManager('display');
    $displays = array();
    foreach ($this->display as $display) {
      $definition = $manager
        ->getDefinition($display['display_plugin']);
      if (!empty($definition['admin'])) {
        $displays[$definition['admin']] = TRUE;
      }
    }
    ksort($displays);
    return array_keys($displays);
  }

  /**
   * Gets a list of paths assigned to the view.
   *
   * @return array
   *   An array of paths for this view.
   */
  public function getPaths() {
    $all_paths = array();
    if (empty($this->display)) {
      $all_paths[] = t('Edit this view to add a display.');
    }
    else {
      foreach ($this->display as $display) {
        if (!empty($display['display_options']['path'])) {
          $path = $display['display_options']['path'];
          if ($this
            ->status() && strpos($path, '%') === FALSE) {
            $all_paths[] = l('/' . $path, $path);
          }
          else {
            $all_paths[] = check_plain('/' . $path);
          }
        }
      }
    }
    return array_unique($all_paths);
  }

  /**
   * Overrides \Drupal\Core\Config\Entity\ConfigEntityBase::getExportProperties();
   */
  public function getExportProperties() {
    $names = array(
      'base_field',
      'base_table',
      'core',
      'description',
      'status',
      'display',
      'label',
      'module',
      'id',
      'tag',
      'uuid',
      'langcode',
    );
    $properties = array();
    foreach ($names as $name) {
      $properties[$name] = $this
        ->get($name);
    }
    return $properties;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityBase::$originalID	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$status	public	property	The enabled/disabled status of the configuration entity.	1
ConfigEntityBase::disable	public	function	Implements \Drupal\Core\Config\Entity\ConfigEntityInterface::disable(). Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Implements \Drupal\Core\Config\Entity\ConfigEntityInterface::enable(). Overrides ConfigEntityInterface::enable
ConfigEntityBase::getOriginalID	public	function	Implements ConfigEntityInterface::getOriginalID(). Overrides ConfigEntityInterface::getOriginalID
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::set	public	function	Overrides Entity::set(). Overrides Entity::set
ConfigEntityBase::setOriginalID	public	function	Implements ConfigEntityInterface::setOriginalID(). Overrides ConfigEntityInterface::setOriginalID
ConfigEntityBase::setStatus	public	function	Implements \Drupal\Core\Config\Entity\ConfigEntityInterface::setStatus(). Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	2
ConfigEntityBase::status	public	function	Implements \Drupal\Core\Config\Entity\ConfigEntityInterface::status(). Overrides ConfigEntityInterface::status	1
ConfigEntityBase::__construct	public	function	Overrides Entity::__construct(). Overrides Entity::__construct	9
Entity::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
Entity::$entityType	protected	property	The entity type.
Entity::$isDefaultRevision	protected	property	Indicates whether this is the default revision.	1
Entity::$langcode	public	property	The language code of the entity's default language.	7
Entity::$newRevision	protected	property	Boolean indicating whether a new revision should be created on save.
Entity::access	public	function	Implements \Drupal\Core\TypedData\AccessibleInterface::access(). Overrides AccessibleInterface::access
Entity::bundle	public	function	Implements \Drupal\Core\Entity\EntityInterface::bundle(). Overrides EntityInterface::bundle	4
Entity::delete	public	function	Implements \Drupal\Core\Entity\EntityInterface::delete(). Overrides EntityInterface::delete	3
Entity::enforceIsNew	public	function	Implements \Drupal\Core\Entity\EntityInterface::enforceIsNew(). Overrides EntityInterface::enforceIsNew
Entity::entityInfo	public	function	Implements \Drupal\Core\Entity\EntityInterface::entityInfo(). Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Implements \Drupal\Core\Entity\EntityInterface::entityType(). Overrides EntityInterface::entityType
Entity::getBCEntity	public	function	Implements \Drupal\Core\Entity\EntityInterface::getBCEntity(). Overrides EntityInterface::getBCEntity	1
Entity::getConstraints	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getConstraints(). Overrides TypedDataInterface::getConstraints
Entity::getDefinition	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getDefinition(). Overrides TypedDataInterface::getDefinition
Entity::getIterator	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getIterator().	1
Entity::getName	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getName(). Overrides TypedDataInterface::getName
Entity::getNGEntity	public	function	Implements \Drupal\Core\Entity\EntityInterface::getNGEntity(). Overrides EntityInterface::getNGEntity
Entity::getParent	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getParent(). Overrides TypedDataInterface::getParent
Entity::getProperties	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getProperties(). Overrides ComplexDataInterface::getProperties	1
Entity::getPropertyDefinition	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyDefinition(). Overrides ComplexDataInterface::getPropertyDefinition	1
Entity::getPropertyDefinitions	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyDefinitions(). Overrides ComplexDataInterface::getPropertyDefinitions	1
Entity::getPropertyPath	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getPropertyPath(). Overrides TypedDataInterface::getPropertyPath
Entity::getPropertyValues	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyValues(). Overrides ComplexDataInterface::getPropertyValues	1
Entity::getRevisionId	public	function	Implements \Drupal\Core\Entity\EntityInterface::getRevisionId(). Overrides EntityInterface::getRevisionId	4
Entity::getRoot	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getRoot(). Overrides TypedDataInterface::getRoot
Entity::getString	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getString(). Overrides TypedDataInterface::getString
Entity::getTranslation	public	function	Implements \Drupal\Core\TypedData\TranslatableInterface::getTranslation(). Overrides TranslatableInterface::getTranslation	1
Entity::getTranslationLanguages	public	function	Implements \Drupal\Core\TypedData\TranslatableInterface::getTranslationLanguages(). Overrides TranslatableInterface::getTranslationLanguages	1
Entity::getType	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getType(). Overrides TypedDataInterface::getType	2
Entity::getValue	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getValue(). Overrides TypedDataInterface::getValue
Entity::id	public	function	Implements \Drupal\Core\Entity\EntityInterface::id(). Overrides EntityInterface::id	11
Entity::isDefaultRevision	public	function	Implements \Drupal\Core\Entity\EntityInterface::isDefaultRevision(). Overrides EntityInterface::isDefaultRevision	1
Entity::isEmpty	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::isEmpty(). Overrides ComplexDataInterface::isEmpty	1
Entity::isNewRevision	public	function	Implements \Drupal\Core\Entity\EntityInterface::isNewRevision(). Overrides EntityInterface::isNewRevision
Entity::isTranslatable	public	function	Implements \Drupal\Core\Entity\EntityInterface::isTranslatable(). Overrides EntityInterface::isTranslatable
Entity::language	public	function	Implements \Drupal\Core\TypedData\TranslatableInterface::language(). Overrides TranslatableInterface::language	1
Entity::onChange	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::onChange(). Overrides ComplexDataInterface::onChange
Entity::save	public	function	Implements \Drupal\Core\Entity\EntityInterface::save(). Overrides EntityInterface::save	6
Entity::setContext	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::setContext(). Overrides TypedDataInterface::setContext
Entity::setNewRevision	public	function	Implements \Drupal\Core\Entity\EntityInterface::setNewRevision(). Overrides EntityInterface::setNewRevision
Entity::setPropertyValues	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::setPropertyValues(). Overrides ComplexDataInterface::setPropertyValues	1
Entity::setValue	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::setValue(). Overrides TypedDataInterface::setValue
Entity::translations	public	function	Returns the languages the entity is translated to.	1
Entity::uriRelationships	public	function	Returns a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::uuid	public	function	Implements \Drupal\Core\Entity\EntityInterface::uuid(). Overrides EntityInterface::uuid	1
Entity::validate	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::validate(). Overrides TypedDataInterface::validate	1
View::$base_field	protected	property	The name of the base field to use.
View::$base_table	protected	property	The name of the base table this view will use.
View::$core	protected	property	The core version the view was created for.
View::$description	protected	property	The description of the view, which is used only in the interface.
View::$display	protected	property	Stores all display handlers of this view.
View::$executable	protected	property	Stores a reference to the executable version of this view.
View::$id	public	property	The unique ID of the view.
View::$label	protected	property	The label of the view.
View::$module	protected	property	The module implementing this view.
View::$tag	protected	property	The "tags" of a view.
View::$uuid	public	property	The UUID for this entity.
View::addDisplay	public	function	Adds a new display handler to the view, automatically creating an ID.
View::createDuplicate	public	function	Overrides Drupal\Core\Config\Entity\ConfigEntityBase::createDuplicate(). Overrides ConfigEntityBase::createDuplicate
View::generateDisplayId	protected	function	Generates a display ID of a certain plugin type.
View::get	public	function	Overrides Drupal\Core\Entity\EntityInterface::get(). Overrides ConfigEntityBase::get
View::getDisplay	public	function	Retrieves a specific display's configuration by reference. Overrides ViewStorageInterface::getDisplay
View::getDisplaysList		function	Gets a list of displays included in the view.
View::getExportProperties	public	function	Overrides \Drupal\Core\Config\Entity\ConfigEntityBase::getExportProperties(); Overrides ConfigEntityBase::getExportProperties
View::getPaths	public	function	Gets a list of paths assigned to the view.
View::label	public	function	Overrides \Drupal\Core\Entity\Entity::label(). Overrides Entity::label
View::newDisplay	public	function	Creates a new display and a display handler instance for it.
View::uri	public	function	Overrides Drupal\Core\Entity\EntityInterface::uri(). Overrides Entity::uri

Main menu

Search Drupal 8.x

API Navigation

class View

Plugin annotation

Hierarchy

File

Namespace

Members

Main menu

You are here

Search Drupal 8.x

API Navigation

class View

Plugin annotation

Hierarchy

File

Namespace

Members