interface FixedBlockContentInterface in Fixed Block Content 8

Fixed block content interface.

Hierarchy

interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  - interface \Drupal\fixed_block_content\FixedBlockContentInterface

Expanded class hierarchy of FixedBlockContentInterface

All classes that implement FixedBlockContentInterface

3 files declare their use of FixedBlockContentInterface

ConfigEventSubscriber.php in src/EventSubscriber/ConfigEventSubscriber.php
FixedBlockContent.php in src/Entity/FixedBlockContent.php
FixedBlockContentForm.php in src/Form/FixedBlockContentForm.php

File

src/FixedBlockContentInterface.php, line 10

Namespace

Drupal\fixed_block_content

View source

interface FixedBlockContentInterface extends ConfigEntityInterface {

  /**
   * Disabled state of the automatic block content export option.
   */
  const AUTO_EXPORT_DISABLED = 0;

  /**
   * State value for automatic default content export when block is empty.
   */
  const AUTO_EXPORT_ON_EMPTY = 1;

  /**
   * State value for unconditional automatic export of block content.
   */
  const AUTO_EXPORT_ALWAYS = 2;

  /**
   * Returns the block content entity linked to this fixed block.
   *
   * @param bool $create
   *   (optional) Creates a new block content and links it to this fixed block
   *   if there is no block content currently linked. Defaults to TRUE.
   *
   * @return null|\Drupal\block_content\BlockContentInterface
   *   The custom block linked to this fixed block content, NULL if not found
   *   and the create argument is FALSE.
   */
  public function getBlockContent($create = TRUE);

  /**
   * Returns the block content bundle.
   *
   * @return string
   *   The block content bundle.
   */
  public function getBlockContentBundle();

  /**
   * Export the default content stored in config to the content block.
   *
   * @param bool $update_existing
   *   (optional) Export the contents into the existing block content, if any.
   *
   *   The existing block content entity is deleted and replaced by a new one
   *   unless $update_existing is given. If there is no default content defined
   *   in the fixed block or it is not valid, a new empty block is created.
   */
  public function exportDefaultContent($update_existing = FALSE);

  /**
   * Import the current content block and set as the default content.
   */
  public function importDefaultContent();

  /**
   * Sets the fixed block protected option.
   *
   * When enabled, the linked custom block is set as non reusable.
   *
   * @param bool $value
   *   Boolean indicating to enable or disable the option.
   *
   * @return \Drupal\fixed_block_content\FixedBlockContentInterface
   *   The called fixed block entity object.
   */
  public function setProtected($value = TRUE);

  /**
   * Gets the protected option.
   *
   * @return bool
   *   Boolean indicating that the option is enabled or not.
   */
  public function isProtected();

  /**
   * Sets the automatic default content export state on configuration update.
   *
   * @param int $state
   *   (optional) The automatic export state.
   *
   *   Available auto-export states:
   *   - 0: Disabled.
   *   - 1: Only if the current content is empty. This is the default value.
   *   - 2: Unconditional automatic export of block content.
   *
   * @return \Drupal\fixed_block_content\FixedBlockContentInterface
   *   The called fixed block entity object.
   */
  public function setAutoExportState($state = FixedBlockContentInterface::AUTO_EXPORT_ON_EMPTY);

  /**
   * Gets the automatic default content export state.
   *
   * @return int
   *   The auto-export state. 0 mean disabled, 1 only if empty, 2 always.
   */
  public function getAutoExportState();

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
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
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
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::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	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::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
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.
FixedBlockContentInterface::exportDefaultContent	public	function	Export the default content stored in config to the content block.	1
FixedBlockContentInterface::getAutoExportState	public	function	Gets the automatic default content export state.	1
FixedBlockContentInterface::getBlockContent	public	function	Returns the block content entity linked to this fixed block.	1
FixedBlockContentInterface::getBlockContentBundle	public	function	Returns the block content bundle.	1
FixedBlockContentInterface::importDefaultContent	public	function	Import the current content block and set as the default content.	1
FixedBlockContentInterface::isProtected	public	function	Gets the protected option.	1
FixedBlockContentInterface::setAutoExportState	public	function	Sets the automatic default content export state on configuration update.	1
FixedBlockContentInterface::setProtected	public	function	Sets the fixed block protected option.	1
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
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5

You are here

interface FixedBlockContentInterface in Fixed Block Content 8

Hierarchy

File

Namespace

Members

API Navigation