summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown90
1 files changed, 87 insertions, 3 deletions
diff --git a/README.markdown b/README.markdown
index 0efaf16..1e51e1d 100644
--- a/README.markdown
+++ b/README.markdown
@@ -83,6 +83,15 @@ converted to arrays of alternating keys and values.
- *Type*: rvalue
+base64
+--------
+Converts a string to and from base64 encoding.
+Requires an action ['encode','decode'] and either a plain or base64 encoded
+string
+
+
+- *Type*: rvalue
+
bool2num
--------
Converts a boolean to a number. Converts the values:
@@ -195,6 +204,55 @@ Would return: ['a','c']
- *Type*: rvalue
+delete_values
+-------------
+Deletes all instances of a given value from a hash.
+
+*Examples:*
+
+ delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')
+
+Would return: {'a'=>'A','c'=>'C','B'=>'D'}
+
+
+delete_undef_values
+-------------------
+Deletes all instances of the undef value from an array or hash.
+
+*Examples:*
+
+ $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})
+
+Would return: {a => 'A', b => '', d => false}
+
+ $array = delete_undef_values(['A','',undef,false])
+
+Would return: ['A','',false]
+
+- *Type*: rvalue
+
+difference
+----------
+This function returns the difference between two arrays.
+The returned array is a copy of the original array, removing any items that
+also appear in the second array.
+
+*Examples:*
+
+ difference(["a","b","c"],["b","c","d"])
+
+Would return: ["a"]
+
+dirname
+-------
+Returns the `dirname` of a path.
+
+*Examples:*
+
+ dirname('/path/to/a/file.ext')
+
+Would return: '/path/to/a'
+
downcase
--------
Converts the case of a string or all strings in an array to lower case.
@@ -227,12 +285,17 @@ resource.
This example only creates the resource if it does not already exist:
- ensure_resource('user, 'dan', {'ensure' => 'present' })
+ ensure_resource('user', 'dan', {'ensure' => 'present' })
If the resource already exists but does not match the specified parameters,
this function will attempt to recreate the resource leading to a duplicate
resource definition error.
+An array of resources can also be passed in and each will be created with
+the type and parameters specified if it doesn't already exist.
+
+ ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})
+
- *Type*: statement
@@ -390,7 +453,7 @@ Example:
hash
----
-This function converts and array into a hash.
+This function converts an array into a hash.
*Examples:*
@@ -401,6 +464,16 @@ Would return: {'a'=>1,'b'=>2,'c'=>3}
- *Type*: rvalue
+intersection
+-----------
+This function returns an array an intersection of two.
+
+*Examples:*
+
+ intersection(["a","b","c"],["b","c","d"])
+
+Would return: ["b","c"]
+
is_array
--------
Returns true if the variable passed to this function is an array.
@@ -853,6 +926,17 @@ Returns the type when passed a variable. Type can be one of:
- *Type*: rvalue
+union
+-----
+This function returns a union of two arrays.
+
+*Examples:*
+
+ union(["a","b","c"],["b","c","d"])
+
+Would return: ["a","b","c","d"]
+
+
unique
------
This function will remove duplicates from strings and arrays.
@@ -886,7 +970,7 @@ Converts a string or an array of strings to uppercase.
Will return:
- ASDF
+ ABCD
- *Type*: rvalue