interface WishlistStorageInterface in Commerce Wishlist 8.3

Defines the interface for wishlist storage.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface; interface \Drupal\Core\Entity\TranslatableRevisionableStorageInterface
  • interface \Drupal\Core\Entity\ContentEntityStorageInterface
    • interface \Drupal\commerce_wishlist\WishlistStorageInterface

File

src/WishlistStorageInterface.php, line 11

Namespace

Drupal\commerce_wishlist

interface WishlistStorageInterface extends ContentEntityStorageInterface {

  /**
   * Loads the wishlist for the given code.
   *
   * @param string $code
   *   The code.
   *
   * @return \Drupal\commerce_wishlist\Entity\WishlistInterface|null
   *   The wishlist, or NULL if none found.
   */
  public function loadByCode($code);

  /**
   * Loads the default wishlist for the given user.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user.
   * @param string $wishlist_type_id
   *   The wishlist type ID.
   *
   * @return \Drupal\commerce_wishlist\Entity\WishlistInterface|null
   *   The default wishlist for the given, if known.
   */
  public function loadDefaultByUser(AccountInterface $account, $wishlist_type_id);

  /**
   * Loads the given user's wishlists.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user.
   * @param string $wishlist_type_id
   *   The wishlist type ID.
   *
   * @return \Drupal\profile\Entity\ProfileInterface[]
   *   The wishlists, ordered by ID, descending.
   */
  public function loadMultipleByUser(AccountInterface $account, $wishlist_type_id);

}

Members

Name	Modifiers	Type	Description	Overrides
ContentEntityStorageInterface::createWithSampleValues	public	function	Creates an entity with sample field values.	2
EntityStorageInterface::create	public	function	Constructs a new entity object, without permanently saving it.	1
EntityStorageInterface::delete	public	function	Deletes permanently saved entities.	1
EntityStorageInterface::deleteRevision	public	function	Delete a specific entity revision.	4
EntityStorageInterface::FIELD_LOAD_CURRENT		constant	Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION		constant	Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery	public	function	Gets an aggregated query instance.	1
EntityStorageInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityStorageInterface::getEntityTypeId	public	function	Gets the entity type ID.	1
EntityStorageInterface::getQuery	public	function	Gets an entity query instance.	1
EntityStorageInterface::hasData	public	function	Determines if the storage contains any data.	1
EntityStorageInterface::load	public	function	Loads one entity.	1
EntityStorageInterface::loadByProperties	public	function	Load entities by their property values.	1
EntityStorageInterface::loadMultiple	public	function	Loads one or more entities.	1
EntityStorageInterface::loadRevision	public	function	Load a specific entity revision.	4
EntityStorageInterface::loadUnchanged	public	function	Loads an unchanged entity from the database.	1
EntityStorageInterface::resetCache	public	function	Resets the internal, static entity cache.	1
EntityStorageInterface::restore	public	function	Restores a previously saved entity.	1
EntityStorageInterface::save	public	function	Saves the entity permanently.	1
RevisionableStorageInterface::getLatestRevisionId	public	function	Returns the latest revision identifier for an entity.	2
RevisionableStorageInterface::loadMultipleRevisions	public	function	Loads multiple entity revisions.	2
TranslatableRevisionableStorageInterface::createRevision	public	function	Creates a new revision starting off from the specified entity object. Overrides RevisionableStorageInterface::createRevision	2
TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId	public	function	Returns the latest revision affecting the specified translation.	2
TranslatableStorageInterface::createTranslation	public	function	Constructs a new entity translation object, without permanently saving it.	2
WishlistStorageInterface::loadByCode	public	function	Loads the wishlist for the given code.	1
WishlistStorageInterface::loadDefaultByUser	public	function	Loads the default wishlist for the given user.	1
WishlistStorageInterface::loadMultipleByUser	public	function	Loads the given user's wishlists.	1