blob: 61b2474fcaa2119875451106b352ae822d75fa2a (
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
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
/**
* PHP version 7.1.1
* @author Hannes Kindströmmer <hannes@kindstrommer.se>
* @copyright 2017 iP.1 Networks AB
* @license https://www.gnu.org/licenses/lgpl-3.0.txt LGPL-3.0
* @version 0.1.0-beta
* @since File available since Release 0.1.0-beta
* @link http://api.ip1sms.com/Help
* @link https://github.com/iP1SMS/ip1-php-sdk
*/
namespace IP1\RESTClient\Core;
/**
*
* An extension of ArrayObject that ensures that there's only one type of object in the array.
*/
class ClassValidationArray extends \ArrayObject implements \JsonSerializable
{
/**
* Stores the only allowed class that is allowed in the array.
* @var string $class
*/
private $class;
/**
* Takes the input and puts it in the contained array.
*
* If the input is an object it will add the object to the array and set the object's class to the only allowed class
* If the input is an array it will verify that all the objects inside the array are of the same class if not it will
* throw an InvalidArgumentException. If all the indexes are of the same class it will add them to the array.
* If input is a string then that string will set the only allowed class.
* @example new ClassValidationArray(get_class(new stdClass));
*
* @param array|object|string $input If array it must only contain a single type of class.
* @throws \InvalidArgumentException Thrown when getting unexpected arguments.
*/
public function __construct($input = [])
{
if (is_array($input)) {
foreach ($input as $key => $value) {
if (!is_object($value)) {
throw new \InvalidArgumentException("Non object found at index $key. Not allowed.");
}
if (!isset($this->class)) {
$this->class = get_class($value);
}
if ($this->class === get_class($value)) {
parent::offsetSet(null, $value);
} else {
throw new \InvalidArgumentException(
$this->class.
" expected in array. Got" .
get_class($value) .
" at index $key"
);
}
}
} elseif (is_object($input)) {
$this->class = get_class($input);
parent::offsetSet(null, $input);
} elseif (is_string($input)) {
$this->class = $input;
} else {
throw new \InvalidArgumentException(gettype($input). " given argument was not an array or an object.");
}
}
/**
* Sets the value at the specified index to value if value's class matches the one set.
* If a class has not been set it will set the given object's class as the only allowed class.
* @param mixed $index The index to put the value in.
* @param object $value The object that should be added.
* @return void
* @throws \InvalidArgumentException When $value is not an object or doesn't match the class that has been set.
*/
public function offsetSet($index, $value): void
{
if (!is_object($value)) {
throw new \InvalidArgumentException("Excepcted object, got ". gettype($value));
}
if (!isset($this->class)) {
$this->class = get_class($value);
}
if (get_class($value) === $this->class) {
parent::offsetSet($index, $value);
} else {
throw new \InvalidArgumentException("Excepcted $this->class, got ". get_class($value));
}
}
/**
* Returns the only class that is allowed to be added.
* @return string
*/
public function getContainedClass(): string
{
return $this->class;
}
/**
* Serializes the object to a value that can be serialized natively by json_encode().
* @return array Associative.
* @link http://php.net/manual/en/jsonserializable.jsonserialize.php
*/
public function jsonSerialize(): array
{
$returnArray = [];
foreach ($this->getArrayCopy() as $value) {
$returnArray[] = $value->JsonSerialize();
}
return $returnArray;
}
}
|
