Add php protobuffer support for transition to GTFS-realtime
[busui.git] / lib / Protobuf-PHP / library / DrSlump / Protobuf / Message.php
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
<?php
 
namespace DrSlump\Protobuf;
 
use DrSlump\Protobuf;
 
abstract class Message implements \ArrayAccess
{
    /** @var \Closure[] */
    static protected $__extensions = array();
 
    /** @var \DrSlump\Protobuf\Descriptor */
    protected $_descriptor;
    /** @var array Store data for extension fields */
    protected $_extensions = array();
    /** @var array Store data for unknown values */
    protected $_unknown = array();
 
    /**
     * @static
     * @abstract
     * @return \DrSlump\Protobuf\Descriptor
     */
    public static function descriptor()
    {
        throw new \BadMethodCallException('This method should be implemented in inherited classes');
    }
 
    /**
     * Register an extension configuration callback
     *
     * @static
     * @param \Closure $fn
     */
    public static function extension(\Closure $fn)
    {
        static::$__extensions[] = $fn;
    }
 
    /**
     * @param string $data
     */
    public function __construct($data = null)
    {
        // Cache the descriptor instance
        $this->_descriptor = Protobuf::getRegistry()->getDescriptor($this);
 
        // Assign default values to extensions
        foreach ($this->_descriptor->getFields() as $f) {
           if ($f->isExtension() && $f->hasDefault()) {
               $this->_extensions[$f->getName()] = $f->getDefault();
           }
        }
 
        if (NULL !== $data) {
            $this->parse($data);
        }
    }
 
    // Implements ArrayAccess for extensions and unknown fields
 
    public function offsetExists($offset)
    {
        if (is_numeric($offset)) {
            return $this->_has($offset);
        } else {
            return $this->hasExtension($offset);
        }
    }
 
    public function offsetSet($offset, $value)
    {
        if (is_numeric($offset)) {
            $this->_set($offset, $value);
        } else {
            $this->setExtension($offset, $value);
        }
    }
 
    public function offsetGet( $offset )
    {
        if (is_numeric($offset)) {
            return $this->_get($offset);
        } else {
            return $this->getExtension($offset);
        }
    }
 
    public function offsetUnset( $offset )
    {
        if (is_numeric($offset)) {
            $this->_clear($offset);
        } else {
            $this->clearExtension($offset);
        }
    }
 
    /**
     * Parse the given data to hydrate the object
     *
     * @param string $data
     * @param CodecInterface|null $codec
     */
    public function parse($data, Protobuf\CodecInterface $codec = null)
    {
        $codec = Protobuf::getCodec($codec);
        $codec->decode($this, $data);
    }
 
    /**
     * Serialize the current object data
     *
     * @param CodecInterface|null $codec
     * @return string
     */
    public function serialize(Protobuf\CodecInterface $codec = null)
    {
        $codec = Protobuf::getCodec($codec);
        return $codec->encode($this);
    }
 
 
    /**
     * Checks if the given tag number is set
     *
     * @param int $tag
     * @return bool
     */
    public function _has($tag)
    {
        if ($this->_descriptor->hasField($tag)) {
            $f = $this->_descriptor->getField($tag);
            $name = $f->getName();
 
            if ($f->isExtension()) {
                return $f->isRepeated()
                       ? count($this->_extensions[$name]) > 0
                       : $this->_extensions[$name] !== NULL;
            } else {
                return $f->isRepeated()
                       ? count($this->$name) > 0
                       : $this->$name !== NULL;
            }
        }
 
        return false;
    }
 
    /**
     * Get the value by tag number
     *
     * @param int $tag
     * @param int|null $idx
     * @return mixed
     */
    public function _get($tag, $idx = null)
    {
        $f = $this->_descriptor->getField($tag);
 
        if (!$f) {
            return null;
        }
 
        $name = $f->getName();
 
        if (!$f->isExtension()) {
 
            return $idx !== NULL
                   ? $this->{$name}[$idx]
                   : $this->$name;
 
        } else {
 
            return $idx !== NULL
                   ? $this->_extensions[$name][$idx]
                   : $this->_extensions[$name];
 
        }
 
    }
 
