Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 11 |
CRAP | |
0.00% |
0 / 92 |
| BlockContent | |
0.00% |
0 / 1 |
|
0.00% |
0 / 11 |
272 | |
0.00% |
0 / 92 |
| createDuplicate | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 5 |
|||
| setTheme | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
| getTheme | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| postSave | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
| getInstances | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| preSaveRevision | |
0.00% |
0 / 1 |
30 | |
0.00% |
0 / 5 |
|||
| delete | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| baseFieldDefinitions | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 59 |
|||
| getRevisionLog | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| setInfo | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
| setRevisionLog | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\block_content\Entity\BlockContent. | |
| */ | |
| namespace Drupal\block_content\Entity; | |
| use Drupal\Core\Entity\ContentEntityBase; | |
| use Drupal\Core\Entity\EntityChangedTrait; | |
| use Drupal\Core\Entity\EntityStorageInterface; | |
| use Drupal\Core\Entity\EntityTypeInterface; | |
| use Drupal\Core\Field\BaseFieldDefinition; | |
| use Drupal\block_content\BlockContentInterface; | |
| /** | |
| * Defines the custom block entity class. | |
| * | |
| * @ContentEntityType( | |
| * id = "block_content", | |
| * label = @Translation("Custom block"), | |
| * bundle_label = @Translation("Custom block type"), | |
| * handlers = { | |
| * "storage" = "Drupal\Core\Entity\Sql\SqlContentEntityStorage", | |
| * "access" = "Drupal\block_content\BlockContentAccessControlHandler", | |
| * "list_builder" = "Drupal\block_content\BlockContentListBuilder", | |
| * "view_builder" = "Drupal\block_content\BlockContentViewBuilder", | |
| * "views_data" = "Drupal\block_content\BlockContentViewsData", | |
| * "form" = { | |
| * "add" = "Drupal\block_content\BlockContentForm", | |
| * "edit" = "Drupal\block_content\BlockContentForm", | |
| * "delete" = "Drupal\block_content\Form\BlockContentDeleteForm", | |
| * "default" = "Drupal\block_content\BlockContentForm" | |
| * }, | |
| * "translation" = "Drupal\block_content\BlockContentTranslationHandler" | |
| * }, | |
| * admin_permission = "administer blocks", | |
| * base_table = "block_content", | |
| * revision_table = "block_content_revision", | |
| * data_table = "block_content_field_data", | |
| * links = { | |
| * "canonical" = "/block/{block_content}", | |
| * "delete-form" = "/block/{block_content}/delete", | |
| * "edit-form" = "/block/{block_content}", | |
| * "collection" = "/admin/structure/block/block-content", | |
| * }, | |
| * translatable = TRUE, | |
| * entity_keys = { | |
| * "id" = "id", | |
| * "revision" = "revision_id", | |
| * "bundle" = "type", | |
| * "label" = "info", | |
| * "langcode" = "langcode", | |
| * "uuid" = "uuid" | |
| * }, | |
| * bundle_entity_type = "block_content_type", | |
| * field_ui_base_route = "entity.block_content_type.edit_form", | |
| * render_cache = FALSE, | |
| * ) | |
| * | |
| * Note that render caching of block_content entities is disabled because they | |
| * are always rendered as blocks, and blocks already have their own render | |
| * caching. | |
| * See https://www.drupal.org/node/2284917#comment-9132521 for more information. | |
| */ | |
| class BlockContent extends ContentEntityBase implements BlockContentInterface { | |
| use EntityChangedTrait; | |
| /** | |
| * The theme the block is being created in. | |
| * | |
| * When creating a new custom block from the block library, the user is | |
| * redirected to the configure form for that block in the given theme. The | |
| * theme is stored against the block when the custom block add form is shown. | |
| * | |
| * @var string | |
| */ | |
| protected $theme; | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function createDuplicate() { | |
| $duplicate = parent::createDuplicate(); | |
| $duplicate->revision_id->value = NULL; | |
| $duplicate->id->value = NULL; | |
| return $duplicate; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function setTheme($theme) { | |
| $this->theme = $theme; | |
| return $this; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getTheme() { | |
| return $this->theme; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function postSave(EntityStorageInterface $storage, $update = TRUE) { | |
| parent::postSave($storage, $update); | |
| // Invalidate the block cache to update custom block-based derivatives. | |
| \Drupal::service('plugin.manager.block')->clearCachedDefinitions(); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getInstances() { | |
| return entity_load_multiple_by_properties('block', array('plugin' => 'block_content:' . $this->uuid())); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function preSaveRevision(EntityStorageInterface $storage, \stdClass $record) { | |
| parent::preSaveRevision($storage, $record); | |
| if (!$this->isNewRevision() && isset($this->original) && (!isset($record->revision_log) || $record->revision_log === '')) { | |
| // If we are updating an existing block_content without adding a new | |
| // revision and the user did not supply a revision log, keep the existing | |
| // one. | |
| $record->revision_log = $this->original->getRevisionLog(); | |
| } | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function delete() { | |
| foreach ($this->getInstances() as $instance) { | |
| $instance->delete(); | |
| } | |
| parent::delete(); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { | |
| $fields['id'] = BaseFieldDefinition::create('integer') | |
| ->setLabel(t('Custom block ID')) | |
| ->setDescription(t('The custom block ID.')) | |
| ->setReadOnly(TRUE) | |
| ->setSetting('unsigned', TRUE); | |
| $fields['uuid'] = BaseFieldDefinition::create('uuid') | |
| ->setLabel(t('UUID')) | |
| ->setDescription(t('The custom block UUID.')) | |
| ->setReadOnly(TRUE); | |
| $fields['revision_id'] = BaseFieldDefinition::create('integer') | |
| ->setLabel(t('Revision ID')) | |
| ->setDescription(t('The revision ID.')) | |
| ->setReadOnly(TRUE) | |
| ->setSetting('unsigned', TRUE); | |
| $fields['langcode'] = BaseFieldDefinition::create('language') | |
| ->setLabel(t('Language')) | |
| ->setDescription(t('The custom block language code.')) | |
| ->setTranslatable(TRUE) | |
| ->setRevisionable(TRUE) | |
| ->setDisplayOptions('view', array( | |
| 'type' => 'hidden', | |
| )) | |
| ->setDisplayOptions('form', array( | |
| 'type' => 'language_select', | |
| 'weight' => 2, | |
| )); | |
| $fields['info'] = BaseFieldDefinition::create('string') | |
| ->setLabel(t('Block description')) | |
| ->setDescription(t('A brief description of your block.')) | |
| ->setRevisionable(TRUE) | |
| ->setTranslatable(TRUE) | |
| ->setRequired(TRUE) | |
| ->setDisplayOptions('form', array( | |
| 'type' => 'string_textfield', | |
| 'weight' => -5, | |
| )) | |
| ->setDisplayConfigurable('form', TRUE) | |
| ->addConstraint('UniqueField', []); | |
| $fields['type'] = BaseFieldDefinition::create('entity_reference') | |
| ->setLabel(t('Block type')) | |
| ->setDescription(t('The block type.')) | |
| ->setSetting('target_type', 'block_content_type'); | |
| $fields['revision_log'] = BaseFieldDefinition::create('string_long') | |
| ->setLabel(t('Revision log message')) | |
| ->setDescription(t('The log entry explaining the changes in this revision.')) | |
| ->setRevisionable(TRUE); | |
| $fields['changed'] = BaseFieldDefinition::create('changed') | |
| ->setLabel(t('Changed')) | |
| ->setDescription(t('The time that the custom block was last edited.')) | |
| ->setTranslatable(TRUE) | |
| ->setRevisionable(TRUE); | |
| $fields['revision_translation_affected'] = BaseFieldDefinition::create('boolean') | |
| ->setLabel(t('Revision translation affected')) | |
| ->setDescription(t('Indicates if the last edit of a translation belongs to current revision.')) | |
| ->setReadOnly(TRUE) | |
| ->setRevisionable(TRUE) | |
| ->setTranslatable(TRUE); | |
| return $fields; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getRevisionLog() { | |
| return $this->get('revision_log')->value; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function setInfo($info) { | |
| $this->set('info', $info); | |
| return $this; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function setRevisionLog($revision_log) { | |
| $this->set('revision_log', $revision_log); | |
| return $this; | |
| } | |
| } |