You are here

Home » API reference » Fixed Block Content 8 » FixedBlockContent.php

class FixedBlockContent in Fixed Block Content 8

Same name in this branch
  1. 8 src/Entity/FixedBlockContent.php \Drupal\fixed_block_content\Entity\FixedBlockContent
  2. 8 src/Plugin/Derivative/FixedBlockContent.php \Drupal\fixed_block_content\Plugin\Derivative\FixedBlockContent

Configuration entity for the fixed block content.

Plugin annotation


@ConfigEntityType(
  id = "fixed_block_content",
  label = @Translation("Fixed block content"),
  config_prefix = "fixed_block_content",
  entity_keys = {
    "id" = "id",
    "label" = "title"
  },
  handlers = {
    "access" = "Drupal\fixed_block_content\FixedBlockContentAccessControlHandler",
    "list_builder" = "Drupal\fixed_block_content\FixedBlockContentListBuilder",
    "content_handler" = "Drupal\fixed_block_content\DefaultContentHandler",
    "mapping_handler" = "Drupal\fixed_block_content\FixedToContentMappingHandler",
    "form" = {
      "add" = "Drupal\fixed_block_content\Form\FixedBlockContentForm",
      "edit" = "Drupal\fixed_block_content\Form\FixedBlockContentForm",
      "delete" = "Drupal\fixed_block_content\Form\FixedBlockContentDeleteForm",
      "export" = "Drupal\fixed_block_content\Form\ExportConfirmForm",
      "import" = "Drupal\fixed_block_content\Form\ImportConfirmForm"
    }
  },
  links = {
    "collection" = "/admin/structure/block/block-content/fixed-block-content",
    "canonical" = "/admin/structure/block/block-content/fixed-block-content/manage/{fixed_block_content}",
    "edit-form" = "/admin/structure/block/block-content/fixed-block-content/manage/{fixed_block_content}/edit",
    "delete-form" = "/admin/structure/block/block-content/fixed-block-content/manage/{fixed_block_content}/delete",
    "export-form" = "/admin/structure/block/block-content/fixed-block-content/manage/{fixed_block_content}/export",
    "import-form" = "/admin/structure/block/block-content/fixed-block-content/manage/{fixed_block_content}/import"
  },
  config_export = {
    "id",
    "title",
    "block_content_bundle",
    "default_content",
    "auto_export",
    "protected"
  }
)

Hierarchy

Expanded class hierarchy of FixedBlockContent

2 files declare their use of FixedBlockContent
FixedBlockContentBlock.php in src/Plugin/Block/FixedBlockContentBlock.php
fixed_block_content.module in ./fixed_block_content.module
Provides permanent custom content blocks.

File

src/Entity/FixedBlockContent.php, line 52

Namespace

Drupal\fixed_block_content\Entity
View source 
class FixedBlockContent extends ConfigEntityBase implements FixedBlockContentInterface {

  /**
   * The block ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The block title.
   *
   * @var string
   */
  protected $title;

  /**
   * The block content bundle.
   *
   * @var string
   */
  protected $block_content_bundle;

  /**
   * The serialized default content for this fixed block.
   *
   * @var string
   */
  protected $default_content;

  /**
   * Option to automatic export of default content on config update.
   *
   * @var int
   */
  protected $auto_export;

  /**
   * Option to set the custom block as non reusable.
   *
   * @var bool
   */
  protected $protected;

  /**
   * The current block content linked to this fixed block.
   *
   * @var \Drupal\block_content\BlockContentInterface
   *
   * @deprecated in fixed_block_content:8.x-1.0 and is removed from
   *   fixed_block_content:8.x-2.0. Use the mapping handler instead to get
   *   a cached version of the linked block content.
   *
   * @see https://www.drupal.org/project/fixed_block_content/issues/3070773
   */
  protected $blockContent;

  /**
   * {@inheritdoc}
   */
  public function getBlockContent($create = TRUE) {
    $block_content = $this
      ->getMappingHandler()
      ->getBlockContent($this
      ->id());
    if (!$block_content && $create) {
      $this
        ->exportDefaultContent();
      $block_content = $this
        ->getMappingHandler()
        ->getBlockContent($this
        ->id());
    }
    return $this->blockContent = $block_content;
  }

