ShopperList.php
1 month ago
ShopperListItem.php
2 weeks ago
ShopperListRenderer.php
1 month ago
ShopperListsController.php
1 month ago
ShopperList.php
239 lines
| 1 | <?php |
| 2 | declare( strict_types = 1 ); |
| 3 | |
| 4 | namespace Automattic\WooCommerce\Internal\ShopperLists; |
| 5 | |
| 6 | use Automattic\WooCommerce\Internal\Utilities\Users; |
| 7 | |
| 8 | /** |
| 9 | * A user's saved list of products. |
| 10 | */ |
| 11 | class ShopperList { |
| 12 | /** |
| 13 | * Prefix for per-list usermeta key for list details. |
| 14 | */ |
| 15 | const META_KEY_PREFIX = '_wc_shopper_list_'; |
| 16 | |
| 17 | /** |
| 18 | * User ID. |
| 19 | * |
| 20 | * @var int |
| 21 | */ |
| 22 | private $user_id; |
| 23 | |
| 24 | /** |
| 25 | * List slug. |
| 26 | * |
| 27 | * @var string |
| 28 | */ |
| 29 | private $slug; |
| 30 | |
| 31 | /** |
| 32 | * Datetime the list was created. |
| 33 | * |
| 34 | * @var string |
| 35 | */ |
| 36 | private $date_created_gmt; |
| 37 | |
| 38 | /** |
| 39 | * Items in the list. |
| 40 | * |
| 41 | * @var array<string, ShopperListItem> |
| 42 | */ |
| 43 | private $items; |
| 44 | |
| 45 | /** |
| 46 | * Private constructor. Use the static factories to obtain concrete instances. |
| 47 | * |
| 48 | * @param int $user_id Owning user ID. |
| 49 | * @param string $slug List slug. |
| 50 | * @param string $date_created_gmt MySQL DATETIME, GMT. |
| 51 | * @param array<string, ShopperListItem> $items Items keyed by storage key. |
| 52 | */ |
| 53 | private function __construct( |
| 54 | int $user_id, |
| 55 | string $slug, |
| 56 | string $date_created_gmt, |
| 57 | array $items |
| 58 | ) { |
| 59 | $this->user_id = $user_id; |
| 60 | $this->slug = $slug; |
| 61 | $this->date_created_gmt = $date_created_gmt; |
| 62 | $this->items = $items; |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Load a list by slug. Returns false for any other list that doesn't exist. |
| 67 | * |
| 68 | * @param string $slug List identifier. |
| 69 | * @param int|null $user_id Defaults to the current user. |
| 70 | * @return self|false |
| 71 | */ |
| 72 | public static function get_by_slug( string $slug, ?int $user_id = null ) { |
| 73 | // Gate disabled or unknown slugs upfront so previously-persisted lists |
| 74 | // don't bypass the feature flag (the Store API surfaces this as 404). |
| 75 | if ( ! wc_get_container()->get( ShopperListsController::class )->is_enabled( $slug ) ) { |
| 76 | return false; |
| 77 | } |
| 78 | |
| 79 | $user_id = absint( $user_id ? $user_id : get_current_user_id() ); |
| 80 | if ( ! $user_id ) { |
| 81 | return false; |
| 82 | } |
| 83 | |
| 84 | $stored = Users::get_site_user_meta( $user_id, self::META_KEY_PREFIX . $slug ); |
| 85 | |
| 86 | if ( is_array( $stored ) ) { |
| 87 | return self::from_array( $stored, $user_id ); |
| 88 | } |
| 89 | |
| 90 | // In-memory list; saved on the first save(). |
| 91 | return new self( |
| 92 | $user_id, |
| 93 | $slug, |
| 94 | current_time( 'mysql', true ), |
| 95 | array() |
| 96 | ); |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Get all of the user's lists. |
| 101 | * |
| 102 | * @param int|null $user_id Defaults to the current user. |
| 103 | * @return array<string, self> |
| 104 | */ |
| 105 | public static function get_all_for_user( ?int $user_id = null ): array { |
| 106 | $result = array(); |
| 107 | foreach ( wc_get_container()->get( ShopperListsController::class )->get_enabled_slugs() as $slug ) { |
| 108 | $list = self::get_by_slug( $slug, $user_id ); |
| 109 | if ( $list ) { |
| 110 | $result[ $slug ] = $list; |
| 111 | } |
| 112 | } |
| 113 | return $result; |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * The list slug (e.g. 'saved-for-later'). |
| 118 | */ |
| 119 | public function get_slug(): string { |
| 120 | return $this->slug; |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Creation time as a MySQL DATETIME in GMT. |
| 125 | */ |
| 126 | public function get_date_created_gmt(): string { |
| 127 | return $this->date_created_gmt; |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Add an item, or merge quantities if it already exists. |
| 132 | * |
| 133 | * @param ShopperListItem $item Item to add. |
| 134 | */ |
| 135 | public function add_item( ShopperListItem $item ): void { |
| 136 | $key = $item->get_key(); |
| 137 | |
| 138 | if ( isset( $this->items[ $key ] ) ) { |
| 139 | $this->items[ $key ] = ShopperListItem::from_array( |
| 140 | array_merge( |
| 141 | $this->items[ $key ]->to_array(), |
| 142 | array( 'quantity' => $this->items[ $key ]->get_quantity() + $item->get_quantity() ) |
| 143 | ) |
| 144 | ); |
| 145 | return; |
| 146 | } |
| 147 | |
| 148 | $this->items[ $key ] = $item; |
| 149 | } |
| 150 | |
| 151 | /** |
| 152 | * Remove an item by key. Returns false if the key wasn't present. |
| 153 | * |
| 154 | * @param string $key Storage key of the item to remove. |
| 155 | */ |
| 156 | public function remove_item( string $key ): bool { |
| 157 | if ( ! isset( $this->items[ $key ] ) ) { |
| 158 | return false; |
| 159 | } |
| 160 | unset( $this->items[ $key ] ); |
| 161 | return true; |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * Get all items currently in the list. |
| 166 | * |
| 167 | * @return array<string, ShopperListItem> |
| 168 | */ |
| 169 | public function get_items(): array { |
| 170 | return $this->items; |
| 171 | } |
| 172 | |
| 173 | /** |
| 174 | * Find an item by key. |
| 175 | * |
| 176 | * @param string $key Storage key. |
| 177 | */ |
| 178 | public function find_item( string $key ): ?ShopperListItem { |
| 179 | return $this->items[ $key ] ?? null; |
| 180 | } |
| 181 | |
| 182 | /** |
| 183 | * Persist the current state to user meta. |
| 184 | */ |
| 185 | public function save(): void { |
| 186 | Users::update_site_user_meta( |
| 187 | $this->user_id, |
| 188 | self::META_KEY_PREFIX . $this->slug, |
| 189 | $this->to_array() |
| 190 | ); |
| 191 | } |
| 192 | |
| 193 | /** |
| 194 | * Storage / response shape. |
| 195 | */ |
| 196 | public function to_array(): array { |
| 197 | $items_array = array(); |
| 198 | foreach ( $this->items as $key => $item ) { |
| 199 | $items_array[ $key ] = $item->to_array(); |
| 200 | } |
| 201 | |
| 202 | return array( |
| 203 | 'slug' => $this->slug, |
| 204 | 'date_created_gmt' => $this->date_created_gmt, |
| 205 | 'items' => $items_array, |
| 206 | ); |
| 207 | } |
| 208 | |
| 209 | /** |
| 210 | * Build a ShopperList from a stored array. |
| 211 | * |
| 212 | * @param array $data Stored list record. |
| 213 | * @param int $user_id Owning user ID. |
| 214 | */ |
| 215 | private static function from_array( array $data, int $user_id ): self { |
| 216 | $items = array(); |
| 217 | if ( ! empty( $data['items'] ) && is_array( $data['items'] ) ) { |
| 218 | foreach ( $data['items'] as $key => $item_data ) { |
| 219 | if ( ! is_array( $item_data ) ) { |
| 220 | continue; |
| 221 | } |
| 222 | |
| 223 | try { |
| 224 | $items[ (string) $key ] = ShopperListItem::from_array( $item_data ); |
| 225 | } catch ( \Throwable $e ) { |
| 226 | continue; |
| 227 | } |
| 228 | } |
| 229 | } |
| 230 | |
| 231 | return new self( |
| 232 | $user_id, |
| 233 | $data['slug'] ?? '', |
| 234 | $data['date_created_gmt'] ?? current_time( 'mysql', true ), |
| 235 | $items |
| 236 | ); |
| 237 | } |
| 238 | } |
| 239 |