You are here

Home » API reference » Homebox 8 » HomeboxInterface.php

interface HomeboxInterface in Homebox 8

Provides an interface for defining Homebox entities.

Hierarchy

Expanded class hierarchy of HomeboxInterface

All classes that implement HomeboxInterface

3 files declare their use of HomeboxInterface
HomeboxAddAccessCheck.php in src/Access/HomeboxAddAccessCheck.php
HomeboxController.php in src/Controller/HomeboxController.php
HomeboxPageForm.php in src/Form/HomeboxPageForm.php

File

src/Entity/HomeboxInterface.php, line 10

Namespace

Drupal\homebox\Entity
View source 
interface HomeboxInterface extends ConfigEntityInterface {

  /**
   * Gets the Homebox page path.
   *
   * @return string
   *   Path of the Homebox.
   */
  public function getPath();

  /**
   * Gets the list of user role IDs.
   *
   * @return array
   *   List of user role IDs.
   */
  public function getRoles();

  /**
   * Gets the list of visibility options.
   *
   * @return array
   *   The list of visibility options.
   */
  public function getOptions();

  /**
   * Gets the layout ID.
   *
   * @return string
   *   Layout ID.
   */
  public function getRegions();

  /**
   * Gets the enabled blocks.
   *
   * @return mixed
   *   Enabled blocks.
   */
  public function getBlocks();

  /**
   * Sets the path of the Homebox page.
   *
   * @param string $name
   *   The path alias of the Homebox.
   *
   * @return $this
   */
  public function setPath($name);

  /**
   * Sets the list of user role IDs.
   *
   * @param array $roles
   *   The list of user role IDs.
   *
   * @return $this
   */
  public function setRoles(array $roles);

  /**
   * Sets the list of layouted blocks.
   *
   * @param array $blocks
   *   Gets the layouted blocks.
   *
   * @return $this
   */
  public function setBlocks(array $blocks);

}

Members

Namesort descending 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
HomeboxInterface::getBlocks public function Gets the enabled blocks. 1
HomeboxInterface::getOptions public function Gets the list of visibility options. 1
HomeboxInterface::getPath public function Gets the Homebox page path. 1
HomeboxInterface::getRegions public function Gets the layout ID. 1
HomeboxInterface::getRoles public function Gets the list of user role IDs. 1
HomeboxInterface::setBlocks public function Sets the list of layouted blocks. 1
HomeboxInterface::setPath public function Sets the path of the Homebox page. 1
HomeboxInterface::setRoles public function Sets the list of user role IDs. 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