class BlockContent in Zircon Profile 8

Same name in this branch

8 core/modules/block_content/src/Entity/BlockContent.php \Drupal\block_content\Entity\BlockContent
8 core/modules/block_content/src/Plugin/Derivative/BlockContent.php \Drupal\block_content\Plugin\Derivative\BlockContent

Same name and namespace in other branches

8.0 core/modules/block_content/src/Entity/BlockContent.php \Drupal\block_content\Entity\BlockContent

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.

Hierarchy

class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface
  - class \Drupal\block_content\Entity\BlockContent implements BlockContentInterface uses EntityChangedTrait

Expanded class hierarchy of BlockContent

11 files declare their use of BlockContent

BlockContentCreationTest.php in core/modules/block_content/src/Tests/BlockContentCreationTest.php: Contains \Drupal\block_content\Tests\BlockContentCreationTest.
BlockContentRevisionsTest.php in core/modules/block_content/src/Tests/BlockContentRevisionsTest.php: Contains \Drupal\block_content\Tests\BlockContentRevisionsTest.
BlockContentSaveTest.php in core/modules/block_content/src/Tests/BlockContentSaveTest.php: Contains \Drupal\block_content\Tests\BlockContentSaveTest.
BlockXssTest.php in core/modules/block/src/Tests/BlockXssTest.php: Contains \Drupal\block\Tests\BlockXssTest.
block_content_test.module in core/modules/block_content/tests/modules/block_content_test/block_content_test.module: A dummy module for testing custom block related hooks.

... See full list

File

core/modules/block_content/src/Entity/BlockContent.php, line 67: Contains \Drupal\block_content\Entity\BlockContent.

Namespace

Drupal\block_content\Entity

