interface WishlistItemInterface in Commerce Wishlist 8.3
Defines the interface for wishlist items.
Hierarchy
- interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable; interface \Drupal\Core\Entity\EntityChangedInterface
- interface \Drupal\commerce_wishlist\Entity\WishlistItemInterface
Expanded class hierarchy of WishlistItemInterface
All classes that implement WishlistItemInterface
9 files declare their use of WishlistItemInterface
- MoveToCart.php in src/
Plugin/ views/ field/ MoveToCart.php - WishlistAssignmentTest.php in tests/
src/ Kernel/ WishlistAssignmentTest.php - WishlistEntityAddEvent.php in src/
Event/ WishlistEntityAddEvent.php - WishlistItemDetailsForm.php in src/
Form/ WishlistItemDetailsForm.php - WishlistItemEvent.php in src/
Event/ WishlistItemEvent.php
File
- src/
Entity/ WishlistItemInterface.php, line 12
Namespace
Drupal\commerce_wishlist\EntityView source
interface WishlistItemInterface extends ContentEntityInterface, EntityChangedInterface {
/**
* Gets the parent wishlist.
*
* @return \Drupal\commerce_wishlist\Entity\WishlistInterface|null
* The wishlist, or NULL.
*/
public function getWishlist();
/**
* Gets the parent wishlist ID.
*
* @return int|null
* The wishlist ID, or NULL.
*/
public function getWishlistId();
/**
* Gets the purchasable entity.
*
* @return \Drupal\commerce\PurchasableEntityInterface|null
* The purchasable entity, or NULL.
*/
public function getPurchasableEntity();
/**
* Gets the purchasable entity ID.
*
* @return int
* The purchasable entity ID.
*/
public function getPurchasableEntityId();
/**
* Gets the wishlist item title.
*
* @return string
* The wishlist item title
*/
public function getTitle();
/**
* Gets the wishlist item quantity.
*
* @return string
* The wishlist item quantity
*/
public function getQuantity();
/**
* Sets the wishlist item quantity.
*
* @param string $quantity
* The wishlist item quantity.
*
* @return $this
*/
public function setQuantity($quantity);
/**
* Gets the wishlist item comment.
*
* @return string
* The wishlist item comment.
*/
public function getComment();
/**
* Sets the wishlist item comment.
*
* @param string $comment
* The wishlist item comment.
*
* @return $this
*/
public function setComment($comment);
/**
* Gets the wishlist item priority.
*
* @return int
* The wishlist item priority.
*/
public function getPriority();
/**
* Sets the wishlist item priority.
*
* @param int $priority
* The wishlist item priority.
*
* @return $this
*/
public function setPriority($priority);
/**
* Gets the purchases.
*
* Each object contains the order ID, quantity, and timestamp of a purchase.
*
* @return \Drupal\commerce_wishlist\WishlistPurchase[]
* The purchases.
*/
public function getPurchases();
/**
* Sets the purchases.
*
* @param \Drupal\commerce_wishlist\WishlistPurchase[] $purchases
* The purchases.
*
* @return $this
*/
public function setPurchases(array $purchases);
/**
* Adds a new purchase.
*
* @param \Drupal\commerce_wishlist\WishlistPurchase $purchase
* The purchase.
*/
public function addPurchase(WishlistPurchase $purchase);
/**
* Removes a purchase.
*
* @param \Drupal\commerce_wishlist\WishlistPurchase $purchase
* The purchase.
*
* @return $this
*/
public function removePurchase(WishlistPurchase $purchase);
/**
* Gets the purchased quantity.
*
* Represents the sum of all purchase quantities.
*
* @return string
* The purchased quantity.
*/
public function getPurchasedQuantity();
/**
* Gets the timestamp of the last purchase.
*
* @return int|null
* The timestamp of the last purchase, or NULL if the wishlist item
* hasn't been purchased yet.
*/
public function getLastPurchasedTime();
/**
* Gets the wishlist item creation timestamp.
*
* @return int
* The wishlist item creation timestamp.
*/
public function getCreatedTime();
/**
* Sets the wishlist item creation timestamp.
*
* @param int $timestamp
* The wishlist item 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 |
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 |
WishlistItemInterface:: |
public | function | Adds a new purchase. | 1 |
WishlistItemInterface:: |
public | function | Gets the wishlist item comment. | 1 |
WishlistItemInterface:: |
public | function | Gets the wishlist item creation timestamp. | 1 |
WishlistItemInterface:: |
public | function | Gets the timestamp of the last purchase. | 1 |
WishlistItemInterface:: |
public | function | Gets the wishlist item priority. | 1 |
WishlistItemInterface:: |
public | function | Gets the purchasable entity. | 1 |
WishlistItemInterface:: |
public | function | Gets the purchasable entity ID. | 1 |
WishlistItemInterface:: |
public | function | Gets the purchased quantity. | 1 |
WishlistItemInterface:: |
public | function | Gets the purchases. | 1 |
WishlistItemInterface:: |
public | function | Gets the wishlist item quantity. | 1 |
WishlistItemInterface:: |
public | function | Gets the wishlist item title. | 1 |
WishlistItemInterface:: |
public | function | Gets the parent wishlist. | 1 |
WishlistItemInterface:: |
public | function | Gets the parent wishlist ID. | 1 |
WishlistItemInterface:: |
public | function | Removes a purchase. | 1 |
WishlistItemInterface:: |
public | function | Sets the wishlist item comment. | 1 |
WishlistItemInterface:: |
public | function | Sets the wishlist item creation timestamp. | 1 |
WishlistItemInterface:: |
public | function | Sets the wishlist item priority. | 1 |
WishlistItemInterface:: |
public | function | Sets the purchases. | 1 |
WishlistItemInterface:: |
public | function | Sets the wishlist item quantity. | 1 |