From b73eb19aed66190c10c9cad476da7c36c271d6dc Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Thu, 19 Sep 2019 15:08:45 +0300 Subject: [ci skip] 3.1.11 release --- user_guide/installation/downloads.html | 538 +++++++++++ user_guide/installation/index.html | 532 +++++++++++ user_guide/installation/troubleshooting.html | 511 ++++++++++ user_guide/installation/upgrade_120.html | 516 ++++++++++ user_guide/installation/upgrade_130.html | 619 ++++++++++++ user_guide/installation/upgrade_131.html | 527 ++++++++++ user_guide/installation/upgrade_132.html | 525 ++++++++++ user_guide/installation/upgrade_133.html | 539 +++++++++++ user_guide/installation/upgrade_140.html | 567 +++++++++++ user_guide/installation/upgrade_141.html | 564 +++++++++++ user_guide/installation/upgrade_150.html | 591 ++++++++++++ user_guide/installation/upgrade_152.html | 536 +++++++++++ user_guide/installation/upgrade_153.html | 523 ++++++++++ user_guide/installation/upgrade_154.html | 547 +++++++++++ user_guide/installation/upgrade_160.html | 566 +++++++++++ user_guide/installation/upgrade_161.html | 522 ++++++++++ user_guide/installation/upgrade_162.html | 537 +++++++++++ user_guide/installation/upgrade_163.html | 522 ++++++++++ user_guide/installation/upgrade_170.html | 549 +++++++++++ user_guide/installation/upgrade_171.html | 522 ++++++++++ user_guide/installation/upgrade_172.html | 539 +++++++++++ user_guide/installation/upgrade_200.html | 632 ++++++++++++ user_guide/installation/upgrade_201.html | 532 +++++++++++ user_guide/installation/upgrade_202.html | 525 ++++++++++ user_guide/installation/upgrade_203.html | 555 +++++++++++ user_guide/installation/upgrade_210.html | 519 ++++++++++ user_guide/installation/upgrade_211.html | 523 ++++++++++ user_guide/installation/upgrade_212.html | 514 ++++++++++ user_guide/installation/upgrade_213.html | 514 ++++++++++ user_guide/installation/upgrade_214.html | 509 ++++++++++ user_guide/installation/upgrade_220.html | 518 ++++++++++ user_guide/installation/upgrade_221.html | 509 ++++++++++ user_guide/installation/upgrade_222.html | 509 ++++++++++ user_guide/installation/upgrade_223.html | 509 ++++++++++ user_guide/installation/upgrade_300.html | 1330 ++++++++++++++++++++++++++ user_guide/installation/upgrade_301.html | 513 ++++++++++ user_guide/installation/upgrade_302.html | 520 ++++++++++ user_guide/installation/upgrade_303.html | 547 +++++++++++ user_guide/installation/upgrade_304.html | 509 ++++++++++ user_guide/installation/upgrade_305.html | 509 ++++++++++ user_guide/installation/upgrade_306.html | 539 +++++++++++ user_guide/installation/upgrade_310.html | 527 ++++++++++ user_guide/installation/upgrade_311.html | 509 ++++++++++ user_guide/installation/upgrade_3110.html | 517 ++++++++++ user_guide/installation/upgrade_3111.html | 514 ++++++++++ user_guide/installation/upgrade_312.html | 534 +++++++++++ user_guide/installation/upgrade_313.html | 539 +++++++++++ user_guide/installation/upgrade_314.html | 509 ++++++++++ user_guide/installation/upgrade_315.html | 509 ++++++++++ user_guide/installation/upgrade_316.html | 523 ++++++++++ user_guide/installation/upgrade_317.html | 522 ++++++++++ user_guide/installation/upgrade_318.html | 509 ++++++++++ user_guide/installation/upgrade_319.html | 514 ++++++++++ user_guide/installation/upgrade_b11.html | 567 +++++++++++ user_guide/installation/upgrading.html | 553 +++++++++++ 55 files changed, 30073 insertions(+) create mode 100644 user_guide/installation/downloads.html create mode 100644 user_guide/installation/index.html create mode 100644 user_guide/installation/troubleshooting.html create mode 100644 user_guide/installation/upgrade_120.html create mode 100644 user_guide/installation/upgrade_130.html create mode 100644 user_guide/installation/upgrade_131.html create mode 100644 user_guide/installation/upgrade_132.html create mode 100644 user_guide/installation/upgrade_133.html create mode 100644 user_guide/installation/upgrade_140.html create mode 100644 user_guide/installation/upgrade_141.html create mode 100644 user_guide/installation/upgrade_150.html create mode 100644 user_guide/installation/upgrade_152.html create mode 100644 user_guide/installation/upgrade_153.html create mode 100644 user_guide/installation/upgrade_154.html create mode 100644 user_guide/installation/upgrade_160.html create mode 100644 user_guide/installation/upgrade_161.html create mode 100644 user_guide/installation/upgrade_162.html create mode 100644 user_guide/installation/upgrade_163.html create mode 100644 user_guide/installation/upgrade_170.html create mode 100644 user_guide/installation/upgrade_171.html create mode 100644 user_guide/installation/upgrade_172.html create mode 100644 user_guide/installation/upgrade_200.html create mode 100644 user_guide/installation/upgrade_201.html create mode 100644 user_guide/installation/upgrade_202.html create mode 100644 user_guide/installation/upgrade_203.html create mode 100644 user_guide/installation/upgrade_210.html create mode 100644 user_guide/installation/upgrade_211.html create mode 100644 user_guide/installation/upgrade_212.html create mode 100644 user_guide/installation/upgrade_213.html create mode 100644 user_guide/installation/upgrade_214.html create mode 100644 user_guide/installation/upgrade_220.html create mode 100644 user_guide/installation/upgrade_221.html create mode 100644 user_guide/installation/upgrade_222.html create mode 100644 user_guide/installation/upgrade_223.html create mode 100644 user_guide/installation/upgrade_300.html create mode 100644 user_guide/installation/upgrade_301.html create mode 100644 user_guide/installation/upgrade_302.html create mode 100644 user_guide/installation/upgrade_303.html create mode 100644 user_guide/installation/upgrade_304.html create mode 100644 user_guide/installation/upgrade_305.html create mode 100644 user_guide/installation/upgrade_306.html create mode 100644 user_guide/installation/upgrade_310.html create mode 100644 user_guide/installation/upgrade_311.html create mode 100644 user_guide/installation/upgrade_3110.html create mode 100644 user_guide/installation/upgrade_3111.html create mode 100644 user_guide/installation/upgrade_312.html create mode 100644 user_guide/installation/upgrade_313.html create mode 100644 user_guide/installation/upgrade_314.html create mode 100644 user_guide/installation/upgrade_315.html create mode 100644 user_guide/installation/upgrade_316.html create mode 100644 user_guide/installation/upgrade_317.html create mode 100644 user_guide/installation/upgrade_318.html create mode 100644 user_guide/installation/upgrade_319.html create mode 100644 user_guide/installation/upgrade_b11.html create 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 new file mode 100644 index 000000000..48e063eeb --- /dev/null +++ b/user_guide/installation/downloads.html @@ -0,0 +1,538 @@ + + + + + + + + + + Downloading CodeIgniter — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Downloading CodeIgniter

+ +
+

GitHub

+

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 develop branch.

+

Beginning with version 2.0.3, stable versions are also available via GitHub Releases.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/index.html b/user_guide/installation/index.html new file mode 100644 index 000000000..5eaafcc99 --- /dev/null +++ b/user_guide/installation/index.html @@ -0,0 +1,532 @@ + + + + + + + + + + Installation Instructions — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Installation Instructions
    • +
  • + +
    • +
    + classic layout +
    +
+
+
+
+ +
+

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!

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/troubleshooting.html b/user_guide/installation/troubleshooting.html new file mode 100644 index 000000000..ef33be296 --- /dev/null +++ b/user_guide/installation/troubleshooting.html @@ -0,0 +1,511 @@ + + + + + + + + + + Troubleshooting — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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 +REQUEST_URI 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?";
+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_120.html b/user_guide/installation/upgrade_120.html new file mode 100644 index 000000000..ab772478c --- /dev/null +++ b/user_guide/installation/upgrade_120.html @@ -0,0 +1,516 @@ + + + + + + + + + + Upgrading From Beta 1.0 to Final 1.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+
    +
  • drivers
    • +
  • helpers
    • +
  • init
    • +
  • language
    • +
  • libraries
    • +
  • plugins
    • +
  • scaffolding
    • +
