If it is acceptable for the user input to include relative paths, e.g. file/in/some/approved/folder.txt, you can set the second optional parameter, $relative_path to TRUE.

Cross-site request forgery (CSRF)

You can enable csrf protection by opening your application/config/config.php file and setting this:

If you use the form helper the form_open() function will automatically insert a hidden csrf field in your forms.

Date: Fri, 28 Jan 2011 14:56:26 -0500 Subject: Wrong branch, and the drivers were not alphabetical. --- user_guide/libraries/javascript.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'user_guide/libraries') diff --git a/user_guide/libraries/javascript.html b/user_guide/libraries/javascript.html index b5041e5b8..864efc82d 100644 --- a/user_guide/libraries/javascript.html +++ b/user_guide/libraries/javascript.html @@ -2,7 +2,7 @@ -CodeIgniter User Guide : Input Class +CodeIgniter User Guide : JavaScript Class @@ -55,6 +55,7 @@ Input Class

Note: This driver is experimental. Its feature set and implementation may change in future releases.

Javascript Class

Rewrite this paragraph: jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add Ajax interactions to your web pages. CodeIgniter provides a library to help you with certain common functions that you may want to use within jQuery. Please note that CodeIgniter does not require the jQuery library to run, and that any scripting library will work equally well. The jQuery library is simply presented as a convenience if you choose to use it.

-- cgit v1.2.3-24-g4f1b From 9d3ad267e8e8f2972ceea05c4281b0234ed3efb4 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Fri, 28 Jan 2011 14:06:58 -0600 Subject: some cleanup for the javascript class docs --- user_guide/libraries/javascript.html | 153 ++++++++++++++++++++++- user_guide/libraries/jquery.html | 236 ----------------------------------- 2 files changed, 147 insertions(+), 242 deletions(-) delete mode 100644 user_guide/libraries/jquery.html (limited to 'user_guide/libraries') diff --git a/user_guide/libraries/javascript.html b/user_guide/libraries/javascript.html index 864efc82d..55ad18907 100644 --- a/user_guide/libraries/javascript.html +++ b/user_guide/libraries/javascript.html @@ -58,9 +58,9 @@ Input Class

Note: This driver is experimental. Its feature set and implementation may change in future releases.

Javascript Class

CodeIgniter provides a library to help you with certain common functions that you may want to use with Javascript. Please note that CodeIgniter does not require the jQuery library to run, and that any scripting library will work equally well. The jQuery library is simply presented as a convenience if you choose to use it.

Initializing the Class

To initialize the jQuery class manually in your controller constructor, use the $this->load->library function. Currently, the only available library is jQuery, which will automatically be loaded like this:

To initialize the Javascript class manually in your controller constructor, use the $this->load->library function. Currently, the only available library is jQuery, which will automatically be loaded like this:

$this->load->library('javascript'); @@ -73,20 +73,161 @@ Input Class

Once loaded, the jQuery library object will be available using: $this->javascript

Setup and Configuration

Set these variables in your view

As a javascript library, your files must be available to your application. For your convenience, the needed files to run this library are available for download from our site.

As javascript is a client side language, the library must be able to write content into your final output. This generally means a view. You'll need to include the following variables in the <head> sections of your output.

As a Javascript library, your files must be available to your application.

As Javascript is a client side language, the library must be able to write content into your final output. This generally means a view. You'll need to include the following variables in the <head> sections of your output.

<?php echo $library_src;?> <?php echo $script_head;?>

$library_src, is where the actual library file will be loaded, as well as any subsequent plugin script calls; $script_head is where specific events, functions and other commands will be rendered.

Set the path to the librarys with config items

There are some configuration items in javascript library. These can either be set in application/config.php, within its own confg/javascript.php file, or within any controller usings the set_item() function.

There are some configuration items in Javascript library. These can either be set in application/config.php, within its own config/javascript.php file, or within any controller usings the set_item() function.

An image to be used as an "ajax loader", or progress indicator. Without one, the simple text message of "loading" will appear when Ajax calls need to be made.

$config['javascript_location'] = 'http://localhost/codeigniter/themes/js/jquery/'); $config['javascript_ajax_img'] = 'images/ajax-loader.gif';

