Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\block_content\Entity;
Chris@0: 
Chris@17: use Drupal\block_content\Access\RefinableDependentAccessTrait;
Chris@14: use Drupal\Core\Entity\EditorialContentEntityBase;
Chris@0: use Drupal\Core\Entity\EntityStorageInterface;
Chris@0: use Drupal\Core\Entity\EntityTypeInterface;
Chris@0: use Drupal\Core\Field\BaseFieldDefinition;
Chris@0: use Drupal\block_content\BlockContentInterface;
Chris@0: use Drupal\user\UserInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines the custom block entity class.
Chris@0:  *
Chris@0:  * @ContentEntityType(
Chris@0:  *   id = "block_content",
Chris@0:  *   label = @Translation("Custom block"),
Chris@17:  *   label_collection = @Translation("Custom blocks"),
Chris@17:  *   label_singular = @Translation("custom block"),
Chris@17:  *   label_plural = @Translation("custom blocks"),
Chris@17:  *   label_count = @PluralTranslation(
Chris@17:  *     singular = "@count custom block",
Chris@17:  *     plural = "@count custom blocks",
Chris@17:  *   ),
Chris@0:  *   bundle_label = @Translation("Custom block type"),
Chris@0:  *   handlers = {
Chris@0:  *     "storage" = "Drupal\Core\Entity\Sql\SqlContentEntityStorage",
Chris@0:  *     "access" = "Drupal\block_content\BlockContentAccessControlHandler",
Chris@0:  *     "list_builder" = "Drupal\block_content\BlockContentListBuilder",
Chris@0:  *     "view_builder" = "Drupal\block_content\BlockContentViewBuilder",
Chris@0:  *     "views_data" = "Drupal\block_content\BlockContentViewsData",
Chris@0:  *     "form" = {
Chris@0:  *       "add" = "Drupal\block_content\BlockContentForm",
Chris@0:  *       "edit" = "Drupal\block_content\BlockContentForm",
Chris@0:  *       "delete" = "Drupal\block_content\Form\BlockContentDeleteForm",
Chris@0:  *       "default" = "Drupal\block_content\BlockContentForm"
Chris@0:  *     },
Chris@0:  *     "translation" = "Drupal\block_content\BlockContentTranslationHandler"
Chris@0:  *   },
Chris@0:  *   admin_permission = "administer blocks",
Chris@0:  *   base_table = "block_content",
Chris@0:  *   revision_table = "block_content_revision",
Chris@0:  *   data_table = "block_content_field_data",
Chris@0:  *   revision_data_table = "block_content_field_revision",
Chris@0:  *   show_revision_ui = TRUE,
Chris@0:  *   links = {
Chris@0:  *     "canonical" = "/block/{block_content}",
Chris@0:  *     "delete-form" = "/block/{block_content}/delete",
Chris@0:  *     "edit-form" = "/block/{block_content}",
Chris@0:  *     "collection" = "/admin/structure/block/block-content",
Chris@0:  *     "create" = "/block",
Chris@0:  *   },
Chris@0:  *   translatable = TRUE,
Chris@0:  *   entity_keys = {
Chris@0:  *     "id" = "id",
Chris@0:  *     "revision" = "revision_id",
Chris@0:  *     "bundle" = "type",
Chris@0:  *     "label" = "info",
Chris@0:  *     "langcode" = "langcode",
Chris@14:  *     "uuid" = "uuid",
Chris@14:  *     "published" = "status",
Chris@0:  *   },
Chris@0:  *   revision_metadata_keys = {
Chris@0:  *     "revision_user" = "revision_user",
Chris@0:  *     "revision_created" = "revision_created",
Chris@0:  *     "revision_log_message" = "revision_log"
Chris@0:  *   },
Chris@0:  *   bundle_entity_type = "block_content_type",
Chris@0:  *   field_ui_base_route = "entity.block_content_type.edit_form",
Chris@0:  *   render_cache = FALSE,
Chris@0:  * )
Chris@0:  *
Chris@0:  * Note that render caching of block_content entities is disabled because they
Chris@0:  * are always rendered as blocks, and blocks already have their own render
Chris@0:  * caching.
Chris@0:  * See https://www.drupal.org/node/2284917#comment-9132521 for more information.
Chris@0:  */
Chris@14: class BlockContent extends EditorialContentEntityBase implements BlockContentInterface {
Chris@0: 
Chris@17:   use RefinableDependentAccessTrait;
Chris@17: 
Chris@0:   /**
Chris@0:    * The theme the block is being created in.
Chris@0:    *
Chris@0:    * When creating a new custom block from the block library, the user is
Chris@0:    * redirected to the configure form for that block in the given theme. The
Chris@0:    * theme is stored against the block when the custom block add form is shown.
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 createDuplicate() {
Chris@0:     $duplicate = parent::createDuplicate();
Chris@0:     $duplicate->revision_id->value = NULL;
Chris@0:     $duplicate->id->value = NULL;
Chris@0:     return $duplicate;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setTheme($theme) {
Chris@0:     $this->theme = $theme;
Chris@0:     return $this;
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 postSave(EntityStorageInterface $storage, $update = TRUE) {
Chris@0:     parent::postSave($storage, $update);
Chris@17:     if ($this->isReusable() || (isset($this->original) && $this->original->isReusable())) {
Chris@17:       static::invalidateBlockPluginCache();
Chris@17:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function postDelete(EntityStorageInterface $storage, array $entities) {
Chris@0:     parent::postDelete($storage, $entities);
Chris@17:     /** @var \Drupal\block_content\BlockContentInterface $block */
Chris@17:     foreach ($entities as $block) {
Chris@17:       if ($block->isReusable()) {
Chris@17:         // If any deleted blocks are reusable clear the block cache.
Chris@17:         static::invalidateBlockPluginCache();
Chris@17:         return;
Chris@17:       }
Chris@17:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getInstances() {
Chris@0:     return \Drupal::entityTypeManager()->getStorage('block')->loadByProperties(['plugin' => 'block_content:' . $this->uuid()]);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function preSaveRevision(EntityStorageInterface $storage, \stdClass $record) {
Chris@0:     parent::preSaveRevision($storage, $record);
Chris@0: 
Chris@0:     if (!$this->isNewRevision() && isset($this->original) && (!isset($record->revision_log) || $record->revision_log === '')) {
Chris@0:       // If we are updating an existing block_content without adding a new
Chris@0:       // revision and the user did not supply a revision log, keep the existing
Chris@0:       // one.
Chris@0:       $record->revision_log = $this->original->getRevisionLogMessage();
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function delete() {
Chris@0:     foreach ($this->getInstances() as $instance) {
Chris@0:       $instance->delete();
Chris@0:     }
Chris@0:     parent::delete();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
Chris@0:     /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
Chris@0:     $fields = parent::baseFieldDefinitions($entity_type);
Chris@0: 
Chris@0:     $fields['id']->setLabel(t('Custom block ID'))
Chris@0:       ->setDescription(t('The custom block ID.'));
Chris@0: 
Chris@0:     $fields['uuid']->setDescription(t('The custom block UUID.'));
Chris@0: 
Chris@0:     $fields['revision_id']->setDescription(t('The revision ID.'));
Chris@0: 
Chris@0:     $fields['langcode']->setDescription(t('The custom block language code.'));
Chris@0: 
Chris@0:     $fields['type']->setLabel(t('Block type'))
Chris@0:       ->setDescription(t('The block type.'));
Chris@0: 
Chris@14:     $fields['revision_log']->setDescription(t('The log entry explaining the changes in this revision.'));
Chris@14: 
Chris@0:     $fields['info'] = BaseFieldDefinition::create('string')
Chris@0:       ->setLabel(t('Block description'))
Chris@0:       ->setDescription(t('A brief description of your block.'))
Chris@0:       ->setRevisionable(TRUE)
Chris@0:       ->setTranslatable(TRUE)
Chris@0:       ->setRequired(TRUE)
Chris@0:       ->setDisplayOptions('form', [
Chris@0:         'type' => 'string_textfield',
Chris@0:         'weight' => -5,
Chris@0:       ])
Chris@0:       ->setDisplayConfigurable('form', TRUE)
Chris@0:       ->addConstraint('UniqueField', []);
Chris@0: 
Chris@0:     $fields['changed'] = BaseFieldDefinition::create('changed')
Chris@0:       ->setLabel(t('Changed'))
Chris@0:       ->setDescription(t('The time that the custom block was last edited.'))
Chris@0:       ->setTranslatable(TRUE)
Chris@0:       ->setRevisionable(TRUE);
Chris@0: 
Chris@17:     $fields['reusable'] = BaseFieldDefinition::create('boolean')
Chris@17:       ->setLabel(t('Reusable'))
Chris@17:       ->setDescription(t('A boolean indicating whether this block is reusable.'))
Chris@17:       ->setTranslatable(FALSE)
Chris@17:       ->setRevisionable(FALSE)
Chris@17:       ->setDefaultValue(TRUE);
Chris@17: 
Chris@0:     return $fields;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRevisionLog() {
Chris@0:     return $this->getRevisionLogMessage();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setInfo($info) {
Chris@0:     $this->set('info', $info);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setRevisionLog($revision_log) {
Chris@0:     return $this->setRevisionLogMessage($revision_log);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRevisionCreationTime() {
Chris@0:     return $this->get('revision_created')->value;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setRevisionCreationTime($timestamp) {
Chris@0:     $this->set('revision_created', $timestamp);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRevisionUser() {
Chris@0:     return $this->get('revision_user')->entity;
Chris@0:   }
Chris@0: 
Chris@0:   public function setRevisionUser(UserInterface $account) {
Chris@0:     $this->set('revision_user', $account);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRevisionUserId() {
Chris@0:     return $this->get('revision_user')->entity->id();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setRevisionUserId($user_id) {
Chris@0:     $this->set('revision_user', $user_id);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRevisionLogMessage() {
Chris@0:     return $this->get('revision_log')->value;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setRevisionLogMessage($revision_log_message) {
Chris@0:     $this->set('revision_log', $revision_log_message);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@17:    * {@inheritdoc}
Chris@17:    */
Chris@17:   public function isReusable() {
Chris@17:     return (bool) $this->get('reusable')->value;
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@17:    * {@inheritdoc}
Chris@17:    */
Chris@17:   public function setReusable() {
Chris@17:     return $this->set('reusable', TRUE);
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@17:    * {@inheritdoc}
Chris@17:    */
Chris@17:   public function setNonReusable() {
Chris@17:     return $this->set('reusable', FALSE);
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@0:    * Invalidates the block plugin cache after changes and deletions.
Chris@0:    */
Chris@0:   protected static function invalidateBlockPluginCache() {
Chris@0:     // Invalidate the block cache to update custom block-based derivatives.
Chris@0:     \Drupal::service('plugin.manager.block')->clearCachedDefinitions();
Chris@0:   }
Chris@0: 
Chris@0: }