From 1a73cb0a2847087645bc5d968743c8a2d8bd52b7 Mon Sep 17 00:00:00 2001 From: Pascal Kriete Date: Tue, 5 Apr 2011 15:17:41 -0400 Subject: Changelogging --- user_guide/changelog.html | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'user_guide') diff --git a/user_guide/changelog.html b/user_guide/changelog.html index 013c55766..ffdc27266 100644 --- a/user_guide/changelog.html +++ b/user_guide/changelog.html @@ -66,12 +66,19 @@ Hg Tag: n/a

General changes
- The Security library was moved to the core and is now loaded automatically. Please remove your loading calls.
- The CI_SHA class is now deprecated. All supported versions of PHP provide a sha1() function.
- constants.php will now be loaded from the environment folder if available.
- Added language key error logging
- Added Environment Support for Hooks.
- Added CI_ Prefix to the Cache driver.
Helpers +
- Removed the previously deprecated dohash() from the Security helper; use do_hash() instead.
+

Database

$this->db->count_all_results() will now return an integer instead of a string.

Date: Wed, 6 Apr 2011 14:48:52 -0400 Subject: Adding a note about security to the upgrade docs --- user_guide/installation/upgrade_201.html | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'user_guide') diff --git a/user_guide/installation/upgrade_201.html b/user_guide/installation/upgrade_201.html index 879067c6e..9c72cf423 100644 --- a/user_guide/installation/upgrade_201.html +++ b/user_guide/installation/upgrade_201.html @@ -66,11 +66,23 @@ Upgrading from 2.0.0 to 2.0.1

Note: If you have any custom developed files in these folders please make copies of them first.

Step 2: Replace config/mimes.php

This config file has been updated to contain more mime types, please copy it to application/config/mimes.php.

Step 3: Check for forms posting to default controller

+ +

Step 3: Remove loading calls for the Security Library

+ +

Security has been moved to the core and is now always loaded automatically. Make sure you remove any loading calls as they will result in PHP errors.

+ + +

Step 4: Move MY_Security

+ +

If you are overriding or extending the Security library, you will need to move it to application/core.

+ + +

Step 5: Check for forms posting to default controller

The default behavior for form_open() when called with no parameters used to be to post to the default controller, but it will now just leave an empty action="" meaning the form will submit to the current URL. -- cgit v1.2.3-24-g4f1b From 4dfca5e7fdb72062c73f0765efb0dd596d6081e5 Mon Sep 17 00:00:00 2001 From: Pascal Kriete Date: Wed, 6 Apr 2011 15:02:06 -0400 Subject: Hat tip to the reactor team in the credits --- user_guide/general/credits.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'user_guide') diff --git a/user_guide/general/credits.html b/user_guide/general/credits.html index 7977956a8..e64a74558 100644 --- a/user_guide/general/credits.html +++ b/user_guide/general/credits.html @@ -62,7 +62,8 @@ Credits world, with many of the class libraries, helpers, and sub-systems borrowed from the code-base of ExpressionEngine.

It is currently developed and maintained by the ExpressionEngine Development Team.

It is currently developed and maintained by the ExpressionEngine Development Team.
+Bleeding edge development is spearheaded by the handpicked contributors of the Reactor Team.

A hat tip goes to Ruby on Rails for inspiring us to create a PHP framework, and for bringing frameworks into the general consciousness of the web community.

-- cgit v1.2.3-24-g4f1b From 8d63cc67bc8671c31e530f1d795bd82c8d3e60b3 Mon Sep 17 00:00:00 2001 From: Phil Sturgeon Date: Thu, 7 Apr 2011 11:52:41 +0100 Subject: Added CLI documentation. --- user_guide/general/cli.html | 150 ++++++++++++++++++++++++++++++++++++++++++++ user_guide/nav/nav.js | 1 + user_guide/toc.html | 2 + 3 files changed, 153 insertions(+) create mode 100644 user_guide/general/cli.html (limited to 'user_guide') diff --git a/user_guide/general/cli.html b/user_guide/general/cli.html new file mode 100644 index 000000000..affafadf7 --- /dev/null +++ b/user_guide/general/cli.html @@ -0,0 +1,150 @@ + + + + + +Running via the CLI : CodeIgniter User Guide + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + +

