# CodeIgniter User Guide Version 1.5.4

Search User Guide

# Change Log

## Version 1.5.4

Release Date: July 12, 2007

- Added custom Language files to the autoload options.
- Added stripslashes() to the _clean_input_data() function in the Input class when magic quotes is on so that data will always be un-slashed within the framework.
- Added array to string into the profiler.
- Added some additional mime types in application/config/mimes.php.
- Added filename_security() method to Input library.
- Added some additional arguments to the Inflection helper singular() to compensate for words ending in "s". Also added a force parameter to pluralize().
- Added $config['charset'] to the config file. Default value is 'UTF-8', used in some string handling functions.
- Fixed MSSQL insert_id().
- Fixed a logic error in the DB trans_status() function. It was incorrectly returning TRUE on failure and FALSE on success.
- Fixed a bug that was allowing multiple load attempts on extended classes.
- Fixed a bug in the bootstrap file that was incorrectly attempting to discern the full server path even when it was explicity set by the user.
- Fixed a bug in the escape_str() function in the MySQL driver.
- Fixed a typo in the Calendar library
- Fixed a typo in rpcs.php library
- Fixed a bug in the Zip library, providing PC Zip file compatibility with Mac OS X
- Fixed a bug in router that was ignoring the scaffolding route for optimization
- Fixed an IP validation bug.
- Fixed a bug in display of POST keys in the Profiler output
- Fixed a bug in display of queries with characters that would be interpreted as HTML in the Profiler output
- Fixed a bug in display of Email class print debugger with characters that would be interpreted as HTML in the debugging output
- Fixed a bug in the Content-Transfer-Encoding of HTML emails with the quoted-printable MIME type
- Fixed a bug where one could unset certain PHP superglobals by setting them via GET or POST data
- Fixed an undefined function error in the insert_id() function of the PostgreSQL driver
- Fixed various doc typos.
- Documented two functions from the String helper that were missing from the user guide: trim_slashes() and reduce_double_slashes().
- Docs now validate to XHTML 1 transitional
- Updated the XSS Filtering to take into account the IE expression() ability and improved certain deletions to prevent possible exploits
- Modified the Router so that when Query Strings are Enabled, the controller trigger and function trigger values are sanitized for filename include security.
- Modified the is_image() method in the Upload library to take into account Windows IE 6/7 eccentricities when dealing with MIMEs
- Modified XSS Cleaning routine to be more performance friendly and compatible with PHP 5.2's new PCRE backtrack and recursion limits.
- Modified the URL Helper to type cast the $title as a string in case a numeric value is supplied
- Modified Form Helper form_dropdown() to type cast the keys and values of the options array as strings, allowing numeric values to be properly set as 'selected'
- Deprecated the use if `is_numeric()` in various places since it allows periods. Due to compatibility problems with `ctype_digit()`, making it unreliable in some installations, the following regular expression was used instead: `preg_match("/[^0-9]/", $n)`
- Deprecated: APPVER has been deprecated and replaced with CI_VERSION for clarity.

## Version 1.5.3

Release Date: April 15, 2007

- Added array to string into the profiler
- Code Igniter references updated to CodeIgniter
- pMachine references updated to EllisLab
- Fixed a bug in the repeater function of string helper.
- Fixed a bug in ODBC driver
- Fixed a bug in result_array() that was returning an empty array when no result is produced.
- Fixed a bug in the redirect function of the url helper.
- Fixed an undefined variable in Loader
- Fixed a version bug in the Postgre driver
- Fixed a bug in the textarea function of the form helper for use with strings
- Fixed doc typos.

## Version 1.5.2

Release Date: February 13, 2007

- Added subversion information to the downloads page.
- Added support for captions in the Table Library
- Fixed a bug in the download_helper that was causing Internet Explorer to load rather then download
- Fixed a bug in the Active Record Join function that was not taking table prefixes into consideration.
- Removed unescaped variables in error messages of Input and Router classes
- Fixed a bug in the Loader that was causing errors on Libraries loaded twice. A debug message is now silently made in the log.
- Fixed a bug in the form helper that gave textarea a value attribute
- Fixed a bug in the Image Library that was ignoring resizing the same size image
- Fixed some doc typos.

