diff options
| author | Andrey Andreev <narf@devilix.net> | 2017-11-07 14:42:53 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2017-11-07 14:42:53 +0100 |
| commit | 44aa1ab0655283b67d6fdcb081803f25453dbc73 (patch) | |
| tree | 4ce1f08f07c24993fa8768e7a9fcdfe5273af3ad /user_guide_src/source/helpers | |
| parent | 35278338a21e6303a32fc3e3039b32d28e0d3fc5 (diff) | |
[ci skip] Deprecate extra parameters of the CAPTCHA helper
Diffstat (limited to 'user_guide_src/source/helpers')
| -rw-r--r-- | user_guide_src/source/helpers/captcha_helper.rst | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst index 986c1d3e1..be1b20aaf 100644 --- a/user_guide_src/source/helpers/captcha_helper.rst +++ b/user_guide_src/source/helpers/captcha_helper.rst @@ -135,9 +135,9 @@ The following functions are available: .. php:function:: create_captcha([$data = ''[, $img_path = ''[, $img_url = ''[, $font_path = '']]]]) :param array $data: Array of data for the CAPTCHA - :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 + :param string $img_path: Path to create the image in (DEPRECATED) + :param string $img_url: URL to the CAPTCHA image folder (DEPRECATED) + :param string $font_path: Server path to font (DEPRECATED) :returns: array('word' => $word, 'time' => $now, 'image' => $img) :rtype: array @@ -161,4 +161,8 @@ The following functions are available: file extension. It will be a number like this: 1139612155.3422 The **word** is the word that appears in the captcha image, which if not - supplied to the function, will be a random string.
\ No newline at end of file + supplied to the function, will be a random string. + + .. note:: Usage of the ``$img_path``, ``$img_url`` and ``$font_path`` + parameters is DEPRECATED. Provide them in the ``$data`` array + instead. |