If you keep your files in the same directories they were downloaded from, then you need not set this configuration items.

For information on outputting events, effects, etc., refer to the jQuery Class documentation.

The jQuery Class

+ +

To initialize the jQuery class manually in your controller constructor, use the $this->load->library function:

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

You may send an optional parameter to determine whether or not a script tag for the main jQuery file will be automatically included when loading the library. It will be created by default. To prevent this, load the library as follows:

+ +$this->load->library('jquery', FALSE); + +

Once loaded, the jQuery library object will be available using: $this->jquery

+ +

jQuery Events

+ +

Events are set using the following syntax.

+ +

$this->jquery->event('element_path', code_to_run());

+ +

In the above example:

+ +

"event" is any of blur, change, click, dblclick, error, focus, hover, keydown, keyup, load, mousedown, mouseup, mouseover, mouseup, resize, scroll, or unload.
"element_path" is any valid jQuery selector. Due to jQuery's unique selector syntax, this is usually an element id, or CSS selector. For example "#notice_area" would effect <div id="notice_area">, and "#content a.notice" would effect all anchors with a class of "notice" in the div with id "content".
"code_to_run()" is script your write yourself, or an action such as an effect from the jQuery library below.

+ +

Effects

+ +

The query library supports a powerful Effects repertoire. Before an effect can be used, it must be loaded:

+ +

$this->jquery->effect([optional path] plugin name); +// for example +$this->jquery->effect('bounce'); +

+ +

hide() / show()

+ +

Each of this functions will affect the visibility of an item on your page. hide() will set an item invisible, show() will reveal it.

$this->jquery->hide(target, optional speed, optional extra information); + $this->jquery->show(target, optional speed, optional extra information);

+ +

"target" will be any valid jQuery selector or selectors.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

+ +

toggle()

+ +

toggle() will change the visibility of an item to the opposite of its current state, hiding visible elements, and revealing hidden ones.

$this->jquery->toggle(target);

"target" will be any valid jQuery selector or selectors.

+ +

animate()

+ +

$this->jquery->animate(target, parameters, optional speed, optional extra information);

"target" will be any valid jQuery selector or selectors.
"paramters" in jQuery would generally include a series of CSS properties that you wish to change.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

For a full summary, see http://docs.jquery.com/Effects/animate

Here is an example of an animate() called on a div with an id of "note", and triggered by a click using the jQuery library's click() event.

$params = array( + 'height' => 80, + 'width' => '50%', + 'marginLeft' => 125 +); +$this->jquery->click('#trigger', $this->jquery->animate('#note', $params, normal));

+ +

fadeIn() / fadeOut()

+ +

$this->jquery->fadeIn(target, optional speed, optional extra information); + $this->jquery->fadeOut(target, optional speed, optional extra information);

"target" will be any valid jQuery selector or selectors.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

+ +

toggleClass()

+ +

This function will add or remove a CSS class to its target.

$this->jquery->toggleClass(target, class)

"target" will be any valid jQuery selector or selectors.
"class" is any CSS classname. Note that this class must be defined and available in a CSS that is already loaded.

+ +

fadeIn() / fadeOut()

+ +

These effects cause an element(s) to disappear or reappear over time.

$this->jquery->fadeIn(target, optional speed, optional extra information); + $this->jquery->fadeOut(target, optional speed, optional extra information);

"target" will be any valid jQuery selector or selectors.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

+ +

slideUp() / slideDown() / slideToggle()

+ +

These effects cause an element(s) to slide.

$this->jquery->slideUp(target, optional speed, optional extra information); + $this->jquery->slideDown(target, optional speed, optional extra information); +$this->jquery->slideToggle(target, optional speed, optional extra information);

"target" will be any valid jQuery selector or selectors.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

+ +

Plugins

+ +

Some select jQuery plugins are made available using this library.

+ +

corner()

Used to add distinct corners to page elements. For full details see http://www.malsup.com/jquery/corner/

$this->jquery->corner(target, corner_style);

"target" will be any valid jQuery selector or selectors.
"corner_style" is optional, and can be set to any valid style such as round, sharp, bevel, bite, dog, etc. Individual corners can be set by following the style with a space and using "tl" (top left), "tr" (top right), "bl" (bottom left), or "br" (bottom right).