## Version 1.5.1

Release Date: November 23, 2006

- Added support for submitting arrays of libraries in the $this->load->library function.
- Added support for naming custom library files in lower or uppercase.
- Fixed a bug related to output buffering.
- Fixed a bug in the active record class that was not resetting query data after a completed query.
- Fixed a bug that was suppressing errors in controllers.
- Fixed a problem that can cause a loop to occur when the config file is missing.
- Fixed a bug that occurred when multiple models were loaded with the third parameter set to TRUE.
- Fixed an oversight that was not unsetting globals properly in the input sanitize function.
- Fixed some bugs in the Oracle DB driver.
- Fixed an incorrectly named variable in the MySQLi result driver.
- Fixed some doc typos.

## Version 1.5.0.1

Release Date: October 31, 2006

- Fixed a problem in which duplicate attempts to load helpers and classes were not being stopped.
- Fixed a bug in the word_wrap() helper function.
- Fixed an invalid color Hex number in the Profiler class.
- Fixed a corrupted image in the user guide.

## Version 1.5.0

Release Date: October 30, 2006

- Added DB utility class, permitting DB backups, CVS or XML files from DB results, and various other functions.
- Added Database Caching Class.
- Added transaction support to the database classes.
- Added Profiler Class which generates a report of Benchmark execution times, queries, and POST data at the bottom of your pages.
- Added User Agent Library which allows browsers, robots, and mobile devises to be identified.
- Added HTML Table Class , enabling tables to be generated from arrays or database results.
- Added Zip Encoding Library.
- Added FTP Library.
- Added the ability to extend libraries and extend core classes, in addition to being able to replace them.
- Added support for storing models within sub-folders.
- Added Download Helper.
- Added simple_query() function to the database classes
- Added standard_date() function to the Date Helper.
- Added $query->free_result() to database class.
- Added $query->list_fields() function to database class
- Added $this->db->platform() function
- Added new File Helper: get_filenames()
- Added new helper: Smiley Helper
- Added support for <ul> and <ol> lists in the HTML Helper
- Added the ability to rewrite short tags on-the-fly, converting them to standard PHP statements, for those servers that do not support short tags. This allows the cleaner syntax to be used regardless of whether it's supported by the server.
- Added the ability to rename or relocate the "application" folder.
- Added more thorough initialization in the upload class so that all class variables are reset.
- Added "is_numeric" to validation, which uses the native PHP is_numeric function.
- Improved the URI handler to make it more reliable when the $config['uri_protocol'] item is set to AUTO.
- Moved most of the functions in the Controller class into the Loader class, allowing fewer reserved function names for controllers when running under PHP 5.
- Updated the DB Result class to return an empty array when $query->result() doesn't produce a result.
- Updated the input->cookie() and input->post() functions in Input Class to permit arrays contained cookies that are arrays to be run through the XSS filter.
- Documented three functions from the Validation class that were missing from the user guide: set_select(), set_radio(), and set_checkbox().
- Fixed a bug in the Email class related to SMTP Helo data.
- Fixed a bug in the word wrapping helper and function in the email class.
- Fixed a bug in the validation class.
- Fixed a bug in the typography helper that was incorrectly wrapping block level elements in paragraph tags.
- Fixed a problem in the form_prep() function that was double encoding entities.
- Fixed a bug that affects some versions of PHP when output buffering is nested.
- Fixed a bug that caused CI to stop working when the PHP magic __get() or __set() functions were used within models or controllers.
- Fixed a pagination bug that was permitting negative values in the URL.
- Fixed an oversight in which the Loader class was not allowed to be exteneded.
- Changed _get_config() to get_config() since the function is not a private one.
- Deprecated "init" folder. Initialization happens automatically now. Please see documentation.
- Deprecated $this->db->field_names() USE $this->db->list_fields()
- Deprecated the $config['log_errors'] item from the config.php file. Instead, $config['log_threshold'] can be set to "0" to turn it off.