+

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

+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_130.html b/user_guide/installation/upgrade_130.html new file mode 100644 index 000000000..5a093a78f --- /dev/null +++ b/user_guide/installation/upgrade_130.html @@ -0,0 +1,619 @@ + + + + + + + + + + Upgrading from 1.2 to 1.3 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+
    +
  • application/models/ (new for 1.3)
    • +
  • codeigniter (new for 1.3)
    • +
  • drivers
    • +
  • helpers
    • +
  • init
    • +
  • language
    • +
  • libraries
    • +
  • plugins
    • +
  • scaffolding
    • +
+
+
+

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:

+
    +
  • application/errors/
    • +
+

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

+
    +
  • 404.php = error_404.php
    • +
  • error.php = error_general.php
    • +
  • error_db.php (new)
    • +
  • error_php.php (new)
    • +
+
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_131.html b/user_guide/installation/upgrade_131.html new file mode 100644 index 000000000..d130f1e6f --- /dev/null +++ b/user_guide/installation/upgrade_131.html @@ -0,0 +1,527 @@ + + + + + + + + + + Upgrading from 1.3 to 1.3.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+
    +
  • drivers
    • +
  • init/init_unit_test.php (new for 1.3.1)
    • +
  • language/
    • +
  • libraries
    • +
  • scaffolding
    • +
+
+
+

Step 2: Update your user guide

+

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

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_132.html b/user_guide/installation/upgrade_132.html new file mode 100644 index 000000000..76ad03d4e --- /dev/null +++ b/user_guide/installation/upgrade_132.html @@ -0,0 +1,525 @@ + + + + + + + + + + Upgrading from 1.3.1 to 1.3.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+
    +
  • drivers
    • +
  • init
    • +
  • libraries
    • +
+
+
+

Step 2: Update your user guide

+

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

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_133.html b/user_guide/installation/upgrade_133.html new file mode 100644 index 000000000..96bf4af33 --- /dev/null +++ b/user_guide/installation/upgrade_133.html @@ -0,0 +1,539 @@ + + + + + + + + + + Upgrading from 1.3.2 to 1.3.3 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+
    +
  • codeigniter
    • +
  • drivers
    • +
  • helpers
    • +
  • init
    • +
  • libraries
    • +
+
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_140.html b/user_guide/installation/upgrade_140.html new file mode 100644 index 000000000..80d53c19e --- /dev/null +++ b/user_guide/installation/upgrade_140.html @@ -0,0 +1,567 @@ + + + + + + + + + + Upgrading from 1.3.3 to 1.4.0 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+
    +
  • application/config/hooks.php
    • +
  • application/config/mimes.php
    • +
  • codeigniter
    • +
  • drivers
    • +
  • helpers
    • +
  • init
    • +
  • language
    • +
  • libraries
    • +
  • scaffolding
    • +
+
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_141.html b/user_guide/installation/upgrade_141.html new file mode 100644 index 000000000..7e049cf32 --- /dev/null +++ b/user_guide/installation/upgrade_141.html @@ -0,0 +1,564 @@ + + + + + + + + + + Upgrading from 1.4.0 to 1.4.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+
    +
  • codeigniter
    • +
  • drivers
    • +
  • helpers
    • +
  • libraries
    • +
+
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_150.html b/user_guide/installation/upgrade_150.html new file mode 100644 index 000000000..0b96c2e39 --- /dev/null +++ b/user_guide/installation/upgrade_150.html @@ -0,0 +1,591 @@ + + + + + + + + + + Upgrading from 1.4.1 to 1.5.0 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • application/config/user_agents.php (new file for 1.5)
    • +
  • application/config/smileys.php (new file for 1.5)
    • +
  • codeigniter/
    • +
  • database/ (new folder for 1.5. Replaces the “drivers” folder)
    • +
  • helpers/
    • +
  • language/
    • +
  • libraries/
    • +
  • scaffolding/
    • +
+
+

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:
+|
+| https://codeigniter.com/user_guide/general/core_classes.html
+| https://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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_152.html b/user_guide/installation/upgrade_152.html new file mode 100644 index 000000000..860961bb5 --- /dev/null +++ b/user_guide/installation/upgrade_152.html @@ -0,0 +1,536 @@ + + + + + + + + + + Upgrading from 1.5.0 to 1.5.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • system/helpers/download_helper.php
    • +
  • system/helpers/form_helper.php
    • +
  • system/libraries/Table.php
    • +
  • system/libraries/User_agent.php
    • +
  • system/libraries/Exceptions.php
    • +
  • system/libraries/Input.php
    • +
  • system/libraries/Router.php
    • +
  • system/libraries/Loader.php
    • +
  • system/libraries/Image_lib.php
    • +
  • system/language/english/unit_test_lang.php
    • +
  • system/database/DB_active_rec.php
    • +
  • system/database/drivers/mysqli/mysqli_driver.php
    • +
  • codeigniter/
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_153.html b/user_guide/installation/upgrade_153.html new file mode 100644 index 000000000..3c15f5ae1 --- /dev/null +++ b/user_guide/installation/upgrade_153.html @@ -0,0 +1,523 @@ + + + + + + + + + + Upgrading from 1.5.2 to 1.5.3 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • system/database/drivers
    • +
  • system/helpers
    • +
  • system/libraries/Input.php
    • +
  • system/libraries/Loader.php
    • +
  • system/libraries/Profiler.php
    • +
  • system/libraries/Table.php
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_154.html b/user_guide/installation/upgrade_154.html new file mode 100644 index 000000000..7e2fc8511 --- /dev/null +++ b/user_guide/installation/upgrade_154.html @@ -0,0 +1,547 @@ + + + + + + + + + + Upgrading from 1.5.3 to 1.5.4 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • application/config/mimes.php
    • +
  • system/codeigniter
    • +
  • system/database
    • +
  • system/helpers
    • +
  • system/libraries
    • +
  • system/plugins
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_160.html b/user_guide/installation/upgrade_160.html new file mode 100644 index 000000000..1d93eedc2 --- /dev/null +++ b/user_guide/installation/upgrade_160.html @@ -0,0 +1,566 @@ + + + + + + + + + + Upgrading from 1.5.4 to 1.6.0 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • system/codeigniter
    • +
  • system/database
    • +
  • system/helpers
    • +
  • system/libraries
    • +
  • system/plugins
    • +
  • system/language
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_161.html b/user_guide/installation/upgrade_161.html new file mode 100644 index 000000000..6dc89de00 --- /dev/null +++ b/user_guide/installation/upgrade_161.html @@ -0,0 +1,522 @@ + + + + + + + + + + Upgrading from 1.6.0 to 1.6.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • system/codeigniter
    • +
  • system/database
    • +
  • system/helpers
    • +
  • system/language
    • +
  • system/libraries
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_162.html b/user_guide/installation/upgrade_162.html new file mode 100644 index 000000000..7e8c242a3 --- /dev/null +++ b/user_guide/installation/upgrade_162.html @@ -0,0 +1,537 @@ + + + + + + + + + + Upgrading from 1.6.1 to 1.6.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • system/codeigniter
    • +
  • system/database
    • +
  • system/helpers
    • +
  • system/language
    • +
  • system/libraries
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_163.html b/user_guide/installation/upgrade_163.html new file mode 100644 index 000000000..5ca9eaf1b --- /dev/null +++ b/user_guide/installation/upgrade_163.html @@ -0,0 +1,522 @@ + + + + + + + + + + Upgrading from 1.6.2 to 1.6.3 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • system/codeigniter
    • +
  • system/database
    • +
  • system/helpers
    • +
  • system/language
    • +
  • system/libraries
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_170.html b/user_guide/installation/upgrade_170.html new file mode 100644 index 000000000..c498459b7 --- /dev/null +++ b/user_guide/installation/upgrade_170.html @@ -0,0 +1,549 @@ + + + + + + + + + + Upgrading from 1.6.3 to 1.7.0 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • system/codeigniter
    • +
  • system/database
    • +
  • system/helpers
    • +
  • system/language
    • +
  • system/libraries
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_171.html b/user_guide/installation/upgrade_171.html new file mode 100644 index 000000000..a9c93f257 --- /dev/null +++ b/user_guide/installation/upgrade_171.html @@ -0,0 +1,522 @@ + + + + + + + + + + Upgrading from 1.7.0 to 1.7.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • system/codeigniter
    • +
  • system/database
    • +
  • system/helpers
    • +
  • system/language
    • +
  • system/libraries
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_172.html b/user_guide/installation/upgrade_172.html new file mode 100644 index 000000000..ca69b6954 --- /dev/null +++ b/user_guide/installation/upgrade_172.html @@ -0,0 +1,539 @@ + + + + + + + + + + Upgrading from 1.7.1 to 1.7.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • system/codeigniter
    • +
  • system/database
    • +
  • system/helpers
    • +
  • system/language
    • +
  • system/libraries
    • +
  • index.php
    • +
