From 8ede1a2ecbb62577afd32996956c5feaf7ddf9b6 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 13:34:52 -0500 Subject: replacing the old HTML user guide with a Sphinx-managed user guide --- user_guide_src/source/installation/downloads.rst | 69 ++++++++++++ user_guide_src/source/installation/index.rst | 54 +++++++++ .../source/installation/troubleshooting.rst | 19 ++++ user_guide_src/source/installation/upgrade_120.rst | 20 ++++ user_guide_src/source/installation/upgrade_130.rst | 125 +++++++++++++++++++++ user_guide_src/source/installation/upgrade_131.rst | 30 +++++ user_guide_src/source/installation/upgrade_132.rst | 28 +++++ user_guide_src/source/installation/upgrade_133.rst | 44 ++++++++ user_guide_src/source/installation/upgrade_140.rst | 72 ++++++++++++ user_guide_src/source/installation/upgrade_141.rst | 71 ++++++++++++ user_guide_src/source/installation/upgrade_150.rst | 100 +++++++++++++++++ user_guide_src/source/installation/upgrade_152.rst | 39 +++++++ user_guide_src/source/installation/upgrade_153.rst | 28 +++++ user_guide_src/source/installation/upgrade_154.rst | 47 ++++++++ user_guide_src/source/installation/upgrade_160.rst | 76 +++++++++++++ user_guide_src/source/installation/upgrade_161.rst | 27 +++++ user_guide_src/source/installation/upgrade_162.rst | 45 ++++++++ user_guide_src/source/installation/upgrade_163.rst | 27 +++++ user_guide_src/source/installation/upgrade_170.rst | 56 +++++++++ user_guide_src/source/installation/upgrade_171.rst | 27 +++++ user_guide_src/source/installation/upgrade_172.rst | 48 ++++++++ user_guide_src/source/installation/upgrade_200.rst | 90 +++++++++++++++ user_guide_src/source/installation/upgrade_201.rst | 38 +++++++ user_guide_src/source/installation/upgrade_202.rst | 33 ++++++ user_guide_src/source/installation/upgrade_203.rst | 62 ++++++++++ user_guide_src/source/installation/upgrade_210.rst | 22 ++++ user_guide_src/source/installation/upgrade_b11.rst | 57 ++++++++++ user_guide_src/source/installation/upgrading.rst | 32 ++++++ 28 files changed, 1386 insertions(+) create mode 100644 user_guide_src/source/installation/downloads.rst create mode 100644 user_guide_src/source/installation/index.rst create mode 100644 user_guide_src/source/installation/troubleshooting.rst create mode 100644 user_guide_src/source/installation/upgrade_120.rst create mode 100644 user_guide_src/source/installation/upgrade_130.rst create mode 100644 user_guide_src/source/installation/upgrade_131.rst create mode 100644 user_guide_src/source/installation/upgrade_132.rst create mode 100644 user_guide_src/source/installation/upgrade_133.rst create mode 100644 user_guide_src/source/installation/upgrade_140.rst create mode 100644 user_guide_src/source/installation/upgrade_141.rst create mode 100644 user_guide_src/source/installation/upgrade_150.rst create mode 100644 user_guide_src/source/installation/upgrade_152.rst create mode 100644 user_guide_src/source/installation/upgrade_153.rst create mode 100644 user_guide_src/source/installation/upgrade_154.rst create mode 100644 user_guide_src/source/installation/upgrade_160.rst create mode 100644 user_guide_src/source/installation/upgrade_161.rst create mode 100644 user_guide_src/source/installation/upgrade_162.rst create mode 100644 user_guide_src/source/installation/upgrade_163.rst create mode 100644 user_guide_src/source/installation/upgrade_170.rst create mode 100644 user_guide_src/source/installation/upgrade_171.rst create mode 100644 user_guide_src/source/installation/upgrade_172.rst create mode 100644 user_guide_src/source/installation/upgrade_200.rst create mode 100644 user_guide_src/source/installation/upgrade_201.rst create mode 100644 user_guide_src/source/installation/upgrade_202.rst create mode 100644 user_guide_src/source/installation/upgrade_203.rst create mode 100644 user_guide_src/source/installation/upgrade_210.rst create mode 100644 user_guide_src/source/installation/upgrade_b11.rst create mode 100644 user_guide_src/source/installation/upgrading.rst (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/downloads.rst b/user_guide_src/source/installation/downloads.rst new file mode 100644 index 000000000..a4a6b7fbe --- /dev/null +++ b/user_guide_src/source/installation/downloads.rst @@ -0,0 +1,69 @@ +####################### +Downloading CodeIgniter +####################### + +- `CodeIgniter V 2.1.0 (Current + version) `_ +- `CodeIgniter V + 2.0.3 `_ +- `CodeIgniter V + 2.0.2 `_ +- `CodeIgniter V + 2.0.1 `_ +- `CodeIgniter V + 2.0.0 `_ +- `CodeIgniter V + 1.7.3 `_ +- `CodeIgniter V + 1.7.2 `_ +- `CodeIgniter V + 1.7.1 `_ +- `CodeIgniter V + 1.7.0 `_ +- `CodeIgniter V + 1.6.3 `_ +- `CodeIgniter V + 1.6.2 `_ +- `CodeIgniter V + 1.6.1 `_ +- `CodeIgniter V + 1.6.0 `_ +- `CodeIgniter V + 1.5.4 `_ +- `CodeIgniter V + 1.5.3 `_ +- `CodeIgniter V + 1.5.2 `_ +- `CodeIgniter V + 1.5.1 `_ +- `CodeIgniter V + 1.4.1 `_ +- `CodeIgniter V + 1.3.3 `_ +- `CodeIgniter V + 1.3.2 `_ +- `CodeIgniter V + 1.3.1 `_ +- `CodeIgniter V + 1.3 `_ +- `CodeIgniter V + 1.2 `_ +- `CodeIgniter V + 1.1 `_ +- `CodeIgniter V + 1.0 `_ + + +****** +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 tags are also available via GitHub, +simply select the version from the Tags dropdown. \ No newline at end of file diff --git a/user_guide_src/source/installation/index.rst b/user_guide_src/source/installation/index.rst new file mode 100644 index 000000000..7f75f7867 --- /dev/null +++ b/user_guide_src/source/installation/index.rst @@ -0,0 +1,54 @@ +######################### +Installation Instructions +######################### + +CodeIgniter is installed in four steps: + +#. Unzip the package. +#. Upload the CodeIgniter folders and files to your server. Normally the + index.php file will be at your root. +#. 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. +#. If you intend to use a database, open the + application/config/database.php file with a text editor and set your + database settings. + +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 :doc:`security +page <../general/security>`. + +That's it! + +If you're new to CodeIgniter, please read the :doc:`Getting +Started <../overview/getting_started>` section of the User Guide +to begin learning how to build dynamic PHP applications. Enjoy! + +.. toctree:: + :glob: + :hidden: + :titlesonly: + + * \ No newline at end of file diff --git a/user_guide_src/source/installation/troubleshooting.rst b/user_guide_src/source/installation/troubleshooting.rst new file mode 100644 index 000000000..0dfd4083f --- /dev/null +++ b/user_guide_src/source/installation/troubleshooting.rst @@ -0,0 +1,19 @@ +############### +Troubleshooting +############### + +If you find that no matter what you put in your URL only your default +page is loading, it might be that your server does not support the +PATH_INFO variable needed to serve search-engine friendly URLs. As a +first step, open your application/config/config.php file and look for +the URI Protocol information. It will recommend that you try a couple +alternate settings. If it still doesn't work after you've tried this +you'll need to force CodeIgniter to add a question mark to your URLs. To +do this open your application/config/config.php file and change this:: + + $config['index_page'] = "index.php"; + +To this:: + + $config['index_page'] = "index.php?"; + diff --git a/user_guide_src/source/installation/upgrade_120.rst b/user_guide_src/source/installation/upgrade_120.rst new file mode 100644 index 000000000..76c510d66 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_120.rst @@ -0,0 +1,20 @@ +#################################### +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. diff --git a/user_guide_src/source/installation/upgrade_130.rst b/user_guide_src/source/installation/upgrade_130.rst new file mode 100644 index 000000000..6d6d4b9ac --- /dev/null +++ b/user_guide_src/source/installation/upgrade_130.rst @@ -0,0 +1,125 @@ +######################### +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. diff --git a/user_guide_src/source/installation/upgrade_131.rst b/user_guide_src/source/installation/upgrade_131.rst new file mode 100644 index 000000000..8927c1b12 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_131.rst @@ -0,0 +1,30 @@ +########################### +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. diff --git a/user_guide_src/source/installation/upgrade_132.rst b/user_guide_src/source/installation/upgrade_132.rst new file mode 100644 index 000000000..84b7cb4f7 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_132.rst @@ -0,0 +1,28 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_133.rst b/user_guide_src/source/installation/upgrade_133.rst new file mode 100644 index 000000000..4212e4588 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_133.rst @@ -0,0 +1,44 @@ +############################# +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 +:doc:`Models <../general/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, :doc:`as described +here <../general/models>`. + +Step 3: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_140.rst b/user_guide_src/source/installation/upgrade_140.rst new file mode 100644 index 000000000..987281fe1 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_140.rst @@ -0,0 +1,72 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_141.rst b/user_guide_src/source/installation/upgrade_141.rst new file mode 100644 index 000000000..c9c2ca461 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_141.rst @@ -0,0 +1,71 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_150.rst b/user_guide_src/source/installation/upgrade_150.rst new file mode 100644 index 000000000..bfe01ebba --- /dev/null +++ b/user_guide_src/source/installation/upgrade_150.rst @@ -0,0 +1,100 @@ +############################# +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: + | + | http://codeigniter.com/user_guide/general/core_classes.html + | http://codeigniter.com/user_guide/general/creating_libraries.html + | + */ + $config['subclass_prefix'] = 'MY_'; + + /* + |-------------------------------------------------------------------------- + | Rewrite PHP Short Tags + |-------------------------------------------------------------------------- + | + | If your PHP installation does not have short tag support enabled CI + | can rewrite the tags on-the-fly, enabling you to utilize that syntax + | in your view files. Options are TRUE or FALSE (boolean) + | + */ + $config['rewrite_short_tags'] = FALSE; + +In that same file REMOVE this item:: + + + /* + |-------------------------------------------------------------------------- + | Enable/Disable Error Logging + |-------------------------------------------------------------------------- + | + | If you would like errors or debug messages logged set this variable to + | TRUE (boolean). Note: You must set the file permissions on the "logs" folder + | such that it is writable. + | + */ + $config['log_errors'] = FALSE; + +Error logging is now disabled simply by setting the threshold to zero. + +Step 4: Update your main index.php file +======================================= + +If you are running a stock index.php file simply replace your version +with the new one. + +If your index.php file has internal modifications, please add your +modifications to the new file and use it. + +Step 5: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_152.rst b/user_guide_src/source/installation/upgrade_152.rst new file mode 100644 index 000000000..781c907e1 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_152.rst @@ -0,0 +1,39 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_153.rst b/user_guide_src/source/installation/upgrade_153.rst new file mode 100644 index 000000000..e3d487be1 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_153.rst @@ -0,0 +1,28 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_154.rst b/user_guide_src/source/installation/upgrade_154.rst new file mode 100644 index 000000000..1bf3156ce --- /dev/null +++ b/user_guide_src/source/installation/upgrade_154.rst @@ -0,0 +1,47 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_160.rst b/user_guide_src/source/installation/upgrade_160.rst new file mode 100644 index 000000000..daba2e5d2 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_160.rst @@ -0,0 +1,76 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_161.rst b/user_guide_src/source/installation/upgrade_161.rst new file mode 100644 index 000000000..43869223f --- /dev/null +++ b/user_guide_src/source/installation/upgrade_161.rst @@ -0,0 +1,27 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_162.rst b/user_guide_src/source/installation/upgrade_162.rst new file mode 100644 index 000000000..6a618e4ad --- /dev/null +++ b/user_guide_src/source/installation/upgrade_162.rst @@ -0,0 +1,45 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_163.rst b/user_guide_src/source/installation/upgrade_163.rst new file mode 100644 index 000000000..e24e20357 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_163.rst @@ -0,0 +1,27 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_170.rst b/user_guide_src/source/installation/upgrade_170.rst new file mode 100644 index 000000000..fefb2ea51 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_170.rst @@ -0,0 +1,56 @@ +############################# +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 :doc:`Session class <../libraries/sessions>` 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 :doc:`Form Validation +class <../libraries/form_validation>`, 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. diff --git a/user_guide_src/source/installation/upgrade_171.rst b/user_guide_src/source/installation/upgrade_171.rst new file mode 100644 index 000000000..e791b4eba --- /dev/null +++ b/user_guide_src/source/installation/upgrade_171.rst @@ -0,0 +1,27 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_172.rst b/user_guide_src/source/installation/upgrade_172.rst new file mode 100644 index 000000000..16f6dec1f --- /dev/null +++ b/user_guide_src/source/installation/upgrade_172.rst @@ -0,0 +1,48 @@ +############################# +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. + +:: + + + +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. diff --git a/user_guide_src/source/installation/upgrade_200.rst b/user_guide_src/source/installation/upgrade_200.rst new file mode 100644 index 000000000..064e1b534 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_200.rst @@ -0,0 +1,90 @@ +############################# +Upgrading from 1.7.2 to 2.0.0 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder **except** +your application folder. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Adjust get_dir_file_info() where necessary +===================================================== + +Version 2.0.0 brings a non-backwards compatible change to +get_dir_file_info() in the :doc:`File +Helper <../helpers/file_helper>`. Non-backwards compatible changes +are extremely rare in CodeIgniter, but this one we feel was warranted +due to how easy it was to create serious server performance issues. If +you *need* recursiveness where you are using this helper function, +change such instances, setting the second parameter, $top_level_only +to FALSE:: + + get_dir_file_info('/path/to/directory', FALSE); + +Step 3: Convert your Plugins to Helpers +======================================= + +2.0.0 gets rid of the "Plugin" system as their functionality was +identical to Helpers, but non-extensible. You will need to rename your +plugin files from filename_pi.php to filename_helper.php, move them to +your helpers folder, and change all instances of:: + + $this->load->plugin('foo'); + +to :: + + $this->load->helper('foo'); + + +Step 4: Update stored encrypted data +==================================== + +.. note:: If your application does not use the Encryption library, does + not store Encrypted data permanently, or is on an environment that does + not support Mcrypt, you may skip this step. + +The Encryption library has had a number of improvements, some for +encryption strength and some for performance, that has an unavoidable +consequence of making it no longer possible to decode encrypted data +produced by the original version of this library. To help with the +transition, a new method has been added, encode_from_legacy() that +will decode the data with the original algorithm and return a re-encoded +string using the improved methods. This will enable you to easily +replace stale encrypted data with fresh in your applications, either on +the fly or en masse. + +Please read `how to use this +method <../libraries/encryption.html#legacy>`_ in the Encryption library +documentation. + +Step 5: Remove loading calls for the compatibility helper. +========================================================== + +The compatibility helper has been removed from the CodeIgniter core. All +methods in it should be natively available in supported PHP versions. + +Step 6: Update Class extension +============================== + +All core classes are now prefixed with CI\_. Update Models and +Controllers to extend CI_Model and CI_Controller, respectively. + +Step 7: Update Parent Constructor calls +======================================= + +All native CodeIgniter classes now use the PHP 5 \__construct() +convention. Please update extended libraries to call +parent::\__construct(). + +Step 8: Update your user guide +============================== + +Please replace your local copy of the user guide with the new version, +including the image files. diff --git a/user_guide_src/source/installation/upgrade_201.rst b/user_guide_src/source/installation/upgrade_201.rst new file mode 100644 index 000000000..4c6b3c3fa --- /dev/null +++ b/user_guide_src/source/installation/upgrade_201.rst @@ -0,0 +1,38 @@ +############################# +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(); //
+ +to use either a / or base_url():: + + echo form_open('/'); // echo form_open(base_url()); // + diff --git a/user_guide_src/source/installation/upgrade_202.rst b/user_guide_src/source/installation/upgrade_202.rst new file mode 100644 index 000000000..8dbd38aff --- /dev/null +++ b/user_guide_src/source/installation/upgrade_202.rst @@ -0,0 +1,33 @@ +############################# +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. diff --git a/user_guide_src/source/installation/upgrade_203.rst b/user_guide_src/source/installation/upgrade_203.rst new file mode 100644 index 000000000..481b4fda0 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_203.rst @@ -0,0 +1,62 @@ +############################# +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); + diff --git a/user_guide_src/source/installation/upgrade_210.rst b/user_guide_src/source/installation/upgrade_210.rst new file mode 100644 index 000000000..9d7e1a265 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_210.rst @@ -0,0 +1,22 @@ +############################# +Upgrading from 2.0.3 to 2.1.0 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder and replace +your index.php file. If any modifications were made to your index.php +they will need to be made fresh in this new one. + +Step 2: Replace config/user_agents.php +====================================== + +This config file has been updated to contain more user agent types, +please copy it to application/config/user_agents.php. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. \ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_b11.rst b/user_guide_src/source/installation/upgrade_b11.rst new file mode 100644 index 000000000..1d8efbe72 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_b11.rst @@ -0,0 +1,57 @@ +################################### +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"; + diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst new file mode 100644 index 000000000..2badffc93 --- /dev/null +++ b/user_guide_src/source/installation/upgrading.rst @@ -0,0 +1,32 @@ +################################# +Upgrading From a Previous Version +################################# + +Please read the upgrade notes corresponding to the version you are +upgrading from. + +- :doc:`Upgrading from 2.0.3 to 2.1.0 ` +- :doc:`Upgrading from 2.0.2 to 2.0.3 ` +- :doc:`Upgrading from 2.0.1 to 2.0.2 ` +- :doc:`Upgrading from 2.0 to 2.0.1 ` +- :doc:`Upgrading from 1.7.2 to 2.0 ` +- :doc:`Upgrading from 1.7.1 to 1.7.2 ` +- :doc:`Upgrading from 1.7.0 to 1.7.1 ` +- :doc:`Upgrading from 1.6.3 to 1.7.0 ` +- :doc:`Upgrading from 1.6.2 to 1.6.3 ` +- :doc:`Upgrading from 1.6.1 to 1.6.2 ` +- :doc:`Upgrading from 1.6.0 to 1.6.1 ` +- :doc:`Upgrading from 1.5.4 to 1.6.0 ` +- :doc:`Upgrading from 1.5.3 to 1.5.4 ` +- :doc:`Upgrading from 1.5.2 to 1.5.3 ` +- :doc:`Upgrading from 1.5.0 or 1.5.1 to 1.5.2 ` +- :doc:`Upgrading from 1.4.1 to 1.5.0 ` +- :doc:`Upgrading from 1.4.0 to 1.4.1 ` +- :doc:`Upgrading from 1.3.3 to 1.4.0 ` +- :doc:`Upgrading from 1.3.2 to 1.3.3 ` +- :doc:`Upgrading from 1.3.1 to 1.3.2 ` +- :doc:`Upgrading from 1.3 to 1.3.1 ` +- :doc:`Upgrading from 1.2 to 1.3 ` +- :doc:`Upgrading from 1.1 to 1.2 ` +- :doc:`Upgrading from Beta 1.0 to Beta 1.1 ` + -- cgit v1.2.3-24-g4f1b From 3af48520578c79460e31743d145f6509482a8ff9 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 16:33:16 -0500 Subject: fixed code block spacing in installation docs files --- user_guide_src/source/installation/upgrade_154.rst | 11 ++++++++- user_guide_src/source/installation/upgrade_160.rst | 15 ++++++++++-- user_guide_src/source/installation/upgrade_201.rst | 3 ++- user_guide_src/source/installation/upgrade_203.rst | 3 ++- user_guide_src/source/installation/upgrade_b11.rst | 27 +++++++++++++++++++--- 5 files changed, 51 insertions(+), 8 deletions(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_154.rst b/user_guide_src/source/installation/upgrade_154.rst index 1bf3156ce..1d2c51d4a 100644 --- a/user_guide_src/source/installation/upgrade_154.rst +++ b/user_guide_src/source/installation/upgrade_154.rst @@ -28,7 +28,16 @@ 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"; + /* + |-------------------------------------------------------------------------- + | 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 ================================== diff --git a/user_guide_src/source/installation/upgrade_160.rst b/user_guide_src/source/installation/upgrade_160.rst index daba2e5d2..e5d26611b 100644 --- a/user_guide_src/source/installation/upgrade_160.rst +++ b/user_guide_src/source/installation/upgrade_160.rst @@ -39,7 +39,17 @@ Add the following to application/config/autoload.php :: - /* | ------------------------------------------------------------------- | Auto-load Model files | ------------------------------------------------------------------- | Prototype: | | $autoload['model'] = array('my_model'); | */ $autoload['model'] = array(); + /* + | ------------------------------------------------------------------- + | Auto-load Model files + | ------------------------------------------------------------------- + | Prototype: + | + | $autoload['model'] = array('my_model'); + | + */ + + $autoload['model'] = array(); Step 4: Add to your database.php @@ -66,7 +76,8 @@ Add the following to your database configuration options :: - $db['default']['char_set'] = "utf8"; $db['default']['dbcollat'] = "utf8_general_ci"; + $db['default']['char_set'] = "utf8"; + $db['default']['dbcollat'] = "utf8_general_ci"; Step 5: Update your user guide diff --git a/user_guide_src/source/installation/upgrade_201.rst b/user_guide_src/source/installation/upgrade_201.rst index 4c6b3c3fa..93e1aa68d 100644 --- a/user_guide_src/source/installation/upgrade_201.rst +++ b/user_guide_src/source/installation/upgrade_201.rst @@ -34,5 +34,6 @@ need to be changed from:: to use either a / or base_url():: - echo form_open('/'); // echo form_open(base_url()); // + echo form_open('/'); // + echo form_open(base_url()); // diff --git a/user_guide_src/source/installation/upgrade_203.rst b/user_guide_src/source/installation/upgrade_203.rst index 481b4fda0..717aa3e50 100644 --- a/user_guide_src/source/installation/upgrade_203.rst +++ b/user_guide_src/source/installation/upgrade_203.rst @@ -58,5 +58,6 @@ 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); + CREATE INDEX last_activity_idx ON ci_sessions(last_activity); + ALTER TABLE ci_sessions MODIFY user_agent VARCHAR(120); diff --git a/user_guide_src/source/installation/upgrade_b11.rst b/user_guide_src/source/installation/upgrade_b11.rst index 1d8efbe72..e70759be6 100644 --- a/user_guide_src/source/installation/upgrade_b11.rst +++ b/user_guide_src/source/installation/upgrade_b11.rst @@ -44,14 +44,35 @@ 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'] = "/"; + $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'] = "/"; + $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"; + + /* + |------------------------------------------------ + | 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"; -- cgit v1.2.3-24-g4f1b From caa1db64141cc8bfbdbe3a4f6f7b639331d5d3ba Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Mon, 17 Oct 2011 21:17:21 -0500 Subject: added some additional notes to the 2.0.0 update notes to highlight some of the potential gotchas, fixes #588 --- user_guide_src/source/installation/upgrade_200.rst | 52 ++++++++++++++++++++++ 1 file changed, 52 insertions(+) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_200.rst b/user_guide_src/source/installation/upgrade_200.rst index 064e1b534..0bcbd5c99 100644 --- a/user_guide_src/source/installation/upgrade_200.rst +++ b/user_guide_src/source/installation/upgrade_200.rst @@ -5,6 +5,10 @@ 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 ===================================== @@ -88,3 +92,51 @@ Step 8: 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 :ref:`2.0.0 Change Log <2.0.0-changelog>` for full +details, but here are some of the larger changes that are more likely to +impact your code: + +- CodeIgniter now requires PHP 5.1.6. +- Scaffolding has been removed. +- The CAPTCHA plugin in now a :doc:`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 + :doc:`Form Validation library ` +- "default" is now a reserved name. +- The xss_clean() function has moved to the :doc:`Security Class + `. +- do_xss_clean() now returns FALSE if the uploaded file fails XSS checks. +- The :doc:`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 :doc:`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 -- cgit v1.2.3-24-g4f1b From 0fa9d83cb0a05f24e25dd57bfb7fe014dc92597f Mon Sep 17 00:00:00 2001 From: Greg Aker Date: Tue, 27 Dec 2011 01:59:24 -0600 Subject: Adding 3.0.0 release notes documentation file. --- user_guide_src/source/installation/upgrade_300.rst | 28 ++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 user_guide_src/source/installation/upgrade_300.rst (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst new file mode 100644 index 000000000..62ef0ea88 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -0,0 +1,28 @@ +############################# +Upgrading from 2.1.0 to 3.0.0 +############################# + +.. note:: These upgrade notes are for a version that is yet to be released. + + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder and replace +your index.php file. If any modifications were made to your index.php +they will need to be made fresh in this new one. + +Step 2: Change References to the SHA Library +============================================ + +The previously deprecated SHA library has been removed in CodeIgniter 3.0. +Alter your code to use the native `sha1()` PHP function to generate a sha1 hash. + +Additionally, the `sha1()` method in the :doc:`Encryption Library ` library has been removed. + + +.. note:: If you have any custom developed files in these folders please + make copies of them first. -- cgit v1.2.3-24-g4f1b From fcb8ee8695fca74f1175750eb38473ec08a4b483 Mon Sep 17 00:00:00 2001 From: Greg Aker Date: Tue, 27 Dec 2011 02:00:46 -0600 Subject: Fixing a documentation linking error in the 3.0 upgrade notes. --- user_guide_src/source/installation/upgrade_300.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 62ef0ea88..960485ae3 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -21,7 +21,7 @@ Step 2: Change References to the SHA Library The previously deprecated SHA library has been removed in CodeIgniter 3.0. Alter your code to use the native `sha1()` PHP function to generate a sha1 hash. -Additionally, the `sha1()` method in the :doc:`Encryption Library ` library has been removed. +Additionally, the `sha1()` method in the :doc:`Encryption Library <../libraries/encryption>` has been removed. .. note:: If you have any custom developed files in these folders please -- cgit v1.2.3-24-g4f1b From 75f7c12815c62782163a54e84707f50459b6ef5d Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Sun, 8 Jan 2012 03:49:25 +0200 Subject: Remove loading of ['core'] elements --- user_guide_src/source/installation/upgrade_300.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 960485ae3..4c594ab17 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -15,6 +15,9 @@ 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: Change References to the SHA Library ============================================ @@ -23,6 +26,8 @@ Alter your code to use the native `sha1()` PHP function to generate a sha1 hash. Additionally, the `sha1()` method in the :doc:`Encryption Library <../libraries/encryption>` has been removed. +Step 3: Remove $autoload['core'] from your config/autoload.php +============================================================== -.. note:: If you have any custom developed files in these folders please - make copies of them first. +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. -- cgit v1.2.3-24-g4f1b From 07c1ac830b4e98aa40f48baef3dd05fb68c0a836 Mon Sep 17 00:00:00 2001 From: Phil Sturgeon Date: Fri, 9 Mar 2012 17:03:37 +0000 Subject: Bumped CodeIgniter's PHP requirement to 5.2.4. Yes I know PHP 5.4 just came out, and yes I know PHP 5.3 has lovely features, but there are plenty of corporate systems running on CodeIgniter and PHP 5.3 still is not widely supported enough. CodeIgniter is great for distributed applications, and this is the highest we can reasonably go without breaking support. PHP 5.3 will most likely happen in another year or so. Fingers crossed on that one anyway... --- user_guide_src/source/installation/upgrade_200.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_200.rst b/user_guide_src/source/installation/upgrade_200.rst index 0bcbd5c99..b39f4fd23 100644 --- a/user_guide_src/source/installation/upgrade_200.rst +++ b/user_guide_src/source/installation/upgrade_200.rst @@ -102,7 +102,7 @@ Please refer to the :ref:`2.0.0 Change Log <2.0.0-changelog>` for full details, but here are some of the larger changes that are more likely to impact your code: -- CodeIgniter now requires PHP 5.1.6. +- CodeIgniter now requires PHP 5.2.4. - Scaffolding has been removed. - The CAPTCHA plugin in now a :doc:`helper `. - The JavaScript calendar plugin was removed. -- cgit v1.2.3-24-g4f1b From 7bf0a4ff35efc758ef43b3a848e655285946b8b6 Mon Sep 17 00:00:00 2001 From: Iban Eguia Date: Tue, 27 Mar 2012 18:36:15 +0200 Subject: Added doccumentation for the new date helper. --- user_guide_src/source/installation/upgrade_300.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 4c594ab17..b6f52080a 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -31,3 +31,9 @@ Step 3: 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 4: Change your use of the Date heper's now() function +========================================================== + +Function now() has been modified. You can see the changes in :doc:`Date Helper <../helpers/date_helper>` +You must replace $config['time_reference'] with $config['timezone']. \ No newline at end of file -- cgit v1.2.3-24-g4f1b From 0ed4f63f4268b0c98f549ffd711702fd45a761d0 Mon Sep 17 00:00:00 2001 From: Iban Eguia Date: Tue, 27 Mar 2012 22:07:44 +0200 Subject: Fixed a typo and added the route for the config file. --- user_guide_src/source/installation/upgrade_300.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index b6f52080a..5d6450ee6 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -32,8 +32,8 @@ Step 3: 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 4: Change your use of the Date heper's now() function +Step 4: Change your use of the Date helper's now() function ========================================================== Function now() has been modified. You can see the changes in :doc:`Date Helper <../helpers/date_helper>` -You must replace $config['time_reference'] with $config['timezone']. \ No newline at end of file +You must replace $config['time_reference'] with $config['timezone'] in your config.php file. \ No newline at end of file -- cgit v1.2.3-24-g4f1b From 606d246d7583a42582c9c283bc2163fec68d30eb Mon Sep 17 00:00:00 2001 From: Jamie Rumbelow Date: Thu, 26 Apr 2012 13:38:44 +0100 Subject: Adding some update notes for 3.0.0 (renaming AR to QB) --- user_guide_src/source/installation/upgrade_300.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 4c594ab17..e434e8d45 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -31,3 +31,13 @@ Step 3: 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 4: 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; \ No newline at end of file -- cgit v1.2.3-24-g4f1b From 2ed226bd5ed19754c2fb28d4b98ac5423741f039 Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Wed, 16 May 2012 08:37:32 -0400 Subject: Add note in the upgrade guide to move errors folder --- user_guide_src/source/installation/upgrade_300.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index e434e8d45..63c4227dc 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -40,4 +40,9 @@ need to rename the `$active_record` variable to `$query_builder`. $active_group = 'default'; // $active_record = TRUE; - $query_builder = TRUE; \ No newline at end of file + $query_builder = TRUE; + +Step 5: Move your errors folder +=============================== + +In version 3.0.0, the errors folder has been moved from "application/errors" to "application/views/errors". \ No newline at end of file -- cgit v1.2.3-24-g4f1b From 4337771961de19f7cffb444aa2bd2866e9dad18a Mon Sep 17 00:00:00 2001 From: Brent Ashley Date: Tue, 22 May 2012 12:45:10 -0300 Subject: Add step to move existing core extensions to new folder --- user_guide_src/source/installation/upgrade_200.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_200.rst b/user_guide_src/source/installation/upgrade_200.rst index b39f4fd23..74b7443d8 100644 --- a/user_guide_src/source/installation/upgrade_200.rst +++ b/user_guide_src/source/installation/upgrade_200.rst @@ -87,7 +87,14 @@ All native CodeIgniter classes now use the PHP 5 \__construct() convention. Please update extended libraries to call parent::\__construct(). -Step 8: Update your user guide +Step 8: Move any core extensions to application/core +==================================================== + +Any extensions to core classes (e.g. MY_Controller.php) in your +application/liblraries 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, -- cgit v1.2.3-24-g4f1b From 0b427951859e393b5c6b31699fe0f1c1ae89b403 Mon Sep 17 00:00:00 2001 From: Brent Ashley Date: Tue, 22 May 2012 16:24:04 -0300 Subject: fix typo in step 8 --- user_guide_src/source/installation/upgrade_200.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_200.rst b/user_guide_src/source/installation/upgrade_200.rst index 74b7443d8..29f44bd9e 100644 --- a/user_guide_src/source/installation/upgrade_200.rst +++ b/user_guide_src/source/installation/upgrade_200.rst @@ -91,7 +91,7 @@ Step 8: Move any core extensions to application/core ==================================================== Any extensions to core classes (e.g. MY_Controller.php) in your -application/liblraries folder must be moved to the new +application/libraries folder must be moved to the new application/core folder. Step 9: Update your user guide -- cgit v1.2.3-24-g4f1b From f5d1fd2ce8bfa049c8049184ac6d385d0f70fe29 Mon Sep 17 00:00:00 2001 From: Iban Eguia Date: Fri, 8 Jun 2012 23:37:33 +0200 Subject: Updated the upgrade guide to specify which are the supported timezones. --- user_guide_src/source/installation/upgrade_300.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 503e5366c..e86ef67da 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -46,7 +46,8 @@ Step 5: Change your use of the Date helper's now() function =========================================================== Function now() has been modified. You can see the changes in :doc:`Date Helper <../helpers/date_helper>` -You must replace $config['time_reference'] with $config['timezone'] in your config.php file. +You must replace $config['time_reference'] with $config['timezone'] in your config.php file. You can select all +PHP supported timezones, listed here: `PHP's supported timezones `_. Step 6: Move your errors folder =============================== -- cgit v1.2.3-24-g4f1b From e15e3dde9dca15e2d65f098010d3fb7004cef5e7 Mon Sep 17 00:00:00 2001 From: Iban Eguia Date: Sat, 9 Jun 2012 23:52:27 +0200 Subject: Fixed timezone change in index.php Now it does not ever change the local timezone, and it adds the option to get the 'local' time() --- user_guide_src/source/installation/upgrade_300.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index e86ef67da..c2c3899ee 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -47,7 +47,8 @@ Step 5: Change your use of the Date helper's now() function Function now() has been modified. You can see the changes in :doc:`Date Helper <../helpers/date_helper>` You must replace $config['time_reference'] with $config['timezone'] in your config.php file. You can select all -PHP supported timezones, listed here: `PHP's supported timezones `_. +PHP supported timezones, listed here: `Supported timezones `_. You can also +use 'local' if you want to get time(). Step 6: Move your errors folder =============================== -- cgit v1.2.3-24-g4f1b From 5a257187c4ca09ea61c19999bf061cec3f224cc2 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Sun, 10 Jun 2012 06:18:14 +0300 Subject: Merge branch 2.1-stable into develop --- user_guide_src/source/installation/upgrading.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst index 2badffc93..255c6a557 100644 --- a/user_guide_src/source/installation/upgrading.rst +++ b/user_guide_src/source/installation/upgrading.rst @@ -5,7 +5,8 @@ Upgrading From a Previous Version Please read the upgrade notes corresponding to the version you are upgrading from. -- :doc:`Upgrading from 2.0.3 to 2.1.0 ` +- :doc:`Upgrading from 2.1.1 to 3.0.0 ` +- :doc:`Upgrading from 2.1.0 to 2.1.1 ` - :doc:`Upgrading from 2.0.2 to 2.0.3 ` - :doc:`Upgrading from 2.0.1 to 2.0.2 ` - :doc:`Upgrading from 2.0 to 2.0.1 ` -- cgit v1.2.3-24-g4f1b From feb14dac4e7a417a48344a5188a8ad8074871df4 Mon Sep 17 00:00:00 2001 From: Iban Eguia Date: Tue, 12 Jun 2012 16:09:36 +0200 Subject: Changed the config parameter. The session's _get_time() function has also changed. --- user_guide_src/source/installation/upgrade_300.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index c2c3899ee..debf9662c 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -45,9 +45,8 @@ need to rename the `$active_record` variable to `$query_builder`. Step 5: Change your use of the Date helper's now() function =========================================================== -Function now() has been modified. You can see the changes in :doc:`Date Helper <../helpers/date_helper>` -You must replace $config['time_reference'] with $config['timezone'] in your config.php file. You can select all -PHP supported timezones, listed here: `Supported timezones `_. You can also +Function now() has been modified. You can see the changes in :doc:`Date Helper <../helpers/date_helper>`. +You can now select all PHP supported timezones in the `time_reference` setting, listed here: `Supported timezones `_. You can also use 'local' if you want to get time(). Step 6: Move your errors folder -- cgit v1.2.3-24-g4f1b From 7400965017f87c3aba18bf75ed7d732359fd577d Mon Sep 17 00:00:00 2001 From: Iban Eguia Date: Wed, 13 Jun 2012 22:57:50 +0200 Subject: Fixed some stuff in documentation. --- user_guide_src/source/installation/upgrade_300.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index debf9662c..d8a3d5bc1 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -46,8 +46,8 @@ Step 5: Change your use of the Date helper's now() function =========================================================== Function now() has been modified. You can see the changes in :doc:`Date Helper <../helpers/date_helper>`. -You can now select all PHP supported timezones in the `time_reference` setting, listed here: `Supported timezones `_. You can also -use 'local' if you want to get time(). +You can now select all PHP supported timezones in the `time_reference` setting, listed here: +`Supported timezones `_. You can also use 'local' if you want to get time(). Step 6: Move your errors folder =============================== -- cgit v1.2.3-24-g4f1b From d163e0b219b8afacea3cd0d1d7c2ce5bb6f8a933 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Thu, 14 Jun 2012 03:09:53 +0300 Subject: Polish changes from pull #1233 - Session class already has the time_reference setting - 'GMT' is a valid timezone, so nothing needs to be changed in order to work properly (upgrade notes) - Altered some description text --- user_guide_src/source/installation/upgrade_300.rst | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index d8a3d5bc1..c70737cff 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -42,14 +42,7 @@ need to rename the `$active_record` variable to `$query_builder`. // $active_record = TRUE; $query_builder = TRUE; -Step 5: Change your use of the Date helper's now() function -=========================================================== - -Function now() has been modified. You can see the changes in :doc:`Date Helper <../helpers/date_helper>`. -You can now select all PHP supported timezones in the `time_reference` setting, listed here: -`Supported timezones `_. You can also use 'local' if you want to get time(). - -Step 6: Move your errors folder +Step 5: Move your errors folder =============================== -In version 3.0.0, the errors folder has been moved from "application/errors" to "application/views/errors". \ No newline at end of file +In version 3.0.0, the errors folder has been moved from _application/errors_ to _application/views/errors_. \ No newline at end of file -- cgit v1.2.3-24-g4f1b From ce79be0b5ffc9d5754c93771a8c289a252ec437b Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Mon, 25 Jun 2012 23:23:46 -0700 Subject: Fixing various Sphinx bugs and syntax errors in docs --- user_guide_src/source/installation/upgrade_300.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index c70737cff..14199092f 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -35,7 +35,7 @@ Move any entries that you might have listed there to `$autoload['libraries']` in Step 4: 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 +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'; @@ -45,4 +45,4 @@ need to rename the `$active_record` variable to `$query_builder`. Step 5: Move your errors folder =============================== -In version 3.0.0, the errors folder has been moved from _application/errors_ to _application/views/errors_. \ No newline at end of file +In version 3.0.0, the errors folder has been moved from _application/errors* to _application/views/errors*. \ No newline at end of file -- cgit v1.2.3-24-g4f1b From cf9431e294abc921cf9fe4b9228086d65bd27939 Mon Sep 17 00:00:00 2001 From: vlakoff Date: Tue, 3 Jul 2012 07:01:38 +0200 Subject: Document in the 3.0.0 upgrade guide a breaking change in Array Helper The default return value of Array Helper's element() and elements() functions, when the required elements don't exist, has been changed from FALSE to NULL. --- user_guide_src/source/installation/upgrade_300.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 14199092f..676c99e6a 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -45,4 +45,10 @@ need to rename the `$active_record` variable to `$query_builder`. Step 5: Move your errors folder =============================== -In version 3.0.0, the errors folder has been moved from _application/errors* to _application/views/errors*. \ No newline at end of file +In version 3.0.0, the errors folder has been moved from _application/errors* to _application/views/errors*. + +Step 6: Check the calls to Array Helper's element() and elements() functions +============================================================================ + +The default return value of these functions, when the required elements +don't exist, has been changed from FALSE to NULL. \ No newline at end of file -- cgit v1.2.3-24-g4f1b From f2dcca6f9212923e54fb62ae58f79dc713b111ad Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Tue, 3 Jul 2012 16:05:34 +0300 Subject: Update the upgrade notes --- user_guide_src/source/installation/downloads.rst | 8 +- user_guide_src/source/installation/upgrade_210.rst | 8 +- user_guide_src/source/installation/upgrade_211.rst | 33 ++++++++ user_guide_src/source/installation/upgrade_212.rst | 16 ++++ user_guide_src/source/installation/upgrade_300.rst | 97 ++++++++++++++++++---- user_guide_src/source/installation/upgrading.rst | 3 +- 6 files changed, 141 insertions(+), 24 deletions(-) create mode 100644 user_guide_src/source/installation/upgrade_211.rst create mode 100644 user_guide_src/source/installation/upgrade_212.rst (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/downloads.rst b/user_guide_src/source/installation/downloads.rst index a4a6b7fbe..45a8f80a7 100644 --- a/user_guide_src/source/installation/downloads.rst +++ b/user_guide_src/source/installation/downloads.rst @@ -2,8 +2,14 @@ Downloading CodeIgniter ####################### -- `CodeIgniter V 2.1.0 (Current +- `CodeIgniter V 3.0.0 (Current version) `_ +- `CodeIgniter V + 2.1.2 `_ +- `CodeIgniter V + 2.1.1 `_ +- `CodeIgniter V + 2.1.0 `_ - `CodeIgniter V 2.0.3 `_ - `CodeIgniter V diff --git a/user_guide_src/source/installation/upgrade_210.rst b/user_guide_src/source/installation/upgrade_210.rst index 9d7e1a265..647537d1f 100644 --- a/user_guide_src/source/installation/upgrade_210.rst +++ b/user_guide_src/source/installation/upgrade_210.rst @@ -12,11 +12,11 @@ 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/user_agents.php ====================================== This config file has been updated to contain more user agent types, -please copy it to application/config/user_agents.php. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. \ No newline at end of file +please copy it to _application/config/user_agents.php*. \ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_211.rst b/user_guide_src/source/installation/upgrade_211.rst new file mode 100644 index 000000000..80248a758 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_211.rst @@ -0,0 +1,33 @@ +############################# +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 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 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 diff --git a/user_guide_src/source/installation/upgrade_212.rst b/user_guide_src/source/installation/upgrade_212.rst new file mode 100644 index 000000000..cdbf977d7 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_212.rst @@ -0,0 +1,16 @@ +############################# +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 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. \ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 676c99e6a..7b0d8abe9 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -1,15 +1,14 @@ ############################# -Upgrading from 2.1.0 to 3.0.0 +Upgrading from 2.1.2 to 3.0.0 ############################# .. note:: These upgrade notes are for a version that is yet to be released. +Before performing an update you should take your site offline by replacing the index.php file with a static one. -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 @@ -18,22 +17,23 @@ 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: Change References to the SHA Library -============================================ - -The previously deprecated SHA library has been removed in CodeIgniter 3.0. -Alter your code to use the native `sha1()` PHP function to generate a sha1 hash. +******************************** +Step 2: Replace config/mimes.php +******************************** -Additionally, the `sha1()` method in the :doc:`Encryption Library <../libraries/encryption>` has been removed. +This config file has been updated to contain more user mime-types, please copy +it to _application/config/mimes.php*. +************************************************************** Step 3: 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. +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 4: 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`. @@ -42,13 +42,74 @@ need to rename the `$active_record` variable to `$query_builder`. // $active_record = TRUE; $query_builder = TRUE; +******************************* Step 5: Move your errors folder -=============================== +******************************* In version 3.0.0, the errors folder has been moved from _application/errors* to _application/views/errors*. +**************************************************************************** Step 6: Check the calls to Array Helper's element() and elements() functions -============================================================================ +**************************************************************************** The default return value of these functions, when the required elements -don't exist, has been changed from FALSE to NULL. \ No newline at end of file +don't exist, has been changed from FALSE to NULL. + +*************************************************************** +Step 7: 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 :doc:`Encryption Library <../libraries/encryption>` 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 js_insert_smiley() +================================ + +:doc:`Smiley Helper <../helpers/smiley_helper>` function ``js_insert_smiley()`` has been deprecated +since CodeIgniter 1.7.2 and is now removed. You'll need to switch to ``smiley_js()`` instead. + +Security helper do_hash() +========================= + +:doc:`Security Helper <../helpers/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 it's usage sooner + rather than later. + +File helper read_file() +======================= + +:doc:`File Helper <../helpers/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 it's usage sooner + rather than later. + +Pagination library 'anchor_class' setting +========================================= + +The :doc:`Pagination Library <../libraries/pagination>` 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 it's usage sooner + rather than later. \ No newline at end of file diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst index 255c6a557..3609e4213 100644 --- a/user_guide_src/source/installation/upgrading.rst +++ b/user_guide_src/source/installation/upgrading.rst @@ -5,7 +5,8 @@ Upgrading From a Previous Version Please read the upgrade notes corresponding to the version you are upgrading from. -- :doc:`Upgrading from 2.1.1 to 3.0.0 ` +- :doc:`Upgrading from 2.1.2 to 3.0.0 ` +- :doc:`Upgrading from 2.1.1 to 2.1.2 ` - :doc:`Upgrading from 2.1.0 to 2.1.1 ` - :doc:`Upgrading from 2.0.2 to 2.0.3 ` - :doc:`Upgrading from 2.0.1 to 2.0.2 ` -- cgit v1.2.3-24-g4f1b From ac57033236d5b62ba553b6bea87623f0dbeb2f49 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Wed, 4 Jul 2012 13:04:10 +0300 Subject: Deprecate Date helper standard_date() --- user_guide_src/source/installation/upgrade_300.rst | 28 +++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 7b0d8abe9..6b93750d1 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -102,6 +102,32 @@ CodeIgniter 3.1+. .. note:: This function is still available, but you're strongly encouraged to remove it's usage sooner rather than later. +Date helper standard_date() +=========================== + +:doc:`Date Helper <../helpers/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 suppored by ``standard_date()``. Here are examples of how to replace +it's usage: + +:: + + // Old way + standard_date(); // defaults to stanard_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+. + Pagination library 'anchor_class' setting ========================================= @@ -111,5 +137,5 @@ attribute to your anchors via the 'attributes' configuration setting. This inclu 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 it's usage sooner +.. note:: This setting is still available, but you're strongly encouraged to remove its' usage sooner rather than later. \ No newline at end of file -- cgit v1.2.3-24-g4f1b From 9d21400f12bfe3a09d27afb00a22ae96fbbed1d5 Mon Sep 17 00:00:00 2001 From: vlakoff Date: Wed, 4 Jul 2012 13:03:26 +0200 Subject: Fix typos in upgrade_300.rst --- user_guide_src/source/installation/upgrade_300.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 6b93750d1..f304a716f 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -108,13 +108,13 @@ Date helper standard_date() :doc:`Date Helper <../helpers/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 suppored by ``standard_date()``. Here are examples of how to replace +exact same names as the ones supported by ``standard_date()``. Here are examples of how to replace it's usage: :: // Old way - standard_date(); // defaults to stanard_date('DATE_RFC822', now()); + standard_date(); // defaults to standard_date('DATE_RFC822', now()); // Replacement date(DATE_RFC822, now()); -- cgit v1.2.3-24-g4f1b From 0054750cf2e071cbe6903dba59e43a6bb8e639d1 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 4 Jul 2012 06:51:15 -0700 Subject: Fixing upgrade file references --- user_guide_src/source/installation/upgrade_210.rst | 14 +++++--------- user_guide_src/source/installation/upgrade_211.rst | 18 ++++++++++++++++++ user_guide_src/source/installation/upgrade_212.rst | 18 ++++++++++++++++++ user_guide_src/source/installation/upgrading.rst | 4 +++- 4 files changed, 44 insertions(+), 10 deletions(-) create mode 100644 user_guide_src/source/installation/upgrade_211.rst create mode 100644 user_guide_src/source/installation/upgrade_212.rst (limited to 'user_guide_src/source/installation') diff --git a/user_guide_src/source/installation/upgrade_210.rst b/user_guide_src/source/installation/upgrade_210.rst index 9d7e1a265..1625c64bd 100644 --- a/user_guide_src/source/installation/upgrade_210.rst +++ b/user_guide_src/source/installation/upgrade_210.rst @@ -8,15 +8,11 @@ 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. +Replace all files and directories in your "system" folder. -Step 2: Replace config/user_agents.php -====================================== +Step 2: Update your user guide +============================== -This config file has been updated to contain more user agent types, -please copy it to application/config/user_agents.php. +Please also replace your local copy of the user guide with the new +version. -.. note:: If you have any custom developed files in these folders please - make copies of them first. \ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_211.rst b/user_guide_src/source/installation/upgrade_211.rst new file mode 100644 index 000000000..882a520c5 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_211.rst @@ -0,0 +1,18 @@ +############################# +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. + +Step 2: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. + diff --git a/user_guide_src/source/installation/upgrade_212.rst b/user_guide_src/source/installation/upgrade_212.rst new file mode 100644 index 000000000..fa0fb8073 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_212.rst @@ -0,0 +1,18 @@ +############################# +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. + +Step 2: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. + diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst index 255c6a557..545f344ee 100644 --- a/user_guide_src/source/installation/upgrading.rst +++ b/user_guide_src/source/installation/upgrading.rst @@ -5,8 +5,10 @@ Upgrading From a Previous Version Please read the upgrade notes corresponding to the version you are upgrading from. -- :doc:`Upgrading from 2.1.1 to 3.0.0 ` +- :doc:`Upgrading from 2.1.2 to 3.0.0 ` +- :doc:`Upgrading from 2.1.1 to 2.1.2 ` - :doc:`Upgrading from 2.1.0 to 2.1.1 ` +- :doc:`Upgrading from 2.0.3 to 2.1.0 ` - :doc:`Upgrading from 2.0.2 to 2.0.3 ` - :doc:`Upgrading from 2.0.1 to 2.0.2 ` - :doc:`Upgrading from 2.0 to 2.0.1 ` -- cgit v1.2.3-24-g4f1b