interface BlockContentInterface

Same name in other branches
  1. 8.9.x core/modules/block_content/src/BlockContentInterface.php \Drupal\block_content\BlockContentInterface
  2. 10 core/modules/block_content/src/BlockContentInterface.php \Drupal\block_content\BlockContentInterface
  3. 11.x core/modules/block_content/src/BlockContentInterface.php \Drupal\block_content\BlockContentInterface

Provides an interface defining a custom block entity.

Hierarchy

  • interface \Drupal\block_content\Access\RefinableDependentAccessInterface extends \Drupal\block_content\Access\DependentAccessInterface; interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable \Drupal\Core\Entity\FieldableEntityInterface \Drupal\Core\Entity\TranslatableRevisionableInterface \Drupal\Core\Entity\SynchronizableInterface; interface \Drupal\Core\Entity\EntityChangedInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\EntityPublishedInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\RevisionLogInterface extends \Drupal\Core\Entity\RevisionableInterface
    • interface \Drupal\block_content\BlockContentInterface extends \Drupal\Core\Entity\ContentEntityInterface \Drupal\Core\Entity\EntityChangedInterface \Drupal\Core\Entity\RevisionLogInterface \Drupal\Core\Entity\EntityPublishedInterface \Drupal\block_content\Access\RefinableDependentAccessInterface

Expanded class hierarchy of BlockContentInterface

All classes that implement BlockContentInterface

5 files declare their use of BlockContentInterface
BlockContent.php in core/modules/block_content/src/Entity/BlockContent.php
BlockContentEntityChangedConstraintValidator.php in core/modules/block_content/src/Plugin/Validation/Constraint/BlockContentEntityChangedConstraintValidator.php
BlockContentGetDependencyEvent.php in core/modules/block_content/src/Event/BlockContentGetDependencyEvent.php
MigrateCustomBlockTest.php in core/modules/block_content/tests/src/Kernel/Migrate/d7/MigrateCustomBlockTest.php
SetInlineBlockDependency.php in core/modules/layout_builder/src/EventSubscriber/SetInlineBlockDependency.php

File

core/modules/block_content/src/BlockContentInterface.php, line 14

Namespace

Drupal\block_content
View source
interface BlockContentInterface extends ContentEntityInterface, EntityChangedInterface, RevisionLogInterface, EntityPublishedInterface, RefinableDependentAccessInterface {
    
    /**
     * Sets the block description.
     *
     * @param string $info
     *   The block description.
     *
     * @return $this
     *   The class instance that this method is called on.
     */
    public function setInfo($info);
    
    /**
     * Determines if the block is reusable or not.
     *
     * @return bool
     *   Returns TRUE if reusable and FALSE otherwise.
     */
    public function isReusable();
    
    /**
     * Sets the block to be reusable.
     *
     * @return $this
     */
    public function setReusable();
    
    /**
     * Sets the block to be non-reusable.
     *
     * @return $this
     */
    public function setNonReusable();
    
    /**
     * Sets the theme value.
     *
     * When creating a new block content 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 block content add form is shown.
     *
     * @param string $theme
     *   The theme name.
     *
     * @return $this
     *   The class instance that this method is called on.
     */
    public function setTheme($theme);
    
    /**
     * Gets the theme value.
     *
     * When creating a new block content 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 block content add form is shown.
     *
     * @return string
     *   The theme name.
     */
    public function getTheme();
    
    /**
     * Gets the configured instances of this custom block.
     *
     * @return array
     *   Array of Drupal\block\Core\Plugin\Entity\Block entities.
     */
    public function getInstances();

}

Members

Title Sort descending Modifiers Object type Summary Overrides
AccessibleInterface::access public function Checks data value access. 9
BlockContentInterface::getInstances public function Gets the configured instances of this custom block. 1
BlockContentInterface::getTheme public function Gets the theme value. 1
BlockContentInterface::isReusable public function Determines if the block is reusable or not. 1
BlockContentInterface::setInfo public function Sets the block description. 1
BlockContentInterface::setNonReusable public function Sets the block to be non-reusable. 1
BlockContentInterface::setReusable public function Sets the block to be reusable. 1
BlockContentInterface::setTheme public function Sets the theme value. 1
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
DependentAccessInterface::getAccessDependency public function Gets the access dependency.
EntityChangedInterface::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
EntityChangedInterface::getChangedTimeAcrossTranslations public function Gets the timestamp of the last entity change across all translations.
EntityChangedInterface::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
EntityPublishedInterface::isPublished public function Returns whether or not the entity is published.
EntityPublishedInterface::setPublished public function Sets the entity as published.
EntityPublishedInterface::setUnpublished public function Sets the entity as unpublished.
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
RefinableDependentAccessInterface::addAccessDependency public function Adds an access dependency into the existing access dependency.
RefinableDependentAccessInterface::setAccessDependency public function Sets the access dependency.
RevisionableInterface::getLoadedRevisionId public function Gets the loaded Revision ID of the entity.
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity.
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision.
RevisionableInterface::isLatestRevision public function Checks if this entity is the latest revision.
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save.
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved.
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision.
RevisionableInterface::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID.
RevisionableInterface::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved.
RevisionLogInterface::getRevisionCreationTime public function Gets the entity revision creation timestamp. 1
RevisionLogInterface::getRevisionLogMessage public function Returns the entity revision log message.
RevisionLogInterface::getRevisionUser public function Gets the entity revision author.
RevisionLogInterface::getRevisionUserId public function Gets the entity revision author ID.
RevisionLogInterface::setRevisionCreationTime public function Sets the entity revision creation timestamp. 1
RevisionLogInterface::setRevisionLogMessage public function Sets the entity revision log message.
RevisionLogInterface::setRevisionUser public function Sets the entity revision author.
RevisionLogInterface::setRevisionUserId public function Sets the entity revision author by ID.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.