+ + +
+ + + +

+ +

Running via the CLI

+ +

+ As well as calling an applications Controllers via the URL in a browser they can also be loaded via the command-line interface (CLI). +

+ + +

What is the CLI?
Why use this method?
How does it work?

+ + + +

What is the CLI?

+ +

The command-line interface is a text-based method of interacting with computers that looks like what most people remember as DOS.

+ + + +

Why run via the command-line?

+ +

+ There are many reasons for running CodeIgniter from the command-line, but they are not always obvious.

+ +

Run your cron-jobs without needing to use wget or curl
Make your cron-jobs inaccessible from being loaded in the URL by checking for IS_CLI
Make interactive "tasks" that can do things like set permissions, prune cache folders, run backups, etc.
Integrate with other applications in other languages. For example, a random C++ script could call one command and run code in your models!

+ + +

Let's try it: Hello World!

+ +

Let's create a simple controller so you can see it in action. Using your text editor, create a file called tools.php, and put the following code in it:

+ + + +

Then save the file to your application/controllers/ folder.

+ +

Now normally you would visit the your site using a URL similar to this:

+ +example.com/index.php/tools/message/to + +

Instead, we are going to open Terminal in Mac/Lunix or go to Run > "cmd" in Windows and navigate to our CodeIgniter project.

+ +

+ $ cd /path/to/project;
+ $ php index.php tools message +

+ +

If you did it right, you should see Hello World!.

+ +

+ $ php index.php tools message "John Smith" +

+ +

Here we are passing it a argument in the same way that URL parameters work. "John Smith" is passed as a argument and output is: Hello John Smith!.

+ +

That's it!

+ +

That, in a nutshell, is all there is to know about controllers on the command line. Remember that this is just a normal controller, so routing and _remap works fine.

+ + + +

+ + + + + + + \ No newline at end of file diff --git a/user_guide/nav/nav.js b/user_guide/nav/nav.js index eaa5f6237..ce783fc27 100644 --- a/user_guide/nav/nav.js +++ b/user_guide/nav/nav.js @@ -58,6 +58,7 @@ function create_menu(basepath) '

Error Handling

' + '

Caching

' + '

Profiling Your Application

' + + '

Running via the CLI

' + '

Managing Applications

' + '

Handling Multiple Environments

' + '

Alternative PHP Syntax

' + diff --git a/user_guide/toc.html b/user_guide/toc.html index 4e0b65212..3df1a4b3b 100644 --- a/user_guide/toc.html +++ b/user_guide/toc.html @@ -111,7 +111,9 @@ Table of Contents

Error Handling

Caching

Profiling Your Application

Running via the CLI

Managing Applications

Handling Multiple Environments

Alternative PHP Syntax

Security

PHP Style Guide

