Add 'filename' to the return elements for create_captcha() (PR #2602)
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 8f5dfe5..053f577 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -128,6 +128,7 @@
- Added *word_length* and *pool* options to allow customization of the generated word.
- Added *colors* configuration to allow customization for the *background*, *border*, *text* and *grid* colors.
+ - Added *filename* to the returned array elements.
- :doc:`Directory Helper <helpers/directory_helper>` :php:func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
- :doc:`Array Helper <helpers/array_helper>` :php:func:`element()` and :php:func:`elements()` now return NULL instead of FALSE when the required elements don't exist.
diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst
index 3c56add..f471734 100644
--- a/user_guide_src/source/helpers/captcha_helper.rst
+++ b/user_guide_src/source/helpers/captcha_helper.rst
@@ -26,7 +26,7 @@
:param string $img_path: Path to create the image in
:param string $img_url: URL to the CAPTCHA image folder
:param string $font_path: Server path to font
- :returns: array('word' => $word, 'time' => $now, 'image' => $img)
+ :returns: array
Takes an array of information to generate the CAPTCHA as input and
creates the image to your specifications, returning an array of
@@ -35,9 +35,10 @@
::
array(
- 'image' => IMAGE TAG
- 'time' => TIMESTAMP (in microtime)
- 'word' => CAPTCHA WORD
+ 'word' => CAPTCHA WORD,
+ 'time' => TIMESTAMP (in microtime),
+ 'image' => IMAGE TAG,
+ 'filename' => IMAGE FILE NAME
)
The **image** is the actual image tag::