summaryrefslogtreecommitdiffstats
path: root/user_guide/helpers
diff options
context:
space:
mode:
authorPhil Sturgeon <email@philsturgeon.co.uk>2011-08-14 20:23:55 +0200
committerPhil Sturgeon <email@philsturgeon.co.uk>2011-08-14 20:23:55 +0200
commitdbac73b4011a85c4ac3b3a7a6a8e30533b881155 (patch)
treefc7a72c29a933d77ea1358427cac3797e2ba029c /user_guide/helpers
parentd8ef630f2d4d32eee998969e548d36dc629340d4 (diff)
Added increment_string() docs and changelog.
Diffstat (limited to 'user_guide/helpers')
-rw-r--r--user_guide/helpers/string_helper.html11
1 files changed, 11 insertions, 0 deletions
diff --git a/user_guide/helpers/string_helper.html b/user_guide/helpers/string_helper.html
index 169ee4ebb..7c1d30c59 100644
--- a/user_guide/helpers/string_helper.html
+++ b/user_guide/helpers/string_helper.html
@@ -90,6 +90,17 @@ String Helper
<code>echo random_string('alnum', 16);</code>
+<h2>increment_string()</h2>
+
+<p>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.</p>
+
+<p>Usage example:</p>
+
+<code>echo increment_string('file', '_'); // "file_1"<br/>
+echo increment_string('file', '-', 2); // "file-2"<br/>
+echo increment_string('file-4'); // "file-5"<br/></code>
+
+
<h2>alternator()</h2>
<p>Allows two or more items to be alternated between, when cycling through a loop. Example:</p>