-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstr.html
More file actions
277 lines (257 loc) · 7.48 KB
/
str.html
File metadata and controls
277 lines (257 loc) · 7.48 KB
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Str Class - Fuel Documentation</title>
<link href="../assets/css/main.css" media="screen" rel="stylesheet" />
<script type="text/javascript" src="../assets/js/jquery-1.4.4.min.js"></script>
<script type="text/javascript" src="../assets/js/nav.js"></script>
<script type="text/javascript" src="../assets/js/highlight.pack.js"></script>
<script type="text/javascript">
$(function() {
show_nav('classes', '../');
});
hljs.tabReplace = ' ';
hljs.initHighlightingOnLoad();
</script>
</head>
<body>
<header>
<h1>Fuel Documentation</h1>
</header>
<div id="main-nav"></div>
<section id="content">
<h2>Str Class</h2>
<p>The str class is a set of methods to help with the manipulation of strings.</p>
<article>
<h4 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 an 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><i>required</i></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 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><i>alnum</i></td>
<td>The type of string to generate. Your choices are alnum, numeric, nozero, alpha, distinct, hexdec, unique, and sha1.</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 and sha1 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</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 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><i>required</i></td>
<td>The string to truncate.</td>
</tr>
<tr>
<th><kbd>$limit</kbd></th>
<td><i>required</i></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 id="method_alternator">alternator(*$args)</h4>
<p>Returns a closure that will alternate the values you've passed to this method as arguements, unless you
call the closure with <kbd>false</kbd> as arguement - 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><i>required</i></td>
<td>As many arguements 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>
</section>
<section id="footer">
<p>
<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
© 2010 - 2011 Fuel Development Team
</p>
</section>
</body>
</html>