Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\views;
Chris@0: 
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines an interface for View storage classes.
Chris@0:  */
Chris@0: interface ViewEntityInterface extends ConfigEntityInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets an executable instance for this view.
Chris@0:    *
Chris@0:    * @return \Drupal\views\ViewExecutable
Chris@0:    *   A view executable instance.
Chris@0:    */
Chris@0:   public function getExecutable();
Chris@0: 
Chris@0:   /**
Chris@0:    * Retrieves a specific display's configuration by reference.
Chris@0:    *
Chris@0:    * @param string $display_id
Chris@0:    *   The display ID to retrieve, e.g., 'default', 'page_1', 'block_2'.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   A reference to the specified display configuration.
Chris@0:    */
Chris@0:   public function &getDisplay($display_id);
Chris@0: 
Chris@0:   /**
Chris@0:    * Add defaults to the display options.
Chris@0:    */
Chris@0:   public function mergeDefaultDisplaysOptions();
Chris@0: 
Chris@0:   /**
Chris@0:    * Duplicates an existing display into a new display type.
Chris@0:    *
Chris@0:    * For example clone to display a page display as a block display.
Chris@0:    *
Chris@0:    * @param string $old_display_id
Chris@0:    *   The origin of the duplicated display.
Chris@0:    * @param string $new_display_type
Chris@0:    *   The display type of the new display.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   The display ID of the new display.
Chris@0:    */
Chris@0:   public function duplicateDisplayAsType($old_display_id, $new_display_type);
Chris@0: 
Chris@0:   /**
Chris@0:    * Adds a new display handler to the view, automatically creating an ID.
Chris@0:    *
Chris@0:    * @param string $plugin_id
Chris@0:    *   (optional) The plugin type from the Views plugin annotation. Defaults to
Chris@0:    *   'page'.
Chris@0:    * @param string $title
Chris@0:    *   (optional) The title of the display. Defaults to NULL.
Chris@0:    * @param string $id
Chris@0:    *   (optional) The ID to use, e.g., 'default', 'page_1', 'block_2'. Defaults
Chris@0:    *   to NULL.
Chris@0:    *
Chris@0:    * @return string|bool
Chris@0:    *   The key to the display in $view->display, or FALSE if no plugin ID was
Chris@0:    *   provided.
Chris@0:    */
Chris@0:   public function addDisplay($plugin_id = 'page', $title = NULL, $id = NULL);
Chris@0: 
Chris@0: }