+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_200.html b/user_guide/installation/upgrade_200.html new file mode 100644 index 000000000..4667b00db --- /dev/null +++ b/user_guide/installation/upgrade_200.html @@ -0,0 +1,632 @@ + + + + + + + + + + Upgrading from 1.7.2 to 2.0.0 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+

Update Instructions

+
+

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 Encrypt library, does +not store Encrypted data permanently, or is on an environment that does +not support Mcrypt, you may skip this step.

+
+

The Encrypt 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 Encrypt 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: Move any core extensions to application/core

+

Any extensions to core classes (e.g. MY_Controller.php) in your +application/libraries folder must be moved to the new +application/core folder.

+
+
+

Step 9: Update your user guide

+

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

+
+
+
+

Update Notes

+

Please refer to the 2.0.0 Change Log for full +details, but here are some of the larger changes that are more likely to +impact your code:

+
    +
  • Scaffolding has been removed.
    • +
  • The CAPTCHA plugin in now a helper.
    • +
  • The JavaScript calendar plugin was removed.
    • +
  • The system/cache and system/logs directories are now in the application +directory.
    • +
  • The Validation class has been removed. Please see the +Form Validation library
    • +
  • “default” is now a reserved name.
    • +
  • The xss_clean() function has moved to the Security Class.
    • +
  • do_xss_clean() now returns FALSE if the uploaded file fails XSS checks.
    • +
  • The Session Class requires now the use of an +encryption key set in the config file.
    • +
  • The following deprecated Active Record functions have been removed: +orwhere, orlike, groupby, orhaving, orderby, +getwhere.
    • +
  • _drop_database() and _create_database() functions have been removed +from the db utility drivers.
    • +
  • The dohash() function of the Security helper +has been renamed to do_hash() for naming consistency.
    • +
+
+

The config folder

+

The following files have been changed:

+
    +
  • config.php
    • +
  • database.php
    • +
  • mimes.php
    • +
  • routes.php
    • +
  • user_agents.php
    • +
+

The following files have been added:

+
    +
  • foreign_chars.php
    • +
  • profiler.php
    • +
+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_201.html b/user_guide/installation/upgrade_201.html new file mode 100644 index 000000000..396822289 --- /dev/null +++ b/user_guide/installation/upgrade_201.html @@ -0,0 +1,532 @@ + + + + + + + + + + Upgrading from 2.0.0 to 2.0.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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">
+
+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_202.html b/user_guide/installation/upgrade_202.html new file mode 100644 index 000000000..1ea195587 --- /dev/null +++ b/user_guide/installation/upgrade_202.html @@ -0,0 +1,525 @@ + + + + + + + + + + Upgrading from 2.0.1 to 2.0.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_203.html b/user_guide/installation/upgrade_203.html new file mode 100644 index 000000000..a28f16efe --- /dev/null +++ b/user_guide/installation/upgrade_203.html @@ -0,0 +1,555 @@ + + + + + + + + + + Upgrading from 2.0.2 to 2.0.3 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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);
+
+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_210.html b/user_guide/installation/upgrade_210.html new file mode 100644 index 000000000..91f195383 --- /dev/null +++ b/user_guide/installation/upgrade_210.html @@ -0,0 +1,519 @@ + + + + + + + + + + Upgrading from 2.0.3 to 2.1.0 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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.

+
+

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 user agent types, +please copy it to application/config/mimes.php.

+
+
+

Step 3: Update your user guide

+

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

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_211.html b/user_guide/installation/upgrade_211.html new file mode 100644 index 000000000..d982cdc12 --- /dev/null +++ b/user_guide/installation/upgrade_211.html @@ -0,0 +1,523 @@ + + + + + + + + + + Upgrading from 2.1.0 to 2.1.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 2.1.0 to 2.1.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.

+
+

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 user mime-types, please copy +it to _application/config/mimes.php*.

+
+
+

Step 3: Update your IP address tables

+

This upgrade adds support for IPv6 IP addresses. In order to store them, you need +to enlarge your ip_address columns to 45 characters. For example, CodeIgniter’s +session table will need to change

+
ALTER TABLE ci_sessions CHANGE ip_address ip_address varchar(45) default '0' NOT NULL
+
+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_212.html b/user_guide/installation/upgrade_212.html new file mode 100644 index 000000000..c7f6ddd7e --- /dev/null +++ b/user_guide/installation/upgrade_212.html @@ -0,0 +1,514 @@ + + + + + + + + + + Upgrading from 2.1.1 to 2.1.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 2.1.1 to 2.1.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.

+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_213.html b/user_guide/installation/upgrade_213.html new file mode 100644 index 000000000..af3760b60 --- /dev/null +++ b/user_guide/installation/upgrade_213.html @@ -0,0 +1,514 @@ + + + + + + + + + + Upgrading from 2.1.2 to 2.1.3 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 2.1.2 to 2.1.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.

+
+

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.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_214.html b/user_guide/installation/upgrade_214.html new file mode 100644 index 000000000..619200611 --- /dev/null +++ b/user_guide/installation/upgrade_214.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 2.1.3 to 2.1.4 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 2.1.3 to 2.1.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 all files and directories in your “system” folder.

+
+

Note

+

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

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_220.html b/user_guide/installation/upgrade_220.html new file mode 100644 index 000000000..d7b42a6ab --- /dev/null +++ b/user_guide/installation/upgrade_220.html @@ -0,0 +1,518 @@ + + + + + + + + + + Upgrading from 2.1.4 to 2.2.x — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 2.1.4 to 2.2.x

+
+

Note

+

The Encrypt Class now requires the +Mcrypt extension. If you were previously using the Encrypt Class +without Mcrypt, then this is a breaking change. You must install +the Mcrypt extension in order to upgrade. For information on +installing Mcrypt please see the PHP documentation +<http://php.net/manual/en/mcrypt.setup.php>.

+
+

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.

+
+

Note

+

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

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_221.html b/user_guide/installation/upgrade_221.html new file mode 100644 index 000000000..51811087d --- /dev/null +++ b/user_guide/installation/upgrade_221.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 2.2.0 to 2.2.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 2.2.0 to 2.2.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.

+
+

Note

+

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

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_222.html b/user_guide/installation/upgrade_222.html new file mode 100644 index 000000000..5b3dbebb7 --- /dev/null +++ b/user_guide/installation/upgrade_222.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 2.2.1 to 2.2.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 2.2.1 to 2.2.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.

+
+

Note

+

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

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_223.html b/user_guide/installation/upgrade_223.html new file mode 100644 index 000000000..a03872a0b --- /dev/null +++ b/user_guide/installation/upgrade_223.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 2.2.2 to 2.2.3 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 2.2.2 to 2.2.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.

+
+

Note

+

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

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_300.html b/user_guide/installation/upgrade_300.html new file mode 100644 index 000000000..dbd9f3ea0 --- /dev/null +++ b/user_guide/installation/upgrade_300.html @@ -0,0 +1,1330 @@ + + + + + + + + + + Upgrading from 2.2.x to 3.0.x — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 2.2.x to 3.0.x