## Version 1.4.1

Release Date: September 21, 2006

- Added a new feature that passes URI segments directly to your function calls as parameters. See the Controllers page for more info.
- Added support for a function named _output(), which when used in your controllers will received the final rendered output from the output class. More info in the Controllers page.
- Added several new functions in the URI Class to let you retrieve and manipulate URI segments that have been re-routed using the URI Routing feature. Previously, the URI class did not permit you to access any re-routed URI segments, but now it does.
- Added $this->output->set_header() function, which allows you to set server headers.
- Updated plugins, helpers, and language classes to allow your application folder to contain its own plugins, helpers, and language folders. Previously they were always treated as global for your entire installation. If your application folder contains any of these resources they will be used instead the global ones.
- Added Inflector helper.
- Added element() function in the array helper.
- Added RAND() to active record orderby() function.
- Added delete_cookie() and get_cookie() to Cookie helper, even though the input class has a cookie fetching function.
- Added Oracle database driver (still undergoing testing so it might have some bugs).
- Added the ability to combine pseudo-variables and php variables in the template parser class.
- Added output compression option to the config file.
- Removed the is_numeric test from the db->escape() function.
- Fixed a MySQLi bug that was causing error messages not to contain proper error data.
- Fixed a bug in the email class which was causing it to ignore explicitly set alternative headers.
- Fixed a bug that was causing a PHP error when the Exceptions class was called within the get_config() function since it was causing problems.
- Fixed an oversight in the cookie helper in which the config file cookie settings were not being honored.
- Fixed an oversight in the upload class. An item mentioned in the 1.4 changelog was missing.
- Added some code to allow email attachments to be reset when sending batches of email.
- Deprecated the application/scripts folder. It will continue to work for legacy users, but it is recommended that you create your own libraries or models instead. It was originally added before CI had user libraries or models, but it's not needed anymore.
- Deprecated the $autoload['core'] item from the `autoload.php` file. Instead, please now use: `$autoload['libraries']`
- Deprecated the following database functions: $this->db->smart_escape_str() and $this->db->fields().

## Version 1.4.0

Release Date: September 17, 2006

- Added Hooks feature, enabling you to tap into and modify the inner workings of the framework without hacking the core files.
- Added the ability to organize controller files into sub-folders. Kudos to Marco for suggesting this (and the next two) feature.
- Added regular expressions support for routing rules.
- Added the ability to remap function calls within your controllers.
- Added the ability to replace core system classes with your own classes.
- Added support for % character in URL.
- Added the ability to supply full URLs using the anchor() helper function.
- Added mode parameter to file_write() helper.
- Added support for changing the port number in the Postgre driver.
- Moved the list of "allowed URI characters" out of the Router class and into the config file.
- Moved the MIME type array out of the Upload class and into its own file in the applications/config/ folder.
- Updated the Upload class to allow the upload field name to be set when calling do_upload().
- Updated the Config Library to be able to load config files silently, and to be able to assign config files to their own index (to avoid collisions if you use multiple config files).
- Updated the URI Protocol code to allow more options so that URLs will work more reliably in different environments.
- Updated the form_open() helper to allow the GET method to be used.
- Updated the MySQLi execute() function with some code to help prevent lost connection errors.
- Updated the SQLite Driver to check for object support before attempting to return results as objects. If unsupported it returns an array.
- Updated the Models loader function to allow multiple loads of the same model.
- Updated the MS SQL driver so that single quotes are escaped.
- Updated the Postgre and ODBC drivers for better compatibility.
- Removed a strtolower() call that was changing URL segments to lower case.
- Removed some references that were interfering with PHP 4.4.1 compatibility.
- Removed backticks from Postgre class since these are not needed.
- Renamed display() to _display() in the Output class to make it clear that it's a private function.
- Deprecated the hash() function due to a naming conflict with a native PHP function with the same name. Please use `dohash()` instead.
- Fixed an bug that was preventing the input class from unsetting GET variables.
- Fixed a router bug that was making it too greedy when matching end segments.
- Fixed a bug that was preventing multiple discreet database calls.
- Fixed a bug in which loading a language file was producing a "file contains no data" message.
- Fixed a session bug caused by the XSS Filtering feature inadvertently changing the case of certain words.
- Fixed some missing prefixes when using the database prefix feature.
- Fixed a typo in the Calendar class (cal_november).
- Fixed a bug in the form_checkbox() helper.
- Fixed a bug that was allowing the second segment of the URI to be identical to the class name.
- Fixed an evaluation bug in the database initialization function.
- Fixed a minor bug in one of the error messages in the language class.
- Fixed a bug in the date helper timespan function.
- Fixed an undefined variable in the DB Driver class.
- Fixed a bug in which dollar signs used as binding replacement values in the DB class would be treated as RegEx back-references.
- Fixed a bug in the set_hash() function which was preventing MD5 from being used.
- Fixed a couple bugs in the Unit Testing class.
- Fixed an incorrectly named variable in the Validation class.
- Fixed an incorrectly named variable in the URI class.
- Fixed a bug in the config class that was preventing the base URL from being called properly.
- Fixed a bug in the validation class that was not permitting callbacks if the form field was empty.
- Fixed a problem that was preventing scaffolding from working properly with MySQLi.
- Fixed some MS SQL bugs.
- Fixed some doc typos.

