• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?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;
36use Google\Protobuf\Internal\GPBType;
37
38class FieldDescriptor
39{
40    use GetPublicDescriptorTrait;
41
42    private $internal_desc;
43
44    /**
45     * @internal
46     */
47    public function __construct($internal_desc)
48    {
49        $this->internal_desc = $internal_desc;
50    }
51
52    /**
53     * @return string Field name
54     */
55    public function getName()
56    {
57        return $this->internal_desc->getName();
58    }
59
60    /**
61     * @return int Protobuf field number
62     */
63    public function getNumber()
64    {
65        return $this->internal_desc->getNumber();
66    }
67
68    /**
69     * @return int
70     */
71    public function getLabel()
72    {
73        return $this->internal_desc->getLabel();
74    }
75
76    /**
77     * @return int
78     */
79    public function getType()
80    {
81        return $this->internal_desc->getType();
82    }
83
84    /**
85     * @return Descriptor Returns a descriptor for the field type if the field type is a message, otherwise throws \Exception
86     * @throws \Exception
87     */
88    public function getMessageType()
89    {
90        if ($this->getType() == GPBType::MESSAGE) {
91            return $this->getPublicDescriptor($this->internal_desc->getMessageType());
92        } else {
93            throw new \Exception("Cannot get message type for non-message field '" . $this->getName() . "'");
94        }
95    }
96
97    /**
98     * @return EnumDescriptor Returns an enum descriptor if the field type is an enum, otherwise throws \Exception
99     * @throws \Exception
100     */
101    public function getEnumType()
102    {
103        if ($this->getType() == GPBType::ENUM) {
104            return $this->getPublicDescriptor($this->internal_desc->getEnumType());
105        } else {
106            throw new \Exception("Cannot get enum type for non-enum field '" . $this->getName() . "'");
107        }
108    }
109
110    /**
111     * @return boolean
112     */
113    public function isMap()
114    {
115        return $this->internal_desc->isMap();
116    }
117}
118