interface ViewEntityInterface
Same name and namespace in other branches
- 11.x core/modules/views/src/ViewEntityInterface.php \Drupal\views\ViewEntityInterface
- 10 core/modules/views/src/ViewEntityInterface.php \Drupal\views\ViewEntityInterface
- 8.9.x core/modules/views/src/ViewEntityInterface.php \Drupal\views\ViewEntityInterface
Defines an interface for View storage classes.
Hierarchy
- interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\EntityInterface extends \Drupal\Core\Access\AccessibleInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Cache\RefinableCacheableDependencyInterface; interface \Drupal\Core\Entity\SynchronizableInterface extends \Drupal\Core\Entity\EntityInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface, \Drupal\Core\Config\Entity\ThirdPartySettingsInterface, \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\views\ViewEntityInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface, \Drupal\Core\Config\Entity\ThirdPartySettingsInterface, \Drupal\Core\Entity\SynchronizableInterface
Expanded class hierarchy of ViewEntityInterface
All classes that implement ViewEntityInterface
17 files declare their use of ViewEntityInterface
- AddHandler.php in core/
modules/ views_ui/ src/ Form/ Ajax/ AddHandler.php - ConfigHandler.php in core/
modules/ views_ui/ src/ Form/ Ajax/ ConfigHandler.php - ConfigHandlerExtra.php in core/
modules/ views_ui/ src/ Form/ Ajax/ ConfigHandlerExtra.php - ConfigHandlerGroup.php in core/
modules/ views_ui/ src/ Form/ Ajax/ ConfigHandlerGroup.php - Display.php in core/
modules/ views_ui/ src/ Form/ Ajax/ Display.php
File
-
core/
modules/ views/ src/ ViewEntityInterface.php, line 10
Namespace
Drupal\viewsView source
interface ViewEntityInterface extends ConfigEntityInterface {
/**
* Gets an executable instance for this view.
*
* @return \Drupal\views\ViewExecutable
* A view executable instance.
*/
public function getExecutable();
/**
* Retrieves a specific display's configuration by reference.
*
* @param string $display_id
* The display ID to retrieve, e.g., 'default', 'page_1', 'block_2'.
*
* @return array
* A reference to the specified display configuration.
*/
public function &getDisplay($display_id);
/**
* Add defaults to the display options.
*/
public function mergeDefaultDisplaysOptions();
/**
* Duplicates an existing display into a new display type.
*
* For example clone to display a page display as a block display.
*
* @param string $old_display_id
* The origin of the duplicated display.
* @param string $new_display_type
* The display type of the new display.
*
* @return string
* The display ID of the new display.
*/
public function duplicateDisplayAsType($old_display_id, $new_display_type);
/**
* 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|bool
* 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);
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.