## Version 1.3.3

Release Date: June 1, 2006

- Models do not connect automatically to the database as of this version. More info here.
- Updated the Sessions class to utilize the active record class when running session related queries. Previously the queries assumed MySQL syntax.
- Updated alternator() function to re-initialize when called with no arguments, allowing multiple calls.
- Fixed a bug in the active record "having" function.
- Fixed a problem in the validation class which was making checkboxes be ignored when required.
- Fixed a bug in the word_limiter() helper function. It was cutting off the fist word.
- Fixed a bug in the xss_clean function due to a PHP bug that affects some versions of html_entity_decode.
- Fixed a validation bug that was preventing rules from being set twice in one controller.
- Fixed a calendar bug that was not letting it use dynamically loaded languages.
- Fixed a bug in the active record class when using WHERE clauses with LIKE
- Fixed a bug in the hash() security helper.
- Fixed some typos.

## Version 1.3.2

Release Date: April 17, 2006

- Changed the behavior of the validation class such that if a "required" rule is NOT explicitly stated for a field then all other tests get ignored.
- Fixed a bug in the Controller class that was causing it to look in the local "init" folder instead of the main system one.
- Fixed a bug in the init_pagination file. The $config item was not being set correctly.
- Fixed a bug in the auto typography helper that was causing inconsistent behavior.
- Fixed a couple bugs in the Model class.
- Fixed some documentation typos and errata.

## Version 1.3.1

Release Date: April 11, 2006

- Added a Unit Testing Library.
- Added the ability to pass objects to the insert() and update() database functions. This feature enables you to (among other things) use your Model class variables to run queries with. See the Models page for details.
- Added the ability to pass objects to the view loading function: $this->load->view('my_view', $object);
- Added `getwhere` function to Active Record class.
- Added `count_all` function to Active Record class.
- Added language file for scaffolding and fixed a scaffolding bug that occurs when there are no rows in the specified table.
- Added $this->db->last_query(), which allows you to view your last query that was run.
- Added a new mime type to the upload class for better compatibility.
- Changed how cache files are read to prevent PHP errors if the cache file contains an XML tag, which PHP wants to interpret as a short tag.
- Fixed a bug in a couple of the active record functions (where and orderby).
- Fixed a bug in the image library when realpath() returns false.
- Fixed a bug in the Models that was preventing libraries from being used within them.
- Fixed a bug in the "exact_length" function of the validation class.
- Fixed some typos in the user guide

## Version 1.3

Release Date: April 3, 2006

