-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathDocumentParameters.php
More file actions
172 lines (157 loc) · 4.64 KB
/
DocumentParameters.php
File metadata and controls
172 lines (157 loc) · 4.64 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<?php
/**
* class DocumentParameters.
*
* Parameter class for the standard Analytics API endpoints. Does not include Name Translation
*
* @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 DocumentParameters.
*/
class DocumentParameters extends RosetteParamsSetBase
{
/**
* @var string content is the text to be analyzed (required if no contentUri)
*/
public $content;
/**
* @var string contentUri is a URL to content that will be analyzed (required if no content)
*/
public $contentUri;
/**
* @var string language is the language of the content (optional)
*/
public $language;
/**
* @var string multiPartContent contains content for multipart packaging. Private to prevent
* processing by the serializer
*/
private $multiPartContent;
/**
* @var string fileName is the name of the file containing content to be analyzed
*/
private $fileName;
/**
* @deprecated
* @var string genre to categorize the input data
*/
public $genre;
/**
* Constructor.
*
* @throws RosetteException
*/
public function __construct()
{
$this->content = '';
$this->contentUri = '';
$this->language = '';
$this->multiPartContent = '';
$this->genre = '';
}
/**
* Setter for multiPartContent. Clears the content and contentUri properties if it contains
* data
*
* @param $str_content
*/
public function setMultiPartContent($str_content)
{
$this->multiPartContent = trim($str_content);
if (strlen($str_content) > 0) {
$this->content = '';
$this->contentUri = '';
}
}
/**
* Getter for multiPartContent
*
* @return string
*/
public function getMultiPartContent()
{
return $this->multiPartContent;
}
/**
* Getter for fileName
*
* @return string
*/
public function getFileName()
{
return $this->fileName;
}
/**
* Validates parameters.
*
* @throws RosetteException
*/
public function validate()
{
if (empty(trim($this->multiPartContent))) {
if (empty(trim($this->content))) {
if (empty(trim($this->contentUri))) {
throw new RosetteException(
'Must supply one of Content or ContentUri',
RosetteException::$INVALID_DATATYPE
);
}
} else {
if (!empty(trim($this->contentUri))) {
throw new RosetteException(
'Cannot supply both Content and ContentUri',
RosetteException::$INVALID_DATATYPE
);
}
}
}
if (!empty(trim($this->genre))) {
error_log("Deprecated: The option 'genre' is deprecated and will be removed in the next release.", 0);
}
}
/**
* Loads a file into the object.
*
* The file will be read as bytes; the appropriate conversion will be determined by the server.
*
* @param $path : Pathname of a file acceptable to the C{open}
* function.
*
* @throws RosetteException
*/
public function loadDocumentFile($path)
{
$this->loadDocumentString(file_get_contents($path), true);
$this->fileName = $path;
}
/**
* Loads a string into the object.
*
* The string will be taken as bytes or as Unicode dependent upon its native type and the data type asked for;
* if the type is HTML or XHTML, bytes are expected, the encoding to be determined by the server.
*
* @param $stringData
* @param $multiPart
*
* @throws RosetteException
*/
public function loadDocumentString($stringData, $multiPart = false)
{
if ($multiPart === true) {
$this->setMultiPartContent($stringData);
} else {
$this->content = $stringData;
$this->multiPartContent = '';
}
}
}