WishlistTrait
This is the user wishlist trait.
The methods that manage wishlist requests to the API will be located here.
Tags
Table of Contents
| addGetWishlist() | Add the request to add the request to get the areas filtered with the given parameters | : void |
|---|---|---|
| addWishlistProduct() | Add product to the user wishlist | : Status|null |
| deleteWishlistProduct() | Remove product to the user wishlist | : Status|null |
| getWishlist() | Returns the areas filtered with the given parameters | : ElementCollection|null |
| sendWishlist() | Send the newsletter to the given email | : Status|null |
Methods
addGetWishlist()
Add the request to add the request to get the areas filtered with the given parameters
public
addGetWishlist(BatchRequests $batchRequests, string $batchName) : void
Parameters
- $batchRequests : BatchRequests
- $batchName : string
-
the name that will identify the request on the batch return.
Return values
void —addWishlistProduct()
Add product to the user wishlist
public
addWishlistProduct(int $id) : Status|null
Parameters
- $id : int
-
The identifier of the product we want to add to the wishlist
Return values
Status|null —deleteWishlistProduct()
Remove product to the user wishlist
public
deleteWishlistProduct(int $id) : Status|null
Parameters
- $id : int
-
The identifier of the product we want to remove from wishlist
Return values
Status|null —getWishlist()
Returns the areas filtered with the given parameters
public
getWishlist() : ElementCollection|null
Return values
ElementCollection|null —sendWishlist()
Send the newsletter to the given email
public
sendWishlist([SendWishlistParametersGroup $params = null ]) : Status|null
Parameters
- $params : SendWishlistParametersGroup = null