Mercurial > hg > isophonics-drupal-site
view core/modules/block_content/src/BlockContentInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 129ea1e6d783 |
children |
line wrap: on
line source
<?php namespace Drupal\block_content; use Drupal\block_content\Access\RefinableDependentAccessInterface; use Drupal\Core\Entity\ContentEntityInterface; use Drupal\Core\Entity\EntityChangedInterface; use Drupal\Core\Entity\EntityPublishedInterface; use Drupal\Core\Entity\RevisionLogInterface; /** * Provides an interface defining a custom block entity. */ interface BlockContentInterface extends ContentEntityInterface, EntityChangedInterface, RevisionLogInterface, EntityPublishedInterface, RefinableDependentAccessInterface { /** * Returns the block revision log message. * * @return string * The revision log message. * * @deprecated in Drupal 8.2.0, will be removed before Drupal 9.0.0. Use * \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage() instead. */ public function getRevisionLog(); /** * Sets the block description. * * @param string $info * The block description. * * @return \Drupal\block_content\BlockContentInterface * The class instance that this method is called on. */ public function setInfo($info); /** * Sets the block revision log message. * * @param string $revision_log * The revision log message. * * @return \Drupal\block_content\BlockContentInterface * The class instance that this method is called on. * * @deprecated in Drupal 8.2.0, will be removed before Drupal 9.0.0. Use * \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage() instead. */ public function setRevisionLog($revision_log); /** * 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 \Drupal\block_content\BlockContentInterface * 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(); }