From e334c472fb4be44feec3a73402fc4a2b062cbfc0 Mon Sep 17 00:00:00 2001 From: admin Date: Sat, 21 Oct 2006 19:44:22 +0000 Subject: --- user_guide/helpers/array_helper.html | 4 ++-- user_guide/helpers/cookie_helper.html | 6 +++--- user_guide/helpers/date_helper.html | 12 ++++++------ user_guide/helpers/directory_helper.html | 4 ++-- user_guide/helpers/download_helper.html | 4 ++-- user_guide/helpers/file_helper.html | 2 +- user_guide/helpers/form_helper.html | 14 +++++++------- user_guide/helpers/html_helper.html | 2 +- user_guide/helpers/index.html | 6 +++--- user_guide/helpers/inflector_helper.html | 2 +- user_guide/helpers/security_helper.html | 4 ++-- user_guide/helpers/string_helper.html | 4 ++-- user_guide/helpers/text_helper.html | 2 +- user_guide/helpers/typography_helper.html | 8 ++++---- user_guide/helpers/url_helper.html | 10 +++++----- user_guide/helpers/xml_helper.html | 2 +- 16 files changed, 43 insertions(+), 43 deletions(-) (limited to 'user_guide/helpers') diff --git a/user_guide/helpers/array_helper.html b/user_guide/helpers/array_helper.html index a6044be8f..854d0babe 100644 --- a/user_guide/helpers/array_helper.html +++ b/user_guide/helpers/array_helper.html @@ -12,7 +12,7 @@ @@ -75,7 +75,7 @@ Array Helper

element()

-

Lets you fetch an item from an array. The function tests whether the array index is set and whether it has a value. If +

Lets you fetch an item from an array. The function tests whether the array index is set and whether it has a value. If a value exists it is returned. If a value does not exist it returns FALSE, or whatever you've specified as the default value via the third parameter. Example:

diff --git a/user_guide/helpers/cookie_helper.html b/user_guide/helpers/cookie_helper.html index 1e352fc11..ec27e5485 100644 --- a/user_guide/helpers/cookie_helper.html +++ b/user_guide/helpers/cookie_helper.html @@ -12,7 +12,7 @@ @@ -99,7 +99,7 @@ set_cookie($cookie);

Only the name and value are required.

The expiration is set in seconds, which will be added to the current time. Do not include the time, but rather only the -number of seconds from now that you wish the cookie to be valid. If the expiration is set to +number of seconds from now that you wish the cookie to be valid. If the expiration is set to zero the cookie will only last as long as the browser is open.

To delete a cookie set it with the expiration blank.

For site-wide cookies regardless of how your site is requested, add your URL to the domain starting with a period, like this: .your-domain.com

@@ -132,7 +132,7 @@ zero the cookie will only last as long as the browser is open.

delete_cookie("name"); -

This function is otherwise identical to set_cookie(), except that it does not have the value and expiration parameters. You can submit an array +

This function is otherwise identical to set_cookie(), except that it does not have the value and expiration parameters. You can submit an array of values in the first parameter or you can set discreet parameters.

delete_cookie($name, $domain, $path, $prefix) diff --git a/user_guide/helpers/date_helper.html b/user_guide/helpers/date_helper.html index f787176a7..727ce5206 100644 --- a/user_guide/helpers/date_helper.html +++ b/user_guide/helpers/date_helper.html @@ -12,7 +12,7 @@ @@ -86,7 +86,7 @@ run a site that lets each user set their own timezone settings) there is no bene

mdate()

-

This function is identical to PHPs date() function, except that it lets you +

This function is identical to PHPs date() function, except that it lets you use MySQL style date codes, where each code letter is preceded with a percent sign: %Y %m %d etc.

The benefit of doing dates this way is that you don't have to worry about escaping any characters that @@ -142,7 +142,7 @@ $gmt = local_to_gmt($now);

gmt_to_local()

-

Takes a Unix timestamp (referenced to GMT) as input, and converts it to a localized timestamp based on the +

Takes a Unix timestamp (referenced to GMT) as input, and converts it to a localized timestamp based on the timezone and Daylight Saving time submitted. Example:

@@ -171,7 +171,7 @@ $unix = mysql_to_unix($mysql);

This can be useful if you need to display a date in a form field for submission.

-

The time can be formatted with or without seconds, and it can be set to European or US format. If only +

The time can be formatted with or without seconds, and it can be set to European or US format. If only the timestamp is submitted it will return the time without seconds formatted for the U.S. Examples: $now = time();
@@ -185,8 +185,8 @@ echo unix_to_human($now, TRUE, 'eu'); // Euro time with seconds

human_to_unix()

-

The opposite of the above function. Takes a "human" time as input and returns it as Unix. This function is -useful if you accept "human" formatted dates submitted via a form. Returns FALSE (boolean) if +

The opposite of the above function. Takes a "human" time as input and returns it as Unix. This function is +useful if you accept "human" formatted dates submitted via a form. Returns FALSE (boolean) if the date string passed to it is not formatted as indicated above. Example:

$now = time();
diff --git a/user_guide/helpers/directory_helper.html b/user_guide/helpers/directory_helper.html index 35b2d6db9..34450b131 100644 --- a/user_guide/helpers/directory_helper.html +++ b/user_guide/helpers/directory_helper.html @@ -12,7 +12,7 @@ @@ -90,7 +90,7 @@ only the top level directory set the second parameter to true (boolea $map = directory_map('./mydirectory/', TRUE); -

Each folder name will be an array index, while its contained files will be numerically indexed. +

Each folder name will be an array index, while its contained files will be numerically indexed. Here is an example of a typical array:

Array
diff --git a/user_guide/helpers/download_helper.html b/user_guide/helpers/download_helper.html index 5b2f1ecfe..14dba661c 100644 --- a/user_guide/helpers/download_helper.html +++ b/user_guide/helpers/download_helper.html @@ -12,7 +12,7 @@ @@ -76,7 +76,7 @@ Download Helper

force_download('filename', 'data')

-

Generates server headers which force data to be downloaded to your desktop. Useful with file downloads. +

Generates server headers which force data to be downloaded to your desktop. Useful with file downloads. The first parameter is the name you want the downloaded file to be named, the second parameter is the file data. Example:

diff --git a/user_guide/helpers/file_helper.html b/user_guide/helpers/file_helper.html index 319ebfa9b..d51906d99 100644 --- a/user_guide/helpers/file_helper.html +++ b/user_guide/helpers/file_helper.html @@ -12,7 +12,7 @@ diff --git a/user_guide/helpers/form_helper.html b/user_guide/helpers/form_helper.html index a71aa513d..68d44e662 100644 --- a/user_guide/helpers/form_helper.html +++ b/user_guide/helpers/form_helper.html @@ -12,7 +12,7 @@ @@ -175,7 +175,7 @@ echo form_input($data);
// Would produce:

<input type="text" name="username" id="username" value="johndoe" maxlength="100" size="50" style="width:50%" />
-

If you would like your form to contain some additional data, like JavaScript, you can pass it as a string in the +

If you would like your form to contain some additional data, like JavaScript, you can pass it as a string in the third parameter: $js = 'onClick="some_function()"';
@@ -184,17 +184,17 @@ echo form_input('username', 'johndoe', $js);

form_password()

-

This function is identical in all respects to the form_input() function above +

This function is identical in all respects to the form_input() function above except that is sets it as a "password" type.

form_upload()

-

This function is identical in all respects to the form_input() function above +

This function is identical in all respects to the form_input() function above except that is sets it as a "file" type, allowing it to be used to upload files.

form_textarea()

-

This function is identical in all respects to the form_input() function above +

This function is identical in all respects to the 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".

@@ -224,7 +224,7 @@ echo form_dropdown('shirts', $options, 'large');
</select>
-

If you would like the opening <select> to contain additional data, like JavaScript, you can pass it as a string in the +

If you would like the opening <select> to contain additional data, like JavaScript, you can pass it as a string in the fourth parameter: $js = 'onChange="some_function()"';
@@ -260,7 +260,7 @@ echo form_checkbox($data);
// Would produce:

<input type="checkbox" name="newsletter" id="newsletter" value="accept" checked="checked" style="margin:10px" />
-

As with other functions, if you would like the tag to contain additional data, like JavaScript, you can pass it as a string in the +

As with other functions, if you would like the tag to contain additional data, like JavaScript, you can pass it as a string in the fourth parameter: $js = 'onClick="some_function()"';
diff --git a/user_guide/helpers/html_helper.html b/user_guide/helpers/html_helper.html index 17157bbfa..e32cbc937 100644 --- a/user_guide/helpers/html_helper.html +++ b/user_guide/helpers/html_helper.html @@ -12,7 +12,7 @@ diff --git a/user_guide/helpers/index.html b/user_guide/helpers/index.html index 2a5c69367..129e424ea 100644 --- a/user_guide/helpers/index.html +++ b/user_guide/helpers/index.html @@ -12,7 +12,7 @@ @@ -71,11 +71,11 @@ that help you create form elements, Text Helpers perform various text

Unlike most other systems in Code Igniter, Helpers are not written in an Object Oriented format. They are simple, procedural functions. Each helper function performs one specific task, with no dependence on other functions.

-

Helpers are intentionally kept very simple so that they can be used within your View Files with a minimal amount of code. +

Helpers are intentionally kept very simple so that they can be used within your View Files with a minimal amount of code. This is important if you intend to have designers or non-programmer will be working with your view files, since it keeps the code to a minimum.

-

Code Igniter does not load Helper Files by default, so the first step in using +

Code Igniter does not load Helper Files by default, so the first step in using a Helper is to load it. Once loaded, it becomes globally available in your controller and views.

Loading a Helper

diff --git a/user_guide/helpers/inflector_helper.html b/user_guide/helpers/inflector_helper.html index ace1b2e07..65cc795eb 100644 --- a/user_guide/helpers/inflector_helper.html +++ b/user_guide/helpers/inflector_helper.html @@ -12,7 +12,7 @@ diff --git a/user_guide/helpers/security_helper.html b/user_guide/helpers/security_helper.html index d45d7c4e1..3953e8b2f 100644 --- a/user_guide/helpers/security_helper.html +++ b/user_guide/helpers/security_helper.html @@ -12,7 +12,7 @@ @@ -76,7 +76,7 @@ Security Helper

xss_clean()

-

Provides Cross Site Script Hack filtering. This function is an alias to the one in the +

Provides Cross Site Script Hack filtering. This function is an alias to the one in the Input class. More info can be found there.

diff --git a/user_guide/helpers/string_helper.html b/user_guide/helpers/string_helper.html index ca28dc668..f43dfc480 100644 --- a/user_guide/helpers/string_helper.html +++ b/user_guide/helpers/string_helper.html @@ -12,7 +12,7 @@ @@ -84,7 +84,7 @@ String Helper
  • alnum:  Alpha-numeric string with lower and uppercase characters.
  • numeric:  Numeric string.
  • nozero:  Numeric string with no zeros.
  • -
  • unique:  Encrypted with MD5 and uniquid(). Note: The length parameter is not available for this type. +
  • unique:  Encrypted with MD5 and uniquid(). Note: The length parameter is not available for this type. Returns a fixed length 33 character string.
  • diff --git a/user_guide/helpers/text_helper.html b/user_guide/helpers/text_helper.html index 75190da3c..1c704c409 100644 --- a/user_guide/helpers/text_helper.html +++ b/user_guide/helpers/text_helper.html @@ -12,7 +12,7 @@ diff --git a/user_guide/helpers/typography_helper.html b/user_guide/helpers/typography_helper.html index 7213b9d8a..1d1c6d69a 100644 --- a/user_guide/helpers/typography_helper.html +++ b/user_guide/helpers/typography_helper.html @@ -12,7 +12,7 @@ @@ -76,7 +76,7 @@ Typography Helper

    auto_typography()

    -

    Formats text so that it is semantically and typographically correct HTML. Takes a string as input and returns it with +

    Formats text so that it is semantically and typographically correct HTML. Takes a string as input and returns it with the following formatting: