forked from fuel/docs
-
Notifications
You must be signed in to change notification settings - Fork 118
/
Copy pathstr.html
782 lines (747 loc) · 21.1 KB
/
str.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
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
<!doctype html>
<html lang="en">
<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 = "Str::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Str - Classes - FuelPHP Documentation</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="search" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">table of contents</a>
<div class="clear"></div>
</header>
<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>
<div id="main">
<h2>Str Class</h2>
<p>The str class is a set of methods to help with the manipulation of strings.</p>
<article>
<h4 class="method" id="method_increment">increment($str, $first = 1)</h4>
<p>The <strong>increment</strong> method allows you to append a number to the end of a string or increment that number if it already exists.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<td><em>required</em></td>
<td>The string to increment.</td>
</tr>
<tr>
<th><kbd>$first</kbd></th>
<td><pre class="php"><code>1</code></pre></td>
<td>The first number to increment with.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$string = "filename";
Str::increment($string); // returns filename_1
$string = "filename_1";
Str::increment($string); // returns filename_2
$string = "filename";
Str::increment($string, 3); // returns filename_3
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_random">random($type = 'alnum', $length = 8)</h4>
<p>The <strong>random</strong> method generates a random string based on the type given.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$type</kbd></th>
<td><em>alnum</em></td>
<td>The type of string to generate. Your choices are alnum, numeric, nozero, alpha, distinct, hexdec, unique, sha1 and uuid.</td>
</tr>
<tr>
<th><kbd>$length</kbd></th>
<td><pre class="php"><code>16</code></pre></td>
<td>The number of characters you would like the final string to be (unique, sha1 and uuid ignore this parameter).</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// alnum (uppercase and lowercase letters mixed with numbers)
Str::random('alnum', 16);
// Returns: SvZi9Dh3lq7zQYim
// numeric (just numbers)
Str::random('numeric', 16);
// Returns: 1045343964672481
// nozero (just numbers excluding zero)
Str::random('nozero', 16);
// Returns: 3244623373994515
// alpha (just uppercase and lowercase letters)
Str::random('alpha', 16);
// Returns: LuVAXbmxQbbWoYqz
// distinct (uppercase letters and numbers that cannot be confused)
Str::random('distinct', 16);
// Returns: R79MPKMH4KTRN35J
// hexdec (hexadecimal characters a-f, 0-9)
Str::random('hexdec', 16);
// Returns: 09c34e42f36547f8
// unique (32 character string based on md5)
Str::random('unique');
// Returns: ed4bb844a35b7a4edb7eed0d3795d328
// sha1 (40 character string based on sha1)
Str::random('sha1');
// Returns: af5c5a8cc3be9a3180205c1ed2975015cd6cf1e7
// uuid (version 4 - random)
Str::random('uuid');
// Returns: f47ac10b-58cc-4372-a567-0e02b2c3d479</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_truncate">truncate($string, $limit, $continuation = '...', $is_html = false)</h4>
<p>The <strong>truncate</strong> method allows you to limit characters and provide a continuation string without breaking html.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<td><em>required</em></td>
<td>The string to truncate.</td>
</tr>
<tr>
<th><kbd>$limit</kbd></th>
<td><em>required</em></td>
<td>The number of characters to allow in the string.</td>
</tr>
<tr>
<th><kbd>$continuation</kbd></th>
<td><pre class="php"><code>'...'</code></pre></td>
<td>The string to append to the end of the truncated string.</td>
</tr>
<tr>
<th><kbd>$is_html</kbd></th>
<td><pre class="php"><code>false</code></pre></td>
<td>If the string contains html. Setting this as true will make the method not break html.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$string = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.";
Str::truncate($string, 15); // returns Lorem ipsum dol...
$string = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.";
Str::truncate($string, 15, '...Read More'); // returns Lorem ipsum dol...Read More
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_alternator">alternator(*$args)</h4>
<p>Returns a closure that will alternate the values you've passed to this method as arguments, unless you
call the closure with <kbd>false</kbd> as argument - in which case it will just return the value
without moving to the next and return the same value on the next call.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>*$args</kbd></th>
<td><em>required</em></td>
<td>As many arguments as you need to alternate</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>Closure</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$alt = Str::alternator('one', 'two', 'three', 'four');
echo $alt(); // outputs 'one'
echo $alt(); // outputs 'two'
echo $alt(false); // outputs 'three', but doens't move to the next as you can see in the next call
echo $alt(); // outputs 'three'
echo $alt(); // outputs 'four'
echo $alt(); // outputs 'one'
// etc...</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_upper">upper($str, $encoding = null)</h4>
<p>The <strong>upper</strong> method converts all characters to uppercase. It is equivalent to PHP's strtoupper() for your specific character encoding.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<td><em>string</em></td>
<td><em>Required</em></td>
<td>The input string.</td>
</tr>
<tr>
<th><kbd>$encoding</kbd></th>
<td><em>string</em></td>
<td><pre class="php"><code>null</code></pre></td>
<td>The character encoding.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Str::upper('User Data'); // returns 'USER DATA'</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_lower">lower($str, $encoding = null)</h4>
<p>The <strong>lower</strong> method converts all characters to lowercase. It is equivalent to PHP's strtolower() for your specific character encoding.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<td><em>string</em></td>
<td><em>Required</em></td>
<td>The input string.</td>
</tr>
<tr>
<th><kbd>$encoding</kbd></th>
<td><em>string</em></td>
<td><pre class="php"><code>null</code></pre></td>
<td>The character encoding.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Str::lower('User Data'); // returns 'user data'</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_tr">tr($string, $array = array())</h4>
<p>The <strong>tr</strong> method parse the params from given string using PHP's strtr().</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<td><em>string</em></td>
<td><em>Required</em></td>
<td>The input string.</td>
</tr>
<tr>
<th><kbd>$array</kbd></th>
<td><em>array</em></td>
<td><pre class="php"><code>array()</code></pre></td>
<td>params to str_replace.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Str::tr('Hello :name', array('name' => 'World')); // returns 'Hello World'</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_is_json">is_json($string)</h4>
<p>The <strong>is_json</strong> method check if a string is json encoded.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<td><em>string</em></td>
<td><em>Required</em></td>
<td>The input string.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>bool</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Str::is_json('{"0":"An","encoded":["string"]}'); // returns true</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_is_serialized">is_serialized($string)</h4>
<p>The <strong>is_serialized</strong> method check if a string is serialized.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<td><em>string</em></td>
<td><em>Required</em></td>
<td>The input string.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>bool</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Str::is_serialized('a:2:{i:0;s:2:"An";s:7:"encoded";a:1:{i:0;s:6:"string";}}');
// returns true</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_is_html">is_html($string)</h4>
<p>The <strong>is_html</strong> method check if a string is html.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<td><em>string</em></td>
<td><em>Required</em></td>
<td>The input string.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>bool</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Str::is_html('Lorem ipsum <b>dolor sit amet</b>, consectetur <u>adipiscing</u> elit.');
// returns true</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_is_xml">is_xml($string)</h4>
<p>The <strong>is_xml</strong> method check if a string is a valid xml. Requires the <a href="http://www.php.net/manual/en/ref.libxml.php" target="_blank">libxml extension</a>.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$string</kbd></th>
<td><em>string</em></td>
<td><em>Required</em></td>
<td>The input string.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>bool</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Str::is_xml('<?xml version="1.0" encoding="utf-8"?><xml><foo>bar</foo></xml>');
// returns true</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_starts_with">starts_with($str, $start, $ignore_case = false)</h4>
<p>The <strong>starts_with</strong> method checks whether a string has a precific beginning.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$str</kbd></th>
<td><em>required</em></td>
<td>The string to check.</td>
</tr>
<tr>
<th><kbd>$start</kbd></th>
<td><em>required</em></td>
<td>The beginning to check for.</td>
</tr>
<tr>
<th><kbd>$ignore_case</kbd></th>
<td><pre class="php"><code>false</code></pre></td>
<td>Whether to ignore the case.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>bool</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$string = "Lorem ipsum dolor sit amet";
Str::starts_with($string, 'Lorem'); // returns true
Str::starts_with($string, 'lorem'); // returns false
Str::starts_with($string, 'lorem', true); // returns true
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_ends_with">ends_with($str, $end, $ignore_case = false)</h4>
<p>The <strong>ends_with</strong> method checks whether or not a string has a precific ending.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$str</kbd></th>
<td><em>required</em></td>
<td>The string to check.</td>
</tr>
<tr>
<th><kbd>$end</kbd></th>
<td><em>required</em></td>
<td>The ending to check for.</td>
</tr>
<tr>
<th><kbd>$ignore_case</kbd></th>
<td><pre class="php"><code>false</code></pre></td>
<td>Whether to ignore the case.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>bool</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$string = "Lorem ipsum dolor sit amet";
Str::ends_with($string, 'amet'); // returns true
Str::ends_with($string, 'Amet'); // returns false
Str::ends_with($string, 'Amet', true); // returns true
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_sub">sub($str, $start, $length = null, $encoding = null)</h4>
<p>The <strong>sub</strong> method returns the portion of the string specified. It is equivalent to PHP's substr() for your specific character encoding.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$str</kbd></th>
<td><em>required</em></td>
<td>The input string.</td>
</tr>
<tr>
<th><kbd>$start</kbd></th>
<td><em>required</em></td>
<td>Position of first character. See <a href="http://php.net/substr" target="_blank">php.net</a> for detailed usage.</td>
</tr>
<tr>
<th><kbd>$length</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>Maximum number of characters. See <a href="http://php.net/substr" target="_blank">php.net</a> for detailed usage.</td>
</tr>
<tr>
<th><kbd>$encoding</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>The character encoding.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Str::sub('User Data', 3, -1); // returns 'r Dat'</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.
</p>
</footer>
</div>
</body>
</html>