[ci skip] Fix #3515
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 69cc8ac..a0c0de8 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -64,52 +64,52 @@
- :doc:`Date Helper <helpers/date_helper>` changes include:
- - Added an optional third parameter to :func:`timespan()` that constrains the number of time units displayed.
- - Added an optional parameter to :func:`timezone_menu()` that allows more attributes to be added to the generated select tag.
- - Added function :func:`date_range()` that generates a list of dates between a specified period.
+ - Added an optional third parameter to :php:func:`timespan()` that constrains the number of time units displayed.
+ - Added an optional parameter to :php:func:`timezone_menu()` that allows more attributes to be added to the generated select tag.
+ - Added function :php:func:`date_range()` that generates a list of dates between a specified period.
- Deprecated ``standard_date()``, which now just uses the native ``date()`` with `DateTime constants <http://www.php.net/manual/en/class.datetime.php#datetime.constants.types>`_.
- - Changed :func:`now()` to work with all timezone strings supported by PHP.
- - Changed :func:`days_in_month()` to use the native ``cal_days_in_month()`` PHP function, if available.
+ - Changed :php:func:`now()` to work with all timezone strings supported by PHP.
+ - Changed :php:func:`days_in_month()` to use the native ``cal_days_in_month()`` PHP function, if available.
- :doc:`URL Helper <helpers/url_helper>` changes include:
- - Deprecated *separator* options **dash** and **underscore** for function :func:`url_title()` (they are only aliases for '-' and '_' respectively).
- - :func:`url_title()` will now trim extra dashes from beginning and end.
- - :func:`anchor_popup()` will now fill the *href* attribute with the URL and its JS code will return FALSE instead.
- - Added JS window name support to the :func:`anchor_popup()` function.
- - Added support for menubar attribute to the :func:`anchor_popup()`.
- - Added support (auto-detection) for HTTP/1.1 response codes 303, 307 in :func:`redirect()`.
- - Changed :func:`redirect()` to choose the **refresh** method only on IIS servers, instead of all servers on Windows (when **auto** is used).
- - Changed :func:`anchor()`, :func:`anchor_popup()`, and :func:`redirect()` to support protocol-relative URLs (e.g. *//ellislab.com/codeigniter*).
+ - Deprecated *separator* options **dash** and **underscore** for function :php:func:`url_title()` (they are only aliases for '-' and '_' respectively).
+ - :php:func:`url_title()` will now trim extra dashes from beginning and end.
+ - :php:func:`anchor_popup()` will now fill the *href* attribute with the URL and its JS code will return FALSE instead.
+ - Added JS window name support to the :php:func:`anchor_popup()` function.
+ - Added support for menubar attribute to the :php:func:`anchor_popup()`.
+ - Added support (auto-detection) for HTTP/1.1 response codes 303, 307 in :php:func:`redirect()`.
+ - Changed :php:func:`redirect()` to choose the **refresh** method only on IIS servers, instead of all servers on Windows (when **auto** is used).
+ - Changed :php:func:`anchor()`, :php:func:`anchor_popup()`, and :php:func:`redirect()` to support protocol-relative URLs (e.g. *//ellislab.com/codeigniter*).
- :doc:`HTML Helper <helpers/html_helper>` changes include:
- Added more doctypes.
- Changed application and environment config files to be loaded in a cascade-like manner.
- - Changed :func:`doctype()` to cache and only load once the doctypes array.
+ - Changed :php:func:`doctype()` to cache and only load once the doctypes array.
- Deprecated functions ``nbs()`` and ``br()``, which are just aliases for the native ``str_repeat()`` with `` `` and ``<br />`` respectively.
- :doc:`Inflector Helper <helpers/inflector_helper>` changes include:
- - Changed :func:`humanize()` to allow passing an input separator as its second parameter.
- - Changed :func:`humanize()` and :func:`underscore()` to utilize `mbstring <http://php.net/mbstring>`_, if available.
- - Changed :func:`plural()` and :func:`singular()` to avoid double pluralization and support more words.
+ - Changed :php:func:`humanize()` to allow passing an input separator as its second parameter.
+ - Changed :php:func:`humanize()` and :php:func:`underscore()` to utilize `mbstring <http://php.net/mbstring>`_, if available.
+ - Changed :php:func:`plural()` and :php:func:`singular()` to avoid double pluralization and support more words.
- :doc:`Download Helper <helpers/download_helper>` changes include:
- - Added an optional third parameter to :func:`force_download()` that enables/disables sending the actual file MIME type in the Content-Type header (disabled by default).
- - Added a work-around in :func:`force_download()` for a bug Android <= 2.1, where the filename extension needs to be in uppercase.
- - Added support for reading from an existing file path by passing NULL as the second parameter to :func:`force_download()` (useful for large files and/or safely transmitting binary data).
+ - Added an optional third parameter to :php:func:`force_download()` that enables/disables sending the actual file MIME type in the Content-Type header (disabled by default).
+ - Added a work-around in :php:func:`force_download()` for a bug Android <= 2.1, where the filename extension needs to be in uppercase.
+ - Added support for reading from an existing file path by passing NULL as the second parameter to :php:func:`force_download()` (useful for large files and/or safely transmitting binary data).
- :doc:`Form Helper <helpers/form_helper>` changes include:
- - :func:`form_dropdown()` will now also take an array for unity with other form helpers.
- - :func:`form_prep()` is now DEPRECATED and only acts as an alias for :doc:`common function <general/common_functions>` :func:`html_escape()`.
+ - :php:func:`form_dropdown()` will now also take an array for unity with other form helpers.
+ - :php:func:`form_prep()` is now DEPRECATED and only acts as an alias for :doc:`common function <general/common_functions>` :php:func:`html_escape()`.
- :doc:`Security Helper <helpers/security_helper>` changes include:
- - :func:`do_hash()` now uses PHP's native ``hash()`` function (supporting more algorithms) and is deprecated.
- - :func:`strip_image_tags()` is now an alias for the same method in the :doc:`Security Library <libraries/security>`.
+ - :php:func:`do_hash()` now uses PHP's native ``hash()`` function (supporting more algorithms) and is deprecated.
+ - :php:func:`strip_image_tags()` is now an alias for the same method in the :doc:`Security Library <libraries/security>`.
- :doc:`Smiley Helper <helpers/smiley_helper>` changes include:
@@ -120,15 +120,15 @@
- :doc:`File Helper <helpers/file_helper>` changes include:
- - :func:`set_realpath()` can now also handle file paths as opposed to just directories.
- - Added an optional paramater to :func:`delete_files()` to enable it to skip deleting files such as *.htaccess* and *index.html*.
+ - :php:func:`set_realpath()` can now also handle file paths as opposed to just directories.
+ - Added an optional paramater to :php:func:`delete_files()` to enable it to skip deleting files such as *.htaccess* and *index.html*.
- Deprecated function ``read_file()`` - it's just an alias for PHP's native ``file_get_contents()``.
- :doc:`String Helper <helpers/string_helper>` changes include:
- Deprecated function ``repeater()`` - it's just an alias for PHP's native ``str_repeat()``.
- Deprecated function ``trim_slashes()`` - it's just an alias for PHP's native ``trim()`` (with a slash as its second argument).
- - Deprecated randomization type options **unique** and **encrypt** for funcion :func:`random_string()` (they are only aliases for **md5** and **sha1** respectively).
+ - Deprecated randomization type options **unique** and **encrypt** for funcion :php:func:`random_string()` (they are only aliases for **md5** and **sha1** respectively).
- :doc:`CAPTCHA Helper <helpers/captcha_helper>` changes include:
@@ -141,12 +141,12 @@
- :doc:`Text Helper <helpers/text_helper>` changes include:
- - Changed the default tag for use in :func:`highlight_phrase()` to ``<mark>`` (formerly ``<strong>``).
- - Changed :func:`character_limiter()`, :func:`word_wrap()` and :func:`ellipsize()` to utilize `mbstring <http://php.net/mbstring>`_ or `iconv <http://php.net/iconv>`_, if available.
+ - Changed the default tag for use in :php:func:`highlight_phrase()` to ``<mark>`` (formerly ``<strong>``).
+ - Changed :php:func:`character_limiter()`, :php:func:`word_wrap()` and :php:func:`ellipsize()` to utilize `mbstring <http://php.net/mbstring>`_ or `iconv <http://php.net/iconv>`_, if available.
- - :doc:`Directory Helper <helpers/directory_helper>` :func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
- - :doc:`Array Helper <helpers/array_helper>` :func:`element()` and :func:`elements()` now return NULL instead of FALSE when the required elements don't exist.
- - :doc:`Language Helper <helpers/language_helper>` :func:`lang()` now accepts an optional list of additional HTML attributes.
+ - :doc:`Directory Helper <helpers/directory_helper>` :php:func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
+ - :doc:`Array Helper <helpers/array_helper>` :php:func:`element()` and :php:func:`elements()` now return NULL instead of FALSE when the required elements don't exist.
+ - :doc:`Language Helper <helpers/language_helper>` :php:func:`lang()` now accepts an optional list of additional HTML attributes.
- Deprecated the :doc:`Email Helper <helpers/email_helper>` as its ``valid_email()``, ``send_email()`` functions are now only aliases for PHP native functions ``filter_var()`` and ``mail()`` respectively.
- Database
@@ -318,7 +318,7 @@
- Added configuration to generate days of other months instead of blank cells.
- Added auto-configuration for *next_prev_url* if it is empty and *show_prev_next* is set to TRUE.
- Added support for templating via an array in addition to the encoded string.
- - Changed method ``get_total_days()`` to be an alias for :doc:`Date Helper <helpers/date_helper>` :func:`days_in_month()`.
+ - Changed method ``get_total_days()`` to be an alias for :doc:`Date Helper <helpers/date_helper>` :php:func:`days_in_month()`.
- :doc:`Cart Library <libraries/cart>` changes include:
@@ -489,23 +489,23 @@
- Changed method ``_fetch_from_array()`` to parse array notation in field name.
- Changed method ``_fetch_from_array()`` to allow retrieving multiple fields at once.
- Added an option for ``_clean_input_keys()`` to return FALSE instead of terminating the whole script.
- - Deprecated the ``is_cli_request()`` method, it is now an alias for the new :func:`is_cli()` common function.
+ - Deprecated the ``is_cli_request()`` method, it is now an alias for the new :php:func:`is_cli()` common function.
- Added an ``$xss_clean`` parameter to method ``user_agent()`` and removed the ``$user_agent`` property.
- :doc:`Common functions <general/common_functions>` changes include:
- - Added function :func:`get_mimes()` to return the *application/config/mimes.php* array.
- - Added support for HTTP code 303 ("See Other") in :func:`set_status_header()`.
- - Removed redundant conditional to determine HTTP server protocol in :func:`set_status_header()`.
+ - Added function :php:func:`get_mimes()` to return the *application/config/mimes.php* array.
+ - Added support for HTTP code 303 ("See Other") in :php:func:`set_status_header()`.
+ - Removed redundant conditional to determine HTTP server protocol in :php:func:`set_status_header()`.
- Renamed ``_exception_handler()`` to ``_error_handler()`` and replaced it with a real exception handler.
- Changed ``_error_handler()`` to respect php.ini *display_errors* setting.
- - Added function :func:`is_https()` to check if a secure connection is used.
- - Added function :func:`is_cli()` to replace the ``CI_Input::is_cli_request()`` method.
- - Added function :func:`function_usable()` to work around a bug in `Suhosin <http://www.hardened-php.net/suhosin/>`.
- - Removed the third (`$php_error`) argument from function :func:`log_message()`.
+ - Added function :php:func:`is_https()` to check if a secure connection is used.
+ - Added function :php:func:`is_cli()` to replace the ``CI_Input::is_cli_request()`` method.
+ - Added function :php:func:`function_usable()` to work around a bug in `Suhosin <http://www.hardened-php.net/suhosin/>`.
+ - Removed the third (`$php_error`) argument from function :php:func:`log_message()`.
- Changed internal function ``load_class()`` to accept a constructor parameter instead of (previously unused) class name prefix.
- - Removed default parameter value of :func:`is_php()`.
- - Added a second argument ``$double_encode`` to :func:`html_escape()`.
+ - Removed default parameter value of :php:func:`is_php()`.
+ - Added a second argument ``$double_encode`` to :php:func:`html_escape()`.
- Changed function ``config_item()`` to return NULL instead of FALSE when no value is found.
- :doc:`Output Library <libraries/output>` changes include:
@@ -578,13 +578,13 @@
- Fixed a bug (#181) - a typo in the form validation language file.
- Fixed a bug (#159, #163) - :doc:`Query Builder <database/query_builder>` nested transactions didn't work properly due to ``$_trans_depth`` not being incremented.
- Fixed a bug (#737, #75) - :doc:`Pagination <libraries/pagination>` anchor class was not set properly when using initialize method.
-- Fixed a bug (#419) - :doc:`URL Helper <helpers/url_helper>` :func:`auto_link()` didn't recognize URLs that come after a word boundary.
+- Fixed a bug (#419) - :doc:`URL Helper <helpers/url_helper>` :php:func:`auto_link()` didn't recognize URLs that come after a word boundary.
- Fixed a bug (#724) - :doc:`Form Validation Library <libraries/form_validation>` rule **is_unique** didn't check if a database connection exists.
- Fixed a bug (#647) - :doc:`Zip Library <libraries/zip>` internal method ``_get_mod_time()`` didn't suppress possible "stat failed" errors generated by ``filemtime()``.
- Fixed a bug (#157, #174) - :doc:`Image Manipulation Library <libraries/image_lib>` method ``clear()`` didn't completely clear properties.
- Fixed a bug where :doc:`Database Forge <database/forge>` method ``create_table()`` with PostgreSQL database could lead to fetching the whole table.
-- Fixed a bug (#795) - :doc:`Form Helper <helpers/form_helper>` :func:`form_open()` didn't add the default form *method* and *accept-charset* when an empty array is passed to it.
-- Fixed a bug (#797) - :doc:`Date Helper <helpers/date_helper>` :func:`timespan()` was using incorrect seconds for year and month.
+- Fixed a bug (#795) - :doc:`Form Helper <helpers/form_helper>` :php:func:`form_open()` didn't add the default form *method* and *accept-charset* when an empty array is passed to it.
+- Fixed a bug (#797) - :doc:`Date Helper <helpers/date_helper>` :php:func:`timespan()` was using incorrect seconds for year and month.
- Fixed a bug in :doc:`Cart Library <libraries/cart>` method ``contents()`` where if called without a TRUE (or equal) parameter, it would fail due to a typo.
- Fixed a bug (#406) - SQLSRV DB driver not returning resource on ``db_pconnect()``.
- Fixed a bug in :doc:`Image Manipulation Library <libraries/image_lib>` method ``gd_loaded()`` where it was possible for the script execution to end or a PHP E_WARNING message to be emitted.
@@ -658,24 +658,24 @@
- Fixed a bug in :doc:`Query Builder <database/query_builder>` method ``protect_identifiers()`` where if passed along with the field names, operators got escaped as well.
- Fixed a bug (#10) - :doc:`URI Library <libraries/uri>` internal method ``_detect_uri()`` failed with paths containing a colon.
- Fixed a bug (#1387) - :doc:`Query Builder <database/query_builder>` method ``from()`` didn't escape table aliases.
-- Fixed a bug (#520) - :doc:`Date Helper <helpers/date_helper>` function :func:``nice_date()`` failed when the optional second parameter is not passed.
+- Fixed a bug (#520) - :doc:`Date Helper <helpers/date_helper>` function :php:func:``nice_date()`` failed when the optional second parameter is not passed.
- Fixed a bug (#167) - ``$config['permitted_uri_chars']`` didn't affect URL-encoded characters.
- Fixed a bug (#318) - :doc:`Profiling Library <general/profiling>` setting *query_toggle_count* was not settable as described in the manual.
- Fixed a bug (#938) - :doc:`Config Library <libraries/config>` method ``site_url()`` added a question mark to the URL string when query strings are enabled even if it already existed.
- Fixed a bug (#999) - :doc:`Config Library <libraries/config>` method ``site_url()`` always appended ``$config['url_suffix']`` to the end of the URL string, regardless of whether a query string exists in it.
-- Fixed a bug where :doc:`URL Helper <helpers/url_helper>` function :func:`anchor_popup()` ignored the attributes argument if it is not an array.
+- Fixed a bug where :doc:`URL Helper <helpers/url_helper>` function :php:func:`anchor_popup()` ignored the attributes argument if it is not an array.
- Fixed a bug (#1328) - :doc:`Form Validation Library <libraries/form_validation>` didn't properly check the type of the form fields before processing them.
- Fixed a bug (#79) - :doc:`Form Validation Library <libraries/form_validation>` didn't properly validate array fields that use associative keys or have custom indexes.
- Fixed a bug (#427) - :doc:`Form Validation Library <libraries/form_validation>` method ``strip_image_tags()`` was an alias to a non-existent method.
- Fixed a bug (#1545) - :doc:`Query Builder <database/query_builder>` method ``limit()`` wasn't executed properly under Oracle.
-- Fixed a bug (#1551) - :doc:`Date Helper <helpers/date_helper>` function :func:`standard_date()` didn't properly format *W3C* and *ATOM* standard dates.
+- Fixed a bug (#1551) - :doc:`Date Helper <helpers/date_helper>` function :php:func:`standard_date()` didn't properly format *W3C* and *ATOM* standard dates.
- Fixed a bug where :doc:`Query Builder <database/query_builder>` method ``join()`` escaped literal values as if they were fields.
- Fixed a bug (#135) - PHP Error logging was impossible without the errors being displayed.
-- Fixed a bug (#1613) - :doc:`Form Helper <helpers/form_helper>` functions :func:`form_multiselect()`, :func:`form_dropdown()` didn't properly handle empty array option groups.
+- Fixed a bug (#1613) - :doc:`Form Helper <helpers/form_helper>` functions :php:func:`form_multiselect()`, :php:func:`form_dropdown()` didn't properly handle empty array option groups.
- Fixed a bug (#1605) - :doc:`Pagination Library <libraries/pagination>` produced incorrect *previous* and *next* link values.
- Fixed a bug in SQLSRV's ``affected_rows()`` method where an erroneous function name was used.
- Fixed a bug (#1000) - Change syntax of ``$view_file`` to ``$_ci_view_file`` to prevent being overwritten by application.
-- Fixed a bug (#1757) - :doc:`Directory Helper <helpers/directory_helper>` function :func:`directory_map()` was skipping files and directories named '0'.
+- Fixed a bug (#1757) - :doc:`Directory Helper <helpers/directory_helper>` function :php:func:`directory_map()` was skipping files and directories named '0'.
- Fixed a bug (#1789) - :doc:`Database Library <database/index>` method ``escape_str()`` escaped quote characters in LIKE conditions twice under MySQL.
- Fixed a bug (#395) - :doc:`Unit Testing Library <libraries/unit_testing>` method ``result()`` didn't properly check array result columns when called from ``report()``.
- Fixed a bug (#1692) - :doc:`Database Class <database/index>` method ``display_error()`` didn't properly trace the possible error source on Windows systems.
@@ -694,13 +694,13 @@
- Fixed a bug (#134) - :doc:`Database Caching <database/caching>` method ``delete_cache()`` didn't work in some cases due to *cachedir* not being initialized properly.
- Fixed a bug (#191) - :doc:`Loader Library <libraries/loader>` ignored attempts for (re)loading databases to ``get_instance()->db`` even when the old database connection is dead.
- Fixed a bug (#1255) - :doc:`User Agent Library <libraries/user_agent>` method ``is_referral()`` only checked if ``$_SERVER['HTTP_REFERER']`` exists.
-- Fixed a bug (#1146) - :doc:`Download Helper <helpers/download_helper>` function :func:`force_download()` incorrectly sent *Cache-Control* directives *pre-check* and *post-check* to Internet Explorer.
+- Fixed a bug (#1146) - :doc:`Download Helper <helpers/download_helper>` function :php:func:`force_download()` incorrectly sent *Cache-Control* directives *pre-check* and *post-check* to Internet Explorer.
- Fixed a bug (#1811) - :doc:`URI Library <libraries/uri>` didn't properly cache segments for ``uri_to_assoc()`` and ``ruri_to_assoc()``.
- Fixed a bug (#1506) - :doc:`Form Helpers <helpers/form_helper>` set empty *name* attributes.
- Fixed a bug (#59) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` ignored the DISTINCT clause.
- Fixed a bug (#1624) - :doc:`Form Validation Library <libraries/form_validation>` rule **matches** didn't property handle array field names.
-- Fixed a bug (#1630) - :doc:`Form Helper <helpers/form_helper>` function :func:`set_value()` didn't escape HTML entities.
-- Fixed a bug (#142) - :doc:`Form Helper <helpers/form_helper>` function :func:`form_dropdown()` didn't escape HTML entities in option values.
+- Fixed a bug (#1630) - :doc:`Form Helper <helpers/form_helper>` function :php:func:`set_value()` didn't escape HTML entities.
+- Fixed a bug (#142) - :doc:`Form Helper <helpers/form_helper>` function :php:func:`form_dropdown()` didn't escape HTML entities in option values.
- Fixed a bug (#50) - :doc:`Session Library <libraries/sessions>` unnecessarily stripped slashed from serialized data, making it impossible to read objects in a namespace.
- Fixed a bug (#658) - :doc:`Routing <general/routing>` wildcard **:any** didn't work as advertised and matched multiple URI segments instead of all characters within a single segment.
- Fixed a bug (#1938) - :doc:`Email Library <libraries/email>` removed multiple spaces inside a pre-formatted plain text message.
@@ -709,7 +709,7 @@
- Fixed a bug - :doc:`Routing Library <general/routing>` didn't properly handle *default_controller* in a subdirectory when a method is also specified.
- Fixed a bug (#953) - :doc:`post_controller_constructor hook <general/hooks>` wasn't called with a *404_override*.
- Fixed a bug (#1220) - :doc:`Profiler Library <general/profiling>` didn't display information for database objects that are instantiated inside models.
-- Fixed a bug (#1978) - :doc:`Directory Helper <helpers/directory_helper>` function :func:`directory_map()`'s return array didn't make a distinction between directories and file indexes when a directory with a numeric name is present.
+- Fixed a bug (#1978) - :doc:`Directory Helper <helpers/directory_helper>` function :php:func:`directory_map()`'s return array didn't make a distinction between directories and file indexes when a directory with a numeric name is present.
- Fixed a bug (#777) - :doc:`Loader Library <libraries/loader>` didn't look for helper extensions in added package paths.
- Fixed a bug (#18) - :doc:`APC Cache <libraries/caching>` driver didn't (un)serialize data, resulting in failure to store objects.
- Fixed a bug (#188) - :doc:`Unit Testing Library <libraries/unit_testing>` filled up logs with error messages for non-existing language keys.
@@ -722,7 +722,7 @@
- Fixed a bug (#2239) - :doc:`Email Library <libraries/email>` improperly handled the Subject when used with *bcc_batch_mode* resulting in E_WARNING messages and an empty Subject.
- Fixed a bug (#2234) - :doc:`Query Builder <database/query_builder>` didn't reset JOIN cache for write-type queries.
- Fixed a bug (#2298) - :doc:`Database Results <database/results>` method ``next_row()`` kept returning the last row, allowing for infinite loops.
-- Fixed a bug (#2236, #2639) - :doc:`Form Helper <helpers/form_helper>` functions :func:`set_value()`, :func:`set_select()`, :func:`set_radio()`, :func:`set_checkbox()` didn't parse array notation for keys if the rule was not present in the :doc:`Form Validation Library <libraries/form_validation>`.
+- Fixed a bug (#2236, #2639) - :doc:`Form Helper <helpers/form_helper>` functions :php:func:`set_value()`, :php:func:`set_select()`, :php:func:`set_radio()`, :php:func:`set_checkbox()` didn't parse array notation for keys if the rule was not present in the :doc:`Form Validation Library <libraries/form_validation>`.
- Fixed a bug (#2353) - :doc:`Query Builder <database/query_builder>` erroneously prefixed literal strings with **dbprefix**.
- Fixed a bug (#78) - :doc:`Cart Library <libraries/cart>` didn't allow non-English letters in product names.
- Fixed a bug (#77) - :doc:`Database Class <database/index>` didn't properly handle the transaction "test mode" flag.
@@ -732,12 +732,12 @@
- Fixed a bug (#2425) - OCI8 :doc:`database <database/index>` driver method ``stored_procedure()`` didn't log an error unless **db_debug** was set to TRUE.
- Fixed a bug (#2490) - :doc:`Database Class <database/queries>` method ``query()`` returning boolean instead of a result object for PostgreSQL-specific *INSERT INTO ... RETURNING* statements.
- Fixed a bug (#249) - :doc:`Cache Library <libraries/caching>` didn't properly handle Memcache(d) configurations with missing options.
-- Fixed a bug (#180) - :func:`config_item()` didn't take into account run-time configuration changes.
+- Fixed a bug (#180) - :php:func:`config_item()` didn't take into account run-time configuration changes.
- Fixed a bug (#2551) - :doc:`Loader Library <libraries/loader>` method ``library()`` didn't properly check if a class that is being loaded already exists.
-- Fixed a bug (#2560) - :doc:`Form Helper <helpers/form_helper>` function :func:`form_open()` set the 'method="post"' attribute only if the passed attributes equaled an empty string.
+- Fixed a bug (#2560) - :doc:`Form Helper <helpers/form_helper>` function :php:func:`form_open()` set the 'method="post"' attribute only if the passed attributes equaled an empty string.
- Fixed a bug (#2585) - :doc:`Query Builder <database/query_builder>` methods ``min()``, ``max()``, ``avg()``, ``sum()`` didn't escape field names.
-- Fixed a bug (#2590) - :doc:`Common function <general/common_functions>` :func:`log_message()` didn't actually cache the ``CI_Log`` class instance.
-- Fixed a bug (#2609) - :doc:`Common function <general/common_functions>` :func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
+- Fixed a bug (#2590) - :doc:`Common function <general/common_functions>` :php:func:`log_message()` didn't actually cache the ``CI_Log`` class instance.
+- Fixed a bug (#2609) - :doc:`Common function <general/common_functions>` :php:func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
- Fixed a bug in the 'postgre' :doc:`database <database/index>` driver where the connection ID wasn't passed to ``pg_escape_string()``.
- Fixed a bug (#33) - Script execution was terminated when an invalid cookie key was encountered.
- Fixed a bug (#2691) - nested :doc:`database <database/index>` transactions could end in a deadlock when an error is encountered with *db_debug* set to TRUE.
@@ -751,7 +751,7 @@
- Fixed a bug (#148) - :doc:`Input Library <libraries/input>` internal method ``_clean_input_data()`` assumed that it data is URL-encoded, stripping certain character sequences from it.
- Fixed a bug (#346) - with ``$config['global_xss_filtering']`` turned on, the ``$_GET``, ``$_POST``, ``$_COOKIE`` and ``$_SERVER`` superglobals were overwritten during initialization time, resulting in XSS filtering being either performed twice or there was no possible way to get the original data, even though options for this do exist.
- Fixed an edge case (#555) - :doc:`User Agent Library <libraries/user_agent>` reported an incorrect version Opera 10+ due to a non-standard user-agent string.
-- Fixed a bug (#133) - :doc:`Text Helper <helpers/text_helper>` :func:`ascii_to_entities()` stripped the last character if it happens to be in the extended ASCII group.
+- Fixed a bug (#133) - :doc:`Text Helper <helpers/text_helper>` :php:func:`ascii_to_entities()` stripped the last character if it happens to be in the extended ASCII group.
- Fixed a bug (#2822) - ``fwrite()`` was used incorrectly throughout the whole framework, allowing incomplete writes when writing to a network stream and possibly a few other edge cases.
- Fixed a bug where :doc:`User Agent Library <libraries/user_agent>` methods ``accept_charset()`` and ``accept_lang()`` didn't properly parse HTTP headers that contain spaces.
- Fixed a bug where *default_controller* was called instad of triggering a 404 error if the current route is in a controller directory.
diff --git a/user_guide_src/source/conf.py b/user_guide_src/source/conf.py
index 482d493..d65fe0d 100644
--- a/user_guide_src/source/conf.py
+++ b/user_guide_src/source/conf.py
@@ -69,11 +69,11 @@
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
-# If true, '()' will be appended to :func: etc. cross-reference text.
+# If true, '()' will be appended to :php:func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
+# unit titles (such as .. php:function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
diff --git a/user_guide_src/source/database/db_driver_reference.rst b/user_guide_src/source/database/db_driver_reference.rst
index 7bee555..005e6b3 100644
--- a/user_guide_src/source/database/db_driver_reference.rst
+++ b/user_guide_src/source/database/db_driver_reference.rst
@@ -13,9 +13,9 @@
some of them may fail (and return FALSE) if the underlying
driver does not support them.
-.. class:: CI_DB_driver
+.. php:class:: CI_DB_driver
- .. method:: initialize()
+ .. php:method:: initialize()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -23,7 +23,7 @@
Initialize database settings, establish a connection to
the database.
- .. method:: db_connect($persistent = TRUE)
+ .. php:method:: db_connect($persistent = TRUE)
:param bool $persistent: Whether to establish a persistent connection or a regular one
:returns: Database connection resource/object or FALSE on failure
@@ -35,7 +35,7 @@
driver in use. For example, a ``mysqli`` instance
will be returned with the 'mysqli' driver.
- .. method:: db_pconnect()
+ .. php:method:: db_pconnect()
:returns: Database connection resource/object or FALSE on failure
:rtype: mixed
@@ -44,7 +44,7 @@
.. note:: This method is just an alias for ``db_connect(TRUE)``.
- .. method:: reconnect()
+ .. php:method:: reconnect()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -53,7 +53,7 @@
have been sent for a length of time exceeding the
server's idle timeout.
- .. method:: db_select([$database = ''])
+ .. php:method:: db_select([$database = ''])
:param string $database: Database name
:returns: TRUE on success, FALSE on failure
@@ -61,7 +61,7 @@
Select / switch the current database.
- .. method:: db_set_charset($charset)
+ .. php:method:: db_set_charset($charset)
:param string $charset: Character set name
:returns: TRUE on success, FALSE on failure
@@ -69,21 +69,21 @@
Set client character set.
- .. method:: platform()
+ .. php:method:: platform()
:returns: Platform name
:rtype: string
The name of the platform in use (mysql, mssql, etc...).
- .. method:: version()
+ .. php:method:: version()
:returns: The version of the database being used
:rtype: string
Database version number.
- .. method:: query($sql[, $binds = FALSE[, $return_object = NULL]]])
+ .. php:method:: query($sql[, $binds = FALSE[, $return_object = NULL]]])
:param string $sql: The SQL statement to execute
:param array $binds: An array of binding data
@@ -106,7 +106,7 @@
page will be displayed instead of returning FALSE
on failures and script execution will stop.
- .. method:: simple_query($sql)
+ .. php:method:: simple_query($sql)
:param string $sql: The SQL statement to execute
:returns: Whatever the underlying driver's "query" function returns
@@ -116,7 +116,7 @@
for use when you don't need to get a result object or to
just send a query to the database and not care for the result.
- .. method:: trans_strict([$mode = TRUE])
+ .. php:method:: trans_strict([$mode = TRUE])
:param bool $mode: Strict mode flag
:rtype: void
@@ -131,26 +131,26 @@
autonomously, meaning a failure of one group will not
affect any others.
- .. method:: trans_off()
+ .. php:method:: trans_off()
:rtype: void
Disables transactions at run-time.
- .. method:: trans_start([$test_mode = FALSE])
+ .. php:method:: trans_start([$test_mode = FALSE])
:param bool $test_mode: Test mode flag
:rtype: void
Start a transaction.
- .. method:: trans_complete()
+ .. php:method:: trans_complete()
:rtype: void
Complete Transaction.
- .. method:: trans_status()
+ .. php:method:: trans_status()
:returns: TRUE if the transaction succeeded, FALSE if it failed
:rtype: bool
@@ -158,7 +158,7 @@
Lets you retrieve the transaction status flag to
determine if it has failed.
- .. method:: compile_binds($sql, $binds)
+ .. php:method:: compile_binds($sql, $binds)
:param string $sql: The SQL statement
:param array $binds: An array of binding data
@@ -167,7 +167,7 @@
Compiles an SQL query with the bind values passed for it.
- .. method:: is_write_type($sql)
+ .. php:method:: is_write_type($sql)
:param string $sql: The SQL statement
:returns: TRUE if the SQL statement is of "write type", FALSE if not
@@ -176,7 +176,7 @@
Determines if a query is of a "write" type (such as
INSERT, UPDATE, DELETE) or "read" type (i.e. SELECT).
- .. method:: elapsed_time([$decimals = 6])
+ .. php:method:: elapsed_time([$decimals = 6])
:param int $decimals: The number of decimal places
:returns: The aggregate query elapsed time, in microseconds
@@ -184,7 +184,7 @@
Calculate the aggregate query elapsed time.
- .. method:: total_queries()
+ .. php:method:: total_queries()
:returns: The total number of queries executed
:rtype: int
@@ -192,14 +192,14 @@
Returns the total number of queries that have been
executed so far.
- .. method:: last_query()
+ .. php:method:: last_query()
:returns: The last query executed
:rtype: string
Returns the last query that was executed.
- .. method:: escape($str)
+ .. php:method:: escape($str)
:param mixed $str: The value to escape, or an array of multiple ones
:returns: The escaped value(s)
@@ -208,7 +208,7 @@
Escapes input data based on type, including boolean and
NULLs.
- .. method:: escape_str($str[, $like = FALSE])
+ .. php:method:: escape_str($str[, $like = FALSE])
:param mixed $str: A string value or array of multiple ones
:param bool $like: Whether or not the string will be used in a LIKE condition
@@ -220,7 +220,7 @@
.. warning:: The returned strings do NOT include quotes
around them.
- .. method:: escape_like_str($str)
+ .. php:method:: escape_like_str($str)
:param mixed $str: A string value or array of multiple ones
:returns: The escaped string(s)
@@ -232,7 +232,7 @@
and ``_`` wildcard characters, so that they don't cause
false-positives in LIKE conditions.
- .. method:: primary($table)
+ .. php:method:: primary($table)
:param string $table: Table name
:returns: The primary key name, FALSE if none
@@ -244,7 +244,7 @@
key detection, the first column name may be assumed
as the primary key.
- .. method:: count_all([$table = ''])
+ .. php:method:: count_all([$table = ''])
:param string $table: Table name
:returns: Row count for the specified table
@@ -253,7 +253,7 @@
Returns the total number of rows in a table, or 0 if no
table was provided.
- .. method:: list_tables([$constrain_by_prefix = FALSE])
+ .. php:method:: list_tables([$constrain_by_prefix = FALSE])
:param bool $constrain_by_prefix: TRUE to match table names by the configured dbprefix
:returns: Array of table names or FALSE on failure
@@ -261,7 +261,7 @@
Gets a list of the tables in the current database.
- .. method:: table_exists($table_name)
+ .. php:method:: table_exists($table_name)
:param string $table_name: The table name
:returns: TRUE if that table exists, FALSE if not
@@ -269,7 +269,7 @@
Determine if a particular table exists.
- .. method:: list_fields($table)
+ .. php:method:: list_fields($table)
:param string $table: The table name
:returns: Array of field names or FALSE on failure
@@ -277,7 +277,7 @@
Gets a list of the field names in a table.
- .. method:: field_exists($field_name, $table_name)
+ .. php:method:: field_exists($field_name, $table_name)
:param string $table_name: The table name
:param string $field_name: The field name
@@ -286,7 +286,7 @@
Determine if a particular field exists.
- .. method:: field_data($table)
+ .. php:method:: field_data($table)
:param string $table: The table name
:returns: Array of field data items or FALSE on failure
@@ -294,7 +294,7 @@
Gets a list containing field data about a table.
- .. method:: escape_identifiers($item)
+ .. php:method:: escape_identifiers($item)
:param mixed $item: The item or array of items to escape
:returns: The input item(s), escaped
@@ -302,7 +302,7 @@
Escape SQL identifiers, such as column, table and names.
- .. method:: insert_string($table, $data)
+ .. php:method:: insert_string($table, $data)
:param string $table: The target table
:param array $data: An associative array of key/value pairs
@@ -311,7 +311,7 @@
Generate an INSERT statement string.
- .. method:: update_string($table, $data, $where)
+ .. php:method:: update_string($table, $data, $where)
:param string $table: The target table
:param array $data: An associative array of key/value pairs
@@ -321,7 +321,7 @@
Generate an UPDATE statement string.
- .. method:: call_function($function)
+ .. php:method:: call_function($function)
:param string $function: Function name
:returns: The function result
@@ -330,28 +330,28 @@
Runs a native PHP function , using a platform agnostic
wrapper.
- .. method:: cache_set_path([$path = ''])
+ .. php:method:: cache_set_path([$path = ''])
:param string $path: Path to the cache directory
:rtype: void
Sets the directory path to use for caching storage.
- .. method:: cache_on()
+ .. php:method:: cache_on()
:returns: TRUE if caching is on, FALSE if not
:rtype: bool
Enable database results caching.
- .. method:: cache_off()
+ .. php:method:: cache_off()
:returns: TRUE if caching is on, FALSE if not
:rtype: bool
Disable database results caching.
- .. method:: cache_delete([$segment_one = ''[, $segment_two = '']])
+ .. php:method:: cache_delete([$segment_one = ''[, $segment_two = '']])
:param string $segment_one: First URI segment
:param string $segment_two: Second URI segment
@@ -360,20 +360,20 @@
Delete the cache files associated with a particular URI.
- .. method:: cache_delete_all()
+ .. php:method:: cache_delete_all()
:returns: TRUE on success, FALSE on failure
:rtype: bool
Delete all cache files.
- .. method:: close()
+ .. php:method:: close()
:rtype: void
Close the DB Connection.
- .. method:: display_error([$error = ''[, $swap = ''[, $native = FALSE]]])
+ .. php:method:: display_error([$error = ''[, $swap = ''[, $native = FALSE]]])
:param string $error: The error message
:param string $swap: Any "swap" values
@@ -388,7 +388,7 @@
The message is displayed using the
*application/views/errors/error_db.php* template.
- .. method:: protect_identifiers($item[, $prefix_single = FALSE[, $protect_identifiers = NULL[, $field_exists = TRUE]]])
+ .. php:method:: protect_identifiers($item[, $prefix_single = FALSE[, $protect_identifiers = NULL[, $field_exists = TRUE]]])
:param string $item: The item to work with
:param bool $prefix_single: Whether to apply the dbprefix even if the input item is a single identifier
diff --git a/user_guide_src/source/database/forge.rst b/user_guide_src/source/database/forge.rst
index 59a6591..89fac02 100644
--- a/user_guide_src/source/database/forge.rst
+++ b/user_guide_src/source/database/forge.rst
@@ -316,9 +316,9 @@
Class Reference
***************
-.. class:: CI_DB_forge
+.. php:class:: CI_DB_forge
- .. method:: add_column($table[, $field = array()[, $_after = NULL]])
+ .. php:method:: add_column($table[, $field = array()[, $_after = NULL]])
:param string $table: Table name to add the column to
:param array $field: Column definition(s)
@@ -328,7 +328,7 @@
Adds a column to a table. Usage: See `Adding a Column to a Table`_.
- .. method:: add_field($field)
+ .. php:method:: add_field($field)
:param array $field: Field definition to add
:returns: CI_DB_forge instance (method chaining)
@@ -336,7 +336,7 @@
Adds a field to the set that will be used to create a table. Usage: See `Adding fields`_.
- .. method:: add_key($key[, $primary = FALSE])
+ .. php:method:: add_key($key[, $primary = FALSE])
:param array $key: Name of a key field
:param bool $primary: Set to TRUE if it should be a primary key or a regular one
@@ -345,7 +345,7 @@
Adds a key to the set that will be used to create a table. Usage: See `Adding Keys`_.
- .. method:: create_database($db_name)
+ .. php:method:: create_database($db_name)
:param string $db_name: Name of the database to create
:returns: TRUE on success, FALSE on failure
@@ -353,7 +353,7 @@
Creates a new database. Usage: See `Creating and Dropping Databases`_.
- .. method:: create_table($table[, $if_not_exists = FALSE[, array $attributes = array()]])
+ .. php:method:: create_table($table[, $if_not_exists = FALSE[, array $attributes = array()]])
:param string $table: Name of the table to create
:param string $if_not_exists: Set to TRUE to add an 'IF NOT EXISTS' clause
@@ -363,7 +363,7 @@
Creates a new table. Usage: See `Creating a table`_.
- .. method:: drop_column($table, $column_name)
+ .. php:method:: drop_column($table, $column_name)
:param string $table: Table name
:param array $column_name: The column name to drop
@@ -372,7 +372,7 @@
Drops a column from a table. Usage: See `Dropping a Column From a Table`_.
- .. method:: drop_database($db_name)
+ .. php:method:: drop_database($db_name)
:param string $db_name: Name of the database to drop
:returns: TRUE on success, FALSE on failure
@@ -380,7 +380,7 @@
Drops a database. Usage: See `Creating and Dropping Databases`_.
- .. method:: drop_table($table_name[, $if_exists = FALSE])
+ .. php:method:: drop_table($table_name[, $if_exists = FALSE])
:param string $table: Name of the table to drop
:param string $if_exists: Set to TRUE to add an 'IF EXISTS' clause
@@ -389,7 +389,7 @@
Drops a table. Usage: See `Dropping a table`_.
- .. method:: modify_column($table, $field)
+ .. php:method:: modify_column($table, $field)
:param string $table: Table name
:param array $field: Column definition(s)
@@ -398,7 +398,7 @@
Modifies a table column. Usage: See `Modifying a Column in a Table`_.
- .. method:: rename_table($table_name, $new_table_name)
+ .. php:method:: rename_table($table_name, $new_table_name)
:param string $table: Current of the table
:param string $new_table_name: New name of the table
diff --git a/user_guide_src/source/database/query_builder.rst b/user_guide_src/source/database/query_builder.rst
index b06396e..fa1e903 100644
--- a/user_guide_src/source/database/query_builder.rst
+++ b/user_guide_src/source/database/query_builder.rst
@@ -1044,9 +1044,9 @@
Class Reference
***************
-.. class:: CI_DB_query_builder
+.. php:class:: CI_DB_query_builder
- .. method:: reset_query()
+ .. php:method:: reset_query()
:returns: CI_DB_query_builder instance (method chaining)
:rtype: CI_DB_query_builder
@@ -1054,28 +1054,28 @@
Resets the current Query Builder state. Useful when you want
to build a query that can be cancelled under certain conditions.
- .. method:: start_cache()
+ .. php:method:: start_cache()
:returns: CI_DB_query_builder instance (method chaining)
:rtype: CI_DB_query_builder
Starts the Query Builder cache.
- .. method:: stop_cache()
+ .. php:method:: stop_cache()
:returns: CI_DB_query_builder instance (method chaining)
:rtype: CI_DB_query_builder
Stops the Query Builder cache.
- .. method:: flush_cache()
+ .. php:method:: flush_cache()
:returns: CI_DB_query_builder instance (method chaining)
:rtype: CI_DB_query_builder
Empties the Query Builder cache.
- .. method:: set_dbprefix([$prefix = ''])
+ .. php:method:: set_dbprefix([$prefix = ''])
:param string $prefix: The new prefix to use
:returns: The DB prefix in use
@@ -1083,7 +1083,7 @@
Sets the database prefix, without having to reconnect.
- .. method:: dbprefix([$table = ''])
+ .. php:method:: dbprefix([$table = ''])
:param string $table: The table name to prefix
:returns: The prefixed table name
@@ -1091,7 +1091,7 @@
Prepends a database prefix, if one exists in configuration.
- .. method:: count_all_results([$table = ''])
+ .. php:method:: count_all_results([$table = ''])
:param string $table: Table name
:returns: Number of rows in the query result
@@ -1100,7 +1100,7 @@
Generates a platform-specific query string that counts
all records returned by an Query Builder query.
- .. method:: get([$table = ''[, $limit = NULL[, $offset = NULL]]])
+ .. php:method:: get([$table = ''[, $limit = NULL[, $offset = NULL]]])
:param string $table: The table to query
:param int $limit: The LIMIT clause
@@ -1111,7 +1111,7 @@
Compiles and runs SELECT statement based on the already
called Query Builder methods.
- .. method:: get_where([$table = ''[, $where = NULL[, $limit = NULL[, $offset = NULL]]]])
+ .. php:method:: get_where([$table = ''[, $where = NULL[, $limit = NULL[, $offset = NULL]]]])
:param mixed $table: The table(s) to fetch data from; string or array
:param string $where: The WHERE clause
@@ -1122,7 +1122,7 @@
Same as ``get()``, but also allows the WHERE to be added directly.
- .. method:: select([$select = '*'[, $escape = NULL]])
+ .. php:method:: select([$select = '*'[, $escape = NULL]])
:param string $select: The SELECT portion of a query
:param bool $escape: Whether to escape values and identifiers
@@ -1131,7 +1131,7 @@
Adds a SELECT clause to a query.
- .. method:: select_avg([$select = ''[, $alias = '']])
+ .. php:method:: select_avg([$select = ''[, $alias = '']])
:param string $select: Field to compute the average of
:param string $alias: Alias for the resulting value name
@@ -1140,7 +1140,7 @@
Adds a SELECT AVG(field) clause to a query.
- .. method:: select_max([$select = ''[, $alias = '']])
+ .. php:method:: select_max([$select = ''[, $alias = '']])
:param string $select: Field to compute the maximum of
:param string $alias: Alias for the resulting value name
@@ -1149,7 +1149,7 @@
Adds a SELECT MAX(field) clause to a query.
- .. method:: select_min([$select = ''[, $alias = '']])
+ .. php:method:: select_min([$select = ''[, $alias = '']])
:param string $select: Field to compute the minimum of
:param string $alias: Alias for the resulting value name
@@ -1158,7 +1158,7 @@
Adds a SELECT MIN(field) clause to a query.
- .. method:: select_sum([$select = ''[, $alias = '']])
+ .. php:method:: select_sum([$select = ''[, $alias = '']])
:param string $select: Field to compute the sum of
:param string $alias: Alias for the resulting value name
@@ -1167,7 +1167,7 @@
Adds a SELECT SUM(field) clause to a query.
- .. method:: distinct([$val = TRUE])
+ .. php:method:: distinct([$val = TRUE])
:param bool $val: Desired value of the "distinct" flag
:returns: CI_DB_query_builder instance (method chaining)
@@ -1176,7 +1176,7 @@
Sets a flag which tells the query builder to add
a DISTINCT clause to the SELECT portion of the query.
- .. method:: from($from)
+ .. php:method:: from($from)
:param mixed $from: Table name(s); string or array
:returns: CI_DB_query_builder instance (method chaining)
@@ -1184,7 +1184,7 @@
Specifies the FROM clause of a query.
- .. method:: join($table, $cond[, $type = ''[, $escape = NULL]])
+ .. php:method:: join($table, $cond[, $type = ''[, $escape = NULL]])
:param string $table: Table name to join
:param string $cond: The JOIN ON condition
@@ -1195,7 +1195,7 @@
Adds a JOIN clause to a query.
- .. method:: where($key[, $value = NULL[, $escape = NULL]])
+ .. php:method:: where($key[, $value = NULL[, $escape = NULL]])
:param mixed $key: Name of field to compare, or associative array
:param mixed $value: If a single key, compared to this value
@@ -1206,7 +1206,7 @@
Generates the WHERE portion of the query.
Separates multiple calls with 'AND'.
- .. method:: or_where($key[, $value = NULL[, $escape = NULL]])
+ .. php:method:: or_where($key[, $value = NULL[, $escape = NULL]])
:param mixed $key: Name of field to compare, or associative array
:param mixed $value: If a single key, compared to this value
@@ -1217,7 +1217,7 @@
Generates the WHERE portion of the query.
Separates multiple calls with 'OR'.
- .. method:: or_where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
+ .. php:method:: or_where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
:param string $key: The field to search
:param array $values: The values searched on
@@ -1228,7 +1228,7 @@
Generates a WHERE field IN('item', 'item') SQL query,
joined with 'OR' if appropriate.
- .. method:: or_where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
+ .. php:method:: or_where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
:param string $key: The field to search
:param array $values: The values searched on
@@ -1239,7 +1239,7 @@
Generates a WHERE field NOT IN('item', 'item') SQL query,
joined with 'OR' if appropriate.
- .. method:: where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
+ .. php:method:: where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
:param string $key: Name of field to examine
:param array $values: Array of target values
@@ -1250,7 +1250,7 @@
Generates a WHERE field IN('item', 'item') SQL query,
joined with 'AND' if appropriate.
- .. method:: where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
+ .. php:method:: where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
:param string $key: Name of field to examine
:param array $values: Array of target values
@@ -1261,42 +1261,42 @@
Generates a WHERE field NOT IN('item', 'item') SQL query,
joined with 'AND' if appropriate.
- .. method:: group_start()
+ .. php:method:: group_start()
:returns: CI_DB_query_builder instance (method chaining)
:rtype: CI_DB_query_builder
Starts a group expression, using ANDs for the conditions inside it.
- .. method:: or_group_start()
+ .. php:method:: or_group_start()
:returns: CI_DB_query_builder instance (method chaining)
:rtype: CI_DB_query_builder
Starts a group expression, using ORs for the conditions inside it.
- .. method:: not_group_start()
+ .. php:method:: not_group_start()
:returns: CI_DB_query_builder instance (method chaining)
:rtype: CI_DB_query_builder
Starts a group expression, using AND NOTs for the conditions inside it.
- .. method:: or_not_group_start()
+ .. php:method:: or_not_group_start()
:returns: CI_DB_query_builder instance (method chaining)
:rtype: CI_DB_query_builder
Starts a group expression, using OR NOTs for the conditions inside it.
- .. method:: group_end()
+ .. php:method:: group_end()
:returns: DB_query_builder instance
:rtype: object
Ends a group expression.
- .. method:: like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
+ .. php:method:: like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
:param string $field: Field name
:param string $match: Text portion to match
@@ -1307,7 +1307,7 @@
Adds a LIKE clause to a query, separating multiple calls with AND.
- .. method:: or_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
+ .. php:method:: or_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
:param string $field: Field name
:param string $match: Text portion to match
@@ -1318,7 +1318,7 @@
Adds a LIKE clause to a query, separating multiple class with OR.
- .. method:: not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
+ .. php:method:: not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
:param string $field: Field name
:param string $match: Text portion to match
@@ -1329,7 +1329,7 @@
Adds a NOT LIKE clause to a query, separating multiple calls with AND.
- .. method:: or_not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
+ .. php:method:: or_not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
:param string $field: Field name
:param string $match: Text portion to match
@@ -1340,7 +1340,7 @@
Adds a NOT LIKE clause to a query, separating multiple calls with OR.
- .. method:: having($key[, $value = NULL[, $escape = NULL]])
+ .. php:method:: having($key[, $value = NULL[, $escape = NULL]])
:param mixed $key: Identifier (string) or associative array of field/value pairs
:param string $value: Value sought if $key is an identifier
@@ -1350,7 +1350,7 @@
Adds a HAVING clause to a query, separating multiple calls with AND.
- .. method:: or_having($key[, $value = NULL[, $escape = NULL]])
+ .. php:method:: or_having($key[, $value = NULL[, $escape = NULL]])
:param mixed $key: Identifier (string) or associative array of field/value pairs
:param string $value: Value sought if $key is an identifier
@@ -1360,7 +1360,7 @@
Adds a HAVING clause to a query, separating multiple calls with OR.
- .. method:: group_by($by[, $escape = NULL])
+ .. php:method:: group_by($by[, $escape = NULL])
:param mixed $by: Field(s) to group by; string or array
:returns: CI_DB_query_builder instance (method chaining)
@@ -1368,7 +1368,7 @@
Adds a GROUP BY clause to a query.
- .. method:: order_by($orderby[, $direction = ''[, $escape = NULL]])
+ .. php:method:: order_by($orderby[, $direction = ''[, $escape = NULL]])
:param string $orderby: Field to order by
:param string $direction: The order requested - ASC, DESC or random
@@ -1378,7 +1378,7 @@
Adds an ORDER BY clause to a query.
- .. method:: limit($value[, $offset = 0])
+ .. php:method:: limit($value[, $offset = 0])
:param int $value: Number of rows to limit the results to
:param int $offset: Number of rows to skip
@@ -1387,7 +1387,7 @@
Adds LIMIT and OFFSET clauses to a query.
- .. method:: offset($offset)
+ .. php:method:: offset($offset)
:param int $offset: Number of rows to skip
:returns: CI_DB_query_builder instance (method chaining)
@@ -1395,7 +1395,7 @@
Adds an OFFSET clause to a query.
- .. method:: set($key[, $value = ''[, $escape = NULL]])
+ .. php:method:: set($key[, $value = ''[, $escape = NULL]])
:param mixed $key: Field name, or an array of field/value pairs
:param string $value: Field value, if $key is a single field
@@ -1406,7 +1406,7 @@
Adds field/value pairs to be passed later to ``insert()``,
``update()`` or ``replace()``.
- .. method:: insert([$table = ''[, $set = NULL[, $escape = NULL]]])
+ .. php:method:: insert([$table = ''[, $set = NULL[, $escape = NULL]]])
:param string $table: Table name
:param array $set: An associative array of field/value pairs
@@ -1416,7 +1416,7 @@
Compiles and executes an INSERT statement.
- .. method:: insert_batch([$table = ''[, $set = NULL[, $escape = NULL]]])
+ .. php:method:: insert_batch([$table = ''[, $set = NULL[, $escape = NULL]]])
:param string $table: Table name
:param array $set: Data to insert
@@ -1426,7 +1426,7 @@
Compiles and executes batch INSERT statements.
- .. method:: set_insert_batch($key[, $value = ''[, $escape = NULL]])
+ .. php:method:: set_insert_batch($key[, $value = ''[, $escape = NULL]])
:param mixed $key: Field name or an array of field/value pairs
:param string $value: Field value, if $key is a single field
@@ -1436,7 +1436,7 @@
Adds field/value pairs to be inserted in a table later via ``insert_batch()``.
- .. method:: update([$table = ''[, $set = NULL[, $where = NULL[, $limit = NULL]]]])
+ .. php:method:: update([$table = ''[, $set = NULL[, $where = NULL[, $limit = NULL]]]])
:param string $table: Table name
:param array $set: An associative array of field/value pairs
@@ -1447,7 +1447,7 @@
Compiles and executes an UPDATE statement.
- .. method:: update_batch([$table = ''[, $set = NULL[, $value = NULL]]])
+ .. php:method:: update_batch([$table = ''[, $set = NULL[, $value = NULL]]])
:param string $table: Table name
:param array $set: Field name, or an associative array of field/value pairs
@@ -1457,7 +1457,7 @@
Compiles and executes batch UPDATE statements.
- .. method:: set_update_batch($key[, $value = ''[, $escape = NULL]])
+ .. php:method:: set_update_batch($key[, $value = ''[, $escape = NULL]])
:param mixed $key: Field name or an array of field/value pairs
:param string $value: Field value, if $key is a single field
@@ -1467,7 +1467,7 @@
Adds field/value pairs to be updated in a table later via ``update_batch()``.
- .. method:: replace([$table = ''[, $set = NULL]])
+ .. php:method:: replace([$table = ''[, $set = NULL]])
:param string $table: Table name
:param array $set: An associative array of field/value pairs
@@ -1476,7 +1476,7 @@
Compiles and executes a REPLACE statement.
- .. method:: delete([$table = ''[, $where = ''[, $limit = NULL[, $reset_data = TRUE]]]])
+ .. php:method:: delete([$table = ''[, $where = ''[, $limit = NULL[, $reset_data = TRUE]]]])
:param mixed $table: The table(s) to delete from; string or array
:param string $where: The WHERE clause
@@ -1487,7 +1487,7 @@
Compiles and executes a DELETE query.
- .. method:: truncate([$table = ''])
+ .. php:method:: truncate([$table = ''])
:param string $table: Table name
:returns: TRUE on success, FALSE on failure
@@ -1498,7 +1498,7 @@
.. note:: If the database platform in use doesn't support TRUNCATE,
a DELETE statement will be used instead.
- .. method:: empty_table([$table = ''])
+ .. php:method:: empty_table([$table = ''])
:param string $table: Table name
:returns: TRUE on success, FALSE on failure
@@ -1506,7 +1506,7 @@
Deletes all records from a table via a DELETE statement.
- .. method:: get_compiled_select([$table = ''[, $reset = TRUE]])
+ .. php:method:: get_compiled_select([$table = ''[, $reset = TRUE]])
:param string $table: Table name
:param bool $reset: Whether to reset the current QB values or not
@@ -1515,7 +1515,7 @@
Compiles a SELECT statement and returns it as a string.
- .. method:: get_compiled_insert([$table = ''[, $reset = TRUE]])
+ .. php:method:: get_compiled_insert([$table = ''[, $reset = TRUE]])
:param string $table: Table name
:param bool $reset: Whether to reset the current QB values or not
@@ -1524,7 +1524,7 @@
Compiles an INSERT statement and returns it as a string.
- .. method:: get_compiled_update([$table = ''[, $reset = TRUE]])
+ .. php:method:: get_compiled_update([$table = ''[, $reset = TRUE]])
:param string $table: Table name
:param bool $reset: Whether to reset the current QB values or not
@@ -1533,7 +1533,7 @@
Compiles an UPDATE statement and returns it as a string.
- .. method:: get_compiled_delete([$table = ''[, $reset = TRUE]])
+ .. php:method:: get_compiled_delete([$table = ''[, $reset = TRUE]])
:param string $table: Table name
:param bool $reset: Whether to reset the current QB values or not
diff --git a/user_guide_src/source/database/results.rst b/user_guide_src/source/database/results.rst
index ae81998..a22c2e8 100644
--- a/user_guide_src/source/database/results.rst
+++ b/user_guide_src/source/database/results.rst
@@ -245,9 +245,9 @@
Class Reference
***************
-.. class:: CI_DB_result
+.. php:class:: CI_DB_result
- .. method:: result([$type = 'object'])
+ .. php:method:: result([$type = 'object'])
:param string $type: Type of requested results - array, object, or class name
:returns: Array containing the fetched rows
@@ -258,7 +258,7 @@
Usage: see `Result Arrays`_.
- .. method:: result_array()
+ .. php:method:: result_array()
:returns: Array containing the fetched rows
:rtype: array
@@ -268,7 +268,7 @@
Usage: see `Result Arrays`_.
- .. method:: result_object()
+ .. php:method:: result_object()
:returns: Array containing the fetched rows
:rtype: array
@@ -278,7 +278,7 @@
Usage: see `Result Arrays`_.
- .. method:: custom_result_object($class_name)
+ .. php:method:: custom_result_object($class_name)
:param string $class_name: Class name for the resulting rows
:returns: Array containing the fetched rows
@@ -287,7 +287,7 @@
Returns the query results as an array of rows, where each
row is an instance of the specified class.
- .. method:: row([$n = 0[, $type = 'object']])
+ .. php:method:: row([$n = 0[, $type = 'object']])
:param int $n: Index of the query results row to be returned
:param string $type: Type of the requested result - array, object, or class name
@@ -299,7 +299,7 @@
Usage: see `Result Rows`_.
- .. method:: unbuffered_row([$type = 'object'])
+ .. php:method:: unbuffered_row([$type = 'object'])
:param string $type: Type of the requested result - array, object, or class name
:returns: Next row from the result set or NULL if it doesn't exist
@@ -310,7 +310,7 @@
Usage: see `Result Rows`_.
- .. method:: row_array([$n = 0])
+ .. php:method:: row_array([$n = 0])
:param int $n: Index of the query results row to be returned
:returns: The requested row or NULL if it doesn't exist
@@ -320,7 +320,7 @@
Usage: see `Result Rows`_.
- .. method:: row_object([$n = 0])
+ .. php:method:: row_object([$n = 0])
:param int $n: Index of the query results row to be returned
:returns: The requested row or NULL if it doesn't exist
@@ -331,7 +331,7 @@
Usage: see `Result Rows`_.
- .. method:: custom_row_object($n, $type)
+ .. php:method:: custom_row_object($n, $type)
:param int $n: Index of the results row to return
:param string $class_name: Class name for the resulting row
@@ -341,7 +341,7 @@
Returns the requested result row as an instance of the
requested class.
- .. method:: data_seek([$n = 0])
+ .. php:method:: data_seek([$n = 0])
:param int $n: Index of the results row to be returned next
:returns: TRUE on success, FALSE on failure
@@ -351,7 +351,7 @@
Usage: see `Result Helper Methods`_.
- .. method:: set_row($key[, $value = NULL])
+ .. php:method:: set_row($key[, $value = NULL])
:param mixed $key: Column name or array of key/value pairs
:param mixed $value: Value to assign to the column, $key is a single field name
@@ -359,7 +359,7 @@
Assigns a value to a particular column.
- .. method:: next_row([$type = 'object'])
+ .. php:method:: next_row([$type = 'object'])
:param string $type: Type of the requested result - array, object, or class name
:returns: Next row of result set, or NULL if it doesn't exist
@@ -367,7 +367,7 @@
Returns the next row from the result set.
- .. method:: previous_row([$type = 'object'])
+ .. php:method:: previous_row([$type = 'object'])
:param string $type: Type of the requested result - array, object, or class name
:returns: Previous row of result set, or NULL if it doesn't exist
@@ -375,7 +375,7 @@
Returns the previous row from the result set.
- .. method:: first_row([$type = 'object'])
+ .. php:method:: first_row([$type = 'object'])
:param string $type: Type of the requested result - array, object, or class name
:returns: First row of result set, or NULL if it doesn't exist
@@ -383,7 +383,7 @@
Returns the first row from the result set.
- .. method:: last_row([$type = 'object'])
+ .. php:method:: last_row([$type = 'object'])
:param string $type: Type of the requested result - array, object, or class name
:returns: Last row of result set, or NULL if it doesn't exist
@@ -391,7 +391,7 @@
Returns the last row from the result set.
- .. method:: num_rows()
+ .. php:method:: num_rows()
:returns: Number of rows in the result set
:rtype: int
@@ -400,7 +400,7 @@
Usage: see `Result Helper Methods`_.
- .. method:: num_fields()
+ .. php:method:: num_fields()
:returns: Number of fields in the result set
:rtype: int
@@ -409,7 +409,7 @@
Usage: see `Result Helper Methods`_.
- .. method:: field_data()
+ .. php:method:: field_data()
:returns: Array containing field meta-data
:rtype: array
@@ -417,7 +417,7 @@
Generates an array of ``stdClass`` objects containing
field meta-data.
- .. method:: free_result()
+ .. php:method:: free_result()
:rtype: void
@@ -425,7 +425,7 @@
Usage: see `Result Helper Methods`_.
- .. method:: list_fields()
+ .. php:method:: list_fields()
:returns: Array of column names
:rtype: array
diff --git a/user_guide_src/source/database/utilities.rst b/user_guide_src/source/database/utilities.rst
index 0d8137d..2da1f98 100644
--- a/user_guide_src/source/database/utilities.rst
+++ b/user_guide_src/source/database/utilities.rst
@@ -247,9 +247,9 @@
Class Reference
***************
-.. class:: CI_DB_utility
+.. php:class:: CI_DB_utility
- .. method:: backup([$params = array()])
+ .. php:method:: backup([$params = array()])
:param array $params: An associative array of options
:returns: void
@@ -257,7 +257,7 @@
Perform a database backup, per user preferences.
- .. method:: database_exists($database_name)
+ .. php:method:: database_exists($database_name)
:param string $database_name: Database name
:returns: TRUE if the database exists, FALSE otherwise
@@ -265,21 +265,21 @@
Check for the existence of a database.
- .. method:: list_databases()
+ .. php:method:: list_databases()
:returns: Array of database names found
:rtype: array
Retrieve a list of all the database names.
- .. method:: optimize_database()
+ .. php:method:: optimize_database()
:returns: Array of optimization messages or FALSE on failure
:rtype: array
Optimizes the database.
- .. method:: optimize_table($table_name)
+ .. php:method:: optimize_table($table_name)
:param string $table_name: Name of the table to optimize
:returns: Array of optimization messages or FALSE on failure
@@ -287,7 +287,7 @@
Optimizes a database table.
- .. method:: repair_table($table_name)
+ .. php:method:: repair_table($table_name)
:param string $table_name: Name of the table to repair
:returns: Array of repair messages or FALSE on failure
@@ -295,7 +295,7 @@
Repairs a database table.
- .. method:: csv_from_results($query[, $delim = ','[, $newline = "\n"[, $enclosure = '"']]])
+ .. php:method:: csv_from_results($query[, $delim = ','[, $newline = "\n"[, $enclosure = '"']]])
:param object $query: A database result object
:param string $delim: The CSV field delimiter to use
@@ -306,7 +306,7 @@
Translates a database result object into a CSV document.
- .. method:: xml_from_results($query[, $params = array()])
+ .. php:method:: xml_from_results($query[, $params = array()])
:param object $query: A database result object
:param array $params: An associative array of preferences
diff --git a/user_guide_src/source/documentation/index.rst b/user_guide_src/source/documentation/index.rst
index 6d4c94b..60c6b4e 100644
--- a/user_guide_src/source/documentation/index.rst
+++ b/user_guide_src/source/documentation/index.rst
@@ -115,9 +115,9 @@
.. code-block:: rst
- .. class:: Some_class
+ .. php:class:: Some_class
- .. method:: some_method ( $foo [, $bar [, $bat]])
+ .. php:method:: some_method ( $foo [, $bar [, $bat]])
This function will perform some action. The ``$bar`` array must contain
a something and something else, and along with ``$bat`` is an optional
@@ -151,7 +151,7 @@
See also :meth:`Some_class::should_do_something`
- .. method:: should_do_something()
+ .. php:method:: should_do_something()
:returns: Whether or not something should be done
:rtype: bool
@@ -159,10 +159,10 @@
It creates the following display:
-.. class:: Some_class
+.. php:class:: Some_class
- .. method:: some_method ( $foo [, $bar [, $bat]])
+ .. php:method:: some_method ( $foo [, $bar [, $bat]])
This function will perform some action. The ``$bar`` array must contain
a something and something else, and along with ``$bat`` is an optional
@@ -196,7 +196,7 @@
See also :meth:`Some_class::should_do_something`
- .. method:: should_do_something()
+ .. php:method:: should_do_something()
:returns: Whether or not something should be done
:rtype: bool
\ No newline at end of file
diff --git a/user_guide_src/source/general/ancillary_classes.rst b/user_guide_src/source/general/ancillary_classes.rst
index cc232f4..6a64742 100644
--- a/user_guide_src/source/general/ancillary_classes.rst
+++ b/user_guide_src/source/general/ancillary_classes.rst
@@ -9,7 +9,7 @@
get_instance()
==============
-.. function:: get_instance()
+.. php:function:: get_instance()
:returns: object of class CI_Controller
diff --git a/user_guide_src/source/general/cli.rst b/user_guide_src/source/general/cli.rst
index 4f3b07d..b45be1a 100644
--- a/user_guide_src/source/general/cli.rst
+++ b/user_guide_src/source/general/cli.rst
@@ -23,7 +23,7 @@
- Run your cron-jobs without needing to use *wget* or *curl*
- Make your cron-jobs inaccessible from being loaded in the URL by
- checking the return value of :func:`is_cli()`.
+ checking the return value of :php:func:`is_cli()`.
- Make interactive "tasks" that can do things like set permissions,
prune cache folders, run backups, etc.
- Integrate with other applications in other languages. For example, a
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index 399a323..6d6744c 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -13,7 +13,7 @@
<div class="custom-index container"></div>
-.. function:: is_php($version)
+.. php:function:: is_php($version)
:param string $version: Version number
:returns: TRUE if the running PHP version is at least the one specified or FALSE if not
@@ -33,7 +33,7 @@
greater than the supplied version number. Returns FALSE if the installed
version of PHP is lower than the supplied version number.
-.. function:: is_really_writable($file)
+.. php:function:: is_really_writable($file)
:param string $file: File path
:returns: TRUE if the path is writable, FALSE if not
@@ -60,7 +60,7 @@
.. note:: See also `PHP bug #54709 <https://bugs.php.net/bug.php?id=54709>`_ for more info.
-.. function:: config_item($key)
+.. php:function:: config_item($key)
:param string $key: Config item key
:returns: Configuration key value or NULL if not found
@@ -99,7 +99,7 @@
This function is an alias for ``CI_Log::write_log()``. For more info,
please see the :doc:`Error Handling <errors>` documentation.
-.. function:: set_status_header($code[, $text = ''])
+.. php: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
@@ -113,7 +113,7 @@
`See here <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ for
a full list of headers.
-.. function:: remove_invisible_characters($str[, $url_encoded = TRUE])
+.. php: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
@@ -128,7 +128,7 @@
remove_invisible_characters('Java\\0script');
// Returns: 'Javascript'
-.. function:: html_escape($var)
+.. php:function:: html_escape($var)
:param mixed $var: Variable to escape (string or array)
:returns: HTML escaped string(s)
@@ -139,7 +139,7 @@
It is useful in preventing Cross Site Scripting (XSS).
-.. function:: get_mimes()
+.. php:function:: get_mimes()
:returns: An associative array of file types
:rtype: array
@@ -147,7 +147,7 @@
This function returns a *reference* to the MIMEs array from
*application/config/mimes.php*.
-.. function:: is_https()
+.. php:function:: is_https()
:returns: TRUE if currently using HTTP-over-SSL, FALSE if not
:rtype: bool
@@ -155,7 +155,7 @@
Returns TRUE if a secure (HTTPS) connection is used and FALSE
in any other case (including non-HTTP requests).
-.. function:: is_cli()
+.. php:function:: is_cli()
:returns: TRUE if currently running under CLI, FALSE otherwise
:rtype: bool
@@ -166,7 +166,7 @@
.. note:: This function checks both if the ``PHP_SAPI`` value is 'cli'
or if the ``STDIN`` constant is defined.
-.. function:: function_usable($function_name)
+.. php:function:: function_usable($function_name)
:param string $function_name: Function name
:returns: TRUE if the function can be used, FALSE if not
diff --git a/user_guide_src/source/general/compatibility_functions.rst b/user_guide_src/source/general/compatibility_functions.rst
index aee9b1e..434b098 100644
--- a/user_guide_src/source/general/compatibility_functions.rst
+++ b/user_guide_src/source/general/compatibility_functions.rst
@@ -44,7 +44,7 @@
Function reference
==================
-.. function:: password_get_info($hash)
+.. php:function:: password_get_info($hash)
:param string $hash: Password hash
:returns: Information about the hashed password
@@ -53,7 +53,7 @@
For more information, please refer to the `PHP manual for
password_get_info() <http://php.net/password_get_info>`_.
-.. function:: password_hash($password, $algo[, $options = array()])
+.. php:function:: password_hash($password, $algo[, $options = array()])
:param string $password: Plain-text password
:param int $algo: Hashing algorithm
@@ -72,7 +72,7 @@
- /dev/arandom
- /dev/urandom
-.. function:: password_needs_rehash()
+.. php:function:: password_needs_rehash()
:param string $hash: Password hash
:param int $algo: Hashing algorithm
@@ -83,7 +83,7 @@
For more information, please refer to the `PHP manual for
password_needs_rehash() <http://php.net/password_needs_rehash>`_.
-.. function:: password_verify($password, $hash)
+.. php:function:: password_verify($password, $hash)
:param string $password: Plain-text password
:param string $hash: Password hash
@@ -109,7 +109,7 @@
Function reference
==================
-.. function:: hash_equals($known_string, $user_string)
+.. php:function:: hash_equals($known_string, $user_string)
:param string $known_string: Known string
:param string $user_string: User-supplied string
@@ -119,7 +119,7 @@
For more information, please refer to the `PHP manual for
hash_equals() <http://php.net/hash_equals>`_.
-.. function:: hash_pbkdf2($algo, $password, $salt, $iterations[, $length = 0[, $raw_output = FALSE]])
+.. php:function:: hash_pbkdf2($algo, $password, $salt, $iterations[, $length = 0[, $raw_output = FALSE]])
:param string $algo: Hashing algorithm
:param string $password: Password
@@ -162,7 +162,7 @@
Function reference
==================
-.. function:: mb_strlen($str[, $encoding = NULL])
+.. php:function:: mb_strlen($str[, $encoding = NULL])
:param string $str: Input string
:param string $encoding: Character set
@@ -172,7 +172,7 @@
For more information, please refer to the `PHP manual for
mb_strlen() <http://php.net/mb_strlen>`_.
-.. function:: mb_strpos($haystack, $needle[, $offset = 0[, $encoding = NULL]])
+.. php:function:: mb_strpos($haystack, $needle[, $offset = 0[, $encoding = NULL]])
:param string $haystack: String to search in
:param string $needle: Part of string to search for
@@ -184,7 +184,7 @@
For more information, please refer to the `PHP manual for
mb_strpos() <http://php.net/mb_strpos>`_.
-.. function:: mb_substr($str, $start[, $length = NULL[, $encoding = NULL]])
+.. php:function:: mb_substr($str, $start[, $length = NULL[, $encoding = NULL]])
:param string $str: Input string
:param int $start: Position of first character
@@ -211,7 +211,7 @@
Function reference
==================
-.. function:: array_column(array $array, $column_key[, $index_key = NULL])
+.. php:function:: array_column(array $array, $column_key[, $index_key = NULL])
:param array $array: Array to fetch results from
:param mixed $column_key: Key of the column to return values from
@@ -222,7 +222,7 @@
For more information, please refer to the `PHP manual for
array_column() <http://php.net/array_column>`_.
-.. function:: array_replace(array $array1[, ...])
+.. php:function:: array_replace(array $array1[, ...])
:param array $array1: Array in which to replace elements
:param array ...: Array (or multiple ones) from which to extract elements
@@ -232,7 +232,7 @@
For more information, please refer to the `PHP manual for
array_replace() <http://php.net/array_replace>`_.
-.. function:: array_replace_recursive(array $array1[, ...])
+.. php:function:: array_replace_recursive(array $array1[, ...])
:param array $array1: Array in which to replace elements
:param array ...: Array (or multiple ones) from which to extract elements
@@ -245,7 +245,7 @@
.. important:: Only PHP's native function can detect endless recursion.
Unless you are running PHP 5.3+, be careful with references!
-.. function:: hex2bin($data)
+.. php:function:: hex2bin($data)
:param array $data: Hexadecimal representation of data
:returns: Binary representation of the given data
@@ -254,7 +254,7 @@
For more information, please refer to the `PHP manual for hex2bin()
<http://php.net/hex2bin>`_.
-.. function:: quoted_printable_encode($str)
+.. php:function:: quoted_printable_encode($str)
:param string $str: Input string
:returns: 8bit-encoded string
diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst
index 4428c65..9c190fe 100644
--- a/user_guide_src/source/general/errors.rst
+++ b/user_guide_src/source/general/errors.rst
@@ -29,7 +29,7 @@
The following functions let you generate errors:
-.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
+.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
:param mixed $message: Error message
:param int $status_code: HTTP Response status code
@@ -54,7 +54,7 @@
to ``EXIT_ERROR``.
You can check in *application/config/constants.php* for more detail.
-.. function:: show_404($page = '', $log_error = TRUE)
+.. php:function:: show_404($page = '', $log_error = TRUE)
:param string $page: URI string
:param bool $log_error: Whether to log the error
@@ -78,7 +78,7 @@
CodeIgniter automatically logs any ``show_404()`` calls. Setting the
optional second parameter to FALSE will skip logging.
-.. function:: log_message($level, $message, $php_error = FALSE)
+.. php: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/general/reserved_names.rst b/user_guide_src/source/general/reserved_names.rst
index 9da94b3..a7b0c34 100644
--- a/user_guide_src/source/general/reserved_names.rst
+++ b/user_guide_src/source/general/reserved_names.rst
@@ -23,22 +23,22 @@
Functions
---------
-- :func:`is_php()`
-- :func:`is_really_writable()`
+- :php:func:`is_php()`
+- :php:func:`is_really_writable()`
- ``load_class()``
- ``is_loaded()``
- ``get_config()``
-- :func:`config_item()`
-- :func:`show_error()`
-- :func:`show_404()`
-- :func:`log_message()`
-- :func:`set_status_header()`
-- :func:`get_mimes()`
-- :func:`html_escape()`
-- :func:`remove_invisible_characters()`
-- :func:`is_https()`
-- :func:`function_usable()`
-- :func:`get_instance()`
+- :php:func:`config_item()`
+- :php:func:`show_error()`
+- :php:func:`show_404()`
+- :php:func:`log_message()`
+- :php:func:`set_status_header()`
+- :php:func:`get_mimes()`
+- :php:func:`html_escape()`
+- :php:func:`remove_invisible_characters()`
+- :php:func:`is_https()`
+- :php:func:`function_usable()`
+- :php:func:`get_instance()`
- ``_error_handler()``
- ``_exception_handler()``
- ``_stringify_attributes()``
diff --git a/user_guide_src/source/helpers/array_helper.rst b/user_guide_src/source/helpers/array_helper.rst
index 4805f58..d6b4877 100644
--- a/user_guide_src/source/helpers/array_helper.rst
+++ b/user_guide_src/source/helpers/array_helper.rst
@@ -26,7 +26,7 @@
The following functions are available:
-.. function:: element($item, $array[, $default = NULL])
+.. php:function:: element($item, $array[, $default = NULL])
:param string $item: Item to fetch from the array
:param array $array: Input array
@@ -51,7 +51,7 @@
echo element('size', $array, 'foobar'); // returns "foobar"
-.. function:: elements($items, $array[, $default = NULL])
+.. php:function:: elements($items, $array[, $default = NULL])
:param string $item: Item to fetch from the array
:param array $array: Input array
@@ -111,7 +111,7 @@
updated.
-.. function:: random_element($array)
+.. php:function:: random_element($array)
:param array $array: Input array
:returns: 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 4aacafd..986c1d3 100644
--- a/user_guide_src/source/helpers/captcha_helper.rst
+++ b/user_guide_src/source/helpers/captcha_helper.rst
@@ -132,7 +132,7 @@
The following functions are available:
-.. function:: create_captcha([$data = ''[, $img_path = ''[, $img_url = ''[, $font_path = '']]]])
+.. php:function:: create_captcha([$data = ''[, $img_path = ''[, $img_url = ''[, $font_path = '']]]])
:param array $data: Array of data for the CAPTCHA
:param string $img_path: Path to create the image in
diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
index 4a3298f..da26151 100644
--- a/user_guide_src/source/helpers/cookie_helper.rst
+++ b/user_guide_src/source/helpers/cookie_helper.rst
@@ -25,7 +25,7 @@
The following functions are available:
-.. function:: set_cookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]]])
+.. php:function:: set_cookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]]])
:param mixed $name: Cookie name *or* associative array of all of the parameters available to this function
:param string $value: Cookie value
@@ -42,7 +42,7 @@
a description of its use, as this function is an alias for
``CI_Input::set_cookie()``.
-.. function:: get_cookie($index[, $xss_clean = NULL]])
+.. php:function:: get_cookie($index[, $xss_clean = NULL]])
:param string $index: Cookie name
:param bool $xss_clean: Whether to apply XSS filtering to the returned value
@@ -56,7 +56,7 @@
the ``$config['cookie_prefix']`` that you might've set in your
*application/config/config.php* file.
-.. function:: delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]]])
+.. php: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 dcff7a4..bed3b32 100644
--- a/user_guide_src/source/helpers/date_helper.rst
+++ b/user_guide_src/source/helpers/date_helper.rst
@@ -24,7 +24,7 @@
The following functions are available:
-.. function:: now([$timezone = NULL])
+.. php:function:: now([$timezone = NULL])
:param string $timezone: Timezone
:returns: UNIX timestamp
@@ -43,7 +43,7 @@
If a timezone is not provided, it will return ``time()`` based on the
**time_reference** setting.
-.. function:: mdate([$datestr = ''[, $time = '']])
+.. php:function:: mdate([$datestr = ''[, $time = '']])
:param string $datestr: Date string
:param int $time: UNIX timestamp
@@ -67,7 +67,7 @@
If a timestamp is not included in the second parameter the current time
will be used.
-.. function:: standard_date([$fmt = 'DATE_RFC822'[, $time = NULL]])
+.. php:function:: standard_date([$fmt = 'DATE_RFC822'[, $time = NULL]])
:param string $fmt: Date format
:param int $time: UNIX timestamp
@@ -106,7 +106,7 @@
DATE_W3C W3C 2005-08-14T16:13:03+0000
=============== ======================= ======================================
-.. function:: local_to_gmt([$time = ''])
+.. php:function:: local_to_gmt([$time = ''])
:param int $time: UNIX timestamp
:returns: UNIX timestamp
@@ -118,7 +118,7 @@
$gmt = local_to_gmt(time());
-.. function:: gmt_to_local([$time = ''[, $timezone = 'UTC'[, $dst = FALSE]]])
+.. php:function:: gmt_to_local([$time = ''[, $timezone = 'UTC'[, $dst = FALSE]]])
:param int $time: UNIX timestamp
:param string $timezone: Timezone
@@ -140,7 +140,7 @@
.. note:: For a list of timezones see the reference at the bottom of this page.
-.. function:: mysql_to_unix([$time = ''])
+.. php:function:: mysql_to_unix([$time = ''])
:param string $time: MySQL timestamp
:returns: UNIX timestamp
@@ -152,7 +152,7 @@
$unix = mysql_to_unix('20061124092345');
-.. function:: unix_to_human([$time = ''[, $seconds = FALSE[, $fmt = 'us']]])
+.. php:function:: unix_to_human([$time = ''[, $seconds = FALSE[, $fmt = 'us']]])
:param int $time: UNIX timestamp
:param bool $seconds: Whether to show seconds
@@ -179,13 +179,13 @@
echo unix_to_human($now, TRUE, 'us'); // U.S. time with seconds
echo unix_to_human($now, TRUE, 'eu'); // Euro time with seconds
-.. function:: human_to_unix([$datestr = ''])
+.. php:function:: human_to_unix([$datestr = ''])
:param int $datestr: Date string
:returns: UNIX timestamp or FALSE on failure
:rtype: int
- The opposite of the :func:`unix_to_time()` function. Takes a "human"
+ The opposite of the :php:func:`unix_to_time()` function. Takes a "human"
time as input and returns it as a UNIX timestamp. This is useful if you
accept "human" formatted dates submitted via a form. Returns boolean FALSE
date string passed to it is not formatted as indicated above.
@@ -196,7 +196,7 @@
$human = unix_to_human($now);
$unix = human_to_unix($human);
-.. function:: nice_date([$bad_date = ''[, $format = FALSE]])
+.. php: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)
@@ -220,7 +220,7 @@
// Should Produce: 2001-09-11
$better_date = nice_date($bad_date, 'Y-m-d');
-.. function:: timespan([$seconds = 1[, $time = ''[, $units = '']]])
+.. php:function:: timespan([$seconds = 1[, $time = ''[, $units = '']]])
:param int $seconds: Number of seconds
:param string $time: UNIX timestamp
@@ -252,7 +252,7 @@
.. note:: The text generated by this function is found in the following language
file: `language/<your_lang>/date_lang.php`
-.. function:: days_in_month([$month = 0[, $year = '']])
+.. php:function:: days_in_month([$month = 0[, $year = '']])
:param int $month: a numeric month
:param int $year: a numeric year
@@ -271,7 +271,7 @@
.. note:: This function will alias the native ``cal_days_in_month()``, if
it is available.
-.. function:: date_range([$unix_start = ''[, $mixed = ''[, $is_unix = TRUE[, $format = 'Y-m-d']]]])
+.. php: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
@@ -291,7 +291,7 @@
echo $date."\n";
}
-.. function:: timezones([$tz = ''])
+.. php:function:: timezones([$tz = ''])
:param string $tz: A numeric timezone
:returns: Hour difference from UTC
@@ -306,9 +306,9 @@
echo timezones('UM5');
- This function is useful when used with :func:`timezone_menu()`.
+ This function is useful when used with :php:func:`timezone_menu()`.
-.. function:: timezone_menu([$default = 'UTC'[, $class = ''[, $name = 'timezones'[, $attributes = '']]]])
+.. php: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/directory_helper.rst b/user_guide_src/source/helpers/directory_helper.rst
index 030e0ef..b5f1093 100644
--- a/user_guide_src/source/helpers/directory_helper.rst
+++ b/user_guide_src/source/helpers/directory_helper.rst
@@ -27,7 +27,7 @@
The following functions are available:
-.. function:: directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]])
+.. php:function:: directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]])
:param string $source_dir: Path to the source directory
:param int $directory_depth: Depth of directories to traverse (0 = fully recursive, 1 = current dir, etc)
diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst
index f374d49..1a40650 100644
--- a/user_guide_src/source/helpers/download_helper.rst
+++ b/user_guide_src/source/helpers/download_helper.rst
@@ -24,7 +24,7 @@
The following functions are available:
-.. function:: force_download([$filename = ''[, $data = ''[, $set_mime = FALSE]]])
+.. php: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 3b771a0..6852269 100644
--- a/user_guide_src/source/helpers/email_helper.rst
+++ b/user_guide_src/source/helpers/email_helper.rst
@@ -29,7 +29,7 @@
The following functions are available:
-.. function:: valid_email($email)
+.. php:function:: valid_email($email)
:param string $email: E-mail address
:returns: TRUE if a valid email is supplied, FALSE otherwise
@@ -54,7 +54,7 @@
(bool) filter_var($email, FILTER_VALIDATE_EMAIL);
-.. function:: send_email($recipient, $subject, $message)
+.. php: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 013b583..92cb31a 100644
--- a/user_guide_src/source/helpers/file_helper.rst
+++ b/user_guide_src/source/helpers/file_helper.rst
@@ -24,7 +24,7 @@
The following functions are available:
-.. function:: read_file($file)
+.. php:function:: read_file($file)
:param string $file: File path
:returns: File contents or FALSE on failure
@@ -49,7 +49,7 @@
function might not work if you are trying to access a file above the
calling script.
-.. function:: write_file($path, $data[, $mode = 'wb'])
+.. php:function:: write_file($path, $data[, $mode = 'wb'])
:param string $path: File path
:param string $data: Data to write to file
@@ -89,7 +89,7 @@
.. note:: This function acquires an exclusive lock on the file while writing to it.
-.. function:: delete_files($path[, $del_dir = FALSE[, $htdocs = FALSE]])
+.. php: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 @@
.. note:: The files must be writable or owned by the system in order to be deleted.
-.. function:: get_filenames($source_dir[, $include_path = FALSE])
+.. php: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
@@ -127,7 +127,7 @@
$controllers = get_filenames(APPPATH.'controllers/');
-.. function:: get_dir_file_info($source_dir, $top_level_only)
+.. php:function:: get_dir_file_info($source_dir, $top_level_only)
:param string $source_dir: Directory path
:param bool $top_level_only: Whether to look only at the specified directory (excluding sub-directories)
@@ -143,7 +143,7 @@
$models_info = get_dir_file_info(APPPATH.'models/');
-.. function:: get_file_info($file[, $returned_values = array('name', 'server_path', 'size', 'date')])
+.. php: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
@@ -157,7 +157,7 @@
Valid ``$returned_values`` options are: `name`, `size`, `date`, `readable`, `writeable`,
`executable` and `fileperms`.
-.. function:: get_mime_by_extension($filename)
+.. php:function:: get_mime_by_extension($filename)
:param string $filename: File name
:returns: MIME type string or FALSE on failure
@@ -175,7 +175,7 @@
is here strictly for convenience. It should not be used for security
purposes.
-.. function:: symbolic_permissions($perms)
+.. php:function:: symbolic_permissions($perms)
:param int $perms: Permissions
:returns: Symbolic permissions string
@@ -188,7 +188,7 @@
echo symbolic_permissions(fileperms('./index.php')); // -rw-r--r--
-.. function:: octal_permissions($perms)
+.. php:function:: octal_permissions($perms)
:param int $perms: Permissions
:returns: Octal permissions string
diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst
index 5af0d40..15f5d78 100644
--- a/user_guide_src/source/helpers/form_helper.rst
+++ b/user_guide_src/source/helpers/form_helper.rst
@@ -34,7 +34,7 @@
<input type="text" name="myfield" value="<?php echo $string; ?>" />
Since the above string contains a set of quotes, it will cause the form
-to break. The :func:`html_escape()` function converts HTML special
+to break. The :php:func:`html_escape()` function converts HTML special
characters so that it can be used safely::
<input type="text" name="myfield" value="<?php echo html_escape($string); ?>" />
@@ -50,7 +50,7 @@
The following functions are available:
-.. function:: form_open([$action = ''[, $attributes = ''[, $hidden = array()]]])
+.. php:function:: form_open([$action = ''[, $attributes = ''[, $hidden = array()]]])
:param string $action: Form action/target URI string
:param array $attributes: HTML attributes
@@ -108,7 +108,7 @@
<input type="hidden" name="member_id" value="234" />
-.. function:: form_open_multipart([$action = ''[, $attributes = array()[, $hidden = array()]])
+.. php:function:: form_open_multipart([$action = ''[, $attributes = array()[, $hidden = array()]])
:param string $action: Form action/target URI string
:param array $attributes: HTML attributes
@@ -116,12 +116,12 @@
:returns: An HTML multipart form opening tag
:rtype: string
- This function is absolutely identical to :func:`form_open()` above,
+ This function is absolutely identical to :php:func:`form_open()` above,
except that it adds a *multipart* attribute, which is necessary if you
would like to use the form to upload files with.
-.. function:: form_hidden($name[, $value = ''])
+.. php:function:: form_hidden($name[, $value = ''])
:param string $name: Field name
:param string $value: Field value
@@ -187,7 +187,7 @@
<input type="hidden" name="email" value="john@example.com" id="hiddenemail" class="hiddenemail" />
*/
-.. function:: form_input([$data = ''[, $value = ''[, $extra = '']])
+.. php:function:: form_input([$data = ''[, $value = ''[, $extra = '']])
:param array $data: Field attributes data
:param string $value: Field value
@@ -226,7 +226,7 @@
$js = 'onClick="some_function()"';
echo form_input('username', 'johndoe', $js);
-.. function:: form_password([$data = ''[, $value = ''[, $extra = '']]])
+.. php:function:: form_password([$data = ''[, $value = ''[, $extra = '']]])
:param array $data: Field attributes data
:param string $value: Field value
@@ -234,11 +234,11 @@
:returns: An HTML password input field tag
:rtype: string
- This function is identical in all respects to the :func:`form_input()`
+ This function is identical in all respects to the :php:func:`form_input()`
function above except that it uses the "password" input type.
-.. function:: form_upload([$data = ''[, $value = ''[, $extra = '']]])
+.. php:function:: form_upload([$data = ''[, $value = ''[, $extra = '']]])
:param array $data: Field attributes data
:param string $value: Field value
@@ -246,12 +246,12 @@
:returns: An HTML file upload input field tag
:rtype: string
- This function is identical in all respects to the :func:`form_input()`
+ This function is identical in all respects to the :php:func:`form_input()`
function above except that it uses the "file" input type, allowing it to
be used to upload files.
-.. function:: form_textarea([$data = ''[, $value = ''[, $extra = '']]])
+.. php:function:: form_textarea([$data = ''[, $value = ''[, $extra = '']]])
:param array $data: Field attributes data
:param string $value: Field value
@@ -259,13 +259,13 @@
:returns: An HTML textarea tag
:rtype: string
- This function is identical in all respects to the :func:`form_input()`
+ This function is identical in all respects to the :php:func:`form_input()`
function above except that it generates a "textarea" type.
.. note:: Instead of the *maxlength* and *size* attributes in the above example,
you will instead specify *rows* and *cols*.
-.. function:: form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])
+.. php: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
@@ -329,7 +329,7 @@
label.
-.. function:: form_multiselect([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])
+.. php: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
@@ -343,12 +343,12 @@
associative array of options, and the third parameter will contain the
value or values you wish to be selected.
- The parameter usage is identical to using :func:`form_dropdown()` above,
+ The parameter usage is identical to using :php:func:`form_dropdown()` above,
except of course that the name of the field will need to use POST array
syntax, e.g. foo[].
-.. function:: form_fieldset([$legend_text = ''[, $attributes = array()]])
+.. php: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
@@ -394,7 +394,7 @@
*/
-.. function:: form_fieldset_close([$extra = ''])
+.. php:function:: form_fieldset_close([$extra = ''])
:param string $extra: Anything to append after the closing tag, *as is*
:returns: An HTML fieldset closing tag
@@ -412,7 +412,7 @@
// Would produce: </fieldset></div></div>
-.. function:: form_checkbox([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])
+.. php:function:: form_checkbox([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])
:param array $data: Field attributes data
:param string $value: Field value
@@ -451,7 +451,7 @@
echo form_checkbox('newsletter', 'accept', TRUE, $js)
-.. function:: form_radio([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])
+.. php:function:: form_radio([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])
:param array $data: Field attributes data
:param string $value: Field value
@@ -460,11 +460,11 @@
:returns: An HTML radio input tag
:rtype: string
- This function is identical in all respects to the :func:`form_checkbox()`
+ This function is identical in all respects to the :php:func:`form_checkbox()`
function above except that it uses the "radio" input type.
-.. function:: form_label([$label_text = ''[, $id = ''[, $attributes = array()]]])
+.. php: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
@@ -491,7 +491,7 @@
// Would produce: <label for="username" class="mycustomclass" style="color: #000;">What is your Name</label>
-.. function:: form_submit([$data = ''[, $value = ''[, $extra = '']]])
+.. php:function:: form_submit([$data = ''[, $value = ''[, $extra = '']]])
:param string $data: Button name
:param string $value: Button value
@@ -509,7 +509,7 @@
parameter lets you add extra data to your form, like JavaScript.
-.. function:: form_reset([$data = ''[, $value = ''[, $extra = '']]])
+.. php:function:: form_reset([$data = ''[, $value = ''[, $extra = '']]])
:param string $data: Button name
:param string $value: Button value
@@ -521,7 +521,7 @@
:func:`form_submit()`.
-.. function:: form_button([$data = ''[, $content = ''[, $extra = '']]])
+.. php:function:: form_button([$data = ''[, $content = ''[, $extra = '']]])
:param string $data: Button name
:param string $content: Button label
@@ -556,7 +556,7 @@
echo form_button('mybutton', 'Click Me', $js);
-.. function:: form_close([$extra = ''])
+.. php:function:: form_close([$extra = ''])
:param string $extra: Anything to append after the closing tag, *as is*
:returns: An HTML form closing tag
@@ -571,7 +571,7 @@
// Would produce: </form> </div></div>
-.. function:: set_value($field[, $default = ''])
+.. php:function:: set_value($field[, $default = ''])
:param string $field: Field name
:param string $default: Default value
@@ -590,11 +590,11 @@
The above form will show "0" when loaded for the first time.
.. note:: Only use this function with raw HTML fields, as it
- internally calls :func:`html_escape()` and combining its
+ internally calls :php:func:`html_escape()` and combining its
usage with other form helper functions will result in
double HTML encoding!
-.. function:: set_select($field[, $value = ''[, $default = FALSE]])
+.. php:function:: set_select($field[, $value = ''[, $default = FALSE]])
:param string $field: Field name
:param string $value: Value to check for
@@ -617,7 +617,7 @@
<option value="three" <?php echo set_select('myselect', 'three'); ?> >Three</option>
</select>
-.. function:: set_checkbox($field[, $value = ''[, $default = FALSE]])
+.. php:function:: set_checkbox($field[, $value = ''[, $default = FALSE]])
:param string $field: Field name
:param string $value: Value to check for
@@ -636,7 +636,7 @@
<input type="checkbox" name="mycheck" value="1" <?php echo set_checkbox('mycheck', '1'); ?> />
<input type="checkbox" name="mycheck" value="2" <?php echo set_checkbox('mycheck', '2'); ?> />
-.. function:: set_radio($field[, $value = ''[, $default = FALSE]])
+.. php:function:: set_radio($field[, $value = ''[, $default = FALSE]])
:param string $field: Field name
:param string $value: Value to check for
@@ -645,7 +645,7 @@
:rtype: string
Permits you to display radio buttons in the state they were submitted.
- This function is identical to the :func:`set_checkbox()` function above.
+ This function is identical to the :php:func:`set_checkbox()` function above.
Example::
@@ -658,7 +658,7 @@
defined, the control for ``set_*()`` is handed over to a method of the
class instead of the generic helper function.
-.. function:: form_error([$field = ''[, $prefix = ''[, $suffix = '']]])
+.. php:function:: form_error([$field = ''[, $prefix = ''[, $suffix = '']]])
:param string $field: Field name
:param string $prefix: Error opening tag
@@ -679,14 +679,14 @@
// Would produce: <div class="error">Error message associated with the "username" field.</div>
-.. function:: validation_errors([$prefix = ''[, $suffix = '']])
+.. php:function:: validation_errors([$prefix = ''[, $suffix = '']])
:param string $prefix: Error opening tag
:param string $suffix: Error closing tag
:returns: HTML-formatted form validation error message(s)
:rtype: string
- Similarly to the :func:`form_error()` function, returns all validation
+ Similarly to the :php:func:`form_error()` function, returns all validation
error messages produced by the :doc:`Form Validation Library
<../libraries/form_validation>`, with optional opening and closing tags
around each of the messages.
@@ -703,7 +703,7 @@
*/
-.. function:: form_prep($str)
+.. php:function:: form_prep($str)
:param string $str: Value to escape
:returns: Escaped value
diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index ff387be..d35be39 100644
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -25,7 +25,7 @@
The following functions are available:
-.. function:: heading([$data = ''[, $h = '1'[, $attributes = '']]])
+.. php:function:: heading([$data = ''[, $h = '1'[, $attributes = '']]])
:param string $data: Content
:param string $h: Heading level
@@ -51,7 +51,7 @@
<h3 class="pink">Welcome!<h3>
-.. function:: img([$src = ''[, $index_page = FALSE[, $attributes = '']]])
+.. php: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
@@ -90,7 +90,7 @@
img($image_properties);
// <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" />
-.. function:: link_tag([$href = ''[, $rel = 'stylesheet'[, $type = 'text/css'[, $title = ''[, $media = ''[, $index_page = FALSE]]]]]])
+.. php:function:: link_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
@@ -135,7 +135,7 @@
// <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" />
-.. function:: ul($list[, $attributes = ''])
+.. php:function:: ul($list[, $attributes = ''])
:param array $list: List entries
:param array $attributes: HTML attributes
@@ -255,17 +255,17 @@
</li>
</ul>
-.. function:: ol($list, $attributes = '')
+.. php:function:: ol($list, $attributes = '')
:param array $list: List entries
:param array $attributes: HTML attributes
:returns: HTML-formatted ordered list
:rtype: string
- Identical to :func:`ul()`, only it produces the <ol> tag for
+ Identical to :php:func:`ul()`, only it produces the <ol> tag for
ordered lists instead of <ul>.
-.. function:: meta([$name = ''[, $content = ''[, $type = 'name'[, $newline = "\n"]]]])
+.. php:function:: meta([$name = ''[, $content = ''[, $type = 'name'[, $newline = "\n"]]]])
:param string $name: Meta name
:param string $content: Meta content
@@ -321,7 +321,7 @@
// <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-.. function:: doctype([$type = 'xhtml1-strict'])
+.. php:function:: doctype([$type = 'xhtml1-strict'])
:param string $type: Doctype name
:returns: HTML DocType tag
@@ -363,7 +363,7 @@
XHTML+RDFa 1.1 xhtml-rdfa-2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">
=============================== =================== ==================================================================================================================================================
-.. function:: br([$count = 1])
+.. php:function:: br([$count = 1])
:param int $count: Number of times to repeat the tag
:returns: HTML line break tag
@@ -383,7 +383,7 @@
.. note:: This function is DEPRECATED. Use the native ``str_repeat()``
in combination with ``<br />`` instead.
-.. function:: nbs([$num = 1])
+.. php:function:: nbs([$num = 1])
:param int $num: Number of space entities to produce
:returns: A sequence of non-breaking space HTML entities
diff --git a/user_guide_src/source/helpers/inflector_helper.rst b/user_guide_src/source/helpers/inflector_helper.rst
index d0cb17c..ed1e2b3 100644
--- a/user_guide_src/source/helpers/inflector_helper.rst
+++ b/user_guide_src/source/helpers/inflector_helper.rst
@@ -25,7 +25,7 @@
The following functions are available:
-.. function:: singular($str)
+.. php:function:: singular($str)
:param string $str: Input string
:returns: A singular word
@@ -35,7 +35,7 @@
echo singular('dogs'); // Prints 'dog'
-.. function:: plural($str)
+.. php:function:: plural($str)
:param string $str: Input string
:returns: A plular word
@@ -45,7 +45,7 @@
echo plural('dog'); // Prints 'dogs'
-.. function:: camelize($str)
+.. php:function:: camelize($str)
:param string $str: Input string
:returns: Camelized string
@@ -56,7 +56,7 @@
echo camelize('my_dog_spot'); // Prints 'myDogSpot'
-.. function:: underscore($str)
+.. php:function:: underscore($str)
:param string $str: Input string
:returns: String containing underscores instead of spaces
@@ -67,7 +67,7 @@
echo underscore('my dog spot'); // Prints 'my_dog_spot'
-.. function:: humanize($str[, $separator = '_'])
+.. php:function:: humanize($str[, $separator = '_'])
:param string $str: Input string
:param string $separator: Input separator
@@ -85,7 +85,7 @@
echo humanize('my-dog-spot', '-'); // Prints 'My Dog Spot'
-.. function:: is_countable($word)
+.. php:function:: is_countable($word)
:param string $word: Input string
:returns: TRUE if the word is countable or FALSE if not
diff --git a/user_guide_src/source/helpers/language_helper.rst b/user_guide_src/source/helpers/language_helper.rst
index e4d0937..cadf3c0 100644
--- a/user_guide_src/source/helpers/language_helper.rst
+++ b/user_guide_src/source/helpers/language_helper.rst
@@ -25,7 +25,7 @@
The following functions are available:
-.. function:: lang($line[, $for = ''[, $attributes = array()]])
+.. php: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)
diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst
index 2de4457..9d5e98c 100644
--- a/user_guide_src/source/helpers/number_helper.rst
+++ b/user_guide_src/source/helpers/number_helper.rst
@@ -25,7 +25,7 @@
The following functions are available:
-.. function:: byte_format($num[, $precision = 1])
+.. php:function:: byte_format($num[, $precision = 1])
:param mixed $num: Number of bytes
:param int $precision: Floating point precision
diff --git a/user_guide_src/source/helpers/path_helper.rst b/user_guide_src/source/helpers/path_helper.rst
index 705ca23..f46cbad 100644
--- a/user_guide_src/source/helpers/path_helper.rst
+++ b/user_guide_src/source/helpers/path_helper.rst
@@ -25,7 +25,7 @@
The following functions are available:
-.. function:: set_realpath($path[, $check_existance = FALSE])
+.. php:function:: set_realpath($path[, $check_existance = FALSE])
:param string $path: Path
:param bool $check_existance: Whether to check if the path actually exists
diff --git a/user_guide_src/source/helpers/security_helper.rst b/user_guide_src/source/helpers/security_helper.rst
index 2e26890..103880c 100644
--- a/user_guide_src/source/helpers/security_helper.rst
+++ b/user_guide_src/source/helpers/security_helper.rst
@@ -24,7 +24,7 @@
The following functions are available:
-.. function:: xss_clean($str[, $is_image = FALSE])
+.. php:function:: xss_clean($str[, $is_image = FALSE])
:param string $str: Input data
:param bool $is_image: Whether we're dealing with an image
@@ -36,7 +36,7 @@
This function is an alias for ``CI_Input::xss_clean()``. For more info,
please see the :doc:`Input Library <../libraries/input>` documentation.
-.. function:: sanitize_filename($filename)
+.. php:function:: sanitize_filename($filename)
:param string $filename: Filename
:returns: Sanitized file name
@@ -49,7 +49,7 @@
documentation.
-.. function:: do_hash($str[, $type = 'sha1'])
+.. php:function:: do_hash($str[, $type = 'sha1'])
:param string $str: Input
:param string $type: Algorithm
@@ -73,7 +73,7 @@
.. note:: This function is DEPRECATED. Use the native ``hash()`` instead.
-.. function:: strip_image_tags($str)
+.. php:function:: strip_image_tags($str)
:param string $str: Input string
:returns: The input string with no image tags
@@ -91,7 +91,7 @@
documentation.
-.. function:: encode_php_tags($str)
+.. php:function:: encode_php_tags($str)
:param string $str: Input string
:returns: Safely formatted string
@@ -99,7 +99,7 @@
This is a security function that converts PHP tags to entities.
- .. note:: :func:`xss_clean()` does this automatically, if you use it.
+ .. note:: :php:func:`xss_clean()` does this automatically, if you use it.
Example::
diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst
index 5de1d83..978d11e 100644
--- a/user_guide_src/source/helpers/smiley_helper.rst
+++ b/user_guide_src/source/helpers/smiley_helper.rst
@@ -54,7 +54,7 @@
In your **application/controllers/** directory, create a file called
Smileys.php and place the code below in it.
-.. important:: Change the URL in the :func:`get_clickable_smileys()`
+.. important:: Change the URL in the :php:func:`get_clickable_smileys()`
function below so that it points to your smiley folder.
You'll notice that in addition to the smiley helper, we are also using
@@ -115,7 +115,7 @@
Available Functions
===================
-.. function:: get_clickable_smileys($image_url[, $alias = ''[, $smileys = NULL]])
+.. php:function:: get_clickable_smileys($image_url[, $alias = ''[, $smileys = NULL]])
:param string $image_url: URL path to the smileys directory
:param string $alias: Field alias
@@ -130,7 +130,7 @@
$image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comment');
-.. function:: smiley_js([$alias = ''[, $field_id = ''[, $inline = TRUE]]])
+.. php:function:: smiley_js([$alias = ''[, $field_id = ''[, $inline = TRUE]]])
:param string $alias: Field alias
:param string $field_id: Field ID
@@ -148,7 +148,7 @@
<?php echo smiley_js(); ?>
-.. function:: parse_smileys([$str = ''[, $image_url = ''[, $smileys = NULL]]])
+.. php: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 922bc6b..9d0d890 100644
--- a/user_guide_src/source/helpers/string_helper.rst
+++ b/user_guide_src/source/helpers/string_helper.rst
@@ -25,7 +25,7 @@
The following functions are available:
-.. function:: random_string([$type = 'alnum'[, $len = 8]])
+.. php:function:: random_string([$type = 'alnum'[, $len = 8]])
:param string $type: Randomization type
:param int $len: Output string length
@@ -53,7 +53,7 @@
.. note:: Usage of the *unique* and *encrypt* types is DEPRECATED. They
are just aliases for *md5* and *sha1* respectively.
-.. function:: increment_string($str[, $separator = '_'[, $first = 1]])
+.. php:function:: increment_string($str[, $separator = '_'[, $first = 1]])
:param string $str: Input string
:param string $separator: Separator to append a duplicate number with
@@ -72,7 +72,7 @@
echo increment_string('file_4'); // "file_5"
-.. function:: alternator($args)
+.. php:function:: alternator($args)
:param mixed $args: A variable number of arguments
:returns: Alternated string(s)
@@ -99,7 +99,7 @@
.. note:: To use multiple separate calls to this function simply call the
function with no arguments to re-initialize.
-.. function:: repeater($data[, $num = 1])
+.. php:function:: repeater($data[, $num = 1])
:param string $data: Input
:param int $num: Number of times to repeat
@@ -117,7 +117,7 @@
instead.
-.. function:: reduce_double_slashes($str)
+.. php:function:: reduce_double_slashes($str)
:param string $str: Input string
:returns: A string with normalized slashes
@@ -132,7 +132,7 @@
echo reduce_double_slashes($string); // results in "http://example.com/index.php"
-.. function:: strip_slashes($data)
+.. php:function:: strip_slashes($data)
:param mixed $data: Input string or an array of strings
:returns: String(s) with stripped slashes
@@ -160,7 +160,7 @@
and handle string inputs. This however makes it just an
alias for ``stripslashes()``.
-.. function:: trim_slashes($str)
+.. php:function:: trim_slashes($str)
:param string $str: Input string
:returns: Slash-trimmed string
@@ -175,7 +175,7 @@
|
| trim($str, '/');
-.. function:: reduce_multiples($str[, $character = ''[, $trim = FALSE]])
+.. php:function:: reduce_multiples($str[, $character = ''[, $trim = FALSE]])
:param string $str: Text to search in
:param string $character: Character to reduce
@@ -195,7 +195,7 @@
$string = ",Fred, Bill,, Joe, Jimmy,";
$string = reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy"
-.. function:: quotes_to_entities($str)
+.. php:function:: quotes_to_entities($str)
:param string $str: Input string
:returns: String with quotes converted to HTML entities
@@ -208,7 +208,7 @@
$string = quotes_to_entities($string); //results in "Joe's "dinner""
-.. function:: strip_quotes($str)
+.. php:function:: strip_quotes($str)
:param string $str: Input string
:returns: String with quotes stripped
diff --git a/user_guide_src/source/helpers/text_helper.rst b/user_guide_src/source/helpers/text_helper.rst
index 88a6d06..d1723c5 100644
--- a/user_guide_src/source/helpers/text_helper.rst
+++ b/user_guide_src/source/helpers/text_helper.rst
@@ -24,7 +24,7 @@
The following functions are available:
-.. function:: word_limiter($str[, $limit = 100[, $end_char = '…']])
+.. php:function:: word_limiter($str[, $limit = 100[, $end_char = '…']])
:param string $str: Input string
:param int $limit: Limit
@@ -42,7 +42,7 @@
default it adds an ellipsis.
-.. function:: character_limiter($str[, $n = 500[, $end_char = '…']])
+.. php:function:: character_limiter($str[, $n = 500[, $end_char = '…']])
:param string $str: Input string
:param int $n: Number of characters
@@ -64,9 +64,9 @@
undeclared this helper uses an ellipsis.
.. note:: If you need to truncate to an exact number of characters please
- see the :func:`ellipsize()` function below.
+ see the :php:func:`ellipsize()` function below.
-.. function:: ascii_to_entities($str)
+.. php:function:: ascii_to_entities($str)
:param string $str: Input string
:returns: A string with ASCII values converted to entities
@@ -84,17 +84,17 @@
$string = ascii_to_entities($string);
-.. function::entities_to_ascii($str[, $all = TRUE])
+.. php:function::entities_to_ascii($str[, $all = TRUE])
:param string $str: Input string
:param bool $all: Whether to convert unsafe entities as well
:returns: A string with HTML entities converted to ASCII characters
:rtype: string
- This function does the opposite of :func:`ascii_to_entities()`.
+ This function does the opposite of :php:func:`ascii_to_entities()`.
It turns character entities back into ASCII.
-.. function:: convert_accented_characters($str)
+.. php:function:: convert_accented_characters($str)
:param string $str: Input string
:returns: A string with accented characters converted
@@ -112,7 +112,7 @@
`application/config/foreign_chars.php` to define the to and
from array for transliteration.
-.. function:: word_censor($str, $censored[, $replacement = ''])
+.. php:function:: word_censor($str, $censored[, $replacement = ''])
:param string $str: Input string
:param array $censored: List of bad words to censor
@@ -131,7 +131,7 @@
$disallowed = array('darn', 'shucks', 'golly', 'phooey');
$string = word_censor($string, $disallowed, 'Beep!');
-.. function:: highlight_code($str)
+.. php:function:: highlight_code($str)
:param string $str: Input string
:returns: String with code highlighted via HTML
@@ -145,7 +145,7 @@
colors used are the ones specified in your php.ini file.
-.. function:: highlight_phrase($str, $phrase[, $tag_open = '<mark>'[, $tag_close = '</mark>']])
+.. php:function:: highlight_phrase($str, $phrase[, $tag_open = '<mark>'[, $tag_close = '</mark>']])
:param string $str: Input string
:param string $phrase: Phrase to highlight
@@ -178,7 +178,7 @@
color: #000;
};
-.. function:: word_wrap($str[, $charlim = 76])
+.. php:function:: word_wrap($str[, $charlim = 76])
:param string $str: Input string
:param int $charlim: Character limit
@@ -195,7 +195,7 @@
// Would produce: Here is a simple string of text that will help us demonstrate this function
-.. function:: ellipsize($str, $max_length[, $position = 1[, $ellipsis = '…']])
+.. php: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 deb3d16..7eb4fce 100644
--- a/user_guide_src/source/helpers/typography_helper.rst
+++ b/user_guide_src/source/helpers/typography_helper.rst
@@ -25,7 +25,7 @@
The following functions are available:
-.. function:: auto_typography($str[, $reduce_linebreaks = FALSE])
+.. php: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
@@ -49,7 +49,7 @@
pages.
-.. function:: nl2br_except_pre($str)
+.. php:function:: nl2br_except_pre($str)
:param string $str: Input string
:returns: String with HTML-formatted line breaks
@@ -63,7 +63,7 @@
$string = nl2br_except_pre($string);
-.. function:: entity_decode($str, $charset = NULL)
+.. php:function:: entity_decode($str, $charset = NULL)
:param string $str: Input string
:param string $charset: Character set
diff --git a/user_guide_src/source/helpers/url_helper.rst b/user_guide_src/source/helpers/url_helper.rst
index 3bdcb8e..83864d9 100644
--- a/user_guide_src/source/helpers/url_helper.rst
+++ b/user_guide_src/source/helpers/url_helper.rst
@@ -23,7 +23,7 @@
Available Functions
===================
-.. function:: site_url([$uri = ''[, $protocol = NULL]])
+.. php:function:: site_url([$uri = ''[, $protocol = NULL]])
:param string $uri: URI string
:param string $protocol: Protocol, e.g. 'http' or 'https'
@@ -55,7 +55,7 @@
This function is an alias for ``CI_Config::site_url()``. For more info,
please see the :doc:`Config Library <../libraries/config>` documentation.
-.. function:: base_url($uri = '', $protocol = NULL)
+.. php:function:: base_url($uri = '', $protocol = NULL)
:param string $uri: URI string
:param string $protocol: Protocol, e.g. 'http' or 'https'
@@ -66,10 +66,10 @@
echo base_url();
- This function returns the same thing as :func:`site_url()`, without
+ This function returns the same thing as :php:func:`site_url()`, without
the *index_page* or *url_suffix* being appended.
- Also like :func:`site_url()`, you can supply segments as a string or
+ Also like :php:func:`site_url()`, you can supply segments as a string or
an array. Here is a string example::
echo base_url("blog/post/123");
@@ -77,7 +77,7 @@
The above example would return something like:
*http://example.com/blog/post/123*
- This is useful because unlike :func:`site_url()`, you can supply a
+ This is useful because unlike :php:func:`site_url()`, you can supply a
string to a file, such as an image or stylesheet. For example::
echo base_url("images/icons/edit.png");
@@ -88,7 +88,7 @@
This function is an alias for ``CI_Config::base_url()``. For more info,
please see the :doc:`Config Library <../libraries/config>` documentation.
-.. function:: current_url()
+.. php:function:: current_url()
:returns: The current URL
:rtype: string
@@ -101,7 +101,7 @@
| site_url(uri_string());
-.. function:: uri_string()
+.. php:function:: uri_string()
:returns: An URI string
:rtype: string
@@ -119,7 +119,7 @@
please see the :doc:`Config Library <../libraries/config>` documentation.
-.. function:: index_page()
+.. php:function:: index_page()
:returns: 'index_page' value
:rtype: mixed
@@ -129,7 +129,7 @@
echo index_page();
-.. function:: anchor($uri = '', $title = '', $attributes = '')
+.. php:function:: anchor($uri = '', $title = '', $attributes = '')
:param string $uri: URI string
:param string $title: Anchor title
@@ -140,7 +140,7 @@
Creates a standard HTML anchor link based on your local site URL.
The first parameter can contain any segments you wish appended to the
- URL. As with the :func:`site_url()` function above, segments can
+ URL. As with the :php:func:`site_url()` function above, segments can
be a string or an array.
.. note:: If you are building links that are internal to your application
@@ -167,7 +167,7 @@
// Prints: <a href="http://example.com">Click Here</a>
-.. function:: anchor_popup($uri = '', $title = '', $attributes = FALSE)
+.. php:function:: anchor_popup($uri = '', $title = '', $attributes = FALSE)
:param string $uri: URI string
:param string $title: Anchor title
@@ -175,7 +175,7 @@
:returns: Pop-up hyperlink
:rtype: string
- Nearly identical to the :func:`anchor()` function except that it
+ Nearly identical to the :php:func:`anchor()` function except that it
opens the URL in a new window. You can specify JavaScript window
attributes in the third parameter to control how the window is opened.
If the third parameter is not set it will simply open a new window with
@@ -211,7 +211,7 @@
HTML attribute to the anchor tag.
-.. function:: mailto($email, $title = '', $attributes = '')
+.. php:function:: mailto($email, $title = '', $attributes = '')
:param string $email: E-mail address
:param string $title: Anchor title
@@ -223,13 +223,13 @@
echo mailto('me@my-site.com', 'Click Here to Contact Me');
- As with the :func:`anchor()` tab above, you can set attributes using the
+ As with the :php:func:`anchor()` tab above, you can set attributes using the
third parameter::
$attributes = array('title' => 'Mail me');
echo mailto('me@my-site.com', 'Contact Me', $attributes);
-.. function:: safe_mailto($email, $title = '', $attributes = '')
+.. php:function:: safe_mailto($email, $title = '', $attributes = '')
:param string $email: E-mail address
:param string $title: Anchor title
@@ -237,11 +237,11 @@
:returns: A spam-safe "mail to" hyperlink
:rtype: string
- Identical to the :func:`mailto()` function except it writes an obfuscated
+ Identical to the :php:func:`mailto()` function except it writes an obfuscated
version of the *mailto* tag using ordinal numbers written with JavaScript to
help prevent the e-mail address from being harvested by spam bots.
-.. function:: auto_link($str, $type = 'both', $popup = FALSE)
+.. php:function:: auto_link($str, $type = 'both', $popup = FALSE)
:param string $str: Input string
:param string $type: Link type ('email', 'url' or 'both')
@@ -256,7 +256,7 @@
The second parameter determines whether URLs and e-mails are converted or
just one or the other. Default behavior is both if the parameter is not
- specified. E-mail links are encoded as :func:`safe_mailto()` as shown
+ specified. E-mail links are encoded as :php:func:`safe_mailto()` as shown
above.
Converts only URLs::
@@ -273,7 +273,7 @@
$string = auto_link($string, 'both', TRUE);
-.. function:: url_title($str, $separator = '-', $lowercase = FALSE)
+.. php:function:: url_title($str, $separator = '-', $lowercase = FALSE)
:param string $str: Input string
:param string $separator: Word separator
@@ -311,7 +311,7 @@
// Produces: whats_wrong_with_css
-.. function:: prep_url($str = '')
+.. php:function:: prep_url($str = '')
:param string $str: URL string
:returns: Protocol-prefixed URL string
@@ -325,7 +325,7 @@
$url = prep_url('example.com');
-.. function:: redirect($uri = '', $method = 'auto', $code = NULL)
+.. php:function:: redirect($uri = '', $method = 'auto', $code = NULL)
:param string $uri: URI string
:param string $method: Redirect method ('auto', 'location' or 'refresh')
diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst
index a40ea9a..903e925 100644
--- a/user_guide_src/source/helpers/xml_helper.rst
+++ b/user_guide_src/source/helpers/xml_helper.rst
@@ -26,7 +26,7 @@
The following functions are available:
-.. function:: xml_convert($str[, $protect_all = FALSE])
+.. php:function:: xml_convert($str[, $protect_all = FALSE])
:param string $str: the text string to convert
:param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo;
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 78333c9..8983f3d 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -297,7 +297,7 @@
- input->server()
- input->input_stream()
- - :doc:`Cookie Helper <../helpers/cookie_helper>` :func:`get_cookie()`
+ - :doc:`Cookie Helper <../helpers/cookie_helper>` :php:func:`get_cookie()`
.. important:: Another related change is that the ``$_GET``, ``$_POST``,
``$_COOKIE`` and ``$_SERVER`` superglobals are no longer
@@ -527,7 +527,7 @@
String helper repeater()
========================
-:doc:`String Helper <../helpers/string_helper>` function :func:`repeater()` is now just an alias for
+:doc:`String Helper <../helpers/string_helper>` function :php:func:`repeater()` is now just an alias for
PHP's native ``str_repeat()`` function. It is deprecated and scheduled for removal in CodeIgniter 3.1+.
.. note:: This function is still available, but you're strongly encouraged to remove its usage sooner
@@ -536,7 +536,7 @@
String helper trim_slashes()
============================
-:doc:`String Helper <../helpers/string_helper>` function :func:`trim_slashes()` is now just an alias
+:doc:`String Helper <../helpers/string_helper>` function :php:func:`trim_slashes()` is now just an alias
for PHP's native ``trim()`` function (with a slash passed as its second argument). It is deprecated and
scheduled for removal in CodeIgniter 3.1+.
@@ -546,11 +546,11 @@
Form helper form_prep()
=======================
-:doc:`Form Helper <../helpers/form_helper>` function :func:`form_prep()`
+:doc:`Form Helper <../helpers/form_helper>` function :php:func:`form_prep()`
is now just an alias for :doc:`common function </general/common_functions>`
:func:`html_escape()`. It is deprecated and will be removed in the future.
-Please use :func:`html_escape()` instead.
+Please use :php:func:`html_escape()` instead.
.. note:: This function is still available, but you're strongly encouraged
to remove its usage sooner rather than later.
@@ -560,8 +560,8 @@
:doc:`Email Helper <../helpers/email_helper>` only has two functions
- - :func:`valid_email()`
- - :func:`send_email()`
+ - :php:func:`valid_email()`
+ - :php:func:`send_email()`
Both of them are now aliases for PHP's native ``filter_var()`` and ``mail()`` functions, respectively.
Therefore the :doc:`Email Helper <../helpers/email_helper>` altogether is being deprecated and
@@ -623,7 +623,7 @@
String helper random_string() types 'unique' and 'encrypt'
==========================================================
-When using the :doc:`String Helper <../helpers/string_helper>` function :func:`random_string()`,
+When using the :doc:`String Helper <../helpers/string_helper>` function :php:func:`random_string()`,
you should no longer pass the **unique** and **encrypt** randomization types. They are only
aliases for **md5** and **sha1** respectively and are now deprecated and scheduled for removal
in CodeIgniter 3.1+.
@@ -634,7 +634,7 @@
URL helper url_title() separators 'dash' and 'underscore'
=========================================================
-When using the :doc:`URL Helper <../helpers/url_helper>` function :func:`url_title()`, you
+When using the :doc:`URL Helper <../helpers/url_helper>` function :php:func:`url_title()`, you
should no longer pass **dash** or **underscore** as the word separator. This function will
now accept any character and you should just pass the chosen character directly, so you
should write '-' instead of 'dash' and '_' instead of 'underscore'.
@@ -714,7 +714,7 @@
Calls to the ``CI_Input::is_cli_request()`` method are necessary at many places
in the CodeIgniter internals and this is often before the :doc:`Input Library
<../libraries/input>` is loaded. Because of that, it is being replaced by a common
-function named :func:`is_cli()` and this method is now just an alias.
+function named :php:func:`is_cli()` and this method is now just an alias.
The new function is both available at all times for you to use and shorter to type.
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