• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?php
2# Generated by the protocol buffer compiler.  DO NOT EDIT!
3# source: google/protobuf/descriptor.proto
4
5namespace Google\Protobuf\Internal;
6
7use Google\Protobuf\Internal\GPBType;
8use Google\Protobuf\Internal\GPBWire;
9use Google\Protobuf\Internal\RepeatedField;
10use Google\Protobuf\Internal\InputStream;
11use Google\Protobuf\Internal\GPBUtil;
12
13/**
14 * Generated from protobuf message <code>google.protobuf.MessageOptions</code>
15 */
16class MessageOptions extends \Google\Protobuf\Internal\Message
17{
18    /**
19     * Set true to use the old proto1 MessageSet wire format for extensions.
20     * This is provided for backwards-compatibility with the MessageSet wire
21     * format.  You should not use this for any other reason:  It's less
22     * efficient, has fewer features, and is more complicated.
23     * The message must be defined exactly as follows:
24     *   message Foo {
25     *     option message_set_wire_format = true;
26     *     extensions 4 to max;
27     *   }
28     * Note that the message cannot have any defined fields; MessageSets only
29     * have extensions.
30     * All extensions of your type must be singular messages; e.g. they cannot
31     * be int32s, enums, or repeated messages.
32     * Because this is an option, the above two restrictions are not enforced by
33     * the protocol compiler.
34     *
35     * Generated from protobuf field <code>optional bool message_set_wire_format = 1 [default = false];</code>
36     */
37    protected $message_set_wire_format = null;
38    /**
39     * Disables the generation of the standard "descriptor()" accessor, which can
40     * conflict with a field of the same name.  This is meant to make migration
41     * from proto1 easier; new code should avoid fields named "descriptor".
42     *
43     * Generated from protobuf field <code>optional bool no_standard_descriptor_accessor = 2 [default = false];</code>
44     */
45    protected $no_standard_descriptor_accessor = null;
46    /**
47     * Is this message deprecated?
48     * Depending on the target platform, this can emit Deprecated annotations
49     * for the message, or it will be completely ignored; in the very least,
50     * this is a formalization for deprecating messages.
51     *
52     * Generated from protobuf field <code>optional bool deprecated = 3 [default = false];</code>
53     */
54    protected $deprecated = null;
55    /**
56     * Whether the message is an automatically generated map entry type for the
57     * maps field.
58     * For maps fields:
59     *     map<KeyType, ValueType> map_field = 1;
60     * The parsed descriptor looks like:
61     *     message MapFieldEntry {
62     *         option map_entry = true;
63     *         optional KeyType key = 1;
64     *         optional ValueType value = 2;
65     *     }
66     *     repeated MapFieldEntry map_field = 1;
67     * Implementations may choose not to generate the map_entry=true message, but
68     * use a native map in the target language to hold the keys and values.
69     * The reflection APIs in such implementations still need to work as
70     * if the field is a repeated message field.
71     * NOTE: Do not set the option in .proto files. Always use the maps syntax
72     * instead. The option should only be implicitly set by the proto compiler
73     * parser.
74     *
75     * Generated from protobuf field <code>optional bool map_entry = 7;</code>
76     */
77    protected $map_entry = null;
78    /**
79     * The parser stores options it doesn't recognize here. See above.
80     *
81     * Generated from protobuf field <code>repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;</code>
82     */
83    private $uninterpreted_option;
84
85    /**
86     * Constructor.
87     *
88     * @param array $data {
89     *     Optional. Data for populating the Message object.
90     *
91     *     @type bool $message_set_wire_format
92     *           Set true to use the old proto1 MessageSet wire format for extensions.
93     *           This is provided for backwards-compatibility with the MessageSet wire
94     *           format.  You should not use this for any other reason:  It's less
95     *           efficient, has fewer features, and is more complicated.
96     *           The message must be defined exactly as follows:
97     *             message Foo {
98     *               option message_set_wire_format = true;
99     *               extensions 4 to max;
100     *             }
101     *           Note that the message cannot have any defined fields; MessageSets only
102     *           have extensions.
103     *           All extensions of your type must be singular messages; e.g. they cannot
104     *           be int32s, enums, or repeated messages.
105     *           Because this is an option, the above two restrictions are not enforced by
106     *           the protocol compiler.
107     *     @type bool $no_standard_descriptor_accessor
108     *           Disables the generation of the standard "descriptor()" accessor, which can
109     *           conflict with a field of the same name.  This is meant to make migration
110     *           from proto1 easier; new code should avoid fields named "descriptor".
111     *     @type bool $deprecated
112     *           Is this message deprecated?
113     *           Depending on the target platform, this can emit Deprecated annotations
114     *           for the message, or it will be completely ignored; in the very least,
115     *           this is a formalization for deprecating messages.
116     *     @type bool $map_entry
117     *           Whether the message is an automatically generated map entry type for the
118     *           maps field.
119     *           For maps fields:
120     *               map<KeyType, ValueType> map_field = 1;
121     *           The parsed descriptor looks like:
122     *               message MapFieldEntry {
123     *                   option map_entry = true;
124     *                   optional KeyType key = 1;
125     *                   optional ValueType value = 2;
126     *               }
127     *               repeated MapFieldEntry map_field = 1;
128     *           Implementations may choose not to generate the map_entry=true message, but
129     *           use a native map in the target language to hold the keys and values.
130     *           The reflection APIs in such implementations still need to work as
131     *           if the field is a repeated message field.
132     *           NOTE: Do not set the option in .proto files. Always use the maps syntax
133     *           instead. The option should only be implicitly set by the proto compiler
134     *           parser.
135     *     @type \Google\Protobuf\Internal\UninterpretedOption[]|\Google\Protobuf\Internal\RepeatedField $uninterpreted_option
136     *           The parser stores options it doesn't recognize here. See above.
137     * }
138     */
139    public function __construct($data = NULL) {
140        \GPBMetadata\Google\Protobuf\Internal\Descriptor::initOnce();
141        parent::__construct($data);
142    }
143
144    /**
145     * Set true to use the old proto1 MessageSet wire format for extensions.
146     * This is provided for backwards-compatibility with the MessageSet wire
147     * format.  You should not use this for any other reason:  It's less
148     * efficient, has fewer features, and is more complicated.
149     * The message must be defined exactly as follows:
150     *   message Foo {
151     *     option message_set_wire_format = true;
152     *     extensions 4 to max;
153     *   }
154     * Note that the message cannot have any defined fields; MessageSets only
155     * have extensions.
156     * All extensions of your type must be singular messages; e.g. they cannot
157     * be int32s, enums, or repeated messages.
158     * Because this is an option, the above two restrictions are not enforced by
159     * the protocol compiler.
160     *
161     * Generated from protobuf field <code>optional bool message_set_wire_format = 1 [default = false];</code>
162     * @return bool
163     */
164    public function getMessageSetWireFormat()
165    {
166        return isset($this->message_set_wire_format) ? $this->message_set_wire_format : false;
167    }
168
169    public function hasMessageSetWireFormat()
170    {
171        return isset($this->message_set_wire_format);
172    }
173
174    public function clearMessageSetWireFormat()
175    {
176        unset($this->message_set_wire_format);
177    }
178
179    /**
180     * Set true to use the old proto1 MessageSet wire format for extensions.
181     * This is provided for backwards-compatibility with the MessageSet wire
182     * format.  You should not use this for any other reason:  It's less
183     * efficient, has fewer features, and is more complicated.
184     * The message must be defined exactly as follows:
185     *   message Foo {
186     *     option message_set_wire_format = true;
187     *     extensions 4 to max;
188     *   }
189     * Note that the message cannot have any defined fields; MessageSets only
190     * have extensions.
191     * All extensions of your type must be singular messages; e.g. they cannot
192     * be int32s, enums, or repeated messages.
193     * Because this is an option, the above two restrictions are not enforced by
194     * the protocol compiler.
195     *
196     * Generated from protobuf field <code>optional bool message_set_wire_format = 1 [default = false];</code>
197     * @param bool $var
198     * @return $this
199     */
200    public function setMessageSetWireFormat($var)
201    {
202        GPBUtil::checkBool($var);
203        $this->message_set_wire_format = $var;
204
205        return $this;
206    }
207
208    /**
209     * Disables the generation of the standard "descriptor()" accessor, which can
210     * conflict with a field of the same name.  This is meant to make migration
211     * from proto1 easier; new code should avoid fields named "descriptor".
212     *
213     * Generated from protobuf field <code>optional bool no_standard_descriptor_accessor = 2 [default = false];</code>
214     * @return bool
215     */
216    public function getNoStandardDescriptorAccessor()
217    {
218        return isset($this->no_standard_descriptor_accessor) ? $this->no_standard_descriptor_accessor : false;
219    }
220
221    public function hasNoStandardDescriptorAccessor()
222    {
223        return isset($this->no_standard_descriptor_accessor);
224    }
225
226    public function clearNoStandardDescriptorAccessor()
227    {
228        unset($this->no_standard_descriptor_accessor);
229    }
230
231    /**
232     * Disables the generation of the standard "descriptor()" accessor, which can
233     * conflict with a field of the same name.  This is meant to make migration
234     * from proto1 easier; new code should avoid fields named "descriptor".
235     *
236     * Generated from protobuf field <code>optional bool no_standard_descriptor_accessor = 2 [default = false];</code>
237     * @param bool $var
238     * @return $this
239     */
240    public function setNoStandardDescriptorAccessor($var)
241    {
242        GPBUtil::checkBool($var);
243        $this->no_standard_descriptor_accessor = $var;
244
245        return $this;
246    }
247
248    /**
249     * Is this message deprecated?
250     * Depending on the target platform, this can emit Deprecated annotations
251     * for the message, or it will be completely ignored; in the very least,
252     * this is a formalization for deprecating messages.
253     *
254     * Generated from protobuf field <code>optional bool deprecated = 3 [default = false];</code>
255     * @return bool
256     */
257    public function getDeprecated()
258    {
259        return isset($this->deprecated) ? $this->deprecated : false;
260    }
261
262    public function hasDeprecated()
263    {
264        return isset($this->deprecated);
265    }
266
267    public function clearDeprecated()
268    {
269        unset($this->deprecated);
270    }
271
272    /**
273     * Is this message deprecated?
274     * Depending on the target platform, this can emit Deprecated annotations
275     * for the message, or it will be completely ignored; in the very least,
276     * this is a formalization for deprecating messages.
277     *
278     * Generated from protobuf field <code>optional bool deprecated = 3 [default = false];</code>
279     * @param bool $var
280     * @return $this
281     */
282    public function setDeprecated($var)
283    {
284        GPBUtil::checkBool($var);
285        $this->deprecated = $var;
286
287        return $this;
288    }
289
290    /**
291     * Whether the message is an automatically generated map entry type for the
292     * maps field.
293     * For maps fields:
294     *     map<KeyType, ValueType> map_field = 1;
295     * The parsed descriptor looks like:
296     *     message MapFieldEntry {
297     *         option map_entry = true;
298     *         optional KeyType key = 1;
299     *         optional ValueType value = 2;
300     *     }
301     *     repeated MapFieldEntry map_field = 1;
302     * Implementations may choose not to generate the map_entry=true message, but
303     * use a native map in the target language to hold the keys and values.
304     * The reflection APIs in such implementations still need to work as
305     * if the field is a repeated message field.
306     * NOTE: Do not set the option in .proto files. Always use the maps syntax
307     * instead. The option should only be implicitly set by the proto compiler
308     * parser.
309     *
310     * Generated from protobuf field <code>optional bool map_entry = 7;</code>
311     * @return bool
312     */
313    public function getMapEntry()
314    {
315        return isset($this->map_entry) ? $this->map_entry : false;
316    }
317
318    public function hasMapEntry()
319    {
320        return isset($this->map_entry);
321    }
322
323    public function clearMapEntry()
324    {
325        unset($this->map_entry);
326    }
327
328    /**
329     * Whether the message is an automatically generated map entry type for the
330     * maps field.
331     * For maps fields:
332     *     map<KeyType, ValueType> map_field = 1;
333     * The parsed descriptor looks like:
334     *     message MapFieldEntry {
335     *         option map_entry = true;
336     *         optional KeyType key = 1;
337     *         optional ValueType value = 2;
338     *     }
339     *     repeated MapFieldEntry map_field = 1;
340     * Implementations may choose not to generate the map_entry=true message, but
341     * use a native map in the target language to hold the keys and values.
342     * The reflection APIs in such implementations still need to work as
343     * if the field is a repeated message field.
344     * NOTE: Do not set the option in .proto files. Always use the maps syntax
345     * instead. The option should only be implicitly set by the proto compiler
346     * parser.
347     *
348     * Generated from protobuf field <code>optional bool map_entry = 7;</code>
349     * @param bool $var
350     * @return $this
351     */
352    public function setMapEntry($var)
353    {
354        GPBUtil::checkBool($var);
355        $this->map_entry = $var;
356
357        return $this;
358    }
359
360    /**
361     * The parser stores options it doesn't recognize here. See above.
362     *
363     * Generated from protobuf field <code>repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;</code>
364     * @return \Google\Protobuf\Internal\RepeatedField
365     */
366    public function getUninterpretedOption()
367    {
368        return $this->uninterpreted_option;
369    }
370
371    /**
372     * The parser stores options it doesn't recognize here. See above.
373     *
374     * Generated from protobuf field <code>repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;</code>
375     * @param \Google\Protobuf\Internal\UninterpretedOption[]|\Google\Protobuf\Internal\RepeatedField $var
376     * @return $this
377     */
378    public function setUninterpretedOption($var)
379    {
380        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Protobuf\Internal\UninterpretedOption::class);
381        $this->uninterpreted_option = $arr;
382
383        return $this;
384    }
385
386}
387
388