  /**
   * Links a block content with this fixed block.
   *
   * Any existing block content is not deleted, unless on protected fixed
   * blocks. If the given block is new, it will be saved to reference it.
   *
   * @param \Drupal\block_content\BlockContentInterface $block_content
   *   (optional) The new block content to link to this fixed block. New
   *    empty block is created if none given.
   *
   * @throws \InvalidArgumentException
   *   When the content type of the given block mismatches the configured type.
   */
  protected function setBlockContent(BlockContentInterface $block_content = NULL) {

    // Create a new empty block content if no one given.
    if (!$block_content) {
      $block_content = $this
        ->newBlockContent();
    }

    // Link this fixed block with the content block.
    $this
      ->getMappingHandler()
      ->setBlockContent($this, $block_content);
    $this->blockContent = $block_content;
  }

  /**
   * Creates a new block content.
   *
   * @return \Drupal\block_content\BlockContentInterface
   *   The new block content.
   */
  protected function newBlockContent() {

    /** @var \Drupal\block_content\BlockContentInterface $block_content */
    $block_content = $this
      ->getBlockContentStorage()
      ->create([
      'type' => $this->block_content_bundle,
      'info' => $this->title,
      'langcode' => $this
        ->languageManager()
        ->getDefaultLanguage()
        ->getId(),
    ]);
    $block_content
      ->enforceIsNew(TRUE);
    $block_content
      ->setNewRevision(FALSE);

    // Set the reusable flag in the new custom block according to the non
    // reusable option in the fixed block content.
    $block_content
      ->set('reusable', !$this
      ->isProtected());
    return $block_content;
  }

  /**
   * {@inheritdoc}
   */
  public function getBlockContentBundle() {
    return $this->block_content_bundle;
  }

  /**
   * {@inheritdoc}
   */
  public function exportDefaultContent($update_existing = FALSE) {
    $new_block_content = $this
      ->getDefaultContentHandler()
      ->exportDefaultContent($this) ?: $this
      ->newBlockContent();
    if ($current_block = $this
      ->getMappingHandler()
      ->getBlockContent($this
      ->id())) {
      if ($update_existing) {

        // Copy entity identifiers from the existing block into the new one.
        $new_block_content
          ->set('id', $current_block
          ->id());
        $new_block_content
          ->set('uuid', $current_block
          ->uuid());

        // Set the new block as not new entity.
        $new_block_content
          ->enforceIsNew(FALSE);

        // Do not create new revision.
        $new_block_content
          ->setNewRevision(FALSE);

        // Save the block, will update the existing.
        $new_block_content
          ->save();
      }
      else {

        // Delete the current block content.
        $current_block
          ->delete();
      }
    }
    $this
      ->setBlockContent($new_block_content);
  }

  /**
   * {@inheritdoc}
   */
  public function importDefaultContent() {
    $this
      ->getDefaultContentHandler()
      ->importDefaultContent($this);
  }

