Attribute.php
4.5 KB
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<?php
/*
* This file is part of the overtrue/wechat.
*
* (c) overtrue <i@overtrue.me>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
/**
* Attributes.php.
*
* @author overtrue <i@overtrue.me>
* @copyright 2015 overtrue <i@overtrue.me>
*
* @see https://github.com/overtrue
* @see http://overtrue.me
*/
namespace EasyWeChat\Support;
use EasyWeChat\Core\Exceptions\InvalidArgumentException;
/**
* Class Attributes.
*/
abstract class Attribute extends Collection
{
/**
* Attributes alias.
*
* @var array
*/
protected $aliases = [];
/**
* Auto snake attribute name.
*
* @var bool
*/
protected $snakeable = true;
/**
* Required attributes.
*
* @var array
*/
protected $requirements = [];
/**
* Constructor.
*
* @param array $attributes
*/
public function __construct(array $attributes = [])
{
parent::__construct($attributes);
}
/**
* Set attribute.
*
* @param string $attribute
* @param string $value
*
* @return Attribute
*/
public function setAttribute($attribute, $value)
{
$this->set($attribute, $value);
return $this;
}
/**
* Get attribute.
*
* @param string $attribute
* @param mixed $default
*
* @return mixed
*/
public function getAttribute($attribute, $default)
{
return $this->get($attribute, $default);
}
/**
* Set attribute.
*
* @param string $attribute
* @param mixed $value
*
* @return Attribute
*
* @throws \EasyWeChat\Core\Exceptions\InvalidArgumentException
*/
public function with($attribute, $value)
{
$this->snakeable && $attribute = Str::snake($attribute);
if (!$this->validate($attribute, $value)) {
throw new InvalidArgumentException("Invalid attribute '{$attribute}'.");
}
$this->set($attribute, $value);
return $this;
}
/**
* Attribute validation.
*
* @param string $attribute
* @param mixed $value
*
* @return bool
*/
protected function validate($attribute, $value)
{
return true;
}
/**
* Override parent set() method.
*
* @param string $attribute
* @param mixed $value
*/
public function set($attribute, $value = null)
{
parent::set($this->getRealKey($attribute), $value);
}
/**
* Override parent get() method.
*
* @param string $attribute
* @param mixed $default
*
* @return mixed
*/
public function get($attribute, $default = null)
{
return parent::get($this->getRealKey($attribute), $default);
}
/**
* Magic call.
*
* @param string $method
* @param array $args
*
* @return Attribute
*/
public function __call($method, $args)
{
if (0 === stripos($method, 'with')) {
$method = substr($method, 4);
}
return $this->with($method, array_shift($args));
}
/**
* Magic set.
*
* @param string $property
* @param mixed $value
*
* @return Attribute
*/
public function __set($property, $value)
{
return $this->with($property, $value);
}
/**
* Whether or not an data exists by key.
*
* @param string $key
*
* @return bool
*/
public function __isset($key)
{
return parent::__isset($this->getRealKey($key));
}
/**
* Return the raw name of attribute.
*
* @param string $key
*
* @return string
*/
protected function getRealKey($key)
{
if ($alias = array_search($key, $this->aliases, true)) {
$key = $alias;
}
return $key;
}
/**
* Check required attributes.
*
* @throws InvalidArgumentException
*/
protected function checkRequiredAttributes()
{
foreach ($this->requirements as $attribute) {
if (!isset($this->$attribute)) {
throw new InvalidArgumentException(" '{$attribute}' cannot be empty.");
}
}
}
/**
* Return all items.
*
* @return array
*
* @throws InvalidArgumentException
*/
public function all()
{
$this->checkRequiredAttributes();
return parent::all();
}
}