diff options
| author | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
| commit | 3de130c2da3b93a3404f264e92d7b65354de3548 (patch) | |
| tree | 368b1847fffe7af21c5fbc3fa7925212b678e60b /user_guide_src/source/helpers/array_helper.rst | |
| parent | 1e584208e420d1d864de2bc686d437ecdf0ce064 (diff) | |
[ci skip] Add return types to helper docs (+ some other formatting)
Diffstat (limited to 'user_guide_src/source/helpers/array_helper.rst')
| -rw-r--r-- | user_guide_src/source/helpers/array_helper.rst | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/user_guide_src/source/helpers/array_helper.rst b/user_guide_src/source/helpers/array_helper.rst index 20f5864a6..4805f581a 100644 --- a/user_guide_src/source/helpers/array_helper.rst +++ b/user_guide_src/source/helpers/array_helper.rst @@ -32,6 +32,7 @@ The following functions are available: :param array $array: Input array :param bool $default: What to return if the array isn't valid :returns: NULL on failure or the array item. + :rtype: mixed Lets you fetch an item from an array. The function tests whether the array index is set and whether it has a value. If a value exists it is @@ -56,6 +57,7 @@ The following functions are available: :param array $array: Input array :param bool $default: What to return if the array isn't valid :returns: NULL on failure or the array item. + :rtype: mixed Lets you fetch a number of items from an array. The function tests whether each of the array indices is set. If an index does not exist it @@ -112,7 +114,8 @@ The following functions are available: .. function:: random_element($array) :param array $array: Input array - :returns: string (a random element from the array) + :returns: A random element from the array + :rtype: mixed Takes an array as input and returns a random element from it. |