Date: Thu, 13 Nov 2008 22:59:24 +0000 Subject: Changing EOL style to LF --- user_guide/libraries/loader.html | 426 +++++++++++++++++++-------------------- 1 file changed, 213 insertions(+), 213 deletions(-) (limited to 'user_guide/libraries/loader.html') diff --git a/user_guide/libraries/loader.html b/user_guide/libraries/loader.html index 0e13d86bb..2680dfab4 100644 --- a/user_guide/libraries/loader.html +++ b/user_guide/libraries/loader.html @@ -1,214 +1,214 @@ - - - - - -Loader Class : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - -

- - - - - - - - - - -

- - -
- - - -

- - -

Loader Class

- -

Loader, as the name suggests, is used to load elements. These elements can be libraries (classes) View files, -Helpers, Plugins, or your own files.

- -

Note: This class is initialized automatically by the system so there is no need to do it manually.

- -

The following functions are available in this class:

- - -

$this->load->library('`class_name`', `$config`, `'object name'`)

- - -

This function is used to load core classes. Where class_name is the name of the class you want to load. -Note: We use the terms "class" and "library" interchangeably.

- -

For example, if you would like to send email with CodeIgniter, the first step is to load the email class within your controller:

- -$this->load->library('email'); - -

Once loaded, the library will be ready for use, using $this->email->some_function(). - -

Library files can be stored in subdirectories within the main "libraries" folder, or within your personal application/libraries folder. -To load a file located in a subdirectory, simply include the path, relative to the "libraries" folder. -For example, if you have file located at:

- -libraries/flavors/chocolate.php - -

You will load it using:

- -$this->load->library('flavors/chocolate'); - -

You may nest the file in as many subdirectories as you want.

- -

Setting options

- -

The second (optional) parameter allows you to optionally pass configuration setting. You will typically pass these as an array:

- -


-$config = array (

-                  'mailtype' => 'html',

-                  'charset'  => 'utf-8,

-                  'priority' => '1'

-               );

-

-$this->load->library('email', $config);

- -

Config options can usually also be set via a config file. Each library is explained in detail in its own page, so please read the information regarding each one you would like to use.

- -

Assigning a Library to a different object name

- -

If the third (optional) parameter is blank, the library will usually be assigned to an object with the same name as the library. For example, if the library is named Session, it -will be assigned to a variable named $this->session.

- -

If you prefer to set your own class names you can pass its value to the third parameter:

- -

$this->load->library('session', '', 'my_session');


-
-// Session class is now accessed using:


-
-$this->my_session
-
-

- - - -

$this->load->view('`file_name`', `$data`, `true/false`)

- -

This function is used to load your View files. If you haven't read the Views section of the -user guide it is recommended that you do since it shows you how this function is typically used.

- -

The first parameter is required. It is the name of the view file you would like to load. Note: The .php file extension does not need to be specified unless you use something other than .php.

- -

The second optional parameter can take -an associative array or an object as input, which it runs through the PHP extract function to -convert to variables that can be used in your view files. Again, read the Views page to learn -how this might be useful.

- -

The third optional parameter lets you change the behavior of the function so that it returns data as a string -rather than sending it to your browser. This can be useful if you want to process the data in some way. If you -set the parameter to true (boolean) it will return data. The default behavior is false, which sends it -to your browser. Remember to assign it to a variable if you want the data returned:

- -$string = $this->load->view('myfile', '', true); - - -

$this->load->model('`Model_name`');

$this->load->model('Model_name');

If your model is located in a sub-folder, include the relative path from your models folder. For example, if you have a model located at application/models/blog/queries.php you'll load it using:

$this->load->model('blog/queries');

If you would like your model assigned to a different object name you can specify it via the second parameter of the loading - function:

 $this->load->model('Model_name', 'fubar');

-

-$this->fubar->function();

$this->load->database('`options`', `true/false`)

This function lets you load the database class. The two parameters are optional. Please see the -database section for more info.

- - -

$this->load->scaffolding('`table_name`')

- -

This function lets you enable scaffolding. Please see the -scaffolding section for more info.

- - - -

$this->load->vars(`$array`)

- -

This function takes an associative array as input and generates variables using the PHP extract function. -This function produces the same result as using the second parameter of the $this->load->view() function above. The reason you might -want to use this function independently is if you would like to set some global variables in the constructor of your controller -and have them become available in any view file loaded from any function. You can have multiple calls to this function. The data get cached -and merged into one array for conversion to variables. -

