From 8ede1a2ecbb62577afd32996956c5feaf7ddf9b6 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 13:34:52 -0500 Subject: replacing the old HTML user guide with a Sphinx-managed user guide --- user_guide/installation/downloads.html | 115 --------------- user_guide/installation/index.html | 110 --------------- user_guide/installation/troubleshooting.html | 90 ------------ user_guide/installation/upgrade_120.html | 92 ------------ user_guide/installation/upgrade_130.html | 203 --------------------------- user_guide/installation/upgrade_131.html | 102 -------------- user_guide/installation/upgrade_132.html | 100 ------------- user_guide/installation/upgrade_133.html | 112 --------------- user_guide/installation/upgrade_140.html | 145 ------------------- user_guide/installation/upgrade_141.html | 148 ------------------- user_guide/installation/upgrade_150.html | 178 ----------------------- user_guide/installation/upgrade_152.html | 111 --------------- user_guide/installation/upgrade_153.html | 100 ------------- user_guide/installation/upgrade_154.html | 116 --------------- user_guide/installation/upgrade_160.html | 125 ----------------- user_guide/installation/upgrade_161.html | 98 ------------- user_guide/installation/upgrade_162.html | 106 -------------- user_guide/installation/upgrade_163.html | 99 ------------- user_guide/installation/upgrade_170.html | 121 ---------------- user_guide/installation/upgrade_171.html | 98 ------------- user_guide/installation/upgrade_172.html | 109 -------------- user_guide/installation/upgrade_200.html | 131 ----------------- user_guide/installation/upgrade_201.html | 105 -------------- user_guide/installation/upgrade_202.html | 97 ------------- user_guide/installation/upgrade_203.html | 121 ---------------- user_guide/installation/upgrade_210.html | 91 ------------ user_guide/installation/upgrade_b11.html | 144 ------------------- user_guide/installation/upgrading.html | 106 -------------- 28 files changed, 3273 deletions(-) delete mode 100644 user_guide/installation/downloads.html delete mode 100644 user_guide/installation/index.html delete mode 100644 user_guide/installation/troubleshooting.html delete mode 100644 user_guide/installation/upgrade_120.html delete mode 100644 user_guide/installation/upgrade_130.html delete mode 100644 user_guide/installation/upgrade_131.html delete mode 100644 user_guide/installation/upgrade_132.html delete mode 100644 user_guide/installation/upgrade_133.html delete mode 100644 user_guide/installation/upgrade_140.html delete mode 100644 user_guide/installation/upgrade_141.html delete mode 100644 user_guide/installation/upgrade_150.html delete mode 100644 user_guide/installation/upgrade_152.html delete mode 100644 user_guide/installation/upgrade_153.html delete mode 100644 user_guide/installation/upgrade_154.html delete mode 100644 user_guide/installation/upgrade_160.html delete mode 100644 user_guide/installation/upgrade_161.html delete mode 100644 user_guide/installation/upgrade_162.html delete mode 100644 user_guide/installation/upgrade_163.html delete mode 100644 user_guide/installation/upgrade_170.html delete mode 100644 user_guide/installation/upgrade_171.html delete mode 100644 user_guide/installation/upgrade_172.html delete mode 100644 user_guide/installation/upgrade_200.html delete mode 100644 user_guide/installation/upgrade_201.html delete mode 100644 user_guide/installation/upgrade_202.html delete mode 100644 user_guide/installation/upgrade_203.html delete mode 100644 user_guide/installation/upgrade_210.html delete mode 100644 user_guide/installation/upgrade_b11.html delete mode 100644 user_guide/installation/upgrading.html (limited to 'user_guide/installation') diff --git a/user_guide/installation/downloads.html b/user_guide/installation/downloads.html deleted file mode 100644 index bb18f1de2..000000000 --- a/user_guide/installation/downloads.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -Downloading CodeIgniter : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Downloading CodeIgniter

- - - - - - -

Git Server

-

Git is a distributed version control system.

- -

