Auto-loading Resources

CodeIgniter comes with an "Auto-load" feature that permits libraries, helpers, and plugins to be initialized +

CodeIgniter comes with an "Auto-load" feature that permits libraries, helpers, and models to be initialized automatically every time the system runs. If you need certain resources globally throughout your application you should consider auto-loading them for convenience.

Core classes found in the "libraries" folder

Helper files found in the "helpers" folder

Plugins found in the "plugins" folder

Custom config files found in the "config" folder

Language files found in the "system/language" folder

Models found in the "models" folder

diff --git a/user_guide/general/helpers.html b/user_guide/general/helpers.html index f1aa56e7b..ef24e8c92 100644 --- a/user_guide/general/helpers.html +++ b/user_guide/general/helpers.html @@ -176,7 +176,7 @@ Previous Topic: Models · Top of Page · User Guide Home · -Next Topic: Plugins +Next Topic: Using Libraries

diff --git a/user_guide/general/libraries.html b/user_guide/general/libraries.html index 71189dfbf..2634b18a9 100644 --- a/user_guide/general/libraries.html +++ b/user_guide/general/libraries.html @@ -81,7 +81,7 @@ In most cases, to use one of these classes involves initializing it within a

-Previous Topic: Plugins +Previous Topic: Helpers · Top of Page · User Guide Home · diff --git a/user_guide/general/plugins.html b/user_guide/general/plugins.html deleted file mode 100644 index b378ea953..000000000 --- a/user_guide/general/plugins.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - - -Plugins : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - -

- - - - - - - - - - -

- - -
- - - -

- - -

Plugins

- -

Plugins work almost identically to Helpers. The main difference is that a plugin usually -provides a single function, whereas a Helper is usually a collection of functions. Helpers are also considered a part of -the core system; plugins are intended to be created and shared by our community.

- -

Plugins should be saved to your system/plugins directory or you can create a folder called plugins inside -your application folder and store them there. CodeIgniter will look first in your system/application/plugins -directory. If the directory does not exist or the specified plugin is not located there CI will instead look in your global -system/plugins folder.

- - -

Loading a Plugin

- -

Loading a plugin file is quite simple using the following function:

- -$this->load->plugin('name'); - -

Where name is the file name of the plugin, without the .php file extension or the "plugin" part.

- -

For example, to load the Captcha plugin, which is named captcha_pi.php, you will do this:

- -$this->load->plugin('captcha'); - - - -

A plugin can be loaded anywhere within your controller functions (or even within your View files, although that's not a good practice), -as long as you load it before you use it. You can load your plugins in your controller constructor so that they become available -automatically in any function, or you can load a plugin in a specific function that needs it.

- -

Note: The Plugin loading function above does not return a value, so don't try to assign it to a variable. Just use it as shown.

- - -

Loading Multiple Plugins

- -

If you need to load more than one plugin you can specify them in an array, like this:

- -$this->load->plugin( array('plugin1', 'plugin2', 'plugin3') ); - -

Auto-loading Plugins

- -

If you find that you need a particular plugin 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 plugin to the autoload array.

- - -

Using a Plugin

- -

Once you've loaded the Plugin, you'll call it the way you would a standard PHP function.

- - - - -

- - - - - - - \ No newline at end of file diff --git a/user_guide/general/reserved_names.html b/user_guide/general/reserved_names.html index c9946e7d1..8abfbe6ce 100644 --- a/user_guide/general/reserved_names.html +++ b/user_guide/general/reserved_names.html @@ -71,7 +71,7 @@ is a list of reserved names. Do not name your controller functions any of these

Default (PHP 5)

index

If you are running PHP 4 there are some additional reserved names. These ONLY apply if you are running PHP 4.

CI_Loader

@@ -85,8 +85,6 @@ is a list of reserved names. Do not name your controller functions any of these

language

library

model

plugin

plugins

scaffolding

script

view

-- cgit v1.2.3-24-g4f1b

Auto-loading Resources

CodeIgniter User Guide Version 2.0.0

Plugins

Loading a Plugin

Loading Multiple Plugins

Auto-loading Plugins

Using a Plugin