- - -

$this->load->helper('`file_name`')

This function loads helper files, where file_name is the name of the file, without the _helper.php extension.

- - -

$this->load->plugin('`file_name`')

This function loads plugins files, where file_name is the name of the file, without the _plugin.php extension.

- -

$this->load->file('`filepath/filename`', `true/false`)

This is a generic file loading function. Supply the filepath and name in the first parameter and it will open and read the file. -By default the data is sent to your browser, just like a View file, but if you set the second parameter to true (boolean) -it will instead return the data as a string.

- - -

$this->load->lang('`file_name`')

This function is an alias of the language loading function: $this->lang->load()

- -

$this->load->config('`file_name`')

This function is an alias of the config file loading function: $this->config->load()

- - - - -

- - - - - - + + + + + +Loader Class : CodeIgniter User Guide + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + +

+ + +
+ + + +

+ + +

Loader Class

+ +

Loader, as the name suggests, is used to load elements. These elements can be libraries (classes) View files, +Helpers, Plugins, or your own files.

+ +

Note: This class is initialized automatically by the system so there is no need to do it manually.

+ +

The following functions are available in this class:

+ + +

$this->load->library('`class_name`', `$config`, `'object name'`)

+ + +

This function is used to load core classes. Where class_name is the name of the class you want to load. +Note: We use the terms "class" and "library" interchangeably.

+ +

For example, if you would like to send email with CodeIgniter, the first step is to load the email class within your controller:

+ +$this->load->library('email'); + +

Once loaded, the library will be ready for use, using $this->email->some_function(). + +

Library files can be stored in subdirectories within the main "libraries" folder, or within your personal application/libraries folder. +To load a file located in a subdirectory, simply include the path, relative to the "libraries" folder. +For example, if you have file located at:

+ +libraries/flavors/chocolate.php + +

You will load it using:

+ +$this->load->library('flavors/chocolate'); + +

You may nest the file in as many subdirectories as you want.

+ +

Setting options

+ +

The second (optional) parameter allows you to optionally pass configuration setting. You will typically pass these as an array:

+ +


+$config = array (

+                  'mailtype' => 'html',

+                  'charset'  => 'utf-8,

+                  'priority' => '1'

+               );

+

+$this->load->library('email', $config);

+ +

Config options can usually also be set via a config file. Each library is explained in detail in its own page, so please read the information regarding each one you would like to use.

+ +

Assigning a Library to a different object name

+ +

If the third (optional) parameter is blank, the library will usually be assigned to an object with the same name as the library. For example, if the library is named Session, it +will be assigned to a variable named $this->session.

+ +

If you prefer to set your own class names you can pass its value to the third parameter:

+ +

$this->load->library('session', '', 'my_session');


+
+// Session class is now accessed using:


+
+$this->my_session
+
+

+ + + +

$this->load->view('`file_name`', `$data`, `true/false`)

+ +

This function is used to load your View files. If you haven't read the Views section of the +user guide it is recommended that you do since it shows you how this function is typically used.

+ +

The first parameter is required. It is the name of the view file you would like to load. Note: The .php file extension does not need to be specified unless you use something other than .php.

+ +

The second optional parameter can take +an associative array or an object as input, which it runs through the PHP extract function to +convert to variables that can be used in your view files. Again, read the Views page to learn +how this might be useful.

+ +

The third optional parameter lets you change the behavior of the function so that it returns data as a string +rather than sending it to your browser. This can be useful if you want to process the data in some way. If you +set the parameter to true (boolean) it will return data. The default behavior is false, which sends it +to your browser. Remember to assign it to a variable if you want the data returned:

+ +$string = $this->load->view('myfile', '', true); + + +

$this->load->model('`Model_name`');

$this->load->model('Model_name');

If your model is located in a sub-folder, include the relative path from your models folder. For example, if you have a model located at application/models/blog/queries.php you'll load it using:

$this->load->model('blog/queries');

If you would like your model assigned to a different object name you can specify it via the second parameter of the loading + function:

 $this->load->model('Model_name', 'fubar');

+

+$this->fubar->function();

$this->load->database('`options`', `true/false`)

This function lets you load the database class. The two parameters are optional. Please see the +database section for more info.

+ + +

$this->load->scaffolding('`table_name`')

+ +

This function lets you enable scaffolding. Please see the +scaffolding section for more info.

+ + + +

$this->load->vars(`$array`)

+ +