Public Git access is available at GitHub. - Please note that while every effort is made to keep this code base functional, we cannot guarantee the functionality of code taken - from the tip.

- -

Beginning with version 2.0.3, stable tags are also available via GitHub, simply select the version from the Tags dropdown.

-
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/index.html b/user_guide/installation/index.html deleted file mode 100644 index ad66ad7a6..000000000 --- a/user_guide/installation/index.html +++ /dev/null @@ -1,110 +0,0 @@ - - - - - -Installation Instructions : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Installation Instructions

- -

CodeIgniter is installed in four steps:

- -
    -
  1. Unzip the package.
    2. -
  2. Upload the CodeIgniter folders and files to your server. Normally the index.php file will be at your root.
    3. -
  3. Open the application/config/config.php file with a text editor and set your base URL. If you intend to use encryption or sessions, set your encryption key.
    4. -
  4. If you intend to use a database, open the application/config/database.php file with a text editor and set your database settings.
    5. -
- -

If you wish to increase security by hiding the location of your CodeIgniter files you can rename the system and application folders -to something more private. If you do rename them, you must open your main index.php file and set the $system_path and $application_folder -variables at the top of the file with the new name you've chosen.

- -

For the best security, both the system and any application folders should be placed above web root so that they are not directly accessible via a browser. By default, .htaccess files are included in each folder to help prevent direct access, but it is best to remove them from public access entirely in case the web server configuration changes or doesn't abide by the .htaccess.

- -

If you would like to keep your views public it is also possible to move the views folder out of your application folder.

- -

After moving them, open your main index.php file and set the $system_path, $application_folder and $view_folder variables, preferably with a full path, e.g. '/www/MyUser/system'.

- -

- One additional measure to take in production environments is to disable - PHP error reporting and any other development-only functionality. In CodeIgniter, - this can be done by setting the ENVIRONMENT constant, which is - more fully described on the security page. -

- -

That's it!

- -

If you're new to CodeIgniter, please read the Getting Started section of the User Guide to begin learning how -to build dynamic PHP applications. Enjoy!

- - - -
- - - - - - - diff --git a/user_guide/installation/troubleshooting.html b/user_guide/installation/troubleshooting.html deleted file mode 100644 index 943e2d802..000000000 --- a/user_guide/installation/troubleshooting.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - - -Troubleshooting : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Troubleshooting

- -

If you find that no matter what you put in your URL only your default page is loading, it might be that your server -does not support the PATH_INFO variable needed to serve search-engine friendly URLs. - -As a first step, open your application/config/config.php file and look for the URI Protocol -information. It will recommend that you try a couple alternate settings. If it still doesn't work after you've tried this you'll need -to force CodeIgniter to add a question mark to your URLs. To do this open your application/config/config.php file and change this:

- -$config['index_page'] = "index.php"; - -

To this:

- -$config['index_page'] = "index.php?"; - - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_120.html b/user_guide/installation/upgrade_120.html deleted file mode 100644 index 357f68bbb..000000000 --- a/user_guide/installation/upgrade_120.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading From Beta 1.0 to Final 1.2

- -

To upgrade to Version 1.2 please replace the following directories with the new versions:

- -

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

- - - -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_130.html b/user_guide/installation/upgrade_130.html deleted file mode 100644 index 7ad26bbfd..000000000 --- a/user_guide/installation/upgrade_130.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.2 to 1.3

- -

Note: The instructions on this page assume you are running version 1.2. If you -have not upgraded to that version please do so first.

- - -

Before performing an update you should take your site offline by replacing the index.php file -with a static one.

- - -

Step 1: Update your CodeIgniter files

- -

Replace the following directories in your "system" folder with the new versions:

- -

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

- - - - -

Step 2: Update your error files

- -

Version 1.3 contains two new error templates located in application/errors, and for naming consistency the other error templates have -been renamed.

- -

If you have not customized any of the error templates simply -replace this folder:

- - - -

If you have customized your error templates, rename them as follows:

- - - - - -

Step 3: Update your index.php file

- -

Please open your main index.php file (located at your root). At the very bottom of the file, change this:

- -require_once BASEPATH.'libraries/Front_controller'.EXT; - -

To this:

- -require_once BASEPATH.'codeigniter/CodeIgniter'.EXT; - - -

Step 4: Update your config.php file

- -

Open your application/config/config.php file and add these new items:

- -
-/*
-|------------------------------------------------
-| URL suffix
-|------------------------------------------------
-|
-| This option allows you to add a suffix to all URLs.
-| For example, if a URL is this:
-|
-| example.com/index.php/products/view/shoes
-|
-| You can optionally add a suffix, like ".html",
-| making the page appear to be of a certain type:
-|
-| example.com/index.php/products/view/shoes.html
-|
-*/
-$config['url_suffix'] = "";
-
-
-/*
-|------------------------------------------------
-| Enable Query Strings
-|------------------------------------------------
-|
-| By default CodeIgniter uses search-engine and
-| human-friendly segment based URLs:
-|
-| example.com/who/what/where/
-|
-| You can optionally enable standard query string
-| based URLs:
-|
-| example.com?who=me&what=something&where=here
-|
-| Options are: TRUE or FALSE (boolean)
-|
-| The two other items let you set the query string "words"
-| that will invoke your controllers and functions:
-| example.com/index.php?c=controller&m=function
-|
-*/
-$config['enable_query_strings'] = FALSE;
-$config['controller_trigger'] = 'c';
-$config['function_trigger'] = 'm';
-
- - -

Step 5: Update your database.php file

- -

Open your application/config/database.php file and add these new items:

- -
-$db['default']['dbprefix'] = "";
-$db['default']['active_r'] = TRUE;
-
- - -

Step 6: Update your user guide

- -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_131.html b/user_guide/installation/upgrade_131.html deleted file mode 100644 index bc624261a..000000000 --- a/user_guide/installation/upgrade_131.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.3 to 1.3.1

- -

Note: The instructions on this page assume you are running version 1.3. If you -have not upgraded to that version please do so first.

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace the following directories in your "system" folder with the new versions:

- -

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

- - - - -

Step 2: Update your user guide

- -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_132.html b/user_guide/installation/upgrade_132.html deleted file mode 100644 index beef9b279..000000000 --- a/user_guide/installation/upgrade_132.html +++ /dev/null @@ -1,100 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.3.1 to 1.3.2

- -

Note: The instructions on this page assume you are running version 1.3.1. If you -have not upgraded to that version please do so first.

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace the following directories in your "system" folder with the new versions:

- -

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

- - - - -

Step 2: Update your user guide

- -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_133.html b/user_guide/installation/upgrade_133.html deleted file mode 100644 index 4d61ac601..000000000 --- a/user_guide/installation/upgrade_133.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.3.2 to 1.3.3

- -

Note: The instructions on this page assume you are running version 1.3.2. If you -have not upgraded to that version please do so first.

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace the following directories in your "system" folder with the new versions:

- -

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

- - - - -

Step 2: Update your Models

- -

If you are NOT using CodeIgniter's Models feature disregard this step.

- -

As of version 1.3.3, CodeIgniter does not connect automatically to your database when a model is loaded. This -allows you greater flexibility in determining which databases you would like used with your models. If your application is not connecting -to your database prior to a model being loaded you will have to update your code. There are several options for connecting, -as described here.

- - -

Step 3: Update your user guide

- -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_140.html b/user_guide/installation/upgrade_140.html deleted file mode 100644 index 721d70695..000000000 --- a/user_guide/installation/upgrade_140.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.3.3 to 1.4.0

- -

Note: The instructions on this page assume you are running version 1.3.3. If you -have not upgraded to that version please do so first.

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace the following directories in your "system" folder with the new versions:

- -

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

- - - - -

Step 2: Update your config.php file

- -

Open your application/config/config.php file and add these new items:

