-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathNameTranslationParameters.php
More file actions
93 lines (89 loc) · 2.78 KB
/
NameTranslationParameters.php
File metadata and controls
93 lines (89 loc) · 2.78 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
91
92
93
<?php
/**
* class NameTranslationParameters.
*
* Parameters that are necessary for name translation operations.
*
* @copyright 2014-2023 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 NameTranslationParameters.
*/
class NameTranslationParameters extends RosetteParamsSetBase
{
/**
* @var string name to translate
*/
public $name;
/**
* @var string targetLanguage ISO 639-3 code for the translation language
*/
public $targetLanguage;
/**
* @var string entityType type of entity, e.g. PERSON, LOCATION, ORGANIZATION (optional)
*/
public $entityType;
/**
* @var string sourceLanguageOfOrigin ISO 693-3 code for name's language of origin (optional)
*/
public $sourceLanguageOfOrigin;
/**
* @var string sourceLanguageOfUse ISO 693-3 code for name's language of use (optional)
*/
public $sourceLanguageOfUse;
/**
* @var string sourceScript ISO 15924 code for name's script (optional)
*/
public $sourceScript;
/**
* @var string targetScript ISO 15924 code for name's script (optional)
*/
public $targetScript;
/**
* @var string targetScheme transliteration scheme for the translation (optional)
*/
public $targetScheme;
/**
* @deprecated
* @var string genre to categorize the input data
*/
public $genre;
/**
* constructor.
*/
public function __construct()
{
}
/**
* Validates parameters.
*
* @throws RosetteException
*/
public function validate()
{
if (empty($this->name)) {
throw new RosetteException(
sprintf('Required name translation parameter not supplied: name'),
RosetteException::$BAD_REQUEST_FORMAT
);
}
if (empty($this->targetLanguage)) {
throw new RosetteException(
sprintf('Required name translation parameter not supplied: targetLanguage'),
RosetteException::$BAD_REQUEST_FORMAT
);
}
if ($this->genre != null && !empty(trim($this->genre))) {
error_log("Deprecated: The option 'genre' is deprecated and will be removed in the next release.", 0);
}
}
}