$this->jquery->corner("#note", "cool tl br");

+ +

tablesorter()

+ +

description to come

+ +

modal()

+ +

description to come

+ +

calendar()

+ +

description to come

diff --git a/user_guide/libraries/jquery.html b/user_guide/libraries/jquery.html deleted file mode 100644 index 732999c57..000000000 --- a/user_guide/libraries/jquery.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - -CodeIgniter User Guide : Input Class - - - - - - - - - - - - - - - - - - - - -

- - - - - - - - - - -

- - -
- - - -

- - -

jQuery Class

- -

jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add Ajax interactions to your web pages. CodeIgniter provides a library to help you with certain common functions that you may want to use within jQuery. Please note that CodeIgniter does not require the jQuery library to run, and that any scripting library will work equally well. The jQuery library is simply presented as a convenience if you choose to use it.

- -

Initializing the Class

- -

To initialize the jQuery class manually in your controller constructor, use the $this->load->library function:

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

- -$this->load->library('jquery', FALSE); - -

Once loaded, the jQuery library object will be available using: $this->jquery

- -

Setup and Configuration

- -

As a javascript library, jquery.js must be available to your application. For your convenience, the needed files to run this library are available for download from our site.

- -

<?php echo $jquery_script;?> -<?php echo $script_head;?>

- -

There are 2 configuration items in jQuery library. These can either be set in application/config.php, or within any controller. The first is the path from the root of your site to the jquery library ('js' is the default) and the second is an image to be used as an "ajax loader", or progress indicator. Without one, the simple text message of "loading" will appear when Ajax calls need to be made.

- -

$config['javascript_folder'] = 'js'; - $config['javascript_ajax_img'] = 'images/ajax-loader.gif';

- -

If you keep your files in the same directories they were downloaded from, then you needed set this configuration items.

- -

Events

- -

Events are set using the following syntax.

- -

$this->jquery->event('element_path', code_to_run());

- -

In the above example:

- -

"event" is any of blur, change, click, dblclick, error, focus, hover, keydown, keyup, load, mousedown, mouseup, mouseover, mouseup, resize, scroll, or unload.
"element_path" is any valid jQuery selector. Due to jQuery's unique selector syntax, this is usually an element id, or CSS selector. For example "#notice_area" would effect <div id="notice_area">, and "#content a.notice" would effect all anchors with a class of "notice" in the div with id "content".
"code_to_run()" is script your write yourself, or an action such as an effect from the jQuery library below.

- -

Effects

- -

The query library supports a powerful Effects repertoire. Before an effect can be used, it must be loaded:

- -

$this->jquery->effect([optional path] plugin name); -// for example -$this->jquery->effect('bounce'); -

- -

hide() / show()

- -

Each of this functions will affect the visibility of an item on your page. hide() will set an item invisible, show() will reveal it.

$this->jquery->hide(target, optional speed, optional extra information); - $this->jquery->show(target, optional speed, optional extra information);

- -

"target" will be any valid jQuery selector or selectors.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

- -

toggle()

- -

toggle() will change the visibility of an item to the opposite of its current state, hiding visible elements, and revealing hidden ones.

$this->jquery->toggle(target);

"target" will be any valid jQuery selector or selectors.

- -

animate()

- -

$this->jquery->animate(target, parameters, optional speed, optional extra information);

"target" will be any valid jQuery selector or selectors.
"paramters" in jQuery would generally include a series of CSS properties that you wish to change.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

For a full summary, see http://docs.jquery.com/Effects/animate

Here is an example of an animate() called on a div with an id of "note", and triggered by a click using the jQuery library's click() event.

$params = array( - 'height' => 80, - 'width' => '50%', - 'marginLeft' => 125 -); -$this->jquery->click('#trigger', $this->jquery->animate('#note', $params, normal));

- -

fadeIn() / fadeOut()

- -

$this->jquery->fadeIn(target, optional speed, optional extra information); - $this->jquery->fadeOut(target, optional speed, optional extra information);

"target" will be any valid jQuery selector or selectors.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

- -

toggleClass()

- -

This function will add or remove a CSS class to its target.

$this->jquery->toggleClass(target, class)