+

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/ directory 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.

+
+

Important

+

You have to delete the old system/ directory first and +then put the new one in its place. A simple copy-paste may cause +issues.

+
+
+

Note

+

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

+
+
+
+

Step 2: Update your classes file names

+

Starting with CodeIgniter 3.0, all class filenames (libraries, drivers, controllers +and models) must be named in a Ucfirst-like manner or in other words - they must +start with a capital letter.

+

For example, if you have the following library file:

+
+
application/libraries/mylibrary.php
+

… then you’ll have to rename it to:

+
+
application/libraries/Mylibrary.php
+

The same goes for driver libraries and extensions and/or overrides of CodeIgniter’s +own libraries and core classes.

+
+
application/libraries/MY_email.php +application/core/MY_log.php
+

The above files should respectively be renamed to the following:

+
+
application/libraries/MY_Email.php +application/core/MY_Log.php
+

Controllers:

+
+
application/controllers/welcome.php -> application/controllers/Welcome.php
+

Models:

+
+
application/models/misc_model.php -> application/models/Misc_model.php
+

Please note that this DOES NOT affect directories, configuration files, views, +helpers, hooks and anything else - it is only applied to classes.

+

You must now follow just one simple rule - class names in Ucfirst and everything else +in lowercase.

+
+
+

Step 3: Replace config/mimes.php

+

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

+
+
+

Step 4: Remove $autoload[‘core’] from your config/autoload.php

+

Use of the $autoload['core'] config array has been deprecated as of CodeIgniter 1.4.1 and is now removed. +Move any entries that you might have listed there to $autoload['libraries'] instead.

+
+
+

Step 5: Move your Log class overrides or extensions

+

The Log Class is considered as a “core” class and is now located in the +system/core/ directory. Therefore, in order for your Log class overrides +or extensions to work, you need to move them to application/core/:

+
+
application/libraries/Log.php -> application/core/Log.php +application/libraries/MY_Log.php -> application/core/MY_Log.php
+
+
+

Step 6: Update your Session library usage

+

The Session Library has been completely +re-written in CodeIgniter 3 and now comes with a bunch of new features, +but that also means that there are changes that you should make …

+

Most notably, the library now uses separate storage drivers instead of +always relying on (encrypted) cookies. +In fact, cookies as storage have now been removed and you must always use +some kind of server-side storage engine, with the file-system being the +default option.

+

The Session Class now utilizes PHP’s own mechanisms for building custom +session handlers, which also means that your session data is now +accessible via the $_SESSION superglobal (though, we’ve kept the +possibility to use it as “userdata”, like you’ve done until now).

+

A few configuration options have been removed and a few have been added. +You should really read the whole Session library manual for the details, but here’s a short list of changes +that you should make:

+
+
    +

  • Set your $config['sess_driver'] value

    +

    It will default to ‘files’, unless you’ve previously used +$config['sess_use_database'], in which case it will be set to +‘database’.

    +
    • +

  • Set a $config['sess_save_path'] value

    +

    For the ‘database’ driver, a fallback to $config['sess_table_name'] +is in place, but otherwise requires you to read the manual for the +specific driver of your choice.

    +
    • +

  • Update your ci_sessions table (‘database’ driver only)

    +

    The table structure has changed a bit, and more specifically:

    +
    +
      +
    • session_id field is renamed to id
      • +
    • user_agent field is dropped
      • +
    • user_data field is renamed to data and under MySQL is now of type BLOB
      • +
    • last_activity field is renamed to timestamp
      • +
    +
    +

    This is accompanied by a slight change in the table indexes too, so +please read the manual about the Session Database Driver for more information.

    +
    +

    Important

    +

    Only MySQL and PostgreSQL are officially supported +now. Other databases may still work, but due to lack of advisory +locking features, they are unsafe for concurrent requests and +you should consider using another driver instead.

    +
    +
    • +

  • Remove $config['sess_match_useragent']

    +

    The user-agent string is input supplied by the user’s browser, or in +other words: client side input. As such, it is an ineffective feature +and hence why it has been removed.

    +
    • +

  • Remove $config['sess_encrypt_cookie']

    +

    As already noted, the library no longer uses cookies as a storage +mechanism, which renders this option useless.

    +
    • +

  • Remove $config['sess_expire_on_close']

    +

    This option is still usable, but only for backwards compatibility +purposes and it should be otherwise removed. The same effect is +achieved by setting $config['sess_expiration'] to 0.

    +
    • +

  • Check “flashdata” for collisions with “userdata”

    +

    Flashdata is now just regular “userdata”, only marked for deletion on +the next request. In other words: you can’t have both “userdata” and +“flashdata” with the same name, because it’s the same thing.

    +
    • +

  • Check usage of session metadata

    +

    Previously, you could access the ‘session_id’, ‘ip_address’, +‘user_agent’ and ‘last_activity’ metadata items as userdata. +This is no longer possible, and you should read the notes about +Session Metadata +if your application relies on those values.

    +
    • +

  • Check unset_userdata() usage

    +

    Previously, this method used to accept an associative array of +'key' => 'dummy value' pairs for unsetting multiple keys. That +however makes no sense and you now have to pass only the keys, as +the elements of an array.

    +
    // Old
+$this->session->unset_userdata(array('item' => '', 'item2' => ''));
+
+// New
+$this->session->unset_userdata(array('item', 'item2'));
+
    +
    +
    • +
+
+

Finally, if you have written a Session extension, you must now move it to +the application/libraries/Session/ directory, although chances are that +it will now also have to be re-factored.

+
+
+

Step 7: Update your config/database.php

+

Due to 3.0.0’s renaming of Active Record to Query Builder, inside your +config/database.php, you will need to rename the $active_record +variable to $query_builder:

+
$active_group = 'default';
+// $active_record = TRUE;
+$query_builder = TRUE;
+
+
+
+
+

Step 8: Replace your error templates

+

In CodeIgniter 3.0, the error templates are now considered as views and have been moved to the +application/views/errors directory.

+

Furthermore, we’ve added support for CLI error templates in plain-text format that unlike HTML, +is suitable for the command line. This of course requires another level of separation.

+

It is safe to move your old templates from application/errors to application/views/errors/html, +but you’ll have to copy the new application/views/errors/cli directory from the CodeIgniter archive.

+
+
+

Step 9: Update your config/routes.php file

+
+

Routes containing :any

+

Historically, CodeIgniter has always provided the :any wildcard in +routing, with the intention of providing a way to match any character +within an URI segment.

+

However, the :any wildcard is actually just an alias for a regular +expression and used to be executed in that manner as .+. This is +considered a bug, as it also matches the / (forward slash) character, which +is the URI segment delimiter and that was never the intention.

+

In CodeIgniter 3, the :any wildcard will now represent [^/]+, so +that it will not match a forward slash.

+

There are certainly many developers that have utilized this bug as an actual +feature. If you’re one of them and want to match a forward slash, please use +the .+ regular expression:

+
(.+)    // matches ANYTHING
+(:any)  // matches any character, except for '/'
+
+
+
+
+

Directories and ‘default_controller’, ‘404_override’

+

As you should know, the $route['default_controller'] and +$route['404_override'] settings accept not only a controller name, but +also controller/method pairs. However, a bug in the routing logic has +made it possible for some users to use that as directory/controller +instead.

+

As already said, this behavior was incidental and was never intended, nor +documented. If you’ve relied on it, your application will break with +CodeIgniter 3.0.

+

Another notable change in version 3 is that ‘default_controller’ and +‘404_override’ are now applied per directory. To explain what this means, +let’s take the following example:

+
$route['default_controller'] = 'main';
+
+
+

Now, assuming that your website is located at example.com, you already +know that if a user visits http://example.com/, the above setting will +cause your ‘Main’ controller to be loaded.

+

However, what happens if you have an application/controllers/admin/ +directory and the user visits http://example.com/admin/? +In CodeIgniter 3, the router will look for a ‘Main’ controller under the +admin/ directory as well. If not found, a Not Found (404) will be triggered.

+

The same rule applies to the ‘404_override’ setting.

+
+
+
+

Step 10: Many functions now return NULL instead of FALSE on missing items

