give / vendor / vendor-prefixed / stellarwp / licensing-api-client / src / Responses / Credit / PoolCollection.php

PoolCollection.php in GiveWP – Donation Plugin and Fundraising Platform 4.17.0, at vendor/vendor-prefixed/stellarwp/licensing-api-client/src/Responses/Credit/PoolCollection.php

90 lines 2.1 KB

Raw Download Zip

1	<?php declare(strict_types=1);
2
3	namespace Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Credit;
4
5	use Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Contracts\Response;
6	use Give\Vendors\LiquidWeb\LicensingApiClient\Responses\Credit\ValueObjects\CreditPool;
7
8	/**
9	* Represents a keyed collection of managed credit pools.
10	*
11	* @implements Response<array{
12	* pools: array<int, array{
13	* pool_id: int,
14	* credit_type: string,
15	* credits_total: int,
16	* credits_used: int,
17	* overage_limit: ?int,
18	* priority: int,
19	* period: string,
20	* first_period_start: ?string,
21	* expires_at: ?string,
22	* is_expired: bool
23	* }>
24	* }>
25	*/
26	final class PoolCollection implements Response
27	{
28	/**
29	* @var array<int, CreditPool>
30	*/
31	public array $pools;
32
33	/**
34	* @param array<int, CreditPool> $pools
35	*/
36	private function __construct(array $pools) {
37	$this->pools = $pools;
38	}
39
40	/**
41	* @param array{
42	* pools: array<int\|string, array{
43	* pool_id: int,
44	* credit_type: string,
45	* credits_total: int,
46	* credits_used: int,
47	* overage_limit: ?int,
48	* priority: int,
49	* period: string,
50	* first_period_start: ?string,
51	* expires_at: ?string,
52	* is_expired: bool
53	* }>
54	* } $attributes
55	*/
56	public static function from(array $attributes): self {
57	$pools = [];
58
59	foreach ($attributes['pools'] as $poolId => $pool) {
60	$pools[(int) $poolId] = CreditPool::from($pool);
61	}
62
63	return new self($pools);
64	}
65
66	/**
67	* @return array{
68	* pools: array<int, array{
69	* pool_id: int,
70	* credit_type: string,
71	* credits_total: int,
72	* credits_used: int,
73	* overage_limit: ?int,
74	* priority: int,
75	* period: string,
76	* first_period_start: ?string,
77	* expires_at: ?string,
78	* is_expired: bool
79	* }>
80	* }
81	*/
82	public function toArray(): array {
83	$pools = array_map(static fn ($pool) => $pool->toArray(), $this->pools);
84
85	return [
86	'pools' => $pools,
87	];
88	}
89	}
90