class Ds in Bootstrap Layouts 8.4

Handles Display Suite specific layout implementations.

Plugin annotation

@BootstrapLayoutsHandler("ds");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\bootstrap_layouts\Plugin\BootstrapLayouts\BootstrapLayoutsHandlerBase implements BootstrapLayoutsHandlerInterface uses \Symfony\Component\DependencyInjection\ContainerAwareTrait
      • class \Drupal\bootstrap_layouts\Plugin\BootstrapLayouts\Ds

File

src/Plugin/BootstrapLayouts/Ds.php, line 13

Namespace

Drupal\bootstrap_layouts\Plugin\BootstrapLayouts

class Ds extends BootstrapLayoutsHandlerBase {

  /**
   * {@inheritdoc}
   */
  public function loadInstances(array $entity_ids = NULL) {
    $layouts = [];

    /** @var \Drupal\Core\Entity\Display\EntityDisplayInterface $display */
    foreach (EntityViewDisplay::loadMultiple($entity_ids) as $entity_id => $display) {
      if (($info = $display
        ->getThirdPartySettings('ds')) && isset($info['layout']['id'])) {
        $id = $info['layout']['id'];
        $regions = $info['regions'];
        $settings = $info['layout']['settings'];
        $path = isset($info['layout']['path']) ? $info['layout']['path'] : '';
        $layouts[$entity_id] = new BootstrapLayout($id, $regions, $settings, $path);
      }
    }
    return $layouts;
  }

  /**
   * {@inheritdoc}
   */
  public function saveInstances(array $layouts = []) {
    $displays = EntityViewDisplay::loadMultiple(array_keys($layouts));

    /** @var \Drupal\bootstrap_layouts\BootstrapLayout[] $layouts */
    foreach ($layouts as $entity_id => $layout) {

      /** @var \Drupal\Core\Entity\Display\EntityDisplayInterface $display */
      $display = $displays[$entity_id];
      $info = $display
        ->getThirdPartySettings('ds');
      $info['layout']['id'] = $layout
        ->getId();
      $info['regions'] = $layout
        ->getRegions();
      $info['layout']['settings'] = $layout
        ->getSettings();
      $info['layout']['path'] = $layout
        ->getPath();

      // Unfortunately, there is no "setThirdPartySettings" method, so each
      // property must be iterated over manually, set and then saved.
      foreach ($info as $key => $value) {
        $display
          ->setThirdPartySetting('ds', $key, $value);
      }
      $display
        ->save();
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BootstrapLayoutsHandlerBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BootstrapLayoutsHandlerBase::getLabel	public	function	Retrieves the human readable label for the plugin. Overrides BootstrapLayoutsHandlerInterface::getLabel
BootstrapLayoutsHandlerBase::loadInstance	public	function	Loads a specific layout instance. Overrides BootstrapLayoutsHandlerInterface::loadInstance
BootstrapLayoutsHandlerBase::saveInstance	public	function	Saves a specific layout instance. Overrides BootstrapLayoutsHandlerInterface::saveInstance
BootstrapLayoutsHandlerBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
Ds::loadInstances	public	function	Loads layout instances. Overrides BootstrapLayoutsHandlerInterface::loadInstances
Ds::saveInstances	public	function	Saves layout instances. Overrides BootstrapLayoutsHandlerInterface::saveInstances
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.