Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/EntityPublishedInterface.php \Drupal\Core\Entity\EntityPublishedInterface
  2. 9 core/lib/Drupal/Core/Entity/EntityPublishedInterface.php \Drupal\Core\Entity\EntityPublishedInterface

Provides an interface for access to an entity's published state.

Hierarchy

Expanded class hierarchy of EntityPublishedInterface

All classes that implement EntityPublishedInterface

Related topics

Entity type characteristics
Describes how to enhance entity types with additional functionality.
20 files declare their use of EntityPublishedInterface
BlockContentInterface.php in core/modules/block_content/src/BlockContentInterface.php
CommentInterface.php in core/modules/comment/src/CommentInterface.php
CommonCollectionFilterAccessTestPatternsTrait.php in core/modules/jsonapi/tests/src/Traits/CommonCollectionFilterAccessTestPatternsTrait.php
content_moderation.module in core/modules/content_moderation/content_moderation.module
Contains content_moderation.module.
EntityOperations.php in core/modules/content_moderation/src/EntityOperations.php

... See full list

File

core/lib/Drupal/Core/Entity/EntityPublishedInterface.php, line 10

Namespace

Drupal\Core\Entity
View source 
interface EntityPublishedInterface extends EntityInterface {

  /**
   * Returns whether or not the entity is published.
   *
   * @return bool
   *   TRUE if the entity is published, FALSE otherwise.
   */
  public function isPublished();

  /**
   * Sets the entity as published.
   *
   * @return $this
   *
   * @see \Drupal\Core\Entity\EntityPublishedInterface::setUnpublished()
   */
  public function setPublished();

  /**
   * Sets the entity as unpublished.
   *
   * @return $this
   */
  public function setUnpublished();

}

Members

Namesort ascending Modifiers Type Description Overrides
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age.
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags.
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts.
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata.
EntityPublishedInterface::setUnpublished public function Sets the entity as unpublished.
EntityPublishedInterface::setPublished public function Sets the entity as published.
EntityPublishedInterface::isPublished public function Returns whether or not the entity is published.
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 1
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 1
EntityInterface::toUrl public function Gets the URL object for the entity. 1
EntityInterface::toLink public function Generates the HTML for a link to this entity. 1
EntityInterface::toArray public function Gets an array of all property values. 2
EntityInterface::setOriginalId public function Sets the original ID. 1
EntityInterface::save public function Saves an entity permanently. 3
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 8
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 6
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 4
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 8
EntityInterface::postLoad public static function Acts on loaded entities. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 7
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 1
EntityInterface::loadMultiple public static function Loads one or more entities. 1
EntityInterface::load public static function Loads an entity. 1
EntityInterface::language public function Gets the language of the entity. 1
EntityInterface::label public function Gets the label of the entity. 3
EntityInterface::isNew public function Determines whether the entity is new. 1
EntityInterface::id public function Gets the identifier. 1
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 1
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 1
EntityInterface::getOriginalId public function Gets the original ID. 1
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 1
EntityInterface::getEntityType public function Gets the entity type definition. 1
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 1
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 1
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 1
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 3
EntityInterface::enforceIsNew public function Enforces an entity to be new. 1
EntityInterface::delete public function Deletes an entity permanently. 1
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 1
EntityInterface::bundle public function Gets the bundle of the entity. 1
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 12
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 12
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 12
AccessibleInterface::access public function Checks data value access. 6