class PageManagerLayoutBuilderStorage in Page Manager 8.4

A Page Manager storage service that stores Layout Builder displays.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\page_manager\Plugin\LayoutBuilderStorage\PageManagerLayoutBuilderStorage implements ContainerFactoryPluginInterface

File

src/Plugin/LayoutBuilderStorage/PageManagerLayoutBuilderStorage.php, line 16

Namespace

Drupal\page_manager\Plugin\LayoutBuilderStorage

class PageManagerLayoutBuilderStorage extends PluginBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a PageManagerLayoutBuilderStorage.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'));
  }

  /**
   * Load a page variant entity.
   *
   * @param string $id
   *   The page variant entity's id.
   *
   * @return \Drupal\page_manager\PageVariantInterface
   *   The variant object.
   *
   * @throws \Exception
   */
  protected function loadPageVariant($id) {
    return $this->entityTypeManager
      ->getStorage('page_variant')
      ->load($id);
  }

  /**
   * {@inheritdoc}
   */
  public function save(LayoutBuilderDisplayVariant $lb_display) {
    $id = $lb_display
      ->getStorageId();
    if ($id && ($page_variant = $this
      ->loadPageVariant($id))) {
      $variant_plugin = $page_variant
        ->getVariantPlugin();
      if (!$variant_plugin instanceof LayoutBuilderDisplayVariant) {
        throw new \Exception("Page variant doesn't use a Layout Builder display variant");
      }
      $variant_plugin
        ->setConfiguration($lb_display
        ->getConfiguration());
      $page_variant
        ->save();
    }
    else {
      throw new \Exception("Couldn't find page variant to store Layout Builder display");
    }
  }

  /**
   * {@inheritdoc}
   */
  public function load($id) {
    if ($page_variant = $this
      ->loadPageVariant($id)) {
      $lb_display = $page_variant
        ->getVariantPlugin();

      // If this page variant doesn't have a Panels display on it, then we treat
      // it the same as if there was no such page variant.
      if (!$lb_display instanceof LayoutBuilderDisplayVariant) {
        return NULL;
      }

      // Pass down the contexts because the display has no other way to get them
      // from the variant.
      $lb_display
        ->setContexts($page_variant
        ->getContexts());
      return $lb_display;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function access($id, $op, AccountInterface $account) {
    if ($op == 'change layout') {
      $op = 'update';
    }
    if ($page_variant = $this
      ->loadPageVariant($id)) {
      return $page_variant
        ->access($op, $account, TRUE);
    }
    return AccessResult::forbidden();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PageManagerLayoutBuilderStorage::$entityTypeManager	protected	property	The entity type manager.
PageManagerLayoutBuilderStorage::access	public	function
PageManagerLayoutBuilderStorage::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PageManagerLayoutBuilderStorage::load	public	function
PageManagerLayoutBuilderStorage::loadPageVariant	protected	function	Load a page variant entity.
PageManagerLayoutBuilderStorage::save	public	function
PageManagerLayoutBuilderStorage::__construct	public	function	Constructs a PageManagerLayoutBuilderStorage. Overrides PluginBase::__construct
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.