Basic-Shopify-API/src/Contracts/StateStorage.php at c9e6f6110fde7fe3af5a6dbda671e6323cd59007 · gnikyt/Basic-Shopify-API · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?php

declare(strict_types=1);

namespace Gnikyt\BasicShopifyAPI\Contracts;

use Gnikyt\BasicShopifyAPI\Session;

/**
 * Reprecents basic state storage.
 * Based on spatie/guzzle-rate-limiter-middleware.
 */
interface StateStorage
{
    /**
     * Get all container values.
     *
     * @return array
     */
    public function all(): array;

    /**
     * Get the values.
     *
     * @param Session $session The shop session.
     *
     * @return array
     */
    public function get(Session $session): array;

    /**
     * Set the values.
     *
     * @param array   $values  The values to set.
     * @param Session $session The shop session.
     *
     * @return void
     */
    public function set(array $values, Session $session): void;

    /**
     * Set the values.
     *
     * @param mixed   $value   The value to add.
     * @param Session $session The shop session.
     *
     * @return void
     */
    public function push($value, Session $session): void;

    /**
     * Remove all values.
     *
     * @param Session $session The shop session.
     *
     * @return void
     */
    public function reset(Session $session): void;
}