  /**
   * {@inheritdoc}
   */
  public function setAutoExportState($state = FixedBlockContentInterface::AUTO_EXPORT_ON_EMPTY) {
    $this->auto_export = $state;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getAutoExportState() {
    return $this->auto_export ?: FixedBlockContentInterface::AUTO_EXPORT_DISABLED;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();

    // Add dependency on the linked block content.
    if ($block_content = $this
      ->getBlockContent(FALSE)) {
      $this
        ->addDependency($block_content
        ->getConfigDependencyKey(), $block_content
        ->getConfigDependencyName());
    }

    // Add dependency on the configured block content type.
    $block_content_type = $this
      ->entityTypeManager()
      ->getStorage('block_content_type')
      ->load($this->block_content_bundle);
    $this
      ->addDependency($block_content_type
      ->getConfigDependencyKey(), $block_content_type
      ->getConfigDependencyName());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function postDelete(EntityStorageInterface $storage, array $entities) {
    parent::postDelete($storage, $entities);
    static::invalidateBlockPluginCache();

    /** @var \Drupal\fixed_block_content\FixedToContentMappingHandler $mapping_handler */
    $mapping_handler = \Drupal::entityTypeManager()
      ->getHandler('fixed_block_content', 'mapping_handler');
    foreach ($entities as $entity) {

      // Release the fixed block content.
      $mapping_handler
        ->releaseBlockContent($entity);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    static::invalidateBlockPluginCache();
  }

  /**
   * Invalidates the block plugin cache after changes and deletions.
   */
  protected static function invalidateBlockPluginCache() {

    // Invalidate the block cache to update custom block-based derivatives.
    \Drupal::service('plugin.manager.block')
      ->clearCachedDefinitions();
  }

  /**
   * {@inheritdoc}
   */
  public function setProtected($value = TRUE) {
    $this->protected = $value;
  }

  /**
   * {@inheritdoc}
   */
  public function isProtected() {
    return (bool) $this->protected;
  }

  /**
   * Gets the default content handler.
   *
   * @return \Drupal\fixed_block_content\DefaultContentHandlerInterface
   *   The default content handler.
   */
  protected function getDefaultContentHandler() {
    return $this
      ->entityTypeManager()
      ->getHandler($this
      ->getEntityTypeId(), 'content_handler');
  }

  /**
   * Gets the mapping handler.
   *
   * @return \Drupal\fixed_block_content\FixedToContentMappingHandlerInterface
   *   The fixed block content mapping handler.
   */
  protected function getMappingHandler() {
    return $this
      ->entityTypeManager()
      ->getHandler($this
      ->getEntityTypeId(), 'mapping_handler');
  }

  /**
   * Gets the block content entity type storage.
   *
   * @return \Drupal\Core\Entity\EntityStorageInterface
   *   The block content entity storage.
   */
  protected function getBlockContentStorage() {
    return $this
      ->entityTypeManager()
      ->getStorage('block_content');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
FixedBlockContent::$auto_export protected property Option to automatic export of default content on config update.
FixedBlockContent::$blockContent Deprecated protected property The current block content linked to this fixed block.
FixedBlockContent::$block_content_bundle protected property The block content bundle.
FixedBlockContent::$default_content protected property The serialized default content for this fixed block.
FixedBlockContent::$id protected property The block ID.
FixedBlockContent::$protected protected property Option to set the custom block as non reusable.
FixedBlockContent::$title protected property The block title.
FixedBlockContent::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
FixedBlockContent::exportDefaultContent public function Export the default content stored in config to the content block. Overrides FixedBlockContentInterface::exportDefaultContent
FixedBlockContent::getAutoExportState public function Gets the automatic default content export state. Overrides FixedBlockContentInterface::getAutoExportState
FixedBlockContent::getBlockContent public function Returns the block content entity linked to this fixed block. Overrides FixedBlockContentInterface::getBlockContent
FixedBlockContent::getBlockContentBundle public function Returns the block content bundle. Overrides FixedBlockContentInterface::getBlockContentBundle
FixedBlockContent::getBlockContentStorage protected function Gets the block content entity type storage.
FixedBlockContent::getDefaultContentHandler protected function Gets the default content handler.
FixedBlockContent::getMappingHandler protected function Gets the mapping handler.
FixedBlockContent::importDefaultContent public function Import the current content block and set as the default content. Overrides FixedBlockContentInterface::importDefaultContent
FixedBlockContent::invalidateBlockPluginCache protected static function Invalidates the block plugin cache after changes and deletions.
FixedBlockContent::isProtected public function Gets the protected option. Overrides FixedBlockContentInterface::isProtected
FixedBlockContent::newBlockContent protected function Creates a new block content.
FixedBlockContent::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
FixedBlockContent::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
FixedBlockContent::setAutoExportState public function Sets the automatic default content export state on configuration update. Overrides FixedBlockContentInterface::setAutoExportState
FixedBlockContent::setBlockContent protected function Links a block content with this fixed block.
FixedBlockContent::setProtected public function Sets the fixed block protected option. Overrides FixedBlockContentInterface::setProtected
FixedBlockContentInterface::AUTO_EXPORT_ALWAYS constant State value for unconditional automatic export of block content.
FixedBlockContentInterface::AUTO_EXPORT_DISABLED constant Disabled state of the automatic block content export option.
FixedBlockContentInterface::AUTO_EXPORT_ON_EMPTY constant State value for automatic default content export when block is empty.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function