class PanelizerDefaultPanelsStorage in Panelizer 8.3

Panels storage service that stores Panels displays in Panelizer defaults.

Plugin annotation

@PanelsStorage("panelizer_default");

Hierarchy

• class \Drupal\panelizer\Plugin\PanelsStorage\PanelizerDefaultPanelsStorage extends \Drupal\panels\Storage\PanelsStorageBase implements ContainerFactoryPluginInterface

1 file declares its use of PanelizerDefaultPanelsStorage

PanelizerDefaultPanelsStorageTest.php in tests/src/Unit/PanelizerDefaultPanelsStorageTest.php

File

src/Plugin/PanelsStorage/PanelizerDefaultPanelsStorage.php, line 23

Namespace

Drupal\panelizer\Plugin\PanelsStorage

class PanelizerDefaultPanelsStorage extends PanelsStorageBase implements ContainerFactoryPluginInterface {

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

  /**
   * @var \Drupal\panelizer\PanelizerInterface
   */
  protected $panelizer;

  /**
   * Constructs a PanelizerDefaultPanelsStorage.
   *
   * @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.
   * @param \Drupal\panelizer\PanelizerInterface $panelizer
   *   The Panelizer service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, PanelizerInterface $panelizer) {
    $this->entityTypeManager = $entity_type_manager;
    $this->panelizer = $panelizer;
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@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'), $container
      ->get('panelizer'));
  }

  /**
   * Converts the storage id into its component parts.
   *
   * @param string $id
   *   The storage id. There are two formats that can potentially be used:
   *   - The first is the normal format that we actually store:
   *     "entity_type_id:bundle:view_mode:name"
   *   - The second is a special internal format we use in the IPE so we can
   *   correctly set context:
   *     "*entity_type_id:entity_id:view_mode:name"
   *
   * @return array
   *   An array with 4 or 5 items:
   *   - Entity type id: string
   *   - Bundle name: string
   *   - View mode: string
   *   - Default name: string
   *   - Entity: \Drupal\Core\Entity\EntityInterface|NULL
   *
   * @throws \Drupal\panelizer\Exception\PanelizerException
   */
  protected function parseId($id) {
    list($entity_type_id, $part_two, $view_mode, $name) = explode(':', $id);
    if (strpos($entity_type_id, '*') === 0) {
      $entity_type_id = substr($entity_type_id, 1);
      $storage = $this->entityTypeManager
        ->getStorage($entity_type_id);
      if ($entity = $storage
        ->load($part_two)) {
        $bundle = $entity
          ->bundle();
      }
      else {
        throw new PanelizerException("Unable to load {$entity_type_id} with id {$part_two}");
      }
    }
    else {
      $entity = NULL;
      $bundle = $part_two;
    }
    return [
      $entity_type_id,
      $bundle,
      $view_mode,
      $name,
      $entity,
    ];
  }

  /**
   * Returns the entity context.
   *
   * Wraps creating new Context objects to avoid typed data in tests.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param \Drupal\Core\Entity\EntityInterface|NULL $entity
   *   The entity.
   *
   * @return \Drupal\Core\Plugin\Context\Context[]
   *   The available contexts.
   */
  protected function getEntityContext($entity_type_id, EntityInterface $entity = NULL) {
    $contexts = [];

    // Set a placeholder context so that the calling code knows that we need
    // an entity context. If we have the value available, then we actually set
    // the context value.
    $contexts['@panelizer.entity_context:entity'] = new Context(new ContextDefinition('entity:' . $entity_type_id, NULL, TRUE), $entity);
    return $contexts;
  }

  /**
   * {@inheritdoc}
   */
  public function load($id) {
    try {
      list($entity_type_id, $bundle, $view_mode, $name, $entity) = $this
        ->parseId($id);
      if ($panels_display = $this->panelizer
        ->getDefaultPanelsDisplay($name, $entity_type_id, $bundle, $view_mode)) {
        $contexts = $this
          ->getEntityContext($entity_type_id, $entity);
        $contexts = $contexts + $this->panelizer
          ->getDisplayStaticContexts($name, $entity_type_id, $bundle, $view_mode);
        $panels_display
          ->setContexts($contexts);
        return $panels_display;
      }
    } catch (PanelizerException $e) {

      // Do nothing to fallback on returning NULL.
    }
  }

  /**
   * {@inheritdoc}
   */
  public function save(PanelsDisplayVariant $panels_display) {
    $id = $panels_display
      ->getStorageId();
    try {
      list($entity_type_id, $bundle, $view_mode, $name) = $this
        ->parseId($id);
      $this->panelizer
        ->setDefaultPanelsDisplay($name, $entity_type_id, $bundle, $view_mode, $panels_display);
    } catch (PanelizerException $e) {
      throw new \Exception("Couldn't find Panelizer default to store Panels display");
    }
  }

  /**
   * {@inheritdoc}
   */
  public function access($id, $op, AccountInterface $account) {
    try {
      list($entity_type_id, $bundle, $view_mode, $name) = $this
        ->parseId($id);
    } catch (PanelizerException $e) {
      return AccessResult::forbidden();
    }
    if ($panels_display = $this->panelizer
      ->getDefaultPanelsDisplay($name, $entity_type_id, $bundle, $view_mode)) {
      if ($op == 'change layout') {
        if ($this->panelizer
          ->hasDefaultPermission('change layout', $entity_type_id, $bundle, $view_mode, $name, $account)) {
          return AccessResult::allowed();
        }
      }
      else {
        if ($op == 'read' || $this->panelizer
          ->hasDefaultPermission('change content', $entity_type_id, $bundle, $view_mode, $name, $account)) {
          return AccessResult::allowed();
        }
      }
    }
    return AccessResult::forbidden();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PanelizerDefaultPanelsStorage::$entityTypeManager	protected	property
PanelizerDefaultPanelsStorage::$panelizer	protected	property
PanelizerDefaultPanelsStorage::access	public	function
PanelizerDefaultPanelsStorage::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PanelizerDefaultPanelsStorage::getEntityContext	protected	function	Returns the entity context.
PanelizerDefaultPanelsStorage::load	public	function
PanelizerDefaultPanelsStorage::parseId	protected	function	Converts the storage id into its component parts.
PanelizerDefaultPanelsStorage::save	public	function
PanelizerDefaultPanelsStorage::__construct	public	function	Constructs a PanelizerDefaultPanelsStorage.