diff options
21 files changed, 137 insertions, 137 deletions
diff --git a/user_guide_src/source/general/ancillary_classes.rst b/user_guide_src/source/general/ancillary_classes.rst index 5dc058ad4..edb3a14fb 100644 --- a/user_guide_src/source/general/ancillary_classes.rst +++ b/user_guide_src/source/general/ancillary_classes.rst @@ -9,7 +9,7 @@ resources. This is easily possible as you'll see. get_instance() ============== -.. php:function:: get_instance() +.. function:: get_instance() :returns: object of class CI_Controller @@ -48,7 +48,7 @@ Once you've assigned the object to a variable, you'll use that variable passed by reference:: $CI =& get_instance(); - + This is very important. Assigning by reference allows you to use the original CodeIgniter object rather than creating a copy of it. diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst index 32e8a8be0..8a57c183e 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -9,7 +9,7 @@ loading any libraries or helpers. is_php() ======== -.. php:function:: is_php($version = '5.3.0') +.. function:: is_php($version = '5.3.0') :param string $version: Version number :returns: bool @@ -31,7 +31,7 @@ version of PHP is lower than the supplied version number. is_really_writable() ==================== -.. php:function:: is_really_writable($file) +.. function:: is_really_writable($file) :param string $file: File path :returns: bool @@ -58,7 +58,7 @@ Example:: config_item() ============= -.. php:function:: config_item($key) +.. function:: config_item($key) :param string $key: Config item key :returns: mixed @@ -71,7 +71,7 @@ documentation for more information. show_error() ============ -.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') +.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') :param mixed $message: Error message :param int $status_code: HTTP Response status code @@ -84,7 +84,7 @@ please see the :doc:`Error Handling <errors>` documentation. show_404() ========== -.. php:function:: show_404($page = '', $log_error = TRUE) +.. function:: show_404($page = '', $log_error = TRUE) :param string $page: URI string :param bool $log_error: Whether to log the error @@ -96,7 +96,7 @@ please see the :doc:`Error Handling <errors>` documentation. log_message() ============= -.. php:function:: log_message($level, $message, $php_error = FALSE) +.. function:: log_message($level, $message, $php_error = FALSE) :param string $level: Log level: 'error', 'debug' or 'info' :param string $message: Message to log @@ -109,7 +109,7 @@ please see the :doc:`Error Handling <errors>` documentation. set_status_header() =============================== -.. php:function:: set_status_header($code, $text = '') +.. function:: set_status_header($code, $text = '') :param int $code: HTTP Reponse status code :param string $text: A custom message to set with the status code @@ -126,7 +126,7 @@ a full list of headers. remove_invisible_characters() ============================= -.. php:function:: remove_invisible_characters($str, $url_encoded = TRUE) +.. function:: remove_invisible_characters($str, $url_encoded = TRUE) :param string $str: Input string :param bool $url_encoded: Whether to remove URL-encoded characters as well @@ -143,7 +143,7 @@ Example:: html_escape() ============= -.. php:function:: html_escape($var) +.. function:: html_escape($var) :param mixed $var: Variable to escape (string or array) @@ -157,7 +157,7 @@ It is useful in preventing Cross Site Scripting (XSS). get_mimes() =========== -.. php:function:: get_mimes() +.. function:: get_mimes() :returns: array @@ -167,7 +167,7 @@ This function returns a *reference* to the MIMEs array from is_https() ========== -.. php:function:: is_https() +.. function:: is_https() :returns: bool @@ -177,7 +177,7 @@ in any other case (including non-HTTP requests). function_usable() ================= -.. php:function:: function_usable($function_name) +.. function:: function_usable($function_name) :param string $function_name: Function name :returns: bool diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst index f12d992f8..6cc8a0966 100644 --- a/user_guide_src/source/general/errors.rst +++ b/user_guide_src/source/general/errors.rst @@ -21,8 +21,8 @@ without having to worry about class/function scoping. CodeIgniter also returns a status code whenever a portion of the core calls ``exit()``. This exit status code is separate from the HTTP status code, and serves as a notice to other processes that may be watching of -whether the script completed successfully, or if not, what kind of -problem it encountered that caused it to abort. These values are +whether the script completed successfully, or if not, what kind of +problem it encountered that caused it to abort. These values are defined in *application/config/constants.php*. While exit status codes are most useful in CLI settings, returning the proper code helps server software keep track of your scripts and the health of your application. @@ -32,7 +32,7 @@ The following functions let you generate errors: show_error() ============ -.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') +.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') :param mixed $message: Error message :param int $status_code: HTTP Response status code @@ -49,13 +49,13 @@ code should be sent with the error. If ``$status_code`` is less than 100, the HTTP status code will be set to 500, and the exit status code will be set to ``$status_code + EXIT__AUTO_MIN``. If that value is larger than ``EXIT__AUTO_MAX``, or if ``$status_code`` is 100 or higher, the exit -status code will be set to ``EXIT_ERROR``. You can check in +status code will be set to ``EXIT_ERROR``. You can check in *application/config/constants.php* for more detail. show_404() ========== -.. php:function:: show_404($page = '', $log_error = TRUE) +.. function:: show_404($page = '', $log_error = TRUE) :param string $page: URI string :param bool $log_error: Whether to log the error @@ -77,7 +77,7 @@ optional second parameter to FALSE will skip logging. log_message() ============= -.. php:function:: log_message($level, $message, $php_error = FALSE) +.. function:: log_message($level, $message, $php_error = FALSE) :param string $level: Log level: 'error', 'debug' or 'info' :param string $message: Message to log diff --git a/user_guide_src/source/helpers/array_helper.rst b/user_guide_src/source/helpers/array_helper.rst index 9435b3ac7..90ead2942 100644 --- a/user_guide_src/source/helpers/array_helper.rst +++ b/user_guide_src/source/helpers/array_helper.rst @@ -19,7 +19,7 @@ The following functions are available: element() ========= -.. php:function:: element($item, $array, $default = NULL) +.. function:: element($item, $array, $default = NULL) :param string $item: Item to fetch from the array :param array $array: Input array @@ -39,13 +39,13 @@ Example:: 'size' => '' ); - echo element('color', $array); // returns "red" - echo element('size', $array, 'foobar'); // returns "foobar" + echo element('color', $array); // returns "red" + echo element('size', $array, 'foobar'); // returns "foobar" elements() ========== -.. php:function:: elements($items, $array, $default = NULL) +.. function:: elements($items, $array, $default = NULL) :param string $item: Item to fetch from the array :param array $array: Input array @@ -55,7 +55,7 @@ elements() 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 is set to NULL, or whatever you've specified as the default value via -the third parameter. +the third parameter. Example:: @@ -106,7 +106,7 @@ updated. random_element() ================ -.. php:function:: random_element($array) +.. function:: random_element($array) :param array $array: Input array :returns: string (a random element from the array) diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst index 3c56addf3..b40d8a252 100644 --- a/user_guide_src/source/helpers/captcha_helper.rst +++ b/user_guide_src/source/helpers/captcha_helper.rst @@ -20,7 +20,7 @@ The following functions are available: create_captcha() ================ -.. php:function:: function create_captcha($data = '', $img_path = '', $img_url = '', $font_path = '') +.. function:: 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 @@ -132,7 +132,7 @@ CAPTCHA will be shown you'll have something like this:: $this->db->query($query); echo 'Submit the word you see below:'; - echo $cap['image']; + echo $cap['image']; echo '<input type="text" name="captcha" value="" />'; Then, on the page that accepts the submission you'll have something like diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst index c41193c3c..c09f5eb4c 100644 --- a/user_guide_src/source/helpers/cookie_helper.rst +++ b/user_guide_src/source/helpers/cookie_helper.rst @@ -19,7 +19,7 @@ The following functions are available: set_cookie() ============ -.. php:function:: set_cookie($name = '', $value = '', $expire = '', $domain = '', $path = '/', $prefix = '', $secure = FALSE, $httponly = FALSE) +.. function:: set_cookie($name = '', $value = '', $expire = '', $domain = '', $path = '/', $prefix = '', $secure = FALSE, $httponly = FALSE) :param string $name: Cookie name :param string $value: Cookie value @@ -39,7 +39,7 @@ description of its use, as this function is an alias for get_cookie() ============ -.. php:function:: get_cookie($index = '', $xss_clean = FALSE) +.. function:: get_cookie($index = '', $xss_clean = FALSE) :param string $index: Cookie name :param bool $xss_clean: Whether to apply XSS filtering to the returned value @@ -52,7 +52,7 @@ description of itsuse, as this function is an alias for ``CI_Input::cookie()``. delete_cookie() =============== -.. php:function:: delete_cookie($name = '', $domain = '', $path = '/', $prefix = '') +.. function:: delete_cookie($name = '', $domain = '', $path = '/', $prefix = '') :param string $name: Cookie name :param string $domain: Cookie domain (usually: .yourdomain.com) diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst index 5dfee8b48..67ead0330 100644 --- a/user_guide_src/source/helpers/date_helper.rst +++ b/user_guide_src/source/helpers/date_helper.rst @@ -18,7 +18,7 @@ The following functions are available: now() ===== -.. php:function:: now($timezone = NULL) +.. function:: now($timezone = NULL) :param string $timezone: Timezone :returns: int @@ -40,7 +40,7 @@ If a timezone is not provided, it will return ``time()`` based on the mdate() ======= -.. php:function:: mdate($datestr = '', $time = '') +.. function:: mdate($datestr = '', $time = '') :param string $datestr: Date string :param int $time: UNIX timestamp @@ -66,7 +66,7 @@ will be used. standard_date() =============== -.. php:function:: standard_date($fmt = 'DATE_RFC822', $time = NULL) +.. function:: standard_date($fmt = 'DATE_RFC822', $time = NULL) :param string $fmt: Date format :param int $time: UNIX timestamp @@ -109,7 +109,7 @@ DATE_W3C W3C 2005-08-14T16:13:03+0000 local_to_gmt() ============== -.. php:function:: local_to_gmt($time = '') +.. function:: local_to_gmt($time = '') :param int $time: UNIX timestamp :returns: string @@ -123,7 +123,7 @@ Example:: gmt_to_local() ============== -.. php:function:: gmt_to_local($time = '', $timezone = 'UTC', $dst = FALSE) +.. function:: gmt_to_local($time = '', $timezone = 'UTC', $dst = FALSE) :param int $time: UNIX timestamp :param string $timezone: Timezone @@ -147,7 +147,7 @@ Example:: mysql_to_unix() =============== -.. php:function:: mysql_to_unix($time = '') +.. function:: mysql_to_unix($time = '') :param int $time: UNIX timestamp :returns: int @@ -161,7 +161,7 @@ Example:: unix_to_human() =============== -.. php:function:: unix_to_human($time = '', $seconds = FALSE, $fmt = 'us') +.. function:: unix_to_human($time = '', $seconds = FALSE, $fmt = 'us') :param int $time: UNIX timestamp :param bool $seconds: Whether to show seconds @@ -190,7 +190,7 @@ Examples:: human_to_unix() =============== -.. php:function:: human_to_unix($datestr = '') +.. function:: human_to_unix($datestr = '') :param int $datestr: Date string :returns: int UNIX timestamp or FALSE on failure @@ -209,7 +209,7 @@ Example:: nice_date() =========== -.. php:function:: nice_date($bad_date = '', $format = FALSE) +.. 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) @@ -235,7 +235,7 @@ Example:: timespan() ========== -.. php:function:: timespan($seconds = 1, $time = '', $units = '') +.. function:: timespan($seconds = 1, $time = '', $units = '') :param int $seconds: Number of seconds :param string $time: UNIX timestamp @@ -269,7 +269,7 @@ Example:: days_in_month() =============== -.. php:function:: days_in_month($month = 0, $year = '') +.. function:: days_in_month($month = 0, $year = '') :param int $month: a numeric month :param int $year: a numeric year @@ -287,7 +287,7 @@ If the second parameter is empty, the current year will be used. date_range() ============ -.. php:function:: date_range($unix_start = '', $mixed = '', $is_unix = TRUE, $format = 'Y-m-d') +.. 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 @@ -309,7 +309,7 @@ Example:: timezones() =========== -.. php:function:: timezones($tz = '') +.. function:: timezones($tz = '') :param string $tz: a numeric timezone :returns: string @@ -328,7 +328,7 @@ This function is useful when used with :php:func:`timezone_menu()`. timezone_menu() =============== -.. php:function:: timezone_menu($default = 'UTC', $class = '', $name = 'timezones', $attributes = '') +.. function:: timezone_menu($default = 'UTC', $class = '', $name = 'timezones', $attributes = '') :param string $default: Timezone :param string $class: Class name diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst index 860c568b9..fd95f4f34 100644 --- a/user_guide_src/source/helpers/download_helper.rst +++ b/user_guide_src/source/helpers/download_helper.rst @@ -18,7 +18,7 @@ The following functions are available: force_download() ================ -.. php:function:: force_download($filename = '', $data = '', $set_mime = FALSE) +.. function:: force_download($filename = '', $data = '', $set_mime = FALSE) :param string $filename: Filename :param mixed $data: File contents diff --git a/user_guide_src/source/helpers/email_helper.rst b/user_guide_src/source/helpers/email_helper.rst index 10adf1d0e..b38e7ec46 100644 --- a/user_guide_src/source/helpers/email_helper.rst +++ b/user_guide_src/source/helpers/email_helper.rst @@ -22,7 +22,7 @@ The following functions are available: valid_email() ============= -.. php:function:: valid_email($email) +.. function:: valid_email($email) :param string $email: Email address :returns: bool @@ -49,7 +49,7 @@ Example:: send_email() ============ -.. php:function:: send_email($recipient, $subject, $message) +.. function:: send_email($recipient, $subject, $message) :param string $recipient: E-mail address :param string $subject: Mail subject diff --git a/user_guide_src/source/helpers/file_helper.rst b/user_guide_src/source/helpers/file_helper.rst index 194d4348f..be451db4d 100644 --- a/user_guide_src/source/helpers/file_helper.rst +++ b/user_guide_src/source/helpers/file_helper.rst @@ -18,7 +18,7 @@ The following functions are available: read_file() =========== -.. php:function:: read_file($file) +.. function:: read_file($file) :param string $file: File path :returns: string or FALSE on failure @@ -45,7 +45,7 @@ The path can be a relative or full server path. Returns FALSE (boolean) on failu write_file() ============ -.. php:function:: write_file($path, $data, $mode = 'wb') +.. function:: write_file($path, $data, $mode = 'wb') :param string $path: File path :param string $data: Data to write to file @@ -87,7 +87,7 @@ for mode options. delete_files() ============== -.. php:function:: delete_files($path, $del_dir = FALSE, $htdocs = FALSE) +.. function:: delete_files($path, $del_dir = FALSE, $htdocs = FALSE) :param string $path: Directory path :param bool $del_dir: Whether to also delete directories @@ -112,7 +112,7 @@ Example:: get_filenames() =============== -.. php:function:: get_filenames($source_dir, $include_path = FALSE) +.. 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 @@ -129,7 +129,7 @@ Example:: get_dir_file_info() =================== -.. php:function:: get_dir_file_info($source_dir, $top_level_only) +.. 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 @@ -148,7 +148,7 @@ Example:: get_file_info() =============== -.. php:function: get_file_info($file, $returned_values = array('name', 'server_path', 'size', 'date')) +.. 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 @@ -168,7 +168,7 @@ Valid ``$returned_values`` options are: `name`, `size`, `date`, `readable`, `wri get_mime_by_extension() ======================= -.. php:function:: get_mime_by_extension($filename) +.. function:: get_mime_by_extension($filename) :param string $filename: File name :returns: string or FALSE on failure @@ -188,7 +188,7 @@ Returns FALSE if it can't determine the type, or read the MIME config file. symbolic_permissions() ====================== -.. php:function:: symbolic_permissions($perms) +.. function:: symbolic_permissions($perms) :param int $perms: Permissions :returns: string @@ -203,7 +203,7 @@ standard symbolic notation of file permissions. octal_permissions() =================== -.. php:function:: octal_permissions($perms) +.. function:: octal_permissions($perms) :param int $perms: Permissions :returns: string diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst index b2a9b6f0f..e88a5de87 100644 --- a/user_guide_src/source/helpers/form_helper.rst +++ b/user_guide_src/source/helpers/form_helper.rst @@ -19,7 +19,7 @@ The following functions are available: form_open() =========== -.. php:function:: form_open($action = '', $attributes = '', $hidden = array()) +.. function:: form_open($action = '', $attributes = '', $hidden = array()) :param string $action: Form action/target URI string :param string $attributes: HTML attributes @@ -74,7 +74,7 @@ The above example would create a form similar to this:: form_open_multipart() ===================== -.. php:function:: form_open_multipart($action = '', $attributes = array(), $hidden = array()) +.. function:: form_open_multipart($action = '', $attributes = array(), $hidden = array()) :param string $action: Form action/target URI string :param string $attributes: HTML attributes @@ -88,7 +88,7 @@ would like to use the form to upload files with. form_hidden() ============= -.. php:function:: form_hidden($name, $value = '') +.. function:: form_hidden($name, $value = '') :param string $name: Field name :param string $value: Field value @@ -156,7 +156,7 @@ If you want to create hidden input fields with extra attributes:: form_input() ============ -.. php:function:: form_input($data = '', $value = '', $extra = '') +.. function:: form_input($data = '', $value = '', $extra = '') :param array $data: Field attributes data :param string $value: Field value @@ -197,7 +197,7 @@ JavaScript, you can pass it as a string in the third parameter:: form_password() =============== -.. php:function:: form_password($data = '', $value = '', $extra = '') +.. function:: form_password($data = '', $value = '', $extra = '') :param array $data: Field attributes data :param string $value: Field value @@ -210,7 +210,7 @@ function above except that it uses the "password" input type. form_upload() ============= -.. php:function:: form_upload($data = '', $value = '', $extra = '') +.. function:: form_upload($data = '', $value = '', $extra = '') :param array $data: Field attributes data :param string $value: Field value @@ -224,7 +224,7 @@ be used to upload files. form_textarea() =============== -.. php:function:: form_textarea($data = '', $value = '', $extra = '') +.. function:: form_textarea($data = '', $value = '', $extra = '') :param array $data: Field attributes data :param string $value: Field value @@ -240,7 +240,7 @@ function above except that it generates a "textarea" type. form_dropdown() =============== -.. php:function:: form_dropdown($name = '', $options = array(), $selected = array(), $extra = '') +.. 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 @@ -305,7 +305,7 @@ label. form_multiselect() ================== -.. php:function:: form_multiselect($name = '', $options = array(), $selected = array(), $extra = '') +.. function:: form_multiselect($name = '', $options = array(), $selected = array(), $extra = '') :param string $name: Field name :param array $options: An associative array of options to be listed @@ -325,7 +325,7 @@ syntax, e.g. foo[]. form_fieldset() =============== -.. php:function:: form_fieldset($legend_text = '', $attributes = array()) +.. function:: form_fieldset($legend_text = '', $attributes = array()) :param string $legend_text: Text to put in the <legend> tag :param array $attributes: Attributes to be set on the <fieldset> tag @@ -372,7 +372,7 @@ second parameter if you prefer to set additional attributes:: form_fieldset_close() ===================== -.. php:function:: form_fieldset_close($extra = '') +.. function:: form_fieldset_close($extra = '') :param string $extra: Anything to append after the closing tag, *as is* :returns: string @@ -390,7 +390,7 @@ the tag. For example form_checkbox() =============== -.. php:function:: form_checkbox($data = '', $value = '', $checked = FALSE, $extra = '') +.. function:: form_checkbox($data = '', $value = '', $checked = FALSE, $extra = '') :param array $data: Field attributes data :param string $value: Field value @@ -432,7 +432,7 @@ fourth parameter:: form_radio() ============ -.. php:function:: form_radio($data = '', $value = '', $checked = FALSE, $extra = '') +.. function:: form_radio($data = '', $value = '', $checked = FALSE, $extra = '') :param array $data: Field attributes data :param string $value: Field value @@ -446,7 +446,7 @@ function above except that it uses the "radio" input type. form_label() ============ -.. php:function:: form_label($label_text = '', $id = '', $attributes = array()) +.. function:: form_label($label_text = '', $id = '', $attributes = array()) :param string $label_text: Text to put in the <label> tag :param string $id: ID of the form element that we're making a label for @@ -474,7 +474,7 @@ Example:: form_submit() ============= -.. php:function:: form_submit($data = '', $value = '', $extra = '') +.. function:: form_submit($data = '', $value = '', $extra = '') :param string $data: Button name :param string $value: Button value @@ -493,7 +493,7 @@ parameter lets you add extra data to your form, like JavaScript. form_reset() ============ -.. php:function:: form_reset($data = '', $value = '', $extra = '') +.. function:: form_reset($data = '', $value = '', $extra = '') :param string $data: Button name :param string $value: Button value @@ -506,7 +506,7 @@ Lets you generate a standard reset button. Use is identical to form_button() ============= -.. php:function:: form_button($data = '', $content = '', $extra = '') +.. function:: form_button($data = '', $content = '', $extra = '') :param string $data: Button name :param string $content: Button label @@ -542,7 +542,7 @@ JavaScript, you can pass it as a string in the third parameter:: form_close() ============ -.. php:function:: form_close($extra = '') +.. function:: form_close($extra = '') :param string $extra: Anything to append after the closing tag, *as is* :returns: string @@ -558,7 +558,7 @@ the tag. For example:: form_prep() =========== -.. php:function:: form_prep($str = '', $is_textarea = FALSE) +.. function:: form_prep($str = '', $is_textarea = FALSE) :param string $str: Value to escape :param bool $is_textarea: Whether we're preparing for <textarea> or a regular input tag @@ -585,7 +585,7 @@ safely:: set_value() =========== -.. php:function:: set_value($field = '', $default = '', $is_textarea = FALSE) +.. function:: set_value($field = '', $default = '', $is_textarea = FALSE) :param string $field: Field name :param string $default: Default value @@ -606,7 +606,7 @@ The above form will show "0" when loaded for the first time. set_select() ============ -.. php:function:: set_select($field = '', $value = '', $default = FALSE) +.. function:: set_select($field = '', $value = '', $default = FALSE) :param string $field: Field name :param string $value: Value to check for @@ -631,7 +631,7 @@ Example:: set_checkbox() ============== -.. php:function:: set_checkbox($field = '', $value = '', $default = FALSE) +.. function:: set_checkbox($field = '', $value = '', $default = FALSE) :param string $field: Field name :param string $value: Value to check for @@ -652,7 +652,7 @@ Example:: set_radio() =========== -.. php:function:: set_radio($field = '', $value = '', $default = FALSE) +.. function:: set_radio($field = '', $value = '', $default = FALSE) :param string $field: Field name :param string $value: Value to check for @@ -676,7 +676,7 @@ Example:: form_error() ============ -.. php:function:: form_error($field = '', $prefix = '', $suffix = '') +.. function:: form_error($field = '', $prefix = '', $suffix = '') :param string $field: Field name :param string $prefix: Error opening tag @@ -698,7 +698,7 @@ Example:: validation_errors() =================== -.. php:function:: validation_errors($prefix = '', $suffix = '') +.. function:: validation_errors($prefix = '', $suffix = '') :param string $prefix: Error opening tag :param string $suffix: Error closing tag diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst index df53ebd2f..cc0f2d3ab 100644 --- a/user_guide_src/source/helpers/html_helper.rst +++ b/user_guide_src/source/helpers/html_helper.rst @@ -19,7 +19,7 @@ The following functions are available: br() ==== -.. php:function:: br($count = 1) +.. function:: br($count = 1) :param int $count: Number of times to repeat the tag :returns: string @@ -34,7 +34,7 @@ The above would produce: <br /><br /><br /> heading() ========= -.. php:function:: heading($data = '', $h = '1', $attributes = '') +.. function:: heading($data = '', $h = '1', $attributes = '') :param string $data: Content :param string $h: Heading level @@ -58,7 +58,7 @@ The above code produces: <h3 class="pink">Welcome!<<h3> img() ===== -.. php:function:: img($src = '', $index_page = FALSE, $attributes = '') +.. function:: img($src = '', $index_page = FALSE, $attributes = '') :param string $src: Image source data :param bool $index_page: Whether to treat $src as a routed URI string @@ -101,7 +101,7 @@ Example:: link_tag() ========== -.. php:function:: ling_tag($href = '', $rel = 'stylesheet', $type = 'text/css', $title = '', $media = '', $index_page = FALSE) +.. function:: ling_tag($href = '', $rel = 'stylesheet', $type = 'text/css', $title = '', $media = '', $index_page = FALSE) :param string $href: What are we linking to :param string $rel: Relation type @@ -148,7 +148,7 @@ for complete control over all attributes and values:: nbs() ===== -.. php:function:: nbs($num = 1) +.. function:: nbs($num = 1) :param int $num: Number of space entities to produce :returns: string @@ -165,7 +165,7 @@ The above would produce:: ul() and ol() ============= -.. php:function:: ul($list, $attributes = '') +.. function:: ul($list, $attributes = '') :param array $list: List entries :param array $attributes: HTML attributes @@ -280,7 +280,7 @@ The above code will produce this:: </li> </ul> -.. php:function:: ol($list, $attributes = '') +.. function:: ol($list, $attributes = '') :param array $list: List entries :param array $attributes: HTML attributes @@ -292,7 +292,7 @@ ordered lists instead of <ul>. meta() ====== -.. php:function:: meta($name = '', $content = '', $type = 'name', $newline = "\n") +.. function:: meta($name = '', $content = '', $type = 'name', $newline = "\n") :param string $name: Meta name :param string $content: Meta content @@ -349,7 +349,7 @@ Examples:: doctype() ========= -.. php:function:: doctype($type = 'xhtml1-strict') +.. function:: doctype($type = 'xhtml1-strict') :param string $type: Doctype name diff --git a/user_guide_src/source/helpers/inflector_helper.rst b/user_guide_src/source/helpers/inflector_helper.rst index 1f54b76c0..5f1dea736 100644 --- a/user_guide_src/source/helpers/inflector_helper.rst +++ b/user_guide_src/source/helpers/inflector_helper.rst @@ -19,7 +19,7 @@ The following functions are available: singular() ========== -.. php:function:: singular($str) +.. function:: singular($str) :param string $str: Input string :returns: string @@ -31,7 +31,7 @@ Changes a plural word to singular. Example:: plural() ======== -.. php:function:: plural($str) +.. function:: plural($str) :param string $str: Input string :returns: string @@ -43,7 +43,7 @@ Changes a singular word to plural. Example:: camelize() ========== -.. php:function:: camelize($str) +.. function:: camelize($str) :param string $str: Input string :returns: string @@ -56,7 +56,7 @@ case. Example:: underscore() ============ -.. php:function:: camelize($str) +.. function:: camelize($str) :param string $str: Input string :returns: string @@ -69,7 +69,7 @@ Example:: humanize() ========== -.. php:function:: camelize($str) +.. function:: camelize($str) :param string $str: Input string :param string $separator: Input separator @@ -89,7 +89,7 @@ To use dashes instead of underscores:: is_countable() ============== -.. php:function:: is_countable($word) +.. function:: is_countable($word) :param string $word: Input string :returns: bool diff --git a/user_guide_src/source/helpers/language_helper.rst b/user_guide_src/source/helpers/language_helper.rst index 1911e3bfd..2b2342f16 100644 --- a/user_guide_src/source/helpers/language_helper.rst +++ b/user_guide_src/source/helpers/language_helper.rst @@ -19,7 +19,7 @@ The following functions are available: lang() ====== -.. php:function:: lang($line, $for = '', $attributes = array()) +.. function:: lang($line, $for = '', $attributes = array()) :param string $line: Language line key :param string $for: HTML "for" attribute (ID of the element we're creating a label for) @@ -27,7 +27,7 @@ lang() :returns: string This function returns a line of text from a loaded language file with -simplified syntax that may be more desirable for view files than +simplified syntax that may be more desirable for view files than ``CI_Lang::line()``. Example:: diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst index 8e0ebda5e..4e12f9a27 100644 --- a/user_guide_src/source/helpers/number_helper.rst +++ b/user_guide_src/source/helpers/number_helper.rst @@ -19,7 +19,7 @@ The following functions are available: byte_format() ============= -.. php:function:: byte_format($num, $precision = 1) +.. function:: byte_format($num, $precision = 1) :param mixed $num: Number of bytes :param int $precision: Floating point precision @@ -27,7 +27,7 @@ byte_format() Formats numbers as bytes, based on size, and adds the appropriate suffix. Examples:: - + echo byte_format(456); // Returns 456 Bytes echo byte_format(4567); // Returns 4.5 KB echo byte_format(45678); // Returns 44.6 KB diff --git a/user_guide_src/source/helpers/path_helper.rst b/user_guide_src/source/helpers/path_helper.rst index 3a271b28f..863a5589e 100644 --- a/user_guide_src/source/helpers/path_helper.rst +++ b/user_guide_src/source/helpers/path_helper.rst @@ -19,7 +19,7 @@ The following functions are available: set_realpath() ============== -.. php:function:: set_realpath($path, $check_existance = FALSE) +.. function:: set_realpath($path, $check_existance = FALSE) :param string $path: Path :param bool $check_existance: Whether to check if the path actually exists @@ -40,7 +40,7 @@ Examples:: $directory = '/etc/php5'; echo set_realpath($directory); // Prints '/etc/php5/' - + $non_existent_directory = '/path/to/nowhere'; echo set_realpath($non_existent_directory, TRUE); // Shows an error, as the path cannot be resolved echo set_realpath($non_existent_directory, FALSE); // Prints '/path/to/nowhere'
\ No newline at end of file diff --git a/user_guide_src/source/helpers/security_helper.rst b/user_guide_src/source/helpers/security_helper.rst index 21bf53490..b06f78df6 100644 --- a/user_guide_src/source/helpers/security_helper.rst +++ b/user_guide_src/source/helpers/security_helper.rst @@ -18,7 +18,7 @@ The following functions are available: xss_clean() =========== -.. php:function:: xss_clean($str, $is_image = FALSE) +.. function:: xss_clean($str, $is_image = FALSE) :param string $str: Input data :param bool $is_image: Whether we're dealing with an image @@ -32,7 +32,7 @@ please see the :doc:`Input Library <../libraries/input>` documentation. sanitize_filename() =================== -.. php:function:: sanitize_filename($filename) +.. function:: sanitize_filename($filename) :param string $filename: Filename :returns: string @@ -46,7 +46,7 @@ documentation. do_hash() ========= -.. php:function:: do_hash($str, $type = 'sha1') +.. function:: do_hash($str, $type = 'sha1') :param string $str: Input :param string $type: Algorithm @@ -71,7 +71,7 @@ Examples:: strip_image_tags() ================== -.. php:function:: strip_image_tags($str) +.. function:: strip_image_tags($str) :param string $str: Input :returns: string @@ -90,7 +90,7 @@ documentation. encode_php_tags() ================= -.. php:function:: encode_php_tags($str) +.. function:: encode_php_tags($str) :param string $str: Input :returns: string diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst index 7069b465e..cfb4acb98 100644 --- a/user_guide_src/source/helpers/smiley_helper.rst +++ b/user_guide_src/source/helpers/smiley_helper.rst @@ -107,7 +107,7 @@ To map the alias to the field id, pass them both into the get_clickable_smileys() ======================= -.. php:function:: get_clickable_smileys($image_url, $alias = '', $smileys = NULL) +.. function:: get_clickable_smileys($image_url, $alias = '', $smileys = NULL) :param string $image_url: URL path to the smileys directory :param string $alias: Field alias @@ -124,7 +124,7 @@ Example:: smiley_js() =========== -.. php:function:: smiley_js($alias = '', $field_id = '', $inline = TRUE) +.. function:: smiley_js($alias = '', $field_id = '', $inline = TRUE) :param string $alias: Field alias :param string $field_id: Field ID @@ -143,7 +143,7 @@ Example:: parse_smileys() =============== -.. php:function:: parse_smileys($str = '', $image_url = '', $smileys = NULL) +.. function:: parse_smileys($str = '', $image_url = '', $smileys = NULL) :param string $str: Text containing smiley codes :param string $image_url: URL path to the smileys directory diff --git a/user_guide_src/source/helpers/string_helper.rst b/user_guide_src/source/helpers/string_helper.rst index d0d302476..b6417c2a6 100644 --- a/user_guide_src/source/helpers/string_helper.rst +++ b/user_guide_src/source/helpers/string_helper.rst @@ -19,7 +19,7 @@ The following functions are available: random_string() =============== -.. php:function:: random_string($type = 'alnum', $len = 8) +.. function:: random_string($type = 'alnum', $len = 8) :param string $type: Randomization type :param int $len: Output string length @@ -49,7 +49,7 @@ Usage example:: increment_string() ================== -.. php:function:: increment_string($str, $separator = '_', $first = 1) +.. function:: increment_string($str, $separator = '_', $first = 1) :param string $str: Input string :param string $separator: Separator to append a duplicate number with @@ -69,7 +69,7 @@ Usage example:: alternator() ============ -.. php:function:: alternator($args) +.. function:: alternator($args) :param mixed $args: A variable number of arguments :returns: mixed @@ -98,7 +98,7 @@ your loop the next item will be returned. repeater() ========== -.. php:function:: repeater($data, $num = 1) +.. function:: repeater($data, $num = 1) :param string $data: Input :param int $num: Number of times to repeat @@ -117,7 +117,7 @@ The above would generate 30 newlines. reduce_double_slashes() ======================= -.. php:function:: reduce_double_slashes($str) +.. function:: reduce_double_slashes($str) :param string $str: Input string :returns: string @@ -133,7 +133,7 @@ Example:: strip_slashes() =============== -.. php:function:: strip_slashes($data) +.. function:: strip_slashes($data) :param array $data: Input :returns: array @@ -141,14 +141,14 @@ strip_slashes() Removes any slashes from an array of strings. Example:: - + $str = array( 'question' => 'Is your name O\'reilly?', 'answer' => 'No, my name is O\'connor.' ); - + $str = strip_slashes($str); - + The above will return the following array:: array( @@ -163,7 +163,7 @@ The above will return the following array:: trim_slashes() ============== -.. php:function:: trim_slashes($str) +.. function:: trim_slashes($str) :param string $str: Input string :returns: string @@ -180,7 +180,7 @@ Removes any leading/trailing slashes from a string. Example:: reduce_multiples() ================== -.. php:function:: reduce_multiples($str, $character = '', $trim = FALSE) +.. function:: reduce_multiples($str, $character = '', $trim = FALSE) :param string $str: Text to search in :param string $character: Character to reduce @@ -202,7 +202,7 @@ character at the beginning and the end of the string. Example:: quotes_to_entities() ==================== -.. php:function:: quotes_to_entities($str) +.. function:: quotes_to_entities($str) :param string $str: Input string :returns: string @@ -216,7 +216,7 @@ entities. Example:: strip_quotes() ============== -.. php:function:: strip_quotes($str) +.. function:: strip_quotes($str) :param string $str: Input string :returns: string diff --git a/user_guide_src/source/helpers/text_helper.rst b/user_guide_src/source/helpers/text_helper.rst index aec36c9a7..773257220 100644 --- a/user_guide_src/source/helpers/text_helper.rst +++ b/user_guide_src/source/helpers/text_helper.rst @@ -19,7 +19,7 @@ The following functions are available: word_limiter() ============== -.. php:function:: word_limiter($str, $limit = 100, $end_char = '…') +.. function:: word_limiter($str, $limit = 100, $end_char = '…') :param string $str: Input string :param int $limit: Limit @@ -38,7 +38,7 @@ default it adds an ellipsis. character_limiter() =================== -.. php:function:: character_limiter($str, $n = 500, $end_char = '…') +.. function:: character_limiter($str, $n = 500, $end_char = '…') :param string $str: Input string :param int $n: Number of characters @@ -64,7 +64,7 @@ undeclared this helper uses an ellipsis. ascii_to_entities() =================== -.. php:function:: ascii_to_entities($str) +.. function:: ascii_to_entities($str) :param string $str: Input string :returns: string @@ -84,7 +84,7 @@ Example:: entities_to_ascii() =================== -.. php:function::entities_to_ascii($str, $all = TRUE) +.. function::entities_to_ascii($str, $all = TRUE) :param string $str: Input string :param bool $all: Whether to convert unsafe entities as well @@ -96,7 +96,7 @@ It turns character entities back into ASCII. convert_accented_characters() ============================= -.. php:function:: convert_accented_characters($str) +.. function:: convert_accented_characters($str) :param string $str: Input string :returns: string @@ -116,7 +116,7 @@ Example:: word_censor() ============= -.. php:function:: word_censor($str, $censored, $replacement = '') +.. function:: word_censor($str, $censored, $replacement = '') :param string $str: Input string :param array $censored: List of bad words to censor @@ -137,7 +137,7 @@ Example:: highlight_code() ================ -.. php:function:: highlight_code($str) +.. function:: highlight_code($str) :param string $str: Input string :returns: string @@ -152,7 +152,7 @@ colors used are the ones specified in your php.ini file. highlight_phrase() ================== -.. php:function:: highlight_phrase($str, $phrase, $tag_open = '<strong>', $tag_close = '</strong>') +.. function:: highlight_phrase($str, $phrase, $tag_open = '<strong>', $tag_close = '</strong>') :param string $str: Input string :param string $phrase: Phrase to highlight @@ -177,7 +177,7 @@ The above code prints:: word_wrap() =========== -.. php:function:: word_wrap($str, $charlim = 76) +.. function:: word_wrap($str, $charlim = 76) :param string $str: Input string :param int $charlim: Character limit @@ -198,7 +198,7 @@ Example:: ellipsize() =========== -.. php:function:: ellipsize($str, $max_length, $position = 1, $ellipsis = '…') +.. function:: ellipsize($str, $max_length, $position = 1, $ellipsis = '…') :param string $str: Input string :param int $max_length: String length limit diff --git a/user_guide_src/source/helpers/typography_helper.rst b/user_guide_src/source/helpers/typography_helper.rst index 3c81687ac..bce2d149d 100644 --- a/user_guide_src/source/helpers/typography_helper.rst +++ b/user_guide_src/source/helpers/typography_helper.rst @@ -19,7 +19,7 @@ The following functions are available: auto_typography() ================= -.. php:function:: auto_typography($str, $reduce_linebreaks = FALSE) +.. function:: auto_typography($str, $reduce_linebreaks = FALSE) :param string $str: Input string :param bool $reduce_linebreaks: Whether to reduce multiple instances of double newlines to two @@ -44,7 +44,7 @@ Usage example:: nl2br_except_pre() ================== -.. php:function:: nl2br_except_pre($str) +.. function:: nl2br_except_pre($str) :param string $str: Input string :returns: string @@ -60,7 +60,7 @@ Usage example:: entity_decode() =============== -.. php:function:: entity_decode($str, $charset = NULL) +.. function:: entity_decode($str, $charset = NULL) :param string $str: Input string :param string $charset: Character set |