page_manager-8.x-4.0-beta6/src/Entity/PageVariant.php
src/Entity/PageVariant.php
<?php
namespace Drupal\page_manager\Entity;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Condition\ConditionPluginCollection;
use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Plugin\DefaultSingleLazyPluginCollection;
use Drupal\page_manager\PageInterface;
use Drupal\page_manager\PageVariantInterface;
/**
* Defines the page variant entity.
*
* @ConfigEntityType(
* id = "page_variant",
* label = @Translation("Page Variant"),
* handlers = {
* "view_builder" = "Drupal\page_manager\Entity\PageVariantViewBuilder",
* "access" = "Drupal\page_manager\Entity\PageVariantAccess",
* },
* admin_permission = "administer pages",
* entity_keys = {
* "id" = "id",
* "label" = "label",
* "uuid" = "uuid"
* },
* config_export = {
* "id",
* "label",
* "uuid",
* "variant",
* "variant_settings",
* "page",
* "weight",
* "selection_criteria",
* "selection_logic",
* "static_context",
* },
* lookup_keys = {
* "page"
* }
* )
*/
class PageVariant extends ConfigEntityBase implements PageVariantInterface {
/**
* The ID of the page variant entity.
*
* @var string
*/
protected $id;
/**
* The label of the page variant entity.
*
* @var string
*/
protected $label;
/**
* The weight of the page variant entity.
*
* @var int
*/
protected $weight = 0;
/**
* The UUID of the page variant entity.
*
* @var string
*/
protected $uuid;
/**
* The ID of the variant plugin.
*
* @var string
*/
protected $variant;
/**
* The plugin configuration for the variant plugin.
*
* @var array
*/
protected $variant_settings = [];
/**
* The ID of the page entity this page variant entity belongs to.
*
* @var string
*/
protected $page;
/**
* The loaded page entity this page variant entity belongs to.
*
* @var \Drupal\page_manager\PageInterface
*/
protected $pageEntity;
/**
* The plugin configuration for the selection criteria condition plugins.
*
* @var array
*/
protected $selection_criteria = [];
/**
* The selection logic for this page variant entity (either 'and' or 'or').
*
* @var string
*/
protected $selection_logic = 'and';
/**
* An array of collected contexts.
*
* @var \Drupal\Component\Plugin\Context\ContextInterface[]|null
*/
protected $contexts = NULL;
/**
* Static context references.
*
* A list of arrays with the keys name, label, type and value.
*
* @var array[]
*/
protected $static_context = [];
/**
* The plugin collection that holds the single variant plugin instance.
*
* @var \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection
*/
protected $variantPluginCollection;
/**
* The plugin collection that holds the selection condition plugins.
*
* @var \Drupal\Component\Plugin\LazyPluginCollection
*/
protected $selectionConditionCollection;
/**
* {@inheritdoc}
*/
protected function invalidateTagsOnSave($update) {
parent::invalidateTagsOnSave($update);
// The parent doesn't invalidate the entity cache tags on save because the
// config system will invalidate them, but since we're using the parent
// page's cache tags, we need to invalidate them special.
Cache::invalidateTags($this->getCacheTagsToInvalidate());
}
/**
* {@inheritdoc}
*/
protected static function invalidateTagsOnDelete(EntityTypeInterface $entity_type, array $entities) {
parent::invalidateTagsOnDelete($entity_type, $entities);
// The parent doesn't invalidate the entity cache tags on delete because the
// config system will invalidate them, but since we're using the parent
// page's cache tags, we need to invalidate them special.
$tags = [];
foreach ($entities as $entity) {
$tags = Cache::mergeTags($tags, $entity->getCacheTagsToInvalidate());
}
Cache::invalidateTags($tags);
}
/**
* {@inheritdoc}
*/
public function getCacheTagsToInvalidate() {
// We use the same cache tags as the parent page.
return $this->getPage()->getCacheTagsToInvalidate();
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
parent::calculateDependencies();
$this->addDependency('config', $this->getPage()->getConfigDependencyName());
foreach ($this->getSelectionConditions() as $instance) {
$this->calculatePluginDependencies($instance);
}
return $this->getDependencies();
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'selection_criteria' => $this->getSelectionConditions(),
'variant_settings' => $this->getVariantPluginCollection(),
];
}
/**
* Get the plugin collection that holds the single variant plugin instance.
*
* @return \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection
* The plugin collection that holds the single variant plugin instance.
*/
protected function getVariantPluginCollection() {
if (!$this->variantPluginCollection) {
if (empty($this->variant_settings['uuid'])) {
$this->variant_settings['uuid'] = $this->uuidGenerator()->generate();
}
$this->variantPluginCollection = new DefaultSingleLazyPluginCollection(\Drupal::service('plugin.manager.display_variant'), $this->variant, $this->variant_settings);
}
return $this->variantPluginCollection;
}
/**
* {@inheritdoc}
*/
public function getVariantPlugin() {
return $this->getVariantPluginCollection()->get($this->variant);
}
/**
* {@inheritdoc}
*/
public function getVariantPluginId() {
return $this->variant;
}
/**
* {@inheritdoc}
*/
public function setVariantPluginId($variant) {
$this->variant = $variant;
return $this;
}
/**
* {@inheritdoc}
*/
public function getPage() {
if (!$this->pageEntity) {
if (!$this->page) {
throw new \UnexpectedValueException('The page variant has no associated page');
}
$this->pageEntity = $this->getPageStorage()->load($this->page);
if (!$this->pageEntity) {
throw new \UnexpectedValueException(sprintf('The page %s could not be loaded', $this->page));
}
}
return $this->pageEntity;
}
/**
* {@inheritdoc}
*/
public function setPageEntity(PageInterface $page) {
$this->pageEntity = $page;
$this->page = $page->id();
return $this;
}
/**
* {@inheritdoc}
*/
public function getContexts() {
if (is_null($this->contexts)) {
$static_contexts = $this->getContextMapper()->getContextValues($this->getStaticContexts());
$page_contexts = $this->getPage()->getContexts();
$this->contexts = $page_contexts + $static_contexts;
}
return $this->contexts;
}
/**
* {@inheritdoc}
*/
public function resetCollectedContexts() {
$this->contexts = NULL;
return $this;
}
/**
* {@inheritdoc}
*/
public function getWeight() {
return $this->weight;
}
/**
* {@inheritdoc}
*/
public function setWeight($weight) {
$this->weight = $weight;
return $this;
}
/**
* {@inheritdoc}
*/
public function getSelectionLogic() {
return $this->get('selection_logic');
}
/**
* {@inheritdoc}
*/
protected function getSelectionConfiguration() {
return $this->get('selection_criteria');
}
/**
* {@inheritdoc}
*/
public function getSelectionConditions() {
if (!$this->selectionConditionCollection) {
$this->selectionConditionCollection = new ConditionPluginCollection($this->getConditionManager(), $this->getSelectionConfiguration());
}
return $this->selectionConditionCollection;
}
/**
* {@inheritdoc}
*/
public function addSelectionCondition(array $configuration) {
$configuration['uuid'] = $this->uuidGenerator()->generate();
$this->getSelectionConditions()->addInstanceId($configuration['uuid'], $configuration);
return $configuration['uuid'];
}
/**
* {@inheritdoc}
*/
public function getSelectionCondition($condition_id) {
return $this->getSelectionConditions()->get($condition_id);
}
/**
* {@inheritdoc}
*/
public function removeSelectionCondition($condition_id) {
$this->getSelectionConditions()->removeInstanceId($condition_id);
return $this;
}
/**
* {@inheritdoc}
*/
public function getStaticContexts() {
return $this->static_context;
}
/**
* {@inheritdoc}
*/
public function getStaticContext($name) {
if (isset($this->static_context[$name])) {
return $this->static_context[$name];
}
return [];
}
/**
* {@inheritdoc}
*/
public function setStaticContext($name, $configuration) {
$this->static_context[$name] = $configuration;
$this->resetCollectedContexts();
return $this;
}
/**
* {@inheritdoc}
*/
public function removeStaticContext($name) {
unset($this->static_context[$name]);
$this->resetCollectedContexts();
return $this;
}
/**
* {@inheritdoc}
*/
protected function urlRouteParameters($rel) {
$parameters = parent::urlRouteParameters($rel);
$parameters['page'] = $this->get('page');
return $parameters;
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
static::routeBuilder()->setRebuildNeeded();
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
static::routeBuilder()->setRebuildNeeded();
}
/**
* Wraps the route builder.
*
* @return \Drupal\Core\Routing\RouteBuilderInterface
* An object for state storage.
*/
protected static function routeBuilder() {
return \Drupal::service('router.builder');
}
/**
* Wraps the condition plugin manager.
*
* @return \Drupal\Core\Condition\ConditionManager
* The condition manager service.
*/
protected function getConditionManager() {
return \Drupal::service('plugin.manager.condition');
}
/**
* Wraps the context mapper.
*
* @return \Drupal\page_manager\ContextMapperInterface
* The context mapper service.
*/
protected function getContextMapper() {
return \Drupal::service('page_manager.context_mapper');
}
/**
* Wraps the page entity storage.
*
* @return \Drupal\Core\Entity\EntityStorageInterface
* The Page entity storage service.
*/
protected function getPageStorage() {
return \Drupal::entityTypeManager()->getStorage('page');
}
/**
* {@inheritdoc}
*/
public function __sleep(): array {
$vars = parent::__sleep();
// Gathered contexts objects should not be serialized.
if (($key = array_search('contexts', $vars)) !== FALSE) {
unset($vars[$key]);
}
return $vars;
}
}
