forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
html.html
726 lines (687 loc) · 21.6 KB
/
html.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
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
<!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 = "Html::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Html - クラス - 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>Html クラス</h2>
<p>Html クラスは、HTML タグのほぼすべてに対応する HTML ラッパーです。</p>
<h3>Doctypes</h3>
<p>doctype はすべて <kbd>fuel/core/config/doctypes.php</kbd> に記述されており、同設定ファイルはあらかじめインクルードされています。</p>
<article>
<h4 class="method" id="method_anchor">anchor($href, $text, $attributes = array(), $secure = null)</h4>
<p><strong>anchor</strong> メソッドは、HTML の anchor タグを返します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$href</kbd></th>
<td><i>必須</i></td>
<td>ターゲット url</td>
</tr>
<tr>
<th><kbd>$text</kbd></th>
<td><i>必須</i></td>
<td>アンカー値</td>
</tr>
<tr>
<th><kbd>$attributes</kbd></th>
<td><strong>false</strong></td>
<td>anchor タグに適用される属性の配列。</td>
</tr>
<tr>
<th><kbd>$secure</kbd></th>
<td><i>null</i></td>
<td>生成される URL が、false だと http 、true なら https になります</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>正しくフォーマットされた anchor タグの文字列 (属性配列が指定されているならその属性も) 。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>//返り値 <a href="http://www.domain.com/example">Example</a>
echo Html::anchor('example', 'Example');
//返り値 <a href="http://www.otherdomain.com/example">Example</a>
echo Html::anchor('http://www.otherdomain.com/example', 'Example');
//返り値 <a href="http://www.domain.com/example" id="a1" class="sample" style="color:red;">Example</a>
echo Html::anchor('example', 'Example', array('id' => 'a1', 'class' => 'sample', 'style' => 'color:red'));
//返り値 <a href="https://www.domain.com/example" id="a1" class="sample" style="color:red;">Example</a>
echo Html::anchor('example', 'Example', array('id' => 'a1', 'class' => 'sample', 'style' => 'color:red'), true);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_mail_to">mail_to($email, $text, $subject = null, $attr = array())</h4>
<p><strong>mail_to</strong> メソッドは、そのターゲットとして mailto をもつ HTML の anchor タグを返します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$email</kbd></th>
<td><i>必須</i></td>
<td>メールアドレス</td>
</tr>
<tr>
<th><kbd>$text</kbd></th>
<td><i>必須</i></td>
<td>アンカー値</td>
</tr>
<tr>
<th><kbd>$subject</kbd></th>
<td><strong>null</strong></td>
<td>アンカー値</td>
</tr>
<tr>
<th><kbd>$attr</kbd></th>
<td><strong>empty</strong></td>
<td>anchor タグに適用される属性の配列。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>正しくフォーマットされた anchor タグの文字列 (属性配列が指定されているならその属性も) 。</td>
</tr>
<tr>
<th>例</th>
<td>
echo Html::mail_to('[email protected]', 'Name');
//返り値 <a href="mailto:[email protected]?subject=Something">Name</a>
echo Html::mail_to('[email protected]', 'Name', 'Something');
//返り値 <a href="mailto:[email protected]" id="a2" class="sample" style="color:red;">Name</a>
echo Html:::mail_to('[email protected]', 'Name', null, array('id' => 'a2', 'class' => 'sample', 'style' => 'color:red'));</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_mail_to_safe">mail_to_safe($email, $text, $subject = null, $attr = array())</h4>
<p><strong>mail_to_safe</strong> メソッドは、そのターゲットとして mailto をもつ HTML の anchor タグを生成する JavaScript のコードを返します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$email</kbd></th>
<td><i>必須</i></td>
<td>メールアドレス</td>
</tr>
<tr>
<th><kbd>$text</kbd></th>
<td><i>必須</i></td>
<td>アンカー値</td>
</tr>
<tr>
<th><kbd>$subject</kbd></th>
<td><strong>null</strong></td>
<td>アンカー値</td>
</tr>
<tr>
<th><kbd>$attr</kbd></th>
<td><strong>empty</strong></td>
<td>anchor タグに適用される属性の配列。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>正しくフォーマットされた anchor タグの文字列 (属性配列が指定されているならその属性も) 。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>//返り値
//<script type="text/javascript">
// var user = "name";
// var at = "@";
// var server = "domain.com";
// document.write('<a href="' + 'mail' + 'to:' + user + at + server + '">Name</a>');
//</script>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_img">img($src, $attr = array())</h4>
<p><strong>img</strong> メソッドは image タグを返します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$src</kbd></th>
<td><i>必須</i></td>
<td>画像のパス。</td>
</tr>
<tr>
<th><kbd>$attr</kbd></th>
<td><strong>array()</strong></td>
<td>属性の配列。もし alt 属性が指定されていない時は、ファイル名が同属性 (の値) のデフォルトになります。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>正しくフォーマットされた image タグ文字列。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>//返り値 <img src="http://example.com/path/to/image.png" alt="image.png" />
echo Html::img('path/to/image.png');
//返り値 <img src="http://example.com/path/to/image.png" alt="Alt Message" class="myclass" />
echo Html::img('path/to/image.png', array("alt" => "Alt Message", 'class' => "myclass"));
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_meta">meta($name, $content = '', $type = 'name')</h4>
<p><strong>meta</strong> メソッドは meta タグを返します。多次元配列が指定された時は複数の meta タグが返されます。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$name</kbd></th>
<td><i>必須</i></td>
<td>一次元配列、あるいは多次元配列の meta パラメータを含む配列が指定可能。あるいは、name/http-equiv の値を記述することも可能です。</td>
</tr>
<tr>
<th><kbd>$content</kbd></th>
<td><i>必須</i></td>
<td>$name パラメータに配列が指定されていない場合、 $content は meta 要素内の content 属性値と等しくなります。</td>
</tr>
<tr>
<th><kbd>$type</kbd></th>
<td><strong>'name'</strong></td>
<td>値が設定されていない場合は name がデフォルトとなります。 name あるいは http-equiv を設定することが可能です。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>正しくフォーマットされた meta タグ文字列。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>//返り値 <meta name="description" content="Meta Example!" />
echo Html::meta('description', 'Meta Example!');
//返り値 <meta name="robots" content="no-cache" />
echo Html::meta('robots', 'no-cache');
$meta = array(
array('name' => 'robots', 'content' => 'no-cache'),
array('name' => 'description', 'content' => 'Meta Example'),
array('name' => 'keywords', 'content' => 'fuel, rocks'),
);
//返り値 <meta name="robots" content="no-cache" />
//返り値 <meta name="description" content="Meta Example!" />
//返り値 <meta name="keywords" content="fuel, rocks" />
echo Html::meta($meta);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_doctype">doctype($type = 'xhtml1-trans')</h4>
<p><strong>doctype</strong> メソッドは、正しくフォーマットされた doctype タグを返します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$type</kbd></th>
<td>'xhtml1-trans'</td>
<td>出力されるべき HTML の doctype タグのタイプ。<br />指定可能な値: <kbd>xhtml11</kbd>, <kbd>xhtml1-strict</kbd>, <kbd>xhtml1-trans</kbd>, <kbd>xhtml1-frame</kbd>, <kbd>html5</kbd>, <kbd>html4-strict</kbd>, <kbd>html4-trans</kbd>, <kbd>html4-frame</kbd></td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>正しくフォーマットされた doctype タグ文字列。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>//返り値 XHTML1 Transitional doctype タグ。
echo Html::doctype();
//返り値 <!DOCTYPE html>
echo Html::doctype('html5');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_audio">audio($src, $attr = false)</h4>
<p><strong>audio</strong> メソッドの利用にあたっては、html5 を doctype として指定することが必要となります。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$src</kbd></th>
<td><i>必須</i></td>
<td>ソースファイルのロケーション、あるいは複数のロケーションを含む配列。</td>
</tr>
<tr>
<th><kbd>$attr</kbd></th>
<td><strong>false</strong></td>
<td>audio タグに適用されるべき属性の配列。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>ソース (src) が指定されている正しくフォーマットされた audio タグの文字列。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>//返り値 <audio><source src="../sounds/beep.mp3" /></audio>
echo Html::audio('../sounds/beep.mp3');
//返り値 <audio><source src="../sounds/beep.mp3" /><source src="../sounds/frog.mp4" /></audio>
echo Html::audio(array('../sounds/beep.mp3','../sounds/frog.mp4'));</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_ul">ul($list, $style = false)</h4>
<p><strong>ul</strong> メソッドは正しくフォーマットされた単純な、あるいは入れ子になった順不同リストを返します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$list</kbd></th>
<td><i>必須</i></td>
<td>リストアイテムとして出力されるべき、単純な、あるいは入れ子になった順不同リストアイテムを含む配列。</td>
</tr>
<tr>
<th><kbd>$style</kbd></th>
<td><strong>false</strong></td>
<td>ul タグに適用される属性の配列。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>正しくフォーマットされた list タグの文字列。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>/* 返り値
<ul id="todo" class="pending">
<li>red</li>
<li>blue</li>
<li>green</li>
<li>yellow</li>
</ul>
*/
$items = array('red', 'blue', 'green', 'yellow');
$attr = array('id' => 'todo','class' => 'pending');
echo Html::ul($items, $attr);
/* 返り値
<ul class="order">
<li>colors
<ul>
<li>blue</li>
<li>red</li>
<li>green</li>
</ul>
</li>
<li>sky</li>
<li>tools
<ul>
<li>screwdriver</li>
<li>hammer</li>
</ul>
</li>
</ul>
*/
$items = array(
'colors' => array('blue', 'red', 'green'),
'sky',
'tools' => array('screwdriver','hammer')
);
$attr = array('class' => 'order');
echo Html::ul($items, $attr);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_ol">ol($list, $style = false)</h4>
<p><strong>ol</strong> メソッドは正しくフォーマットされた単純な、あるいは入れ子になった順序リストを返します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$list</kbd></th>
<td><i>必須</i></td>
<td>リストアイテムとして出力されるべき、単純な、あるいは入れ子になった順序リストアイテムを含む配列。</td>
</tr>
<tr>
<th><kbd>$style</kbd></th>
<td><strong>false</strong></td>
<td> (オプション) ol タグに適用される属性の配列。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>正しくフォーマットされた list タグの文字列。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>/* 返り値
<ol id="todo" class="pending">
<li>red</li>
<li>blue</li>
<li>green</li>
<li>yellow</li>
</ol>
*/
$items = array('red', 'blue', 'green', 'yellow');
$attr = array('id' => 'todo','class' => 'pending');
echo Html::ol($items, $attr);
/* 返り値
<ol class="order">
<li>colors
<ol>
<li>blue</li>
<li>red</li>
<li>green</li>
</ol>
</li>
<li>sky</li>
<li>tools
<ol>
<li>screwdriver</li>
<li>hammer</li>
</ol>
</li>
</ol>
*/
$items = array(
'colors' => array('blue', 'red', 'green'),
'sky',
'tools' => array('screw driver','hammer'));
$attr = array('class' => 'order');
echo Html::ol($items, $attr);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<h3 id="procedural_helpers">処理ヘルパー</h3>
<article>
<h4 id="function_html_tag">html_tag($tag, $attr = array(), $content = false)</h4>
<p><strong>html_tag</strong> 関数は、指定された属性に基づいて HTML タグを生成します。</p>
<table class="method">
<tbody>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>型</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$tag</kbd></th>
<td><em>string</em></td>
<td><em>必須</em></td>
<td>得たい要素名 (検索する値)</td>
</tr>
<tr>
<th><kbd>$attr</kbd></th>
<td><em>array</em></td>
<td><pre class="php"><code>array()</code></pre></td>
<td>属性の配列</td>
</tr>
<tr>
<th><kbd>$content</kbd></th>
<td><em>string</em></td>
<td><pre class="php"><code>false</code></pre></td>
<td>タグで囲まれるコンテント</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo html_tag('a', array(
'href' => 'http://somedomain.com/',
'class' => 'my_class'
), 'Link title');
// <a href="http://somedomain.com/" class="my_class">Link title</a></code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="function_array_to_attr">array_to_attr($attr)</h4>
<p><strong>array_to_attr</strong> 関数は属性文字列を生成します。</p>
<table class="method">
<tbody>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>型</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$attr</kbd></th>
<td><em>array</em></td>
<td><em>必須</em></td>
<td>属性の配列</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo array_to_attr(array(
'href' => 'http://somedomain.com/',
'class' => 'my_class'
));
// href="http://somedomain.com/" class="my_class"</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/html.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/html.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/html.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>