"target" will be any valid jQuery selector or selectors.
"class" is any CSS classname. Note that this class must be defined and available in a CSS that is already loaded.

- -

fadeIn() / fadeOut()

- -

These effects cause an element(s) to disappear or reappear over time.

$this->jquery->fadeIn(target, optional speed, optional extra information); - $this->jquery->fadeOut(target, optional speed, optional extra information);

"target" will be any valid jQuery selector or selectors.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

- -

slideUp() / slideDown() / slideToggle()

- -

These effects cause an element(s) to slide.

$this->jquery->slideUp(target, optional speed, optional extra information); - $this->jquery->slideDown(target, optional speed, optional extra information); -$this->jquery->slideToggle(target, optional speed, optional extra information);

"target" will be any valid jQuery selector or selectors.
"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.
"extra information" is optional, and could include a callback, or other additional information.

- -

Plugins

- -

Some select jQuery plugins are made available using this library.

- -

corner()

Used to add distinct corners to page elements. For full details see http://www.malsup.com/jquery/corner/

$this->jquery->corner(target, corner_style);

"target" will be any valid jQuery selector or selectors.
"corner_style" is optional, and can be set to any valid style such as round, sharp, bevel, bite, dog, etc. Individual corners can be set by following the style with a space and using "tl" (top left), "tr" (top right), "bl" (bottom left), or "br" (bottom right).

$this->jquery->corner("#note", "cool tl br");

- -

tablesorter()

- -

description to come

- -

modal()

- -

description to come

- -

calendar()

- -

description to come

- -

- - - - - - - \ No newline at end of file -- cgit v1.2.3-24-g4f1b From d91d0f7544967869248743c7ca663159d93628f5 Mon Sep 17 00:00:00 2001 From: Eric Barnes Date: Sun, 30 Jan 2011 20:47:42 -0500 Subject: Fixed breadcrumb and removed errand parentheses. --- user_guide/libraries/javascript.html | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'user_guide/libraries') diff --git a/user_guide/libraries/javascript.html b/user_guide/libraries/javascript.html index 55ad18907..18b7181b0 100644 --- a/user_guide/libraries/javascript.html +++ b/user_guide/libraries/javascript.html @@ -2,7 +2,7 @@ -CodeIgniter User Guide : JavaScript Class +JavaScript Driver : CodeIgniter User Guide @@ -42,7 +42,8 @@ CodeIgniter Home › User Guide Home › -Input Class +Drivers › +JavaScript Driver @@ -57,7 +58,7 @@ Input Class

Note: This driver is experimental. Its feature set and implementation may change in future releases.

Javascript Class

Javascript Driver

Initializing the Class

@@ -82,7 +83,7 @@ Input Class

Set the path to the librarys with config items

An image to be used as an "ajax loader", or progress indicator. Without one, the simple text message of "loading" will appear when Ajax calls need to be made.

$config['javascript_location'] = 'http://localhost/codeigniter/themes/js/jquery/'); +

$config['javascript_location'] = 'http://localhost/codeigniter/themes/js/jquery/'; $config['javascript_ajax_img'] = 'images/ajax-loader.gif';


 If you keep your files in the same directories they were downloaded from, then you need not set this configuration items.
 
-- 
cgit v1.2.3-24-g4f1b

Cross-site request forgery (CSRF)

Javascript Class

Javascript Class

Initializing the Class

Setup and Configuration

Set these variables in your view

Set the path to the librarys with config items

The jQuery Class

jQuery Events

Effects

hide() / show()

toggle()

animate()

fadeIn() / fadeOut()

toggleClass()

fadeIn() / fadeOut()

slideUp() / slideDown() / slideToggle()

Plugins

corner()

tablesorter()

modal()

calendar()

CodeIgniter User Guide Version 2.0.0

jQuery Class

Initializing the Class

Setup and Configuration

Events

Effects

hide() / show()

toggle()

animate()

fadeIn() / fadeOut()

toggleClass()

fadeIn() / fadeOut()

slideUp() / slideDown() / slideToggle()

Plugins

corner()

tablesorter()

modal()

calendar()

Javascript Class

Javascript Driver

Initializing the Class

Set the path to the librarys with config items