View source

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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockContent::$theme	protected	property	The theme the block is being created in.
BlockContent::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type. Overrides FieldableEntityInterface::baseFieldDefinitions
BlockContent::createDuplicate	public	function	Creates a duplicate of the entity. Overrides ContentEntityBase::createDuplicate
BlockContent::delete	public	function	Deletes an entity permanently. Overrides Entity::delete
BlockContent::getInstances	public	function	Gets the configured instances of this custom block. Overrides BlockContentInterface::getInstances
BlockContent::getRevisionLog	public	function	Returns the block revision log message. Overrides BlockContentInterface::getRevisionLog
BlockContent::getTheme	public	function	Gets the theme value. Overrides BlockContentInterface::getTheme
BlockContent::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides Entity::postSave
BlockContent::preSaveRevision	public	function	Acts on a revision before it gets saved. Overrides ContentEntityBase::preSaveRevision
BlockContent::setInfo	public	function	Sets the block description. Overrides BlockContentInterface::setInfo
BlockContent::setRevisionLog	public	function	Sets the block revision log message. Overrides BlockContentInterface::setRevisionLog
BlockContent::setTheme	public	function	Sets the theme value. Overrides BlockContentInterface::setTheme
ContentEntityBase::$activeLangcode	protected	property	Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode	protected	property	Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey	protected	property	The default langcode entity key.
ContentEntityBase::$entityKeys	protected	property	Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions	protected	property	Local cache for field definitions.
ContentEntityBase::$fields	protected	property	The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$isDefaultRevision	protected	property	Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey	protected	property	The language entity key.
ContentEntityBase::$languages	protected	property	Local cache for the available language objects.
ContentEntityBase::$newRevision	protected	property	Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$translatableEntityKeys	protected	property	Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize	protected	property	A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations	protected	property	An array of entity translation metadata.
ContentEntityBase::$validated	protected	property	Whether entity validation was performed.
ContentEntityBase::$validationRequired	protected	property	Whether entity validation is required before saving the entity.
ContentEntityBase::$values	protected	property	The plain data values of the contained fields.
ContentEntityBase::access	public	function	Checks data value access. Overrides Entity::access	1
ContentEntityBase::addTranslation	public	function	Adds a new translation to the translatable object. Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle	public	function	Gets the bundle of the entity. Overrides Entity::bundle
ContentEntityBase::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions	3
ContentEntityBase::clearTranslationCache	protected	function	Clear entity translation object cache to remove stale references.
ContentEntityBase::get	public	function	Gets a field item list. Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey	protected	function	Gets the value of the given entity key, if defined.
ContentEntityBase::getFieldDefinition	public	function	Gets the definition of a contained field. Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions	public	function	Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields	public	function	Gets an array of all field item lists. Overrides FieldableEntityInterface::getFields
ContentEntityBase::getIterator	public	function
ContentEntityBase::getLanguages	protected	function
ContentEntityBase::getRevisionId	public	function	Gets the revision identifier of the entity. Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields	public	function	Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField	protected	function	Gets a translated field.
ContentEntityBase::getTranslation	public	function	Gets a translation of the data. Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages	public	function	Returns the languages the data is translated to. Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getUntranslated	public	function	Returns the translatable object referring to the original language. Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField	public	function	Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation	public	function	Returns TRUE there is a translation for the given language code. Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges	public	function	Determines if the current translation of the entity has unsaved changes. Overrides ContentEntityInterface::hasTranslationChanges
ContentEntityBase::id	public	function	Gets the identifier. Overrides Entity::id
ContentEntityBase::initializeTranslation	protected	function	Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision	public	function	Checks if this entity is the default revision. Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation	public	function	Checks whether the translation is the default one. Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isNewRevision	public	function	Determines whether a new revision should be created on save. Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation	public	function	Checks whether the translation is new. Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected	public	function	Checks whether the current translation is affected by the current revision. Overrides ContentEntityInterface::isRevisionTranslationAffected
ContentEntityBase::isTranslatable	public	function	Returns the translation support status. Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired	public	function	Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::label	public	function	Gets the label of the entity. Overrides Entity::label	3
ContentEntityBase::language	public	function	Gets the language of the entity. Overrides Entity::language
ContentEntityBase::onChange	public	function	Reacts to changes to a field. Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate	public	function	Acts on an entity after it is created but before hooks are invoked. Overrides Entity::postCreate
ContentEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides Entity::preSave	5
ContentEntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides Entity::referencedEntities	1
ContentEntityBase::removeTranslation	public	function	Removes the translation identified by the given language code. Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set	public	function	Sets a field value. Overrides FieldableEntityInterface::set
ContentEntityBase::setDefaultLangcode	protected	function	Populates the local cache for the default language code.
ContentEntityBase::setNewRevision	public	function	Enforces an entity to be saved as a new revision. Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected	public	function	Marks the current revision translation as affected. Overrides ContentEntityInterface::setRevisionTranslationAffected
ContentEntityBase::setValidationRequired	public	function	Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::toArray	public	function	Gets an array of all property values. Overrides Entity::toArray
ContentEntityBase::TRANSLATION_CREATED		constant	Status code identifying a newly created translation.
ContentEntityBase::TRANSLATION_EXISTING		constant	Status code identifying an existing translation.
ContentEntityBase::TRANSLATION_REMOVED		constant	Status code identifying a removed translation.
ContentEntityBase::updateFieldLangcodes	protected	function	Updates language for already instantiated fields.
ContentEntityBase::updateOriginalValues	public	function	Updates the original values with the interim changes.
ContentEntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides Entity::uuid
ContentEntityBase::validate	public	function	Validates the currently set values. Overrides FieldableEntityInterface::validate
ContentEntityBase::__clone	public	function	Magic method: Implements a deep clone.
ContentEntityBase::__construct	public	function	Constructs an Entity object. Overrides Entity::__construct
ContentEntityBase::__get	public	function	Implements the magic method for getting object properties.
ContentEntityBase::__isset	public	function	Implements the magic method for isset().
ContentEntityBase::__set	public	function	Implements the magic method for setting object properties.
ContentEntityBase::__sleep	public	function	Overrides Entity::__sleep
ContentEntityBase::__unset	public	function	Implements the magic method for unset().
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
Entity::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId	protected	property	The entity type.
Entity::$typedData	protected	property	A typed data object wrapping this entity.
Entity::create	public static	function	Overrides EntityInterface::create
Entity::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated	protected	function	Gets the entity manager.
Entity::entityTypeManager	protected	function	Gets the entity type manager.
Entity::getCacheContexts	public	function	The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags	public	function	The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate	3
Entity::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName	1
Entity::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget	1
Entity::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getOriginalId	public	function	Gets the original ID. Overrides EntityInterface::getOriginalId	1
Entity::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::invalidateTagsOnDelete	protected static	function	Invalidates an entity's cache tags upon delete.	1
Entity::invalidateTagsOnSave	protected	function	Invalidates an entity's cache tags upon save.	1
Entity::isNew	public	function	Determines whether the entity is new. Overrides EntityInterface::isNew	2
Entity::languageManager	protected	function	Gets the language manager.
Entity::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link	1
Entity::linkTemplates	protected	function	Gets an array link templates.	1
Entity::load	public static	function	Overrides EntityInterface::load
Entity::loadMultiple	public static	function	Overrides EntityInterface::loadMultiple
Entity::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	14
Entity::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
Entity::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	6
Entity::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete	5
Entity::save	public	function	Saves an entity permanently. Overrides EntityInterface::save	2
Entity::setOriginalId	public	function	Sets the original ID. Overrides EntityInterface::setOriginalId	1
Entity::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::toUrl	public	function	Gets the URL object for the entity. Overrides EntityInterface::toUrl	1
Entity::uriRelationships	public	function	Returns a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::url	public	function	Gets the public URL for this entity. Overrides EntityInterface::url	2
Entity::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityInterface::urlInfo	1
Entity::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	1
Entity::uuidGenerator	protected	function	Gets the UUID generator.
EntityChangedTrait::getChangedTime	public	function	Gets the timestamp of the last entity change for the current translation.
EntityChangedTrait::getChangedTimeAcrossTranslations	public	function	Returns the timestamp of the last entity change across all translations.
EntityChangedTrait::setChangedTime	public	function	Sets the timestamp of the last entity change for the current translation.
RefinableCacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function

You are here

class BlockContent in Zircon Profile 8

Hierarchy

File

Namespace

Members

API Navigation