forked from Unicity/Chimera
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Writer.php
356 lines (320 loc) · 10.5 KB
/
Writer.php
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<?php
/**
* Copyright 2015 Unicity International
*
* 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
*
* 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 Unicity\Config {
use \Unicity\Common;
use \Unicity\Config;
use \Unicity\Core;
use \Unicity\IO;
use \Unicity\Throwable;
/**
* This class is used to write a collection to a file.
*
* @abstract
* @access public
* @class
* @package Config
*/
abstract class Writer extends Core\Object {
/**
* This variable stores a reference to the data being written.
*
* @access protected
* @var mixed
*/
protected $data;
/**
* This variable stores any metadata associated with the writer that is needed
* to write to the URI.
*
* @access protected
* @var array
*/
protected $metadata;
/**
* This constructor initializes the class with the specified data.
*
* @access public
* @param mixed $data the data to be written
*/
public function __construct($data) {
$this->data = $data;
$this->metadata = array(
'encoding' => array(Core\Data\Charset::UTF_8_ENCODING, Core\Data\Charset::UTF_8_ENCODING),
'ext' => '.txt',
'mime' => 'text/plain',
'uri' => null,
);
}
/**
* This method sets the metadata for the writer.
*
* @access public
* @param array $metadata the metadata to be set
* @return Config\Writer a reference to this class
* @throws Throwable\InvalidProperty\Exception indicates that the specified property
* is either inaccessible or undefined
*/
public function config(array $metadata) {
if ($metadata !== null) {
foreach ($metadata as $name => $value) {
if (strcmp($name, 'data') != 0) {
$this->$name = $value;
}
}
}
return $this;
}
/**
* This destructor ensures that any resources are properly disposed.
*
* @access public
*/
public function __destruct() {
parent::__destruct();
unset($this->data);
unset($this->metadata);
}
/**
* This method displays the data.
*
* @access public
* @param Core\IMessage $message the message container
*/
public function display(Core\IMessage $message = null) {
$charset = isset($this->metadata['encoding'][1])
? $this->metadata['encoding'][1]
: Core\Data\Charset::UTF_8_ENCODING;
if ($message === null) {
$message = new Core\Message();
$send = true;
}
else {
$send = false;
}
$buffer = new IO\StringBuffer($this->render());
$message->setHeader('content-disposition', 'inline');
$message->setHeader('content-type', $this->metadata['mime'] . '; charset=' . $charset);
$message->setBody($buffer);
if ($send) {
$message->send();
}
}
/**
* This method exports the data.
*
* @access public
* @param Core\IMessage $message the message container
*/
public function export(Core\IMessage $message = null) {
if (isset($this->metadata['uri']) && ($this->metadata['uri'] != '')) {
$uri = preg_split('!(\?.*|/)!', $this->metadata['uri'], -1, PREG_SPLIT_NO_EMPTY);
$uri = $uri[count($uri) - 1];
}
else {
date_default_timezone_set('America/Denver');
$uri = date('YmdHis') . $this->metadata['ext'];
}
$charset = isset($this->metadata['encoding'][1])
? $this->metadata['encoding'][1]
: Core\Data\Charset::UTF_8_ENCODING;
if ($message === null) {
$message = new Core\Message();
$send = true;
}
else {
$send = false;
}
$buffer = new IO\StringBuffer($this->render());
$message->setHeader('content-disposition', 'attachment; filename="' . $uri . '"');
$message->setHeader('content-type', $this->metadata['mime'] . '; charset=' . $charset);
$message->setBody($buffer);
if ($send) {
$message->send();
}
}
/**
* This function returns the value associated with the specified property.
*
* @access public
* @override
* @param string $name the name of the property
* @return mixed the value of the property
* @throws Throwable\InvalidProperty\Exception indicates that the specified property
* is either inaccessible or undefined
*/
public function __get($name) {
if (strcmp($name, 'data') == 0) {
return $this->data;
}
else if (!array_key_exists($name, $this->metadata)) {
throw new Throwable\InvalidProperty\Exception('Unable to get the specified property. Property :name is either inaccessible or undefined.', array(':name' => $name));
}
return $this->metadata[$name];
}
/**
* This method renders the data for the writer.
*
* @access public
* @abstract
* @return mixed the processed data
*/
public abstract function render();
/**
* This method saves the data to disk.
*
* @access public
*/
public function save() {
if (!isset($this->metadata['uri']) || ($this->metadata['uri'] == '')) {
date_default_timezone_set('America/Denver');
$this->metadata['uri'] = date('YmdHis') . $this->metadata['ext'];
}
file_put_contents($this->metadata['uri'], $this->render());
}
/**
* This function sets the value for the specified key.
*
* @access public
* @override
* @param string $name the name of the property
* @param mixed $value the value of the property
* @throws Throwable\InvalidProperty\Exception indicates that the specified property
* is either inaccessible or undefined
*/
public function __set($name, $value) {
if (!array_key_exists($name, $this->metadata)) {
throw new Throwable\InvalidProperty\Exception('Unable to set the specified property. Property :name is either inaccessible or undefined.', array(':name' => $name));
}
if (strcmp($name, 'eol') == 0) {
if (!preg_match('/^\R$/', $value)) {
$value = str_replace('\n', "\n", str_replace('\r', "\r", $value));
}
}
$this->metadata[$name] = $value;
}
/**
* This method return a writer matching the specified format.
*
* @access public
* @static
* @param string $format the name of the writer
* @param mixed $data the data to be written
* @param boolean $restrict whether to restrict access to certain
* writer classes
* @return Config\Writer the writer
* @throws Throwable\Instantiation\Exception indicates that there is no matching
* writer available
*/
public static function factory($format, $data, $restrict = true) {
$name = str_replace('_', '', $format);
if ($restrict && in_array(strtolower($name), array('inc', 'php'))) {
throw new Throwable\Instantiation\Exception('Unable to initialize class. Unknown writer format, got ":format".', array(':format' => $format));
}
$writer = "\\Unicity\\Config\\{$name}\\Writer";
if (!class_exists($writer)) {
$directory = dirname(__FILE__);
$directories = scandir($directory);
foreach ($directories as $file) {
if (!in_array($file, array('.', '..')) && (!is_dir($directory . DIRECTORY_SEPARATOR . $file) && (strtolower($file) == $name))) {
$writer = "\\Unicity\\Config\\{$file}\\Writer";
if (!class_exists($writer)) {
break;
}
return new $writer($data);
}
}
throw new Throwable\Instantiation\Exception('Unable to initialize class. Unknown writer format, got ":format".', array(':format' => $format));
}
return new $writer($data);
}
/**
* This method returns whether the specified array is an associated array.
*
* @access protected
* @static
* @param mixed $value the value to be evaluated
* @return boolean whether the specified array is an
* associated array
*/
protected static function isDictionary($value) {
if (($value !== null) && is_array($value)) {
$keys = array_keys($value);
return (array_keys($keys) !== $keys);
}
return false;
}
/**
* This method converts a collection to use arrays.
*
* @access protected
* @static
* @param mixed $data the data to be converted
* @return mixed the converted data
*/
protected static function useArrays($data) {
if (is_object($data)) {
if ($data instanceof Common\ICollection) {
$buffer = array();
if ($data instanceof Common\IMap) {
foreach ($data as $key => $value) {
if (!($value instanceof Core\Data\Undefined)) {
$buffer[$key] = static::useArrays($value);
}
}
}
else {
foreach ($data as $value) {
if (!($value instanceof Core\Data\Undefined)) {
$buffer[] = static::useArrays($value);
}
}
}
return $buffer;
}
else if ($data instanceof \stdClass) {
$data = get_object_vars($data);
$buffer = array();
foreach ($data as $key => $value) {
if (!($value instanceof Core\Data\Undefined)) {
$buffer[$key] = static::useArrays($value);
}
}
return $buffer;
}
}
else if (is_array($data)) {
$buffer = array();
if (static::isDictionary($data)) {
foreach ($data as $key => $value) {
if (!($value instanceof Core\Data\Undefined)) {
$buffer[$key] = static::useArrays($value);
}
}
}
else {
foreach ($data as $value) {
if (!($value instanceof Core\Data\Undefined)) {
$buffer[] = static::useArrays($value);
}
}
}
return $buffer;
}
return $data;
}
}
}