class View in Zircon Profile 8
Same name in this branch
- 8 core/modules/views/src/Element/View.php \Drupal\views\Element\View
- 8 core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
- 8 core/modules/views/src/Plugin/views/area/View.php \Drupal\views\Plugin\views\area\View
Same name and namespace in other branches
- 8.0 core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
Defines a View configuration entity class.
Plugin annotation
@ConfigEntityType(
id = "view",
label = @Translation("View", context = "View entity type"),
handlers = {
"access" = "Drupal\views\ViewAccessControlHandler"
},
admin_permission = "administer views",
entity_keys = {
"id" = "id",
"label" = "label",
"status" = "status"
},
config_export = {
"id",
"label",
"module",
"description",
"tag",
"base_table",
"base_field",
"core",
"display",
}
)
Hierarchy
- class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
- class \Drupal\views\Entity\View implements ViewEntityInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
Expanded class hierarchy of View
28 files declare their use of View
- AreaEntityTest.php in core/
modules/ views/ src/ Tests/ Handler/ AreaEntityTest.php - Contains \Drupal\views\Tests\Handler\AreaEntityTest.
- AreaEntityUITest.php in core/
modules/ views_ui/ src/ Tests/ AreaEntityUITest.php - Contains \Drupal\views_ui\Tests\AreaEntityUITest.
- AreaTitleWebTest.php in core/
modules/ views/ src/ Tests/ Handler/ AreaTitleWebTest.php - Contains \Drupal\views\Tests\Handler\AreaTitleWebTest.
- ArgumentPlaceholderUpdatePathTest.php in core/
modules/ views/ src/ Tests/ Update/ ArgumentPlaceholderUpdatePathTest.php - Contains \Drupal\views\Tests\Update\ArgumentPlaceholderUpdatePathTest.
- BlockXssTest.php in core/
modules/ block/ src/ Tests/ BlockXssTest.php - Contains \Drupal\block\Tests\BlockXssTest.
22 string references to 'View'
- aggregator.links.task.yml in core/
modules/ aggregator/ aggregator.links.task.yml - core/modules/aggregator/aggregator.links.task.yml
- BookAdminEditForm::bookAdminTableTree in core/
modules/ book/ src/ Form/ BookAdminEditForm.php - Helps build the main table in the book administration page form.
- BookAdminEditForm::submitForm in core/
modules/ book/ src/ Form/ BookAdminEditForm.php - Form submission handler.
- BookTest::testAdminBookNodeListing in core/
modules/ book/ src/ Tests/ BookTest.php - Tests the administrative listing of all book pages in a book.
- CommentForm::save in core/
modules/ comment/ src/ CommentForm.php - Form submission handler for the 'save' action.
File
- core/
modules/ views/ src/ Entity/ View.php, line 46 - Contains \Drupal\views\Entity\View.
Namespace
Drupal\views\EntityView source
class View extends ConfigEntityBase implements ViewEntityInterface {
/**
* The name of the base table this view will use.
*
* @var string
*/
protected $base_table = 'node';
/**
* The unique ID of the view.
*
* @var string
*/
protected $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 string
*/
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';
/**
* 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';
/**
* {@inheritdoc}
*/
public function getExecutable() {
// Ensure that an executable View is available.
if (!isset($this->executable)) {
$this->executable = Views::executableFactory()
->get($this);
}
return $this->executable;
}
/**
* {@inheritdoc}
*/
public function createDuplicate() {
$duplicate = parent::createDuplicate();
unset($duplicate->executable);
return $duplicate;
}
/**
* {@inheritdoc}
*/
public function label() {
if (!($label = $this
->get('label'))) {
$label = $this
->id();
}
return $label;
}
/**
* {@inheritdoc}
*/
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,
// Cast the display title to a string since it is an object.
// @see \Drupal\Core\StringTranslation\TranslatableMarkup
'display_title' => (string) $title,
'position' => $id === 'default' ? 0 : 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.
*
* @return string
*/
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;
}
/**
* {@inheritdoc}
*/
public function &getDisplay($display_id) {
return $this->display[$display_id];
}
/**
* {@inheritdoc}
*/
public function duplicateDisplayAsType($old_display_id, $new_display_type) {
$executable = $this
->getExecutable();
$display = $executable
->newDisplay($new_display_type);
$new_display_id = $display->display['id'];
$displays = $this
->get('display');
// Let the display title be generated by the addDisplay method and set the
// right display plugin, but keep the rest from the original display.
$display_duplicate = $displays[$old_display_id];
unset($display_duplicate['display_title']);
unset($display_duplicate['display_plugin']);
$displays[$new_display_id] = NestedArray::mergeDeep($displays[$new_display_id], $display_duplicate);
$displays[$new_display_id]['id'] = $new_display_id;
// First set the displays.
$this
->set('display', $displays);
// Ensure that we just copy display options, which are provided by the new
// display plugin.
$executable
->setDisplay($new_display_id);
$executable->display_handler
->filterByDefinedOptions($displays[$new_display_id]['display_options']);
// Update the display settings.
$this
->set('display', $displays);
return $new_display_id;
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
parent::calculateDependencies();
// Ensure that the view is dependant on the module that implements the view.
$this
->addDependency('module', $this->module);
$executable = $this
->getExecutable();
$executable
->initDisplay();
$executable
->initStyle();
foreach ($executable->displayHandlers as $display) {
// Calculate the dependencies each display has.
$this
->calculatePluginDependencies($display);
}
return $this;
}
/**
* {@inheritdoc}
*/
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
// Sort the displays.
$display = $this
->get('display');
ksort($display);
$this
->set('display', array(
'default' => $display['default'],
) + $display);
// @todo Check whether isSyncing is needed.
if (!$this
->isSyncing()) {
$this
->addCacheMetadata();
}
}
/**
* Fills in the cache metadata of this view.
*
* Cache metadata is set per view and per display, and ends up being stored in
* the view's configuration. This allows Views to determine very efficiently:
* - the max-age
* - the cache contexts
* - the cache tags
*
* In other words: this allows us to do the (expensive) work of initializing
* Views plugins and handlers to determine their effect on the cacheability of
* a view at save time rather than at runtime.
*/
protected function addCacheMetadata() {
$executable = $this
->getExecutable();
$current_display = $executable->current_display;
$displays = $this
->get('display');
foreach (array_keys($displays) as $display_id) {
$display =& $this
->getDisplay($display_id);
$executable
->setDisplay($display_id);
$cache_metadata = $executable
->getDisplay()
->calculateCacheMetadata();
$display['cache_metadata']['max-age'] = $cache_metadata
->getCacheMaxAge();
$display['cache_metadata']['contexts'] = $cache_metadata
->getCacheContexts();
$display['cache_metadata']['tags'] = $cache_metadata
->getCacheTags();
// Always include at least the 'languages:' context as there will most
// probably be translatable strings in the view output.
$display['cache_metadata']['contexts'] = Cache::mergeContexts($display['cache_metadata']['contexts'], [
'languages:' . LanguageInterface::TYPE_INTERFACE,
]);
}
// Restore the previous active display.
$executable
->setDisplay($current_display);
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
// @todo Remove if views implements a view_builder controller.
views_invalidate_cache();
$this
->invalidateCaches();
// Rebuild the router if this is a new view, or it's status changed.
if (!isset($this->original) || $this
->status() != $this->original
->status()) {
\Drupal::service('router.builder')
->setRebuildNeeded();
}
}
/**
* {@inheritdoc}
*/
public static function postLoad(EntityStorageInterface $storage, array &$entities) {
parent::postLoad($storage, $entities);
foreach ($entities as $entity) {
$entity
->mergeDefaultDisplaysOptions();
}
}
/**
* {@inheritdoc}
*/
public static function preCreate(EntityStorageInterface $storage, array &$values) {
parent::preCreate($storage, $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(),
),
),
);
}
/**
* {@inheritdoc}
*/
public function postCreate(EntityStorageInterface $storage) {
parent::postCreate($storage);
$this
->mergeDefaultDisplaysOptions();
}
/**
* {@inheritdoc}
*/
public static function preDelete(EntityStorageInterface $storage, array $entities) {
parent::preDelete($storage, $entities);
// Call the remove() hook on the individual displays.
/** @var \Drupal\views\ViewEntityInterface $entity */
foreach ($entities as $entity) {
$executable = Views::executableFactory()
->get($entity);
foreach ($entity
->get('display') as $display_id => $display) {
$executable
->setDisplay($display_id);
$executable
->getDisplay()
->remove();
}
}
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
$tempstore = \Drupal::service('user.shared_tempstore')
->get('views');
foreach ($entities as $entity) {
$tempstore
->delete($entity
->id());
}
}
/**
* {@inheritdoc}
*/
public function mergeDefaultDisplaysOptions() {
$displays = array();
foreach ($this
->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;
}
$this
->set('display', $displays);
}
/**
* {@inheritdoc}
*/
public function isInstallable() {
$table_definition = \Drupal::service('views.views_data')
->get($this->base_table);
// Check whether the base table definition exists and contains a base table
// definition. For example, taxonomy_views_data_alter() defines
// node_field_data even if it doesn't exist as a base table.
return $table_definition && isset($table_definition['table']['base']);
}
/**
* {@inheritdoc}
*/
public function __sleep() {
$keys = parent::__sleep();
unset($keys[array_search('executable', $keys)]);
return $keys;
}
/**
* Invalidates cache tags.
*/
public function invalidateCaches() {
// Invalidate cache tags for cached rows.
$tags = $this
->getCacheTags();
\Drupal::service('cache_tags.invalidator')
->invalidateTags($tags);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigEntityBase:: |
private | property | Whether the config is being created, updated or deleted through the import process. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The name of the property that is used to store plugin configuration. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 2 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides Entity:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides Entity:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides Entity:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides Entity:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the status of the isSyncing flag. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides Entity:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides Entity:: |
10 |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | 1 |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
Entity:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
Entity:: |
protected | property | The entity type. | |
Entity:: |
protected | property | A typed data object wrapping this entity. | |
Entity:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
Entity:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
Entity:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
Entity:: |
protected | function | Gets the entity manager. | |
Entity:: |
protected | function | Gets the entity type manager. | |
Entity:: |
public | function |
The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
Entity:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
Entity:: |
protected | function | Gets the language manager. | |
Entity:: |
protected | function | Gets an array link templates. | 1 |
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
Entity:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Returns a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
Entity:: |
protected | function | Gets an array of placeholders for this entity. | 1 |
Entity:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
Entity:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
RefinableCacheableDependencyTrait:: |
protected | property | Cache contexts. | |
RefinableCacheableDependencyTrait:: |
protected | property | Cache max-age. | |
RefinableCacheableDependencyTrait:: |
protected | property | Cache tags. | |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
View:: |
protected | property | The name of the base field to use. | |
View:: |
protected | property | The name of the base table this view will use. | |
View:: |
protected | property | The core version the view was created for. | |
View:: |
protected | property | The description of the view, which is used only in the interface. | |
View:: |
protected | property | Stores all display handlers of this view. | |
View:: |
protected | property | Stores a reference to the executable version of this view. | |
View:: |
protected | property | The unique ID of the view. | |
View:: |
protected | property | The label of the view. | |
View:: |
protected | property | The module implementing this view. | |
View:: |
protected | property | The "tags" of a view. | |
View:: |
protected | function | Fills in the cache metadata of this view. | |
View:: |
public | function |
Adds a new display handler to the view, automatically creating an ID. Overrides ViewEntityInterface:: |
|
View:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase:: |
|
View:: |
public | function |
Creates a duplicate of the entity. Overrides ConfigEntityBase:: |
|
View:: |
public | function |
Duplicates an existing display into a new display type. Overrides ViewEntityInterface:: |
|
View:: |
protected | function | Generates a display ID of a certain plugin type. | |
View:: |
public | function |
Retrieves a specific display's configuration by reference. Overrides ViewEntityInterface:: |
|
View:: |
public | function |
Gets an executable instance for this view. Overrides ViewEntityInterface:: |
|
View:: |
public | function | Invalidates cache tags. | |
View:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityBase:: |
|
View:: |
public | function |
Gets the label of the entity. Overrides Entity:: |
|
View:: |
public | function |
Add defaults to the display options. Overrides ViewEntityInterface:: |
|
View:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides Entity:: |
|
View:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides Entity:: |
|
View:: |
public static | function |
Acts on loaded entities. Overrides Entity:: |
|
View:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides Entity:: |
|
View:: |
public static | function |
Changes the values of an entity before it is created. Overrides Entity:: |
|
View:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase:: |
|
View:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase:: |
|
View:: |
public | function |
Overrides Entity:: |