-- cgit v1.2.3-24-g4f1b From 1f622294b92c095fd91e8ca44912d405c1605ded Mon Sep 17 00:00:00 2001 From: Pascal Kriete Date: Thu, 7 Apr 2011 12:06:51 -0400 Subject: Wow, I screwed that up, Reactor is going to 2.0.2 not 2.0.1 --- user_guide/changelog.html | 8 ++++---- user_guide/database/active_record.html | 2 +- user_guide/database/caching.html | 2 +- user_guide/database/call_function.html | 2 +- user_guide/database/configuration.html | 2 +- user_guide/database/connecting.html | 2 +- user_guide/database/examples.html | 2 +- user_guide/database/fields.html | 2 +- user_guide/database/forge.html | 2 +- user_guide/database/helpers.html | 2 +- user_guide/database/index.html | 2 +- user_guide/database/queries.html | 2 +- user_guide/database/results.html | 2 +- user_guide/database/table_data.html | 2 +- user_guide/database/transactions.html | 2 +- user_guide/database/utilities.html | 2 +- user_guide/doc_style/index.html | 2 +- user_guide/general/alternative_php.html | 2 +- user_guide/general/ancillary_classes.html | 2 +- user_guide/general/autoloader.html | 2 +- user_guide/general/caching.html | 2 +- user_guide/general/cli.html | 2 +- user_guide/general/common_functions.html | 2 +- user_guide/general/controllers.html | 2 +- user_guide/general/core_classes.html | 2 +- user_guide/general/creating_drivers.html | 2 +- user_guide/general/creating_libraries.html | 2 +- user_guide/general/credits.html | 2 +- user_guide/general/drivers.html | 2 +- user_guide/general/environments.html | 2 +- user_guide/general/errors.html | 2 +- user_guide/general/helpers.html | 2 +- user_guide/general/hooks.html | 2 +- user_guide/general/libraries.html | 2 +- user_guide/general/managing_apps.html | 2 +- user_guide/general/models.html | 2 +- user_guide/general/profiling.html | 2 +- user_guide/general/quick_reference.html | 2 +- user_guide/general/requirements.html | 2 +- user_guide/general/reserved_names.html | 2 +- user_guide/general/routing.html | 2 +- user_guide/general/security.html | 2 +- user_guide/general/styleguide.html | 2 +- user_guide/general/urls.html | 2 +- user_guide/general/views.html | 2 +- user_guide/helpers/array_helper.html | 2 +- user_guide/helpers/captcha_helper.html | 2 +- user_guide/helpers/cookie_helper.html | 2 +- user_guide/helpers/date_helper.html | 2 +- user_guide/helpers/directory_helper.html | 2 +- user_guide/helpers/download_helper.html | 2 +- user_guide/helpers/email_helper.html | 2 +- user_guide/helpers/file_helper.html | 2 +- user_guide/helpers/form_helper.html | 2 +- user_guide/helpers/html_helper.html | 2 +- user_guide/helpers/inflector_helper.html | 2 +- user_guide/helpers/language_helper.html | 2 +- user_guide/helpers/number_helper.html | 2 +- user_guide/helpers/path_helper.html | 2 +- user_guide/helpers/security_helper.html | 2 +- user_guide/helpers/smiley_helper.html | 2 +- user_guide/helpers/string_helper.html | 2 +- user_guide/helpers/text_helper.html | 2 +- user_guide/helpers/typography_helper.html | 2 +- user_guide/helpers/url_helper.html | 2 +- user_guide/helpers/xml_helper.html | 2 +- user_guide/index.html | 2 +- user_guide/installation/downloads.html | 2 +- user_guide/installation/index.html | 2 +- user_guide/installation/troubleshooting.html | 2 +- user_guide/installation/upgrade_120.html | 2 +- user_guide/installation/upgrade_130.html | 2 +- user_guide/installation/upgrade_131.html | 2 +- user_guide/installation/upgrade_132.html | 2 +- user_guide/installation/upgrade_133.html | 2 +- user_guide/installation/upgrade_140.html | 2 +- user_guide/installation/upgrade_141.html | 2 +- user_guide/installation/upgrade_150.html | 2 +- user_guide/installation/upgrade_152.html | 2 +- user_guide/installation/upgrade_153.html | 2 +- user_guide/installation/upgrade_154.html | 2 +- user_guide/installation/upgrade_160.html | 2 +- user_guide/installation/upgrade_161.html | 2 +- user_guide/installation/upgrade_162.html | 2 +- user_guide/installation/upgrade_163.html | 2 +- user_guide/installation/upgrade_170.html | 2 +- user_guide/installation/upgrade_171.html | 2 +- user_guide/installation/upgrade_172.html | 2 +- user_guide/installation/upgrade_200.html | 2 +- user_guide/installation/upgrade_201.html | 2 +- user_guide/installation/upgrade_b11.html | 2 +- user_guide/installation/upgrading.html | 2 +- user_guide/libraries/benchmark.html | 2 +- user_guide/libraries/caching.html | 2 +- user_guide/libraries/calendar.html | 2 +- user_guide/libraries/cart.html | 2 +- user_guide/libraries/config.html | 2 +- user_guide/libraries/email.html | 2 +- user_guide/libraries/encryption.html | 2 +- user_guide/libraries/file_uploading.html | 2 +- user_guide/libraries/form_validation.html | 2 +- user_guide/libraries/ftp.html | 2 +- user_guide/libraries/image_lib.html | 2 +- user_guide/libraries/input.html | 2 +- user_guide/libraries/javascript.html | 2 +- user_guide/libraries/language.html | 2 +- user_guide/libraries/loader.html | 2 +- user_guide/libraries/output.html | 2 +- user_guide/libraries/pagination.html | 2 +- user_guide/libraries/parser.html | 2 +- user_guide/libraries/security.html | 2 +- user_guide/libraries/sessions.html | 2 +- user_guide/libraries/table.html | 2 +- user_guide/libraries/trackback.html | 2 +- user_guide/libraries/typography.html | 2 +- user_guide/libraries/unit_testing.html | 2 +- user_guide/libraries/uri.html | 2 +- user_guide/libraries/user_agent.html | 2 +- user_guide/libraries/xmlrpc.html | 2 +- user_guide/libraries/zip.html | 2 +- user_guide/license.html | 2 +- user_guide/overview/appflow.html | 2 +- user_guide/overview/at_a_glance.html | 2 +- user_guide/overview/cheatsheets.html | 2 +- user_guide/overview/features.html | 2 +- user_guide/overview/getting_started.html | 2 +- user_guide/overview/goals.html | 2 +- user_guide/overview/index.html | 2 +- user_guide/overview/mvc.html | 2 +- user_guide/toc.html | 2 +- 130 files changed, 133 insertions(+), 133 deletions(-) (limited to 'user_guide') diff --git a/user_guide/changelog.html b/user_guide/changelog.html index d34f5c8f0..446b2d618 100644 --- a/user_guide/changelog.html +++ b/user_guide/changelog.html @@ -28,7 +28,7 @@

