common/TypedSequence.php at master · zimbra-api/common · 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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<?php
/**
 * This file is part of the Zimbra API in PHP library.
 *
 * © Nguyen Van Nguyen <nguyennv1981@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zimbra\Common;

use PhpCollection\Sequence;

/**
 * TypedSequence class
 *
 * @package   Zimbra
 * @category  Common
 * @author    Nguyen Van Nguyen - nguyennv1981@gmail.com
 * @copyright Copyright © 2013 by Nguyen Van Nguyen.
 */
class TypedSequence extends Sequence
{
    /**
     * Class type
     * @var string
     */
    private $_type;

    /**
     * Constructor method for TypedSequence
     * @param string $type
     * @param array $elements
     * @return self
     */
    public function __construct($type, array $elements = [])
    {
        $this->_type = $type;
        $this->addAll($elements);
    }

    /**
     * Appends an element at the end of the sequence.
     * @param T $element
     * @return self
     */
    public function add($element)
    {
        if($element instanceof $this->_type)
        {
            parent::add($element);
        }
        else
        {
            throw new \UnexpectedValueException(
                "TypedSequence<$this->_type> can only hold objects of $this->_type class."
            );
        }
        return $this;
    }

    /**
     * Appends elements at the end of the sequence.
     * @param array $elements
     * @return self
     */
    public function addAll(array $elements)
    {
        foreach ($elements as $element)
        {
            $this->add($element);
        }
        return $this;
    }

    /**
     * Updates the element at the given index (0-based).
     *
     * @param int $index
     * @param T $value
     */
    public function update($index, $value)
    {
        if (!isset($this->elements[$index]))
        {
            throw new \InvalidArgumentException(
                sprintf('There is no element at index "%d".', $index)
            );
        }
        if($value instanceof $this->_type)
        {
            $this->elements[$index] = $value;
        }
        return $this;
    }

    /**
     * Remove the element from sequence.
     *
     * @param T $element
     * @param int
     */
    public function removeElement($element)
    {
        if(($index = $this->indexOf($element)) >= 0)
        {
            $this->remove($index);
            return $index;
        }
        else
            return false;
    }
}