+

Many methods and functions now return NULL instead of FALSE when the required items don’t exist:

+
+
    +
  • Common functions
      +
    • config_item()
      • +
    +
    • +
  • Config Class
      +
    • config->item()
      • +
    • config->slash_item()
      • +
    +
    • +
  • Input Class
      +
    • input->get()
      • +
    • input->post()
      • +
    • input->get_post()
      • +
    • input->cookie()
      • +
    • input->server()
      • +
    • input->input_stream()
      • +
    • input->get_request_header()
      • +
    +
    • +
  • Session Class
      +
    • session->userdata()
      • +
    • session->flashdata()
      • +
    +
    • +
  • URI Class
      +
    • uri->segment()
      • +
    • uri->rsegment()
      • +
    +
    • +
  • Array Helper
      +
    • element()
      • +
    • elements()
      • +
    +
    • +
+
+
+
+

Step 11: Usage of XSS filtering

+

Many functions in CodeIgniter allow you to use its XSS filtering feature +on demand by passing a boolean parameter. The default value of that +parameter used to be boolean FALSE, but it is now changed to NULL and it +will be dynamically determined by your $config['global_xss_filtering'] +value.

+

If you used to manually pass a boolean value for the $xss_filter +parameter or if you’ve always had $config['global_xss_filtering'] set +to FALSE, then this change doesn’t concern you.

+

Otherwise however, please review your usage of the following functions:

+
+
+
+
+

Important

+

Another related change is that the $_GET, $_POST, +$_COOKIE and $_SERVER superglobals are no longer +automatically overwritten when global XSS filtering is turned on.

+
+
+
+

Step 12: Check for potential XSS issues with URIs

+

The URI Library used to automatically convert +a certain set of “programmatic characters” to HTML entities when they +are encountered in a URI segment.

+

This was aimed at providing some automatic XSS protection, in addition +to the $config['permitted_uri_chars'] setting, but has proven to be +problematic and is now removed in CodeIgniter 3.0.

+

If your application has relied on this feature, you should update it to +filter URI segments through $this->security->xss_clean() whenever you +output them.

+
+
+

Step 13: Check for usage of the ‘xss_clean’ Form validation rule

+

A largely unknown rule about XSS cleaning is that it should only be +applied to output, as opposed to input data.

+

We’ve made that mistake ourselves with our automatic and global XSS cleaning +feature (see previous step about XSS above), so now in an effort to discourage that +practice, we’re also removing ‘xss_clean’ from the officially supported +list of form validation rules.

+

Because the Form Validation library +generally validates input data, the ‘xss_clean’ rule simply doesn’t +belong in it.

+

If you really, really need to apply that rule, you should now also load the +Security Helper, which contains +xss_clean() as a regular function and therefore can be also used as +a validation rule.

+
+
+

Step 14: Update usage of Input Class’s get_post() method

+

Previously, the Input Class method get_post() +was searching first in POST data, then in GET data. This method has been +modified so that it searches in GET then in POST, as its name suggests.

+

A method has been added, post_get(), which searches in POST then in GET, as +get_post() was doing before.

+
+
+

Step 15: Update usage of Directory Helper’s directory_map() function

+

In the resulting array, directories now end with a trailing directory +separator (i.e. a slash, usually).

+
+
+

Step 16: Update usage of Database Forge’s drop_table() method

+

Up until now, drop_table() added an IF EXISTS clause by default or it didn’t work +at all with some drivers. In CodeIgniter 3.0, the IF EXISTS condition is no longer added +by default and has an optional second parameter that allows that instead and is set to +FALSE by default.

+

If your application relies on IF EXISTS, you’ll have to change its usage.

+
// Now produces just DROP TABLE `table_name`
+$this->dbforge->drop_table('table_name');
+
+// Produces DROP TABLE IF EXISTS `table_name`
+$this->dbforge->drop_table('table_name', TRUE);
+
+
+
+

Note

+

The given example uses MySQL-specific syntax, but it should work across +all drivers with the exception of ODBC.

+
+
+
+

Step 17: Change usage of Email library with multiple emails

+

The Email Library will automatically clear the +set parameters after successfully sending emails. To override this behaviour, +pass FALSE as the first parameter in the send() method:

+
if ($this->email->send(FALSE))
+{
+        // Parameters won't be cleared
+}
+
+
+
+
+

Step 18: Update your Form_validation language lines

+

Two improvements have been made to the Form Validation Library’s language +files and error messages format:

+
+
    +

  • Language Library line keys now must be +prefixed with form_validation_ in order to avoid collisions:

    +
    // Old
+$lang['rule'] = ...
+
+// New
+$lang['form_validation_rule'] = ...
+
    +
    +
    • +

  • The error messages format has been changed to use named parameters, to +allow more flexibility than what sprintf() offers:

    +
    // Old
+'The %s field does not match the %s field.'
+
+// New
+'The {field} field does not match the {param} field.'
+
    +
    +
    • +
+
+
+

Note

+

The old formatting still works, but the non-prefixed line keys +are DEPRECATED and scheduled for removal in CodeIgniter 3.1+. +Therefore you’re encouraged to update its usage sooner rather than +later.

+
+
+
+

Step 19: Make sure your ‘base_url’ config value is not empty

+

When $config['base_url'] is not set, CodeIgniter tries to automatically +detect what your website’s base URL is. This is done purely for convenience +when you are starting development of a new application.

+

Auto-detection is never reliable and also has security implications, which +is why you should always have it manually configured!

+

One of the changes in CodeIgniter 3.0.3 is how this auto-detection works, +and more specifically it now falls back to the server’s IP address instead +of the hostname requested by the client. Therefore, if you’ve ever relied +on auto-detection, it will change how your website works now.

+

In case you need to allow e.g. multiple domains, or both http:// and +https:// prefixes to be dynamically used depending on the request, +remember that application/config/config.php is still a PHP script, in +which you can create this logic with a few lines of code. For example:

+
$allowed_domains = array('domain1.tld', 'domain2.tld');
+$default_domain  = 'domain1.tld';
+
+if (in_array($_SERVER['HTTP_HOST'], $allowed_domains, TRUE))
+{
+        $domain = $_SERVER['HTTP_HOST'];
+}
+else
+{
+        $domain = $default_domain;
+}
+
+if ( ! empty($_SERVER['HTTPS']))
+{
+        $config['base_url'] = 'https://'.$domain;
+}
+else
+{
+        $config['base_url'] = 'http://'.$domain;
+}
+
+
+
+
+

Step 20: Remove usage of (previously) deprecated functionalities

+

In addition to the $autoload['core'] configuration setting, there’s a +number of other functionalities that have been removed in CodeIgniter 3.0.0:

+
+

The SHA1 library

+

The previously deprecated SHA1 library has been removed, alter your code to use PHP’s native +sha1() function to generate a SHA1 hash.

+

Additionally, the sha1() method in the Encrypt Library has been removed.

+
+
+

The EXT constant

+

Usage of the EXT constant has been deprecated since dropping support for PHP 4. There’s no +longer a need to maintain different filename extensions and in this new CodeIgniter version, +the EXT constant has been removed. Use just ‘.php’ instead.

+
+
+

Smiley helper

+

The Smiley Helper is a legacy feature from EllisLab’s +ExpressionEngine product. However, it is too specific for a general purpose framework like +CodeIgniter and as such it is now deprecated.

+

Also, the previously deprecated js_insert_smiley() (since version 1.7.2) is now removed.

+
+
+

The Encrypt library

+

Following numerous vulnerability reports, the Encrypt Library has +been deprecated and a new, Encryption Library is added to take +its place.

+

The new library requires either the MCrypt extension (and /dev/urandom +availability) or PHP 5.3.3 and the OpenSSL extension. +While this might be rather inconvenient, it is a requirement that allows us to have properly +implemented cryptographic functions.

+
+

Note

+

The Encrypt Library is still available for the purpose +of keeping backwards compatibility.

+
+
+

Important

+

You are strongly encouraged to switch to the new Encryption Library as soon as possible!

+
+
+
+

The Cart library

+