    /**
     * Sets the value by tag number
     *
     * @throws \Exception If trying to set an unknown field
     * @param int $tag
     * @param mixed $value
     * @param int|null $idx
     * @return \DrSlump\Protobuf\Message - Fluent interface
     */
    public function _set($tag, $value, $idx = null)
    {
        $f = $this->_descriptor->getField($tag);
 
        if (!$f) {
            throw new \Exception('Unknown fields not supported');
        }
 
        $name = $f->getName();
        if (!$f->isExtension()) {
 
            if ($idx === NULL) {
                $this->$name = $value;
            } else {
                $this->{$name}[$idx] = $value;
            }
 
        } else {
            if ($idx === NULL) {
                $this->_extensions[$name] = $value;
            } else {
                $this->_extensions[$name][$idx] = $value;
            }
        }
 
        return $this;
    }
 
    /**
     * Adds a new value to a repeated field by tag number
     *
     * @throws \Exception If trying to modify an unknown field
     * @param int $tag
     * @param mixed $value
     * @return Message
     */
    public function _add($tag, $value)
    {
        $f = $this->_descriptor->getField($tag);
 
        if (!$f) {
            throw new \Exception('Unknown fields not supported');
        }
 
        $name = $f->getName();
        if (!$f->isExtension()) {
            $this->{$name}[] = $value;
        } else {
            $this->_extensions[$name][] = $value;
        }
 
        return $this;
    }
 
    /**
     * Clears/Resets a field by tag number
     *
     * @throws \Exception If trying to modify an unknown field
     * @param int $tag
     * @return \DrSlump\Protobuf\Message - Fluent interface
     */
    public function _clear($tag)
    {
        $f = $this->_descriptor->getField($tag);
 
        if (!$f) {
            throw new \Exception('Unknown fields not supported');
        }
 
        $name = $f->getName();
        if (!$f->isExtension()) {
            $this->$name = $f->isRepeated()
                           ? array()
                           : NULL;
        } else {
            $this->_extensions[$name] = $f->isRepeated()
                                      ? array()
                                      : NULL;
        }
 
        return $this;
    }
 
    // Extensions public methods.
    // @todo Check if extension name is defined
 
    /**
     * Checks if an extension field is set
     *
     * @param string $extname
     * @return bool
     */
    public function hasExtension($extname)
    {
        return isset($this->_extensions[$extname]);
    }
 
    /**
     * Get the value of an extension field
     *
     * @param string $extname
     * @param int|null $idx
     * @return mixed
     */
    public function getExtension($extname, $idx = null)
    {
        if (!isset($this->_extensions[$extname])) return NULL;
 
        return $idx === NULL
               ? $this->_extensions[$extname]
               : $this->_extensions[$extname][$idx];
    }
 
    /**
     * Get all the values of a repeated extension field
     *
     * @param string $extname
     * @return array
     */
    public function getExtensionList($extname)
    {
        return isset($this->_extensions[$extname])
               ? $this->_extensions[$extname]
               : array();
    }
 
    /**
     * Set the value for an extension field
     *
     * @param string $extname
     * @param mixed $value
     * @param int|null $idx
     * @return \DrSlump\Protobuf\Message - Fluent Interface
     */
    public function setExtension($extname, $value, $idx = null)
    {
        if (NULL !== $idx) {
            if (empty($this->_extensions)) {
                $this->_extensions[$extname] = array();
            }
            $this->_extensions[$extname][$idx] = $value;
        }
 
        $this->_extensions[$extname] = $value;
 
        return $this;
    }
 
    /**
     * Adds a value to repeated extension field
     *
     * @param string $extname
     * @param mixed $value
     * @return \DrSlump\Protobuf\Message - Fluent Interface
     */
    public function addExtension($extname, $value)
    {
        $this->_extensions[$extname][] = $value;
    }
 
    /**
     * @param  $extname
     * @return void
     */
    public function clearExtension($extname)
    {
        unset($this->_extensions[$extname]);
    }
 
 
    public function addUnknown(Unknown $unknown)
    {
        $this->_unknown[] = $unknown;
    }
 
    public function getUnknown()
    {
        return $this->_unknown;
    }
 
    public function clearUnknown()
    {
        $this->_unknown = array();
    }
 
}