This function takes an associative array as input and generates variables using the PHP extract function. +This function produces the same result as using the second parameter of the $this->load->view() function above. The reason you might +want to use this function independently is if you would like to set some global variables in the constructor of your controller +and have them become available in any view file loaded from any function. You can have multiple calls to this function. The data get cached +and merged into one array for conversion to variables. +

+ + +

$this->load->helper('`file_name`')

This function loads helper files, where file_name is the name of the file, without the _helper.php extension.

+ + +

$this->load->plugin('`file_name`')

This function loads plugins files, where file_name is the name of the file, without the _plugin.php extension.

+ +

$this->load->file('`filepath/filename`', `true/false`)

This is a generic file loading function. Supply the filepath and name in the first parameter and it will open and read the file. +By default the data is sent to your browser, just like a View file, but if you set the second parameter to true (boolean) +it will instead return the data as a string.

+ + +

$this->load->lang('`file_name`')

This function is an alias of the language loading function: $this->lang->load()

+ +

$this->load->config('`file_name`')

This function is an alias of the config file loading function: $this->config->load()

+ + + + +

+ + + + + + \ No newline at end of file -- cgit v1.2.3-24-g4f1b

CodeIgniter User Guide Version 1.7

Loader Class

$this->load->library('`class_name`', `$config`, `'object name'`)

Setting options

Assigning a Library to a different object name

$this->load->view('`file_name`', `$data`, `true/false`)

$this->load->model('`Model_name`');

$this->load->database('`options`', `true/false`)

$this->load->scaffolding('`table_name`')

$this->load->vars(`$array`)

$this->load->helper('`file_name`')

$this->load->plugin('`file_name`')

$this->load->file('`filepath/filename`', `true/false`)

$this->load->lang('`file_name`')

$this->load->config('`file_name`')

CodeIgniter User Guide Version 1.7

Loader Class

$this->load->library('`class_name`', `$config`, `'object name'`)

Setting options

Assigning a Library to a different object name

$this->load->view('`file_name`', `$data`, `true/false`)

$this->load->model('`Model_name`');

$this->load->database('`options`', `true/false`)

$this->load->scaffolding('`table_name`')

$this->load->vars(`$array`)

$this->load->helper('`file_name`')

$this->load->plugin('`file_name`')

$this->load->file('`filepath/filename`', `true/false`)

$this->load->lang('`file_name`')

$this->load->config('`file_name`')

CodeIgniter User Guide Version 1.7

Loader Class

$this->load->library('class_name', $config, 'object name')

Setting options

Assigning a Library to a different object name

$this->load->view('file_name', $data, true/false)

$this->load->model('Model_name');

$this->load->database('options', true/false)

$this->load->scaffolding('table_name')

$this->load->vars($array)

$this->load->helper('file_name')

$this->load->plugin('file_name')

$this->load->file('filepath/filename', true/false)

$this->load->lang('file_name')

$this->load->config('file_name')

CodeIgniter User Guide Version 1.7

Loader Class

$this->load->library('class_name', $config, 'object name')

Setting options

Assigning a Library to a different object name

$this->load->view('file_name', $data, true/false)

$this->load->model('Model_name');

$this->load->database('options', true/false)

$this->load->scaffolding('table_name')

$this->load->vars($array)

$this->load->helper('file_name')

$this->load->plugin('file_name')

$this->load->file('filepath/filename', true/false)

$this->load->lang('file_name')

$this->load->config('file_name')

$this->load->library('`class_name`', `$config`, `'object name'`)

$this->load->view('`file_name`', `$data`, `true/false`)

$this->load->model('`Model_name`');

$this->load->database('`options`', `true/false`)

$this->load->scaffolding('`table_name`')

$this->load->vars(`$array`)

$this->load->helper('`file_name`')

$this->load->plugin('`file_name`')

$this->load->file('`filepath/filename`', `true/false`)

$this->load->lang('`file_name`')

$this->load->config('`file_name`')

$this->load->library('`class_name`', `$config`, `'object name'`)

$this->load->view('`file_name`', `$data`, `true/false`)

$this->load->model('`Model_name`');

$this->load->database('`options`', `true/false`)

$this->load->scaffolding('`table_name`')

$this->load->vars(`$array`)

$this->load->helper('`file_name`')

$this->load->plugin('`file_name`')

$this->load->file('`filepath/filename`', `true/false`)

$this->load->lang('`file_name`')

$this->load->config('`file_name`')