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
|
#############
String Helper
#############
The String Helper file contains functions that assist in working with
strings.
.. important:: Please note that these functions are NOT intended, nor
suitable to be used for any kind of security-related logic.
.. contents::
:local:
.. raw:: html
<div class="custom-index container"></div>
Loading this Helper
===================
This helper is loaded using the following code::
$this->load->helper('string');
Available Functions
===================
The following functions are available:
.. php:function:: random_string([$type = 'alnum'[, $len = 8]])
:param string $type: Randomization type
:param int $len: Output string length
:returns: A random string
:rtype: string
Generates a random string based on the type and length you specify.
Useful for creating passwords or generating random hashes.
The first parameter specifies the type of string, the second parameter
specifies the length. The following choices are available:
- **alpha**: A string with lower and uppercase letters only.
- **alnum**: Alpha-numeric string with lower and uppercase characters.
- **basic**: A random number based on ``mt_rand()``.
- **numeric**: Numeric string.
- **nozero**: Numeric string with no zeros.
- **md5**: An encrypted random number based on ``md5()`` (fixed length of 32).
- **sha1**: An encrypted random number based on ``sha1()`` (fixed length of 40).
Usage example::
echo random_string('alnum', 16);
.. note:: Usage of the *unique* and *encrypt* types is DEPRECATED. They
are just aliases for *md5* and *sha1* respectively.
.. php:function:: increment_string($str[, $separator = '_'[, $first = 1]])
:param string $str: Input string
:param string $separator: Separator to append a duplicate number with
:param int $first: Starting number
:returns: An incremented string
:rtype: string
Increments a string by appending a number to it or increasing the
number. Useful for creating "copies" or a file or duplicating database
content which has unique titles or slugs.
Usage example::
echo increment_string('file', '_'); // "file_1"
echo increment_string('file', '-', 2); // "file-2"
echo increment_string('file_4'); // "file_5"
.. php:function:: alternator($args)
:param mixed $args: A variable number of arguments
:returns: Alternated string(s)
:rtype: mixed
Allows two or more items to be alternated between, when cycling through
a loop. Example::
for ($i = 0; $i < 10; $i++)
{ Â Â Â Â
echo alternator('string one', 'string two');
}
You can add as many parameters as you want, and with each iteration of
your loop the next item will be returned.
::
for ($i = 0; $i < 10; $i++)
{ Â Â Â Â
echo alternator('one', 'two', 'three', 'four', 'five');
}
.. note:: To use multiple separate calls to this function simply call the
function with no arguments to re-initialize.
.. php:function:: reduce_double_slashes($str)
:param string $str: Input string
:returns: A string with normalized slashes
:rtype: string
Converts double slashes in a string to a single slash, except those
found in URL protocol prefixes (e.g. http://).
Example::
$string = "http://example.com//index.php";
echo reduce_double_slashes($string); // results in "http://example.com/index.php"
.. php:function:: strip_slashes($data)
:param mixed $data: Input string or an array of strings
:returns: String(s) with stripped slashes
:rtype: mixed
Removes any slashes from an array of strings.
Example::
$str = array(
'question'Â Â => 'Is your name O\'reilly?',
'answer' => 'No, my name is O\'connor.'
);
$str = strip_slashes($str);
The above will return the following array::
array(
'question'Â Â => "Is your name O'reilly?",
'answer' => "No, my name is O'connor."
);
.. note:: For historical reasons, this function will also accept
and handle string inputs. This however makes it just an
alias for ``stripslashes()``.
.. php:function:: reduce_multiples($str[, $character = ''[, $trim = FALSE]])
:param string $str: Text to search in
:param string $character: Character to reduce
:param bool $trim: Whether to also trim the specified character
:returns: Reduced string
:rtype: string
Reduces multiple instances of a particular character occuring directly
after each other. Example::
$string = "Fred, Bill,, Joe, Jimmy";
$string = reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy"
If the third parameter is set to TRUE it will remove occurrences of the
character at the beginning and the end of the string. Example::
$string = ",Fred, Bill,, Joe, Jimmy,";
$string = reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy"
.. php:function:: quotes_to_entities($str)
:param string $str: Input string
:returns: String with quotes converted to HTML entities
:rtype: string
Converts single and double quotes in a string to the corresponding HTML
entities. Example::
$string = "Joe's \"dinner\"";
$string = quotes_to_entities($string); //results in "Joe's "dinner""
.. php:function:: strip_quotes($str)
:param string $str: Input string
:returns: String with quotes stripped
:rtype: string
Removes single and double quotes from a string. Example::
$string = "Joe's \"dinner\"";
$string = strip_quotes($string); //results in "Joes dinner"
|
