[ci skip] Fix #3515
diff --git a/user_guide_src/source/libraries/benchmark.rst b/user_guide_src/source/libraries/benchmark.rst
index ddbe048..8fc06be 100644
--- a/user_guide_src/source/libraries/benchmark.rst
+++ b/user_guide_src/source/libraries/benchmark.rst
@@ -131,16 +131,16 @@
Class Reference
***************
-.. class:: CI_Benchmark
+.. php:class:: CI_Benchmark
- .. method:: mark($name)
+ .. php:method:: mark($name)
:param string $name: the name you wish to assign to your marker
:rtype: void
Sets a benchmark marker.
- .. method:: elapsed_time([$point1 = ''[, $point2 = ''[, $decimals = 4]]])
+ .. php:method:: elapsed_time([$point1 = ''[, $point2 = ''[, $decimals = 4]]])
:param string $point1: a particular marked point
:param string $point2: a particular marked point
@@ -156,7 +156,7 @@
swap the real value for this variable.
- .. method:: memory_usage()
+ .. php:method:: memory_usage()
:returns: Memory usage info
:rtype: string
diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index caece1a..86439b4 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -52,9 +52,9 @@
Class Reference
***************
-.. class:: CI_Cache
+.. php:class:: CI_Cache
- .. method:: is_supported($driver)
+ .. php:method:: is_supported($driver)
:param string $driver: the name of the caching driver
:returns: TRUE if supported, FALSE if not
@@ -74,7 +74,7 @@
}
}
- .. method:: get($id)
+ .. php:method:: get($id)
:param string $id: Cache item name
:returns: Item value or FALSE if not found
@@ -86,7 +86,7 @@
$foo = $this->cache->get('my_cached_item');
- .. method:: save($id, $data[, $ttl = 60[, $raw = FALSE]])
+ .. php:method:: save($id, $data[, $ttl = 60[, $raw = FALSE]])
:param string $id: Cache item name
:param mixed $data: the data to save
@@ -104,7 +104,7 @@
.. note:: The ``$raw`` parameter is only utilized by APC and Memcache,
in order to allow usage of ``increment()`` and ``decrement()``.
- .. method:: delete($id)
+ .. php:method:: delete($id)
:param string $id: name of cached item
:returns: TRUE on success, FALSE on failure
@@ -116,7 +116,7 @@
$this->cache->delete('cache_item_id');
- .. method:: increment($id[, $offset = 1])
+ .. php:method:: increment($id[, $offset = 1])
:param string $id: Cache ID
:param int $offset: Step/value to add
@@ -132,7 +132,7 @@
$this->cache->increment('iterator', 3); // 'iterator' is now 6
- .. method:: decrement($id[, $offset = 1])
+ .. php:method:: decrement($id[, $offset = 1])
:param string $id: Cache ID
:param int $offset: Step/value to reduce by
@@ -148,7 +148,7 @@
$this->cache->decrement('iterator', 2); // 'iterator' is now 3
- .. method:: clean()
+ .. php:method:: clean()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -159,7 +159,7 @@
$this->cache->clean();
- .. method:: cache_info()
+ .. php:method:: cache_info()
:returns: Information on the entire cache database
:rtype: mixed
@@ -172,7 +172,7 @@
.. note:: The information returned and the structure of the data is dependent
on which adapter is being used.
- .. method:: get_metadata($id)
+ .. php:method:: get_metadata($id)
:param string $id: Cache item name
:returns: Metadata for the cached item
diff --git a/user_guide_src/source/libraries/calendar.rst b/user_guide_src/source/libraries/calendar.rst
index 2083274..52883d2 100644
--- a/user_guide_src/source/libraries/calendar.rst
+++ b/user_guide_src/source/libraries/calendar.rst
@@ -213,9 +213,9 @@
Class Reference
***************
-.. class:: CI_Calendar
+.. php:class:: CI_Calendar
- .. method:: initialize([$config = array()])
+ .. php:method:: initialize([$config = array()])
:param array $config: Configuration parameters
:returns: CI_Calendar instance (method chaining)
@@ -223,7 +223,7 @@
Initializes the Calendaring preferences. Accepts an associative array as input, containing display preferences.
- .. method:: generate([$year = ''[, $month = ''[, $data = array()]]])
+ .. php:method:: generate([$year = ''[, $month = ''[, $data = array()]]])
:param int $year: Year
:param int $month: Month
@@ -234,7 +234,7 @@
Generate the calendar.
- .. method:: get_month_name($month)
+ .. php:method:: get_month_name($month)
:param int $month: Month
:returns: Month name
@@ -242,7 +242,7 @@
Generates a textual month name based on the numeric month provided.
- .. method:: get_day_names($day_type = '')
+ .. php:method:: get_day_names($day_type = '')
:param string $day_type: 'long', 'short', or 'abr'
:returns: Array of day names
@@ -253,7 +253,7 @@
if an invalid type is provided) this method will return the "abbreviated"
style.
- .. method:: adjust_date($month, $year)
+ .. php:method:: adjust_date($month, $year)
:param int $month: Month
:param int $year: Year
@@ -274,7 +274,7 @@
[year] => '2015'
)
- .. method:: get_total_days($month, $year)
+ .. php:method:: get_total_days($month, $year)
:param int $month: Month
:param int $year: Year
@@ -287,9 +287,9 @@
// 29
.. note:: This method is an alias for :doc:`Date Helper
- <../helpers/date_helper>` function :func:`days_in_month()`.
+ <../helpers/date_helper>` function :php:func:`days_in_month()`.
- .. method:: default_template()
+ .. php:method:: default_template()
:returns: An array of template values
:rtype: array
@@ -298,7 +298,7 @@
your own template.
- .. method:: parse_template()
+ .. php:method:: parse_template()
:returns: CI_Calendar instance (method chaining)
:rtype: CI_Calendar
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index 3c0a791..be34332 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -285,7 +285,7 @@
Class Reference
***************
-.. class:: CI_Cart
+.. php:class:: CI_Cart
.. attribute:: $product_id_rules = '\.a-z0-9_-'
@@ -302,7 +302,7 @@
Whether or not to only allow safe product names. Default TRUE.
- .. method:: insert([$items = array()])
+ .. php:method:: insert([$items = array()])
:param array $items: Items to insert into the cart
:returns: TRUE on success, FALSE on failure
@@ -312,7 +312,7 @@
on success and FALSE on failure.
- .. method:: update([$items = array()])
+ .. php:method:: update([$items = array()])
:param array $items: Items to update in the cart
:returns: TRUE on success, FALSE on failure
@@ -323,7 +323,7 @@
to the quantity before checkout. That array must contain the rowid
for each item.
- .. method:: remove($rowid)
+ .. php:method:: remove($rowid)
:param int $rowid: ID of the item to remove from the cart
:returns: TRUE on success, FALSE on failure
@@ -332,7 +332,7 @@
Allows you to remove an item from the shopping cart by passing it the
``$rowid``.
- .. method:: total()
+ .. php:method:: total()
:returns: Total amount
:rtype: int
@@ -340,7 +340,7 @@
Displays the total amount in the cart.
- .. method:: total_items()
+ .. php:method:: total_items()
:returns: Total amount of items in the cart
:rtype: int
@@ -348,7 +348,7 @@
Displays the total number of items in the cart.
- .. method:: contents([$newest_first = FALSE])
+ .. php:method:: contents([$newest_first = FALSE])
:param bool $newest_first: Whether to order the array with newest items first
:returns: An array of cart contents
@@ -359,7 +359,7 @@
will be sorted from newest to oldest, otherwise it is sorted from oldest
to newest.
- .. method:: get_item($row_id)
+ .. php:method:: get_item($row_id)
:param int $row_id: Row ID to retrieve
:returns: Array of item data
@@ -368,7 +368,7 @@
Returns an array containing data for the item matching the specified row
ID, or FALSE if no such item exists.
- .. method:: has_options($row_id = '')
+ .. php:method:: has_options($row_id = '')
:param int $row_id: Row ID to inspect
:returns: TRUE if options exist, FALSE otherwise
@@ -379,7 +379,7 @@
you must pass the rowid to this method, as shown in the Displaying
the Cart example above.
- .. method:: product_options([$row_id = ''])
+ .. php:method:: product_options([$row_id = ''])
:param int $row_id: Row ID
:returns: Array of product options
@@ -390,7 +390,7 @@
must pass the rowid to this method, as shown in the Displaying the
Cart example above.
- .. method:: destroy()
+ .. php:method:: destroy()
:rtype: void
diff --git a/user_guide_src/source/libraries/config.rst b/user_guide_src/source/libraries/config.rst
index 3116b76..3138e34 100644
--- a/user_guide_src/source/libraries/config.rst
+++ b/user_guide_src/source/libraries/config.rst
@@ -171,7 +171,7 @@
Class Reference
***************
-.. class:: CI_Config
+.. php:class:: CI_Config
.. attribute:: $config
@@ -182,7 +182,7 @@
Array of all loaded config files
- .. method:: item($item[, $index=''])
+ .. php:method:: item($item[, $index=''])
:param string $item: Config item name
:param string $index: Index name
@@ -191,7 +191,7 @@
Fetch a config file item.
- .. method:: set_item($item, $value)
+ .. php:method:: set_item($item, $value)
:param string $item: Config item name
:param string $value: Config item value
@@ -199,7 +199,7 @@
Sets a config file item to the specified value.
- .. method:: slash_item($item)
+ .. php:method:: slash_item($item)
:param string $item: config item name
:returns: Config item value with a trailing forward slash or NULL if not found
@@ -208,7 +208,7 @@
This method is identical to ``item()``, except it appends a forward
slash to the end of the item, if it exists.
- .. method:: load([$file = ''[, $use_sections = FALSE[, $fail_gracefully = FALSE]]])
+ .. php:method:: load([$file = ''[, $use_sections = FALSE[, $fail_gracefully = FALSE]]])
:param string $file: Configuration file name
:param bool $use_sections: Whether config values shoud be loaded into their own section (index of the main config array)
@@ -218,7 +218,7 @@
Loads a configuration file.
- .. method:: site_url()
+ .. php:method:: site_url()
:returns: Site URL
:rtype: string
@@ -229,7 +229,7 @@
This method is normally accessed via the corresponding functions in the
:doc:`URL Helper </helpers/url_helper>`.
- .. method:: base_url()
+ .. php:method:: base_url()
:returns: Base URL
:rtype: string
@@ -240,7 +240,7 @@
This method is normally accessed via the corresponding functions in the
:doc:`URL Helper </helpers/url_helper>`.
- .. method:: system_url()
+ .. php:method:: system_url()
:returns: URL pointing at your CI system/ directory
:rtype: string
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index ebfde80..54fb53f 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -141,9 +141,9 @@
Class Reference
***************
-.. class:: CI_Email
+.. php:class:: CI_Email
- .. method:: from($from[, $name = ''[, $return_path = NULL]])
+ .. php:method:: from($from[, $name = ''[, $return_path = NULL]])
:param string $from: "From" e-mail address
:param string $name: "From" display name
@@ -162,7 +162,7 @@
.. note:: Return-Path can't be used if you've configured 'smtp' as
your protocol.
- .. method:: reply_to($replyto[, $name = ''])
+ .. php:method:: reply_to($replyto[, $name = ''])
:param string $replyto: E-mail address for replies
:param string $name: Display name for the reply-to e-mail address
@@ -174,7 +174,7 @@
$this->email->reply_to('you@example.com', 'Your Name');
- .. method:: to($to)
+ .. php:method:: to($to)
:param mixed $to: Comma-delimited string or an array of e-mail addresses
:returns: CI_Email instance (method chaining)
@@ -195,7 +195,7 @@
array('one@example.com', 'two@example.com', 'three@example.com')
);
- .. method:: cc($cc)
+ .. php:method:: cc($cc)
:param mixed $cc: Comma-delimited string or an array of e-mail addresses
:returns: CI_Email instance (method chaining)
@@ -204,7 +204,7 @@
Sets the CC email address(s). Just like the "to", can be a single e-mail,
a comma-delimited list or an array.
- .. method:: bcc($bcc[, $limit = ''])
+ .. php:method:: bcc($bcc[, $limit = ''])
:param mixed $bcc: Comma-delimited string or an array of e-mail addresses
:param int $limit: Maximum number of e-mails to send per batch
@@ -218,7 +218,7 @@
the emails to batches, with each batch not exceeding the specified
``$limit``.
- .. method:: subject($subject)
+ .. php:method:: subject($subject)
:param string $subject: E-mail subject line
:returns: CI_Email instance (method chaining)
@@ -228,7 +228,7 @@
$this->email->subject('This is my subject');
- .. method:: message($body)
+ .. php:method:: message($body)
:param string $body: E-mail message body
:returns: CI_Email instance (method chaining)
@@ -238,7 +238,7 @@
$this->email->message('This is my message');
- .. method:: set_alt_message($str)
+ .. php:method:: set_alt_message($str)
:param string $str: Alternative e-mail message body
:returns: CI_Email instance (method chaining)
@@ -255,7 +255,7 @@
message CodeIgniter will extract the message from your HTML email
and strip the tags.
- .. method:: set_header($header, $value)
+ .. php:method:: set_header($header, $value)
:param string $header: Header name
:param string $value: Header value
@@ -267,7 +267,7 @@
$this->email->set_header('Header1', 'Value1');
$this->email->set_header('Header2', 'Value2');
- .. method:: clear([$clear_attachments = FALSE])
+ .. php:method:: clear([$clear_attachments = FALSE])
:param bool $clear_attachments: Whether or not to clear attachments
:returns: CI_Email instance (method chaining)
@@ -295,7 +295,7 @@
$this->email->clear(TRUE);
- .. method:: send([$auto_clear = TRUE])
+ .. php:method:: send([$auto_clear = TRUE])
:param bool $auto_clear: Whether to clear message data automatically
:returns: TRUE on success, FALSE on failure
@@ -320,7 +320,7 @@
.. note:: In order to use the ``print_debugger()`` method, you need
to avoid clearing the email parameters.
- .. method:: attach($filename[, $disposition = ''[, $newname = NULL[, $mime = '']]])
+ .. php:method:: attach($filename[, $disposition = ''[, $newname = NULL[, $mime = '']]])
:param string $filename: File name
:param string $disposition: 'disposition' of the attachment. Most
@@ -358,7 +358,7 @@
$this->email->attach($buffer, 'attachment', 'report.pdf', 'application/pdf');
- .. method:: attachment_cid($filename)
+ .. php:method:: attachment_cid($filename)
:param string $filename: Existing attachment filename
:returns: Attachment Content-ID or FALSE if not found
@@ -380,7 +380,7 @@
.. note:: Content-ID for each e-mail must be re-created for it to be unique.
- .. method:: print_debugger([$include = array('headers', 'subject', 'body')])
+ .. php:method:: print_debugger([$include = array('headers', 'subject', 'body')])
:param array $include: Which parts of the message to print out
:returns: Formatted debug data
diff --git a/user_guide_src/source/libraries/encrypt.rst b/user_guide_src/source/libraries/encrypt.rst
index 6b65099..67e2a01 100644
--- a/user_guide_src/source/libraries/encrypt.rst
+++ b/user_guide_src/source/libraries/encrypt.rst
@@ -80,9 +80,9 @@
Class Reference
***************
-.. class:: CI_Encrypt
+.. php:class:: CI_Encrypt
- .. method:: encode($string[, $key = ''])
+ .. php:method:: encode($string[, $key = ''])
:param string $string: Data to encrypt
:param string $key: Encryption key
@@ -103,7 +103,7 @@
$encrypted_string = $this->encrypt->encode($msg, $key);
- .. method:: decode($string[, $key = ''])
+ .. php:method:: decode($string[, $key = ''])
:param string $string: String to decrypt
:param string $key: Encryption key
@@ -124,7 +124,7 @@
$encrypted_string = $this->encrypt->decode($msg, $key);
- .. method:: set_cipher($cipher)
+ .. php:method:: set_cipher($cipher)
:param int $cipher: Valid PHP MCrypt cypher constant
:returns: CI_Encrypt instance (method chaining)
@@ -142,7 +142,7 @@
echo extension_loaded('mcrypt') ? 'Yup' : 'Nope';
- .. method:: set_mode($mode)
+ .. php:method:: set_mode($mode)
:param int $mode: Valid PHP MCrypt mode constant
:returns: CI_Encrypt instance (method chaining)
@@ -155,7 +155,7 @@
Please visit php.net for a list of `available modes <http://php.net/mcrypt>`_.
- .. method:: encode_from_legacy($string[, $legacy_mode = MCRYPT_MODE_ECB[, $key = '']])
+ .. php:method:: encode_from_legacy($string[, $legacy_mode = MCRYPT_MODE_ECB[, $key = '']])
:param string $string: String to encrypt
:param int $legacy_mode: Valid PHP MCrypt cipher constant
diff --git a/user_guide_src/source/libraries/encryption.rst b/user_guide_src/source/libraries/encryption.rst
index 2d0ee23..d445bf4 100644
--- a/user_guide_src/source/libraries/encryption.rst
+++ b/user_guide_src/source/libraries/encryption.rst
@@ -474,9 +474,9 @@
Class Reference
***************
-.. class:: CI_Encryption
+.. php:class:: CI_Encryption
- .. method:: initialize($params)
+ .. php:method:: initialize($params)
:param array $params: Configuration parameters
:returns: CI_Encryption instance (method chaining)
@@ -493,7 +493,7 @@
Please refer to the :ref:`configuration` section for detailed info.
- .. method:: encrypt($data[, $params = NULL])
+ .. php:method:: encrypt($data[, $params = NULL])
:param string $data: Data to encrypt
:param array $params: Optional parameters
@@ -509,7 +509,7 @@
Please refer to the :ref:`custom-parameters` section for information
on the optional parameters.
- .. method:: decrypt($data[, $params = NULL])
+ .. php:method:: decrypt($data[, $params = NULL])
:param string $data: Data to decrypt
:param array $params: Optional parameters
@@ -525,7 +525,7 @@
Please refer to the :ref:`custom-parameters` secrion for information
on the optional parameters.
- .. method:: hkdf($key[, $digest = 'sha512'[, $salt = NULL[, $length = NULL[, $info = '']]]])
+ .. php:method:: hkdf($key[, $digest = 'sha512'[, $salt = NULL[, $length = NULL[, $info = '']]]])
:param string $key: Input key material
:param string $digest: A SHA-2 family digest algorithm
diff --git a/user_guide_src/source/libraries/file_uploading.rst b/user_guide_src/source/libraries/file_uploading.rst
index d93acb8..ea2fef7 100644
--- a/user_guide_src/source/libraries/file_uploading.rst
+++ b/user_guide_src/source/libraries/file_uploading.rst
@@ -252,16 +252,16 @@
Class Reference
***************
-.. class:: CI_Upload
+.. php:class:: CI_Upload
- .. method:: initialize([array $config = array()[, $reset = TRUE]])
+ .. php:method:: initialize([array $config = array()[, $reset = TRUE]])
:param array $config: Preferences
:param bool $reset: Whether to reset preferences (that are not provided in $config) to their defaults
:returns: CI_Upload instance (method chaining)
:rtype: CI_Upload
- .. method:: do_upload([$field = 'userfile'])
+ .. php:method:: do_upload([$field = 'userfile'])
:param string $field: Name of the form field
:returns: TRUE on success, FALSE on failure
@@ -283,7 +283,7 @@
$field_name = "some_field_name";
$this->upload->do_upload($field_name);
- .. method:: display_errors([$open = '<p>'[, $close = '</p>']])
+ .. php:method:: display_errors([$open = '<p>'[, $close = '</p>']])
:param string $open: Opening markup
:param string $close: Closing markup
@@ -302,7 +302,7 @@
$this->upload->display_errors('<p>', '</p>');
- .. method:: data([$index = NULL])
+ .. php:method:: data([$index = NULL])
:param string $data: Element to return instead of the full array
:returns: Information about the uploaded file
diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index 2d05d1b..da43a4b 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -352,9 +352,9 @@
set_value('field name')
Open your myform.php view file and update the **value** in each field
-using the :func:`set_value()` function:
+using the :php:func:`set_value()` function:
-**Don't forget to include each field name in the :func:`set_value()`
+**Don't forget to include each field name in the :php:func:`set_value()`
function calls!**
::
@@ -643,7 +643,7 @@
===========================
If you prefer to show an error message next to each form field, rather
-than as a list, you can use the :func:`form_error()` function.
+than as a list, you can use the :php:func:`form_error()` function.
Try it! Change your form so that it looks like this::
@@ -1018,9 +1018,9 @@
Class Reference
***************
-.. class:: CI_Form_validation
+.. php:class:: CI_Form_validation
- .. method:: set_rules($field[, $label = ''[, $rules = '']])
+ .. php:method:: set_rules($field[, $label = ''[, $rules = '']])
:param string $field: Field name
:param string $label: Field label
@@ -1034,7 +1034,7 @@
- :ref:`setting-validation-rules`
- :ref:`saving-groups`
- .. method:: run([$group = ''])
+ .. php:method:: run([$group = ''])
:param string $group: The name of the validation group to run
:returns: TRUE on success, FALSE if validation failed
@@ -1044,7 +1044,7 @@
on failure. You can optionally pass the name of the validation group via
the method, as described in: :ref:`saving-groups`
- .. method:: set_message($lang[, $val = ''])
+ .. php:method:: set_message($lang[, $val = ''])
:param string $lang: The rule the message is for
:param string $val: The message
@@ -1053,7 +1053,7 @@
Permits you to set custom error messages. See :ref:`setting-error-messages`
- .. method:: set_error_delimiters([$prefix = '<p>'[, $suffix = '</p>']])
+ .. php:method:: set_error_delimiters([$prefix = '<p>'[, $suffix = '</p>']])
:param string $prefix: Error message prefix
:param string $suffix: Error message suffix
@@ -1062,7 +1062,7 @@
Sets the default prefix and suffix for error messages.
- .. method:: set_data($data)
+ .. php:method:: set_data($data)
:param array $data: Array of data validate
:returns: CI_Form_validation instance (method chaining)
@@ -1071,7 +1071,7 @@
Permits you to set an array for validation, instead of using the default
``$_POST`` array.
- .. method:: reset_validation()
+ .. php:method:: reset_validation()
:returns: CI_Form_validation instance (method chaining)
:rtype: CI_Form_validation
@@ -1079,14 +1079,14 @@
Permits you to reset the validation when you validate more than one array.
This method should be called before validating each new array.
- .. method:: error_array()
+ .. php:method:: error_array()
:returns: Array of error messages
:rtype: array
Returns the error messages as an array.
- .. method:: error_string([$prefix = ''[, $suffix = '']])
+ .. php:method:: error_string([$prefix = ''[, $suffix = '']])
:param string $prefix: Error message prefix
:param string $suffix: Error message suffix
@@ -1096,7 +1096,7 @@
Returns all error messages (as returned from error_array()) formatted as a
string and separated by a newline character.
- .. method:: error($field[, $prefix = ''[, $suffix = '']])
+ .. php:method:: error($field[, $prefix = ''[, $suffix = '']])
:param string $field: Field name
:param string $prefix: Optional prefix
@@ -1107,7 +1107,7 @@
Returns the error message for a specific field, optionally adding a
prefix and/or suffix to it (usually HTML tags).
- .. method:: has_rule($field)
+ .. php:method:: has_rule($field)
:param string $field: Field name
:returns: TRUE if the field has rules set, FALSE if not
@@ -1124,12 +1124,12 @@
Please refer to the :doc:`Form Helper <../helpers/form_helper>` manual for
the following functions:
-- :func:`form_error()`
-- :func:`validation_errors()`
-- :func:`set_value()`
-- :func:`set_select()`
-- :func:`set_checkbox()`
-- :func:`set_radio()`
+- :php:func:`form_error()`
+- :php:func:`validation_errors()`
+- :php:func:`set_value()`
+- :php:func:`set_select()`
+- :php:func:`set_checkbox()`
+- :php:func:`set_radio()`
Note that these are procedural functions, so they **do not** require you
to prepend them with ``$this->form_validation``.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/ftp.rst b/user_guide_src/source/libraries/ftp.rst
index 4be1a6e..ddd4442 100644
--- a/user_guide_src/source/libraries/ftp.rst
+++ b/user_guide_src/source/libraries/ftp.rst
@@ -90,9 +90,9 @@
Class Reference
***************
-.. class:: CI_FTP
+.. php:class:: CI_FTP
- .. method:: connect([$config = array()])
+ .. php:method:: connect([$config = array()])
:param array $config: Connection values
:returns: TRUE on success, FALSE on failure
@@ -135,7 +135,7 @@
**passive** TRUE TRUE/FALSE (boolean): Whether to use passive mode
============== =============== =============================================================================
- .. method:: upload($locpath, $rempath[, $mode = 'auto'[, $permissions = NULL]])
+ .. php:method:: upload($locpath, $rempath[, $mode = 'auto'[, $permissions = NULL]])
:param string $locpath: Local file path
:param string $rempath: Remote file path
@@ -154,7 +154,7 @@
If set, permissions have to be passed as an octal value.
- .. method:: download($rempath, $locpath[, $mode = 'auto'])
+ .. php:method:: download($rempath, $locpath[, $mode = 'auto'])
:param string $rempath: Remote file path
:param string $locpath: Local file path
@@ -172,7 +172,7 @@
Returns FALSE if the download does not execute successfully
(including if PHP does not have permission to write the local file).
- .. method:: rename($old_file, $new_file[, $move = FALSE])
+ .. php:method:: rename($old_file, $new_file[, $move = FALSE])
:param string $old_file: Old file name
:param string $new_file: New file name
@@ -186,7 +186,7 @@
// Renames green.html to blue.html
$this->ftp->rename('/public_html/foo/green.html', '/public_html/foo/blue.html');
- .. method:: move($old_file, $new_file)
+ .. php:method:: move($old_file, $new_file)
:param string $old_file: Old file name
:param string $new_file: New file name
@@ -200,7 +200,7 @@
.. note:: If the destination file name is different the file will be renamed.
- .. method:: delete_file($filepath)
+ .. php:method:: delete_file($filepath)
:param string $filepath: Path to file to delete
:returns: TRUE on success, FALSE on failure
@@ -211,7 +211,7 @@
$this->ftp->delete_file('/public_html/joe/blog.html');
- .. method:: delete_dir($filepath)
+ .. php:method:: delete_dir($filepath)
:param string $filepath: Path to directory to delete
:returns: TRUE on success, FALSE on failure
@@ -229,7 +229,7 @@
$this->ftp->delete_dir('/public_html/path/to/folder/');
- .. method:: list_files([$path = '.'])
+ .. php:method:: list_files([$path = '.'])
:param string $path: Directory path
:returns: An array list of files or FALSE on failure
@@ -242,7 +242,7 @@
$list = $this->ftp->list_files('/public_html/');
print_r($list);
- .. method:: mirror($locpath, $rempath)
+ .. php:method:: mirror($locpath, $rempath)
:param string $locpath: Local path
:param string $rempath: Remote path
@@ -256,7 +256,7 @@
$this->ftp->mirror('/path/to/myfolder/', '/public_html/myfolder/');
- .. method:: mkdir($path[, $permissions = NULL])
+ .. php:method:: mkdir($path[, $permissions = NULL])
:param string $path: Path to directory to create
:param int $permissions: Permissions (octal)
@@ -272,7 +272,7 @@
// Creates a folder named "bar"
$this->ftp->mkdir('/public_html/foo/bar/', 0755);
- .. method:: chmod($path, $perm)
+ .. php:method:: chmod($path, $perm)
:param string $path: Path to alter permissions for
:param int $perm: Permissions (octal)
@@ -285,7 +285,7 @@
// Chmod "bar" to 755
$this->ftp->chmod('/public_html/foo/bar/', 0755);
- .. method:: changedir($path[, $suppress_debug = FALSE])
+ .. php:method:: changedir($path[, $suppress_debug = FALSE])
:param string $path: Directory path
:param bool $suppress_debug: Whether to turn off debug messages for this command
@@ -297,7 +297,7 @@
The ``$suppress_debug`` parameter is useful in case you want to use this method
as an ``is_dir()`` alternative for FTP.
- .. method:: close()
+ .. php:method:: close()
:returns: TRUE on success, FALSE on failure
:rtype: bool
diff --git a/user_guide_src/source/libraries/image_lib.rst b/user_guide_src/source/libraries/image_lib.rst
index a52cf3e..ae2c847 100644
--- a/user_guide_src/source/libraries/image_lib.rst
+++ b/user_guide_src/source/libraries/image_lib.rst
@@ -316,9 +316,9 @@
Class Reference
***************
-.. class:: CI_Image_lib
+.. php:class:: CI_Image_lib
- .. method:: initialize([$props = array()])
+ .. php:method:: initialize([$props = array()])
:param array $props: Image processing preferences
:returns: TRUE on success, FALSE in case of invalid settings
@@ -326,7 +326,7 @@
Initializes the class for processing an image.
- .. method:: resize()
+ .. php:method:: resize()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -373,7 +373,7 @@
new_image) are used, the resizing method will instead target the
original image for processing.
- .. method:: crop()
+ .. php:method:: crop()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -409,7 +409,7 @@
in ExpressionEngine, the CMS we develop. We added a JavaScript UI that
lets the cropping area be selected.
- .. method:: rotate()
+ .. php:method:: rotate()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -441,7 +441,7 @@
echo $this->image_lib->display_errors();
}
- .. method:: watermark()
+ .. php:method:: watermark()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -449,7 +449,7 @@
Creates a watermark over an image, please refer to the :ref:`watermarking`
section for more info.
- .. method:: clear()
+ .. php:method:: clear()
:rtype: void
@@ -461,7 +461,7 @@
$this->image_lib->clear();
- .. method:: display_errors([$open = '<p>[, $close = '</p>']])
+ .. php:method:: display_errors([$open = '<p>[, $close = '</p>']])
:param string $open: Error message opening tag
:param string $close: Error message closing tag
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index 3bc0967..967f69d 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -112,9 +112,9 @@
Class Reference
***************
-.. class:: CI_Input
+.. php:class:: CI_Input
- .. method:: post([$index = NULL[, $xss_clean = NULL]])
+ .. php:method:: post([$index = NULL[, $xss_clean = NULL]])
:param mixed $index: POST parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -157,7 +157,7 @@
$this->input->post(array('field1', 'field2'), TRUE);
- .. method:: get([$index = NULL[, $xss_clean = NULL]])
+ .. php:method:: get([$index = NULL[, $xss_clean = NULL]])
:param mixed $index: GET parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -190,7 +190,7 @@
$this->input->get(array('field1', 'field2'), TRUE);
- .. method:: post_get($index[, $xss_clean = NULL])
+ .. php:method:: post_get($index[, $xss_clean = NULL])
:param string $index: POST/GET parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -203,7 +203,7 @@
$this->input->post_get('some_data', TRUE);
- .. method:: get_post($index[, $xss_clean = NULL])
+ .. php:method:: get_post($index[, $xss_clean = NULL])
:param string $index: GET/POST parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -218,7 +218,7 @@
.. note:: This method used to act EXACTLY like ``post_get()``, but it's
behavior has changed in CodeIgniter 3.0.
- .. method:: cookie([$index = NULL[, $xss_clean = NULL]])
+ .. php:method:: cookie([$index = NULL[, $xss_clean = NULL]])
:param mixed $index: COOKIE name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -238,10 +238,10 @@
$this->input->cookie(array('some_cookie', 'some_cookie2'));
.. note:: Unlike the :doc:`Cookie Helper <../helpers/cookie_helper>`
- function :func:`get_cookie()`, this method does NOT prepend
+ function :php:func:`get_cookie()`, this method does NOT prepend
your configured ``$config['cookie_prefix']`` value.
- .. method:: server($index[, $xss_clean = NULL])
+ .. php:method:: server($index[, $xss_clean = NULL])
:param mixed $index: Value name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -259,7 +259,7 @@
$this->input->server(array('SERVER_PROTOCOL', 'REQUEST_URI'));
- .. method:: input_stream([$index = NULL[, $xss_clean = NULL]])
+ .. php:method:: input_stream([$index = NULL[, $xss_clean = NULL]])
:param mixed $index: Key name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -269,7 +269,7 @@
This method is identical to ``get()``, ``post()`` and ``cookie()``,
only it fetches the *php://input* stream data.
- .. method:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]])
+ .. php:method:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]])
:param mixed $name: Cookie name or an array of parameters
:param string $value: Cookie value
@@ -332,7 +332,7 @@
$this->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure);
- .. method:: ip_address()
+ .. php:method:: ip_address()
:returns: Visitor's IP address or '0.0.0.0' if not valid
:rtype: string
@@ -347,7 +347,7 @@
HTTP_CLIENT_IP, HTTP_X_CLIENT_IP or HTTP_X_CLUSTER_CLIENT_IP
address for the allowed IP addresses.
- .. method:: valid_ip($ip[, $which = ''])
+ .. php:method:: valid_ip($ip[, $which = ''])
:param string $ip: IP address
:param string $which: IP protocol ('ipv4' or 'ipv6')
@@ -374,7 +374,7 @@
Accepts an optional second string parameter of 'ipv4' or 'ipv6' to specify
an IP format. The default checks for both formats.
- .. method:: user_agent([$xss_clean = NULL])
+ .. php:method:: user_agent([$xss_clean = NULL])
:returns: User agent string or NULL if not set
:param bool $xss_clean: Whether to apply XSS filtering
@@ -389,7 +389,7 @@
See the :doc:`User Agent Class <user_agent>` for methods which extract
information from the user agent string.
- .. method:: request_headers([$xss_clean = FALSE])
+ .. php:method:: request_headers([$xss_clean = FALSE])
:param bool $xss_clean: Whether to apply XSS filtering
:returns: An array of HTTP request headers
@@ -403,7 +403,7 @@
$headers = $this->input->request_headers();
- .. method:: get_request_header($index[, $xss_clean = FALSE])
+ .. php:method:: get_request_header($index[, $xss_clean = FALSE])
:param string $index: HTTP request header name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -416,7 +416,7 @@
$this->input->get_request_header('some-header', TRUE);
- .. method:: is_ajax_request()
+ .. php:method:: is_ajax_request()
:returns: TRUE if it is an Ajax request, FALSE if not
:rtype: bool
@@ -424,7 +424,7 @@
Checks to see if the HTTP_X_REQUESTED_WITH server header has been
set, and returns boolean TRUE if it is or FALSE if not.
- .. method:: is_cli_request()
+ .. php:method:: is_cli_request()
:returns: TRUE if it is a CLI request, FALSE if not
:rtype: bool
@@ -443,7 +443,7 @@
.. note:: This method is DEPRECATED and is now just an alias for the
:func:`is_cli()` function.
- .. method:: method([$upper = FALSE])
+ .. php:method:: method([$upper = FALSE])
:param bool $upper: Whether to return the request method name in upper or lower case
:returns: HTTP request method
diff --git a/user_guide_src/source/libraries/language.rst b/user_guide_src/source/libraries/language.rst
index e833d97..ee1cefc 100644
--- a/user_guide_src/source/libraries/language.rst
+++ b/user_guide_src/source/libraries/language.rst
@@ -169,7 +169,7 @@
-----------------------------------
This feature has been deprecated from the language library and moved to
-the :func:`lang()` function of the :doc:`Language Helper
+the :php:func:`lang()` function of the :doc:`Language Helper
<../helpers/language_helper>`.
Auto-loading Languages
@@ -185,9 +185,9 @@
Class Reference
***************
-.. class:: CI_Lang
+.. php:class:: CI_Lang
- .. method:: load($langfile[, $idiom = ''[, $return = FALSE[, $add_suffix = TRUE[, $alt_path = '']]]])
+ .. php:method:: load($langfile[, $idiom = ''[, $return = FALSE[, $add_suffix = TRUE[, $alt_path = '']]]])
:param mixed $langfile: Language file to load or array with multiple files
:param string $idiom: Language name (i.e. 'english')
@@ -199,7 +199,7 @@
Loads a language file.
- .. method:: line($line[, $log_errors = TRUE])
+ .. php:method:: line($line[, $log_errors = TRUE])
:param string $line: Language line key name
:param bool $log_errors: Whether to log an error if the line isn't found
diff --git a/user_guide_src/source/libraries/loader.rst b/user_guide_src/source/libraries/loader.rst
index 48ac6e1..efa9d51 100644
--- a/user_guide_src/source/libraries/loader.rst
+++ b/user_guide_src/source/libraries/loader.rst
@@ -77,9 +77,9 @@
Class Reference
***************
-.. class:: CI_Loader
+.. php:class:: CI_Loader
- .. method:: library($library[, $params = NULL[, $object_name = NULL]])
+ .. php:method:: library($library[, $params = NULL[, $object_name = NULL]])
:param mixed $library: Library name as a string or an array with multiple libraries
:param array $params: Optional array of parameters to pass to the loaded library's constructor
@@ -156,7 +156,7 @@
Please take note, when multiple libraries are supplied in an array for
the first parameter, this parameter is discarded.
- .. method:: driver($library[, $params = NULL[, $object_name]])
+ .. php:method:: driver($library[, $params = NULL[, $object_name]])
:param mixed $library: Library name as a string or an array with multiple libraries
:param array $params: Optional array of parameters to pass to the loaded library's constructor
@@ -217,7 +217,7 @@
// Session class is now accessed using:
$this->my_session
- .. method:: view($view[, $vars = array()[, return = FALSE]])
+ .. php:method:: view($view[, $vars = array()[, return = FALSE]])
:param string $view: View name
:param array $vars: An associative array of variables
@@ -251,7 +251,7 @@
$string = $this->load->view('myfile', '', TRUE);
- .. method:: vars($vars[, $val = ''])
+ .. php:method:: vars($vars[, $val = ''])
:param mixed $vars: An array of variables or a single variable name
:param mixed $val: Optional variable value
@@ -268,7 +268,7 @@
have multiple calls to this method. The data get cached and merged
into one array for conversion to variables.
- .. method:: get_var($key)
+ .. php:method:: get_var($key)
:param string $key: Variable name key
:returns: Value if key is found, NULL if not
@@ -278,21 +278,21 @@
your views. This is useful if for any reason a var is set in a library
or another controller method using ``$this->load->vars()``.
- .. method:: get_vars()
+ .. php:method:: get_vars()
:returns: An array of all assigned view variables
:rtype: array
This method retrieves all variables available to your views.
- .. method:: clear_vars()
+ .. php:method:: clear_vars()
:returns: CI_Loader instance (method chaining)
:rtype: CI_Loader
Clears cached view variables.
- .. method:: model($model[, $name = ''[, $db_conn = FALSE]])
+ .. php:method:: model($model[, $name = ''[, $db_conn = FALSE]])
:param mixed $model: Model name or an array containing multiple models
:param string $name: Optional object name to assign the model to
@@ -317,7 +317,7 @@
$this->load->model('model_name', 'fubar');
$this->fubar->method();
- .. method:: database([$params = ''[, $return = FALSE[, $query_builder = NULL]]])
+ .. php:method:: database([$params = ''[, $return = FALSE[, $query_builder = NULL]]])
:param mixed $params: Database group name or configuration options
:param bool $return: Whether to return the loaded database object
@@ -329,7 +329,7 @@
**optional**. Please see the :doc:`database <../database/index>`
section for more info.
- .. method:: dbforge([$db = NULL[, $return = FALSE]])
+ .. php:method:: dbforge([$db = NULL[, $return = FALSE]])
:param object $db: Database object
:param bool $return: Whether to return the Database Forge instance
@@ -339,7 +339,7 @@
Loads the :doc:`Database Forge <../database/forge>` class, please refer
to that manual for more info.
- .. method:: dbutil([$db = NULL[, $return = FALSE]])
+ .. php:method:: dbutil([$db = NULL[, $return = FALSE]])
:param object $db: Database object
:param bool $return: Whether to return the Database Utilities instance
@@ -349,7 +349,7 @@
Loads the :doc:`Database Utilities <../database/utilities>` class, please
refer to that manual for more info.
- .. method:: helper($helpers)
+ .. php:method:: helper($helpers)
:param mixed $helpers: Helper name as a string or an array containing multiple helpers
:returns: CI_Loader instance (method chaining)
@@ -358,7 +358,7 @@
This method loads helper files, where file_name is the name of the
file, without the _helper.php extension.
- .. method:: file($path[, $return = FALSE])
+ .. php:method:: file($path[, $return = FALSE])
:param string $path: File path
:param bool $return: Whether to return the loaded file
@@ -371,7 +371,7 @@
second parameter to boolean TRUE it will instead return the data as a
string.
- .. method:: language($files[, $lang = ''])
+ .. php:method:: language($files[, $lang = ''])
:param mixed $files: Language file name or an array of multiple language files
:param string $lang: Language name
@@ -381,7 +381,7 @@
This method is an alias of the :doc:`language loading
method <language>`: ``$this->lang->load()``.
- .. method:: config($file[, $use_sections = FALSE[, $fail_gracefully = FALSE]])
+ .. php:method:: config($file[, $use_sections = FALSE[, $fail_gracefully = FALSE]])
:param string $file: Configuration file name
:param bool $use_sections: Whether configuration values should be loaded into their own section
@@ -392,7 +392,7 @@
This method is an alias of the :doc:`config file loading
method <config>`: ``$this->config->load()``
- .. method:: is_loaded($class)
+ .. php:method:: is_loaded($class)
:param string $class: Class name
:returns: Singleton property name if found, FALSE if not
@@ -420,7 +420,7 @@
$this->load->is_loaded('Form_validation'); // returns 'fv'
- .. method:: add_package_path($path[, $view_cascade = TRUE])
+ .. php:method:: add_package_path($path[, $view_cascade = TRUE])
:param string $path: Path to add
:param bool $view_cascade: Whether to use cascading views
@@ -435,7 +435,7 @@
$this->load->add_package_path(APPPATH.'third_party/foo_bar/')
->library('foo_bar');
- .. method:: remove_package_path([$path = ''])
+ .. php:method:: remove_package_path([$path = ''])
:param string $path: Path to remove
:returns: CI_Loader instance (method chaining)
@@ -452,7 +452,7 @@
$this->load->remove_package_path(APPPATH.'third_party/foo_bar/');
- .. method:: get_package_paths([$include_base = TRUE])
+ .. php:method:: get_package_paths([$include_base = TRUE])
:param bool $include_base: Whether to include BASEPATH
:returns: An array of package paths
diff --git a/user_guide_src/source/libraries/migration.rst b/user_guide_src/source/libraries/migration.rst
index e8ea1d9..25be0c9 100644
--- a/user_guide_src/source/libraries/migration.rst
+++ b/user_guide_src/source/libraries/migration.rst
@@ -138,9 +138,9 @@
Class Reference
***************
-.. class:: CI_Migration
+.. php:class:: CI_Migration
- .. method:: current()
+ .. php:method:: current()
:returns: TRUE if no migrations are found, current version string on success, FALSE on failure
:rtype: mixed
@@ -148,21 +148,21 @@
Migrates up to the current version (whatever is set for
``$config['migration_version']`` in *application/config/migration.php*).
- .. method:: error_string()
+ .. php:method:: error_string()
:returns: Error messages
:rtype: string
This returns a string of errors that were detected while performing a migration.
- .. method:: find_migrations()
+ .. php:method:: find_migrations()
:returns: An array of migration files
:rtype: array
An array of migration filenames are returned that are found in the **migration_path** property.
- .. method:: latest()
+ .. php:method:: latest()
:returns: TRUE if no migrations are found, current version string on success, FALSE on failure
:rtype: mixed
@@ -171,7 +171,7 @@
the ``$config['migration_version']`` the Migration class will use the very
newest migration found in the filesystem.
- .. method:: version($target_version)
+ .. php:method:: version($target_version)
:param mixed $target_version: Migration version to process
:returns: TRUE if no migrations are found, current version string on success, FALSE on failure
diff --git a/user_guide_src/source/libraries/output.rst b/user_guide_src/source/libraries/output.rst
index e808561..4b36d2a 100644
--- a/user_guide_src/source/libraries/output.rst
+++ b/user_guide_src/source/libraries/output.rst
@@ -29,7 +29,7 @@
Class Reference
***************
-.. class:: CI_Output
+.. php:class:: CI_Output
.. attribute:: $parse_exec_vars = TRUE;
@@ -41,7 +41,7 @@
$this->output->parse_exec_vars = FALSE;
- .. method:: set_output($output)
+ .. php:method:: set_output($output)
:param string $output: String to set the output to
:returns: CI_Output instance (method chaining)
@@ -55,7 +55,7 @@
in the function you call it from. For example, if you build a page in one
of your controller methods, don't set the output until the end.
- .. method:: set_content_type($mime_type[, $charset = NULL])
+ .. php:method:: set_content_type($mime_type[, $charset = NULL])
:param string $mime_type: MIME Type idenitifer string
:param string $charset: Character set
@@ -80,7 +80,7 @@
$this->output->set_content_type('css', 'utf-8');
- .. method:: get_content_type()
+ .. php:method:: get_content_type()
:returns: Content-Type string
:rtype: string
@@ -92,7 +92,7 @@
.. note:: If not set, the default return value is 'text/html'.
- .. method:: get_header($header)
+ .. php:method:: get_header($header)
:param string $header: HTTP header name
:returns: HTTP response header or NULL if not found
@@ -109,7 +109,7 @@
.. note:: Raw headers sent via PHP's native ``header()`` function are also detected.
- .. method:: get_output()
+ .. php:method:: get_output()
:returns: Output string
:rtype: string
@@ -123,7 +123,7 @@
been previously sent to the output class by one of the CodeIgniter
functions like ``$this->load->view()``.
- .. method:: append_output($output)
+ .. php:method:: append_output($output)
:param string $output: Additional output data to append
:returns: CI_Output instance (method chaining)
@@ -134,7 +134,7 @@
$this->output->append_output($data);
- .. method:: set_header($header[, $replace = TRUE])
+ .. php:method:: set_header($header[, $replace = TRUE])
:param string $header: HTTP response header
:param bool $replace: Whether to replace the old header value, if it is already set
@@ -151,7 +151,7 @@
$this->output->set_header('Cache-Control: post-check=0, pre-check=0');
$this->output->set_header('Pragma: no-cache');
- .. method:: set_status_header([$code = 200[, $text = '']])
+ .. php:method:: set_status_header([$code = 200[, $text = '']])
:param int $code: HTTP status code
:param string $text: Optional message
@@ -168,7 +168,7 @@
.. note:: This method is an alias for :doc:`Common function <../general/common_functions>`
:func:`set_status_header()`.
- .. method:: enable_profiler([$val = TRUE])
+ .. php:method:: enable_profiler([$val = TRUE])
:param bool $val: Whether to enable or disable the Profiler
:returns: CI_Output instance (method chaining)
@@ -188,7 +188,7 @@
$this->output->enable_profiler(FALSE);
- .. method:: set_profiler_sections($sections)
+ .. php:method:: set_profiler_sections($sections)
:param array $sections: Profiler sections
:returns: CI_Output instance (method chaining)
@@ -197,7 +197,7 @@
Permits you to enable/disable specific sections of the Profiler when it is enabled.
Please refer to the :doc:`Profiler <../general/profiling>` documentation for further information.
- .. method:: cache($time)
+ .. php:method:: cache($time)
:param int $time: Cache expiration time in seconds
:returns: CI_Output instance (method chaining)
@@ -207,7 +207,7 @@
For more information, please see the :doc:`caching documentation <../general/caching>`.
- .. method:: _display([$output = ''])
+ .. php:method:: _display([$output = ''])
:param string $output: Output data override
:returns: void
diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
index d51d0dd..913717c 100644
--- a/user_guide_src/source/libraries/pagination.rst
+++ b/user_guide_src/source/libraries/pagination.rst
@@ -296,9 +296,9 @@
Class Reference
***************
-.. class:: CI_Pagination
+.. php:class:: CI_Pagination
- .. method:: initialize([$params = array()])
+ .. php:method:: initialize([$params = array()])
:param array $params: Configuration parameters
:returns: CI_Pagination instance (method chaining)
@@ -306,7 +306,7 @@
Initializes the Pagination class with your preferred options.
- .. method:: create_links()
+ .. php:method:: create_links()
:returns: HTML-formatted pagination
:rtype: string
diff --git a/user_guide_src/source/libraries/parser.rst b/user_guide_src/source/libraries/parser.rst
index d66684d..6c9d289 100644
--- a/user_guide_src/source/libraries/parser.rst
+++ b/user_guide_src/source/libraries/parser.rst
@@ -276,9 +276,9 @@
Class Reference
***************
-.. class:: CI_Parser
+.. php:class:: CI_Parser
- .. method:: parse($template, $data[, $return = FALSE])
+ .. php:method:: parse($template, $data[, $return = FALSE])
:param string $template: Path to view file
:param array $data: Variable data
@@ -288,7 +288,7 @@
Parses a template from the provided path and variables.
- .. method:: parse_string($template, $data[, $return = FALSE])
+ .. php:method:: parse_string($template, $data[, $return = FALSE])
:param string $template: Path to view file
:param array $data: Variable data
@@ -299,7 +299,7 @@
This method works exactly like ``parse()``, only it accepts
the template as a string instead of loading a view file.
- .. method:: set_delimiters([$l = '{'[, $r = '}']])
+ .. php:method:: set_delimiters([$l = '{'[, $r = '}']])
:param string $l: Left delimiter
:param string $r: Right delimiter
diff --git a/user_guide_src/source/libraries/security.rst b/user_guide_src/source/libraries/security.rst
index a39ef59..27e6e56 100644
--- a/user_guide_src/source/libraries/security.rst
+++ b/user_guide_src/source/libraries/security.rst
@@ -110,9 +110,9 @@
Class Reference
***************
-.. class:: CI_Security
+.. php:class:: CI_Security
- .. method:: xss_clean($str[, $is_image = FALSE])
+ .. php:method:: xss_clean($str[, $is_image = FALSE])
:param mixed $str: Input string or an array of strings
:returns: XSS-clean data
@@ -121,7 +121,7 @@
Tries to remove XSS exploits from the input data and returns the cleaned string.
If the optional second parameter is set to true, it will return boolean TRUE if the image is safe to use and FALSE if malicious data was detected in it.
- .. method:: sanitize_filename($str[, $relative_path = FALSE])
+ .. php:method:: sanitize_filename($str[, $relative_path = FALSE])
:param string $str: File name/path
:param bool $relative_path: Whether to preserve any directories in the file path
@@ -140,14 +140,14 @@
$filename = $this->security->sanitize_filename($this->input->post('filename'), TRUE);
- .. method:: get_csrf_token_name()
+ .. php:method:: get_csrf_token_name()
:returns: CSRF token name
:rtype: string
Returns the CSRF token name (the ``$config['csrf_token_name']`` value).
- .. method:: get_csrf_hash()
+ .. php:method:: get_csrf_hash()
:returns: CSRF hash
:rtype: string
@@ -155,7 +155,7 @@
Returns the CSRF hash value. Useful in combination with ``get_csrf_token_name()``
for manually building forms or sending valid AJAX POST requests.
- .. method:: entity_decode($str[, $charset = NULL])
+ .. php:method:: entity_decode($str[, $charset = NULL])
:param string $str: Input string
:param string $charset: Character set of the input string
@@ -167,7 +167,7 @@
If the ``$charset`` parameter is left empty, then your configured ``$config['charset']`` value will be used.
- .. method:: get_random_bytes($length)
+ .. php:method:: get_random_bytes($length)
:param int $length: Output length
:returns: A binary stream of random bytes or FALSE on failure
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 91dafde..bf0d7a4 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -768,9 +768,9 @@
Class Reference
***************
-.. class:: CI_Session
+.. php:class:: CI_Session
- .. method:: userdata([$key = NULL])
+ .. php:method:: userdata([$key = NULL])
:param mixed $key: Session item key or NULL
:returns: Value of the specified item key, or an array of all userdata
@@ -783,7 +783,7 @@
compatibility with older applications. You should
directly access ``$_SESSION`` instead.
- .. method:: all_userdata()
+ .. php:method:: all_userdata()
:returns: An array of all userdata
:rtype: array
@@ -793,7 +793,7 @@
.. note:: This method is DEPRECATED. Use ``userdata()``
with no parameters instead.
- .. method:: &get_usedata()
+ .. php:method:: &get_usedata()
:returns: A reference to ``$_SESSION``
:rtype: array
@@ -803,7 +803,7 @@
.. note:: This is a legacy method kept only for backwards
compatibility with older applications.
- .. method:: has_userdata($key)
+ .. php:method:: has_userdata($key)
:param string $key: Session item key
:returns: TRUE if the specified key exists, FALSE if not
@@ -816,7 +816,7 @@
an alias for ``isset($_SESSION[$key])`` - please
use that instead.
- .. method:: set_userdata($data[, $value = NULL])
+ .. php:method:: set_userdata($data[, $value = NULL])
:param mixed $data: An array of key/value pairs to set as session data, or the key for a single item
:param mixed $value: The value to set for a specific session item, if $data is a key
@@ -827,7 +827,7 @@
.. note:: This is a legacy method kept only for backwards
compatibility with older applications.
- .. method:: unset_userdata($key)
+ .. php:method:: unset_userdata($key)
:param mixed $key: Key for the session data item to unset, or an array of multiple keys
:rtype: void
@@ -840,7 +840,7 @@
an alias for ``unset($_SESSION[$key])`` - please
use that instead.
- .. method:: mark_as_flash($key)
+ .. php:method:: mark_as_flash($key)
:param mixed $key: Key to mark as flashdata, or an array of multiple keys
:returns: TRUE on success, FALSE on failure
@@ -849,7 +849,7 @@
Marks a ``$_SESSION`` item key (or multiple ones) as
"flashdata".
- .. method:: get_flash_keys()
+ .. php:method:: get_flash_keys()
:returns: Array containing the keys of all "flashdata" items.
:rtype: array
@@ -857,7 +857,7 @@
Gets a list of all ``$_SESSION`` that have been marked as
"flashdata".
- .. method:: umark_flash($key)
+ .. php:method:: umark_flash($key)
:param mixed $key: Key to be un-marked as flashdata, or an array of multiple keys
:rtype: void
@@ -865,7 +865,7 @@
Unmarks a ``$_SESSION`` item key (or multiple ones) as
"flashdata".
- .. method:: flashdata([$key = NULL])
+ .. php:method:: flashdata([$key = NULL])
:param mixed $key: Flashdata item key or NULL
:returns: Value of the specified item key, or an array of all flashdata
@@ -879,7 +879,7 @@
compatibility with older applications. You should
directly access ``$_SESSION`` instead.
- .. method:: keep_flashdata($key)
+ .. php:method:: keep_flashdata($key)
:param mixed $key: Flashdata key to keep, or an array of multiple keys
:returns: TRUE on success, FALSE on failure
@@ -892,7 +892,7 @@
compatibility with older applications. It is just
an alias for the ``mark_as_flash()`` method.
- .. method:: set_flashdata($data[, $value = NULL])
+ .. php:method:: set_flashdata($data[, $value = NULL])
:param mixed $data: An array of key/value pairs to set as flashdata, or the key for a single item
:param mixed $value: The value to set for a specific session item, if $data is a key
@@ -904,7 +904,7 @@
.. note:: This is a legacy method kept only for backwards
compatibility with older applications.
- .. method:: mark_as_temp($key[, $ttl = 300])
+ .. php:method:: mark_as_temp($key[, $ttl = 300])
:param mixed $key: Key to mark as tempdata, or an array of multiple keys
:param int $ttl: Time-to-live value for the tempdata, in seconds
@@ -914,7 +914,7 @@
Marks a ``$_SESSION`` item key (or multiple ones) as
"tempdata".
- .. method:: get_temp_keys()
+ .. php:method:: get_temp_keys()
:returns: Array containing the keys of all "tempdata" items.
:rtype: array
@@ -922,7 +922,7 @@
Gets a list of all ``$_SESSION`` that have been marked as
"tempdata".
- .. method:: umark_temp($key)
+ .. php:method:: umark_temp($key)
:param mixed $key: Key to be un-marked as tempdata, or an array of multiple keys
:rtype: void
@@ -930,7 +930,7 @@
Unmarks a ``$_SESSION`` item key (or multiple ones) as
"tempdata".
- .. method:: tempdata([$key = NULL])
+ .. php:method:: tempdata([$key = NULL])
:param mixed $key: Tempdata item key or NULL
:returns: Value of the specified item key, or an array of all tempdata
@@ -944,7 +944,7 @@
compatibility with older applications. You should
directly access ``$_SESSION`` instead.
- .. method:: set_tempdata($data[, $value = NULL])
+ .. php:method:: set_tempdata($data[, $value = NULL])
:param mixed $data: An array of key/value pairs to set as tempdata, or the key for a single item
:param mixed $value: The value to set for a specific session item, if $data is a key
@@ -957,7 +957,7 @@
.. note:: This is a legacy method kept only for backwards
compatibility with older applications.
- .. method:: sess_regenerate([$destroy = FALSE])
+ .. php:method:: sess_regenerate([$destroy = FALSE])
:param bool $destroy: Whether to destroy session data
:rtype: void
@@ -969,7 +969,7 @@
`session_regenerate_id()
<http://php.net/session_regenerate_id>`_ function.
- .. method:: sess_destroy()
+ .. php:method:: sess_destroy()
:rtype: void
@@ -983,7 +983,7 @@
`session_destroy()
<http://php.net/session_destroy>`_ function.
- .. method:: __get($key)
+ .. php:method:: __get($key)
:param string $key: Session item key
:returns: The requested session data item, or NULL if it doesn't exist
@@ -997,7 +997,7 @@
``session_id()`` if you try to access
``$this->session->session_id``.
- .. method:: __set($key, $value)
+ .. php:method:: __set($key, $value)
:param string $key: Session item key
:param mixed $value: Value to assign to the session item key
diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst
index bb001e8..91ae1ae 100644
--- a/user_guide_src/source/libraries/table.rst
+++ b/user_guide_src/source/libraries/table.rst
@@ -143,7 +143,7 @@
Class Reference
***************
-.. class:: CI_Table
+.. php:class:: CI_Table
.. attribute:: $function = NULL
@@ -162,7 +162,7 @@
<td>Fred</td><td><strong>Blue</strong></td><td>Small</td>
- .. method:: generate([$table_data = NULL])
+ .. php:method:: generate([$table_data = NULL])
:param mixed $table_data: Data to populate the table rows with
:returns: HTML table
@@ -170,7 +170,7 @@
Returns a string containing the generated table. Accepts an optional parameter which can be an array or a database result object.
- .. method:: set_caption($caption)
+ .. php:method:: set_caption($caption)
:param string $caption: Table caption
:returns: CI_Table instance (method chaining)
@@ -181,7 +181,7 @@
$this->table->set_caption('Colors');
- .. method:: set_heading([$args = array()[, ...]])
+ .. php:method:: set_heading([$args = array()[, ...]])
:param mixed $args: An array or multiple strings containing the table column titles
:returns: CI_Table instance (method chaining)
@@ -193,7 +193,7 @@
$this->table->set_heading(array('Name', 'Color', 'Size'));
- .. method:: add_row([$args = array()[, ...]])
+ .. php:method:: add_row([$args = array()[, ...]])
:param mixed $args: An array or multiple strings containing the row values
:returns: CI_Table instance (method chaining)
@@ -214,7 +214,7 @@
// generates
// <td class='highlight' colspan='2'>Blue</td><td>Red</td><td>Green</td>
- .. method:: make_columns([$array = array()[, $col_limit = 0]])
+ .. php:method:: make_columns([$array = array()[, $col_limit = 0]])
:param array $array: An array containing multiple rows' data
:param int $col_limit: Count of columns in the table
@@ -244,7 +244,7 @@
</table>
- .. method:: set_template($template)
+ .. php:method:: set_template($template)
:param array $template: An associative array containing template values
:returns: TRUE on success, FALSE on failure
@@ -259,7 +259,7 @@
$this->table->set_template($template);
- .. method:: set_empty($value)
+ .. php:method:: set_empty($value)
:param mixed $value: Value to put in empty cells
:returns: CI_Table instance (method chaining)
@@ -270,7 +270,7 @@
$this->table->set_empty(" ");
- .. method:: clear()
+ .. php:method:: clear()
:returns: CI_Table instance (method chaining)
:rtype: CI_Table
diff --git a/user_guide_src/source/libraries/trackback.rst b/user_guide_src/source/libraries/trackback.rst
index da7c319..4e0cb55 100644
--- a/user_guide_src/source/libraries/trackback.rst
+++ b/user_guide_src/source/libraries/trackback.rst
@@ -213,7 +213,7 @@
Class Reference
***************
-.. class:: CI_Trackback
+.. php:class:: CI_Trackback
.. attribute:: $data = array('url' => '', 'title' => '', 'excerpt' => '', 'blog_name' => '', 'charset' => '')
@@ -223,7 +223,7 @@
Whether to convert high ASCII and MS Word characters to HTML entities.
- .. method:: send($tb_data)
+ .. php:method:: send($tb_data)
:param array $tb_data: Trackback data
:returns: TRUE on success, FALSE on failure
@@ -231,7 +231,7 @@
Send trackback.
- .. method:: receive()
+ .. php:method:: receive()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -239,7 +239,7 @@
This method simply validates the incoming TB data, returning TRUE on success and FALSE on failure.
If the data is valid it is set to the ``$this->data`` array so that it can be inserted into a database.
- .. method:: send_error([$message = 'Incomplete information')
+ .. php:method:: send_error([$message = 'Incomplete information')
:param string $message: Error message
:rtype: void
@@ -248,7 +248,7 @@
.. note:: This method will terminate script execution.
- .. method:: send_success()
+ .. php:method:: send_success()
:rtype: void
@@ -256,7 +256,7 @@
.. note:: This method will terminate script execution.
- .. method:: data($item)
+ .. php:method:: data($item)
:param string $item: Data key
:returns: Data value or empty string if not found
@@ -264,7 +264,7 @@
Returns a single item from the reponse data array.
- .. method:: process($url, $data)
+ .. php:method:: process($url, $data)
:param string $url: Target url
:param string $data: Raw POST data
@@ -273,7 +273,7 @@
Opens a socket connection and passes the data to the server, returning TRUE on success and FALSE on failure.
- .. method:: extract_urls($urls)
+ .. php:method:: extract_urls($urls)
:param string $urls: Comma-separated URL list
:returns: Array of URLs
@@ -281,14 +281,14 @@
This method lets multiple trackbacks to be sent. It takes a string of URLs (separated by comma or space) and puts each URL into an array.
- .. method:: validate_url(&$url)
+ .. php:method:: validate_url(&$url)
:param string $url: Trackback URL
:rtype: void
Simply adds the *http://* prefix it it's not already present in the URL.
- .. method:: get_id($url)
+ .. php:method:: get_id($url)
:param string $url: Trackback URL
:returns: URL ID or FALSE on failure
@@ -296,7 +296,7 @@
Find and return a trackback URL's ID or FALSE on failure.
- .. method:: convert_xml($str)
+ .. php:method:: convert_xml($str)
:param string $str: Input string
:returns: Converted string
@@ -304,7 +304,7 @@
Converts reserved XML characters to entities.
- .. method:: limit_characters($str[, $n = 500[, $end_char = '…']])
+ .. php:method:: limit_characters($str[, $n = 500[, $end_char = '…']])
:param string $str: Input string
:param int $n: Max characters number
@@ -314,7 +314,7 @@
Limits the string based on the character count. Will preserve complete words.
- .. method:: convert_ascii($str)
+ .. php:method:: convert_ascii($str)
:param string $str: Input string
:returns: Converted string
@@ -322,14 +322,14 @@
Converts high ASCII text and MS Word special characterss to HTML entities.
- .. method:: set_error($msg)
+ .. php:method:: set_error($msg)
:param string $msg: Error message
:rtype: void
Set an log an error message.
- .. method:: display_errors([$open = '<p>'[, $close = '</p>']])
+ .. php:method:: display_errors([$open = '<p>'[, $close = '</p>']])
:param string $open: Open tag
:param string $close: Close tag
diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index 65fea9d..1d1e4f3 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -31,7 +31,7 @@
Class Reference
***************
-.. class:: CI_Typography
+.. php:class:: CI_Typography
.. attribute:: $protect_braced_quotes = FALSE
@@ -75,7 +75,7 @@
.. note:: Typographic formatting can be processor intensive, particularly if you have a lot of content being formatted.
If you choose to use this method you may want to consider :doc:`caching <../general/caching>` your pages.
- .. method:: format_characters($str)
+ .. php:method:: format_characters($str)
:param string $str: Input string
:returns: Formatted string
@@ -93,7 +93,7 @@
$string = $this->typography->format_characters($string);
- .. method:: nl2br_except_pre($str)
+ .. php:method:: nl2br_except_pre($str)
:param string $str: Input string
:returns: Formatted string
diff --git a/user_guide_src/source/libraries/unit_testing.rst b/user_guide_src/source/libraries/unit_testing.rst
index 7e91a7b..026781c 100644
--- a/user_guide_src/source/libraries/unit_testing.rst
+++ b/user_guide_src/source/libraries/unit_testing.rst
@@ -177,9 +177,9 @@
Class Reference
***************
-.. class:: CI_Unit_test
+.. php:class:: CI_Unit_test
- .. method:: set_test_items($items)
+ .. php:method:: set_test_items($items)
:param array $items: List of visible test items
:returns: void
@@ -195,7 +195,7 @@
- line
- notes
- .. method:: run($test[, $expected = TRUE[, $test_name = 'undefined'[, $notes = '']]])
+ .. php:method:: run($test[, $expected = TRUE[, $test_name = 'undefined'[, $notes = '']]])
:param mixed $test: Test data
:param mixed $expected: Expected result
@@ -206,7 +206,7 @@
Runs unit tests.
- .. method:: report([$result = array()])
+ .. php:method:: report([$result = array()])
:param array $result: Array containing tests results
:returns: Test report
@@ -214,21 +214,21 @@
Generates a report about already complete tests.
- .. method:: use_strict([$state = TRUE])
+ .. php:method:: use_strict([$state = TRUE])
:param bool $state: Strict state flag
:rtype: void
Enables/disables strict type comparison in tests.
- .. method:: active([$state = TRUE])
+ .. php:method:: active([$state = TRUE])
:param bool $state: Whether to enable testing
:rtype: void
Enables/disables unit testing.
- .. method:: result([$results = array()])
+ .. php:method:: result([$results = array()])
:param array $results: Tests results list
:returns: Array of raw result data
@@ -236,7 +236,7 @@
Returns raw tests results data.
- .. method:: set_template($template)
+ .. php:method:: set_template($template)
:param string $template: Test result template
:rtype: void
diff --git a/user_guide_src/source/libraries/uri.rst b/user_guide_src/source/libraries/uri.rst
index 7db758c..ae56184 100644
--- a/user_guide_src/source/libraries/uri.rst
+++ b/user_guide_src/source/libraries/uri.rst
@@ -20,9 +20,9 @@
Class Reference
***************
-.. class:: CI_URI
+.. php:class:: CI_URI
- .. method:: segment($n[, $no_result = NULL])
+ .. php:method:: segment($n[, $no_result = NULL])
:param int $n: Segment index number
:param mixed $no_result: What to return if the searched segment is not found
@@ -59,7 +59,7 @@
$product_id = $this->uri->segment(3);
}
- .. method:: rsegment($n[, $no_result = NULL])
+ .. php:method:: rsegment($n[, $no_result = NULL])
:param int $n: Segment index number
:param mixed $no_result: What to return if the searched segment is not found
@@ -70,7 +70,7 @@
a specific segment from your re-routed URI in the event you are
using CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
- .. method:: slash_segment($n[, $where = 'trailing'])
+ .. php:method:: slash_segment($n[, $where = 'trailing'])
:param int $n: Segment index number
:param string $where: Where to add the slash ('trailing' or 'leading')
@@ -91,7 +91,7 @@
#. /segment
#. /segment/
- .. method:: slash_rsegment($n[, $where = 'trailing'])
+ .. php:method:: slash_rsegment($n[, $where = 'trailing'])
:param int $n: Segment index number
:param string $where: Where to add the slash ('trailing' or 'leading')
@@ -103,7 +103,7 @@
are using CodeIgniter's :doc:`URI Routing <../general/routing>`
feature.
- .. method:: uri_to_assoc([$n = 3[, $default = array()]])
+ .. php:method:: uri_to_assoc([$n = 3[, $default = array()]])
:param int $n: Segment index number
:param array $default: Default values
@@ -145,7 +145,7 @@
Lastly, if a corresponding value is not found for a given key (if there
is an odd number of URI segments) the value will be set to NULL.
- .. method:: ruri_to_assoc([$n = 3[, $default = array()]])
+ .. php:method:: ruri_to_assoc([$n = 3[, $default = array()]])
:param int $n: Segment index number
:param array $default: Default values
@@ -156,7 +156,7 @@
an associative array using the re-routed URI in the event you are using
CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
- .. method:: assoc_to_uri($array)
+ .. php:method:: assoc_to_uri($array)
:param array $array: Input array of key/value pairs
:returns: URI string
@@ -170,7 +170,7 @@
// Produces: product/shoes/size/large/color/red
- .. method:: uri_string()
+ .. php:method:: uri_string()
:returns: URI string
:rtype: string
@@ -183,7 +183,7 @@
news/local/345
- .. method:: ruri_string()
+ .. php:method:: ruri_string()
:returns: Routed URI string
:rtype: string
@@ -192,14 +192,14 @@
the re-routed URI in the event you are using CodeIgniter's :doc:`URI
Routing <../general/routing>` feature.
- .. method:: total_segments()
+ .. php:method:: total_segments()
:returns: Count of URI segments
:rtype: int
Returns the total number of segments.
- .. method:: total_rsegments()
+ .. php:method:: total_rsegments()
:returns: Count of routed URI segments
:rtype: int
@@ -208,7 +208,7 @@
the total number of segments in your re-routed URI in the event you are
using CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
- .. method:: segment_array()
+ .. php:method:: segment_array()
:returns: URI segments array
:rtype: array
@@ -223,7 +223,7 @@
echo '<br />';
}
- .. method:: rsegment_array()
+ .. php:method:: rsegment_array()
:returns: Routed URI segments array
:rtype: array
diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst
index 517382a..a1d969a 100644
--- a/user_guide_src/source/libraries/user_agent.rst
+++ b/user_guide_src/source/libraries/user_agent.rst
@@ -72,9 +72,9 @@
Class Reference
***************
-.. class:: CI_User_agent
+.. php:class:: CI_User_agent
- .. method:: is_browser([$key = NULL])
+ .. php:method:: is_browser([$key = NULL])
:param string $key: Optional browser name
:returns: TRUE if the user agent is a (specified) browser, FALSE if not
@@ -96,7 +96,7 @@
You can find this list in **application/config/user_agents.php** if you want to add new
browsers or change the stings.
- .. method:: is_mobile([$key = NULL])
+ .. php:method:: is_mobile([$key = NULL])
:param string $key: Optional mobile device name
:returns: TRUE if the user agent is a (specified) mobile device, FALSE if not
@@ -118,7 +118,7 @@
$this->load->view('web/home');
}
- .. method:: is_robot([$key = NULL])
+ .. php:method:: is_robot([$key = NULL])
:param string $key: Optional robot name
:returns: TRUE if the user agent is a (specified) robot, FALSE if not
@@ -131,49 +131,49 @@
that commonly visit your site are missing from the list you can add them to your
**application/config/user_agents.php** file.
- .. method:: is_referral()
+ .. php:method:: is_referral()
:returns: TRUE if the user agent is a referral, FALSE if not
:rtype: bool
Returns TRUE/FALSE (boolean) if the user agent was referred from another site.
- .. method:: browser()
+ .. php:method:: browser()
:returns: Detected browser or an empty string
:rtype: string
Returns a string containing the name of the web browser viewing your site.
- .. method:: version()
+ .. php:method:: version()
:returns: Detected browser version or an empty string
:rtype: string
Returns a string containing the version number of the web browser viewing your site.
- .. method:: mobile()
+ .. php:method:: mobile()
:returns: Detected mobile device brand or an empty string
:rtype: string
Returns a string containing the name of the mobile device viewing your site.
- .. method:: robot()
+ .. php:method:: robot()
:returns: Detected robot name or an empty string
:rtype: string
Returns a string containing the name of the robot viewing your site.
- .. method:: platform()
+ .. php:method:: platform()
:returns: Detected operating system or an empty string
:rtype: string
Returns a string containing the platform viewing your site (Linux, Windows, OS X, etc.).
- .. method:: referrer()
+ .. php:method:: referrer()
:returns: Detected referrer or an empty string
:rtype: string
@@ -185,7 +185,7 @@
echo $this->agent->referrer();
}
- .. method:: agent_string()
+ .. php:method:: agent_string()
:returns: Full user agent string or an empty string
:rtype: string
@@ -194,7 +194,7 @@
Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.0.4) Gecko/20060613 Camino/1.0.2
- .. method:: accept_lang([$lang = 'en'])
+ .. php:method:: accept_lang([$lang = 'en'])
:param string $lang: Language key
:returns: TRUE if provided language is accepted, FALSE if not
@@ -210,14 +210,14 @@
.. note:: This method is not typically very reliable since some browsers do not provide language info,
and even among those that do, it is not always accurate.
- .. method:: languages()
+ .. php:method:: languages()
:returns: An array list of accepted languages
:rtype: array
Returns an array of languages supported by the user agent.
- .. method:: accept_charset([$charset = 'utf-8'])
+ .. php:method:: accept_charset([$charset = 'utf-8'])
:param string $charset: Character set
:returns: TRUE if the character set is accepted, FALSE if not
@@ -233,14 +233,14 @@
.. note:: This method is not typically very reliable since some browsers do not provide character-set info,
and even among those that do, it is not always accurate.
- .. method:: charsets()
+ .. php:method:: charsets()
:returns: An array list of accepted character sets
:rtype: array
Returns an array of character sets accepted by the user agent.
- .. method:: parse($string)
+ .. php:method:: parse($string)
:param string $string: A custom user-agent string
:rtype: void
diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst
index 5f1c917..4d7ed66 100644
--- a/user_guide_src/source/libraries/xmlrpc.rst
+++ b/user_guide_src/source/libraries/xmlrpc.rst
@@ -456,16 +456,16 @@
Class Reference
***************
-.. class:: CI_Xmlrpc
+.. php:class:: CI_Xmlrpc
- .. method:: initialize([$config = array()])
+ .. php:method:: initialize([$config = array()])
:param array $config: Configuration data
:rtype: void
Initializes the XML-RPC library. Accepts an associative array containing your settings.
- .. method:: server($url[, $port = 80[, $proxy = FALSE[, $proxy_port = 8080]]])
+ .. php:method:: server($url[, $port = 80[, $proxy = FALSE[, $proxy_port = 8080]]])
:param string $url: XML-RPC server URL
:param int $port: Server port
@@ -481,7 +481,7 @@
$this->xmlrpc->server('http://user:pass@localhost/', 80);
- .. method:: timeout($seconds = 5)
+ .. php:method:: timeout($seconds = 5)
:param int $seconds: Timeout in seconds
:rtype: void
@@ -490,7 +490,7 @@
$this->xmlrpc->timeout(6);
- .. method:: method($function)
+ .. php:method:: method($function)
:param string $function: Method name
:rtype: void
@@ -501,7 +501,7 @@
Where method is the name of the method.
- .. method:: request($incoming)
+ .. php:method:: request($incoming)
:param array $incoming: Request data
:rtype: void
@@ -511,7 +511,7 @@
$request = array(array('My Photoblog', 'string'), 'http://www.yoursite.com/photoblog/');
$this->xmlrpc->request($request);
- .. method:: send_request()
+ .. php:method:: send_request()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -525,7 +525,7 @@
Enables or disables debugging, which will display a variety of information and error data helpful during development.
- .. method:: display_error()
+ .. php:method:: display_error()
:returns: Error message string
:rtype: string
@@ -535,7 +535,7 @@
echo $this->xmlrpc->display_error();
- .. method:: display_response()
+ .. php:method:: display_response()
:returns: Response
:rtype: mixed
@@ -545,7 +545,7 @@
$this->xmlrpc->display_response();
- .. method:: send_error_message($number, $message)
+ .. php:method:: send_error_message($number, $message)
:param int $number: Error number
:param string $message: Error message
diff --git a/user_guide_src/source/libraries/zip.rst b/user_guide_src/source/libraries/zip.rst
index ce70e6c..816f49c 100644
--- a/user_guide_src/source/libraries/zip.rst
+++ b/user_guide_src/source/libraries/zip.rst
@@ -51,7 +51,7 @@
Class Reference
***************
-.. class:: CI_Zip
+.. php:class:: CI_Zip
.. attribute:: $compression_level = 2
@@ -61,7 +61,7 @@
$this->zip->compression_level = 0;
- .. method:: add_data($filepath[, $data = NULL])
+ .. php:method:: add_data($filepath[, $data = NULL])
:param mixed $filepath: A single file path or an array of file => data pairs
:param array $data: File contents (ignored if $filepath is an array)
@@ -100,7 +100,7 @@
The above example will place my_bio.txt inside a folder called personal.
- .. method:: add_dir($directory)
+ .. php:method:: add_dir($directory)
:param mixed $directory: Directory name string or an array of multiple directories
:rtype: void
@@ -111,7 +111,7 @@
$this->zip->add_dir('myfolder'); // Creates a directory called "myfolder"
- .. method:: read_file($path[, $archive_filepath = FALSE])
+ .. php:method:: read_file($path[, $archive_filepath = FALSE])
:param string $path: Path to file
:param mixed $archive_filepath: New file name/path (string) or (boolean) whether to maintain the original filepath
@@ -150,7 +150,7 @@
// Download ZIP archive containing /new/path/some_photo.jpg
$this->zip->download('my_archive.zip');
- .. method:: read_dir($path[, $preserve_filepath = TRUE[, $root_path = NULL]])
+ .. php:method:: read_dir($path[, $preserve_filepath = TRUE[, $root_path = NULL]])
:param string $path: Path to directory
:param bool $preserve_filepath: Whether to maintain the original path
@@ -180,7 +180,7 @@
This will create a ZIP with a directory named "directory" inside, then all sub-directories
stored correctly inside that, but will not include the */path/to/your* part of the path.
- .. method:: archive($filepath)
+ .. php:method:: archive($filepath)
:param string $filepath: Path to target zip archive
:returns: TRUE on success, FALSE on failure
@@ -192,7 +192,7 @@
$this->zip->archive('/path/to/folder/myarchive.zip'); // Creates a file named myarchive.zip
- .. method:: download($filename = 'backup.zip')
+ .. php:method:: download($filename = 'backup.zip')
:param string $filename: Archive file name
:rtype: void
@@ -206,7 +206,7 @@
this method since it sends various server headers that cause the
download to happen and the file to be treated as binary.
- .. method:: get_zip()
+ .. php:method:: get_zip()
:returns: Zip file content
:rtype: string
@@ -221,7 +221,7 @@
$zip_file = $this->zip->get_zip();
- .. method:: clear_data()
+ .. php:method:: clear_data()
:rtype: void