interface EntityStorageControllerInterface

Defines a common interface for entity storage controllers.

Implemented by

EntityDatabaseStorageController

Hierarchy

interface EntityControllerInterface
- interface EntityStorageControllerInterface

Expanded class hierarchy of EntityStorageControllerInterface

1 string reference to 'EntityStorageControllerInterface'

entity_autoload_info in core/modules/entity/entity.module: Implements hook_autoload_info().

File

core/modules/entity/entity.controller.inc, line 651: Entity API controller classes and interface.

View source

interface EntityStorageControllerInterface extends EntityControllerInterface {

  /**
   * Constructs a new entity object, without permanently saving it.
   *
   * @param $values
   *   An array of values to set, keyed by property name. If the entity type has
   *   bundles the bundle key has to be specified.
   *
   * @return EntityInterface
   *   A new entity object.
   */
  public function create(array $values);

  /**
   * Deletes permanently saved entities.
   *
   * @param $ids
   *   An array of entity IDs.
   *
   * @throws EntityStorageException
   *   In case of failures, an exception is thrown.
   */
  public function delete($ids);

  /**
   * Saves the entity permanently.
   *
   * @param EntityInterface $entity
   *   The entity to save.
   *
   * @return int
   *   Either SAVED_NEW or SAVED_UPDATED depending on the operation performed.
   *
   * @throws EntityStorageException
   *   In case of failures, an exception is thrown.
   */
  public function save(EntityInterface $entity);

}

Members

Name	Modifiers	Type	Description
EntityControllerInterface::buildContent	public	function	Builds a structured array representing the entity's content.
EntityControllerInterface::load	public	function	Loads one or more entities.
EntityControllerInterface::resetCache	public	function	Resets the internal, static entity cache.
EntityControllerInterface::resetStaticCache	public	function	Resets the internal, static entity cache.
EntityControllerInterface::view	public	function	Creates a rendered entity.
EntityStorageControllerInterface::create	public	function	Constructs a new entity object, without permanently saving it.
EntityStorageControllerInterface::delete	public	function	Deletes permanently saved entities.
EntityStorageControllerInterface::save	public	function	Saves the entity permanently.