The Cart Library, similarly to the Smiley Helper is too specific for CodeIgniter. It is now deprecated +and scheduled for removal in CodeIgniter 3.1+.

+
+

Note

+

The library is still available, but you’re strongly encouraged to remove its usage sooner +rather than later.

+
+
+
+

Database drivers ‘mysql’, ‘sqlite’, ‘mssql’, ‘pdo/dblib’

+

The mysql driver utilizes the old ‘mysql’ PHP extension, known for its aging code base and +many low-level problems. The extension is deprecated as of PHP 5.5 and CodeIgniter deprecates +it in version 3.0, switching the default configured MySQL driver to mysqli.

+

Please use either the ‘mysqli’ or ‘pdo/mysql’ drivers for MySQL. The old ‘mysql’ driver will be +removed at some point in the future.

+

The sqlite, mssql and pdo/dblib (also known as pdo/mssql or pdo/sybase) drivers +all depend on PHP extensions that for different reasons no longer exist since PHP 5.3.

+

Therefore we are now deprecating these drivers as we will have to remove them in one of the next +CodeIgniter versions. You should use the more advanced, sqlite3, sqlsrv or pdo/sqlsrv +drivers respectively.

+
+

Note

+

These drivers are still available, but you’re strongly encouraged to switch to other ones +sooner rather than later.

+
+
+
+

Security helper do_hash()

+

Security Helper function do_hash() is now just an alias for +PHP’s native hash() function. It is deprecated and scheduled for removal in CodeIgniter 3.1+.

+
+

Note

+

This function is still available, but you’re strongly encouraged to remove its usage sooner +rather than later.

+
+
+
+

The $config[‘global_xss_filtering’] setting

+

As already explained above, XSS filtering should not be done on input data, +but on output instead. Therefore, the $config['global_xss_filtering'], +which automatically filters input data, is considered a bad practice and +is now deprecated.

+

Instead, you should manually escape any user-provided data via the +xss_clean() function when you need to output it, or use a +library like HTML Purifier that does that +for you.

+
+

Note

+

The setting is still available, but you’re strongly encouraged to +remove its usage sooner rather than later.

+
+
+
+

File helper read_file()

+

File Helper function read_file() is now just an alias for +PHP’s native file_get_contents() function. It is deprecated and scheduled for removal in +CodeIgniter 3.1+.

+
+

Note

+

This function is still available, but you’re strongly encouraged to remove its usage sooner +rather than later.

+
+
+
+

String helper repeater()

+

String Helper function repeater() is now just an alias for +PHP’s native str_repeat() function. It is deprecated and scheduled for removal in CodeIgniter 3.1+.

+
+

Note

+

This function is still available, but you’re strongly encouraged to remove its usage sooner +rather than later.

+
+
+
+

String helper trim_slashes()

+

String Helper function trim_slashes() is now just an alias +for PHP’s native trim() function (with a slash passed as its second argument). It is deprecated and +scheduled for removal in CodeIgniter 3.1+.

+
+

Note

+

This function is still available, but you’re strongly encouraged to remove its usage sooner +rather than later.

+
+
+
+

Form helper form_prep()

+

Form Helper function form_prep() +is now just an alias for common function +html_escape(). It is deprecated and will be removed in the future.

+

Please use html_escape() instead.

+
+

Note

+

This function is still available, but you’re strongly encouraged +to remove its usage sooner rather than later.

+
+
+
+

Email helper functions

+

Email Helper only has two functions

+
+
+

Both of them are now aliases for PHP’s native filter_var() and mail() functions, respectively. +Therefore the Email Helper altogether is being deprecated and +is scheduled for removal in CodeIgniter 3.1+.

+
+

Note

+

These functions are still available, but you’re strongly encouraged to remove their usage +sooner rather than later.

+
+
+
+

Date helper standard_date()

+

Date Helper function standard_date() is being deprecated due +to the availability of native PHP constants, +which when combined with date() provide the same functionality. Furthermore, they have the +exact same names as the ones supported by standard_date(). Here are examples of how to replace +its usage:

+
// Old way
+standard_date(); // defaults to standard_date('DATE_RFC822', now());
+
+// Replacement
+date(DATE_RFC822, now());
+
+// Old way
+standard_date('DATE_ATOM', $time);
+
+// Replacement
+date(DATE_ATOM, $time);
+
+
+
+

Note

+

This function is still available, but you’re strongly encouraged to remove its usage sooner +rather than later as it is scheduled for removal in CodeIgniter 3.1+.

+
+
+
+

HTML helpers nbs(), br()

+

HTML Helper functions nbs() and br() are just aliases +for the native str_repeat() function used with &nbsp; and <br > respectively.

+

Because there’s no point in just aliasing native PHP functions, they are now deprecated and +scheduled for removal in CodeIgniter 3.1+.

+
+

Note

+

These functions are still available, but you’re strongly encouraged to remove their usage +sooner rather than later.

+
+
+
+

Pagination library ‘anchor_class’ setting

+

The Pagination Library now supports adding pretty much any HTML +attribute to your anchors via the ‘attributes’ configuration setting. This includes passing the +‘class’ attribute and using the separate ‘anchor_class’ setting no longer makes sense. +As a result of that, the ‘anchor_class’ setting is now deprecated and scheduled for removal in +CodeIgniter 3.1+.

+
+

Note

+

This setting is still available, but you’re strongly encouraged to remove its usage sooner +rather than later.

+
+
+
+

String helper random_string() types ‘unique’ and ‘encrypt’

+

When using the String Helper function random_string(), +you should no longer pass the unique and encrypt randomization types. They are only +aliases for md5 and sha1 respectively and are now deprecated and scheduled for removal +in CodeIgniter 3.1+.

+
+

Note

+

These options are still available, but you’re strongly encouraged to remove their usage +sooner rather than later.

+
+
+
+

URL helper url_title() separators ‘dash’ and ‘underscore’

+

When using the URL Helper function url_title(), you +should no longer pass dash or underscore as the word separator. This function will +now accept any character and you should just pass the chosen character directly, so you +should write ‘-‘ instead of ‘dash’ and ‘_’ instead of ‘underscore’.

+

dash and underscore now act as aliases and are deprecated and scheduled for removal +in CodeIgniter 3.1+.

+
+

Note

+

These options are still available, but you’re strongly encouraged to remove their usage +sooner rather than later.

+
+
+
+

Session Library method all_userdata()

+

As seen in the Change Log, Session Library +method userdata() now allows you to fetch all userdata by simply omitting its parameter:

+
$this->session->userdata();
+
+
+

This makes the all_userdata() method redudant and therefore it is now just an alias for +userdata() with the above shown usage and is being deprecated and scheduled for removal +in CodeIgniter 3.1+.

+
+

Note

+

This method is still available, but you’re strongly encouraged to remove its usage +sooner rather than later.

+
+
+
+

Database Forge method add_column() with an AFTER clause

+

If you have used the third parameter for Database Forge method +add_column() to add a field for an AFTER clause, then you should change its usage.

+

That third parameter has been deprecated and scheduled for removal in CodeIgniter 3.1+.

+

You should now put AFTER clause field names in the field definition array instead:

+
// Old usage:
+$field = array(
+        'new_field' => array('type' => 'TEXT')
+);
+
+$this->dbforge->add_column('table_name', $field, 'another_field');
+
+// New usage:
+$field = array(
+        'new_field' => array('type' => 'TEXT', 'after' => 'another_field')
+);
+
+$this->dbforge->add_column('table_name', $field);
+
+
+
+

Note

+

The parameter is still available, but you’re strongly encouraged to remove its usage +sooner rather than later.

+
+
+

Note

+

This is for MySQL and CUBRID databases only! Other drivers don’t support this +clause and will silently ignore it.

+
+
+
+

URI Routing methods fetch_directory(), fetch_class(), fetch_method()

+

With properties CI_Router::$directory, CI_Router::$class and CI_Router::$method +being public and their respective fetch_*() no longer doing anything else to just return +the properties - it doesn’t make sense to keep them.

+

Those are all internal, undocumented methods, but we’ve opted to deprecate them for now +in order to maintain backwards-compatibility just in case. If some of you have utilized them, +then you can now just access the properties instead:

+
$this->router->directory;
+$this->router->class;
+$this->router->method;
+
+
+
+

Note

+

Those methods are still available, but you’re strongly encouraged to remove their usage +sooner rather than later.

+
+
+
+

Input library method is_cli_request()

+

Calls to the CI_Input::is_cli_request() method are necessary at many places +in the CodeIgniter internals and this is often before the Input Library is loaded. Because of that, it is being replaced by a common +function named is_cli() and this method is now just an alias.

+

The new function is both available at all times for you to use and shorter to type.

+
// Old
+$this->input->is_cli_request();
+
+// New
+is_cli();
+
+
+

CI_Input::is_cli_request() is now now deprecated and scheduled for removal in +CodeIgniter 3.1+.

+
+

Note

+

This method is still available, but you’re strongly encouraged to remove its usage +sooner rather than later.

+
+
+
+

Config library method system_url()

+

Usage of CI_Config::system_url() encourages insecure coding practices. +Namely, your CodeIgniter system/ directory shouldn’t be publicly accessible +from a security point of view.

+

Because of this, this method is now deprecated and scheduled for removal in +CodeIgniter 3.1+.

+
+

Note

+

This method is still available, but you’re strongly encouraged to remove its usage +sooner rather than later.

+
+
+
+

The Javascript library

+

The Javascript Library has always had an +‘experimental’ status and was never really useful, nor a proper solution.

+

It is now deprecated and scheduled for removal in CodeIgniter 3.1+.

+
+

Note

+

This library is still available, but you’re strongly encouraged to remove its usage +sooner rather than later.

+
+
+
+

Form Validation method prep_for_form()

+

The Form Validation Library has a +prep_for_form() method, which is/can also be used as a rule in +set_rules() to automatically perform HTML encoding on input data.

+

Automatically encoding input (instead of output) data is a bad practice in +the first place, and CodeIgniter and PHP itself offer other alternatives +to this method anyway. +For example, Form Helper functions will +automatically perform HTML escaping when necessary.

+

Therefore, the prep_for_form method/rule is pretty much useless and is now +deprecated and scheduled for removal in 3.1+.

+
+

Note

+

The method is still available, but you’re strongly encouraged to +remove its usage sooner rather than later.

+
+
+
+
+

Step 21: Check your usage of Text helper highlight_phrase()

+

The default HTML tag used by Text Helper function +highlight_phrase() has been changed from <strong> to the new HTML5 +tag <mark>.

+

Unless you’ve used your own highlighting tags, this might cause trouble +for your visitors who use older web browsers such as Internet Explorer 8. +We therefore suggest that you add the following code to your CSS files +in order to avoid backwards compatibility with old browsers:

+
mark {
+        background: #ff0;
+        color: #000;
+};
+
+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_301.html b/user_guide/installation/upgrade_301.html new file mode 100644 index 000000000..a726e9cbf --- /dev/null +++ b/user_guide/installation/upgrade_301.html @@ -0,0 +1,513 @@ + + + + + + + + + + Upgrading from 3.0.0 to 3.0.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.0.0 to 3.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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Update your CLI error templates

+

Replace all files under your application/views/errors/cli/ directory.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_302.html b/user_guide/installation/upgrade_302.html new file mode 100644 index 000000000..7581bdf01 --- /dev/null +++ b/user_guide/installation/upgrade_302.html @@ -0,0 +1,520 @@ + + + + + + + + + + Upgrading from 3.0.1 to 3.0.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.0.1 to 3.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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Update your application/config/constants.php file

+

The application/config/constants.php file has been updated to check +if constants aren’t already defined before doing that, making it easier +to add an environment-specific configuration.

+
+

Note

+

If you’ve made modifications to this file, please make a +backup first and cross-check the differences first.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_303.html b/user_guide/installation/upgrade_303.html new file mode 100644 index 000000000..ddcf90c56 --- /dev/null +++ b/user_guide/installation/upgrade_303.html @@ -0,0 +1,547 @@ + + + + + + + + + + Upgrading from 3.0.2 to 3.0.3 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.0.2 to 3.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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Make sure your ‘base_url’ config value is not empty

+

When $config['base_url'] is not set, CodeIgniter tries to automatically +detect what your website’s base URL is. This is done purely for convenience +when you are starting development of a new application.

+

Auto-detection is never reliable and also has security implications, which +is why you should always have it manually configured!

+

One of the changes in CodeIgniter 3.0.3 is how this auto-detection works, +and more specifically it now falls back to the server’s IP address instead +of the hostname requested by the client. Therefore, if you’ve ever relied +on auto-detection, it will change how your website works now.

+

In case you need to allow e.g. multiple domains, or both http:// and +https:// prefixes to be dynamically used depending on the request, +remember that application/config/config.php is still a PHP script, in +which you can create this logic with a few lines of code. For example:

+
$allowed_domains = array('domain1.tld', 'domain2.tld');
+$default_domain  = 'domain1.tld';
+
+if (in_array($_SERVER['HTTP_HOST'], $allowed_domains, TRUE))
+{
+        $domain = $_SERVER['HTTP_HOST'];
+}
+else
+{
+        $domain = $default_domain;
+}
+
+if ( ! empty($_SERVER['HTTPS']))
+{
+        $config['base_url'] = 'https://'.$domain;
+}
+else
+{
+        $config['base_url'] = 'http://'.$domain;
+}
+
+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_304.html b/user_guide/installation/upgrade_304.html new file mode 100644 index 000000000..71e041533 --- /dev/null +++ b/user_guide/installation/upgrade_304.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 3.0.3 to 3.0.4 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.0.3 to 3.0.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 all files and directories in your system/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_305.html b/user_guide/installation/upgrade_305.html new file mode 100644 index 000000000..e558feb76 --- /dev/null +++ b/user_guide/installation/upgrade_305.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 3.0.4 to 3.0.5 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.0.4 to 3.0.5

+

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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_306.html b/user_guide/installation/upgrade_306.html new file mode 100644 index 000000000..cef2be6b9 --- /dev/null +++ b/user_guide/installation/upgrade_306.html @@ -0,0 +1,539 @@ + + + + + + + + + + Upgrading from 3.0.5 to 3.0.6 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.0.5 to 3.0.6

+

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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Update your index.php file (optional)

+

We’ve made some tweaks to the index.php file, mostly related to proper +usage of directory separators (i.e. use the DIRECTORY_SEPARATOR +constant instead of a hard coded forward slash “/”).

+

Nothing will break if you skip this step, but if you’re running Windows +or just want to be up to date with every change - we do recommend that +you update your index.php file.

+

Tip: Just copy the ``ENVIRONMENT``, ``$system_path``, ``$application_folder`` +and ``$view_folder`` declarations from the old file and put them into the +new one, replacing the defaults.

+
+
+

Step 3: Remove ‘prep_for_form’ usage (deprecation)

+

The Form Validation Library has a +prep_for_form() method, which is/can also be used as a rule in +set_rules() to automatically perform HTML encoding on input data.

+

Automatically encoding input (instead of output) data is a bad practice in +the first place, and CodeIgniter and PHP itself offer other alternatives +to this method anyway. +For example, Form Helper functions will +automatically perform HTML escaping when necessary.

+

Therefore, the prep_for_form method/rule is pretty much useless and is now +deprecated and scheduled for removal in 3.1+.

+
+

Note

+

The method is still available, but you’re strongly encouraged to +remove its usage sooner rather than later.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_310.html b/user_guide/installation/upgrade_310.html new file mode 100644 index 000000000..052e54c9d --- /dev/null +++ b/user_guide/installation/upgrade_310.html @@ -0,0 +1,527 @@ + + + + + + + + + + Upgrading from 3.0.6 to 3.1.0 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.0.6 to 3.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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Check your PHP version

+

We recommend always running versions that are currently supported, which right now is at least PHP 5.6.

+

PHP 5.2.x versions are now officially not supported by CodeIgniter, and while 5.3.7+ +may be at least runnable, we strongly discourage you from using any PHP versions below +the ones listed on the PHP.net Supported Versions +page.

+
+
+

Step 3: If you’re using the ‘odbc’ database driver, check for usage of Query Builder

+