- -
-
-/*
-|--------------------------------------------------------------------------
-| Enable/Disable System Hooks
-|--------------------------------------------------------------------------
-|
-| If you would like to use the "hooks" feature you must enable it by
-| setting this variable to TRUE (boolean).  See the user guide for details.
-|
-*/
-$config['enable_hooks'] = FALSE;
-
-
-/*
-|--------------------------------------------------------------------------
-| Allowed URL Characters
-|--------------------------------------------------------------------------
-|
-| This lets you specify which characters are permitted within your URLs.
-| When someone tries to submit a URL with disallowed characters they will
-| get a warning message.
-|
-| As a security measure you are STRONGLY encouraged to restrict URLs to
-| as few characters as possible.  By default only these are allowed: a-z 0-9~%.:_-
-|
-| Leave blank to allow all characters -- but only if you are insane.
-|
-| DO NOT CHANGE THIS UNLESS YOU FULLY UNDERSTAND THE REPERCUSSIONS!!
-|
-*/
-$config['permitted_uri_chars'] = 'a-z 0-9~%.:_-';
-
- - -

Step 3: Update your user guide

- -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_141.html b/user_guide/installation/upgrade_141.html deleted file mode 100644 index 7c81d0521..000000000 --- a/user_guide/installation/upgrade_141.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.4.0 to 1.4.1

- -

Note: The instructions on this page assume you are running version 1.4.0. If you -have not upgraded to that version please do so first.

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace the following directories in your "system" folder with the new versions:

- -

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

- - - - -

Step 2: Update your config.php file

- -

Open your application/config/config.php file and add this new item:

- -
-
-/*
-|--------------------------------------------------------------------------
-| Output Compression
-|--------------------------------------------------------------------------
-|
-| Enables Gzip output compression for faster page loads.  When enabled,
-| the output class will test whether your server supports Gzip.
-| Even if it does, however, not all browsers support compression
-| so enable only if you are reasonably sure your visitors can handle it.
-|
-| VERY IMPORTANT:  If you are getting a blank page when compression is enabled it
-| means you are prematurely outputting something to your browser. It could
-| even be a line of whitespace at the end of one of your scripts.  For
-| compression to work, nothing can be sent before the output buffer is called
-| by the output class.  Do not "echo" any values with compression enabled.
-|
-*/
-$config['compress_output'] = FALSE;
-
-
- - - -

Step 3: Rename an Autoload Item

- -

Open the following file: application/config/autoload.php

- -

Find this array item:

- -$autoload['core'] = array(); - -

And rename it to this:

- -$autoload['libraries'] = array(); - -

This change was made to improve clarity since some users were not sure that their own libraries could be auto-loaded.

- - - - - - -

Step 4: Update your user guide

- -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_150.html b/user_guide/installation/upgrade_150.html deleted file mode 100644 index f622ea310..000000000 --- a/user_guide/installation/upgrade_150.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.4.1 to 1.5.0

- -

Note: The instructions on this page assume you are running version 1.4.1. If you -have not upgraded to that version please do so first.

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- - -

Step 2: Update your database.php file

- -

Open your application/config/database.php file and add these new items:

- -
-$db['default']['cache_on'] = FALSE;
-$db['default']['cachedir'] = '';
-
- - - -

Step 3: Update your config.php file

- -

Open your application/config/config.php file and ADD these new items:

- -
-/*
-|--------------------------------------------------------------------------
-| Class Extension Prefix
-|--------------------------------------------------------------------------
-|
-| This item allows you to set the filename/classname prefix when extending
-| native libraries.  For more information please see the user guide:
-|
-| http://codeigniter.com/user_guide/general/core_classes.html
-| http://codeigniter.com/user_guide/general/creating_libraries.html
-|
-*/
-$config['subclass_prefix'] = 'MY_';
-
-/*
-|--------------------------------------------------------------------------
-| Rewrite PHP Short Tags
-|--------------------------------------------------------------------------
-|
-| If your PHP installation does not have short tag support enabled CI
-| can rewrite the tags on-the-fly, enabling you to utilize that syntax
-| in your view files.  Options are TRUE or FALSE (boolean)
-|
-*/
-$config['rewrite_short_tags'] = FALSE;
-
- -

