Wishlist_Action
Abstract class for handling wishlist-related actions.
This class provides the base structure for actions that involve wishlists, such as creating, updating, or deleting wishlists. It defines common functionality for working with customer wishlists and handling requests, which must be extended by specific actions.
- Full name:
\BigCommerce\Accounts\Wishlists\Actions\Wishlist_Action - This class is an Abstract class
Properties
wishlists
protected \BigCommerce\Api\v3\Api\WishlistsApi $wishlistsMethods
__construct
Wishlist_Action constructor.
public __construct(\BigCommerce\Api\v3\Api\WishlistsApi $wishlists): mixedInitializes the action with the WishlistsApi instance, allowing the action to interact with the BigCommerce API for wishlist management.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$wishlists | \BigCommerce\Api\v3\Api\WishlistsApi | The WishlistsApi instance used for wishlist operations. |
handle_request
Handle the incoming request.
public handle_request(mixed $args): voidThis is an abstract method that must be implemented by subclasses to handle the specific request for a wishlist action (e.g., create, update, delete). The method should process the request and return the appropriate response.
- This method is abstract.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$args | mixed | The arguments for the action request, typically including the wishlist ID and any necessary data. |
sanitize_request
Sanitize and validate the request data.
protected sanitize_request(array $args, array $submission): arrayThis is an abstract method that must be implemented by subclasses to sanitize and validate the request submission before performing any operations on the wishlist.
- This method is abstract.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$args | array | The arguments for the action request. |
$submission | array | The submitted form data, typically from a POST request. |
Return Value:
Sanitized data to be used in the action handler.
get_customer_wishlist
Get the wishlist for the customer.
protected get_customer_wishlist(int $user_id, int $wishlist_id): \BigCommerce\Accounts\Wishlists\WishlistFetches the wishlist for a given customer based on their user ID and wishlist ID. If the wishlist is not found or does not belong to the customer, an exception is thrown.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$user_id | int | The ID of the user (customer). |
$wishlist_id | int | The ID of the wishlist to retrieve. |
Return Value:
The customer’s wishlist.
Throws:
If the wishlist cannot be found or accessed.
If the wishlist does not belong to the customer.
get_customer_id
Get the Customer ID for the user.
protected get_customer_id(int $user_id): intRetrieves the customer ID associated with the given user ID.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$user_id | int | The ID of the user (customer). |
Return Value:
The customer ID associated with the user.
Automatically generated on 2025-01-21