Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\block\Entity;
Chris@0: 
Chris@0: use Drupal\Core\Cache\Cache;
Chris@0: use Drupal\Core\Condition\ConditionPluginCollection;
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityBase;
Chris@0: use Drupal\block\BlockPluginCollection;
Chris@0: use Drupal\block\BlockInterface;
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityInterface;
Chris@0: use Drupal\Core\Entity\EntityWithPluginCollectionInterface;
Chris@0: use Drupal\Core\Entity\EntityStorageInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a Block configuration entity class.
Chris@0:  *
Chris@0:  * @ConfigEntityType(
Chris@0:  *   id = "block",
Chris@0:  *   label = @Translation("Block"),
Chris@17:  *   label_collection = @Translation("Blocks"),
Chris@17:  *   label_singular = @Translation("block"),
Chris@17:  *   label_plural = @Translation("blocks"),
Chris@17:  *   label_count = @PluralTranslation(
Chris@17:  *     singular = "@count block",
Chris@17:  *     plural = "@count blocks",
Chris@17:  *   ),
Chris@0:  *   handlers = {
Chris@0:  *     "access" = "Drupal\block\BlockAccessControlHandler",
Chris@0:  *     "view_builder" = "Drupal\block\BlockViewBuilder",
Chris@0:  *     "list_builder" = "Drupal\block\BlockListBuilder",
Chris@0:  *     "form" = {
Chris@0:  *       "default" = "Drupal\block\BlockForm",
Chris@0:  *       "delete" = "Drupal\block\Form\BlockDeleteForm"
Chris@0:  *     }
Chris@0:  *   },
Chris@0:  *   admin_permission = "administer blocks",
Chris@0:  *   entity_keys = {
Chris@0:  *     "id" = "id",
Chris@0:  *     "status" = "status"
Chris@0:  *   },
Chris@0:  *   links = {
Chris@0:  *     "delete-form" = "/admin/structure/block/manage/{block}/delete",
Chris@0:  *     "edit-form" = "/admin/structure/block/manage/{block}",
Chris@0:  *     "enable" = "/admin/structure/block/manage/{block}/enable",
Chris@0:  *     "disable" = "/admin/structure/block/manage/{block}/disable",
Chris@0:  *   },
Chris@0:  *   config_export = {
Chris@0:  *     "id",
Chris@0:  *     "theme",
Chris@0:  *     "region",
Chris@0:  *     "weight",
Chris@0:  *     "provider",
Chris@0:  *     "plugin",
Chris@0:  *     "settings",
Chris@0:  *     "visibility",
Chris@0:  *   },
Chris@0:  *   lookup_keys = {
Chris@0:  *     "theme"
Chris@0:  *   }
Chris@0:  * )
Chris@0:  */
Chris@0: class Block extends ConfigEntityBase implements BlockInterface, EntityWithPluginCollectionInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The ID of the block.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $id;
Chris@0: 
Chris@0:   /**
Chris@0:    * The plugin instance settings.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $settings = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * The region this block is placed in.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $region;
Chris@0: 
Chris@0:   /**
Chris@0:    * The block weight.
Chris@0:    *
Chris@0:    * @var int
Chris@0:    */
Chris@0:   protected $weight;
Chris@0: 
Chris@0:   /**
Chris@0:    * The plugin instance ID.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $plugin;
Chris@0: 
Chris@0:   /**
Chris@0:    * The visibility settings for this block.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $visibility = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * The plugin collection that holds the block plugin for this entity.
Chris@0:    *
Chris@0:    * @var \Drupal\block\BlockPluginCollection
Chris@0:    */
Chris@0:   protected $pluginCollection;
Chris@0: 
Chris@0:   /**
Chris@0:    * The available contexts for this block and its visibility conditions.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $contexts = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * The visibility collection.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Condition\ConditionPluginCollection
Chris@0:    */
Chris@0:   protected $visibilityCollection;
Chris@0: 
Chris@0:   /**
Chris@0:    * The condition plugin manager.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Executable\ExecutableManagerInterface
Chris@0:    */
Chris@0:   protected $conditionPluginManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * The theme that includes the block plugin for this entity.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $theme;
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getPlugin() {
Chris@0:     return $this->getPluginCollection()->get($this->plugin);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Encapsulates the creation of the block's LazyPluginCollection.
Chris@0:    *
Chris@0:    * @return \Drupal\Component\Plugin\LazyPluginCollection
Chris@0:    *   The block's plugin collection.
Chris@0:    */
Chris@0:   protected function getPluginCollection() {
Chris@0:     if (!$this->pluginCollection) {
Chris@0:       $this->pluginCollection = new BlockPluginCollection(\Drupal::service('plugin.manager.block'), $this->plugin, $this->get('settings'), $this->id());
Chris@0:     }
Chris@0:     return $this->pluginCollection;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getPluginCollections() {
Chris@0:     return [
Chris@0:       'settings' => $this->getPluginCollection(),
Chris@0:       'visibility' => $this->getVisibilityConditions(),
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getPluginId() {
Chris@0:     return $this->plugin;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRegion() {
Chris@0:     return $this->region;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getTheme() {
Chris@0:     return $this->theme;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getWeight() {
Chris@0:     return $this->weight;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function label() {
Chris@0:     $settings = $this->get('settings');
Chris@0:     if ($settings['label']) {
Chris@0:       return $settings['label'];
Chris@0:     }
Chris@0:     else {
Chris@0:       $definition = $this->getPlugin()->getPluginDefinition();
Chris@0:       return $definition['admin_label'];
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Sorts active blocks by weight; sorts inactive blocks by name.
Chris@0:    */
Chris@0:   public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
Chris@0:     // Separate enabled from disabled.
Chris@0:     $status = (int) $b->status() - (int) $a->status();
Chris@0:     if ($status !== 0) {
Chris@0:       return $status;
Chris@0:     }
Chris@0: 
Chris@0:     // Sort by weight.
Chris@0:     $weight = $a->getWeight() - $b->getWeight();
Chris@0:     if ($weight) {
Chris@0:       return $weight;
Chris@0:     }
Chris@0: 
Chris@0:     // Sort by label.
Chris@0:     return strcmp($a->label(), $b->label());
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function calculateDependencies() {
Chris@0:     parent::calculateDependencies();
Chris@0:     $this->addDependency('theme', $this->theme);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function postSave(EntityStorageInterface $storage, $update = TRUE) {
Chris@0:     parent::postSave($storage, $update);
Chris@0: 
Chris@0:     // Entity::postSave() calls Entity::invalidateTagsOnSave(), which only
Chris@0:     // handles the regular cases. The Block entity has one special case: a
Chris@0:     // newly created block may *also* appear on any page in the current theme,
Chris@0:     // so we must invalidate the associated block's cache tag (which includes
Chris@0:     // the theme cache tag).
Chris@0:     if (!$update) {
Chris@0:       Cache::invalidateTags($this->getCacheTagsToInvalidate());
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getVisibility() {
Chris@0:     return $this->getVisibilityConditions()->getConfiguration();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setVisibilityConfig($instance_id, array $configuration) {
Chris@0:     $conditions = $this->getVisibilityConditions();
Chris@0:     if (!$conditions->has($instance_id)) {
Chris@0:       $configuration['id'] = $instance_id;
Chris@0:       $conditions->addInstanceId($instance_id, $configuration);
Chris@0:     }
Chris@0:     else {
Chris@0:       $conditions->setInstanceConfiguration($instance_id, $configuration);
Chris@0:     }
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getVisibilityConditions() {
Chris@0:     if (!isset($this->visibilityCollection)) {
Chris@0:       $this->visibilityCollection = new ConditionPluginCollection($this->conditionPluginManager(), $this->get('visibility'));
Chris@0:     }
Chris@0:     return $this->visibilityCollection;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getVisibilityCondition($instance_id) {
Chris@0:     return $this->getVisibilityConditions()->get($instance_id);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the condition plugin manager.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Executable\ExecutableManagerInterface
Chris@0:    *   The condition plugin manager.
Chris@0:    */
Chris@0:   protected function conditionPluginManager() {
Chris@0:     if (!isset($this->conditionPluginManager)) {
Chris@0:       $this->conditionPluginManager = \Drupal::service('plugin.manager.condition');
Chris@0:     }
Chris@0:     return $this->conditionPluginManager;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setRegion($region) {
Chris@0:     $this->region = $region;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setWeight($weight) {
Chris@0:     $this->weight = $weight;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function createDuplicateBlock($new_id = NULL, $new_theme = NULL) {
Chris@0:     $duplicate = parent::createDuplicate();
Chris@0:     if (!empty($new_id)) {
Chris@0:       $duplicate->id = $new_id;
Chris@0:     }
Chris@0:     if (!empty($new_theme)) {
Chris@0:       $duplicate->theme = $new_theme;
Chris@0:     }
Chris@0:     return $duplicate;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function preSave(EntityStorageInterface $storage) {
Chris@0:     parent::preSave($storage);
Chris@0: 
Chris@0:     // Ensure the region is valid to mirror the behavior of block_rebuild().
Chris@0:     // This is done primarily for backwards compatibility support of
Chris@0:     // \Drupal\block\BlockInterface::BLOCK_REGION_NONE.
Chris@0:     $regions = system_region_list($this->theme);
Chris@0:     if (!isset($regions[$this->region]) && $this->status()) {
Chris@0:       $this
Chris@0:         ->setRegion(system_default_region($this->theme))
Chris@0:         ->disable();
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }