xref: /aosp_15_r20/external/protobuf/php/src/Google/Protobuf/OneofDescriptor.php (revision 1b3f573f81763fcece89efc2b6a5209149e44ab8)
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;
36
37class OneofDescriptor
38{
39    use GetPublicDescriptorTrait;
40
41    /** @var  \Google\Protobuf\Internal\OneofDescriptor $internal_desc */
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 The name of the oneof
54     */
55    public function getName()
56    {
57        return $this->internal_desc->getName();
58    }
59
60    /**
61     * @param int $index Must be >= 0 and < getFieldCount()
62     * @return FieldDescriptor
63     */
64    public function getField($index)
65    {
66        if (
67            is_null($this->internal_desc->getFields())
68            || !isset($this->internal_desc->getFields()[$index])
69        ) {
70            return null;
71        }
72        return $this->getPublicDescriptor($this->internal_desc->getFields()[$index]);
73    }
74
75    /**
76     * @return int Number of fields in the oneof
77     */
78    public function getFieldCount()
79    {
80        return count($this->internal_desc->getFields());
81    }
82
83    public function isSynthetic()
84    {
85        return $this->internal_desc->isSynthetic();
86    }
87}
88