class PageManagerPanelsStorage in Panels 8.3

A Panels storage service that stores Panels displays in Page Manager.

Plugin annotation

@PanelsStorage("page_manager");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\panels\Storage\PanelsStorageBase implements PanelsStorageInterface
    • class \Drupal\panels\Plugin\PanelsStorage\PageManagerPanelsStorage implements ContainerFactoryPluginInterface

1 file declares its use of PageManagerPanelsStorage

PanelsStorageTest.php in tests/src/Unit/PanelsStorageTest.php

Contains \Drupal\Tests\panels\Unit\PanelsStorageTest.

File

src/Plugin/PanelsStorage/PageManagerPanelsStorage.php, line 22

Namespace

Drupal\panels\Plugin\PanelsStorage

class PageManagerPanelsStorage extends PanelsStorageBase implements ContainerFactoryPluginInterface {

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a PageManagerPanelsStorage.
   *
   * @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
   */
  protected function loadPageVariant($id) {
    return $this->entityTypeManager
      ->getStorage('page_variant')
      ->load($id);
  }

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

  /**
   * {@inheritdoc}
   */
  public function load($id) {
    if ($page_variant = $this
      ->loadPageVariant($id)) {
      $panels_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 (!$panels_display instanceof PanelsDisplayVariant) {
        return NULL;
      }

      // Pass down the contexts because the display has no other way to get them
      // from the variant.
      $panels_display
        ->setContexts($page_variant
        ->getContexts());
      return $panels_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
PageManagerPanelsStorage::$entityTypeManager	protected	property
PageManagerPanelsStorage::access	public	function	Checks if the user has access to a Panels display. Overrides PanelsStorageInterface::access
PageManagerPanelsStorage::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PageManagerPanelsStorage::load	public	function	Loads a Panels display. Overrides PanelsStorageInterface::load
PageManagerPanelsStorage::loadPageVariant	protected	function	Load a page variant entity.
PageManagerPanelsStorage::save	public	function	Saves a Panels display. Overrides PanelsStorageInterface::save
PageManagerPanelsStorage::__construct	public	function	Constructs a PageManagerPanelsStorage. 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.