summaryrefslogtreecommitdiffstats
path: root/system/helpers
diff options
context:
space:
mode:
authorAndrey Andreev <narf@bofh.bg>2012-10-27 00:05:09 +0200
committerAndrey Andreev <narf@bofh.bg>2012-10-27 00:05:09 +0200
commit29d909d5d1a14efc2e316650946bf43ddf03f1fd (patch)
tree95dd5551798ba62ae8ba74c8942f9693b49274a9 /system/helpers
parent582ebcb3b7eebd12605804577710cf73f0362001 (diff)
[ci skip] Update docblocks for deprecated functions
Diffstat (limited to 'system/helpers')
-rw-r--r--system/helpers/date_helper.php17
-rw-r--r--system/helpers/file_helper.php10
-rw-r--r--system/helpers/form_helper.php1
-rw-r--r--system/helpers/security_helper.php10
4 files changed, 16 insertions, 22 deletions
diff --git a/system/helpers/date_helper.php b/system/helpers/date_helper.php
index 51b2b76db..5d9251526 100644
--- a/system/helpers/date_helper.php
+++ b/system/helpers/date_helper.php
@@ -119,19 +119,16 @@ if ( ! function_exists('standard_date'))
*
* As of PHP 5.2, the DateTime extension provides constants that
* serve for the exact same purpose and are used with date().
- * Due to that, this function is DEPRECATED and should be removed
- * in CodeIgniter 3.1+.
*
- * Here are two examples of how you should replace it:
+ * @todo Remove in version 3.1+.
+ * @deprecated 3.0.0 Use PHP's native date() instead.
+ * @link http://www.php.net/manual/en/class.datetime.php#datetime.constants.types
*
- * date(DATE_RFC822, now()); // default
- * date(DATE_W3C, $time); // a different format and time
+ * @example date(DATE_RFC822, now()); // default
+ * @example date(DATE_W3C, $time); // a different format and time
*
- * Reference: http://www.php.net/manual/en/class.datetime.php#datetime.constants.types
- *
- * @deprecated
- * @param string the chosen format
- * @param int Unix timestamp
+ * @param string $fmt = 'DATE_RFC822' the chosen format
+ * @param int $time = NULL Unix timestamp
* @return string
*/
function standard_date($fmt = 'DATE_RFC822', $time = NULL)
diff --git a/system/helpers/file_helper.php b/system/helpers/file_helper.php
index 441345b05..8f23a3d54 100644
--- a/system/helpers/file_helper.php
+++ b/system/helpers/file_helper.php
@@ -44,12 +44,10 @@ if ( ! function_exists('read_file'))
*
* Opens the file specfied in the path and returns it as a string.
*
- * This function is DEPRECATED and should be removed in
- * CodeIgniter 3.1+. Use file_get_contents() instead.
- *
- * @deprecated
- * @param string path to file
- * @return string
+ * @todo Remove in version 3.1+.
+ * @deprecated 3.0.0 It is now just an alias for PHP's native file_get_contents().
+ * @param string $file Path to file
+ * @return string File contents
*/
function read_file($file)
{
diff --git a/system/helpers/form_helper.php b/system/helpers/form_helper.php
index a09cb36dd..622622c0e 100644
--- a/system/helpers/form_helper.php
+++ b/system/helpers/form_helper.php
@@ -600,6 +600,7 @@ if ( ! function_exists('form_prep'))
*
* Formats text so that it can be safely placed in a form field in the event it has HTML tags.
*
+ * @todo Remove in version 3.1+.
* @deprecated 3.0.0 This function has been broken for a long time
* and is now just an alias for html_escape(). It's
* second argument is ignored.
diff --git a/system/helpers/security_helper.php b/system/helpers/security_helper.php
index 5ecc960bc..8bbd06684 100644
--- a/system/helpers/security_helper.php
+++ b/system/helpers/security_helper.php
@@ -77,12 +77,10 @@ if ( ! function_exists('do_hash'))
/**
* Hash encode a string
*
- * This function is DEPRECATED and should be removed in
- * CodeIgniter 3.1+. Use hash() instead.
- *
- * @deprecated
- * @param string
- * @param string
+ * @todo Remove in version 3.1+.
+ * @deprecated 3.0.0 Use PHP's native hash() instead.
+ * @param string $str
+ * @param string $type = 'sha1'
* @return string
*/
function do_hash($str, $type = 'sha1')