22

✏️ Editing: ShopperList.php

<?php
declare( strict_types = 1 );

namespace Automattic\WooCommerce\Internal\ShopperLists;

use Automattic\WooCommerce\Internal\Utilities\Users;

/**
 * A user's saved list of products.
 */
class ShopperList {
	/**
	 * Prefix for per-list usermeta key for list details.
	 */
	const META_KEY_PREFIX = '_wc_shopper_list_';

/**
	 * User ID.
	 *
	 * @var int
	 */
	private $user_id;

/**
	 * List slug.
	 *
	 * @var string
	 */
	private $slug;

/**
	 * Datetime the list was created.
	 *
	 * @var string
	 */
	private $date_created_gmt;

/**
	 * Items in the list.
	 *
	 * @var array<string, ShopperListItem>
	 */
	private $items;

/**
	 * Private constructor. Use the static factories to obtain concrete instances.
	 *
	 * @param int                            $user_id          Owning user ID.
	 * @param string                         $slug             List slug.
	 * @param string                         $date_created_gmt MySQL DATETIME, GMT.
	 * @param array<string, ShopperListItem> $items            Items keyed by storage key.
	 */
	private function __construct(
		int $user_id,
		string $slug,
		string $date_created_gmt,
		array $items
	) {
		$this->user_id          = $user_id;
		$this->slug             = $slug;
		$this->date_created_gmt = $date_created_gmt;
		$this->items            = $items;
	}

/**
	 * Load a list by slug. Returns false for a disabled, unknown, or unloadable list.
	 *
	 * @param string   $slug    List identifier.
	 * @param int|null $user_id Defaults to the current user.
	 * @return self|false
	 */
	public static function get_by_slug( string $slug, ?int $user_id = null ) {
		if ( ! wc_get_container()->get( ShopperListsController::class )->is_enabled( $slug ) ) {
			return false;
		}

return self::get_by_slug_raw( $slug, $user_id );
	}

/**
	 * Load a list by slug without the feature-flag gate, for internal callers
	 * (e.g. privacy export/erase). Do not use for user-facing reads.
	 *
	 * @param string   $slug    List identifier.
	 * @param int|null $user_id Defaults to the current user.
	 * @return self|false
	 */
	public static function get_by_slug_raw( string $slug, ?int $user_id = null ) {
		if ( ! in_array( $slug, wc_get_container()->get( ShopperListsController::class )->get_supported_slugs(), true ) ) {
			return false;
		}

$user_id = absint( $user_id ? $user_id : get_current_user_id() );
		if ( ! $user_id ) {
			return false;
		}

$stored = Users::get_site_user_meta( $user_id, self::META_KEY_PREFIX . $slug );

if ( is_array( $stored ) ) {
			return self::from_array( $stored, $user_id );
		}

return new self(
			$user_id,
			$slug,
			current_time( 'mysql', true ),
			array()
		);
	}

/**
	 * Get all of the user's lists.
	 *
	 * @param int|null $user_id Defaults to the current user.
	 * @return array<string, self>
	 */
	public static function get_all_for_user( ?int $user_id = null ): array {
		$result = array();
		foreach ( wc_get_container()->get( ShopperListsController::class )->get_enabled_slugs() as $slug ) {
			$list = self::get_by_slug( $slug, $user_id );
			if ( $list ) {
				$result[ $slug ] = $list;
			}
		}
		return $result;
	}

/**
	 * The list slug (e.g. 'saved-for-later').
	 */
	public function get_slug(): string {
		return $this->slug;
	}

/**
	 * Creation time as a MySQL DATETIME in GMT.
	 */
	public function get_date_created_gmt(): string {
		return $this->date_created_gmt;
	}

/**
	 * Add an item, or merge quantities if it already exists.
	 *
	 * @param ShopperListItem $item Item to add.
	 */
	public function add_item( ShopperListItem $item ): void {
		$key = $item->get_key();

if ( isset( $this->items[ $key ] ) ) {
			$this->items[ $key ] = ShopperListItem::from_array(
				array_merge(
					$this->items[ $key ]->to_array(),
					array( 'quantity' => $this->items[ $key ]->get_quantity() + $item->get_quantity() )
				)
			);
			return;
		}

$this->items[ $key ] = $item;
	}

/**
	 * Remove an item by key. Returns false if the key wasn't present.
	 *
	 * @param string $key Storage key of the item to remove.
	 */
	public function remove_item( string $key ): bool {
		if ( ! isset( $this->items[ $key ] ) ) {
			return false;
		}
		unset( $this->items[ $key ] );
		return true;
	}

/**
	 * Get all items currently in the list.
	 *
	 * @return array<string, ShopperListItem>
	 */
	public function get_items(): array {
		return $this->items;
	}

/**
	 * Find an item by key.
	 *
	 * @param string $key Storage key.
	 */
	public function find_item( string $key ): ?ShopperListItem {
		return $this->items[ $key ] ?? null;
	}

/**
	 * Persist the current state to user meta.
	 */
	public function save(): void {
		Users::update_site_user_meta(
			$this->user_id,
			self::META_KEY_PREFIX . $this->slug,
			$this->to_array()
		);
	}

/**
	 * Storage / response shape.
	 */
	public function to_array(): array {
		$items_array = array();
		foreach ( $this->items as $key => $item ) {
			$items_array[ $key ] = $item->to_array();
		}

return array(
			'slug'             => $this->slug,
			'date_created_gmt' => $this->date_created_gmt,
			'items'            => $items_array,
		);
	}

/**
	 * Build a ShopperList from a stored array.
	 *
	 * @param array $data    Stored list record.
	 * @param int   $user_id Owning user ID.
	 */
	private static function from_array( array $data, int $user_id ): self {
		$items = array();
		if ( ! empty( $data['items'] ) && is_array( $data['items'] ) ) {
			foreach ( $data['items'] as $key => $item_data ) {
				if ( ! is_array( $item_data ) ) {
					continue;
				}

try {
					$items[ (string) $key ] = ShopperListItem::from_array( $item_data );
				} catch ( \Throwable $e ) {
					continue;
				}
			}
		}

return new self(
			$user_id,
			$data['slug'] ?? '',
			$data['date_created_gmt'] ?? current_time( 'mysql', true ),
			$items
		);
	}
}

MR SKB