summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/general/helpers.rst
diff options
context:
space:
mode:
authorDerek Jones <derek.jones@ellislab.com>2011-10-07 15:59:45 +0200
committerDerek Jones <derek.jones@ellislab.com>2011-10-07 15:59:45 +0200
commitaed7e48184a1e14d9551a5d65d1e73afcda016be (patch)
tree8ea97139226a497106297b3e88c502b1b611948c /user_guide_src/source/general/helpers.rst
parenta8b5a9f81d649aa1f583b818905f333d478eba9c (diff)
parent526433e86e0c3d838452d61e0d1a97b6b5a3c323 (diff)
Merge pull request #547 from purwandi/develop
Fix some user guide style
Diffstat (limited to 'user_guide_src/source/general/helpers.rst')
-rw-r--r--user_guide_src/source/general/helpers.rst37
1 files changed, 18 insertions, 19 deletions
diff --git a/user_guide_src/source/general/helpers.rst b/user_guide_src/source/general/helpers.rst
index 71cb8b25a..3a98311a6 100644
--- a/user_guide_src/source/general/helpers.rst
+++ b/user_guide_src/source/general/helpers.rst
@@ -3,10 +3,10 @@ Helper Functions
################
Helpers, as the name suggests, help you with tasks. Each helper file is
-simply a collection of functions in a particular category. There are URL
-Helpers, that assist in creating links, there are Form Helpers that help
-you create form elements, Text Helpers perform various text formatting
-routines, Cookie Helpers set and read cookies, File Helpers help you
+simply a collection of functions in a particular category. There are **URL
+Helpers**, that assist in creating links, there are Form Helpers that help
+you create form elements, **Text Helpers** perform various text formatting
+routines, **Cookie Helpers** set and read cookies, File Helpers help you
deal with files, etc.
Unlike most other systems in CodeIgniter, Helpers are not written in an
@@ -19,9 +19,9 @@ using a Helper is to load it. Once loaded, it becomes globally available
in your :doc:`controller <../general/controllers>` and
:doc:`views <../general/views>`.
-Helpers are typically stored in your system/helpers, or
-application/helpers directory. CodeIgniter will look first in your
-application/helpers directory. If the directory does not exist or the
+Helpers are typically stored in your **system/helpers**, or
+**application/helpers directory**. CodeIgniter will look first in your
+**application/helpers directory**. If the directory does not exist or the
specified helper is not located there CI will instead look in your
global system/helpers folder.
@@ -32,11 +32,11 @@ Loading a helper file is quite simple using the following function::
$this->load->helper('name');
-Where name is the file name of the helper, without the .php file
+Where **name** is the file name of the helper, without the .php file
extension or the "helper" part.
-For example, to load the URL Helper file, which is named
-url_helper.php, you would do this::
+For example, to load the **URL Helper** file, which is named
+**url_helper.php**, you would do this::
$this->load->helper('url');
@@ -63,9 +63,8 @@ Auto-loading Helpers
If you find that you need a particular helper globally throughout your
application, you can tell CodeIgniter to auto-load it during system
-initialization. This is done by opening the
-application/config/autoload.php file and adding the helper to the
-autoload array.
+initialization. This is done by opening the **application/config/autoload.php**
+file and adding the helper to the autoload array.
Using a Helper
==============
@@ -84,8 +83,8 @@ URI to the controller/function you wish to link to.
"Extending" Helpers
===================
-To "extend" Helpers, create a file in your application/helpers/ folder
-with an identical name to the existing Helper, but prefixed with MY\_
+To "extend" Helpers, create a file in your **application/helpers/** folder
+with an identical name to the existing Helper, but prefixed with **MY\_**
(this item is configurable. See below.).
If all you need to do is add some functionality to an existing helper -
@@ -98,8 +97,8 @@ sense. Under the hood, this gives you the ability to add to the
functions a Helper provides, or to modify how the native Helper
functions operate.
-For example, to extend the native Array Helper you'll create a file
-named application/helpers/MY_array_helper.php, and add or override
+For example, to extend the native **Array Helper** you'll create a file
+named **application/helpers/MY_array_helper.php**, and add or override
functions::
// any_in_array() is not in the Array Helper, so it defines a new function
@@ -130,11 +129,11 @@ Setting Your Own Prefix
The filename prefix for "extending" Helpers is the same used to extend
libraries and Core classes. To set your own prefix, open your
-application/config/config.php file and look for this item::
+**application/config/config.php** file and look for this item::
$config['subclass_prefix'] = 'MY_';
-Please note that all native CodeIgniter libraries are prefixed with CI\_
+Please note that all native CodeIgniter libraries are prefixed with **CI\_**
so DO NOT use that as your prefix.
Now What?