- +

wrapchars	76		Character count to wrap at.
mailtype	text	text or html	Type of mail. If you send HTML email you must send it as a complete web page. Make sure you don't have any relative links or relative image paths otherwise they will not work.	mailtype	text	text or html	Type of mail. If you send HTML email you must send it as a complete web page. Make sure you don't have any relative links or relative image paths otherwise they will not work.
charset	utf-8		Character set (utf-8, iso-8859-1, etc.).
validate	FALSE	TRUE or FALSE (boolean)	Whether to validate the email address.	validate	FALSE	TRUE or FALSE (boolean)	Whether to validate the email address.
priority	3	1, 2, 3, 4, 5	Email Priority. 1 = highest. 5 = lowest. 3 = normal.	priority	3	1, 2, 3, 4, 5	Email Priority. 1 = highest. 5 = lowest. 3 = normal.
crlf
$legacy_mode	MCRYPT_MODE_ECB	The Mcrypt mode that was used to generate the original encrypted data. CodeIgniter 1.x's default was MCRYPT_MODE_ECB, and it will +	The Mcrypt mode that was used to generate the original encrypted data. CodeIgniter 1.x's default was MCRYPT_MODE_ECB, and it will assume that to be the case unless overridden by this parameter.
$key	n/a	The encryption key. This it typically specified in your config file as outlined above.	The encryption key. This it typically specified in your config file as outlined above.

