You are here

interface BootstrapLayoutsHandlerInterface in Bootstrap Layouts 8.5

Same name and namespace in other branches
  1. 8.4 src/Plugin/BootstrapLayouts/BootstrapLayoutsHandlerInterface.php \Drupal\bootstrap_layouts\Plugin\BootstrapLayouts\BootstrapLayoutsHandlerInterface

Interface BootstrapLayoutsHandlerInterface

Hierarchy

Expanded class hierarchy of BootstrapLayoutsHandlerInterface

All classes that implement BootstrapLayoutsHandlerInterface

File

src/Plugin/BootstrapLayouts/BootstrapLayoutsHandlerInterface.php, line 14

Namespace

Drupal\bootstrap_layouts\Plugin\BootstrapLayouts
View source
interface BootstrapLayoutsHandlerInterface extends ContainerAwareInterface, ContainerFactoryPluginInterface, DerivativeInspectionInterface, PluginInspectionInterface {

  /**
   * Retrieves the human readable label for the plugin.
   *
   * @return string
   *   The human readable label.
   */
  public function getLabel();

  /**
   * Loads a specific layout instance.
   *
   * @param string|int $id
   *   The identifier to load.
   *
   * @return \Drupal\bootstrap_layouts\BootstrapLayout
   *   The BootstrapLayout instance.
   */
  public function loadInstance($id);

  /**
   * Loads layout instances.
   *
   * @param string[]|int[] $ids
   *   Optional. An array of identifiers to load. If no identifiers are
   *   specified, then all available instances will be loaded.
   *
   * @return \Drupal\bootstrap_layouts\BootstrapLayout[]
   *   An associative array of BootstrapLayout instances, keyed by identifier.
   */
  public function loadInstances(array $ids = NULL);

  /**
   * Saves a specific layout instance.
   *
   * @param string|int $id
   *   The identifier to save.
   * @param \Drupal\bootstrap_layouts\BootstrapLayout $layout
   *   The layout instance info array.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   *   In case of failures an exception is thrown.
   */
  public function saveInstance($id, BootstrapLayout $layout);

  /**
   * Saves layout instances.
   *
   * @param \Drupal\bootstrap_layouts\BootstrapLayout[] $layouts
   *   An associative array of BootstrapLayout instances, keyed by identifier.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   *   In case of failures an exception is thrown.
   */
  public function saveInstances(array $layouts = []);

}

Members

Namesort descending Modifiers Type Description Overrides
BootstrapLayoutsHandlerInterface::getLabel public function Retrieves the human readable label for the plugin. 1
BootstrapLayoutsHandlerInterface::loadInstance public function Loads a specific layout instance. 1
BootstrapLayoutsHandlerInterface::loadInstances public function Loads layout instances. 2
BootstrapLayoutsHandlerInterface::saveInstance public function Saves a specific layout instance. 1
BootstrapLayoutsHandlerInterface::saveInstances public function Saves layout instances. 2
ContainerFactoryPluginInterface::create public static function Creates an instance of the plugin. 112
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2