interface WishlistInterface in Commerce Wishlist 8.3
Defines the interface for wishlists.
Hierarchy
- interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable; interface \Drupal\Core\Entity\EntityChangedInterface; interface \Drupal\user\EntityOwnerInterface
- interface \Drupal\commerce_wishlist\Entity\WishlistInterface
Expanded class hierarchy of WishlistInterface
All classes that implement WishlistInterface
16 files declare their use of WishlistInterface
- commerce_wishlist.module in ./
commerce_wishlist.module - Defines the Wishlist entity and associated features.
- WishlistAssignEvent.php in src/
Event/ WishlistAssignEvent.php - WishlistAssignment.php in src/
WishlistAssignment.php - WishlistAssignmentInterface.php in src/
WishlistAssignmentInterface.php - WishlistAssignmentTest.php in tests/
src/ Kernel/ WishlistAssignmentTest.php
File
- src/
Entity/ WishlistInterface.php, line 13
Namespace
Drupal\commerce_wishlist\EntityView source
interface WishlistInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {
/**
* Gets the wishlist code.
*
* @return string
* The wishlist code.
*/
public function getCode();
/**
* Sets the wishlist code.
*
* @param string $code
* The wishlist code.
*
* @return $this
*/
public function setCode($code);
/**
* Gets the wishlist name.
*
* @return string
* The wishlist name.
*/
public function getName();
/**
* Sets the wishlist name.
*
* @param string $name
* The wishlist name.
*
* @return $this
*/
public function setName($name);
/**
* Gets the shipping profile.
*
* @return \Drupal\profile\Entity\ProfileInterface|null
* The shipping profile, or null.
*/
public function getShippingProfile();
/**
* Sets the shipping profile.
*
* @param \Drupal\profile\Entity\ProfileInterface $profile
* The shipping profile.
*
* @return $this
*/
public function setShippingProfile(ProfileInterface $profile);
/**
* Gets the wishlist items.
*
* @return \Drupal\commerce_wishlist\Entity\WishlistItemInterface[]
* The wishlist items.
*/
public function getItems();
/**
* Sets the wishlist items.
*
* @param \Drupal\commerce_wishlist\Entity\WishlistItemInterface[] $wishlist_items
* The wishlist items.
*
* @return $this
*/
public function setItems(array $wishlist_items);
/**
* Gets whether the wishlist has wishlist items.
*
* @return bool
* TRUE if the wishlist has wishlist items, FALSE otherwise.
*/
public function hasItems();
/**
* Adds an wishlist item.
*
* @param \Drupal\commerce_wishlist\Entity\WishlistItemInterface $wishlist_item
* The wishlist item.
*
* @return $this
*/
public function addItem(WishlistItemInterface $wishlist_item);
/**
* Removes an wishlist item.
*
* @param \Drupal\commerce_wishlist\Entity\WishlistItemInterface $wishlist_item
* The wishlist item.
*
* @return $this
*/
public function removeItem(WishlistItemInterface $wishlist_item);
/**
* Checks whether the wishlist has a given wishlist item.
*
* @param \Drupal\commerce_wishlist\Entity\WishlistItemInterface $wishlist_item
* The wishlist item.
*
* @return bool
* TRUE if the wishlist item was found, FALSE otherwise.
*/
public function hasItem(WishlistItemInterface $wishlist_item);
/**
* Gets whether this is the user's default wishlist.
*
* @return bool
* TRUE if this is the user's default wishlist, FALSE otherwise.
*/
public function isDefault();
/**
* Sets whether this is the user's default wishlist.
*
* @param bool $default
* Whether this is the user's default wishlist.
*
* @return $this
*/
public function setDefault($default);
/**
* Gets whether the wishlist is public.
*
* @return bool
* TRUE if the wishlist is public, FALSE otherwise.
*/
public function isPublic();
/**
* Sets whether the wishlist is public.
*
* @param bool $public
* Whether the wishlist is public.
*
* @return $this
*/
public function setPublic($public);
/**
* Gets whether items should remain in the wishlist once purchased.
*
* @return bool
* TRUE if purchased items should remain in the wishlist, FALSE otherwise.
*/
public function getKeepPurchasedItems();
/**
* Sets whether items should remain in the wishlist once purchased.
*
* @param bool $keep_purchased_items
* Whether items should remain in the wishlist once purchased.
*
* @return $this
*/
public function setKeepPurchasedItems($keep_purchased_items);
/**
* Gets the wishlist creation timestamp.
*
* @return int
* Creation timestamp of the wishlist.
*/
public function getCreatedTime();
/**
* Sets the wishlist creation timestamp.
*
* @param int $timestamp
* The wishlist creation timestamp.
*
* @return $this
*/
public function setCreatedTime($timestamp);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 9 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 27 |
EntityChangedInterface:: |
public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedInterface:: |
public | function | Gets the timestamp of the last entity change across all translations. | |
EntityChangedInterface:: |
public | function | Sets the timestamp of the last entity change for the current translation. | |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public | function | Deprecated way of generating a link to the entity. See toLink(). | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the public URL for this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
EntityOwnerInterface:: |
public | function | Returns the entity owner's user entity. | 1 |
EntityOwnerInterface:: |
public | function | Returns the entity owner's user ID. | 1 |
EntityOwnerInterface:: |
public | function | Sets the entity owner's user entity. | 1 |
EntityOwnerInterface:: |
public | function | Sets the entity owner's user ID. | 1 |
FieldableEntityInterface:: |
public static | function | Provides base field definitions for an entity type. | 2 |
FieldableEntityInterface:: |
public static | function | Provides field definitions for a specific bundle. | 2 |
FieldableEntityInterface:: |
public | function | Gets a field item list. | 1 |
FieldableEntityInterface:: |
public | function | Gets the definition of a contained field. | 1 |
FieldableEntityInterface:: |
public | function | Gets an array of field definitions of all contained fields. | 1 |
FieldableEntityInterface:: |
public | function | Gets an array of all field item lists. | 1 |
FieldableEntityInterface:: |
public | function | Gets an array of field item lists for translatable fields. | 1 |
FieldableEntityInterface:: |
public | function | Determines whether the entity has a field with the given name. | 1 |
FieldableEntityInterface:: |
public | function | Checks whether entity validation is required before saving the entity. | 1 |
FieldableEntityInterface:: |
public | function | Reacts to changes to a field. | 1 |
FieldableEntityInterface:: |
public | function | Sets a field value. | 1 |
FieldableEntityInterface:: |
public | function | Sets whether entity validation is required before saving the entity. | 1 |
FieldableEntityInterface:: |
public | function |
Gets an array of all field values. Overrides EntityInterface:: |
|
FieldableEntityInterface:: |
public | function | Validates the currently set values. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
RevisionableInterface:: |
public | function | Gets the loaded Revision ID of the entity. | 1 |
RevisionableInterface:: |
public | function | Gets the revision identifier of the entity. | 1 |
RevisionableInterface:: |
public | function | Checks if this entity is the default revision. | 1 |
RevisionableInterface:: |
public | function | Checks if this entity is the latest revision. | 1 |
RevisionableInterface:: |
public | function | Determines whether a new revision should be created on save. | 1 |
RevisionableInterface:: |
public | function | Acts on a revision before it gets saved. | 1 |
RevisionableInterface:: |
public | function | Enforces an entity to be saved as a new revision. | 1 |
RevisionableInterface:: |
public | function | Updates the loaded Revision ID with the revision ID. | 1 |
RevisionableInterface:: |
public | function | Checks whether the entity object was a default revision when it was saved. | 1 |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | 1 |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | 1 |
TranslatableInterface:: |
public | function | Adds a new translation to the translatable object. | 1 |
TranslatableInterface:: |
public | function | Gets a translation of the data. | 1 |
TranslatableInterface:: |
public | function | Returns the languages the data is translated to. | 1 |
TranslatableInterface:: |
public | function | Returns the translatable object referring to the original language. | 1 |
TranslatableInterface:: |
public | function | Checks there is a translation for the given language code. | 1 |
TranslatableInterface:: |
public | function | Determines if the current translation of the entity has unsaved changes. | 1 |
TranslatableInterface:: |
public | function | Checks whether the translation is the default one. | 1 |
TranslatableInterface:: |
public | function | Checks whether the translation is new. | 1 |
TranslatableInterface:: |
public | function | Returns the translation support status. | 1 |
TranslatableInterface:: |
public | function | Removes the translation identified by the given language code. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks if untranslatable fields should affect only the default translation. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks whether this is the latest revision affecting this translation. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks whether the current translation is affected by the current revision. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks if the revision translation affected flag value has been enforced. | 1 |
TranslatableRevisionableInterface:: |
public | function | Marks the current revision translation as affected. | 1 |
TranslatableRevisionableInterface:: |
public | function | Enforces the revision translation affected flag value. | 1 |
WishlistInterface:: |
public | function | Adds an wishlist item. | 1 |
WishlistInterface:: |
public | function | Gets the wishlist code. | 1 |
WishlistInterface:: |
public | function | Gets the wishlist creation timestamp. | 1 |
WishlistInterface:: |
public | function | Gets the wishlist items. | 1 |
WishlistInterface:: |
public | function | Gets whether items should remain in the wishlist once purchased. | 1 |
WishlistInterface:: |
public | function | Gets the wishlist name. | 1 |
WishlistInterface:: |
public | function | Gets the shipping profile. | 1 |
WishlistInterface:: |
public | function | Checks whether the wishlist has a given wishlist item. | 1 |
WishlistInterface:: |
public | function | Gets whether the wishlist has wishlist items. | 1 |
WishlistInterface:: |
public | function | Gets whether this is the user's default wishlist. | 1 |
WishlistInterface:: |
public | function | Gets whether the wishlist is public. | 1 |
WishlistInterface:: |
public | function | Removes an wishlist item. | 1 |
WishlistInterface:: |
public | function | Sets the wishlist code. | 1 |
WishlistInterface:: |
public | function | Sets the wishlist creation timestamp. | 1 |
WishlistInterface:: |
public | function | Sets whether this is the user's default wishlist. | 1 |
WishlistInterface:: |
public | function | Sets the wishlist items. | 1 |
WishlistInterface:: |
public | function | Sets whether items should remain in the wishlist once purchased. | 1 |
WishlistInterface:: |
public | function | Sets the wishlist name. | 1 |
WishlistInterface:: |
public | function | Sets whether the wishlist is public. | 1 |
WishlistInterface:: |
public | function | Sets the shipping profile. | 1 |