In that same file REMOVE this item:

- - -
-/*
-|--------------------------------------------------------------------------
-| Enable/Disable Error Logging
-|--------------------------------------------------------------------------
-|
-| If you would like errors or debug messages logged set this variable to
-| TRUE (boolean).  Note: You must set the file permissions on the "logs" folder
-| such that it is writable.
-|
-*/
-$config['log_errors'] = FALSE;
-
- -

Error logging is now disabled simply by setting the threshold to zero.

- - - -

Step 4: Update your main index.php file

- -

If you are running a stock index.php file simply replace your version with the new one.

- -

If your index.php file has internal modifications, please add your modifications to the new file and use it.

- - - -

Step 5: Update your user guide

- -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_152.html b/user_guide/installation/upgrade_152.html deleted file mode 100644 index d350aae78..000000000 --- a/user_guide/installation/upgrade_152.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.5.0 to 1.5.2

- -

Note: The instructions on this page assume you are running version 1.5.0 or 1.5.1. If you -have not upgraded to that version please do so first.

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- - -

Step 2: Update your user guide

- -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_153.html b/user_guide/installation/upgrade_153.html deleted file mode 100644 index 50c6970e3..000000000 --- a/user_guide/installation/upgrade_153.html +++ /dev/null @@ -1,100 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.5.2 to 1.5.3

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- - -

Step 2: Update your user guide

- -

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_154.html b/user_guide/installation/upgrade_154.html deleted file mode 100644 index 90abaf30b..000000000 --- a/user_guide/installation/upgrade_154.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - -Upgrading from 1.5.3 to 1.5.4 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.5.3 to 1.5.4

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- -

Step 2: Add charset to your config.php

-

Add the following to application/config/config.php

-/*
- |--------------------------------------------------------------------------
- | Default Character Set
- |--------------------------------------------------------------------------
- |
- | This determines which character set is used by default in various methods
- | that require a character set to be provided.
- |
- */
- $config['charset'] = "UTF-8"; - -

Step 3: Autoloading language files

-

If you want to autoload any language files, add this line to application/config/autoload.php

-$autoload['language'] = array(); - -

Step 4: Update your user guide

-

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_160.html b/user_guide/installation/upgrade_160.html deleted file mode 100644 index 16c53eb46..000000000 --- a/user_guide/installation/upgrade_160.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - -Upgrading from 1.5.4 to 1.6.0 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.5.4 to 1.6.0

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- -

Step 2: Add time_to_update to your config.php

-

Add the following to application/config/config.php with the other session configuration options

-

$config['sess_time_to_update'] = 300;

-

Step 3: Add $autoload['model']

-

Add the following to application/config/autoload.php

-

/*
- | -------------------------------------------------------------------
- | Auto-load Model files
- | -------------------------------------------------------------------
- | Prototype:
- |
- | $autoload['model'] = array('my_model');
- |
- */
-
- $autoload['model'] = array();

-

Step 4: Add to your database.php

-

Make the following changes to your application/config/database.php file:

-

Add the following variable above the database configuration options, with $active_group

-

$active_record = TRUE;

-

Remove the following from your database configuration options

-

$db['default']['active_r'] = TRUE;

-

Add the following to your database configuration options

-

$db['default']['char_set'] = "utf8";
-$db['default']['dbcollat'] = "utf8_general_ci";

- -

Step 5: Update your user guide

-

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_161.html b/user_guide/installation/upgrade_161.html deleted file mode 100644 index b167f1da4..000000000 --- a/user_guide/installation/upgrade_161.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - - -Upgrading from 1.6.0 to 1.6.1 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.6.0 to 1.6.1

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- -

Step 2: Update your user guide

-

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_162.html b/user_guide/installation/upgrade_162.html deleted file mode 100644 index 015b7da75..000000000 --- a/user_guide/installation/upgrade_162.html +++ /dev/null @@ -1,106 +0,0 @@ - - - - - -Upgrading from 1.6.1 to 1.6.2 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.6.1 to 1.6.2

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- - -

