blob: 986b81e12d61beeebec001504d20e189c291b660 [file] [log] [blame]
avm9996399bb77c2020-01-27 03:15:08 +01001<?php
2
3// Protocol Buffers - Google's data interchange format
4// Copyright 2017 Google Inc. All rights reserved.
5// https://developers.google.com/protocol-buffers/
6//
7// Redistribution and use in source and binary forms, with or without
8// modification, are permitted provided that the following conditions are
9// met:
10//
11// * Redistributions of source code must retain the above copyright
12// notice, this list of conditions and the following disclaimer.
13// * Redistributions in binary form must reproduce the above
14// copyright notice, this list of conditions and the following disclaimer
15// in the documentation and/or other materials provided with the
16// distribution.
17// * Neither the name of Google Inc. nor the names of its
18// contributors may be used to endorse or promote products derived from
19// this software without specific prior written permission.
20//
21// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
33namespace Google\Protobuf;
34
35use Google\Protobuf\Internal\GetPublicDescriptorTrait;
36
37class Descriptor
38{
39 use GetPublicDescriptorTrait;
40
41 private $internal_desc;
42
43 /**
44 * @internal
45 */
46 public function __construct($internal_desc)
47 {
48 $this->internal_desc = $internal_desc;
49 }
50
51 /**
52 * @return string Full protobuf message name
53 */
54 public function getFullName()
55 {
56 return trim($this->internal_desc->getFullName(), ".");
57 }
58
59 /**
60 * @return string PHP class name
61 */
62 public function getClass()
63 {
64 return $this->internal_desc->getClass();
65 }
66
67 /**
68 * @param int $index Must be >= 0 and < getFieldCount()
69 * @return FieldDescriptor
70 */
71 public function getField($index)
72 {
73 return $this->getPublicDescriptor($this->internal_desc->getFieldByIndex($index));
74 }
75
76 /**
77 * @return int Number of fields in message
78 */
79 public function getFieldCount()
80 {
81 return count($this->internal_desc->getField());
82 }
83
84 /**
85 * @param int $index Must be >= 0 and < getOneofDeclCount()
86 * @return OneofDescriptor
87 */
88 public function getOneofDecl($index)
89 {
90 return $this->getPublicDescriptor($this->internal_desc->getOneofDecl()[$index]);
91 }
92
93 /**
94 * @return int Number of oneofs in message
95 */
96 public function getOneofDeclCount()
97 {
98 return count($this->internal_desc->getOneofDecl());
99 }
100}