Query Builder functionality and escape() can +no longer be used with the ‘odbc’ database driver.

+

This is because, due to its nature, the ODBC extension for PHP +does not provide a function that allows to safely escape user-supplied strings for usage +inside an SQL query (which our Query Builder relies on).

+

Thus, user inputs MUST be bound, as shown in Running Queries, +under the “Query Bindings” section.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_311.html b/user_guide/installation/upgrade_311.html new file mode 100644 index 000000000..4f27282aa --- /dev/null +++ b/user_guide/installation/upgrade_311.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 3.1.0 to 3.1.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.0 to 3.1.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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_3110.html b/user_guide/installation/upgrade_3110.html new file mode 100644 index 000000000..a14210a3b --- /dev/null +++ b/user_guide/installation/upgrade_3110.html @@ -0,0 +1,517 @@ + + + + + + + + + + Upgrading from 3.1.9 to 3.1.10 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.9 to 3.1.10

+

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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Check for calls to is_countable()

+

PHP 7.3 introduces a native is_countable() +function, which creates a name collision with the is_countable() function +we’ve had in our Inflector Helpers.

+

If you’ve been using the helper function in question, you should now rename +the calls to it to word_is_countable().

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_3111.html b/user_guide/installation/upgrade_3111.html new file mode 100644 index 000000000..485c507b3 --- /dev/null +++ b/user_guide/installation/upgrade_3111.html @@ -0,0 +1,514 @@ + + + + + + + + + + Upgrading from 3.1.10 to 3.1.11 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.10 to 3.1.11

+

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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Replace config/mimes.php

+

This config file has received some updates. Please copy it to +application/config/mimes.php.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_312.html b/user_guide/installation/upgrade_312.html new file mode 100644 index 000000000..ab4814b8c --- /dev/null +++ b/user_guide/installation/upgrade_312.html @@ -0,0 +1,534 @@ + + + + + + + + + + Upgrading from 3.1.1 to 3.1.2 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.1 to 3.1.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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Update your “ci_sessions” database table

+

If you’re using the Session Library with the +‘database’ driver, you may have to ALTER your sessions table for your +sessions to continue to work.

+
+

Note

+

The table in question is not necessarily named “ci_sessions”. +It is what you’ve set as your $config['sess_save_path'].

+
+

This will only affect you if you’ve changed your session.hash_function +php.ini setting to something like ‘sha512’. Or if you’ve been running +an older CodeIgniter version on PHP 7.1+.

+

It is recommended that you do this anyway, just to avoid potential issues +in the future if you do change your configuration.

+

Just execute the one of the following SQL queries, depending on your +database:

+
// MySQL:
+ALTER TABLE ci_sessions CHANGE id id varchar(128) NOT NULL;
+
+// PostgreSQL
+ALTER TABLE ci_sessions ALTER COLUMN id SET DATA TYPE varchar(128);
+
+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_313.html b/user_guide/installation/upgrade_313.html new file mode 100644 index 000000000..074b38d88 --- /dev/null +++ b/user_guide/installation/upgrade_313.html @@ -0,0 +1,539 @@ + + + + + + + + + + Upgrading from 3.1.2 to 3.1.3 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.2 to 3.1.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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Remove usage of nice_date() helper (deprecation)

+

The Date Helper function nice_date() is +no longer useful since the introduction of PHP’s DateTime classes

+

You can replace it with the following:

+
DateTime::createFromFormat($input_format, $input_date)->format($desired_output_format);
+
+
+

Thus, nice_date() is now deprecated and scheduled for removal in +CodeIgniter 3.2+.

+
+

Note

+

The function is still available, but you’re strongly encouraged +to remove its usage sooner rather than later.

+
+
+
+

Step 3: Remove usage of $config[‘standardize_newlines’]

+

The Input Library would optionally replace +occurrences of rn, r, n in input data with whatever the PHP_EOL +value is on your system - if you’ve set $config['standardize_newlines'] +to TRUE in your application/config/config.php.

+

This functionality is now deprecated and scheduled for removal in +CodeIgniter 3.2.+.

+
+

Note

+

The functionality is still available, but you’re strongly +encouraged to remove its usage sooner rather than later.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_314.html b/user_guide/installation/upgrade_314.html new file mode 100644 index 000000000..b260c04fa --- /dev/null +++ b/user_guide/installation/upgrade_314.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 3.1.3 to 3.1.4 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.3 to 3.1.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 all files and directories in your system/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_315.html b/user_guide/installation/upgrade_315.html new file mode 100644 index 000000000..ce26be90a --- /dev/null +++ b/user_guide/installation/upgrade_315.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 3.1.4 to 3.1.5 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.4 to 3.1.5

+

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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_316.html b/user_guide/installation/upgrade_316.html new file mode 100644 index 000000000..28f7e556f --- /dev/null +++ b/user_guide/installation/upgrade_316.html @@ -0,0 +1,523 @@ + + + + + + + + + + Upgrading from 3.1.5 to 3.1.6 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.5 to 3.1.6

+

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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Remove usage of the APC Cache driver (deprecation)

+

The Cache Library APC driver is now +deprecated, as the APC extension is effectively dead, as explained in its +PHP Manual page.

+

If your application happens to be using it, you can switch to another +cache driver, as APC support will be removed in a future CodeIgniter +version.

+
+

Note

+

The driver is still available, but you’re strongly encouraged +to remove its usage sooner rather than later.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_317.html b/user_guide/installation/upgrade_317.html new file mode 100644 index 000000000..954326b0c --- /dev/null +++ b/user_guide/installation/upgrade_317.html @@ -0,0 +1,522 @@ + + + + + + + + + + Upgrading from 3.1.6 to 3.1.7 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.6 to 3.1.7

+

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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Remove usage of CAPTCHA helper extra parameters (deprecation)

+

The CAPTCHA Helper function +create_captcha() allows passing of its img_path, img_url +and font_path options as the 2nd, 3rd and 4th parameters respectively.

+

This kind of usage is now deprecated and you should just pass the options +in question as part of the first parameter array.

+
+

Note

+

The functionality in question is still available, but you’re +strongly encouraged to remove its usage sooner rather than later.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_318.html b/user_guide/installation/upgrade_318.html new file mode 100644 index 000000000..cd78286a6 --- /dev/null +++ b/user_guide/installation/upgrade_318.html @@ -0,0 +1,509 @@ + + + + + + + + + + Upgrading from 3.1.7 to 3.1.8 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.7 to 3.1.8

+

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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_319.html b/user_guide/installation/upgrade_319.html new file mode 100644 index 000000000..869e6a180 --- /dev/null +++ b/user_guide/installation/upgrade_319.html @@ -0,0 +1,514 @@ + + + + + + + + + + Upgrading from 3.1.8 to 3.1.9 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading from 3.1.8 to 3.1.9

+

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/ directory.

+
+

Note

+

If you have any custom developed files in these directories, +please make copies of them first.

+
+
+
+

Step 2: Replace config/mimes.php

+

This config file has received some updates. Please copy it to +application/config/mimes.php.

+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrade_b11.html b/user_guide/installation/upgrade_b11.html new file mode 100644 index 000000000..50e9c5834 --- /dev/null +++ b/user_guide/installation/upgrade_b11.html @@ -0,0 +1,567 @@ + + + + + + + + + + Upgrading From Beta 1.0 to Beta 1.1 — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

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:

+
    +
  • drivers
    • +
  • helpers
    • +
  • init
    • +
  • libraries
    • +
  • scaffolding
    • +
+
+
+

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";
+
+
+
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/user_guide/installation/upgrading.html b/user_guide/installation/upgrading.html new file mode 100644 index 000000000..fdd4fc9bb --- /dev/null +++ b/user_guide/installation/upgrading.html @@ -0,0 +1,553 @@ + + + + + + + + + + Upgrading From a Previous Version — CodeIgniter 3.1.11 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Upgrading From a Previous Version

+

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

+
+ +
+
+ + +
+
+ + + + +
+ +
+

+ © Copyright 2014 - 2019, British Columbia Institute of Technology. + Last updated on Sep 19, 2019. +

+
+ + Built with Sphinx using a theme provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file -- cgit v1.2.3-24-g4f1b