From 3de130c2da3b93a3404f264e92d7b65354de3548 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Fri, 7 Feb 2014 23:31:49 +0200 Subject: [ci skip] Add return types to helper docs (+ some other formatting) --- user_guide_src/source/helpers/array_helper.rst | 5 +- user_guide_src/source/helpers/captcha_helper.rst | 1 + user_guide_src/source/helpers/cookie_helper.rst | 35 ++-- user_guide_src/source/helpers/date_helper.rst | 181 ++++++++++----------- user_guide_src/source/helpers/directory_helper.rst | 10 +- user_guide_src/source/helpers/download_helper.rst | 2 +- user_guide_src/source/helpers/email_helper.rst | 11 +- user_guide_src/source/helpers/file_helper.rst | 41 +++-- user_guide_src/source/helpers/form_helper.rst | 82 ++++++---- user_guide_src/source/helpers/html_helper.rst | 97 +++++------ user_guide_src/source/helpers/inflector_helper.rst | 23 +-- user_guide_src/source/helpers/language_helper.rst | 21 +-- user_guide_src/source/helpers/number_helper.rst | 5 +- user_guide_src/source/helpers/path_helper.rst | 3 +- user_guide_src/source/helpers/security_helper.rst | 20 ++- user_guide_src/source/helpers/smiley_helper.rst | 12 +- user_guide_src/source/helpers/string_helper.rst | 39 +++-- user_guide_src/source/helpers/text_helper.rst | 40 ++--- .../source/helpers/typography_helper.rst | 10 +- user_guide_src/source/helpers/url_helper.rst | 44 ++--- user_guide_src/source/helpers/xml_helper.rst | 5 +- 21 files changed, 361 insertions(+), 326 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. diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst index 13cf92a19..d83490b8e 100644 --- a/user_guide_src/source/helpers/captcha_helper.rst +++ b/user_guide_src/source/helpers/captcha_helper.rst @@ -135,6 +135,7 @@ The following functions are available: :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) + :rtype: array Takes an array of information to generate the CAPTCHA as input and creates the image to your specifications, returning an array of diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst index 3b594170d..22fd0f77f 100644 --- a/user_guide_src/source/helpers/cookie_helper.rst +++ b/user_guide_src/source/helpers/cookie_helper.rst @@ -27,15 +27,15 @@ The following functions are available: .. function:: set_cookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]]]) - :param mixed $name: Cookie name *or* associative array of all of the parameters available to this function - :param string $value: Cookie value - :param int $expire: Number of seconds until expiration - :param string $domain: Cookie domain (usually: .yourdomain.com) - :param string $path: Cookie path - :param string $prefix: Cookie name prefix - :param bool $secure: Whether to only send the cookie through HTTPS - :param bool $httponly: Whether to hide the cookie from JavaScript - :returns: void + :param mixed $name: Cookie name *or* associative array of all of the parameters available to this function + :param string $value: Cookie value + :param int $expire: Number of seconds until expiration + :param string $domain: Cookie domain (usually: .yourdomain.com) + :param string $path: Cookie path + :param string $prefix: Cookie name prefix + :param bool $secure: Whether to only send the cookie through HTTPS + :param bool $httponly: Whether to hide the cookie from JavaScript + :rtype: void This helper function gives you view file friendly syntax to set browser cookies. Refer to the :doc:`Input Library <../libraries/input>` for a @@ -45,9 +45,10 @@ The following functions are available: .. function:: get_cookie($index[, $xss_clean = NULL]]) - :param string $index: Cookie name - :param bool $xss_clean: Whether to apply XSS filtering to the returned value - :returns: mixed + :param string $index: Cookie name + :param bool $xss_clean: Whether to apply XSS filtering to the returned value + :returns: The cookie value or NULL if not found + :rtype: mixed This helper function gives you view file friendly syntax to get browser cookies. Refer to the :doc:`Input Library <../libraries/input>` for a @@ -56,11 +57,11 @@ The following functions are available: .. function:: delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]]]) - :param string $name: Cookie name - :param string $domain: Cookie domain (usually: .yourdomain.com) - :param string $path: Cookie path - :param string $prefix: Cookie name prefix - :returns: void + :param string $name: Cookie name + :param string $domain: Cookie domain (usually: .yourdomain.com) + :param string $path: Cookie path + :param string $prefix: Cookie name prefix + :rtype: void Lets you delete a cookie. Unless you've set a custom path or other values, only the name of the cookie is needed. diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst index e7598df14..39a9cb325 100644 --- a/user_guide_src/source/helpers/date_helper.rst +++ b/user_guide_src/source/helpers/date_helper.rst @@ -27,7 +27,8 @@ The following functions are available: .. function:: now([$timezone = NULL]) :param string $timezone: Timezone - :returns: int + :returns: UNIX timestamp + :rtype: int Returns the current time as a UNIX timestamp, referenced either to your server's local time or any PHP suported timezone, based on the "time reference" setting @@ -35,7 +36,6 @@ The following functions are available: any other PHP supported timezone (which you'll typically do if you run a site that lets each user set their own timezone settings) there is no benefit to using this function over PHP's ``time()`` function. - :: echo now('Australia/Victoria'); @@ -43,12 +43,12 @@ The following functions are available: If a timezone is not provided, it will return ``time()`` based on the **time_reference** setting. - .. function:: mdate([$datestr = ''[, $time = '']]) - :param string $datestr: Date string - :param int $time: UNIX timestamp - :returns: int + :param string $datestr: Date string + :param int $time: UNIX timestamp + :returns: MySQL-formatted date + :rtype: string This function is identical to PHP's `date() `_ function, except that it lets you use MySQL style date codes, where each @@ -67,12 +67,12 @@ The following functions are available: If a timestamp is not included in the second parameter the current time will be used. - .. function:: standard_date([$fmt = 'DATE_RFC822'[, $time = NULL]]) :param string $fmt: Date format - :param int $time: UNIX timestamp - :returns: string + :param int $time: UNIX timestamp + :returns: Formatted date or FALSE on invalid format + :rtype: string Lets you generate a date string in one of several standardized formats. @@ -92,25 +92,25 @@ The following functions are available: **Supported formats:** =============== ======================= ====================================== - Constant Description Example + Constant Description Example =============== ======================= ====================================== - DATE_ATOM Atom 2005-08-15T16:13:03+0000 - DATE_COOKIE HTTP Cookies Sun, 14 Aug 2005 16:13:03 UTC - DATE_ISO8601 ISO-8601 2005-08-14T16:13:03+00:00 - DATE_RFC822 RFC 822 Sun, 14 Aug 05 16:13:03 UTC - DATE_RFC850 RFC 850 Sunday, 14-Aug-05 16:13:03 UTC - DATE_RFC1036 RFC 1036 Sunday, 14-Aug-05 16:13:03 UTC - DATE_RFC1123 RFC 1123 Sun, 14 Aug 2005 16:13:03 UTC - DATE_RFC2822 RFC 2822 Sun, 14 Aug 2005 16:13:03 +0000 - DATE_RSS RSS Sun, 14 Aug 2005 16:13:03 UTC - DATE_W3C W3C 2005-08-14T16:13:03+0000 + DATE_ATOM Atom 2005-08-15T16:13:03+0000 + DATE_COOKIE HTTP Cookies Sun, 14 Aug 2005 16:13:03 UTC + DATE_ISO8601 ISO-8601 2005-08-14T16:13:03+00:00 + DATE_RFC822 RFC 822 Sun, 14 Aug 05 16:13:03 UTC + DATE_RFC850 RFC 850 Sunday, 14-Aug-05 16:13:03 UTC + DATE_RFC1036 RFC 1036 Sunday, 14-Aug-05 16:13:03 UTC + DATE_RFC1123 RFC 1123 Sun, 14 Aug 2005 16:13:03 UTC + DATE_RFC2822 RFC 2822 Sun, 14 Aug 2005 16:13:03 +0000 + DATE_RSS RSS Sun, 14 Aug 2005 16:13:03 UTC + DATE_W3C W3C 2005-08-14T16:13:03+0000 =============== ======================= ====================================== - .. function:: local_to_gmt([$time = '']) :param int $time: UNIX timestamp - :returns: string + :returns: UNIX timestamp + :rtype: int Takes a UNIX timestamp as input and returns it as GMT. @@ -118,13 +118,13 @@ The following functions are available: $gmt = local_to_gmt(time()); - .. function:: gmt_to_local([$time = ''[, $timezone = 'UTC'[, $dst = FALSE]]]) - :param int $time: UNIX timestamp + :param int $time: UNIX timestamp :param string $timezone: Timezone - :param bool $dst: Whether DST is active - :returns: int + :param bool $dst: Whether DST is active + :returns: UNIX timestamp + :rtype: int Takes a UNIX timestamp (referenced to GMT) as input, and converts it to a localized timestamp based on the timezone and Daylight Saving Time @@ -140,11 +140,11 @@ The following functions are available: .. note:: For a list of timezones see the reference at the bottom of this page. - .. function:: mysql_to_unix([$time = '']) - :param int $time: UNIX timestamp - :returns: int + :param string $time: MySQL timestamp + :returns: UNIX timestamp + :rtype: int Takes a MySQL Timestamp as input and returns it as a UNIX timestamp. @@ -152,13 +152,13 @@ The following functions are available: $unix = mysql_to_unix('20061124092345'); - .. function:: unix_to_human([$time = ''[, $seconds = FALSE[, $fmt = 'us']]]) :param int $time: UNIX timestamp :param bool $seconds: Whether to show seconds :param string $fmt: format (us or euro) - :returns: integer + :returns: Formatted date + :rtype: string Takes a UNIX timestamp as input and returns it in a human readable format with this prototype:: @@ -179,11 +179,11 @@ The following functions are available: echo unix_to_human($now, TRUE, 'us'); // U.S. time with seconds echo unix_to_human($now, TRUE, 'eu'); // Euro time with seconds - .. function:: human_to_unix([$datestr = '']) - :param int $datestr: Date string - :returns: int UNIX timestamp or FALSE on failure + :param int $datestr: Date string + :returns: UNIX timestamp or FALSE on failure + :rtype: int The opposite of the :func:`unix_to_time()` function. Takes a "human" time as input and returns it as a UNIX timestamp. This is useful if you @@ -196,12 +196,12 @@ The following functions are available: $human = unix_to_human($now); $unix = human_to_unix($human); - .. function:: nice_date([$bad_date = ''[, $format = FALSE]]) :param int $bad_date: The terribly formatted date-like string :param string $format: Date format to return (same as PHP's ``date()`` function) - :returns: string + :returns: Formatted date + :rtype: string This function can take a number poorly-formed date formats and convert them into something useful. It also accepts well-formed dates. @@ -220,13 +220,13 @@ The following functions are available: // Should Produce: 2001-09-11 $better_date = nice_date($bad_date, 'Y-m-d'); - .. function:: timespan([$seconds = 1[, $time = ''[, $units = '']]]) :param int $seconds: Number of seconds :param string $time: UNIX timestamp :param int $units: Number of time units to display - :returns: string + :returns: Formatted time difference + :rtype: string Formats a UNIX timestamp so that is appears similar to this:: @@ -252,12 +252,12 @@ The following functions are available: .. note:: The text generated by this function is found in the following language file: `language//date_lang.php` - .. function:: days_in_month([$month = 0[, $year = '']]) :param int $month: a numeric month :param int $year: a numeric year - :returns: int + :returns: Count of days in the specified month + :rtype: int Returns the number of days in a given month/year. Takes leap years into account. @@ -268,14 +268,14 @@ The following functions are available: If the second parameter is empty, the current year will be used. - .. function:: date_range([$unix_start = ''[, $mixed = ''[, $is_unix = TRUE[, $format = 'Y-m-d']]]]) :param int $unix_start: UNIX timestamp of the range start date :param int $mixed: UNIX timestamp of the range end date or interval in days :param bool $is_unix: set to FALSE if $mixed is not a timestamp :param string $format: Output date format, same as in ``date()`` - :returns: array + :returns: An array of dates + :rtype: array Returns a list of dates within a specified period. @@ -288,11 +288,11 @@ The following functions are available: echo $date."\n"; } - .. function:: timezones([$tz = '']) - :param string $tz: a numeric timezone - :returns: string + :param string $tz: A numeric timezone + :returns: Hour difference from UTC + :rtype: int Takes a timezone reference (for a list of valid timezones, see the "Timezone Reference" below) and returns the number of hours offset from @@ -305,14 +305,14 @@ The following functions are available: This function is useful when used with :func:`timezone_menu()`. - .. function:: timezone_menu([$default = 'UTC'[, $class = ''[, $name = 'timezones'[, $attributes = '']]]]) :param string $default: Timezone :param string $class: Class name :param string $name: Menu name :param mixed $attributes: HTML attributes - :returns: string + :returns: HTML drop down menu with time zones + :rtype: string Generates a pull-down menu of timezones, like this one: @@ -381,7 +381,6 @@ The following functions are available: .. note:: The text contained in the menu is found in the following language file: `language//date_lang.php` - Timezone Reference ================== @@ -389,47 +388,47 @@ The following table indicates each timezone and its location. Note some of the location lists have been abridged for clarity and formatting. -=========== ===================================================================== -Time Zone Location -=========== ===================================================================== -UM12 (UTC - 12:00) Baker/Howland Island -UM11 (UTC - 11:00) Samoa Time Zone, Niue -UM10 (UTC - 10:00) Hawaii-Aleutian Standard Time, Cook Islands -UM95 (UTC - 09:30) Marquesas Islands -UM9 (UTC - 09:00) Alaska Standard Time, Gambier Islands -UM8 (UTC - 08:00) Pacific Standard Time, Clipperton Island -UM7 (UTC - 11:00) Mountain Standard Time -UM6 (UTC - 06:00) Central Standard Time -UM5 (UTC - 05:00) Eastern Standard Time, Western Caribbean -UM45 (UTC - 04:30) Venezuelan Standard Time -UM4 (UTC - 04:00) Atlantic Standard Time, Eastern Caribbean -UM35 (UTC - 03:30) Newfoundland Standard Time -UM3 (UTC - 03:00) Argentina, Brazil, French Guiana, Uruguay -UM2 (UTC - 02:00) South Georgia/South Sandwich Islands -UM1 (UTC -1:00) Azores, Cape Verde Islands -UTC (UTC) Greenwich Mean Time, Western European Time -UP1 (UTC +1:00) Central European Time, West Africa Time -UP2 (UTC +2:00) Central Africa Time, Eastern European Time -UP3 (UTC +3:00) Moscow Time, East Africa Time -UP35 (UTC +3:30) Iran Standard Time -UP4 (UTC +4:00) Azerbaijan Standard Time, Samara Time -UP45 (UTC +4:30) Afghanistan -UP5 (UTC +5:00) Pakistan Standard Time, Yekaterinburg Time -UP55 (UTC +5:30) Indian Standard Time, Sri Lanka Time -UP575 (UTC +5:45) Nepal Time -UP6 (UTC +6:00) Bangladesh Standard Time, Bhutan Time, Omsk Time -UP65 (UTC +6:30) Cocos Islands, Myanmar -UP7 (UTC +7:00) Krasnoyarsk Time, Cambodia, Laos, Thailand, Vietnam -UP8 (UTC +8:00) Australian Western Standard Time, Beijing Time -UP875 (UTC +8:45) Australian Central Western Standard Time -UP9 (UTC +9:00) Japan Standard Time, Korea Standard Time, Yakutsk -UP95 (UTC +9:30) Australian Central Standard Time -UP10 (UTC +10:00) Australian Eastern Standard Time, Vladivostok Time -UP105 (UTC +10:30) Lord Howe Island -UP11 (UTC +11:00) Magadan Time, Solomon Islands, Vanuatu -UP115 (UTC +11:30) Norfolk Island -UP12 (UTC +12:00) Fiji, Gilbert Islands, Kamchatka, New Zealand -UP1275 (UTC +12:45) Chatham Islands Standard Time -UP13 (UTC +13:00) Phoenix Islands Time, Tonga -UP14 (UTC +14:00) Line Islands +=========== ===================================================================== +Time Zone Location +=========== ===================================================================== +UM12 (UTC - 12:00) Baker/Howland Island +UM11 (UTC - 11:00) Samoa Time Zone, Niue +UM10 (UTC - 10:00) Hawaii-Aleutian Standard Time, Cook Islands +UM95 (UTC - 09:30) Marquesas Islands +UM9 (UTC - 09:00) Alaska Standard Time, Gambier Islands +UM8 (UTC - 08:00) Pacific Standard Time, Clipperton Island +UM7 (UTC - 11:00) Mountain Standard Time +UM6 (UTC - 06:00) Central Standard Time +UM5 (UTC - 05:00) Eastern Standard Time, Western Caribbean +UM45 (UTC - 04:30) Venezuelan Standard Time +UM4 (UTC - 04:00) Atlantic Standard Time, Eastern Caribbean +UM35 (UTC - 03:30) Newfoundland Standard Time +UM3 (UTC - 03:00) Argentina, Brazil, French Guiana, Uruguay +UM2 (UTC - 02:00) South Georgia/South Sandwich Islands +UM1 (UTC -1:00) Azores, Cape Verde Islands +UTC (UTC) Greenwich Mean Time, Western European Time +UP1 (UTC +1:00) Central European Time, West Africa Time +UP2 (UTC +2:00) Central Africa Time, Eastern European Time +UP3 (UTC +3:00) Moscow Time, East Africa Time +UP35 (UTC +3:30) Iran Standard Time +UP4 (UTC +4:00) Azerbaijan Standard Time, Samara Time +UP45 (UTC +4:30) Afghanistan +UP5 (UTC +5:00) Pakistan Standard Time, Yekaterinburg Time +UP55 (UTC +5:30) Indian Standard Time, Sri Lanka Time +UP575 (UTC +5:45) Nepal Time +UP6 (UTC +6:00) Bangladesh Standard Time, Bhutan Time, Omsk Time +UP65 (UTC +6:30) Cocos Islands, Myanmar +UP7 (UTC +7:00) Krasnoyarsk Time, Cambodia, Laos, Thailand, Vietnam +UP8 (UTC +8:00) Australian Western Standard Time, Beijing Time +UP875 (UTC +8:45) Australian Central Western Standard Time +UP9 (UTC +9:00) Japan Standard Time, Korea Standard Time, Yakutsk +UP95 (UTC +9:30) Australian Central Standard Time +UP10 (UTC +10:00) Australian Eastern Standard Time, Vladivostok Time +UP105 (UTC +10:30) Lord Howe Island +UP11 (UTC +11:00) Magadan Time, Solomon Islands, Vanuatu +UP115 (UTC +11:30) Norfolk Island +UP12 (UTC +12:00) Fiji, Gilbert Islands, Kamchatka, New Zealand +UP1275 (UTC +12:45) Chatham Islands Standard Time +UP13 (UTC +13:00) Phoenix Islands Time, Tonga +UP14 (UTC +14:00) Line Islands =========== ===================================================================== \ No newline at end of file diff --git a/user_guide_src/source/helpers/directory_helper.rst b/user_guide_src/source/helpers/directory_helper.rst index 514e80c96..3004316a8 100644 --- a/user_guide_src/source/helpers/directory_helper.rst +++ b/user_guide_src/source/helpers/directory_helper.rst @@ -29,11 +29,11 @@ The following functions are available: .. function:: directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]]) - :param string $source_dir: path to the ource directory - :param integer $directory_depth: depth of directories to traverse (0 = - fully recursive, 1 = current dir, etc) - :param boolean $hidden: whether to include hidden directories - :returns: array + :param string $source_dir: Path to the ource directory + :param int $directory_depth: Depth of directories to traverse (0 = fully recursive, 1 = current dir, etc) + :param bool $hidden: Whether to include hidden directories + :returns: An array of files + :rtype: array Examples:: diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst index 17b68f454..f374d491f 100644 --- a/user_guide_src/source/helpers/download_helper.rst +++ b/user_guide_src/source/helpers/download_helper.rst @@ -29,7 +29,7 @@ The following functions are available: :param string $filename: Filename :param mixed $data: File contents :param bool $set_mime: Whether to try to send the actual MIME type - :returns: void + :rtype: void Generates server headers which force data to be downloaded to your desktop. Useful with file downloads. The first parameter is the **name diff --git a/user_guide_src/source/helpers/email_helper.rst b/user_guide_src/source/helpers/email_helper.rst index fe3ccdda1..b665ce548 100644 --- a/user_guide_src/source/helpers/email_helper.rst +++ b/user_guide_src/source/helpers/email_helper.rst @@ -30,8 +30,9 @@ The following functions are available: .. function:: valid_email($email) - :param string $email: Email address - :returns: bool + :param string $email: E-mail address + :returns: TRUE if a valid email is supplied, FALSE otherwise + :rtype: bool Checks if the input is a correctly formatted e-mail address. Note that is doesn't actually prove that the address will be able recieve mail, but @@ -52,13 +53,13 @@ The following functions are available: (bool) filter_var($email, FILTER_VALIDATE_EMAIL); - .. function:: send_email($recipient, $subject, $message) :param string $recipient: E-mail address :param string $subject: Mail subject :param string $message: Message body - :returns: bool + :returns: TRUE if the mail was successfully sent, FALSE in case of an error + :rtype: bool Sends an email using PHP's native `mail() `_ function. @@ -70,4 +71,4 @@ The following functions are available: mail($recipient, $subject, $message); For a more robust email solution, see CodeIgniter's :doc:`Email Library - <../libraries/email>`. + <../libraries/email>`. \ No newline at end of file diff --git a/user_guide_src/source/helpers/file_helper.rst b/user_guide_src/source/helpers/file_helper.rst index 4d225d278..59cabcce2 100644 --- a/user_guide_src/source/helpers/file_helper.rst +++ b/user_guide_src/source/helpers/file_helper.rst @@ -27,7 +27,8 @@ The following functions are available: .. function:: read_file($file) :param string $file: File path - :returns: string or FALSE on failure + :returns: File contents or FALSE on failure + :rtype: string Returns the data contained in the file specified in the path. @@ -48,13 +49,13 @@ The following functions are available: function might not work if you are trying to access a file above the calling script. - .. function:: write_file($path, $data[, $mode = 'wb']) :param string $path: File path :param string $data: Data to write to file :param string $mode: ``fopen()`` mode - :returns: bool + :returns: TRUE if the write was successful, FALSE in case of an error + :rtype: bool Writes data to the file specified in the path. If the file does not exist then the function will create it. @@ -88,13 +89,13 @@ The following functions are available: .. note:: This function acquires an exclusive lock on the file while writing to it. - .. function:: delete_files($path[, $del_dir = FALSE[, $htdocs = FALSE]]) :param string $path: Directory path :param bool $del_dir: Whether to also delete directories :param bool $htdocs: Whether to skip deleting .htaccess and index page files - :returns: bool + :returns: TRUE on success, FALSE in case of an error + :rtype: bool Deletes ALL files contained in the supplied path. @@ -111,12 +112,12 @@ The following functions are available: .. note:: The files must be writable or owned by the system in order to be deleted. - .. function:: get_filenames($source_dir[, $include_path = FALSE]) :param string $source_dir: Directory path :param bool $include_path: Whether to include the path as part of the filenames - :returns: array + :returns: An array of file names + :rtype: array Takes a server path as input and returns an array containing the names of all files contained within it. The file path can optionally be added to the file names by setting @@ -126,13 +127,12 @@ The following functions are available: $controllers = get_filenames(APPPATH.'controllers/'); - .. function:: get_dir_file_info($source_dir, $top_level_only) :param string $source_dir: Directory path - :param bool $top_level_only: Whether to look only at the specified directory - (excluding sub-directories) - :returns: array + :param bool $top_level_only: Whether to look only at the specified directory (excluding sub-directories) + :returns: An array containing info on the supplied directory's contents + :rtype: array Reads the specified directory and builds an array containing the filenames, filesize, dates, and permissions. Sub-folders contained within the specified path are only read @@ -143,12 +143,12 @@ The following functions are available: $models_info = get_dir_file_info(APPPATH.'models/'); - .. function:: get_file_info($file[, $returned_values = array('name', 'server_path', 'size', 'date')]) :param string $file: File path :param array $returned_values: What type of info to return - :returns: array or FALSE on failure + :returns: An array containing info on the specified file or FALSE on failure + :rtype: array Given a file and path, returns (optionally) the *name*, *path*, *size* and *date modified* information attributes for a file. Second parameter allows you to explicitly declare what @@ -157,14 +157,11 @@ The following functions are available: Valid ``$returned_values`` options are: `name`, `size`, `date`, `readable`, `writeable`, `executable` and `fileperms`. - .. note:: The *writable* attribute is checked via PHP's ``is_writeable()`` function, which - known to have issues on the IIS webserver. Consider using *fileperms* instead, - which returns information from PHP's ``fileperms()`` function. - .. function:: get_mime_by_extension($filename) :param string $filename: File name - :returns: string or FALSE on failure + :returns: MIME type string or FALSE on failure + :rtype: string Translates a filename extension into a MIME type based on *config/mimes.php*. Returns FALSE if it can't determine the type, or read the MIME config file. @@ -178,11 +175,11 @@ The following functions are available: is here strictly for convenience. It should not be used for security purposes. - .. function:: symbolic_permissions($perms) :param int $perms: Permissions - :returns: string + :returns: Symbolic permissions string + :rtype: string Takes numeric permissions (such as is returned by ``fileperms()``) and returns standard symbolic notation of file permissions. @@ -191,11 +188,11 @@ The following functions are available: echo symbolic_permissions(fileperms('./index.php')); // -rw-r--r-- - .. function:: octal_permissions($perms) :param int $perms: Permissions - :returns: string + :returns: Octal permissions string + :rtype: string Takes numeric permissions (such as is returned by ``fileperms()``) and returns a three character octal notation of file permissions. diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst index dcb5bee21..4fa5f246b 100644 --- a/user_guide_src/source/helpers/form_helper.rst +++ b/user_guide_src/source/helpers/form_helper.rst @@ -30,7 +30,8 @@ The following functions are available: :param string $action: Form action/target URI string :param array $attributes: HTML attributes :param array $hidden: An array of hidden fields' definitions - :returns: string + :returns: An HTML form opening tag + :rtype: string Creates an opening form tag with a base URL **built from your config preferences**. It will optionally let you add form attributes and hidden input fields, and @@ -87,7 +88,8 @@ The following functions are available: :param string $action: Form action/target URI string :param array $attributes: HTML attributes :param array $hidden: An array of hidden fields' definitions - :returns: string + :returns: An HTML multipart form opening tag + :rtype: string This function is absolutely identical to :func:`form_open()` above, except that it adds a *multipart* attribute, which is necessary if you @@ -98,7 +100,8 @@ The following functions are available: :param string $name: Field name :param string $value: Field value - :returns: string + :returns: An HTML hidden input field tag + :rtype: string Lets you generate hidden input fields. You can either submit a name/value string to create one field:: @@ -159,13 +162,13 @@ The following functions are available: */ - .. function:: form_input([$data = ''[, $value = ''[, $extra = '']]) :param array $data: Field attributes data :param string $value: Field value :param string $extra: Extra attributes to be added to the tag *as is* - :returns: string + :returns: An HTML text input field tag + :rtype: string Lets you generate a standard text input field. You can minimally pass the field name and value in the first and second parameter:: @@ -198,13 +201,13 @@ The following functions are available: $js = 'onClick="some_function()"'; echo form_input('username', 'johndoe', $js); - .. function:: form_password([$data = ''[, $value = ''[, $extra = '']]]) :param array $data: Field attributes data :param string $value: Field value :param string $extra: Extra attributes to be added to the tag *as is* - :returns: string + :returns: An HTML password input field tag + :rtype: string This function is identical in all respects to the :func:`form_input()` function above except that it uses the "password" input type. @@ -215,7 +218,8 @@ The following functions are available: :param array $data: Field attributes data :param string $value: Field value :param string $extra: Extra attributes to be added to the tag *as is* - :returns: string + :returns: An HTML file upload input field tag + :rtype: string This function is identical in all respects to the :func:`form_input()` function above except that it uses the "file" input type, allowing it to @@ -227,7 +231,8 @@ The following functions are available: :param array $data: Field attributes data :param string $value: Field value :param string $extra: Extra attributes to be added to the tag *as is* - :returns: string + :returns: An HTML textarea tag + :rtype: string This function is identical in all respects to the :func:`form_input()` function above except that it generates a "textarea" type. @@ -235,14 +240,14 @@ The following functions are available: .. note:: Instead of the *maxlength* and *size* attributes in the above example, you will instead specify *rows* and *cols*. - .. function:: form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]]) :param string $name: Field name :param array $options: An associative array of options to be listed :param array $selected: List of fields to mark with the *selected* attribute :param string $extra: Extra attributes to be added to the tag *as is* - :returns: string + :returns: An HTML dropdown select field tag + :rtype: string Lets you create a standard drop-down field. The first parameter will contain the name of the field, the second parameter will contain an @@ -305,7 +310,8 @@ The following functions are available: :param array $options: An associative array of options to be listed :param array $selected: List of fields to mark with the *selected* attribute :param string $extra: Extra attributes to be added to the tag *as is* - :returns: string + :returns: An HTML dropdown multiselect field tag + :rtype: string Lets you create a standard multiselect field. The first parameter will contain the name of the field, the second parameter will contain an @@ -321,7 +327,8 @@ The following functions are available: :param string $legend_text: Text to put in the tag :param array $attributes: Attributes to be set on the
tag - :returns: string + :returns: An HTML fieldset opening tag + :rtype: string Lets you generate fieldset/legend fields. @@ -365,7 +372,9 @@ The following functions are available: .. function:: form_fieldset_close([$extra = '']) :param string $extra: Anything to append after the closing tag, *as is* - :returns: string + :returns: An HTML fieldset closing tag + :rtype: string + Produces a closing
tag. The only advantage to using this function is it permits you to pass data to it which will be added below @@ -384,7 +393,8 @@ The following functions are available: :param string $value: Field value :param bool $checked: Whether to mark the checkbox as being *checked* :param string $extra: Extra attributes to be added to the tag *as is* - :returns: string + :returns: An HTML checkbox input tag + :rtype: string Lets you generate a checkbox field. Simple example:: @@ -422,7 +432,8 @@ The following functions are available: :param string $value: Field value :param bool $checked: Whether to mark the radio button as being *checked* :param string $extra: Extra attributes to be added to the tag *as is* - :returns: string + :returns: An HTML radio input tag + :rtype: string This function is identical in all respects to the :func:`form_checkbox()` function above except that it uses the "radio" input type. @@ -433,7 +444,8 @@ The following functions are available: :param string $label_text: Text to put in the