- Added support for Models.
- Redesigned the database libraries to support additional RDBMs (Postgre, MySQLi, etc.).
- Redesigned the Active Record class to enable more varied types of queries with simpler syntax, and advanced features like JOINs.
- Added a feature to the database class that lets you run custom function calls.
- Added support for private functions in your controllers. Any controller function name that starts with an underscore will not be served by a URI request.
- Added the ability to pass your own initialization parameters to your custom core libraries when using $this->load->library()
- Added support for running standard query string URLs. These can be optionally enabled in your config file.
- Added the ability to specify a "suffix", which will be appended to your URLs. For example, you could add .html to your URLs, making them appear static. This feature is enabled in your config file.
- Added a new error template for use with native PHP errors.
- Added "alternator" function in the string helpers.
- Removed slashing from the input class. After much debate we decided to kill this feature.
- Change the commenting style in the scripts to the PEAR standard so that IDEs and tools like phpDocumenter can harvest the comments.
- Added better class and function name-spacing to avoid collisions with user developed classes. All CodeIgniter classes are now prefixed with CI_ and all controller methods are prefixed with _ci to avoid controller collisions. A list of reserved function names can be found here.
- Redesigned how the "CI" super object is referenced, depending on whether PHP 4 or 5 is being run, since PHP 5 allows a more graceful way to manage objects that utilizes a bit less resources.
- Deprecated: $this->db->use_table() has been deprecated. Please read the Active Record page for information.
- Deprecated: $this->db->smart_escape_str() has been deprecated. Please use this instead: $this->db->escape()
- Fixed a bug in the exception handler which was preventing some PHP errors from showing up.
- Fixed a typo in the URI class. $this->total_segment() should be plural: $this->total_segments()
- Fixed some typos in the default calendar template
- Fixed some typos in the user guide

## Version 1.2

Release Date: March 21, 2006

- Redesigned some internal aspects of the framework to resolve scoping problems that surfaced during the beta tests. The problem was most notable when instantiating classes in your constructors, particularly if those classes in turn did work in their constructors.
- Added a global function named get_instance() allowing the main CodeIgniter object to be accessible throughout your own classes.
- Added new File Helper: delete_files()
- Added new URL Helpers: base_url(), index_page()
- Added the ability to create your own core libraries and store them in your local application directory.
- Added an `overwrite` option to the Upload class, enabling files to be overwritten rather than having the file name appended.
- Added Javascript Calendar plugin.
- Added search feature to user guide. Note: This is done using Google, which at the time of this writing has not crawled all the pages of the docs.
- Updated the parser class so that it allows tag pars within other tag pairs.
- Fixed a bug in the DB "where" function.
- Fixed a bug that was preventing custom config files to be auto-loaded.
- Fixed a bug in the mysql class bind feature that prevented question marks in the replacement data.
- Fixed some bugs in the xss_clean function

## Version Beta 1.1

Release Date: March 10, 2006

- Added a Calendaring class.
- Added support for running multiple applications that share a common CodeIgniter backend.
- Moved the "uri protocol" variable from the index.php file into the config.php file
- Fixed a problem that was preventing certain function calls from working within constructors.
- Fixed a problem that was preventing the $this->load->library function from working in constructors.
- Fixed a bug that occurred when the session class was loaded using the auto-load routine.
- Fixed a bug that can happen with PHP versions that do not support the E_STRICT constant
- Fixed a data type error in the form_radio function (form helper)
- Fixed a bug that was preventing the xss_clean function from being called from the validation class.
- Fixed the cookie related config names, which were incorrectly specified as $conf rather than $config
- Fixed a pagination problem in the scaffolding.
- Fixed a bug in the mysql class "where" function.
- Fixed a regex problem in some code that trimmed duplicate slashes.
- Fixed a bug in the br() function in the HTML helper
- Fixed a syntax mistake in the form_dropdown function in the Form Helper.
- Removed the "style" attributes form the form helpers.
- Updated the documentation. Added "next/previous" links to each page and fixed various typos.

## Version Beta 1.0

Release Date: February 28, 2006

First publicly released version.