Step 2: Encryption Key

-

If you are using sessions, open up application/config/config.php and verify you've set an encryption key.

- -

Step 3: Constants File

-

Copy /application/config/constants.php to your installation, and modify if necessary.

-

Step 4: Mimes File

-

Replace /application/config/mimes.php with the dowloaded version. If you've added custom mime types, you'll need to re-add them.

-

Step 5: Update your user guide

-

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_163.html b/user_guide/installation/upgrade_163.html deleted file mode 100644 index a1c3c8ff9..000000000 --- a/user_guide/installation/upgrade_163.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - -Upgrading from 1.6.2 to 1.6.3 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.6.2 to 1.6.3

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- - -

Step 2: Update your user guide

-

Please also replace your local copy of the user guide with the new version.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_170.html b/user_guide/installation/upgrade_170.html deleted file mode 100644 index a0e12c678..000000000 --- a/user_guide/installation/upgrade_170.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - -Upgrading from 1.6.3 to 1.7.0 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.6.3 to 1.7.0

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- - -

Step 2: Update your Session Table

- -

If you are using the Session class in your application, AND if you are storing session data to a database, you must add a new column named user_data to your session table. -Here is an example of what this column might look like for MySQL:

- -user_data text NOT NULL - -

To add this column you will run a query similar to this:

- -ALTER TABLE `ci_sessions` ADD `user_data` text NOT NULL - -

You'll find more information regarding the new Session functionality in the Session class page.

- - -

Step 3: Update your Validation Syntax

- -

This is an optional, but recommended step, for people currently using the Validation class. CI 1.7 introduces a new Form Validation class, which -deprecates the old Validation library. We have left the old one in place so that existing applications that use it will not break, but you are encouraged to -migrate to the new version as soon as possible. Please read the user guide carefully as the new library works a little differently, and has several new features.

- - - -

Step 4: Update your user guide

-

Please replace your local copy of the user guide with the new version, including the image files.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_171.html b/user_guide/installation/upgrade_171.html deleted file mode 100644 index 052af69f7..000000000 --- a/user_guide/installation/upgrade_171.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - - -Upgrading from 1.7.0 to 1.7.1 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.7.0 to 1.7.1

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- -

Step 2: Update your user guide

-

Please replace your local copy of the user guide with the new version, including the image files.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_172.html b/user_guide/installation/upgrade_172.html deleted file mode 100644 index 971453297..000000000 --- a/user_guide/installation/upgrade_172.html +++ /dev/null @@ -1,109 +0,0 @@ - - - - - -Upgrading from 1.7.1 to 1.7.2 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.7.1 to 1.7.2

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace these files and directories in your "system" folder with the new versions:

- - - -

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

- -

Step 2: Remove header() from 404 error template

-

If you are using header() in your 404 error template, such as the case with the default error_404.php template shown below, remove that line of code.

- -<?php header("HTTP/1.1 404 Not Found"); ?> - -

404 status headers are now properly handled in the show_404() method itself.

- -

Step 3: Confirm your system_path

-

In your updated index.php file, confirm that the $system_path variable is set to your application's system folder.

- -

Step 4: Update your user guide

-

Please replace your local copy of the user guide with the new version, including the image files.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_200.html b/user_guide/installation/upgrade_200.html deleted file mode 100644 index 9f9dce7d0..000000000 --- a/user_guide/installation/upgrade_200.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - -Upgrading from 1.7.2 to 2.0.0 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 1.7.2 to 2.0.0

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - - -

Step 1: Update your CodeIgniter files

- -

Replace all files and directories in your "system" folder except your application folder.

- -

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

- -

Step 2: Adjust get_dir_file_info() where necessary

- -

Version 2.0.0 brings a non-backwards compatible change to get_dir_file_info() in the File Helper. Non-backwards compatible changes are extremely rare - in CodeIgniter, but this one we feel was warranted due to how easy it was to create serious server performance issues. If you need - recursiveness where you are using this helper function, change such instances, setting the second parameter, $top_level_only to FALSE:

- -get_dir_file_info('/path/to/directory', FALSE); - -

- -

Step 3: Convert your Plugins to Helpers

- -

2.0.0 gets rid of the "Plugin" system as their functionality was identical to Helpers, but non-extensible. You will need to rename your plugin files from filename_pi.php to filename_helper.php, move them to your helpers folder, and change all instances of: - - $this->load->plugin('foo'); - -to - - $this->load->helper('foo'); - -

- -

Step 4: Update stored encrypted data

- -

Note: If your application does not use the Encryption library, does not store Encrypted data permanently, or is on an environment that does not support Mcrypt, you may skip this step.

- -

The Encryption library has had a number of improvements, some for encryption strength and some for performance, that has an unavoidable consequence of - making it no longer possible to decode encrypted data produced by the original version of this library. To help with the transition, a new method has - been added, encode_from_legacy() that will decode the data with the original algorithm and return a re-encoded string using the improved methods. - This will enable you to easily replace stale encrypted data with fresh in your applications, either on the fly or en masse.

- -

Please read how to use this method in the Encryption library documentation.

- -

Step 5: Remove loading calls for the compatibility helper.

-

The compatibility helper has been removed from the CodeIgniter core. All methods in it should be natively available in supported PHP versions.

- -

Step 6: Update Class extension

-

All core classes are now prefixed with CI_. Update Models and Controllers to extend CI_Model and CI_Controller, respectively.

- -

Step 7: Update Parent Constructor calls

-

All native CodeIgniter classes now use the PHP 5 __construct() convention. Please update extended libraries to call parent::__construct().

- -

Step 8: Update your user guide

-

Please replace your local copy of the user guide with the new version, including the image files.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_201.html b/user_guide/installation/upgrade_201.html deleted file mode 100644 index 7ae29b824..000000000 --- a/user_guide/installation/upgrade_201.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -Upgrading from 2.0.0 to 2.0.1 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 2.0.0 to 2.0.1

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - -

Step 1: Update your CodeIgniter files

- -

Replace all files and directories in your "system" folder and replace your index.php file. If any modifications were made to your index.php they will need to be made fresh in this new one.

- -

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

- -

- 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. - If submitting to the default controller was the expected behavior it will need to be changed from: -

- -echo form_open(); //<form action="" method="post" accept-charset="utf-8"> - -

to use either a / or base_url():

- -echo form_open('/'); //<form action="http://example.com/index.php/" method="post" accept-charset="utf-8">
-echo form_open(base_url()); //<form action="http://example.com/" method="post" accept-charset="utf-8"> - -
- - - - - - - diff --git a/user_guide/installation/upgrade_202.html b/user_guide/installation/upgrade_202.html deleted file mode 100644 index b6c62b4d5..000000000 --- a/user_guide/installation/upgrade_202.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - -Upgrading from 2.0.1 to 2.0.2 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 2.0.1 to 2.0.2

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - -

Step 1: Update your CodeIgniter files

- -

Replace all files and directories in your "system" folder and replace your index.php file. If any modifications were made to your index.php they will need to be made fresh in this new one.

- -

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

- - -

Step 2: 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 3: Move MY_Security

- -

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

- -

csrf_token_name and csrf_hash have changed to protected class properties. Please use security->get_csrf_hash() and security->get_csrf_token_name() to access those values.

- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_203.html b/user_guide/installation/upgrade_203.html deleted file mode 100644 index 04899832d..000000000 --- a/user_guide/installation/upgrade_203.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - -Upgrading from 2.0.2 to 2.0.3 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 2.0.2 to 2.0.3

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- - -

Step 1: Update your CodeIgniter files

- -

Replace all files and directories in your "system" folder and replace your index.php file. If any modifications were made to your index.php they will need to be made fresh in this new one.

- -

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

- -

Step 2: Update your main index.php file

- -

If you are running a stock index.php file simply replace your version with the new one.

- -

If your index.php file has internal modifications, please add your modifications to the new file and use it.

- -

Step 3: Replace config/user_agents.php

- -

