-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathName.php
More file actions
90 lines (83 loc) · 2.08 KB
/
Name.php
File metadata and controls
90 lines (83 loc) · 2.08 KB
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
<?php
/**
* Name represents an entity name in Analytics API.
*
* @copyright 2014-2024 Basis Technology Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* @license http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is
* distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and limitations under the License.
**/
namespace rosette\api;
/**
* Class that represents a Name.
*/
class Name extends RosetteParamsSetBase
{
/**
* Textual form of the name.
*
* @var string
*/
public $text;
/**
* Entity type of the name.
*
* @var string
*/
public $entityType;
/**
* Language of the name.
*
* @var string
*/
public $language;
/**
* Script in which the name is written.
*
* @var string
*/
public $script;
/**
* Gender of the name. Can be MALE, FEMALE and NONBINARY
*
* @var Gender
*/
public ?Gender $gender;
/**
* Constructor.
*
* @param $text
* @param $entityType
* @param $language
* @param $script
* @param $gender
*
* @throws RosetteException
*/
public function __construct($text, $entityType = null, $language = null, $script = null, $gender = null)
{
if ($text === null) {
throw new RosetteException(
sprintf('The text of a name is required'),
RosetteException::$BAD_REQUEST_FORMAT
);
}
$this->text = $text;
$this->entityType = $entityType;
$this->language = $language;
$this->script = $script;
$this->gender = $gender;
}
/**
* required validate function
*/
public function validate()
{
// nothing to validate
}
}