summaryrefslogtreecommitdiffstats
path: root/library/Icinga/Web/CookieSet.php
blob: 019be292b6597c1c75b751c1f37f7da506271a06 (plain)
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
<?php
/* Icinga Web 2 | (c) 2015 Icinga Development Team | GPLv2+ */

namespace Icinga\Web;

use ArrayIterator;
use IteratorAggregate;
use Traversable;

/**
 * Maintain a set of cookies
 */
class CookieSet implements IteratorAggregate
{
    /**
     * Cookies in this set indexed by the cookie names
     *
     * @var Cookie[]
     */
    protected $cookies = array();

    /**
     * Get an iterator for traversing the cookies in this set
     *
     * @return  ArrayIterator   An iterator for traversing the cookies in this set
     */
    public function getIterator(): Traversable
    {
        return new ArrayIterator($this->cookies);
    }

    /**
     * Add a cookie to the set
     *
     * If a cookie with the same name already exists, the cookie will be overridden.
     *
     * @param   Cookie  $cookie The cookie to add
     *
     * @return  $this
     */
    public function add(Cookie $cookie)
    {
        $this->cookies[$cookie->getName()] = $cookie;
        return $this;
    }

    /**
     * Get the cookie with the given name from the set
     *
     * @param   string  $name       The name of the cookie
     *
     * @return  Cookie|null         The cookie with the given name or null if the cookie does not exist
     */
    public function get($name)
    {
        return isset($this->cookies[$name]) ? $this->cookies[$name] : null;
    }
}