CartInterface.php
84 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Cart contracts |
| 4 | * |
| 5 | * @package Tutor\Ecommerce |
| 6 | * @author Themeum |
| 7 | * @link https://themeum.com |
| 8 | * @since 3.5.0 |
| 9 | */ |
| 10 | |
| 11 | namespace Tutor\Ecommerce\Cart\Contracts; |
| 12 | |
| 13 | interface CartInterface { |
| 14 | |
| 15 | /** |
| 16 | * Add item to cart |
| 17 | * |
| 18 | * @since 3.5.0 |
| 19 | * |
| 20 | * @param integer $item_id Item id to add to cart. |
| 21 | * |
| 22 | * @return boolean |
| 23 | */ |
| 24 | public function add( int $item_id ): bool; |
| 25 | |
| 26 | /** |
| 27 | * Remove an item from cart |
| 28 | * |
| 29 | * @since 3.5.0 |
| 30 | * |
| 31 | * @param integer $item_id Item id to add to cart. |
| 32 | * |
| 33 | * @return boolean |
| 34 | */ |
| 35 | public function remove( int $item_id ): bool; |
| 36 | |
| 37 | /** |
| 38 | * Clear the cart entirely |
| 39 | * |
| 40 | * @since 3.5.0 |
| 41 | * |
| 42 | * @return boolean |
| 43 | */ |
| 44 | public function clear_cart(): bool; |
| 45 | |
| 46 | /** |
| 47 | * Get cart items |
| 48 | * |
| 49 | * @since 3.5.0 |
| 50 | * |
| 51 | * @return array Array of object |
| 52 | */ |
| 53 | public function get_cart_items(): array; |
| 54 | |
| 55 | /** |
| 56 | * Get cart url to view the cart |
| 57 | * |
| 58 | * @since 3.5.0 |
| 59 | * |
| 60 | * @return string |
| 61 | */ |
| 62 | public function get_cart_url(): string; |
| 63 | |
| 64 | /** |
| 65 | * Get cart error message |
| 66 | * |
| 67 | * @since 3.5.0 |
| 68 | * |
| 69 | * @return string |
| 70 | */ |
| 71 | public function get_error(): string; |
| 72 | |
| 73 | /** |
| 74 | * Check if item already exists in cart |
| 75 | * |
| 76 | * @since 3.5.0 |
| 77 | * |
| 78 | * @param integer $item_id Item id. |
| 79 | * |
| 80 | * @return boolean |
| 81 | */ |
| 82 | public function is_item_exists( int $item_id ): bool; |
| 83 | } |
| 84 |