This config file has been updated to contain more user agent types, please copy it to application/config/user_agents.php.

- -

Step 4: Change references of the EXT constant to ".php"

-

Note: The EXT Constant has been marked as deprecated, but has not been removed from the application. You are encouraged to make the changes sooner rather than later.

- -

Step 5: Remove APPPATH.'third_party' from autoload.php

- -

Open application/config/autoload.php, and look for the following:

- -$autoload['packages'] = array(APPPATH.'third_party'); - -

If you have not chosen to load any additional packages, that line can be changed to:

-$autoload['packages'] = array(); - -

Which should provide for nominal performance gains if not autoloading packages.

- -

Update Sessions Database Tables

- -

If you are using database sessions with the CI Session Library, please update your ci_sessions database table as follows:

- - - CREATE INDEX last_activity_idx ON ci_sessions(last_activity); - ALTER TABLE ci_sessions MODIFY user_agent VARCHAR(120); - - - - - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_210.html b/user_guide/installation/upgrade_210.html deleted file mode 100644 index 6e8ddec9d..000000000 --- a/user_guide/installation/upgrade_210.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - - -Upgrading from 2.0.3 to 2.1.0 : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.1.0

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading from 2.0.3 to 2.1.0

- -

Before performing an update you should take your site offline by replacing the index.php file with a static one.

- -

Step 1: Update your CodeIgniter files

- -

Replace all files and directories in your "system" folder and replace your index.php file. If any modifications were made to your index.php they will need to be made fresh in this new one.

- -

Step 2: Replace config/user_agents.php

- -

This config file has been updated to contain more user agent types, please copy it to application/config/user_agents.php.

- -

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

- - - - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_b11.html b/user_guide/installation/upgrade_b11.html deleted file mode 100644 index 7cf06cd9d..000000000 --- a/user_guide/installation/upgrade_b11.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - -CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading From Beta 1.0 to Beta 1.1

- -

To upgrade to Beta 1.1 please perform the following steps:

- -

Step 1: Replace your index file

- -

Replace your main index.php file with the new index.php file. Note: If you have renamed your "system" folder you will need to edit this info in the new file.

- -

Step 2: Relocate your config folder

- -

This version of CodeIgniter now permits multiple sets of "applications" to all share a common set of backend files. In order to enable -each application to have its own configuration values, the config directory must now reside -inside of your application folder, so please move it there.

- - -

Step 3: Replace directories

- -

Replace the following directories with the new versions:

- - - - -

Step 4: Add the calendar language file

- -

There is a new language file corresponding to the new calendaring class which must be added to your language folder. Add -the following item to your version: language/english/calendar_lang.php

- - -

Step 5: Edit your config file

- -

The original application/config/config.php file has a typo in it Open the file and look for the items related to cookies:

- -$conf['cookie_prefix'] = "";
-$conf['cookie_domain'] = "";
-$conf['cookie_path'] = "/"; - -

Change the array name from $conf to $config, like this:

- -$config['cookie_prefix'] = "";
-$config['cookie_domain'] = "";
-$config['cookie_path'] = "/"; - -

Lastly, add the following new item to the config file (and edit the option if needed):

- -
-/*
-|------------------------------------------------
-| URI PROTOCOL
-|------------------------------------------------
-|
-| This item determines which server global
-| should be used to retrieve the URI string. The
-| default setting of "auto" works for most servers.
-| If your links do not seem to work, try one of
-| the other delicious flavors:
-|
-| 'auto' Default - auto detects
-| 'path_info' Uses the PATH_INFO
-| 'query_string' Uses the QUERY_STRING
-*/
-
-$config['uri_protocol'] = "auto"; - - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrading.html b/user_guide/installation/upgrading.html deleted file mode 100644 index 0f4a29bfd..000000000 --- a/user_guide/installation/upgrading.html +++ /dev/null @@ -1,106 +0,0 @@ - - - - - -Upgrading From a Previous Version : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Upgrading From a Previous Version

- -

Please read the upgrade notes corresponding to the version you are upgrading from.

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