upload_path	None	None	The path to the folder where the upload should be placed. The folder must be writable and the path can be absolute or relative.	The path to the folder where the upload should be placed. The folder must be writable and the path can be absolute or relative.
allowed_types	None	None	The mime types corresponding to the types of files you allow to be uploaded. Usually the file extension can be used as the mime type. Separate multiple types with a pipe.	The mime types corresponding to the types of files you allow to be uploaded. Usually the file extension can be used as the mime type. Separate multiple types with a pipe.
None	Desired file name	- If set CodeIgniter will rename the uploaded file to this name. The extension provided in the file name must also be an allowed file type. + If set CodeIgniter will rename the uploaded file to this name. The extension provided in the file name must also be an allowed file type.
max_size	0	None	The maximum size (in kilobytes) that the file can be. Set to zero for no limit. Note: Most PHP installations have their own limit, as specified in the php.ini file. Usually 2 MB (or 2048 KB) by default.	The maximum size (in kilobytes) that the file can be. Set to zero for no limit. Note: Most PHP installations have their own limit, as specified in the php.ini file. Usually 2 MB (or 2048 KB) by default.
max_width	0	None	The maximum width (in pixels) that the file can be. Set to zero for no limit.	The maximum width (in pixels) that the file can be. Set to zero for no limit.
max_height	0	None	The maximum height (in pixels) that the file can be. Set to zero for no limit.	The maximum height (in pixels) that the file can be. Set to zero for no limit.
max_filename	0	None	The maximum length that a file name can be. Set to zero for no limit.	The maximum length that a file name can be. Set to zero for no limit.
The file name without the extension
orig_name	The original file name. This is only useful if you use the encrypted name option.
The original file name. This is only useful if you use the encrypted name option.
client_name	The file name as supplied by the client user agent, prior to any file name preparation or incrementing.
The file size in kilobytes
is_image	Whether the file is an image or not. 1 = image. 0 = not.
Whether the file is an image or not. 1 = image. 0 = not.
image_width	Image width.
Image height
image_type	Image type. Typically the file extension without the period.
Image type. Typically the file extension without the period.
image_size_str	A string containing the width and height. Useful to put into an image tag.
A string containing the width and height. Useful to put into an image tag.

Key	Description	Default
benchmarks	Elapsed time of Benchmark points and total execution time	TRUE
config	CodeIgniter Config variables	TRUE
controller_info	The Controller class and method requested	TRUE
get	Any GET data passed in the request	TRUE
http_headers	The HTTP headers for the current request	TRUE
memory_usage	Amount of memory consumed by the current request, in bytes	TRUE
post	Any POST data passed in the request	TRUE
queries	Listing of all database queries executed, including execution time	TRUE
uri_string	The URI of the current request	TRUE
Key	Description	Default
benchmarks	Elapsed time of Benchmark points and total execution time	TRUE
config	CodeIgniter Config variables	TRUE
controller_info	The Controller class and method requested	TRUE
get	Any GET data passed in the request	TRUE
http_headers	The HTTP headers for the current request	TRUE
memory_usage	Amount of memory consumed by the current request, in bytes	TRUE
post	Any POST data passed in the request	TRUE
queries	Listing of all database queries executed, including execution time	TRUE
uri_string	The URI of the current request	TRUE
query_toggle_count	The number of queries after which the query block will default to hidden.	25

Step 2: Replace config/mimes.php

Step 3: Check for forms posting to default controller

Step 3: Remove loading calls for the Security Library

Step 4: Move MY_Security

Step 5: Check for forms posting to default controller

CodeIgniter User Guide Version 2.0.1

Running via the CLI

What is the CLI?

Why run via the command-line?

Let's try it: Hello World!

That's it!

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

Version 2.0.2

Version 2.0.1

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1

CodeIgniter User Guide Version 2.0.2

CodeIgniter User Guide Version 2.0.1