forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathformat.html
514 lines (485 loc) · 15.9 KB
/
format.html
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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
<!doctype html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./../assets/css/combined.css">
<link rel="shortcut icon" href="./../favicon.ico" />
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
var path = './../';
var class_prefix = "Form::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Format - クラス - FuelPHP ドキュメント</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<a href="http://fuelphp.com"><img height="37px" width="147px" src="./../assets/img/fuel.png" /></a>
<strong>Documentation</strong>
</h1>
<form id="google_search">
<p>
<span id="search_clear"> </span>
<input type="submit" name="search_submit" id="search_submit" value="検索" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">目次</a>
<div class="clear"></div>
</header>
<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>
<div id="main">
<h2>Format クラス</h2>
<p>Format クラスは、XML、JSON、CSV 等の様々なフォーマット間の変換ができます。</p>
<article>
<h3 id="configuration">設定</h3>
<p>Format クラスは、 <kbd>fuel/core/config/format.php</kbd> にある設定ファイルで設定をします。デフォルトで設定がされています。設定を変更するには、設定ファイルをアプリケーションの設定ディレクトリにコピーし、そのファイルを変更してください。</p>
<p>次の設定を定義することができます。</p>
<h4>CSV</h4>
<table class="config">
<tbody>
<tr class="header">
<th>パラメータ</th>
<th>タイプ</th>
<th>デフォルト</th>
<th>説明</th>
</tr>
<tr>
<th>delimiter</th>
<td>string</td>
<td><pre class="php"><code>','</code></pre></td>
<td>デリミタ</td>
</tr>
<tr>
<th>enclosure</th>
<td>string</td>
<td><pre class="php"><code>'"'</code></pre></td>
<td>囲み文字</td>
</tr>
<tr>
<th>newline</th>
<td>string</td>
<td><pre class="php"><code>'\n'</code></pre></td>
<td>to_csv() メソッドで利用される改行文字</td>
</tr>
<tr>
<th>escape</th>
<td>string</td>
<td><pre class="php"><code>'\\'</code></pre></td>
<td>エスケープ文字</td>
</tr>
</tbody>
</table>
<p>
デフォルトでは、これらの設定は CSV データのインポートにもエクスポートにも使われます。
インポートとエクスポートで別の設定が必要な場合、配列のキーを用い設定をその中に移します。
デフォルトの設定ファイルはすでにそのようになっています。
</p>
<table class="config">
<tbody>
<tr>
<th>regex_newline</th>
<td>string</td>
<td><pre class="php"><code>'\n'</code></pre></td>
<td>入力データを変換するために正規表現で使用される改行文字</td>
</tr>
<tr>
<th>enclose_numbers</th>
<td>bool</td>
<td><pre class="php"><code>true</code></pre></td>
<td>false の場合、数字は囲まれません。true の場合、数字も囲まれます</td>
</tr>
</tbody>
</table>
<h4>XML</h4>
<table class="config">
<tbody>
<tr class="header">
<th>パラメーター</th>
<th>タイプ</th>
<th>デフォルト</th>
<th>説明</th>
</tr>
<tr>
<th>basenode</th>
<td>string</td>
<td><pre class="php"><code>'xml'</code></pre></td>
<td>XML ベースノードの名前</td>
</tr>
<tr>
<th>use_cdata</th>
<td>boolean</td>
<td><pre class="php"><code>false</code></pre></td>
<td>ノードの中で CDATA セクションを使用するかどうか</td>
</tr>
<tr>
<th>bool_representation</th>
<td>mixed</td>
<td><pre class="php"><code>null</code></pre></td>
<td>How booleans must be represented (0/1 vs false/true)</td>
</tr>
</tbody>
</table>
<h4>JSON</h4>
<table class="config">
<tbody>
<tr class="header">
<th>パラメータ</th>
<th>型</th>
<th>デフォルト</th>
<th>説明</th>
</tr>
<tr>
<th>options</th>
<td>integer</td>
<td><pre class="php"><code>JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP</code></pre></td>
<td>json_encode() の options</td>
</tr>
</tbody>
</table>
</article>
<p class="note">
いつくかの組み合わせは予測不可能であることに留意してください。例えば、囲み文字なし、ヘッダなし、最初の行に改行コードが含まれない CSV データは、ファイルの正確なフィールド数を計算できません。
</p>
<article>
<h4 class="method" id="method_forge">forge($data = null, $from_type = null, $params = null)</h4>
<p><strong>forge</strong> メソッドは、新しい format オブジェクトを返します。<strong>$from_type</strong> は、<strong>'xml'</strong> 、<strong>'yaml'</strong> 、<strong>'csv'</strong> 、<strong>'json'</strong> 、<strong>'serialize'</strong> と <strong>'xml:ns'</strong> をサポートします。'xml:ns' は、全ての XML 名前空間をパースすることができます。 $from_type が指定されない場合、 <strong>$data</strong> がその値として与えられます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$data</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>変換されるデータ。</td>
</tr>
<tr>
<th><kbd>$from_type</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>元データのフォーマット。</td>
</tr>
<tr>
<th><kbd>$param</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>コンバータに渡されるオプションのパラメータ。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Fuel\Core\Format オブジェクト</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$array = array('foo' => 'bar');
print_r(Format::forge($array));
// 実行結果
Fuel\Core\Format Object
(
[_data:protected] => Array
(
[foo] => bar
)
)</code>
</pre>
</td>
</tr>
</tbody>
</table>
<p class="note">
CSV フォーマットから変換する場合、<kbd>$param</kbd> に <kbd>false</kbd> を渡すと、CSV ソースがヘッダを含まないことを示せます。その場合、結果はインデックス配列になります。
</p>
</article>
<article>
<h4 class="method" id="method_to_array">to_array($data = null)</h4>
<p><strong>to_array</strong> メソッドは、与えられたデータを配列として返します。直接呼び出すのではなく、例にもあるように <strong>forge</strong> メソッドを利用します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$data</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>変換されるデータ。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>array</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$json_string = '{"foo":"bar","baz":"qux"}';
print_r(Format::forge($json_string, 'json')->to_array());
// 実行結果
Array
(
[foo] => bar
[baz] => qux
)</code>
</pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_to_xml">to_xml($data = null, $structure = null, $basenode = 'xml', $use_cdata = false)</h4>
<p><strong>to_xml</strong> メソッドは、与えられたデータを XML 文字列として返します。直接呼び出すのではなく、例にもあるように <strong>forge</strong> メソッドを利用します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$data</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>変換されるデータ。</td>
</tr>
<tr>
<th><kbd>$structure</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>クラス SimpleXMLElement のオブジェクト。</td>
</tr>
<tr>
<th><kbd>$basenode</kbd></th>
<td>"xml"</td>
<td>XML マークアップのベースノード。</td>
</tr>
<tr>
<th><kbd>$use_cdata</kbd></th>
<td>false</td>
<td>ノードの中で CDATA セクションを使用するかどうか。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$array = array('foo' => 'bar', 'baz' => 'qux');
print_r(Format::forge($array)->to_xml());
// 実行結果
// <?xml version="1.0" encoding="utf-8"?>
// <xml>
// <foo>bar</foo>
// <baz>qux</baz>
// </xml></code>
</pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_to_csv">to_csv($data = null, $delimiter = null, $enclose_numbers = null, array $headings = array())</h4>
<p><strong>to_csv</strong> メソッドは、与えられたデータを CSV 文字列として返します。直接呼び出すのではなく、例にもあるように <strong>forge</strong> メソッドを利用します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$data</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>変換するデータ。与えられない場合、forge() の入力が用いられる。</td>
</tr>
<tr>
<th><kbd>$delimiter</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>CSV フィールド区切り文字。与えられない場合、設定されたデフォルトが用いられる。</td>
</tr>
<tr>
<th><kbd>$enclose_numbers</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>false の場合、数字は囲まれない。true の場合、数字も囲われる。与えられない場合、設定されたデフォルトが用いられる。</td>
</tr>
<tr>
<th><kbd>$headings</kbd></th>
<td><pre class="php"><code>array()</code></pre></td>
<td>CSV フィールド名の配列。与えられない場合、データの配列の最初の行が使われる。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$json_string = '{"foo":"bar","baz":"qux","nr":1}';
print_r(Format::forge($json_string, 'json')->to_csv(null, null, false));
// 実行結果
// "foo","baz","nr"
// "bar","qux",1
$json_string = '{"foo":"bar","baz":"qux","nr":1}';
print_r(Format::forge($json_string, 'json')->to_csv(null, null, false, array('this', 'that', 'num')));
// 実行結果
// "this","that","num"
// "bar","qux",1</code>
</pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_to_json">to_json()</h4>
<p><strong>to_json</strong> メソッドは、与えられたデータを JSON 文字列として返します。直接呼び出すのではなく、例にもあるように <strong>forge</strong> メソッドを利用します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$array = array('foo' => 'bar', 'baz' => 'qux');
print_r(Format::forge($array)->to_json());
// 実行結果
// {"foo":"bar","baz":"qux"}</code>
</pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_to_serialized">to_serialized()</h4>
<p><strong>to_serialized</strong> メソッドは、与えられたデータをシリアル化された文字列として返します。直接呼び出すのではなく、例にもあるように <strong>forge</strong> メソッドを利用します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$array = array('foo' => 'bar', 'baz' => 'qux');
print_r(Format::forge($array)->to_serialized());
// 実行結果
// a:2:{s:3:"foo";s:3:"bar";s:3:"baz";s:3:"qux";}</code>
</pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_to_php">to_php()</h4>
<p><strong>to_php</strong> メソッドは、与えられたデータを 文字列表現された PHP コードとして返します。この PHP コードを eval() で評価することや、他にも思いもつかないようなことに利用することができます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$array = array(1, 2, array('a', 'b', 'c'));
print_r(Format::forge($array)->to_php());
// 実行結果
Array
(
0 => 1,
1 => 2,
2 => array(
0 => 'a',
1 => 'b',
2 => 'c',
),
)</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2016 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
[ <a href="https://github.com/fuel/docs/commits/1.8/develop/classes/format.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/format.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/format.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>