forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
num.html
617 lines (590 loc) · 17.4 KB
/
num.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
<!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 = "Num::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Num - クラス - 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 id="num_class">Num クラス</h2>
<p>Num クラスは、数値を扱うために付加的なフォーマットを行うメソッドを提供します</p>
<h3 id="config">設定</h3>
<p>
Num クラスは、数値を特定のフォーマットへ変換する様々なメソッドを提供します。
フォーマットは文字列で表します (ゼロは返り値の数値の部分となります) 。
</p>
<p class="note">
<strong>注意:</strong> num コンフィグを変更する場合、app/config/num.php をコピーして設定を変更します。
そうすれば、あなたのカスタム設定を失うことなく簡単にアップグレードができるようになります。
</p>
<table class="config">
<tbody>
<tr class="header">
<th>キー</th>
<th>型</th>
<th>デフォルト</th>
<th>説明</th>
</tr>
<tr>
<th>phone</th>
<td>string</td>
<td><pre class="php"><code>'(000) 000-0000'</code></pre></td>
<td>
電話番号のフォーマット。
</td>
</tr>
<tr>
<th>smart_phone</th>
<td>array</td>
<td><pre class="php"><code>array(
7 => '000-0000',
10 => '(000) 000-0000',
11 => '0 (000) 000-0000',
),</code></pre></td>
<td>
電話番号の長さに基づいた電話番号の書式。array(長さ => フォーマット)
</td>
</tr>
<tr>
<th>exp</th>
<td>string</td>
<td><pre class="php"><code>'00-00'</code></pre></td>
<td>
クレジットカードの有効期限のフォーマット。
</td>
</tr>
<tr>
<th>credit_card</th>
<td>string</td>
<td><pre class="php"><code>'00-00'</code></pre></td>
<td>
クレジットカードの番号を覆い隠すためのフォーマット。
</td>
</tr>
</tbody>
</table>
<article>
<h4 class="method" id="method_bytes">bytes($size = 0)</h4>
<p>
<strong>bytes</strong> メソッドは、(ファイルサイズの) 数値をバイト値へ変換します。
ファイルサイズは、 'S' 大きさ (1, 8.5, 300 など) と 'B' バイト単位 (K, MiB, GB など) をあわせて 'SB' というフォーマットで定義します。
全ての有効なバイト単位は、 <em>core/lang/en/byte_units.php</em> で定義されています。
</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>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$size</kbd></th>
<th><em>string|int|float</em></th>
<td><pre class="php"><code>0</code></pre></td>
<td>変換する文字列。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>float</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo Num::bytes('200K'); // 204800
echo Num::bytes('5MiB'); // 5242880
echo Num::bytes('1000'); // 1000
echo Num::bytes('2.5GB'); // 2684354560</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_format_bytes">format_bytes($bytes = 0, $decimals = 0)</h4>
<p>
<strong>format_bytes</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>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$bytes</kbd></th>
<th><em>int</em></th>
<td><pre class="php"><code>0</code></pre></td>
<td>フォーマットする数値。</td>
</tr>
<tr>
<th><kbd>$decimals</kbd></th>
<th><em>int</em></th>
<td><pre class="php"><code>0</code></pre></td>
<td>切り上げする小数点以下の桁数。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string|false</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo Num::format_bytes('204800'); // 200 kB
echo Num::format_bytes('214901', 1); // 209.9 kB
echo Num::format_bytes('2249010', 1); // 2.1 MB
echo Num::format_bytes('badbytes'); // false
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_quantity">quantity($num, $decimals = 0)</h4>
<p>
<strong>quantity</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>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$num</kbd></th>
<th><em>int</em></th>
<td><em>必須</em></td>
<td>フォーマットする数値。</td>
</tr>
<tr>
<th><kbd>$decimals</kbd></th>
<th><em>int</em></th>
<td><pre class="php"><code>0</code></pre></td>
<td>切り上げする小数点以下の桁数。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string|false</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo Num::quantity(7000); // 7K
echo Num::quantity(7500); // 8K
echo Num::quantity(7500, 1); // 7.5K
echo Num::quantity('badnumber'); // false
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_format">format($string = '', $format = '')</h4>
<p>
<strong>format</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>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>''</code></pre></td>
<td>フォーマットする数値。</td>
</tr>
<tr>
<th><kbd>$format</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>''</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 Num::format('1234567890', '(000) 000-0000'); // (123) 456-7890
echo Num::format('1234567890', '000.000.0000'); // 123.456.7890
echo Num::format('1234567890', '000.000.0000'); // 123.456.7890
echo Num::format('1', '000.000.000'); // 1..
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_mask_string">mask_string($string = '', $format = '', $ignore = ' ')</h4>
<p>
<strong>mask_string</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>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>''</code></pre></td>
<td>フォーマットする数値。</td>
</tr>
<tr>
<th><kbd>$format</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>''</code></pre></td>
<td>フォーマット。</td>
</tr>
<tr>
<th><kbd>$ignore</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>''</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 Num::mask_string('1234567812345678', '************0000');
// ************5678
echo Num::mask_string('1234567812345678', '**** **** **** 0000');
// **** **** **** 5678
echo Num::mask_string('1234567812345678', '**** - **** - **** - 0000', ' -');
// **** - **** - **** - 5678
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_format_phone">format_phone($string = '', $format = null)</h4>
<p>
<strong>format_phone</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>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>''</code></pre></td>
<td>フォーマットする数値。</td>
</tr>
<tr>
<th><kbd>$format</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>null</code></pre></td>
<td>フォーマット。<em>null</em> の場合、<strong>format_phone</strong> コンフィグの設定がデフォルトになります。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo Num::format_phone('0612345678');
// (061) 234 5678
echo Num::format_phone('0612345678', '(00) 000 000 00');
// (06) 123 456 78
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_smart_format_phone">smart_format_phone($string)</h4>
<p>
<strong>smart_format_phone</strong> メソッドは、
文字数に基いて数値を電話番号のフォーマットへ変換します。
</p>
<p class="note">
<strong>注意:</strong> 数値は長さに基いてフォーマットされます。
それらは、<a href="#config">num の設定</a> の中で定義されています。
</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>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<th><em>string</em></th>
<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 Num::smart_format_phone('1234567');
// 123-4567
echo Num::smart_format_phone('01234567890');
// 0 (123) 456-7890
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_format_exp">format_exp($string, $format = null)</h4>
<p>
<strong>format_exp</strong> メソッドは、数値をクレジットカードの有効期限の文字列へ変換します。
</p>
<p class="note">
<strong>注意:</strong> このメソッドは、4 桁の数字が入力されることが期待されています。
</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>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<th><em>string</em></th>
<td><em>必須</em></td>
<td>フォーマットする数値。</td>
</tr>
<tr>
<th><kbd>$format</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>null</code></pre></td>
<td>フォーマット。<em>null</em> の場合、<strong>exp</strong> コンフィグの設定がデフォルトになります。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo Num::format_exp('1234');
// 12-34
echo Num::format_exp('1234', '00/00');
// 12/34
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_mask_credit_card">mask_credit_card($string, $format = null)</h4>
<p>
<strong>mask_credit_card</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>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>''</code></pre></td>
<td>フォーマットする数値。</td>
</tr>
<tr>
<th><kbd>$format</kbd></th>
<th><em>string</em></th>
<td><pre class="php"><code>null</code></pre></td>
<td>フォーマット。<em>null</em> の場合、<strong>credit_card</strong> コンフィグの設定がデフォルトになります。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo Num::mask_credit_card('1234263583742938');
// **** **** **** 2938
echo Num::mask_credit_card('1234123412341234', '0000 **** **** ****');
// 1234 **** **** ****</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/num.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/num.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/num.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>