diff --git a/README.md b/README.md index 145bdd0..8dfbfb2 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,18 @@ Simple source code for learning basic backend developer using REST API (login, C # Setup Download or clone [Master File](simple-codeigniter-rest-api) -and then config & import MySQL database +and then config & import database: + +-MySQL +-PostgreSQL + You can use [POSTMAN](https://www.getpostman.com/) or anything else for simulate frontend # Test the API You can test the API by including header `Content-Type`,`Client-Service` & `Auth-Key` with value `application/json`,`frontend-client` & `simplerestapi` in every request -And for API except `login` you must include `id` & `token` that you get after successfully login. The header for both look like this `User-ID` & `Authorization` +And for API except `login` you must include `id` & `token` that you get after successfully login. The header for both look like this `User` & `Authorization` List of the API : diff --git a/application/config/database.php b/application/config/database.php index 461d742..ebcc999 100755 --- a/application/config/database.php +++ b/application/config/database.php @@ -72,12 +72,12 @@ */ $active_group = 'default'; $query_builder = TRUE; - +/* $db['default'] = array( 'dsn' => '', 'hostname' => 'localhost', 'username' => 'root', - 'password' => 'root', + 'password' => '', 'database' => 'ci_rest_api', 'dbdriver' => 'mysqli', 'dbprefix' => '', @@ -94,3 +94,26 @@ 'failover' => array(), 'save_queries' => TRUE ); +*/ + +$db['default'] = array( + 'dsn' => '', + 'hostname' => 'localhost', + 'username' => 'andabral', + 'password' => 'Prueba', + 'database' => 'ci_rest_api', + 'dbdriver' => 'postgre', + 'dbprefix' => '', + 'pconnect' => FALSE, + 'db_debug' => (ENVIRONMENT !== 'production'), + 'cache_on' => FALSE, + 'cachedir' => '', + 'char_set' => 'utf8', + 'dbcollat' => 'utf8_general_ci', + 'swap_pre' => '', + 'encrypt' => FALSE, + 'compress' => FALSE, + 'stricton' => FALSE, + 'failover' => array(), + 'save_queries' => TRUE +); \ No newline at end of file diff --git a/application/models/MyModel.php b/application/models/MyModel.php index 92125d5..78af073 100644 --- a/application/models/MyModel.php +++ b/application/models/MyModel.php @@ -1,6 +1,6 @@ password; $id = $q->id; if (hash_equals($hashed_password, crypt($password, $hashed_password))) { - $last_login = date('Y-m-d H:i:s'); - $token = crypt(substr( md5(rand()), 0, 7)); - $expired_at = date("Y-m-d H:i:s", strtotime('+12 hours')); - $this->db->trans_start(); - $this->db->where('id',$id)->update('users',array('last_login' => $last_login)); - $this->db->insert('users_authentication',array('users_id' => $id,'token' => $token,'expired_at' => $expired_at)); - if ($this->db->trans_status() === FALSE){ - $this->db->trans_rollback(); - return array('status' => 500,'message' => 'Internal server error.'); - } else { - $this->db->trans_commit(); - return array('status' => 200,'message' => 'Successfully login.','id' => $id, 'token' => $token); - } + $obj_ua = $this->db->from('users_authentication')->where('users_id',$q->id)->where('estado = 1')->get(); + + $last_login = date('Y-m-d H:i:s'); + + if($obj_ua->num_rows() > 0){ + $ua=$obj_ua->row(); + //print_r($ua); + //echo "
".$last_login; + //echo "
".$ua->expired_at; + if(strtotime($last_login) <= strtotime($ua->expired_at) ){ + return array('status' => 200,'message' => 'Token was generated which expires on '.$ua->expired_at,'user' => $username, 'token' => $ua->token); + }else{ + $this->db->where('users_id',$id)->update('users_authentication',array('estado' => 0)); + $token = crypt(substr( md5(rand()), 0, 7),'$5$rounds=5000$fragatausesystringforsalt$'); + echo $expired_at = date("Y-m-d H:i:s", strtotime('+12 hours')); + $this->db->trans_start(); + $this->db->where('id',$id)->update('users',array('last_login' => $last_login)); + $this->db->insert('users_authentication',array('users_id' => $id,'token' => $token,'expired_at' => $expired_at)); + if ($this->db->trans_status() === FALSE){ + $this->db->trans_rollback(); + return array('status' => 500,'message' => 'Internal server error.'); + } else { + $this->db->trans_commit(); + return array('status' => 200,'message' => 'Successfully login.','user' => $username, 'token' => $token); + } + } + }else{ + $token = crypt(substr( md5(rand()), 0, 7),'$5$rounds=5000$fragatausesystringforsalt$'); + $expired_at = date("Y-m-d H:i:s", strtotime('+12 hours')); + $this->db->trans_start(); + $this->db->where('id',$id)->update('users',array('last_login' => $last_login)); + $this->db->insert('users_authentication',array('users_id' => $id,'token' => $token,'expired_at' => $expired_at)); + if ($this->db->trans_status() === FALSE){ + $this->db->trans_rollback(); + return array('status' => 500,'message' => 'Internal server error.'); + } else { + $this->db->trans_commit(); + return array('status' => 200,'message' => 'Successfully login.','user' => $username, 'token' => $token); + } + } } else { return array('status' => 204,'message' => 'Wrong password.'); } @@ -46,7 +73,7 @@ public function login($username,$password) public function logout() { - $users_id = $this->input->get_request_header('User-ID', TRUE); + $users_id = $this->input->get_request_header('User', TRUE); $token = $this->input->get_request_header('Authorization', TRUE); $this->db->where('users_id',$users_id)->where('token',$token)->delete('users_authentication'); return array('status' => 200,'message' => 'Successfully logout.'); @@ -54,18 +81,19 @@ public function logout() public function auth() { - $users_id = $this->input->get_request_header('User-ID', TRUE); + $user = $this->input->get_request_header('User', TRUE); $token = $this->input->get_request_header('Authorization', TRUE); - $q = $this->db->select('expired_at')->from('users_authentication')->where('users_id',$users_id)->where('token',$token)->get()->row(); + $o = $this->db->select('id')->from('users')->where('username',$user)->get()->row(); + $q = $this->db->select('expired_at')->from('users_authentication')->where('users_id',$o->id)->where('token',$token)->get()->row(); if($q == ""){ return json_output(401,array('status' => 401,'message' => 'Unauthorized.')); } else { - if($q->expired_at < date('Y-m-d H:i:s')){ + if(strtotime($q->expired_at) < strtotime(date('Y-m-d H:i:s'))){echo $q->expired_at ."
".date('Y-m-d H:i:s'); return json_output(401,array('status' => 401,'message' => 'Your session has been expired.')); } else { $updated_at = date('Y-m-d H:i:s'); $expired_at = date("Y-m-d H:i:s", strtotime('+12 hours')); - $this->db->where('users_id',$users_id)->where('token',$token)->update('users_authentication',array('expired_at' => $expired_at,'updated_at' => $updated_at)); + $this->db->where('users_id',$o->id)->where('token',$token)->update('users_authentication',array('expired_at' => $expired_at,'updated_at' => $updated_at)); return array('status' => 200,'message' => 'Authorized.'); } } diff --git a/ci_rest_api.sql b/ci_rest_api.sql index a265a2b..bd7ec1e 100644 --- a/ci_rest_api.sql +++ b/ci_rest_api.sql @@ -1,134 +1,80 @@ --- phpMyAdmin SQL Dump --- version 4.5.1 --- http://www.phpmyadmin.net --- --- Host: localhost --- Generation Time: Dec 27, 2015 at 04:41 AM --- Server version: 10.1.9-MariaDB --- PHP Version: 5.5.30 - -SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO"; -SET time_zone = "+00:00"; - - -/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */; -/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */; -/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */; -/*!40101 SET NAMES utf8mb4 */; - --- --- Database: `ci_rest_api` --- - --- -------------------------------------------------------- - --- --- Table structure for table `books` --- - -CREATE TABLE `books` ( - `id` int(11) NOT NULL, - `title` varchar(255) NOT NULL, - `author` varchar(255) NOT NULL, +/* + Navicat Premium Data Transfer + + Source Server : localMy + Source Server Type : MySQL + Source Server Version : 50736 (5.7.36) + Source Host : localhost:3306 + Source Schema : ci_rest_api + + Target Server Type : MySQL + Target Server Version : 50736 (5.7.36) + File Encoding : 65001 + + Date: 06/05/2023 15:27:03 +*/ + +SET NAMES utf8mb4; +SET FOREIGN_KEY_CHECKS = 0; + +-- ---------------------------- +-- Table structure for books +-- ---------------------------- +DROP TABLE IF EXISTS `books`; +CREATE TABLE `books` ( + `id` int(11) NOT NULL AUTO_INCREMENT, + `title` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL, + `author` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL, `created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, - `updated_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP -) ENGINE=InnoDB DEFAULT CHARSET=utf8; - --- --- Dumping data for table `books` --- - -INSERT INTO `books` (`id`, `title`, `author`, `created_at`, `updated_at`) VALUES -(1, 'Codeigniter Rest API', 'Momo Baruno', '2015-12-26 09:17:14', '2015-12-26 09:17:14'); - --- -------------------------------------------------------- - --- --- Table structure for table `users` --- - -CREATE TABLE `users` ( - `id` int(11) NOT NULL, - `username` varchar(255) NOT NULL, - `password` varchar(255) NOT NULL, - `name` varchar(255) NOT NULL, + `updated_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, + PRIMARY KEY (`id`) USING BTREE +) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Compact; + +-- ---------------------------- +-- Records of books +-- ---------------------------- +INSERT INTO `books` VALUES (1, 'Codeigniter Rest API', 'Momo Baruno', '2015-12-26 09:17:14', '2015-12-26 09:17:14'); + +-- ---------------------------- +-- Table structure for users +-- ---------------------------- +DROP TABLE IF EXISTS `users`; +CREATE TABLE `users` ( + `id` int(11) NOT NULL AUTO_INCREMENT, + `username` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL, + `password` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL, + `name` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL, `last_login` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, `created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, - `updated_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP -) ENGINE=InnoDB DEFAULT CHARSET=utf8; - --- --- Dumping data for table `users` --- - -INSERT INTO `users` (`id`, `username`, `password`, `name`, `last_login`, `created_at`, `updated_at`) VALUES -(1, 'admin', '$1$Dtqyvz7/$wZSaZbfHgn0UbLlVi1HHp0', 'Admin', '2015-12-27 11:30:55', '2015-12-25 10:35:16', '2015-12-25 10:35:16'); - --- -------------------------------------------------------- - --- --- Table structure for table `users_authentication` --- - -CREATE TABLE `users_authentication` ( - `id` int(11) NOT NULL, + `updated_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, + PRIMARY KEY (`id`) USING BTREE, + UNIQUE INDEX `username`(`username`) USING BTREE +) ENGINE = InnoDB AUTO_INCREMENT = 2 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Compact; + +-- ---------------------------- +-- Records of users +-- ---------------------------- +INSERT INTO `users` VALUES (1, 'admin', '$1$Dtqyvz7/$wZSaZbfHgn0UbLlVi1HHp0', 'Admin', '2023-05-06 13:00:24', '2015-12-25 10:35:16', '2015-12-25 10:35:16'); + +-- ---------------------------- +-- Table structure for users_authentication +-- ---------------------------- +DROP TABLE IF EXISTS `users_authentication`; +CREATE TABLE `users_authentication` ( + `id` int(11) NOT NULL AUTO_INCREMENT, `users_id` int(11) NOT NULL, - `token` varchar(255) NOT NULL, + `token` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL, + `estado` smallint(5) UNSIGNED NOT NULL DEFAULT 1, `expired_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, `created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, - `updated_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP -) ENGINE=InnoDB DEFAULT CHARSET=utf8; - --- --- Dumping data for table `users_authentication` --- - -INSERT INTO `users_authentication` (`id`, `users_id`, `token`, `expired_at`, `created_at`, `updated_at`) VALUES -(1, 1, '$1$6fjNSBRR$7lx.mxo/q1LbNO7f5.7w8.', '2015-12-27 23:28:00', '2015-12-27 11:28:00', '2015-12-27 11:28:00'), -(2, 1, '$1$HY2H7rB0$2U.dlCsoHX21s/gvjCypG/', '2015-12-27 23:28:10', '2015-12-27 11:28:10', '2015-12-27 11:28:10'); - --- --- Indexes for dumped tables --- - --- --- Indexes for table `books` --- -ALTER TABLE `books` - ADD PRIMARY KEY (`id`); - --- --- Indexes for table `users` --- -ALTER TABLE `users` - ADD PRIMARY KEY (`id`), - ADD KEY `username` (`username`); - --- --- Indexes for table `users_authentication` --- -ALTER TABLE `users_authentication` - ADD PRIMARY KEY (`id`); + `updated_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, + PRIMARY KEY (`id`) USING BTREE +) ENGINE = InnoDB AUTO_INCREMENT = 3 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Compact; --- --- AUTO_INCREMENT for dumped tables --- +-- ---------------------------- +-- Records of users_authentication +-- ---------------------------- +INSERT INTO `users_authentication` VALUES (1, 1, '$5$rounds=5000$fragatausesystri$oVIBWXz7KrcRndHOW/c3nAFakbirPfPsmq32.2YxL58', 0, '2023-05-06 13:00:23', '2023-05-06 12:34:23', '2023-05-06 12:34:23'); +INSERT INTO `users_authentication` VALUES (2, 1, '$5$rounds=5000$fragatausesystri$M1rDx1Do0I..fQQuqPTpFa29Rr4bXTATQwJ.K086R51', 1, '2023-05-07 02:43:25', '2023-05-06 13:00:24', '2023-05-06 14:43:25'); --- --- AUTO_INCREMENT for table `books` --- -ALTER TABLE `books` - MODIFY `id` int(11) NOT NULL AUTO_INCREMENT, AUTO_INCREMENT=3; --- --- AUTO_INCREMENT for table `users` --- -ALTER TABLE `users` - MODIFY `id` int(11) NOT NULL AUTO_INCREMENT, AUTO_INCREMENT=2; --- --- AUTO_INCREMENT for table `users_authentication` --- -ALTER TABLE `users_authentication` - MODIFY `id` int(11) NOT NULL AUTO_INCREMENT, AUTO_INCREMENT=4; -/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */; -/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */; -/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */; +SET FOREIGN_KEY_CHECKS = 1; diff --git a/ci_rest_api_postgresql.sql b/ci_rest_api_postgresql.sql new file mode 100644 index 0000000..d13be74 --- /dev/null +++ b/ci_rest_api_postgresql.sql @@ -0,0 +1,177 @@ +-- +-- PostgreSQL database dump +-- + +-- Dumped from database version 13.4 +-- Dumped by pg_dump version 13.4 + +SET statement_timeout = 0; +SET lock_timeout = 0; +SET idle_in_transaction_session_timeout = 0; +SET client_encoding = 'UTF8'; +SET standard_conforming_strings = on; +SELECT pg_catalog.set_config('search_path', '', false); +SET check_function_bodies = false; +SET xmloption = content; +SET client_min_messages = warning; +SET row_security = off; + +-- +-- Name: id_books_seq; Type: SEQUENCE; Schema: public; Owner: andabral +-- + +CREATE SEQUENCE public.id_books_seq + START WITH 1 + INCREMENT BY 1 + NO MINVALUE + NO MAXVALUE + CACHE 1; + + +ALTER TABLE public.id_books_seq OWNER TO andabral; + +SET default_tablespace = ''; + +SET default_table_access_method = heap; + +-- +-- Name: books; Type: TABLE; Schema: public; Owner: andabral +-- + +CREATE TABLE public.books ( + id integer DEFAULT nextval('public.id_books_seq'::regclass) NOT NULL, + title character varying(255) NOT NULL, + author character varying(255) NOT NULL, + created_at timestamp without time zone DEFAULT LOCALTIMESTAMP(0) NOT NULL, + updated_at timestamp without time zone DEFAULT LOCALTIMESTAMP(0) NOT NULL +); + + +ALTER TABLE public.books OWNER TO andabral; + +-- +-- Name: id_users_authentication_seq; Type: SEQUENCE; Schema: public; Owner: andabral +-- + +CREATE SEQUENCE public.id_users_authentication_seq + START WITH 1 + INCREMENT BY 1 + NO MINVALUE + NO MAXVALUE + CACHE 1; + + +ALTER TABLE public.id_users_authentication_seq OWNER TO andabral; + +-- +-- Name: users; Type: TABLE; Schema: public; Owner: andabral +-- + +CREATE TABLE public.users ( + id integer NOT NULL, + username character varying(255) NOT NULL, + password character varying(255) NOT NULL, + name character varying(255) NOT NULL, + last_login timestamp without time zone NOT NULL, + created_at timestamp without time zone NOT NULL, + updated_at timestamp without time zone NOT NULL +); + + +ALTER TABLE public.users OWNER TO andabral; + +-- +-- Name: users_authentication; Type: TABLE; Schema: public; Owner: andabral +-- + +CREATE TABLE public.users_authentication ( + id integer DEFAULT nextval('public.id_users_authentication_seq'::regclass) NOT NULL, + users_id integer NOT NULL, + token character varying(255) NOT NULL, + estado smallint DEFAULT 1 NOT NULL, + expired_at timestamp without time zone NOT NULL, + created_at timestamp without time zone DEFAULT LOCALTIMESTAMP(0) NOT NULL, + updated_at timestamp without time zone DEFAULT LOCALTIMESTAMP(0) NOT NULL +); + + +ALTER TABLE public.users_authentication OWNER TO andabral; + +-- +-- Data for Name: books; Type: TABLE DATA; Schema: public; Owner: andabral +-- + +INSERT INTO public.books VALUES (1, 'Mami', 'Admin123$', '2023-05-06 20:17:00', '2023-05-06 20:17:00'); + + +-- +-- Data for Name: users; Type: TABLE DATA; Schema: public; Owner: andabral +-- + +INSERT INTO public.users VALUES (1, 'admin', '$1$Dtqyvz7/$wZSaZbfHgn0UbLlVi1HHp0', 'Admin', '2023-05-06 20:12:45', '2015-12-25 10:35:16', '2015-12-25 10:35:16'); + + +-- +-- Data for Name: users_authentication; Type: TABLE DATA; Schema: public; Owner: andabral +-- + +INSERT INTO public.users_authentication VALUES (4, 1, '$5$rounds=5000$fragatausesystri$QOhYJQH1JbJDXY4uzQl4q8mWfv1/VIGNV46wV3ysfJ4', 1, '2023-05-07 08:17:00', '2023-05-06 20:12:45', '2023-05-06 20:17:00'); + + +-- +-- Name: id_books_seq; Type: SEQUENCE SET; Schema: public; Owner: andabral +-- + +SELECT pg_catalog.setval('public.id_books_seq', 1, true); + + +-- +-- Name: id_users_authentication_seq; Type: SEQUENCE SET; Schema: public; Owner: andabral +-- + +SELECT pg_catalog.setval('public.id_users_authentication_seq', 4, true); + + +-- +-- Name: users_authentication _copy_1; Type: CONSTRAINT; Schema: public; Owner: andabral +-- + +ALTER TABLE ONLY public.users_authentication + ADD CONSTRAINT _copy_1 PRIMARY KEY (id); + + +-- +-- Name: users _copy_2; Type: CONSTRAINT; Schema: public; Owner: andabral +-- + +ALTER TABLE ONLY public.users + ADD CONSTRAINT _copy_2 PRIMARY KEY (id); + + +-- +-- Name: books books_pkey; Type: CONSTRAINT; Schema: public; Owner: andabral +-- + +ALTER TABLE ONLY public.books + ADD CONSTRAINT books_pkey PRIMARY KEY (id); + + +-- +-- Name: username; Type: INDEX; Schema: public; Owner: andabral +-- + +CREATE UNIQUE INDEX username ON public.users USING btree (username); + + +-- +-- Name: users_authentication fk_users_authentication_users_1; Type: FK CONSTRAINT; Schema: public; Owner: andabral +-- + +ALTER TABLE ONLY public.users_authentication + ADD CONSTRAINT fk_users_authentication_users_1 FOREIGN KEY (users_id) REFERENCES public.users(id); + + +-- +-- PostgreSQL database dump complete +-- + diff --git a/user_guide/.buildinfo b/user_guide/.buildinfo deleted file mode 100755 index 99d9d85..0000000 --- a/user_guide/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 103a80b9dd782a05507c3eddad9efb74 -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/user_guide/DCO.html b/user_guide/DCO.html deleted file mode 100755 index 7a88483..0000000 --- a/user_guide/DCO.html +++ /dev/null @@ -1,515 +0,0 @@ - - - - - - - - - - Developer’s Certificate of Origin 1.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
-
-
    -
  • Docs »
    • - -
  • Developer’s Certificate of Origin 1.1
    • -
  • - -
    • -
    - classic layout -
    -
-
-
-
- -
-

Developer’s Certificate of Origin 1.1

-

By making a contribution to this project, I certify that:

-
    -
  1. The contribution was created in whole or in part by me and I -have the right to submit it under the open source license -indicated in the file; or
    2. -
  2. The contribution is based upon previous work that, to the best -of my knowledge, is covered under an appropriate open source -license and I have the right under that license to submit that -work with modifications, whether created in whole or in part -by me, under the same open source license (unless I am -permitted to submit under a different license), as indicated -in the file; or
    3. -
  3. The contribution was provided directly to me by some other -person who certified (1), (2) or (3) and I have not modified -it.
    4. -
  4. I understand and agree that this project and the contribution -are public and that a record of the contribution (including all -personal information I submit with it, including my sign-off) is -maintained indefinitely and may be redistributed consistent with -this project or the open source license(s) involved.
    5. -
-
- - -
- -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/_downloads/ELDocs.tmbundle.zip b/user_guide/_downloads/ELDocs.tmbundle.zip deleted file mode 100755 index f7a11b3..0000000 Binary files a/user_guide/_downloads/ELDocs.tmbundle.zip and /dev/null differ diff --git a/user_guide/_images/appflowchart.gif b/user_guide/_images/appflowchart.gif deleted file mode 100755 index 422332c..0000000 Binary files a/user_guide/_images/appflowchart.gif and /dev/null differ diff --git a/user_guide/_images/smile.gif b/user_guide/_images/smile.gif deleted file mode 100755 index bf09225..0000000 Binary files a/user_guide/_images/smile.gif and /dev/null differ diff --git a/user_guide/_static/ajax-loader.gif b/user_guide/_static/ajax-loader.gif deleted file mode 100755 index 61faf8c..0000000 Binary files a/user_guide/_static/ajax-loader.gif and /dev/null differ diff --git a/user_guide/_static/basic.css b/user_guide/_static/basic.css deleted file mode 100755 index 967e36c..0000000 --- a/user_guide/_static/basic.css +++ /dev/null @@ -1,537 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox input[type="text"] { - width: 170px; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - width: 30px; -} - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable dl, table.indextable dd { - margin-top: 0; - margin-bottom: 0; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- general body styles --------------------------------------------------- */ - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.field-list ul { - padding-left: 1em; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px 7px 0 7px; - background-color: #ffe; - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - border: 0; - border-collapse: collapse; -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -dl { - margin-bottom: 15px; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, .highlighted { - background-color: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.optional { - font-size: 1.3em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -tt.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -tt.descclassname { - background-color: transparent; -} - -tt.xref, a tt { - background-color: transparent; - font-weight: bold; -} - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/user_guide/_static/ci-icon.ico b/user_guide/_static/ci-icon.ico deleted file mode 100755 index 7ecfce2..0000000 Binary files a/user_guide/_static/ci-icon.ico and /dev/null differ diff --git a/user_guide/_static/comment-bright.png b/user_guide/_static/comment-bright.png deleted file mode 100755 index 551517b..0000000 Binary files a/user_guide/_static/comment-bright.png and /dev/null differ diff --git a/user_guide/_static/comment-close.png b/user_guide/_static/comment-close.png deleted file mode 100755 index 09b54be..0000000 Binary files a/user_guide/_static/comment-close.png and /dev/null differ diff --git a/user_guide/_static/comment.png b/user_guide/_static/comment.png deleted file mode 100755 index 92feb52..0000000 Binary files a/user_guide/_static/comment.png and /dev/null differ diff --git a/user_guide/_static/css/badge_only.css b/user_guide/_static/css/badge_only.css deleted file mode 100755 index 7e17fb1..0000000 --- a/user_guide/_static/css/badge_only.css +++ /dev/null @@ -1,2 +0,0 @@ -.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/fontawesome_webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:0.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}} -/*# sourceMappingURL=badge_only.css.map */ diff --git a/user_guide/_static/css/citheme.css b/user_guide/_static/css/citheme.css deleted file mode 100755 index a2a3b3e..0000000 --- a/user_guide/_static/css/citheme.css +++ /dev/null @@ -1,88 +0,0 @@ -@import 'theme.css'; - -.highlighted { - padding: 0px !important; - font-weight: inherit !important; - background-color: #f1d40f !important; -} - -#nav { - background-color: #494949; - margin: 0; - padding: 0; - display: none; -} - -#nav2 { - background: url(data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAMgAzAwERAAIRAQMRAf/EAFkAAQADAQAAAAAAAAAAAAAAAAABBQcIAQEAAAAAAAAAAAAAAAAAAAAAEAABAgYDAAAAAAAAAAAAAAAAAVERAtMEFJRVBxgRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AMRAAAAAAAA7a87dZcCu3e1wHnbrLgV272uA87dZcCu3e1wHnbrLgV272uA87dZcCu3e1wHnbrLgV272uA87dZcCu3e1wN/wJGAYEjAMCRgGBIwDAkYBgSMAwJGAsoIwCCMAgjAIIwCCMAgjAIIwEgAAAAAAAAAAAAAAAAAAAAAAAH//2Q==) repeat-x scroll left top transparent; - margin: 0; - padding: 0 310px 0 0; - text-align: right; - display: none; -} - -#nav_inner { - background-color: transparent; - font-family: Lucida Grande,Verdana,Geneva,sans-serif; - font-size: 11px; - margin: 0; - padding: 8px 12px 0 20px; -} - -div#pulldown-menu { - -moz-column-count: 5; - -moz-column-gap: 20px; - -webkit-column-count: 5; - -webkit-column-gap: 20px; - column-count: 5; - column-gap: 20px; - -webkit-column-rule: 1px groove #b8b8b8; - -moz-column-rule: 1px groove #b8b8b8; - column-rule: 1px groove #b8b8b8; -} - -#pulldown-menu > ul { - padding-top: 10px; - padding-bottom: 10px; - -webkit-column-break-inside: avoid; /*Chrome, Safari*/ - display: table; /*Firefox*/ - break-inside: avoid; /*IE 10+ theoretically*/ -} - -#pulldown-menu ul li.toctree-l2 { - font-size: 0.82em; - margin-left: 20px; - list-style-image: url(data:image/gif;base64,R0lGODlhCwAJALMJAO7u7uTk5PLy8unp6fb29t7e3vj4+Li4uIWFheTk5AAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAAkALAAAAAALAAkAAAQoMJ1JqTQ4Z3SI98jHCWSJkByArCyiHkMsIzEX3DeCc0Xv+4hEa5iIAAA7); -} - -#pulldown-menu ul li.toctree-l1 a { - color: #ffffff; - text-decoration: none; - font-size: 12px; - font-family: "Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif; - font-weight: 700; -} - -#pulldown-menu ul li.toctree-l2 a { - text-decoration: none; - font-size: 11px; - line-height: 1.4em; - font-weight: 300; - font-family: Lucida Grande,Verdana,Geneva,sans-serif; - color: #aaaaaa; -} - -/*hide pulldown menu on mobile devices*/ -@media (max-width: 768px) { /*tablet size defined by theme*/ - #closeMe { - display: none; - } - - #pulldown { - display: none; - } - - #openToc { - display: none; - } -} \ No newline at end of file diff --git a/user_guide/_static/css/theme.css b/user_guide/_static/css/theme.css deleted file mode 100755 index 64d4114..0000000 --- a/user_guide/_static/css/theme.css +++ /dev/null @@ -1,5 +0,0 @@ -*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:0.2em 0;background:#ccc;color:#000;padding:0.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:1.5cm 0.5cm 2.5cm}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}}.fa:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! - * Font Awesome 4.1.0 by @davegandy - http://fontawesome.io - @fontawesome - * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.1.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.1.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff?v=4.1.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.1.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.1.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.icon{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:0.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:0.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.pull-left.icon{margin-right:.3em}.fa.pull-right,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:spin 2s infinite linear;-moz-animation:spin 2s infinite linear;-o-animation:spin 2s infinite linear;animation:spin 2s infinite linear}@-moz-keyframes spin{0%{-moz-transform:rotate(0deg)}100%{-moz-transform:rotate(359deg)}}@-webkit-keyframes spin{0%{-webkit-transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg)}}@-o-keyframes spin{0%{-o-transform:rotate(0deg)}100%{-o-transform:rotate(359deg)}}@keyframes spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=1);-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=3);-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=0);-webkit-transform:scale(-1, 1);-moz-transform:scale(-1, 1);-ms-transform:scale(-1, 1);-o-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:scale(1, -1);-moz-transform:scale(1, -1);-ms-transform:scale(1, -1);-o-transform:scale(1, -1);transform:scale(1, -1)}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-square:before,.fa-pied-piper:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .icon,.nav .fa,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .icon{display:inline}.btn .fa.fa-large,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .fa-large.icon{line-height:0.9em}.btn .fa.fa-spin,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.btn.icon:before{opacity:0.5;-webkit-transition:opacity 0.05s ease-in;-moz-transition:opacity 0.05s ease-in;transition:opacity 0.05s ease-in}.btn.fa:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo{padding:12px;line-height:24px;margin-bottom:24px;background:#dedede}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#8ba8af;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo{background:#dedede}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title{background:#8ba8af}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo{background:#dedede}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title{background:#dd4814}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a{color:#dd4814}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all 0.3s ease-in;-moz-transition:all 0.3s ease-in;transition:all 0.3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#dd4814}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all 0.1s linear;-moz-transition:all 0.1s linear;transition:all 0.1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#dd4814 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#dd4814;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#97310e}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#dd4814;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#dd4814;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 0.3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:68em;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.35765%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:0.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:0.3125em;font-style:italic}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.3s linear}input[type="datetime-local"]{padding:0.34375em 0.625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:0.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#f3f6f6;color:#cad2d3}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:0.5em 0.625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fff;color:#cad2d3;border-color:transparent}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:0.5em 0.625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#dd4814}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:0.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0.3em;display:block}.wy-form label{margin-bottom:0.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:0.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}a{color:#dd4814;text-decoration:none;cursor:pointer}a:hover{color:#97310e}a:visited{color:#97310e}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#dd4814 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc}.codeblock-example{border:1px solid #e1e4e5;border-bottom:none;padding:24px;padding-top:48px;font-weight:500;background:#fff;position:relative}.codeblock-example:after{content:"Example";position:absolute;top:0px;left:0px;background:#97310e;color:#fff;padding:6px 12px}.codeblock-example.prettyprint-example-only{border:1px solid #e1e4e5;margin-bottom:24px}.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight']{border:1px solid #e1e4e5;padding:0px;overflow-x:auto;background:#fff;margin:1px 0 24px 0}.codeblock div[class^='highlight'],pre.literal-block div[class^='highlight'],.rst-content .literal-block div[class^='highlight'],div[class^='highlight'] div[class^='highlight']{border:none;background:none;margin:0}div[class^='highlight'] td.code{width:100%}.linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;color:#d9d9d9}div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;display:block;overflow:auto;color:#404040}@media print{.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight'],div[class^='highlight'] pre{white-space:pre-wrap}}.hll{background-color:#ffc;margin:0 -12px;padding:0 12px;display:block}.c{color:#998;font-style:italic}.err{color:#a61717;background-color:#e3d2d2}.k{font-weight:bold}.o{font-weight:bold}.cm{color:#998;font-style:italic}.cp{color:#999;font-weight:bold}.c1{color:#998;font-style:italic}.cs{color:#999;font-weight:bold;font-style:italic}.gd{color:#000;background-color:#fdd}.gd .x{color:#000;background-color:#faa}.ge{font-style:italic}.gr{color:#a00}.gh{color:#999}.gi{color:#000;background-color:#dfd}.gi .x{color:#000;background-color:#afa}.go{color:#888}.gp{color:#555}.gs{font-weight:bold}.gu{color:purple;font-weight:bold}.gt{color:#a00}.kc{font-weight:bold}.kd{font-weight:bold}.kn{font-weight:bold}.kp{font-weight:bold}.kr{font-weight:bold}.kt{color:#458;font-weight:bold}.m{color:#099}.s{color:#d14}.n{color:#333}.na{color:teal}.nb{color:#0086b3}.nc{color:#458;font-weight:bold}.no{color:teal}.ni{color:purple}.ne{color:#900;font-weight:bold}.nf{color:#900;font-weight:bold}.nn{color:#555}.nt{color:navy}.nv{color:teal}.ow{font-weight:bold}.w{color:#bbb}.mf{color:#099}.mh{color:#099}.mi{color:#099}.mo{color:#099}.sb{color:#d14}.sc{color:#d14}.sd{color:#d14}.s2{color:#d14}.se{color:#d14}.sh{color:#d14}.si{color:#d14}.sx{color:#d14}.sr{color:#009926}.s1{color:#d14}.ss{color:#990073}.bp{color:#999}.vc{color:teal}.vg{color:teal}.vi{color:teal}.il{color:#099}.gc{color:#999;background-color:#EAF2F5}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical header{height:32px;display:inline-block;line-height:32px;padding:0 1.618em;display:block;font-weight:bold;text-transform:uppercase;font-size:80%;color:#dd4814;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:0.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:0.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:0.4045em 2.427em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical .local-toc li ul{display:block}.wy-menu-vertical li ul li a{margin-bottom:0;color:#b3b3b3;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:0.4045em 1.618em;display:block;position:relative;font-size:90%;color:#b3b3b3}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:active{background-color:#dd4814;cursor:pointer;color:#fff}.wy-side-nav-search{z-index:200;background-color:#dd4814;text-align:center;padding:0.809em;display:block;color:#fcfcfc;margin-bottom:0.809em}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#97310e}.wy-side-nav-search img{display:block;margin:auto auto 0.809em auto;height:45px;width:45px;background-color:#dd4814;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:0.809em}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-nav .wy-menu-vertical header{color:#dd4814}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#dd4814;color:#fff}[data-menu-wrap]{-webkit-transition:all 0.2s ease-in;-moz-transition:all 0.2s ease-in;transition:all 0.2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:left repeat-y #fcfcfc;background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxOERBMTRGRDBFMUUxMUUzODUwMkJCOThDMEVFNURFMCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxOERBMTRGRTBFMUUxMUUzODUwMkJCOThDMEVFNURFMCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjE4REExNEZCMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjE4REExNEZDMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+EwrlwAAAAA5JREFUeNpiMDU0BAgwAAE2AJgB9BnaAAAAAElFTkSuQmCC);background-size:300px 1px}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:absolute;top:0;left:0;width:300px;overflow:hidden;min-height:100%;background:#343131;z-index:200}.wy-nav-top{display:none;background:#dd4814;color:#fff;padding:0.4045em 0.809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#dd4814;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100x;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:#999}footer p{margin-bottom:12px}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1400px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}nav.stickynav{position:fixed;top:0}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#dd4814;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}}.rst-content img{max-width:100%;height:auto !important}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .line-block{margin-left:24px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto;display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink{display:none;visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after{visibility:visible;content:"";font-family:FontAwesome;display:inline-block}.rst-content h1:hover .headerlink,.rst-content h2:hover .headerlink,.rst-content h3:hover .headerlink,.rst-content h4:hover .headerlink,.rst-content h5:hover .headerlink,.rst-content h6:hover .headerlink,.rst-content dl dt:hover .headerlink{display:inline-block}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:super;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:#999}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none;padding-top:5px}.rst-content table.field-list td>strong{display:inline-block;margin-top:3px}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left;padding-left:0}.rst-content tt{color:#000}.rst-content tt big,.rst-content tt em{font-size:100% !important;line-height:normal}.rst-content tt .xref,a .rst-content tt{font-weight:bold}.rst-content a tt{color:#dd4814}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:inline-block;margin:6px 0;font-size:90%;line-height:normal;background:#dedede;color:#dd4814;border-top:solid 3px #8ba8af;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#8ba8af}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:gray}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center} -/*# sourceMappingURL=theme.css.map */ diff --git a/user_guide/_static/doctools.js b/user_guide/_static/doctools.js deleted file mode 100755 index c5455c9..0000000 --- a/user_guide/_static/doctools.js +++ /dev/null @@ -1,238 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s == 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node) { - if (node.nodeType == 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { - var span = document.createElement("span"); - span.className = className; - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this); - }); - } - } - return this.each(function() { - highlight(this); - }); -}; - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated == 'undefined') - return string; - return (typeof translated == 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated == 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); - } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) == 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this == '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); diff --git a/user_guide/_static/down-pressed.png b/user_guide/_static/down-pressed.png deleted file mode 100755 index 6f7ad78..0000000 Binary files a/user_guide/_static/down-pressed.png and /dev/null differ diff --git a/user_guide/_static/down.png b/user_guide/_static/down.png deleted file mode 100755 index 3003a88..0000000 Binary files a/user_guide/_static/down.png and /dev/null differ diff --git a/user_guide/_static/file.png b/user_guide/_static/file.png deleted file mode 100755 index d18082e..0000000 Binary files a/user_guide/_static/file.png and /dev/null differ diff --git a/user_guide/_static/fonts/FontAwesome.otf b/user_guide/_static/fonts/FontAwesome.otf deleted file mode 100755 index 8b0f54e..0000000 Binary files a/user_guide/_static/fonts/FontAwesome.otf and /dev/null differ diff --git a/user_guide/_static/fonts/fontawesome-webfont.eot b/user_guide/_static/fonts/fontawesome-webfont.eot deleted file mode 100755 index 7c79c6a..0000000 Binary files a/user_guide/_static/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/user_guide/_static/fonts/fontawesome-webfont.svg b/user_guide/_static/fonts/fontawesome-webfont.svg deleted file mode 100755 index 45fdf33..0000000 --- a/user_guide/_static/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/_static/fonts/fontawesome-webfont.ttf b/user_guide/_static/fonts/fontawesome-webfont.ttf deleted file mode 100755 index e89738d..0000000 Binary files a/user_guide/_static/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/user_guide/_static/fonts/fontawesome-webfont.woff b/user_guide/_static/fonts/fontawesome-webfont.woff deleted file mode 100755 index 8c1748a..0000000 Binary files a/user_guide/_static/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/user_guide/_static/jquery.js b/user_guide/_static/jquery.js deleted file mode 100755 index 83589da..0000000 --- a/user_guide/_static/jquery.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! jQuery v1.8.3 jquery.com | jquery.org/license */ -(function(e,t){function _(e){var t=M[e]={};return v.each(e.split(y),function(e,n){t[n]=!0}),t}function H(e,n,r){if(r===t&&e.nodeType===1){var i="data-"+n.replace(P,"-$1").toLowerCase();r=e.getAttribute(i);if(typeof r=="string"){try{r=r==="true"?!0:r==="false"?!1:r==="null"?null:+r+""===r?+r:D.test(r)?v.parseJSON(r):r}catch(s){}v.data(e,n,r)}else r=t}return r}function B(e){var t;for(t in e){if(t==="data"&&v.isEmptyObject(e[t]))continue;if(t!=="toJSON")return!1}return!0}function et(){return!1}function tt(){return!0}function ut(e){return!e||!e.parentNode||e.parentNode.nodeType===11}function at(e,t){do e=e[t];while(e&&e.nodeType!==1);return e}function ft(e,t,n){t=t||0;if(v.isFunction(t))return v.grep(e,function(e,r){var i=!!t.call(e,r,e);return i===n});if(t.nodeType)return v.grep(e,function(e,r){return e===t===n});if(typeof t=="string"){var r=v.grep(e,function(e){return e.nodeType===1});if(it.test(t))return v.filter(t,r,!n);t=v.filter(t,r)}return v.grep(e,function(e,r){return v.inArray(e,t)>=0===n})}function lt(e){var t=ct.split("|"),n=e.createDocumentFragment();if(n.createElement)while(t.length)n.createElement(t.pop());return n}function Lt(e,t){return e.getElementsByTagName(t)[0]||e.appendChild(e.ownerDocument.createElement(t))}function At(e,t){if(t.nodeType!==1||!v.hasData(e))return;var n,r,i,s=v._data(e),o=v._data(t,s),u=s.events;if(u){delete o.handle,o.events={};for(n in u)for(r=0,i=u[n].length;r").appendTo(i.body),n=t.css("display");t.remove();if(n==="none"||n===""){Pt=i.body.appendChild(Pt||v.extend(i.createElement("iframe"),{frameBorder:0,width:0,height:0}));if(!Ht||!Pt.createElement)Ht=(Pt.contentWindow||Pt.contentDocument).document,Ht.write(""),Ht.close();t=Ht.body.appendChild(Ht.createElement(e)),n=Dt(t,"display"),i.body.removeChild(Pt)}return Wt[e]=n,n}function fn(e,t,n,r){var i;if(v.isArray(t))v.each(t,function(t,i){n||sn.test(e)?r(e,i):fn(e+"["+(typeof i=="object"?t:"")+"]",i,n,r)});else if(!n&&v.type(t)==="object")for(i in t)fn(e+"["+i+"]",t[i],n,r);else r(e,t)}function Cn(e){return function(t,n){typeof t!="string"&&(n=t,t="*");var r,i,s,o=t.toLowerCase().split(y),u=0,a=o.length;if(v.isFunction(n))for(;u)[^>]*$|#([\w\-]*)$)/,E=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,S=/^[\],:{}\s]*$/,x=/(?:^|:|,)(?:\s*\[)+/g,T=/\\(?:["\\\/bfnrt]|u[\da-fA-F]{4})/g,N=/"[^"\\\r\n]*"|true|false|null|-?(?:\d\d*\.|)\d+(?:[eE][\-+]?\d+|)/g,C=/^-ms-/,k=/-([\da-z])/gi,L=function(e,t){return(t+"").toUpperCase()},A=function(){i.addEventListener?(i.removeEventListener("DOMContentLoaded",A,!1),v.ready()):i.readyState==="complete"&&(i.detachEvent("onreadystatechange",A),v.ready())},O={};v.fn=v.prototype={constructor:v,init:function(e,n,r){var s,o,u,a;if(!e)return this;if(e.nodeType)return this.context=this[0]=e,this.length=1,this;if(typeof e=="string"){e.charAt(0)==="<"&&e.charAt(e.length-1)===">"&&e.length>=3?s=[null,e,null]:s=w.exec(e);if(s&&(s[1]||!n)){if(s[1])return n=n instanceof v?n[0]:n,a=n&&n.nodeType?n.ownerDocument||n:i,e=v.parseHTML(s[1],a,!0),E.test(s[1])&&v.isPlainObject(n)&&this.attr.call(e,n,!0),v.merge(this,e);o=i.getElementById(s[2]);if(o&&o.parentNode){if(o.id!==s[2])return r.find(e);this.length=1,this[0]=o}return this.context=i,this.selector=e,this}return!n||n.jquery?(n||r).find(e):this.constructor(n).find(e)}return v.isFunction(e)?r.ready(e):(e.selector!==t&&(this.selector=e.selector,this.context=e.context),v.makeArray(e,this))},selector:"",jquery:"1.8.3",length:0,size:function(){return this.length},toArray:function(){return l.call(this)},get:function(e){return e==null?this.toArray():e<0?this[this.length+e]:this[e]},pushStack:function(e,t,n){var r=v.merge(this.constructor(),e);return r.prevObject=this,r.context=this.context,t==="find"?r.selector=this.selector+(this.selector?" ":"")+n:t&&(r.selector=this.selector+"."+t+"("+n+")"),r},each:function(e,t){return v.each(this,e,t)},ready:function(e){return v.ready.promise().done(e),this},eq:function(e){return e=+e,e===-1?this.slice(e):this.slice(e,e+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(l.apply(this,arguments),"slice",l.call(arguments).join(","))},map:function(e){return this.pushStack(v.map(this,function(t,n){return e.call(t,n,t)}))},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:[].sort,splice:[].splice},v.fn.init.prototype=v.fn,v.extend=v.fn.extend=function(){var e,n,r,i,s,o,u=arguments[0]||{},a=1,f=arguments.length,l=!1;typeof u=="boolean"&&(l=u,u=arguments[1]||{},a=2),typeof u!="object"&&!v.isFunction(u)&&(u={}),f===a&&(u=this,--a);for(;a0)return;r.resolveWith(i,[v]),v.fn.trigger&&v(i).trigger("ready").off("ready")},isFunction:function(e){return v.type(e)==="function"},isArray:Array.isArray||function(e){return v.type(e)==="array"},isWindow:function(e){return e!=null&&e==e.window},isNumeric:function(e){return!isNaN(parseFloat(e))&&isFinite(e)},type:function(e){return e==null?String(e):O[h.call(e)]||"object"},isPlainObject:function(e){if(!e||v.type(e)!=="object"||e.nodeType||v.isWindow(e))return!1;try{if(e.constructor&&!p.call(e,"constructor")&&!p.call(e.constructor.prototype,"isPrototypeOf"))return!1}catch(n){return!1}var r;for(r in e);return r===t||p.call(e,r)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},error:function(e){throw new Error(e)},parseHTML:function(e,t,n){var r;return!e||typeof e!="string"?null:(typeof t=="boolean"&&(n=t,t=0),t=t||i,(r=E.exec(e))?[t.createElement(r[1])]:(r=v.buildFragment([e],t,n?null:[]),v.merge([],(r.cacheable?v.clone(r.fragment):r.fragment).childNodes)))},parseJSON:function(t){if(!t||typeof t!="string")return null;t=v.trim(t);if(e.JSON&&e.JSON.parse)return e.JSON.parse(t);if(S.test(t.replace(T,"@").replace(N,"]").replace(x,"")))return(new Function("return "+t))();v.error("Invalid JSON: "+t)},parseXML:function(n){var r,i;if(!n||typeof n!="string")return null;try{e.DOMParser?(i=new DOMParser,r=i.parseFromString(n,"text/xml")):(r=new ActiveXObject("Microsoft.XMLDOM"),r.async="false",r.loadXML(n))}catch(s){r=t}return(!r||!r.documentElement||r.getElementsByTagName("parsererror").length)&&v.error("Invalid XML: "+n),r},noop:function(){},globalEval:function(t){t&&g.test(t)&&(e.execScript||function(t){e.eval.call(e,t)})(t)},camelCase:function(e){return e.replace(C,"ms-").replace(k,L)},nodeName:function(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()},each:function(e,n,r){var i,s=0,o=e.length,u=o===t||v.isFunction(e);if(r){if(u){for(i in e)if(n.apply(e[i],r)===!1)break}else for(;s0&&e[0]&&e[a-1]||a===0||v.isArray(e));if(f)for(;u-1)a.splice(n,1),i&&(n<=o&&o--,n<=u&&u--)}),this},has:function(e){return v.inArray(e,a)>-1},empty:function(){return a=[],this},disable:function(){return a=f=n=t,this},disabled:function(){return!a},lock:function(){return f=t,n||c.disable(),this},locked:function(){return!f},fireWith:function(e,t){return t=t||[],t=[e,t.slice?t.slice():t],a&&(!r||f)&&(i?f.push(t):l(t)),this},fire:function(){return c.fireWith(this,arguments),this},fired:function(){return!!r}};return c},v.extend({Deferred:function(e){var t=[["resolve","done",v.Callbacks("once memory"),"resolved"],["reject","fail",v.Callbacks("once memory"),"rejected"],["notify","progress",v.Callbacks("memory")]],n="pending",r={state:function(){return n},always:function(){return i.done(arguments).fail(arguments),this},then:function(){var e=arguments;return v.Deferred(function(n){v.each(t,function(t,r){var s=r[0],o=e[t];i[r[1]](v.isFunction(o)?function(){var e=o.apply(this,arguments);e&&v.isFunction(e.promise)?e.promise().done(n.resolve).fail(n.reject).progress(n.notify):n[s+"With"](this===i?n:this,[e])}:n[s])}),e=null}).promise()},promise:function(e){return e!=null?v.extend(e,r):r}},i={};return r.pipe=r.then,v.each(t,function(e,s){var o=s[2],u=s[3];r[s[1]]=o.add,u&&o.add(function(){n=u},t[e^1][2].disable,t[2][2].lock),i[s[0]]=o.fire,i[s[0]+"With"]=o.fireWith}),r.promise(i),e&&e.call(i,i),i},when:function(e){var t=0,n=l.call(arguments),r=n.length,i=r!==1||e&&v.isFunction(e.promise)?r:0,s=i===1?e:v.Deferred(),o=function(e,t,n){return function(r){t[e]=this,n[e]=arguments.length>1?l.call(arguments):r,n===u?s.notifyWith(t,n):--i||s.resolveWith(t,n)}},u,a,f;if(r>1){u=new Array(r),a=new Array(r),f=new Array(r);for(;t
a",n=p.getElementsByTagName("*"),r=p.getElementsByTagName("a")[0];if(!n||!r||!n.length)return{};s=i.createElement("select"),o=s.appendChild(i.createElement("option")),u=p.getElementsByTagName("input")[0],r.style.cssText="top:1px;float:left;opacity:.5",t={leadingWhitespace:p.firstChild.nodeType===3,tbody:!p.getElementsByTagName("tbody").length,htmlSerialize:!!p.getElementsByTagName("link").length,style:/top/.test(r.getAttribute("style")),hrefNormalized:r.getAttribute("href")==="/a",opacity:/^0.5/.test(r.style.opacity),cssFloat:!!r.style.cssFloat,checkOn:u.value==="on",optSelected:o.selected,getSetAttribute:p.className!=="t",enctype:!!i.createElement("form").enctype,html5Clone:i.createElement("nav").cloneNode(!0).outerHTML!=="<:nav>",boxModel:i.compatMode==="CSS1Compat",submitBubbles:!0,changeBubbles:!0,focusinBubbles:!1,deleteExpando:!0,noCloneEvent:!0,inlineBlockNeedsLayout:!1,shrinkWrapBlocks:!1,reliableMarginRight:!0,boxSizingReliable:!0,pixelPosition:!1},u.checked=!0,t.noCloneChecked=u.cloneNode(!0).checked,s.disabled=!0,t.optDisabled=!o.disabled;try{delete p.test}catch(d){t.deleteExpando=!1}!p.addEventListener&&p.attachEvent&&p.fireEvent&&(p.attachEvent("onclick",h=function(){t.noCloneEvent=!1}),p.cloneNode(!0).fireEvent("onclick"),p.detachEvent("onclick",h)),u=i.createElement("input"),u.value="t",u.setAttribute("type","radio"),t.radioValue=u.value==="t",u.setAttribute("checked","checked"),u.setAttribute("name","t"),p.appendChild(u),a=i.createDocumentFragment(),a.appendChild(p.lastChild),t.checkClone=a.cloneNode(!0).cloneNode(!0).lastChild.checked,t.appendChecked=u.checked,a.removeChild(u),a.appendChild(p);if(p.attachEvent)for(l in{submit:!0,change:!0,focusin:!0})f="on"+l,c=f in p,c||(p.setAttribute(f,"return;"),c=typeof p[f]=="function"),t[l+"Bubbles"]=c;return v(function(){var n,r,s,o,u="padding:0;margin:0;border:0;display:block;overflow:hidden;",a=i.getElementsByTagName("body")[0];if(!a)return;n=i.createElement("div"),n.style.cssText="visibility:hidden;border:0;width:0;height:0;position:static;top:0;margin-top:1px",a.insertBefore(n,a.firstChild),r=i.createElement("div"),n.appendChild(r),r.innerHTML="
t
",s=r.getElementsByTagName("td"),s[0].style.cssText="padding:0;margin:0;border:0;display:none",c=s[0].offsetHeight===0,s[0].style.display="",s[1].style.display="none",t.reliableHiddenOffsets=c&&s[0].offsetHeight===0,r.innerHTML="",r.style.cssText="box-sizing:border-box;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;padding:1px;border:1px;display:block;width:4px;margin-top:1%;position:absolute;top:1%;",t.boxSizing=r.offsetWidth===4,t.doesNotIncludeMarginInBodyOffset=a.offsetTop!==1,e.getComputedStyle&&(t.pixelPosition=(e.getComputedStyle(r,null)||{}).top!=="1%",t.boxSizingReliable=(e.getComputedStyle(r,null)||{width:"4px"}).width==="4px",o=i.createElement("div"),o.style.cssText=r.style.cssText=u,o.style.marginRight=o.style.width="0",r.style.width="1px",r.appendChild(o),t.reliableMarginRight=!parseFloat((e.getComputedStyle(o,null)||{}).marginRight)),typeof r.style.zoom!="undefined"&&(r.innerHTML="",r.style.cssText=u+"width:1px;padding:1px;display:inline;zoom:1",t.inlineBlockNeedsLayout=r.offsetWidth===3,r.style.display="block",r.style.overflow="visible",r.innerHTML="
",r.firstChild.style.width="5px",t.shrinkWrapBlocks=r.offsetWidth!==3,n.style.zoom=1),a.removeChild(n),n=r=s=o=null}),a.removeChild(p),n=r=s=o=u=a=p=null,t}();var D=/(?:\{[\s\S]*\}|\[[\s\S]*\])$/,P=/([A-Z])/g;v.extend({cache:{},deletedIds:[],uuid:0,expando:"jQuery"+(v.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:!0,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:!0},hasData:function(e){return e=e.nodeType?v.cache[e[v.expando]]:e[v.expando],!!e&&!B(e)},data:function(e,n,r,i){if(!v.acceptData(e))return;var s,o,u=v.expando,a=typeof n=="string",f=e.nodeType,l=f?v.cache:e,c=f?e[u]:e[u]&&u;if((!c||!l[c]||!i&&!l[c].data)&&a&&r===t)return;c||(f?e[u]=c=v.deletedIds.pop()||v.guid++:c=u),l[c]||(l[c]={},f||(l[c].toJSON=v.noop));if(typeof n=="object"||typeof n=="function")i?l[c]=v.extend(l[c],n):l[c].data=v.extend(l[c].data,n);return s=l[c],i||(s.data||(s.data={}),s=s.data),r!==t&&(s[v.camelCase(n)]=r),a?(o=s[n],o==null&&(o=s[v.camelCase(n)])):o=s,o},removeData:function(e,t,n){if(!v.acceptData(e))return;var r,i,s,o=e.nodeType,u=o?v.cache:e,a=o?e[v.expando]:v.expando;if(!u[a])return;if(t){r=n?u[a]:u[a].data;if(r){v.isArray(t)||(t in r?t=[t]:(t=v.camelCase(t),t in r?t=[t]:t=t.split(" ")));for(i=0,s=t.length;i1,null,!1))},removeData:function(e){return this.each(function(){v.removeData(this,e)})}}),v.extend({queue:function(e,t,n){var r;if(e)return t=(t||"fx")+"queue",r=v._data(e,t),n&&(!r||v.isArray(n)?r=v._data(e,t,v.makeArray(n)):r.push(n)),r||[]},dequeue:function(e,t){t=t||"fx";var n=v.queue(e,t),r=n.length,i=n.shift(),s=v._queueHooks(e,t),o=function(){v.dequeue(e,t)};i==="inprogress"&&(i=n.shift(),r--),i&&(t==="fx"&&n.unshift("inprogress"),delete s.stop,i.call(e,o,s)),!r&&s&&s.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return v._data(e,n)||v._data(e,n,{empty:v.Callbacks("once memory").add(function(){v.removeData(e,t+"queue",!0),v.removeData(e,n,!0)})})}}),v.fn.extend({queue:function(e,n){var r=2;return typeof e!="string"&&(n=e,e="fx",r--),arguments.length1)},removeAttr:function(e){return this.each(function(){v.removeAttr(this,e)})},prop:function(e,t){return v.access(this,v.prop,e,t,arguments.length>1)},removeProp:function(e){return e=v.propFix[e]||e,this.each(function(){try{this[e]=t,delete this[e]}catch(n){}})},addClass:function(e){var t,n,r,i,s,o,u;if(v.isFunction(e))return this.each(function(t){v(this).addClass(e.call(this,t,this.className))});if(e&&typeof e=="string"){t=e.split(y);for(n=0,r=this.length;n=0)r=r.replace(" "+n[s]+" "," ");i.className=e?v.trim(r):""}}}return this},toggleClass:function(e,t){var n=typeof e,r=typeof t=="boolean";return v.isFunction(e)?this.each(function(n){v(this).toggleClass(e.call(this,n,this.className,t),t)}):this.each(function(){if(n==="string"){var i,s=0,o=v(this),u=t,a=e.split(y);while(i=a[s++])u=r?u:!o.hasClass(i),o[u?"addClass":"removeClass"](i)}else if(n==="undefined"||n==="boolean")this.className&&v._data(this,"__className__",this.className),this.className=this.className||e===!1?"":v._data(this,"__className__")||""})},hasClass:function(e){var t=" "+e+" ",n=0,r=this.length;for(;n=0)return!0;return!1},val:function(e){var n,r,i,s=this[0];if(!arguments.length){if(s)return n=v.valHooks[s.type]||v.valHooks[s.nodeName.toLowerCase()],n&&"get"in n&&(r=n.get(s,"value"))!==t?r:(r=s.value,typeof r=="string"?r.replace(R,""):r==null?"":r);return}return i=v.isFunction(e),this.each(function(r){var s,o=v(this);if(this.nodeType!==1)return;i?s=e.call(this,r,o.val()):s=e,s==null?s="":typeof s=="number"?s+="":v.isArray(s)&&(s=v.map(s,function(e){return e==null?"":e+""})),n=v.valHooks[this.type]||v.valHooks[this.nodeName.toLowerCase()];if(!n||!("set"in n)||n.set(this,s,"value")===t)this.value=s})}}),v.extend({valHooks:{option:{get:function(e){var t=e.attributes.value;return!t||t.specified?e.value:e.text}},select:{get:function(e){var t,n,r=e.options,i=e.selectedIndex,s=e.type==="select-one"||i<0,o=s?null:[],u=s?i+1:r.length,a=i<0?u:s?i:0;for(;a=0}),n.length||(e.selectedIndex=-1),n}}},attrFn:{},attr:function(e,n,r,i){var s,o,u,a=e.nodeType;if(!e||a===3||a===8||a===2)return;if(i&&v.isFunction(v.fn[n]))return v(e)[n](r);if(typeof e.getAttribute=="undefined")return v.prop(e,n,r);u=a!==1||!v.isXMLDoc(e),u&&(n=n.toLowerCase(),o=v.attrHooks[n]||(X.test(n)?F:j));if(r!==t){if(r===null){v.removeAttr(e,n);return}return o&&"set"in o&&u&&(s=o.set(e,r,n))!==t?s:(e.setAttribute(n,r+""),r)}return o&&"get"in o&&u&&(s=o.get(e,n))!==null?s:(s=e.getAttribute(n),s===null?t:s)},removeAttr:function(e,t){var n,r,i,s,o=0;if(t&&e.nodeType===1){r=t.split(y);for(;o=0}})});var $=/^(?:textarea|input|select)$/i,J=/^([^\.]*|)(?:\.(.+)|)$/,K=/(?:^|\s)hover(\.\S+|)\b/,Q=/^key/,G=/^(?:mouse|contextmenu)|click/,Y=/^(?:focusinfocus|focusoutblur)$/,Z=function(e){return v.event.special.hover?e:e.replace(K,"mouseenter$1 mouseleave$1")};v.event={add:function(e,n,r,i,s){var o,u,a,f,l,c,h,p,d,m,g;if(e.nodeType===3||e.nodeType===8||!n||!r||!(o=v._data(e)))return;r.handler&&(d=r,r=d.handler,s=d.selector),r.guid||(r.guid=v.guid++),a=o.events,a||(o.events=a={}),u=o.handle,u||(o.handle=u=function(e){return typeof v=="undefined"||!!e&&v.event.triggered===e.type?t:v.event.dispatch.apply(u.elem,arguments)},u.elem=e),n=v.trim(Z(n)).split(" ");for(f=0;f=0&&(y=y.slice(0,-1),a=!0),y.indexOf(".")>=0&&(b=y.split("."),y=b.shift(),b.sort());if((!s||v.event.customEvent[y])&&!v.event.global[y])return;n=typeof n=="object"?n[v.expando]?n:new v.Event(y,n):new v.Event(y),n.type=y,n.isTrigger=!0,n.exclusive=a,n.namespace=b.join("."),n.namespace_re=n.namespace?new RegExp("(^|\\.)"+b.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,h=y.indexOf(":")<0?"on"+y:"";if(!s){u=v.cache;for(f in u)u[f].events&&u[f].events[y]&&v.event.trigger(n,r,u[f].handle.elem,!0);return}n.result=t,n.target||(n.target=s),r=r!=null?v.makeArray(r):[],r.unshift(n),p=v.event.special[y]||{};if(p.trigger&&p.trigger.apply(s,r)===!1)return;m=[[s,p.bindType||y]];if(!o&&!p.noBubble&&!v.isWindow(s)){g=p.delegateType||y,l=Y.test(g+y)?s:s.parentNode;for(c=s;l;l=l.parentNode)m.push([l,g]),c=l;c===(s.ownerDocument||i)&&m.push([c.defaultView||c.parentWindow||e,g])}for(f=0;f=0:v.find(h,this,null,[s]).length),u[h]&&f.push(c);f.length&&w.push({elem:s,matches:f})}d.length>m&&w.push({elem:this,matches:d.slice(m)});for(r=0;r0?this.on(t,null,e,n):this.trigger(t)},Q.test(t)&&(v.event.fixHooks[t]=v.event.keyHooks),G.test(t)&&(v.event.fixHooks[t]=v.event.mouseHooks)}),function(e,t){function nt(e,t,n,r){n=n||[],t=t||g;var i,s,a,f,l=t.nodeType;if(!e||typeof e!="string")return n;if(l!==1&&l!==9)return[];a=o(t);if(!a&&!r)if(i=R.exec(e))if(f=i[1]){if(l===9){s=t.getElementById(f);if(!s||!s.parentNode)return n;if(s.id===f)return n.push(s),n}else if(t.ownerDocument&&(s=t.ownerDocument.getElementById(f))&&u(t,s)&&s.id===f)return n.push(s),n}else{if(i[2])return S.apply(n,x.call(t.getElementsByTagName(e),0)),n;if((f=i[3])&&Z&&t.getElementsByClassName)return S.apply(n,x.call(t.getElementsByClassName(f),0)),n}return vt(e.replace(j,"$1"),t,n,r,a)}function rt(e){return function(t){var n=t.nodeName.toLowerCase();return n==="input"&&t.type===e}}function it(e){return function(t){var n=t.nodeName.toLowerCase();return(n==="input"||n==="button")&&t.type===e}}function st(e){return N(function(t){return t=+t,N(function(n,r){var i,s=e([],n.length,t),o=s.length;while(o--)n[i=s[o]]&&(n[i]=!(r[i]=n[i]))})})}function ot(e,t,n){if(e===t)return n;var r=e.nextSibling;while(r){if(r===t)return-1;r=r.nextSibling}return 1}function ut(e,t){var n,r,s,o,u,a,f,l=L[d][e+" "];if(l)return t?0:l.slice(0);u=e,a=[],f=i.preFilter;while(u){if(!n||(r=F.exec(u)))r&&(u=u.slice(r[0].length)||u),a.push(s=[]);n=!1;if(r=I.exec(u))s.push(n=new m(r.shift())),u=u.slice(n.length),n.type=r[0].replace(j," ");for(o in i.filter)(r=J[o].exec(u))&&(!f[o]||(r=f[o](r)))&&(s.push(n=new m(r.shift())),u=u.slice(n.length),n.type=o,n.matches=r);if(!n)break}return t?u.length:u?nt.error(e):L(e,a).slice(0)}function at(e,t,r){var i=t.dir,s=r&&t.dir==="parentNode",o=w++;return t.first?function(t,n,r){while(t=t[i])if(s||t.nodeType===1)return e(t,n,r)}:function(t,r,u){if(!u){var a,f=b+" "+o+" ",l=f+n;while(t=t[i])if(s||t.nodeType===1){if((a=t[d])===l)return t.sizset;if(typeof a=="string"&&a.indexOf(f)===0){if(t.sizset)return t}else{t[d]=l;if(e(t,r,u))return t.sizset=!0,t;t.sizset=!1}}}else while(t=t[i])if(s||t.nodeType===1)if(e(t,r,u))return t}}function ft(e){return e.length>1?function(t,n,r){var i=e.length;while(i--)if(!e[i](t,n,r))return!1;return!0}:e[0]}function lt(e,t,n,r,i){var s,o=[],u=0,a=e.length,f=t!=null;for(;u-1&&(s[f]=!(o[f]=c))}}else g=lt(g===o?g.splice(d,g.length):g),i?i(null,o,g,a):S.apply(o,g)})}function ht(e){var t,n,r,s=e.length,o=i.relative[e[0].type],u=o||i.relative[" "],a=o?1:0,f=at(function(e){return e===t},u,!0),l=at(function(e){return T.call(t,e)>-1},u,!0),h=[function(e,n,r){return!o&&(r||n!==c)||((t=n).nodeType?f(e,n,r):l(e,n,r))}];for(;a1&&ft(h),a>1&&e.slice(0,a-1).join("").replace(j,"$1"),n,a0,s=e.length>0,o=function(u,a,f,l,h){var p,d,v,m=[],y=0,w="0",x=u&&[],T=h!=null,N=c,C=u||s&&i.find.TAG("*",h&&a.parentNode||a),k=b+=N==null?1:Math.E;T&&(c=a!==g&&a,n=o.el);for(;(p=C[w])!=null;w++){if(s&&p){for(d=0;v=e[d];d++)if(v(p,a,f)){l.push(p);break}T&&(b=k,n=++o.el)}r&&((p=!v&&p)&&y--,u&&x.push(p))}y+=w;if(r&&w!==y){for(d=0;v=t[d];d++)v(x,m,a,f);if(u){if(y>0)while(w--)!x[w]&&!m[w]&&(m[w]=E.call(l));m=lt(m)}S.apply(l,m),T&&!u&&m.length>0&&y+t.length>1&&nt.uniqueSort(l)}return T&&(b=k,c=N),x};return o.el=0,r?N(o):o}function dt(e,t,n){var r=0,i=t.length;for(;r2&&(f=u[0]).type==="ID"&&t.nodeType===9&&!s&&i.relative[u[1].type]){t=i.find.ID(f.matches[0].replace($,""),t,s)[0];if(!t)return n;e=e.slice(u.shift().length)}for(o=J.POS.test(e)?-1:u.length-1;o>=0;o--){f=u[o];if(i.relative[l=f.type])break;if(c=i.find[l])if(r=c(f.matches[0].replace($,""),z.test(u[0].type)&&t.parentNode||t,s)){u.splice(o,1),e=r.length&&u.join("");if(!e)return S.apply(n,x.call(r,0)),n;break}}}return a(e,h)(r,t,s,n,z.test(e)),n}function mt(){}var n,r,i,s,o,u,a,f,l,c,h=!0,p="undefined",d=("sizcache"+Math.random()).replace(".",""),m=String,g=e.document,y=g.documentElement,b=0,w=0,E=[].pop,S=[].push,x=[].slice,T=[].indexOf||function(e){var t=0,n=this.length;for(;ti.cacheLength&&delete e[t.shift()],e[n+" "]=r},e)},k=C(),L=C(),A=C(),O="[\\x20\\t\\r\\n\\f]",M="(?:\\\\.|[-\\w]|[^\\x00-\\xa0])+",_=M.replace("w","w#"),D="([*^$|!~]?=)",P="\\["+O+"*("+M+")"+O+"*(?:"+D+O+"*(?:(['\"])((?:\\\\.|[^\\\\])*?)\\3|("+_+")|)|)"+O+"*\\]",H=":("+M+")(?:\\((?:(['\"])((?:\\\\.|[^\\\\])*?)\\2|([^()[\\]]*|(?:(?:"+P+")|[^:]|\\\\.)*|.*))\\)|)",B=":(even|odd|eq|gt|lt|nth|first|last)(?:\\("+O+"*((?:-\\d)?\\d*)"+O+"*\\)|)(?=[^-]|$)",j=new RegExp("^"+O+"+|((?:^|[^\\\\])(?:\\\\.)*)"+O+"+$","g"),F=new RegExp("^"+O+"*,"+O+"*"),I=new RegExp("^"+O+"*([\\x20\\t\\r\\n\\f>+~])"+O+"*"),q=new RegExp(H),R=/^(?:#([\w\-]+)|(\w+)|\.([\w\-]+))$/,U=/^:not/,z=/[\x20\t\r\n\f]*[+~]/,W=/:not\($/,X=/h\d/i,V=/input|select|textarea|button/i,$=/\\(?!\\)/g,J={ID:new RegExp("^#("+M+")"),CLASS:new RegExp("^\\.("+M+")"),NAME:new RegExp("^\\[name=['\"]?("+M+")['\"]?\\]"),TAG:new RegExp("^("+M.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+H),POS:new RegExp(B,"i"),CHILD:new RegExp("^:(only|nth|first|last)-child(?:\\("+O+"*(even|odd|(([+-]|)(\\d*)n|)"+O+"*(?:([+-]|)"+O+"*(\\d+)|))"+O+"*\\)|)","i"),needsContext:new RegExp("^"+O+"*[>+~]|"+B,"i")},K=function(e){var t=g.createElement("div");try{return e(t)}catch(n){return!1}finally{t=null}},Q=K(function(e){return e.appendChild(g.createComment("")),!e.getElementsByTagName("*").length}),G=K(function(e){return e.innerHTML="",e.firstChild&&typeof e.firstChild.getAttribute!==p&&e.firstChild.getAttribute("href")==="#"}),Y=K(function(e){e.innerHTML="";var t=typeof e.lastChild.getAttribute("multiple");return t!=="boolean"&&t!=="string"}),Z=K(function(e){return e.innerHTML="",!e.getElementsByClassName||!e.getElementsByClassName("e").length?!1:(e.lastChild.className="e",e.getElementsByClassName("e").length===2)}),et=K(function(e){e.id=d+0,e.innerHTML="
",y.insertBefore(e,y.firstChild);var t=g.getElementsByName&&g.getElementsByName(d).length===2+g.getElementsByName(d+0).length;return r=!g.getElementById(d),y.removeChild(e),t});try{x.call(y.childNodes,0)[0].nodeType}catch(tt){x=function(e){var t,n=[];for(;t=this[e];e++)n.push(t);return n}}nt.matches=function(e,t){return nt(e,null,null,t)},nt.matchesSelector=function(e,t){return nt(t,null,null,[e]).length>0},s=nt.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(i===1||i===9||i===11){if(typeof e.textContent=="string")return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=s(e)}else if(i===3||i===4)return e.nodeValue}else for(;t=e[r];r++)n+=s(t);return n},o=nt.isXML=function(e){var t=e&&(e.ownerDocument||e).documentElement;return t?t.nodeName!=="HTML":!1},u=nt.contains=y.contains?function(e,t){var n=e.nodeType===9?e.documentElement:e,r=t&&t.parentNode;return e===r||!!(r&&r.nodeType===1&&n.contains&&n.contains(r))}:y.compareDocumentPosition?function(e,t){return t&&!!(e.compareDocumentPosition(t)&16)}:function(e,t){while(t=t.parentNode)if(t===e)return!0;return!1},nt.attr=function(e,t){var n,r=o(e);return r||(t=t.toLowerCase()),(n=i.attrHandle[t])?n(e):r||Y?e.getAttribute(t):(n=e.getAttributeNode(t),n?typeof e[t]=="boolean"?e[t]?t:null:n.specified?n.value:null:null)},i=nt.selectors={cacheLength:50,createPseudo:N,match:J,attrHandle:G?{}:{href:function(e){return e.getAttribute("href",2)},type:function(e){return e.getAttribute("type")}},find:{ID:r?function(e,t,n){if(typeof t.getElementById!==p&&!n){var r=t.getElementById(e);return r&&r.parentNode?[r]:[]}}:function(e,n,r){if(typeof n.getElementById!==p&&!r){var i=n.getElementById(e);return i?i.id===e||typeof i.getAttributeNode!==p&&i.getAttributeNode("id").value===e?[i]:t:[]}},TAG:Q?function(e,t){if(typeof t.getElementsByTagName!==p)return t.getElementsByTagName(e)}:function(e,t){var n=t.getElementsByTagName(e);if(e==="*"){var r,i=[],s=0;for(;r=n[s];s++)r.nodeType===1&&i.push(r);return i}return n},NAME:et&&function(e,t){if(typeof t.getElementsByName!==p)return t.getElementsByName(name)},CLASS:Z&&function(e,t,n){if(typeof t.getElementsByClassName!==p&&!n)return t.getElementsByClassName(e)}},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace($,""),e[3]=(e[4]||e[5]||"").replace($,""),e[2]==="~="&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),e[1]==="nth"?(e[2]||nt.error(e[0]),e[3]=+(e[3]?e[4]+(e[5]||1):2*(e[2]==="even"||e[2]==="odd")),e[4]=+(e[6]+e[7]||e[2]==="odd")):e[2]&&nt.error(e[0]),e},PSEUDO:function(e){var t,n;if(J.CHILD.test(e[0]))return null;if(e[3])e[2]=e[3];else if(t=e[4])q.test(t)&&(n=ut(t,!0))&&(n=t.indexOf(")",t.length-n)-t.length)&&(t=t.slice(0,n),e[0]=e[0].slice(0,n)),e[2]=t;return e.slice(0,3)}},filter:{ID:r?function(e){return e=e.replace($,""),function(t){return t.getAttribute("id")===e}}:function(e){return e=e.replace($,""),function(t){var n=typeof t.getAttributeNode!==p&&t.getAttributeNode("id");return n&&n.value===e}},TAG:function(e){return e==="*"?function(){return!0}:(e=e.replace($,"").toLowerCase(),function(t){return t.nodeName&&t.nodeName.toLowerCase()===e})},CLASS:function(e){var t=k[d][e+" "];return t||(t=new RegExp("(^|"+O+")"+e+"("+O+"|$)"))&&k(e,function(e){return t.test(e.className||typeof e.getAttribute!==p&&e.getAttribute("class")||"")})},ATTR:function(e,t,n){return function(r,i){var s=nt.attr(r,e);return s==null?t==="!=":t?(s+="",t==="="?s===n:t==="!="?s!==n:t==="^="?n&&s.indexOf(n)===0:t==="*="?n&&s.indexOf(n)>-1:t==="$="?n&&s.substr(s.length-n.length)===n:t==="~="?(" "+s+" ").indexOf(n)>-1:t==="|="?s===n||s.substr(0,n.length+1)===n+"-":!1):!0}},CHILD:function(e,t,n,r){return e==="nth"?function(e){var t,i,s=e.parentNode;if(n===1&&r===0)return!0;if(s){i=0;for(t=s.firstChild;t;t=t.nextSibling)if(t.nodeType===1){i++;if(e===t)break}}return i-=r,i===n||i%n===0&&i/n>=0}:function(t){var n=t;switch(e){case"only":case"first":while(n=n.previousSibling)if(n.nodeType===1)return!1;if(e==="first")return!0;n=t;case"last":while(n=n.nextSibling)if(n.nodeType===1)return!1;return!0}}},PSEUDO:function(e,t){var n,r=i.pseudos[e]||i.setFilters[e.toLowerCase()]||nt.error("unsupported pseudo: "+e);return r[d]?r(t):r.length>1?(n=[e,e,"",t],i.setFilters.hasOwnProperty(e.toLowerCase())?N(function(e,n){var i,s=r(e,t),o=s.length;while(o--)i=T.call(e,s[o]),e[i]=!(n[i]=s[o])}):function(e){return r(e,0,n)}):r}},pseudos:{not:N(function(e){var t=[],n=[],r=a(e.replace(j,"$1"));return r[d]?N(function(e,t,n,i){var s,o=r(e,null,i,[]),u=e.length;while(u--)if(s=o[u])e[u]=!(t[u]=s)}):function(e,i,s){return t[0]=e,r(t,null,s,n),!n.pop()}}),has:N(function(e){return function(t){return nt(e,t).length>0}}),contains:N(function(e){return function(t){return(t.textContent||t.innerText||s(t)).indexOf(e)>-1}}),enabled:function(e){return e.disabled===!1},disabled:function(e){return e.disabled===!0},checked:function(e){var t=e.nodeName.toLowerCase();return t==="input"&&!!e.checked||t==="option"&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,e.selected===!0},parent:function(e){return!i.pseudos.empty(e)},empty:function(e){var t;e=e.firstChild;while(e){if(e.nodeName>"@"||(t=e.nodeType)===3||t===4)return!1;e=e.nextSibling}return!0},header:function(e){return X.test(e.nodeName)},text:function(e){var t,n;return e.nodeName.toLowerCase()==="input"&&(t=e.type)==="text"&&((n=e.getAttribute("type"))==null||n.toLowerCase()===t)},radio:rt("radio"),checkbox:rt("checkbox"),file:rt("file"),password:rt("password"),image:rt("image"),submit:it("submit"),reset:it("reset"),button:function(e){var t=e.nodeName.toLowerCase();return t==="input"&&e.type==="button"||t==="button"},input:function(e){return V.test(e.nodeName)},focus:function(e){var t=e.ownerDocument;return e===t.activeElement&&(!t.hasFocus||t.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},active:function(e){return e===e.ownerDocument.activeElement},first:st(function(){return[0]}),last:st(function(e,t){return[t-1]}),eq:st(function(e,t,n){return[n<0?n+t:n]}),even:st(function(e,t){for(var n=0;n=0;)e.push(r);return e}),gt:st(function(e,t,n){for(var r=n<0?n+t:n;++r",e.querySelectorAll("[selected]").length||i.push("\\["+O+"*(?:checked|disabled|ismap|multiple|readonly|selected|value)"),e.querySelectorAll(":checked").length||i.push(":checked")}),K(function(e){e.innerHTML="

",e.querySelectorAll("[test^='']").length&&i.push("[*^$]="+O+"*(?:\"\"|'')"),e.innerHTML="",e.querySelectorAll(":enabled").length||i.push(":enabled",":disabled")}),i=new RegExp(i.join("|")),vt=function(e,r,s,o,u){if(!o&&!u&&!i.test(e)){var a,f,l=!0,c=d,h=r,p=r.nodeType===9&&e;if(r.nodeType===1&&r.nodeName.toLowerCase()!=="object"){a=ut(e),(l=r.getAttribute("id"))?c=l.replace(n,"\\$&"):r.setAttribute("id",c),c="[id='"+c+"'] ",f=a.length;while(f--)a[f]=c+a[f].join("");h=z.test(e)&&r.parentNode||r,p=a.join(",")}if(p)try{return S.apply(s,x.call(h.querySelectorAll(p),0)),s}catch(v){}finally{l||r.removeAttribute("id")}}return t(e,r,s,o,u)},u&&(K(function(t){e=u.call(t,"div");try{u.call(t,"[test!='']:sizzle"),s.push("!=",H)}catch(n){}}),s=new RegExp(s.join("|")),nt.matchesSelector=function(t,n){n=n.replace(r,"='$1']");if(!o(t)&&!s.test(n)&&!i.test(n))try{var a=u.call(t,n);if(a||e||t.document&&t.document.nodeType!==11)return a}catch(f){}return nt(n,null,null,[t]).length>0})}(),i.pseudos.nth=i.pseudos.eq,i.filters=mt.prototype=i.pseudos,i.setFilters=new mt,nt.attr=v.attr,v.find=nt,v.expr=nt.selectors,v.expr[":"]=v.expr.pseudos,v.unique=nt.uniqueSort,v.text=nt.getText,v.isXMLDoc=nt.isXML,v.contains=nt.contains}(e);var nt=/Until$/,rt=/^(?:parents|prev(?:Until|All))/,it=/^.[^:#\[\.,]*$/,st=v.expr.match.needsContext,ot={children:!0,contents:!0,next:!0,prev:!0};v.fn.extend({find:function(e){var t,n,r,i,s,o,u=this;if(typeof e!="string")return v(e).filter(function(){for(t=0,n=u.length;t0)for(i=r;i=0:v.filter(e,this).length>0:this.filter(e).length>0)},closest:function(e,t){var n,r=0,i=this.length,s=[],o=st.test(e)||typeof e!="string"?v(e,t||this.context):0;for(;r-1:v.find.matchesSelector(n,e)){s.push(n);break}n=n.parentNode}}return s=s.length>1?v.unique(s):s,this.pushStack(s,"closest",e)},index:function(e){return e?typeof e=="string"?v.inArray(this[0],v(e)):v.inArray(e.jquery?e[0]:e,this):this[0]&&this[0].parentNode?this.prevAll().length:-1},add:function(e,t){var n=typeof e=="string"?v(e,t):v.makeArray(e&&e.nodeType?[e]:e),r=v.merge(this.get(),n);return this.pushStack(ut(n[0])||ut(r[0])?r:v.unique(r))},addBack:function(e){return this.add(e==null?this.prevObject:this.prevObject.filter(e))}}),v.fn.andSelf=v.fn.addBack,v.each({parent:function(e){var t=e.parentNode;return t&&t.nodeType!==11?t:null},parents:function(e){return v.dir(e,"parentNode")},parentsUntil:function(e,t,n){return v.dir(e,"parentNode",n)},next:function(e){return at(e,"nextSibling")},prev:function(e){return at(e,"previousSibling")},nextAll:function(e){return v.dir(e,"nextSibling")},prevAll:function(e){return v.dir(e,"previousSibling")},nextUntil:function(e,t,n){return v.dir(e,"nextSibling",n)},prevUntil:function(e,t,n){return v.dir(e,"previousSibling",n)},siblings:function(e){return v.sibling((e.parentNode||{}).firstChild,e)},children:function(e){return v.sibling(e.firstChild)},contents:function(e){return v.nodeName(e,"iframe")?e.contentDocument||e.contentWindow.document:v.merge([],e.childNodes)}},function(e,t){v.fn[e]=function(n,r){var i=v.map(this,t,n);return nt.test(e)||(r=n),r&&typeof r=="string"&&(i=v.filter(r,i)),i=this.length>1&&!ot[e]?v.unique(i):i,this.length>1&&rt.test(e)&&(i=i.reverse()),this.pushStack(i,e,l.call(arguments).join(","))}}),v.extend({filter:function(e,t,n){return n&&(e=":not("+e+")"),t.length===1?v.find.matchesSelector(t[0],e)?[t[0]]:[]:v.find.matches(e,t)},dir:function(e,n,r){var i=[],s=e[n];while(s&&s.nodeType!==9&&(r===t||s.nodeType!==1||!v(s).is(r)))s.nodeType===1&&i.push(s),s=s[n];return i},sibling:function(e,t){var n=[];for(;e;e=e.nextSibling)e.nodeType===1&&e!==t&&n.push(e);return n}});var ct="abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",ht=/ jQuery\d+="(?:null|\d+)"/g,pt=/^\s+/,dt=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,vt=/<([\w:]+)/,mt=/]","i"),Et=/^(?:checkbox|radio)$/,St=/checked\s*(?:[^=]|=\s*.checked.)/i,xt=/\/(java|ecma)script/i,Tt=/^\s*\s*$/g,Nt={option:[1,""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]},Ct=lt(i),kt=Ct.appendChild(i.createElement("div"));Nt.optgroup=Nt.option,Nt.tbody=Nt.tfoot=Nt.colgroup=Nt.caption=Nt.thead,Nt.th=Nt.td,v.support.htmlSerialize||(Nt._default=[1,"X
","
"]),v.fn.extend({text:function(e){return v.access(this,function(e){return e===t?v.text(this):this.empty().append((this[0]&&this[0].ownerDocument||i).createTextNode(e))},null,e,arguments.length)},wrapAll:function(e){if(v.isFunction(e))return this.each(function(t){v(this).wrapAll(e.call(this,t))});if(this[0]){var t=v(e,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstChild&&e.firstChild.nodeType===1)e=e.firstChild;return e}).append(this)}return this},wrapInner:function(e){return v.isFunction(e)?this.each(function(t){v(this).wrapInner(e.call(this,t))}):this.each(function(){var t=v(this),n=t.contents();n.length?n.wrapAll(e):t.append(e)})},wrap:function(e){var t=v.isFunction(e);return this.each(function(n){v(this).wrapAll(t?e.call(this,n):e)})},unwrap:function(){return this.parent().each(function(){v.nodeName(this,"body")||v(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(e){(this.nodeType===1||this.nodeType===11)&&this.appendChild(e)})},prepend:function(){return this.domManip(arguments,!0,function(e){(this.nodeType===1||this.nodeType===11)&&this.insertBefore(e,this.firstChild)})},before:function(){if(!ut(this[0]))return this.domManip(arguments,!1,function(e){this.parentNode.insertBefore(e,this)});if(arguments.length){var e=v.clean(arguments);return this.pushStack(v.merge(e,this),"before",this.selector)}},after:function(){if(!ut(this[0]))return this.domManip(arguments,!1,function(e){this.parentNode.insertBefore(e,this.nextSibling)});if(arguments.length){var e=v.clean(arguments);return this.pushStack(v.merge(this,e),"after",this.selector)}},remove:function(e,t){var n,r=0;for(;(n=this[r])!=null;r++)if(!e||v.filter(e,[n]).length)!t&&n.nodeType===1&&(v.cleanData(n.getElementsByTagName("*")),v.cleanData([n])),n.parentNode&&n.parentNode.removeChild(n);return this},empty:function(){var e,t=0;for(;(e=this[t])!=null;t++){e.nodeType===1&&v.cleanData(e.getElementsByTagName("*"));while(e.firstChild)e.removeChild(e.firstChild)}return this},clone:function(e,t){return e=e==null?!1:e,t=t==null?e:t,this.map(function(){return v.clone(this,e,t)})},html:function(e){return v.access(this,function(e){var n=this[0]||{},r=0,i=this.length;if(e===t)return n.nodeType===1?n.innerHTML.replace(ht,""):t;if(typeof e=="string"&&!yt.test(e)&&(v.support.htmlSerialize||!wt.test(e))&&(v.support.leadingWhitespace||!pt.test(e))&&!Nt[(vt.exec(e)||["",""])[1].toLowerCase()]){e=e.replace(dt,"<$1>");try{for(;r1&&typeof f=="string"&&St.test(f))return this.each(function(){v(this).domManip(e,n,r)});if(v.isFunction(f))return this.each(function(i){var s=v(this);e[0]=f.call(this,i,n?s.html():t),s.domManip(e,n,r)});if(this[0]){i=v.buildFragment(e,this,l),o=i.fragment,s=o.firstChild,o.childNodes.length===1&&(o=s);if(s){n=n&&v.nodeName(s,"tr");for(u=i.cacheable||c-1;a0?this.clone(!0):this).get(),v(o[i])[t](r),s=s.concat(r);return this.pushStack(s,e,o.selector)}}),v.extend({clone:function(e,t,n){var r,i,s,o;v.support.html5Clone||v.isXMLDoc(e)||!wt.test("<"+e.nodeName+">")?o=e.cloneNode(!0):(kt.innerHTML=e.outerHTML,kt.removeChild(o=kt.firstChild));if((!v.support.noCloneEvent||!v.support.noCloneChecked)&&(e.nodeType===1||e.nodeType===11)&&!v.isXMLDoc(e)){Ot(e,o),r=Mt(e),i=Mt(o);for(s=0;r[s];++s)i[s]&&Ot(r[s],i[s])}if(t){At(e,o);if(n){r=Mt(e),i=Mt(o);for(s=0;r[s];++s)At(r[s],i[s])}}return r=i=null,o},clean:function(e,t,n,r){var s,o,u,a,f,l,c,h,p,d,m,g,y=t===i&&Ct,b=[];if(!t||typeof t.createDocumentFragment=="undefined")t=i;for(s=0;(u=e[s])!=null;s++){typeof u=="number"&&(u+="");if(!u)continue;if(typeof u=="string")if(!gt.test(u))u=t.createTextNode(u);else{y=y||lt(t),c=t.createElement("div"),y.appendChild(c),u=u.replace(dt,"<$1>"),a=(vt.exec(u)||["",""])[1].toLowerCase(),f=Nt[a]||Nt._default,l=f[0],c.innerHTML=f[1]+u+f[2];while(l--)c=c.lastChild;if(!v.support.tbody){h=mt.test(u),p=a==="table"&&!h?c.firstChild&&c.firstChild.childNodes:f[1]===""&&!h?c.childNodes:[];for(o=p.length-1;o>=0;--o)v.nodeName(p[o],"tbody")&&!p[o].childNodes.length&&p[o].parentNode.removeChild(p[o])}!v.support.leadingWhitespace&&pt.test(u)&&c.insertBefore(t.createTextNode(pt.exec(u)[0]),c.firstChild),u=c.childNodes,c.parentNode.removeChild(c)}u.nodeType?b.push(u):v.merge(b,u)}c&&(u=c=y=null);if(!v.support.appendChecked)for(s=0;(u=b[s])!=null;s++)v.nodeName(u,"input")?_t(u):typeof u.getElementsByTagName!="undefined"&&v.grep(u.getElementsByTagName("input"),_t);if(n){m=function(e){if(!e.type||xt.test(e.type))return r?r.push(e.parentNode?e.parentNode.removeChild(e):e):n.appendChild(e)};for(s=0;(u=b[s])!=null;s++)if(!v.nodeName(u,"script")||!m(u))n.appendChild(u),typeof u.getElementsByTagName!="undefined"&&(g=v.grep(v.merge([],u.getElementsByTagName("script")),m),b.splice.apply(b,[s+1,0].concat(g)),s+=g.length)}return b},cleanData:function(e,t){var n,r,i,s,o=0,u=v.expando,a=v.cache,f=v.support.deleteExpando,l=v.event.special;for(;(i=e[o])!=null;o++)if(t||v.acceptData(i)){r=i[u],n=r&&a[r];if(n){if(n.events)for(s in n.events)l[s]?v.event.remove(i,s):v.removeEvent(i,s,n.handle);a[r]&&(delete a[r],f?delete i[u]:i.removeAttribute?i.removeAttribute(u):i[u]=null,v.deletedIds.push(r))}}}}),function(){var e,t;v.uaMatch=function(e){e=e.toLowerCase();var t=/(chrome)[ \/]([\w.]+)/.exec(e)||/(webkit)[ \/]([\w.]+)/.exec(e)||/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(e)||/(msie) ([\w.]+)/.exec(e)||e.indexOf("compatible")<0&&/(mozilla)(?:.*? rv:([\w.]+)|)/.exec(e)||[];return{browser:t[1]||"",version:t[2]||"0"}},e=v.uaMatch(o.userAgent),t={},e.browser&&(t[e.browser]=!0,t.version=e.version),t.chrome?t.webkit=!0:t.webkit&&(t.safari=!0),v.browser=t,v.sub=function(){function e(t,n){return new e.fn.init(t,n)}v.extend(!0,e,this),e.superclass=this,e.fn=e.prototype=this(),e.fn.constructor=e,e.sub=this.sub,e.fn.init=function(r,i){return i&&i instanceof v&&!(i instanceof e)&&(i=e(i)),v.fn.init.call(this,r,i,t)},e.fn.init.prototype=e.fn;var t=e(i);return e}}();var Dt,Pt,Ht,Bt=/alpha\([^)]*\)/i,jt=/opacity=([^)]*)/,Ft=/^(top|right|bottom|left)$/,It=/^(none|table(?!-c[ea]).+)/,qt=/^margin/,Rt=new RegExp("^("+m+")(.*)$","i"),Ut=new RegExp("^("+m+")(?!px)[a-z%]+$","i"),zt=new RegExp("^([-+])=("+m+")","i"),Wt={BODY:"block"},Xt={position:"absolute",visibility:"hidden",display:"block"},Vt={letterSpacing:0,fontWeight:400},$t=["Top","Right","Bottom","Left"],Jt=["Webkit","O","Moz","ms"],Kt=v.fn.toggle;v.fn.extend({css:function(e,n){return v.access(this,function(e,n,r){return r!==t?v.style(e,n,r):v.css(e,n)},e,n,arguments.length>1)},show:function(){return Yt(this,!0)},hide:function(){return Yt(this)},toggle:function(e,t){var n=typeof e=="boolean";return v.isFunction(e)&&v.isFunction(t)?Kt.apply(this,arguments):this.each(function(){(n?e:Gt(this))?v(this).show():v(this).hide()})}}),v.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=Dt(e,"opacity");return n===""?"1":n}}}},cssNumber:{fillOpacity:!0,fontWeight:!0,lineHeight:!0,opacity:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":v.support.cssFloat?"cssFloat":"styleFloat"},style:function(e,n,r,i){if(!e||e.nodeType===3||e.nodeType===8||!e.style)return;var s,o,u,a=v.camelCase(n),f=e.style;n=v.cssProps[a]||(v.cssProps[a]=Qt(f,a)),u=v.cssHooks[n]||v.cssHooks[a];if(r===t)return u&&"get"in u&&(s=u.get(e,!1,i))!==t?s:f[n];o=typeof r,o==="string"&&(s=zt.exec(r))&&(r=(s[1]+1)*s[2]+parseFloat(v.css(e,n)),o="number");if(r==null||o==="number"&&isNaN(r))return;o==="number"&&!v.cssNumber[a]&&(r+="px");if(!u||!("set"in u)||(r=u.set(e,r,i))!==t)try{f[n]=r}catch(l){}},css:function(e,n,r,i){var s,o,u,a=v.camelCase(n);return n=v.cssProps[a]||(v.cssProps[a]=Qt(e.style,a)),u=v.cssHooks[n]||v.cssHooks[a],u&&"get"in u&&(s=u.get(e,!0,i)),s===t&&(s=Dt(e,n)),s==="normal"&&n in Vt&&(s=Vt[n]),r||i!==t?(o=parseFloat(s),r||v.isNumeric(o)?o||0:s):s},swap:function(e,t,n){var r,i,s={};for(i in t)s[i]=e.style[i],e.style[i]=t[i];r=n.call(e);for(i in t)e.style[i]=s[i];return r}}),e.getComputedStyle?Dt=function(t,n){var r,i,s,o,u=e.getComputedStyle(t,null),a=t.style;return u&&(r=u.getPropertyValue(n)||u[n],r===""&&!v.contains(t.ownerDocument,t)&&(r=v.style(t,n)),Ut.test(r)&&qt.test(n)&&(i=a.width,s=a.minWidth,o=a.maxWidth,a.minWidth=a.maxWidth=a.width=r,r=u.width,a.width=i,a.minWidth=s,a.maxWidth=o)),r}:i.documentElement.currentStyle&&(Dt=function(e,t){var n,r,i=e.currentStyle&&e.currentStyle[t],s=e.style;return i==null&&s&&s[t]&&(i=s[t]),Ut.test(i)&&!Ft.test(t)&&(n=s.left,r=e.runtimeStyle&&e.runtimeStyle.left,r&&(e.runtimeStyle.left=e.currentStyle.left),s.left=t==="fontSize"?"1em":i,i=s.pixelLeft+"px",s.left=n,r&&(e.runtimeStyle.left=r)),i===""?"auto":i}),v.each(["height","width"],function(e,t){v.cssHooks[t]={get:function(e,n,r){if(n)return e.offsetWidth===0&&It.test(Dt(e,"display"))?v.swap(e,Xt,function(){return tn(e,t,r)}):tn(e,t,r)},set:function(e,n,r){return Zt(e,n,r?en(e,t,r,v.support.boxSizing&&v.css(e,"boxSizing")==="border-box"):0)}}}),v.support.opacity||(v.cssHooks.opacity={get:function(e,t){return jt.test((t&&e.currentStyle?e.currentStyle.filter:e.style.filter)||"")?.01*parseFloat(RegExp.$1)+"":t?"1":""},set:function(e,t){var n=e.style,r=e.currentStyle,i=v.isNumeric(t)?"alpha(opacity="+t*100+")":"",s=r&&r.filter||n.filter||"";n.zoom=1;if(t>=1&&v.trim(s.replace(Bt,""))===""&&n.removeAttribute){n.removeAttribute("filter");if(r&&!r.filter)return}n.filter=Bt.test(s)?s.replace(Bt,i):s+" "+i}}),v(function(){v.support.reliableMarginRight||(v.cssHooks.marginRight={get:function(e,t){return v.swap(e,{display:"inline-block"},function(){if(t)return Dt(e,"marginRight")})}}),!v.support.pixelPosition&&v.fn.position&&v.each(["top","left"],function(e,t){v.cssHooks[t]={get:function(e,n){if(n){var r=Dt(e,t);return Ut.test(r)?v(e).position()[t]+"px":r}}}})}),v.expr&&v.expr.filters&&(v.expr.filters.hidden=function(e){return e.offsetWidth===0&&e.offsetHeight===0||!v.support.reliableHiddenOffsets&&(e.style&&e.style.display||Dt(e,"display"))==="none"},v.expr.filters.visible=function(e){return!v.expr.filters.hidden(e)}),v.each({margin:"",padding:"",border:"Width"},function(e,t){v.cssHooks[e+t]={expand:function(n){var r,i=typeof n=="string"?n.split(" "):[n],s={};for(r=0;r<4;r++)s[e+$t[r]+t]=i[r]||i[r-2]||i[0];return s}},qt.test(e)||(v.cssHooks[e+t].set=Zt)});var rn=/%20/g,sn=/\[\]$/,on=/\r?\n/g,un=/^(?:color|date|datetime|datetime-local|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,an=/^(?:select|textarea)/i;v.fn.extend({serialize:function(){return v.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?v.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||an.test(this.nodeName)||un.test(this.type))}).map(function(e,t){var n=v(this).val();return n==null?null:v.isArray(n)?v.map(n,function(e,n){return{name:t.name,value:e.replace(on,"\r\n")}}):{name:t.name,value:n.replace(on,"\r\n")}}).get()}}),v.param=function(e,n){var r,i=[],s=function(e,t){t=v.isFunction(t)?t():t==null?"":t,i[i.length]=encodeURIComponent(e)+"="+encodeURIComponent(t)};n===t&&(n=v.ajaxSettings&&v.ajaxSettings.traditional);if(v.isArray(e)||e.jquery&&!v.isPlainObject(e))v.each(e,function(){s(this.name,this.value)});else for(r in e)fn(r,e[r],n,s);return i.join("&").replace(rn,"+")};var ln,cn,hn=/#.*$/,pn=/^(.*?):[ \t]*([^\r\n]*)\r?$/mg,dn=/^(?:about|app|app\-storage|.+\-extension|file|res|widget):$/,vn=/^(?:GET|HEAD)$/,mn=/^\/\//,gn=/\?/,yn=/)<[^<]*)*<\/script>/gi,bn=/([?&])_=[^&]*/,wn=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+)|)|)/,En=v.fn.load,Sn={},xn={},Tn=["*/"]+["*"];try{cn=s.href}catch(Nn){cn=i.createElement("a"),cn.href="",cn=cn.href}ln=wn.exec(cn.toLowerCase())||[],v.fn.load=function(e,n,r){if(typeof e!="string"&&En)return En.apply(this,arguments);if(!this.length)return this;var i,s,o,u=this,a=e.indexOf(" ");return a>=0&&(i=e.slice(a,e.length),e=e.slice(0,a)),v.isFunction(n)?(r=n,n=t):n&&typeof n=="object"&&(s="POST"),v.ajax({url:e,type:s,dataType:"html",data:n,complete:function(e,t){r&&u.each(r,o||[e.responseText,t,e])}}).done(function(e){o=arguments,u.html(i?v("
").append(e.replace(yn,"")).find(i):e)}),this},v.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(e,t){v.fn[t]=function(e){return this.on(t,e)}}),v.each(["get","post"],function(e,n){v[n]=function(e,r,i,s){return v.isFunction(r)&&(s=s||i,i=r,r=t),v.ajax({type:n,url:e,data:r,success:i,dataType:s})}}),v.extend({getScript:function(e,n){return v.get(e,t,n,"script")},getJSON:function(e,t,n){return v.get(e,t,n,"json")},ajaxSetup:function(e,t){return t?Ln(e,v.ajaxSettings):(t=e,e=v.ajaxSettings),Ln(e,t),e},ajaxSettings:{url:cn,isLocal:dn.test(ln[1]),global:!0,type:"GET",contentType:"application/x-www-form-urlencoded; charset=UTF-8",processData:!0,async:!0,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":Tn},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":e.String,"text html":!0,"text json":v.parseJSON,"text xml":v.parseXML},flatOptions:{context:!0,url:!0}},ajaxPrefilter:Cn(Sn),ajaxTransport:Cn(xn),ajax:function(e,n){function T(e,n,s,a){var l,y,b,w,S,T=n;if(E===2)return;E=2,u&&clearTimeout(u),o=t,i=a||"",x.readyState=e>0?4:0,s&&(w=An(c,x,s));if(e>=200&&e<300||e===304)c.ifModified&&(S=x.getResponseHeader("Last-Modified"),S&&(v.lastModified[r]=S),S=x.getResponseHeader("Etag"),S&&(v.etag[r]=S)),e===304?(T="notmodified",l=!0):(l=On(c,w),T=l.state,y=l.data,b=l.error,l=!b);else{b=T;if(!T||e)T="error",e<0&&(e=0)}x.status=e,x.statusText=(n||T)+"",l?d.resolveWith(h,[y,T,x]):d.rejectWith(h,[x,T,b]),x.statusCode(g),g=t,f&&p.trigger("ajax"+(l?"Success":"Error"),[x,c,l?y:b]),m.fireWith(h,[x,T]),f&&(p.trigger("ajaxComplete",[x,c]),--v.active||v.event.trigger("ajaxStop"))}typeof e=="object"&&(n=e,e=t),n=n||{};var r,i,s,o,u,a,f,l,c=v.ajaxSetup({},n),h=c.context||c,p=h!==c&&(h.nodeType||h instanceof v)?v(h):v.event,d=v.Deferred(),m=v.Callbacks("once memory"),g=c.statusCode||{},b={},w={},E=0,S="canceled",x={readyState:0,setRequestHeader:function(e,t){if(!E){var n=e.toLowerCase();e=w[n]=w[n]||e,b[e]=t}return this},getAllResponseHeaders:function(){return E===2?i:null},getResponseHeader:function(e){var n;if(E===2){if(!s){s={};while(n=pn.exec(i))s[n[1].toLowerCase()]=n[2]}n=s[e.toLowerCase()]}return n===t?null:n},overrideMimeType:function(e){return E||(c.mimeType=e),this},abort:function(e){return e=e||S,o&&o.abort(e),T(0,e),this}};d.promise(x),x.success=x.done,x.error=x.fail,x.complete=m.add,x.statusCode=function(e){if(e){var t;if(E<2)for(t in e)g[t]=[g[t],e[t]];else t=e[x.status],x.always(t)}return this},c.url=((e||c.url)+"").replace(hn,"").replace(mn,ln[1]+"//"),c.dataTypes=v.trim(c.dataType||"*").toLowerCase().split(y),c.crossDomain==null&&(a=wn.exec(c.url.toLowerCase()),c.crossDomain=!(!a||a[1]===ln[1]&&a[2]===ln[2]&&(a[3]||(a[1]==="http:"?80:443))==(ln[3]||(ln[1]==="http:"?80:443)))),c.data&&c.processData&&typeof c.data!="string"&&(c.data=v.param(c.data,c.traditional)),kn(Sn,c,n,x);if(E===2)return x;f=c.global,c.type=c.type.toUpperCase(),c.hasContent=!vn.test(c.type),f&&v.active++===0&&v.event.trigger("ajaxStart");if(!c.hasContent){c.data&&(c.url+=(gn.test(c.url)?"&":"?")+c.data,delete c.data),r=c.url;if(c.cache===!1){var N=v.now(),C=c.url.replace(bn,"$1_="+N);c.url=C+(C===c.url?(gn.test(c.url)?"&":"?")+"_="+N:"")}}(c.data&&c.hasContent&&c.contentType!==!1||n.contentType)&&x.setRequestHeader("Content-Type",c.contentType),c.ifModified&&(r=r||c.url,v.lastModified[r]&&x.setRequestHeader("If-Modified-Since",v.lastModified[r]),v.etag[r]&&x.setRequestHeader("If-None-Match",v.etag[r])),x.setRequestHeader("Accept",c.dataTypes[0]&&c.accepts[c.dataTypes[0]]?c.accepts[c.dataTypes[0]]+(c.dataTypes[0]!=="*"?", "+Tn+"; q=0.01":""):c.accepts["*"]);for(l in c.headers)x.setRequestHeader(l,c.headers[l]);if(!c.beforeSend||c.beforeSend.call(h,x,c)!==!1&&E!==2){S="abort";for(l in{success:1,error:1,complete:1})x[l](c[l]);o=kn(xn,c,n,x);if(!o)T(-1,"No Transport");else{x.readyState=1,f&&p.trigger("ajaxSend",[x,c]),c.async&&c.timeout>0&&(u=setTimeout(function(){x.abort("timeout")},c.timeout));try{E=1,o.send(b,T)}catch(k){if(!(E<2))throw k;T(-1,k)}}return x}return x.abort()},active:0,lastModified:{},etag:{}});var Mn=[],_n=/\?/,Dn=/(=)\?(?=&|$)|\?\?/,Pn=v.now();v.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Mn.pop()||v.expando+"_"+Pn++;return this[e]=!0,e}}),v.ajaxPrefilter("json jsonp",function(n,r,i){var s,o,u,a=n.data,f=n.url,l=n.jsonp!==!1,c=l&&Dn.test(f),h=l&&!c&&typeof a=="string"&&!(n.contentType||"").indexOf("application/x-www-form-urlencoded")&&Dn.test(a);if(n.dataTypes[0]==="jsonp"||c||h)return s=n.jsonpCallback=v.isFunction(n.jsonpCallback)?n.jsonpCallback():n.jsonpCallback,o=e[s],c?n.url=f.replace(Dn,"$1"+s):h?n.data=a.replace(Dn,"$1"+s):l&&(n.url+=(_n.test(f)?"&":"?")+n.jsonp+"="+s),n.converters["script json"]=function(){return u||v.error(s+" was not called"),u[0]},n.dataTypes[0]="json",e[s]=function(){u=arguments},i.always(function(){e[s]=o,n[s]&&(n.jsonpCallback=r.jsonpCallback,Mn.push(s)),u&&v.isFunction(o)&&o(u[0]),u=o=t}),"script"}),v.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/javascript|ecmascript/},converters:{"text script":function(e){return v.globalEval(e),e}}}),v.ajaxPrefilter("script",function(e){e.cache===t&&(e.cache=!1),e.crossDomain&&(e.type="GET",e.global=!1)}),v.ajaxTransport("script",function(e){if(e.crossDomain){var n,r=i.head||i.getElementsByTagName("head")[0]||i.documentElement;return{send:function(s,o){n=i.createElement("script"),n.async="async",e.scriptCharset&&(n.charset=e.scriptCharset),n.src=e.url,n.onload=n.onreadystatechange=function(e,i){if(i||!n.readyState||/loaded|complete/.test(n.readyState))n.onload=n.onreadystatechange=null,r&&n.parentNode&&r.removeChild(n),n=t,i||o(200,"success")},r.insertBefore(n,r.firstChild)},abort:function(){n&&n.onload(0,1)}}}});var Hn,Bn=e.ActiveXObject?function(){for(var e in Hn)Hn[e](0,1)}:!1,jn=0;v.ajaxSettings.xhr=e.ActiveXObject?function(){return!this.isLocal&&Fn()||In()}:Fn,function(e){v.extend(v.support,{ajax:!!e,cors:!!e&&"withCredentials"in e})}(v.ajaxSettings.xhr()),v.support.ajax&&v.ajaxTransport(function(n){if(!n.crossDomain||v.support.cors){var r;return{send:function(i,s){var o,u,a=n.xhr();n.username?a.open(n.type,n.url,n.async,n.username,n.password):a.open(n.type,n.url,n.async);if(n.xhrFields)for(u in n.xhrFields)a[u]=n.xhrFields[u];n.mimeType&&a.overrideMimeType&&a.overrideMimeType(n.mimeType),!n.crossDomain&&!i["X-Requested-With"]&&(i["X-Requested-With"]="XMLHttpRequest");try{for(u in i)a.setRequestHeader(u,i[u])}catch(f){}a.send(n.hasContent&&n.data||null),r=function(e,i){var u,f,l,c,h;try{if(r&&(i||a.readyState===4)){r=t,o&&(a.onreadystatechange=v.noop,Bn&&delete Hn[o]);if(i)a.readyState!==4&&a.abort();else{u=a.status,l=a.getAllResponseHeaders(),c={},h=a.responseXML,h&&h.documentElement&&(c.xml=h);try{c.text=a.responseText}catch(p){}try{f=a.statusText}catch(p){f=""}!u&&n.isLocal&&!n.crossDomain?u=c.text?200:404:u===1223&&(u=204)}}}catch(d){i||s(-1,d)}c&&s(u,f,c,l)},n.async?a.readyState===4?setTimeout(r,0):(o=++jn,Bn&&(Hn||(Hn={},v(e).unload(Bn)),Hn[o]=r),a.onreadystatechange=r):r()},abort:function(){r&&r(0,1)}}}});var qn,Rn,Un=/^(?:toggle|show|hide)$/,zn=new RegExp("^(?:([-+])=|)("+m+")([a-z%]*)$","i"),Wn=/queueHooks$/,Xn=[Gn],Vn={"*":[function(e,t){var n,r,i=this.createTween(e,t),s=zn.exec(t),o=i.cur(),u=+o||0,a=1,f=20;if(s){n=+s[2],r=s[3]||(v.cssNumber[e]?"":"px");if(r!=="px"&&u){u=v.css(i.elem,e,!0)||n||1;do a=a||".5",u/=a,v.style(i.elem,e,u+r);while(a!==(a=i.cur()/o)&&a!==1&&--f)}i.unit=r,i.start=u,i.end=s[1]?u+(s[1]+1)*n:n}return i}]};v.Animation=v.extend(Kn,{tweener:function(e,t){v.isFunction(e)?(t=e,e=["*"]):e=e.split(" ");var n,r=0,i=e.length;for(;r-1,f={},l={},c,h;a?(l=i.position(),c=l.top,h=l.left):(c=parseFloat(o)||0,h=parseFloat(u)||0),v.isFunction(t)&&(t=t.call(e,n,s)),t.top!=null&&(f.top=t.top-s.top+c),t.left!=null&&(f.left=t.left-s.left+h),"using"in t?t.using.call(e,f):i.css(f)}},v.fn.extend({position:function(){if(!this[0])return;var e=this[0],t=this.offsetParent(),n=this.offset(),r=er.test(t[0].nodeName)?{top:0,left:0}:t.offset();return n.top-=parseFloat(v.css(e,"marginTop"))||0,n.left-=parseFloat(v.css(e,"marginLeft"))||0,r.top+=parseFloat(v.css(t[0],"borderTopWidth"))||0,r.left+=parseFloat(v.css(t[0],"borderLeftWidth"))||0,{top:n.top-r.top,left:n.left-r.left}},offsetParent:function(){return this.map(function(){var e=this.offsetParent||i.body;while(e&&!er.test(e.nodeName)&&v.css(e,"position")==="static")e=e.offsetParent;return e||i.body})}}),v.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(e,n){var r=/Y/.test(n);v.fn[e]=function(i){return v.access(this,function(e,i,s){var o=tr(e);if(s===t)return o?n in o?o[n]:o.document.documentElement[i]:e[i];o?o.scrollTo(r?v(o).scrollLeft():s,r?s:v(o).scrollTop()):e[i]=s},e,i,arguments.length,null)}}),v.each({Height:"height",Width:"width"},function(e,n){v.each({padding:"inner"+e,content:n,"":"outer"+e},function(r,i){v.fn[i]=function(i,s){var o=arguments.length&&(r||typeof i!="boolean"),u=r||(i===!0||s===!0?"margin":"border");return v.access(this,function(n,r,i){var s;return v.isWindow(n)?n.document.documentElement["client"+e]:n.nodeType===9?(s=n.documentElement,Math.max(n.body["scroll"+e],s["scroll"+e],n.body["offset"+e],s["offset"+e],s["client"+e])):i===t?v.css(n,r,i,u):v.style(n,r,i,u)},n,o?i:t,o,null)}})}),e.jQuery=e.$=v,typeof define=="function"&&define.amd&&define.amd.jQuery&&define("jquery",[],function(){return v})})(window); \ No newline at end of file diff --git a/user_guide/_static/js/oldtheme.js b/user_guide/_static/js/oldtheme.js deleted file mode 100755 index 60520cc..0000000 --- a/user_guide/_static/js/oldtheme.js +++ /dev/null @@ -1,47 +0,0 @@ -$( document ).ready(function() { - // Shift nav in mobile when clicking the menu. - $(document).on('click', "[data-toggle='wy-nav-top']", function() { - $("[data-toggle='wy-nav-shift']").toggleClass("shift"); - $("[data-toggle='rst-versions']").toggleClass("shift"); - }); - // Close menu when you click a link. - $(document).on('click', ".wy-menu-vertical .current ul li a", function() { - $("[data-toggle='wy-nav-shift']").removeClass("shift"); - $("[data-toggle='rst-versions']").toggleClass("shift"); - }); - $(document).on('click', "[data-toggle='rst-current-version']", function() { - $("[data-toggle='rst-versions']").toggleClass("shift-up"); - }); - // Make tables responsive - $("table.docutils:not(.field-list)").wrap("
"); -}); - -window.SphinxRtdTheme = (function (jquery) { - var stickyNav = (function () { - var navBar, - win, - stickyNavCssClass = 'stickynav', - applyStickNav = function () { - if (navBar.height() <= win.height()) { - navBar.addClass(stickyNavCssClass); - } else { - navBar.removeClass(stickyNavCssClass); - } - }, - enable = function () { - applyStickNav(); - win.on('resize', applyStickNav); - }, - init = function () { - navBar = jquery('nav.wy-nav-side:first'); - win = jquery(window); - }; - jquery(init); - return { - enable : enable - }; - }()); - return { - StickyNav : stickyNav - }; -}($)); diff --git a/user_guide/_static/js/theme.js b/user_guide/_static/js/theme.js deleted file mode 100755 index 081d77b..0000000 --- a/user_guide/_static/js/theme.js +++ /dev/null @@ -1,131 +0,0 @@ -$(document).ready(function () { - // Shift nav in mobile when clicking the menu. - $(document).on('click', "[data-toggle='wy-nav-top']", function () { - $("[data-toggle='wy-nav-shift']").toggleClass("shift"); - $("[data-toggle='rst-versions']").toggleClass("shift"); - }); - // Close menu when you click a link. - $(document).on('click', ".wy-menu-vertical .current ul li a", function () { - $("[data-toggle='wy-nav-shift']").removeClass("shift"); - $("[data-toggle='rst-versions']").toggleClass("shift"); - }); - $(document).on('click', "[data-toggle='rst-current-version']", function () { - $("[data-toggle='rst-versions']").toggleClass("shift-up"); - }); - // Make tables responsive - $("table.docutils:not(.field-list)").wrap("
"); - // --- - // START DOC MODIFICATION BY RUFNEX - // v1.0 04.02.2015 - // Add ToogleButton to get FullWidth-View by Johannes Gamperl codeigniter.de - - $('#openToc').click(function () { - $('#nav').slideToggle(); - }); - $('#closeMe').toggle( - function () - { - setCookie('ciNav', 'yes', 365); - $('#nav2').show(); - $('#topMenu').remove(); - $('body').css({background: 'none'}); - $('.wy-nav-content-wrap').css({background: 'none', 'margin-left': 0}); - $('.wy-breadcrumbs').append('
' + $('.wy-form').parent().html() + '
'); - $('.wy-nav-side').toggle(); - }, - function () - { - setCookie('ciNav', 'no', 365); - $('#topMenu').remove(); - $('#nav').hide(); - $('#nav2').hide(); - $('body').css({background: '#edf0f2;'}); - $('.wy-nav-content-wrap').css({background: 'none repeat scroll 0 0 #fcfcfc;', 'margin-left': '300px'}); - $('.wy-nav-side').show(); - } - ); - if (getCookie('ciNav') == 'yes') - { - $('#closeMe').trigger('click'); - //$('#nav').slideToggle(); - } - // END MODIFICATION --- - -}); - -// Rufnex Cookie functions -function setCookie(cname, cvalue, exdays) { - // expire the old cookie if existed to avoid multiple cookies with the same name - if (getCookie(cname)) { - document.cookie = cname + "=;expires=Thu, 01 Jan 1970 00:00:00 GMT"; - } - var d = new Date(); - d.setTime(d.getTime() + (exdays * 24 * 60 * 60 * 1000)); - var expires = "expires=" + d.toGMTString(); - document.cookie = cname + "=" + cvalue + "; " + expires + "; path=/"; -} -function getCookie(cname) { - var name = cname + "="; - var ca = document.cookie.split(';'); - for (var i = 0; i < ca.length; i++) { - var c = ca[i]; - while (c.charAt(0) == ' ') - c = c.substring(1); - if (c.indexOf(name) == 0) { - return c.substring(name.length, c.length); - } - } - return ''; -} -// End - -// resize window -$(window).on('resize', function(){ - // show side nav on small screens when pulldown is enabled - if (getCookie('ciNav') == 'yes' && $(window).width() <= 768) { // 768px is the tablet size defined by the theme - $('.wy-nav-side').show(); - } - // changing css with jquery seems to override the default css media query - // change margin - else if (getCookie('ciNav') == 'no' && $(window).width() <= 768) { - $('.wy-nav-content-wrap').css({'margin-left': 0}); - } - // hide side nav on large screens when pulldown is enabled - else if (getCookie('ciNav') == 'yes' && $(window).width() > 768) { - $('.wy-nav-side').hide(); - } - // change margin - else if (getCookie('ciNav') == 'no' && $(window).width() > 768) { - $('.wy-nav-content-wrap').css({'margin-left': '300px'}); - } -}); - -window.SphinxRtdTheme = (function (jquery) { - var stickyNav = (function () { - var navBar, - win, - stickyNavCssClass = 'stickynav', - applyStickNav = function () { - if (navBar.height() <= win.height()) { - navBar.addClass(stickyNavCssClass); - } else { - navBar.removeClass(stickyNavCssClass); - } - }, - enable = function () { - applyStickNav(); - win.on('resize', applyStickNav); - }, - init = function () { - navBar = jquery('nav.wy-nav-side:first'); - win = jquery(window); - }; - jquery(init); - return { - enable: enable - }; - }()); - return { - StickyNav: stickyNav - }; -}($)); diff --git a/user_guide/_static/minus.png b/user_guide/_static/minus.png deleted file mode 100755 index da1c562..0000000 Binary files a/user_guide/_static/minus.png and /dev/null differ diff --git a/user_guide/_static/plus.png b/user_guide/_static/plus.png deleted file mode 100755 index b3cb374..0000000 Binary files a/user_guide/_static/plus.png and /dev/null differ diff --git a/user_guide/_static/pygments.css b/user_guide/_static/pygments.css deleted file mode 100755 index ec544a6..0000000 --- a/user_guide/_static/pygments.css +++ /dev/null @@ -1,61 +0,0 @@ -.highlight .hll { background-color: #ffffcc } -.highlight { background: #ffffff; } -.highlight .c { color: #999988; font-style: italic } /* Comment */ -.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ -.highlight .k { font-weight: bold } /* Keyword */ -.highlight .o { font-weight: bold } /* Operator */ -.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */ -.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #aa0000 } /* Generic.Error */ -.highlight .gh { color: #999999 } /* Generic.Heading */ -.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ -.highlight .go { color: #888888 } /* Generic.Output */ -.highlight .gp { color: #555555 } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #aaaaaa } /* Generic.Subheading */ -.highlight .gt { color: #aa0000 } /* Generic.Traceback */ -.highlight .kc { font-weight: bold } /* Keyword.Constant */ -.highlight .kd { font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { font-weight: bold } /* Keyword.Pseudo */ -.highlight .kr { font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */ -.highlight .m { color: #009999 } /* Literal.Number */ -.highlight .s { color: #bb8844 } /* Literal.String */ -.highlight .na { color: #008080 } /* Name.Attribute */ -.highlight .nb { color: #999999 } /* Name.Builtin */ -.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */ -.highlight .no { color: #008080 } /* Name.Constant */ -.highlight .ni { color: #800080 } /* Name.Entity */ -.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */ -.highlight .nn { color: #555555 } /* Name.Namespace */ -.highlight .nt { color: #000080 } /* Name.Tag */ -.highlight .nv { color: #008080 } /* Name.Variable */ -.highlight .ow { font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mb { color: #009999 } /* Literal.Number.Bin */ -.highlight .mf { color: #009999 } /* Literal.Number.Float */ -.highlight .mh { color: #009999 } /* Literal.Number.Hex */ -.highlight .mi { color: #009999 } /* Literal.Number.Integer */ -.highlight .mo { color: #009999 } /* Literal.Number.Oct */ -.highlight .sb { color: #bb8844 } /* Literal.String.Backtick */ -.highlight .sc { color: #bb8844 } /* Literal.String.Char */ -.highlight .sd { color: #bb8844 } /* Literal.String.Doc */ -.highlight .s2 { color: #bb8844 } /* Literal.String.Double */ -.highlight .se { color: #bb8844 } /* Literal.String.Escape */ -.highlight .sh { color: #bb8844 } /* Literal.String.Heredoc */ -.highlight .si { color: #bb8844 } /* Literal.String.Interpol */ -.highlight .sx { color: #bb8844 } /* Literal.String.Other */ -.highlight .sr { color: #808000 } /* Literal.String.Regex */ -.highlight .s1 { color: #bb8844 } /* Literal.String.Single */ -.highlight .ss { color: #bb8844 } /* Literal.String.Symbol */ -.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */ -.highlight .vc { color: #008080 } /* Name.Variable.Class */ -.highlight .vg { color: #008080 } /* Name.Variable.Global */ -.highlight .vi { color: #008080 } /* Name.Variable.Instance */ -.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/user_guide/_static/searchtools.js b/user_guide/_static/searchtools.js deleted file mode 100755 index 6e1f06b..0000000 --- a/user_guide/_static/searchtools.js +++ /dev/null @@ -1,622 +0,0 @@ -/* - * searchtools.js_t - * ~~~~~~~~~~~~~~~~ - * - * Sphinx JavaScript utilties for the full-text search. - * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - - -/** - * Porter Stemmer - */ -var Stemmer = function() { - - var step2list = { - ational: 'ate', - tional: 'tion', - enci: 'ence', - anci: 'ance', - izer: 'ize', - bli: 'ble', - alli: 'al', - entli: 'ent', - eli: 'e', - ousli: 'ous', - ization: 'ize', - ation: 'ate', - ator: 'ate', - alism: 'al', - iveness: 'ive', - fulness: 'ful', - ousness: 'ous', - aliti: 'al', - iviti: 'ive', - biliti: 'ble', - logi: 'log' - }; - - var step3list = { - icate: 'ic', - ative: '', - alize: 'al', - iciti: 'ic', - ical: 'ic', - ful: '', - ness: '' - }; - - var c = "[^aeiou]"; // consonant - var v = "[aeiouy]"; // vowel - var C = c + "[^aeiouy]*"; // consonant sequence - var V = v + "[aeiou]*"; // vowel sequence - - var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } -} - - - -/** - * Simple result scoring code. - */ -var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [filename, title, anchor, descr, score] - // and returns the new score. - /* - score: function(result) { - return result[4]; - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: {0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5}, // used to be unimportantResults - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - // query found in terms - term: 5 -}; - - -/** - * Search Module - */ -var Search = { - - _index : null, - _queued_query : null, - _pulse_status : -1, - - init : function() { - var params = $.getQueryParameters(); - if (params.q) { - var query = params.q[0]; - $('input[name="q"]')[0].value = query; - this.performSearch(query); - } - }, - - loadIndex : function(url) { - $.ajax({type: "GET", url: url, data: null, - dataType: "script", cache: true, - complete: function(jqxhr, textstatus) { - if (textstatus != "success") { - document.getElementById("searchindexloader").src = url; - } - }}); - }, - - setIndex : function(index) { - var q; - this._index = index; - if ((q = this._queued_query) !== null) { - this._queued_query = null; - Search.query(q); - } - }, - - hasIndex : function() { - return this._index !== null; - }, - - deferQuery : function(query) { - this._queued_query = query; - }, - - stopPulse : function() { - this._pulse_status = 0; - }, - - startPulse : function() { - if (this._pulse_status >= 0) - return; - function pulse() { - var i; - Search._pulse_status = (Search._pulse_status + 1) % 4; - var dotString = ''; - for (i = 0; i < Search._pulse_status; i++) - dotString += '.'; - Search.dots.text(dotString); - if (Search._pulse_status > -1) - window.setTimeout(pulse, 500); - } - pulse(); - }, - - /** - * perform a search for something (or wait until index is loaded) - */ - performSearch : function(query) { - // create the required interface elements - this.out = $('#search-results'); - this.title = $('

' + _('Searching') + '

').appendTo(this.out); - this.dots = $('').appendTo(this.title); - this.status = $('

').appendTo(this.out); - this.output = $('
'); - } - // Prettify the comment rating. - comment.pretty_rating = comment.rating + ' point' + - (comment.rating == 1 ? '' : 's'); - // Make a class (for displaying not yet moderated comments differently) - comment.css_class = comment.displayed ? '' : ' moderate'; - // Create a div for this comment. - var context = $.extend({}, opts, comment); - var div = $(renderTemplate(commentTemplate, context)); - - // If the user has voted on this comment, highlight the correct arrow. - if (comment.vote) { - var direction = (comment.vote == 1) ? 'u' : 'd'; - div.find('#' + direction + 'v' + comment.id).hide(); - div.find('#' + direction + 'u' + comment.id).show(); - } - - if (opts.moderator || comment.text != '[deleted]') { - div.find('a.reply').show(); - if (comment.proposal_diff) - div.find('#sp' + comment.id).show(); - if (opts.moderator && !comment.displayed) - div.find('#cm' + comment.id).show(); - if (opts.moderator || (opts.username == comment.username)) - div.find('#dc' + comment.id).show(); - } - return div; - } - - /** - * A simple template renderer. Placeholders such as <%id%> are replaced - * by context['id'] with items being escaped. Placeholders such as <#id#> - * are not escaped. - */ - function renderTemplate(template, context) { - var esc = $(document.createElement('div')); - - function handle(ph, escape) { - var cur = context; - $.each(ph.split('.'), function() { - cur = cur[this]; - }); - return escape ? esc.text(cur || "").html() : cur; - } - - return template.replace(/<([%#])([\w\.]*)\1>/g, function() { - return handle(arguments[2], arguments[1] == '%' ? true : false); - }); - } - - /** Flash an error message briefly. */ - function showError(message) { - $(document.createElement('div')).attr({'class': 'popup-error'}) - .append($(document.createElement('div')) - .attr({'class': 'error-message'}).text(message)) - .appendTo('body') - .fadeIn("slow") - .delay(2000) - .fadeOut("slow"); - } - - /** Add a link the user uses to open the comments popup. */ - $.fn.comment = function() { - return this.each(function() { - var id = $(this).attr('id').substring(1); - var count = COMMENT_METADATA[id]; - var title = count + ' comment' + (count == 1 ? '' : 's'); - var image = count > 0 ? opts.commentBrightImage : opts.commentImage; - var addcls = count == 0 ? ' nocomment' : ''; - $(this) - .append( - $(document.createElement('a')).attr({ - href: '#', - 'class': 'sphinx-comment-open' + addcls, - id: 'ao' + id - }) - .append($(document.createElement('img')).attr({ - src: image, - alt: 'comment', - title: title - })) - .click(function(event) { - event.preventDefault(); - show($(this).attr('id').substring(2)); - }) - ) - .append( - $(document.createElement('a')).attr({ - href: '#', - 'class': 'sphinx-comment-close hidden', - id: 'ah' + id - }) - .append($(document.createElement('img')).attr({ - src: opts.closeCommentImage, - alt: 'close', - title: 'close' - })) - .click(function(event) { - event.preventDefault(); - hide($(this).attr('id').substring(2)); - }) - ); - }); - }; - - var opts = { - processVoteURL: '/_process_vote', - addCommentURL: '/_add_comment', - getCommentsURL: '/_get_comments', - acceptCommentURL: '/_accept_comment', - deleteCommentURL: '/_delete_comment', - commentImage: '/static/_static/comment.png', - closeCommentImage: '/static/_static/comment-close.png', - loadingImage: '/static/_static/ajax-loader.gif', - commentBrightImage: '/static/_static/comment-bright.png', - upArrow: '/static/_static/up.png', - downArrow: '/static/_static/down.png', - upArrowPressed: '/static/_static/up-pressed.png', - downArrowPressed: '/static/_static/down-pressed.png', - voting: false, - moderator: false - }; - - if (typeof COMMENT_OPTIONS != "undefined") { - opts = jQuery.extend(opts, COMMENT_OPTIONS); - } - - var popupTemplate = '\ -
\ -

\ - Sort by:\ - best rated\ - newest\ - oldest\ -

\ -
Comments
\ -
\ - loading comments...
\ -
    \ -
    \ -

    Add a comment\ - (markup):

    \ -
    \ - reStructured text markup: *emph*, **strong**, \ - ``code``, \ - code blocks: :: and an indented block after blank line
    \ -
    \ - \ -

    \ - \ - Propose a change ▹\ - \ - \ - Propose a change ▿\ - \ -

    \ - \ - \ - \ - \ - \ -
    \ -
    '; - - var commentTemplate = '\ -
    \ -
    \ -
    \ - \ - \ - \ - \ - \ - \ -
    \ -
    \ - \ - \ - \ - \ - \ - \ -
    \ -
    \ -
    \ -

    \ - <%username%>\ - <%pretty_rating%>\ - <%time.delta%>\ -

    \ -
    <#text#>
    \ -

    \ - \ - reply ▿\ - proposal ▹\ - proposal ▿\ - \ - \ -

    \ - 
    \
-<#proposal_diff#>\
-
    \ -
      \ -
      \ -
      \ -
      \ - '; - - var replyTemplate = '\ -
    • \ -
      \ -
      \ - \ - \ - \ - \ - \ - \ -
      \ -
      • '; - - $(document).ready(function() { - init(); - }); -})(jQuery); - -$(document).ready(function() { - // add comment anchors for all paragraphs that are commentable - $('.sphinx-has-comment').comment(); - - // highlight search words in search results - $("div.context").each(function() { - var params = $.getQueryParameters(); - var terms = (params.q) ? params.q[0].split(/\s+/) : []; - var result = $(this); - $.each(terms, function() { - result.highlightText(this.toLowerCase(), 'highlighted'); - }); - }); - - // directly open comment window if requested - var anchor = document.location.hash; - if (anchor.substring(0, 9) == '#comment-') { - $('#ao' + anchor.substring(9)).click(); - document.location.hash = '#s' + anchor.substring(9); - } -}); diff --git a/user_guide/changelog.html b/user_guide/changelog.html deleted file mode 100755 index fe4df4f..0000000 --- a/user_guide/changelog.html +++ /dev/null @@ -1,3753 +0,0 @@ - - - - - - - - - - Change Log — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Change Log
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Change Log

      -
      -

      Version 3.0.3

      -

      Release Date: October 31, 2015

      -
        -
      • Security
          -
        • Fixed an XSS attack vector in Security Library method xss_clean().
          • -
        • Changed Config Library method base_url() to fallback to $_SERVER['SERVER_ADDR'] when $config['base_url'] is empty in order to avoid Host header injections.
          • -
        • Changed CAPTCHA Helper to use the operating system’s PRNG when possible.
          • -
        -
        • -
      • Database -
        • -
      -
      -

      Bug fixes for 3.0.3

      -
        -
      • Fixed a bug (#4170) - Database method insert_id() could return an identity from the wrong scope with the ‘sqlsrv’ driver.
        • -
      • Fixed a bug (#4179) - Session Library doesn’t properly maintain its state after ID regeneration with the ‘database’ driver on PHP7.
        • -
      • Fixed a bug (#4173) - Database Forge method add_key() didn’t allow creation of non-PRIMARY composite keys after the “bugfix” for #3968.
        • -
      • Fixed a bug (#4171) - Database Transactions didn’t work with nesting in methods trans_begin(), trans_commit(), trans_rollback().
        • -
      • Fixed a bug where Database Transaction methods trans_begin(), trans_commit(), trans_rollback() ignored failures.
        • -
      • Fixed a bug where all Database Transaction methods returned TRUE while transactions are actually disabled.
        • -
      • Fixed a bug where common function html_escape() modified keys of its array inputs.
        • -
      • Fixed a bug (#4192) - Email Library wouldn’t always have proper Quoted-printable encoding due to a bug in PHP’s own mb_mime_encodeheader() function.
        • -
      -
      -
      -
      -

      Version 3.0.2

      -

      Release Date: October 8, 2015

      -
        -
      • Security -
        • -
      • General Changes
          -
        • Updated the application/config/constants.php file to check if constants aren’t already defined before doing that.
          • -
        • Changed Loader Library method model() to only apply ucfirst() and not strtolower() to the requested class name.
          • -
        • Changed Config Library methods base_url(), site_url() to allow protocol-relative URLs by passing an empty string as the protocol.
          • -
        -
        • -
      -
      -

      Bug fixes for 3.0.2

      -
        -
      • Fixed a bug (#2284) - Database method protect_identifiers() breaks when Query Builder isn’t enabled.
        • -
      • Fixed a bug (#4052) - Routing with anonymous functions didn’t work for routes that don’t use regular expressions.
        • -
      • Fixed a bug (#4056) - Input Library method get_request_header() could not return a value unless request_headers() was called beforehand.
        • -
      • Fixed a bug where the Database Class entered an endless loop if it fails to connect with the ‘sqlsrv’ driver.
        • -
      • Fixed a bug (#4065) - Database method protect_identifiers() treats a traling space as an alias separator if the input doesn’t contain ‘ AS ‘.
        • -
      • Fixed a bug (#4066) - Cache Library couldn’t fallback to a backup driver if the primary one is Memcache(d) or Redis.
        • -
      • Fixed a bug (#4073) - Email Library method send() could return TRUE in case of an actual failure when an SMTP command fails.
        • -
      • Fixed a bug (#4086) - Query Builder didn’t apply dbprefix to LIKE conditions if the pattern included spaces.
        • -
      • Fixed a bug (#4091) - Cache Library ‘file’ driver could be tricked into accepting empty cache item IDs.
        • -
      • Fixed a bug (#4093) - Query Builder modified string values containing ‘AND’, ‘OR’ while compiling WHERE conditions.
        • -
      • Fixed a bug (#4096) - Query Builder didn’t apply dbprefix when compiling BETWEEN conditions.
        • -
      • Fixed a bug (#4105) - Form Validation Library didn’t allow pipe characters inside “bracket parameters” when using a string ruleset.
        • -
      • Fixed a bug (#4109) - Routing to default_controller didn’t work when enable_query_strings is set to TRUE.
        • -
      • Fixed a bug (#4044) - Cache Library ‘redis’ driver didn’t catch RedisException that could be thrown during authentication.
        • -
      • Fixed a bug (#4120) - Database method error() didn’t return error info when called after query() with the ‘mssql’ driver.
        • -
      • Fixed a bug (#4116) - Pagination Library set the wrong page number on the “data-ci-pagination-page” attribute in generated links.
        • -
      • Fixed a bug where Pagination Library added the ‘rel=”start”’ attribute to the first displayed link even if it’s not actually linking the first page.
        • -
      • Fixed a bug (#4137) - Error Handling breaks for the new Error exceptions under PHP 7.
        • -
      • Fixed a bug (#4126) - Form Validation Library method reset_validation() discarded validation rules from config files.
        • -
      -
      -
      -
      -

      Version 3.0.1

      -

      Release Date: August 7, 2015

      -
        -
      • Core -
        • -
      • Database
          -
        • Added list_fields() support for SQLite (‘sqlite3’ and ‘pdo_sqlite’ drivers).
          • -
        • Added SSL connection support for the ‘mysqli’ and ‘pdo_mysql’ drivers.
          • -
        -
        • -
      • Libraries
          -
        • File Uploading Library changes:
            -
          • Changed method set_error() to accept a custom log level (defaults to ‘error’).
            • -
          • Errors “no_file_selected”, “file_partial”, “stopped_by_extension”, “no_file_types”, “invalid_filetype”, “bad_filename” are now logged at the ‘debug’ level.
            • -
          • Errors “file_exceeds_limit”, “file_exceeds_form_limit”, “invalid_filesize”, “invalid_dimensions” are now logged at the ‘info’ level.
            • -
          -
          • -
        • Added ‘is_resource’ to the available expectations in Unit Testing Library.
          • -
        -
        • -
      • Helpers
          -
        • Added Unicode support to URL Helper function url_title().
          • -
        • Added support for passing the “extra” parameter as an array to all Form Helper functions that use it.
          • -
        -
        • -
      • Core
          -
        • Added support for defining a list of specific query parameters in $config['cache_query_string'] for the Output Library.
          • -
        • Added class existence and inheritance checks to CI_Loader::model() in order to ease debugging in case of name collisions.
          • -
        -
        • -
      -
      -

      Bug fixes for 3.0.1

      -
        -
      • Fixed a bug (#3733) - Autoloading of libraries with aliases didn’t work, although it was advertised to.
        • -
      • Fixed a bug (#3744) - Redis Caching driver didn’t handle authentication failures properly.
        • -
      • Fixed a bug (#3761) - URL Helper function anchor() didn’t work with array inputs.
        • -
      • Fixed a bug (#3773) - db_select() didn’t work for MySQL with the PDO Database driver.
        • -
      • Fixed a bug (#3771) - Form Validation Library was looking for a ‘form_validation_’ prefix when trying to translate field name labels.
        • -
      • Fixed a bug (#3787) - FTP Library method delete_dir() failed when the target has subdirectories.
        • -
      • Fixed a bug (#3801) - Output Library method _display_cache() incorrectly looked for the last modified time of a directory instead of the cache file.
        • -
      • Fixed a bug (#3816) - Form Validation Library treated empty string values as non-existing ones.
        • -
      • Fixed a bug (#3823) - Session Library drivers Redis and Memcached didn’t properly handle locks that are blocking the request for more than 30 seconds.
        • -
      • Fixed a bug (#3846) - Image Manipulation Library method image_mirror_gd() didn’t properly initialize its variables.
        • -
      • Fixed a bug (#3854) - field_data() didn’t work properly with the Oracle (OCI8) database driver.
        • -
      • Fixed a bug in the Database Utility Class method csv_from_result() didn’t work with a whitespace CSV delimiter.
        • -
      • Fixed a bug (#3890) - Input Library method get_request_header() treated header names as case-sensitive.
        • -
      • Fixed a bug (#3903) - Form Validation Library ignored “unnamed” closure validation rules.
        • -
      • Fixed a bug (#3904) - Form Validation Library ignored “named” callback rules when the field is empty and there’s no ‘required’ rule.
        • -
      • Fixed a bug (#3922) - Email and XML-RPC libraries could enter an infinite loop due to PHP bug #39598.
        • -
      • Fixed a bug (#3913) - Cache Library didn’t work with the direct $this->cache->$driver_name->method() syntax with Redis and Memcache(d).
        • -
      • Fixed a bug (#3932) - Query Builder didn’t properly compile WHERE and HAVING conditions for field names that end with “and”, “or”.
        • -
      • Fixed a bug in Query Builder where delete() didn’t properly work on multiple tables with a WHERE condition previously set via where().
        • -
      • Fixed a bug (#3952) - Database method list_fields() didn’t work with SQLite3.
        • -
      • Fixed a bug (#3955) - Cache Library methods increment() and decrement() ignored the ‘key_prefix’ setting.
        • -
      • Fixed a bug (#3963) - Unit Testing Library wrongly tried to translate filenames, line numbers and notes values in test results.
        • -
      • Fixed a bug (#3965) - File Uploading Library ignored the “encrypt_name” setting when “overwrite” is enabled.
        • -
      • Fixed a bug (#3968) - Database Forge method add_key() didn’t treat array inputs as composite keys unless it’s a PRIMARY KEY.
        • -
      • Fixed a bug (#3715) - Pagination Library could generate broken link when a protocol-relative base URL is used.
        • -
      • Fixed a bug (#3828) - Output Library method delete_cache() couldn’t delete index page caches.
        • -
      • Fixed a bug (#3704) - Database method stored_procedure() in the ‘oci8’ driver didn’t properly bind parameters.
        • -
      • Fixed a bug (#3778) - Download Helper function force_download() incorrectly sent a Pragma response header.
        • -
      • Fixed a bug (#3752) - $routing['directory'] overrides were not properly handled and always resulted in a 404 “Not Found” error.
        • -
      • Fixed a bug (#3279) - Query Builder methods update() and get_compiled_update() did double escaping on the table name if it was provided via from().
        • -
      • Fixed a bug (#3991) - $config['rewrite_short_tags'] never worked due to function_exists('eval') always returning FALSE.
        • -
      • Fixed a bug where the File Uploading Library library will not properly configure its maximum file size unless the input value is of type integer.
        • -
      • Fixed a bug (#4000) - Pagination Library didn’t enable “rel” attributes by default if no attributes-related config options were used.
        • -
      • Fixed a bug (#4004) - URI Class didn’t properly parse the request URI if it contains a colon followed by a digit.
        • -
      • Fixed a bug in Query Builder where the $escape parameter for some methods only affected field names.
        • -
      • Fixed a bug (#4012) - Query Builder methods where_in(), or_where_in(), where_not_in(), or_where_not_in() didn’t take into account previously cached WHERE conditions when query cache is in use.
        • -
      • Fixed a bug (#4015) - Email Library method set_header() didn’t support method chaining, although it was advertised.
        • -
      • Fixed a bug (#4027) - Routing with HTTP verbs only worked if the route request method was declared in all-lowercase letters.
        • -
      • Fixed a bug (#4026) - Database Transactions always rollback if any previous query() call fails.
        • -
      • Fixed a bug (#4023) - String Helper function increment_string() didn’t escape its $separator parameter.
        • -
      -
      -
      -
      -

      Version 3.0.0

      -

      Release Date: March 30, 2015

      -
        -
      • License
          -
        • CodeIgniter has been relicensed with the MIT License, eliminating its old proprietary licensing.
          • -
        -
        • -
      • General Changes
          -
        • PHP 5.1.6 is no longer supported. CodeIgniter now requires PHP 5.2.4 and recommends PHP 5.4+ or newer to be used.
          • -
        • Changed filenaming convention (class file names now must be Ucfirst and everything else in lowercase).
          • -
        • Changed the default database driver to ‘mysqli’ (the old ‘mysql’ driver is DEPRECATED).
          • -
        • $_SERVER['CI_ENV'] can now be set to control the ENVIRONMENT constant.
          • -
        • Added an optional backtrace to php-error template.
          • -
        • Added Android to the list of user agents.
          • -
        • Added Windows 7, Windows 8, Windows 8.1, Android, Blackberry, iOS and PlayStation 3 to the list of user platforms.
          • -
        • Added Fennec (Firefox for mobile) to the list of mobile user agents.
          • -
        • Ability to log certain error types, not all under a threshold.
          • -
        • Added support for pem, p10, p12, p7a, p7c, p7m, p7r, p7s, crt, crl, der, kdb, rsa, cer, sst, csr Certs to mimes.php.
          • -
        • Added support for pgp, gpg, zsh and cdr files to mimes.php.
          • -
        • Added support for 3gp, 3g2, mp4, wmv, f4v, vlc Video files to mimes.php.
          • -
        • Added support for m4a, aac, m4u, xspf, au, ac3, flac, ogg, wma Audio files to mimes.php.
          • -
        • Added support for kmz and kml (Google Earth) files to mimes.php.
          • -
        • Added support for ics Calendar files to mimes.php.
          • -
        • Added support for rar, jar and 7zip archives to mimes.php.
          • -
        • Updated support for xml (‘application/xml’) and xsl (‘application/xml’, ‘text/xsl’) files in mimes.php.
          • -
        • Updated support for doc files in mimes.php.
          • -
        • Updated support for docx files in mimes.php.
          • -
        • Updated support for php files in mimes.php.
          • -
        • Updated support for zip files in mimes.php.
          • -
        • Updated support for csv files in mimes.php.
          • -
        • Added Romanian, Greek, Vietnamese and Cyrilic characters in application/config/foreign_characters.php.
          • -
        • Changed logger to only chmod when file is first created.
          • -
        • Removed previously deprecated SHA1 Library.
          • -
        • Removed previously deprecated use of $autoload['core'] in application/config/autoload.php. -Only entries in $autoload['libraries'] are auto-loaded now.
          • -
        • Removed previously deprecated EXT constant.
          • -
        • Updated all classes to be written in PHP 5 style, with visibility declarations and no var usage for properties.
          • -
        • Added an Exception handler.
          • -
        • Moved error templates to application/views/errors/ and made the path configurable via $config['error_views_path'].
          • -
        • Added support non-HTML error templates for CLI applications.
          • -
        • Moved the Log class to application/core/
          • -
        • Global config files are loaded first, then environment ones. Environment config keys overwrite base ones, allowing to only set the keys we want changed per environment.
          • -
        • Changed detection of $view_folder so that if it’s not found in the current path, it will now also be searched for under the application folder.
          • -
        • Path constants BASEPATH, APPPATH and VIEWPATH are now (internally) defined as absolute paths.
          • -
        • Updated email validation methods to use filter_var() instead of PCRE.
          • -
        • Changed environment defaults to report all errors in development and only fatal ones in testing, production but only display them in development.
          • -
        • Updated ip_address database field lengths from 16 to 45 for supporting IPv6 address on Trackback Library and Captcha Helper.
          • -
        • Removed cheatsheets and quick_reference PDFs from the documentation.
          • -
        • Added availability checks where usage of dangerous functions like eval() and exec() is required.
          • -
        • Added support for changing the file extension of log files using $config['log_file_extension'].
          • -
        • Added support for turning newline standardization on/off via $config['standardize_newlines'] and set it to FALSE by default.
          • -
        • Added configuration setting $config['composer_autoload'] to enable loading of a Composer auto-loader.
          • -
        • Removed the automatic conversion of ‘programmatic characters’ to HTML entities from the URI Library.
          • -
        • Changed log messages that say a class or file was loaded to “info” level instead of “debug”, so that they don’t pollute log files when $config['log_threshold'] is set to 2 (debug).
          • -
        -
        • -
      • Helpers
          -
        • Date Helper changes include:
            -
          • Added an optional third parameter to timespan() that constrains the number of time units displayed.
            • -
          • Added an optional parameter to timezone_menu() that allows more attributes to be added to the generated select tag.
            • -
          • Added function date_range() that generates a list of dates between a specified period.
            • -
          • Deprecated standard_date(), which now just uses the native date() with DateTime constants.
            • -
          • Changed now() to work with all timezone strings supported by PHP.
            • -
          • Changed days_in_month() to use the native cal_days_in_month() PHP function, if available.
            • -
          -
          • -
        • URL Helper changes include:
            -
          • Deprecated separator options dash and underscore for function url_title() (they are only aliases for ‘-‘ and ‘_’ respectively).
            • -
          • url_title() will now trim extra dashes from beginning and end.
            • -
          • anchor_popup() will now fill the href attribute with the URL and its JS code will return FALSE instead.
            • -
          • Added JS window name support to the anchor_popup() function.
            • -
          • Added support for menubar attribute to the anchor_popup().
            • -
          • Added support (auto-detection) for HTTP/1.1 response codes 303, 307 in redirect().
            • -
          • Changed redirect() to choose the refresh method only on IIS servers, instead of all servers on Windows (when auto is used).
            • -
          • Changed anchor(), anchor_popup(), and redirect() to support protocol-relative URLs (e.g. //ellislab.com/codeigniter).
            • -
          -
          • -
        • HTML Helper changes include:
            -
          • Added more doctypes.
            • -
          • Changed application and environment config files to be loaded in a cascade-like manner.
            • -
          • Changed doctype() to cache and only load once the doctypes array.
            • -
          • Deprecated functions nbs() and br(), which are just aliases for the native str_repeat() with &nbsp; and <br /> respectively.
            • -
          -
          • -
        • Inflector Helper changes include: -
          • -
        • Download Helper changes include:
            -
          • Added an optional third parameter to force_download() that enables/disables sending the actual file MIME type in the Content-Type header (disabled by default).
            • -
          • Added a work-around in force_download() for a bug Android <= 2.1, where the filename extension needs to be in uppercase.
            • -
          • Added support for reading from an existing file path by passing NULL as the second parameter to force_download() (useful for large files and/or safely transmitting binary data).
            • -
          -
          • -
        • Form Helper changes include: -
          • -
        • Security Helper changes include: -
          • -
        • Smiley Helper changes include:
            -
          • Deprecated the whole helper as too specific for CodeIgniter.
            • -
          • Removed previously deprecated function js_insert_smiley().
            • -
          • Changed application and environment config files to be loaded in a cascade-like manner.
            • -
          • The smileys array is now cached and loaded only once.
            • -
          -
          • -
        • File Helper changes include:
            -
          • set_realpath() can now also handle file paths as opposed to just directories.
            • -
          • Added an optional paramater to delete_files() to enable it to skip deleting files such as .htaccess and index.html.
            • -
          • Deprecated function read_file() - it’s just an alias for PHP’s native file_get_contents().
            • -
          -
          • -
        • String Helper changes include:
            -
          • Deprecated function repeater() - it’s just an alias for PHP’s native str_repeat().
            • -
          • Deprecated function trim_slashes() - it’s just an alias for PHP’s native trim() (with a slash as its second argument).
            • -
          • Deprecated randomization type options unique and encrypt for funcion random_string() (they are only aliases for md5 and sha1 respectively).
            • -
          -
          • -
        • CAPTCHA Helper changes include:
            -
          • Added word_length and pool options to allow customization of the generated word.
            • -
          • Added colors configuration to allow customization for the background, border, text and grid colors.
            • -
          • Added filename to the returned array elements.
            • -
          • Updated to use imagepng() in case that imagejpeg() isn’t available.
            • -
          • Added font_size option to allow customization of font size.
            • -
          • Added img_id option to set id attribute of captcha image.
            • -
          -
          • -
        • Text Helper changes include: -
          • -
        • Directory Helper directory_map() will now append DIRECTORY_SEPARATOR to directory names in the returned array.
          • -
        • Array Helper element() and elements() now return NULL instead of FALSE when the required elements don’t exist.
          • -
        • Language Helper lang() now accepts an optional list of additional HTML attributes.
          • -
        • Deprecated the Email Helper as its valid_email(), send_email() functions are now only aliases for PHP native functions filter_var() and mail() respectively.
          • -
        -
        • -
      • Database
          -
        • DEPRECATED the ‘mysql’, ‘sqlite’, ‘mssql’ and ‘pdo/dblib’ (also known as ‘pdo/mssql’ or ‘pdo/sybase’) drivers.
          • -
        • Added dsn configuration setting for drivers that support DSN strings (PDO, PostgreSQL, Oracle, ODBC, CUBRID).
          • -
        • Added schema configuration setting (defaults to public) for drivers that might need it (currently used by PostgreSQL and ODBC).
          • -
        • Added save_queries configuration setting to application/config/database.php (defaults to TRUE).
          • -
        • Removed autoinit configuration setting as it doesn’t make sense to instantiate the database class but not connect to the database.
          • -
        • Added subdrivers support (currently only used by PDO).
          • -
        • Added an optional database name parameter to db_select().
          • -
        • Removed protect_identifiers() and renamed internal method _protect_identifiers() to it instead - it was just an alias.
          • -
        • Renamed internal method _escape_identifiers() to escape_identifiers().
          • -
        • Updated escape_identifiers() to accept an array of fields as well as strings.
          • -
        • MySQL and MySQLi drivers now require at least MySQL version 5.1.
          • -
        • Added a $persistent parameter to db_connect() and changed db_pconnect() to be an alias for db_connect(TRUE).
          • -
        • db_set_charset() now only requires one parameter (collation was only needed due to legacy support for MySQL versions prior to 5.1).
          • -
        • db_select() will now always (if required by the driver) be called by db_connect() instead of only when initializing.
          • -
        • Replaced the _error_message() and _error_number() methods with error(), which returns an array containing the last database error code and message.
          • -
        • Improved version() implementation so that drivers that have a native function to get the version number don’t have to be defined in the core DB_driver class.
          • -
        • Added capability for packages to hold config/database.php config files.
          • -
        • Added MySQL client compression support.
          • -
        • Added encrypted connections support (for mysql, sqlsrv and PDO with sqlsrv).
          • -
        • Removed Loader Class from Database error tracing to better find the likely culprit.
          • -
        • Added support for SQLite3 database driver.
          • -
        • Added Interbase/Firebird database support via the ibase driver.
          • -
        • Added ODBC support for create_database(), drop_database() and drop_table() in Database Forge.
          • -
        • Added support to binding arrays as IN() sets in query().
          • -
        • Query Builder changes include:
            -
          • Renamed the Active Record class to Query Builder to remove confusion with the Active Record design pattern.
            • -
          • Added the ability to insert objects with insert_batch().
            • -
          • Added new methods that return the SQL string of queries without executing them: get_compiled_select(), get_compiled_insert(), get_compiled_update(), get_compiled_delete().
            • -
          • Added an optional parameter that allows to disable escaping (useful for custom fields) for methods join(), order_by(), where_in(), or_where_in(), where_not_in(), or_where_not_in(), insert(), insert_batch().
            • -
          • Added support for join() with multiple conditions.
            • -
          • Added support for USING in join().
            • -
          • Added support for EXISTS in where().
            • -
          • Added seed values support for random ordering with order_by(seed, 'RANDOM').
            • -
          • Changed limit() to ignore NULL values instead of always casting to integer.
            • -
          • Changed offset() to ignore empty values instead of always casting to integer.
            • -
          • Methods insert_batch() and update_batch() now return an integer representing the number of rows affected by them.
            • -
          • Methods where(), or_where(), having() and or_having() now convert trailing = and <>, != SQL operators to IS NULL and IS NOT NULL respectively when the supplied comparison value is NULL.
            • -
          • Added method chaining support to reset_query(), start_cache(), stop_cache() and flush_cache().
            • -
          • Added an optional second parameter to count_all_results() to disable resetting of QB values.
            • -
          -
          • -
        • Database Results changes include:
            -
          • Added a constructor to the DB_result class and moved all driver-specific properties and logic out of the base DB_driver class to allow better abstraction.
            • -
          • Added method unbuffered_row() for fetching a row without prefetching the whole result (consume less memory).
            • -
          • Renamed former method _data_seek() to data_seek() and made it public.
            • -
          -
          • -
        • Improved support for the MySQLi driver, including:
            -
          • OOP style usage of the PHP extension is now used, instead of the procedural aliases.
            • -
          • Server version checking is now done via mysqli::$server_info instead of running an SQL query.
            • -
          • Added persistent connections support for PHP >= 5.3.
            • -
          • Added support for configuring socket pipe connections.
            • -
          • Added support for backup() in Database Utilities.
            • -
          • Changed methods trans_begin(), trans_commit() and trans_rollback() to use the PHP API instead of sending queries.
            • -
          -
          • -
        • Improved support of the PDO driver, including:
            -
          • Added support for create_database(), drop_database() and drop_table() in Database Forge.
            • -
          • Added support for list_fields() in Database Results.
            • -
          • Subdrivers are now isolated from each other instead of being in one large class.
            • -
          -
          • -
        • Improved support of the PostgreSQL driver, including:
            -
          • pg_version() is now used to get the database version number, when possible.
            • -
          • Added db_set_charset() support.
            • -
          • Added support for optimize_table() in Database Utilities (rebuilds table indexes).
            • -
          • Added boolean data type support in escape().
            • -
          • Added update_batch() support.
            • -
          • Removed limit() and order_by() support for UPDATE and DELETE queries as PostgreSQL does not support those features.
            • -
          • Added a work-around for dead persistent connections to be re-created after a database restart.
            • -
          • Changed db_connect() to include the (new) schema value into Postgre’s search_path session variable.
            • -
          • pg_escape_literal() is now used for escaping strings, if available.
            • -
          -
          • -
        • Improved support of the CUBRID driver, including:
            -
          • Added DSN string support.
            • -
          • Added persistent connections support.
            • -
          • Improved list_databases() in Database Utility (until now only the currently used database was returned).
            • -
          -
          • -
        • Improved support of the MSSQL and SQLSRV drivers, including:
            -
          • Added random ordering support.
            • -
          • Added support for optimize_table() in Database Utility.
            • -
          • Added escaping with QUOTE_IDENTIFIER setting detection.
            • -
          • Added port handling support for UNIX-based systems (MSSQL driver).
            • -
          • Added OFFSET support for SQL Server 2005 and above.
            • -
          • Added db_set_charset() support (MSSQL driver).
            • -
          • Added a scrollable property to enable configuration of the cursor to use (SQLSRV driver).
            • -
          • Added support and auto-detection for the SQLSRV_CURSOR_CLIENT_BUFFERED scrollable cursor flag (SQLSRV driver).
            • -
          • Changed default behavior to not use SQLSRV_CURSOR_STATIC due to performance issues (SQLSRV driver).
            • -
          -
          • -
        • Improved support of the Oracle (OCI8) driver, including:
            -
          • Added DSN string support (Easy Connect and TNS).
            • -
          • Added support for drop_table() in Database Forge.
            • -
          • Added support for list_databases() in Database Utilities.
            • -
          • Generally improved for speed and cleaned up all of its components.
            • -
          • num_rows() is now only called explicitly by the developer and no longer re-executes statements.
            • -
          -
          • -
        • Improved support of the SQLite driver, including: -
          • -
        • Database Forge changes include:
            -
          • Added an optional second parameter to drop_table() that allows adding the IF EXISTS condition, which is no longer the default.
            • -
          • Added support for passing a custom database object to the loader.
            • -
          • Added support for passing custom table attributes (such as ENGINE for MySQL) to create_table().
            • -
          • Added support for usage of the FIRST clause in add_column() for MySQL and CUBRID.
            • -
          • Added partial support for field comments (MySQL, PostgreSQL, Oracle).
            • -
          • Deprecated add_column()‘s third method. AFTER clause should now be added to the field definition array instead.
            • -
          • Overall improved support for all of the drivers.
            • -
          -
          • -
        • Database Utility changes include:
            -
          • Added support for passing a custom database object to the loader.
            • -
          • Modified the class to no longer extend Database Forge, which has been a deprecated behavior for awhile.
            • -
          • Overall improved support for all of the drivers.
            • -
          • Added foreign_key_checks option to MySQL/MySQLi backup, allowing statement to disable/re-enable foreign key checks to be inserted into the backup output.
            • -
          -
          • -
        -
        • -
      • Libraries
          -
        • Added a new Encryption Library to replace the old, largely insecure Encrypt Library.
          • -
        • Encrypt Library changes include:
            -
          • Deprecated the library in favor of the new Encryption Library.
            • -
          • Added support for hashing algorithms other than SHA1 and MD5.
            • -
          • Removed previously deprecated sha1() method.
            • -
          -
          • -
        • Session Library changes include:
            -
          • Completely re-written the library to use self-contained drivers via $config['sess_driver'].
            • -
          • Added ‘files’, ‘database’, ‘redis’ and ‘memcached’ drivers (using ‘files’ by default).
            • -
          • Added $config['sess_save_path'] setting to specify where the session data is stored, depending on the driver.
            • -
          • Dropped support for storing session data in cookies (which renders $config['sess_encrypt_cookie'] useless and is therefore also removed).
            • -
          • Dropped official support for storing session data in databases other than MySQL and PostgreSQL.
            • -
          • Changed table structure for the ‘database’ driver.
            • -
          • Added a new tempdata feature that allows setting userdata items with expiration time (mark_as_temp(), tempdata(), set_tempdata(), unset_tempdata()).
            • -
          • Changed method keep_flashdata() to also accept an array of keys.
            • -
          • Changed methods userdata(), flashdata() to return an array of all userdata/flashdata when no parameter is passed.
            • -
          • Deprecated method all_userdata() - it is now just an alias for userdata() with no parameters.
            • -
          • Added method has_userdata() that verifies the existence of a userdata item.
            • -
          • Added debug level log messages for key events in the session validation process.
            • -
          • Dropped support for the sess_match_useragent option.
            • -
          -
          • -
        • File Uploading Library changes include:
            -
          • Added method chaining support.
            • -
          • Added support for using array notation in file field names.
            • -
          • Added max_filename_increment and file_ext_tolower configuration settings.
            • -
          • Added min_width and min_height configuration settings for images.
            • -
          • Added mod_mime_fix configuration setting to disable suffixing multiple file extensions with an underscore.
            • -
          • Added the possibility pass allowed_types as an array.
            • -
          • Added an $index parameter to the method data().
            • -
          • Added a $reset parameter to method initialize().
            • -
          • Removed method clean_file_name() and its usage in favor of Security Library‘s sanitize_filename().
            • -
          • Removed method mimes_types().
            • -
          • Changed CI_Upload::_prep_filename() to simply replace all (but the last) dots in the filename with underscores, instead of suffixing them.
            • -
          -
          • -
        • Calendar Library changes include:
            -
          • Added method chaining support.
            • -
          • Added configuration to generate days of other months instead of blank cells.
            • -
          • Added auto-configuration for next_prev_url if it is empty and show_prev_next is set to TRUE.
            • -
          • Added support for templating via an array in addition to the encoded string.
            • -
          • Changed method get_total_days() to be an alias for Date Helper days_in_month().
            • -
          -
          • -
        • Cart Library changes include:
            -
          • Deprecated the library as too specific for CodeIgniter.
            • -
          • Added method remove() to remove a cart item, updating with quantity of 0 seemed like a hack but has remained to retain compatibility.
            • -
          • Added method get_item() to enable retrieving data for a single cart item.
            • -
          • Added unicode support for product names.
            • -
          • Added support for disabling product name strictness via the $product_name_safe property.
            • -
          • Changed insert() method to auto-increment quantity for an item when inserted twice instead of resetting it.
            • -
          • Changed update() method to support updating all properties attached to an item and not to require ‘qty’.
            • -
          -
          • -
        • Image Manipulation Library changes include:
            -
          • The initialize() method now only sets existing class properties.
            • -
          • Added support for 3-length hex color values for wm_font_color and wm_shadow_color properties, as well as validation for them.
            • -
          • Class properties wm_font_color, wm_shadow_color and wm_use_drop_shadow are now protected, to avoid breaking the text_watermark() method if they are set manually after initialization.
            • -
          • If property maintain_ratio is set to TRUE, image_reproportion() now doesn’t need both width and height to be specified.
            • -
          • Property maintain_ratio is now taken into account when resizing images using ImageMagick library.
            • -
          • Added support for maintaining transparency for PNG images when watermarking.
            • -
          • Added a file_permissions setting.
            • -
          -
          • -
        • Form Validation Library changes include:
            -
          • Added method error_array() to return all error messages as an array.
            • -
          • Added method set_data() to set an alternative data array to be validated instead of the default $_POST.
            • -
          • Added method reset_validation() which resets internal validation variables in case of multiple validation routines.
            • -
          • Added support for setting error delimiters in the config file via $config['error_prefix'] and $config['error_suffix'].
            • -
          • Internal method _execute() now considers input data to be invalid if a specified rule is not found.
            • -
          • Removed method is_numeric() as it exists as a native PHP function and _execute() will find and use that (the is_numeric rule itself is deprecated since 1.6.1).
            • -
          • Native PHP functions used as rules can now accept an additional parameter, other than the data itself.
            • -
          • Updated method set_rules() to accept an array of rules as well as a string.
            • -
          • Fields that have empty rules set no longer run through validation (and therefore are not considered erroneous).
            • -
          • Added rule differs to check if the value of a field differs from the value of another field.
            • -
          • Added rule valid_url.
            • -
          • Added rule in_list to check if the value of a field is within a given list.
            • -
          • Added support for named parameters in error messages.
            • -
          • Language line keys must now be prefixed with form_validation_.
            • -
          • Added rule alpha_numeric_spaces.
            • -
          • Added support for custom error messages per field rule.
            • -
          • Added support for callable rules when they are passed as an array.
            • -
          • Added support for non-ASCII domains in valid_email rule, depending on the Intl extension.
            • -
          • Changed the debug message about an error message not being set to include the rule name it is about.
            • -
          -
          • -
        • Caching Library changes include:
            -
          • Added Wincache driver.
            • -
          • Added Redis driver.
            • -
          • Added a key_prefix option for cache IDs.
            • -
          • Updated driver is_supported() methods to log at the “debug” level.
            • -
          • Added option to store raw values instead of CI-formatted ones (APC, Memcache).
            • -
          • Added atomic increment/decrement feature via increment(), decrement().
            • -
          -
          • -
        • E-mail Library changes include:
            -
          • Added a custom filename parameter to attach() as $this->email->attach($filename, $disposition, $newname).
            • -
          • Added possibility to send attachment as buffer string in attach() as $this->email->attach($buffer, $disposition, $newname, $mime).
            • -
          • Added possibility to attach remote files by passing a URL.
            • -
          • Added method attachment_cid() to enable embedding inline attachments into HTML.
            • -
          • Added dsn (delivery status notification) option.
            • -
          • Renamed method _set_header() to set_header() and made it public to enable adding custom headers.
            • -
          • Successfully sent emails will automatically clear the parameters.
            • -
          • Added a return_path parameter to the from() method.
            • -
          • Removed the second parameter (character limit) from internal method _prep_quoted_printable() as it is never used.
            • -
          • Internal method _prep_quoted_printable() will now utilize the native quoted_printable_encode(), imap_8bit() functions (if available) when CRLF is set to “rn”.
            • -
          • Default charset now relies on the global $config['charset'] setting.
            • -
          • Removed unused protected method _get_ip() (Input Library‘s ip_address() should be used anyway).
            • -
          • Internal method _prep_q_encoding() now utilizes PHP’s mbstring and iconv extensions (when available) and no longer has a second ($from) argument.
            • -
          • Added an optional parameter to print_debugger() to allow specifying which parts of the message should be printed (‘headers’, ‘subject’, ‘body’).
            • -
          • Added SMTP keepalive option to avoid opening the connection for each send() call. Accessible as $smtp_keepalive.
            • -
          • Public method set_header() now filters the input by removing all “\r” and “\n” characters.
            • -
          • Added support for non-ASCII domains in valid_email(), depending on the Intl extension.
            • -
          -
          • -
        • Pagination Library changes include:
            -
          • Deprecated usage of the “anchor_class” setting (use the new “attributes” setting instead).
            • -
          • Added method chaining support to initialize() method.
            • -
          • Added support for the anchor “rel” attribute.
            • -
          • Added support for setting custom attributes.
            • -
          • Added support for language translations of the first_link, next_link, prev_link and last_link values.
            • -
          • Added support for $config['num_links'] = 0 configuration.
            • -
          • Added $config['reuse_query_string'] to allow automatic repopulation of query string arguments, combined with normal URI segments.
            • -
          • Added $config['use_global_url_suffix'] to allow overriding the library ‘suffix’ value with that of the global $config['url_suffix'] setting.
            • -
          • Removed the default &nbsp; from a number of the configuration variables.
            • -
          -
          • -
        • Profiler Library changes include:
            -
          • Database object names are now being displayed.
            • -
          • The sum of all queries running times in seconds is now being displayed.
            • -
          • Added support for displaying the HTTP DNT (“Do Not Track”) header.
            • -
          • Added support for displaying $_FILES.
            • -
          -
          • -
        • Migration Library changes include:
            -
          • Added support for timestamp-based migrations (enabled by default).
            • -
          • Added $config['migration_type'] to allow switching between sequential and timestamp migrations.
            • -
          -
          • -
        • XML-RPC Library changes include:
            -
          • Added the ability to use a proxy.
            • -
          • Added Basic HTTP authentication support.
            • -
          -
          • -
        • User Agent Library changes include:
            -
          • Added check to detect if robots are pretending to be mobile clients (helps with e.g. Google indexing mobile website versions).
            • -
          • Added method parse() to allow parsing a custom user-agent string, different from the current visitor’s.
            • -
          -
          • -
        • HTML Table Library changes include:
            -
          • Added method chaining support.
            • -
          • Added support for setting table class defaults in a config file.
            • -
          -
          • -
        • Zip Library changes include:
            -
          • Method read_file() can now also alter the original file path/name while adding files to an archive.
            • -
          • Added support for changing the compression level.
            • -
          -
          • -
        • Trackback Library method receive() will now utilize iconv() if it is available but mb_convert_encoding() is not.
          • -
        -
        • -
      • Core
          -
        • Routing changes include:
            -
          • Added support for multiple levels of controller directories.
            • -
          • Added support for per-directory default_controller and 404_override classes.
            • -
          • Added possibility to route requests using HTTP verbs.
            • -
          • Added possibility to route requests using callbacks.
            • -
          • Added a new reserved route (translate_uri_dashes) to allow usage of dashes in the controller and method URI segments.
            • -
          • Deprecated methods fetch_directory(), fetch_class() and fetch_method() in favor of their respective public properties.
            • -
          • Removed method _set_overrides() and moved its logic to the class constructor.
            • -
          -
          • -
        • URI Library changes include:
            -
          • Added conditional PCRE UTF-8 support to the “invalid URI characters” check and removed the preg_quote() call from it to allow more flexibility.
            • -
          • Renamed method _filter_uri() to filter_uri().
            • -
          • Changed method filter_uri() to accept by reference and removed its return value.
            • -
          • Changed private methods to protected so that MY_URI can override them.
            • -
          • Renamed internal method _parse_cli_args() to _parse_argv().
            • -
          • Renamed internal method _detect_uri() to _parse_request_uri().
            • -
          • Changed _parse_request_uri() to accept absolute URIs for compatibility with HTTP/1.1 as per RFC2616 <http://www.ietf.org/rfc/rfc2616.txt>.
            • -
          • Added protected method _parse_query_string() to URI paths in the the QUERY_STRING value, like _parse_request_uri() does.
            • -
          • Changed URI string detection logic to always default to REQUEST_URI unless configured otherwise or under CLI.
            • -
          • Removed methods _remove_url_suffix(), _explode_segments() and moved their logic into _set_uri_string().
            • -
          • Removed method _fetch_uri_string() and moved its logic into the class constructor.
            • -
          • Removed method _reindex_segments().
            • -
          -
          • -
        • Loader Library changes include:
            -
          • Added method chaining support.
            • -
          • Added method get_vars() to the Loader to retrieve all variables loaded with $this->load->vars().
            • -
          • _ci_autoloader() is now a protected method.
            • -
          • Added autoloading of drivers with $autoload['drivers'].
            • -
          • $config['rewrite_short_tags'] now has no effect when using PHP 5.4 as <?= will always be available.
            • -
          • Changed method config() to return whatever CI_Config::load() returns instead of always being void.
            • -
          • Added support for library and model aliasing on autoload.
            • -
          • Changed method is_loaded() to ask for the (case sensitive) library name instead of its instance name.
            • -
          • Removed $_base_classes property and unified all class data in $_ci_classes instead.
            • -
          • Added method clear_vars() to allow clearing the cached variables for views.
            • -
          -
          • -
        • Input Library changes include:
            -
          • Deprecated the $config['global_xss_filtering'] setting.
            • -
          • Added method() to retrieve $_SERVER['REQUEST_METHOD'].
            • -
          • Added support for arrays and network addresses (e.g. 192.168.1.1/24) for use with the proxy_ips setting.
            • -
          • Added method input_stream() to aid in using php://input stream data such as one passed via PUT, DELETE and PATCH requests.
            • -
          • Changed method valid_ip() to use PHP’s native filter_var() function.
            • -
          • Changed internal method _sanitize_globals() to skip enforcing reversal of register_globals in PHP 5.4+, where this functionality no longer exists.
            • -
          • Changed methods get(), post(), get_post(), cookie(), server(), user_agent() to return NULL instead of FALSE when no value is found.
            • -
          • Changed default value of the $xss_clean parameter to NULL for all methods that utilize it, the default value is now determined by the $config['global_xss_filtering'] setting.
            • -
          • Added method post_get() and changed get_post() to search in GET data first. Both methods’ names now properly match their GET/POST data search priorities.
            • -
          • Changed method _fetch_from_array() to parse array notation in field name.
            • -
          • Changed method _fetch_from_array() to allow retrieving multiple fields at once.
            • -
          • Added an option for _clean_input_keys() to return FALSE instead of terminating the whole script.
            • -
          • Deprecated the is_cli_request() method, it is now an alias for the new is_cli() common function.
            • -
          • Added an $xss_clean parameter to method user_agent() and removed the $user_agent property.
            • -
          • Added property $raw_input_stream to access php://input data.
            • -
          -
          • -
        • Common functions changes include:
            -
          • Added function get_mimes() to return the application/config/mimes.php array.
            • -
          • Added support for HTTP code 303 (“See Other”) in set_status_header().
            • -
          • Removed redundant conditional to determine HTTP server protocol in set_status_header().
            • -
          • Renamed _exception_handler() to _error_handler() and replaced it with a real exception handler.
            • -
          • Changed _error_handler() to respect php.ini display_errors setting.
            • -
          • Added function is_https() to check if a secure connection is used.
            • -
          • Added function is_cli() to replace the CI_Input::is_cli_request() method.
            • -
          • Added function function_usable() to work around a bug in Suhosin <http://www.hardened-php.net/suhosin/>.
            • -
          • Removed the third ($php_error) argument from function log_message().
            • -
          • Changed internal function load_class() to accept a constructor parameter instead of (previously unused) class name prefix.
            • -
          • Removed default parameter value of is_php().
            • -
          • Added a second argument $double_encode to html_escape().
            • -
          • Changed function config_item() to return NULL instead of FALSE when no value is found.
            • -
          • Changed function set_status_header() to return immediately when run under CLI.
            • -
          -
          • -
        • Output Library changes include:
            -
          • Added a second argument to method set_content_type() that allows setting the document charset as well.
            • -
          • Added methods get_content_type() and get_header().
            • -
          • Added method delete_cache().
            • -
          • Added configuration option $config['cache_query_string'] to enable taking the query string into account when caching.
            • -
          • Changed caching behavior to compress the output before storing it, if $config['compress_output'] is enabled.
            • -
          -
          • -
        • Config Library changes include:
            -
          • Changed site_url() method to accept an array as well.
            • -
          • Removed internal method _assign_to_config() and moved its implementation to CodeIgniter.php instead.
            • -
          • item() now returns NULL instead of FALSE when the required config item doesn’t exist.
            • -
          • Added an optional second parameter to both base_url() and site_url() that allows enforcing of a protocol different than the one in the base_url configuration setting.
            • -
          • Added HTTP “Host” header character validation to prevent cache poisoning attacks when base_url auto-detection is used.
            • -
          -
          • -
        • Security Library changes include:
            -
          • Added $config['csrf_regeneration'], which makes CSRF token regeneration optional.
            • -
          • Added $config['csrf_exclude_uris'], allowing for exclusion of URIs from the CSRF protection (regular expressions are supported).
            • -
          • Added method strip_image_tags().
            • -
          • Added method get_random_bytes() and switched CSRF & XSS token generation to use it.
            • -
          • Modified method sanitize_filename() to read a public $filename_bad_chars property for getting the invalid characters list.
            • -
          • Return status code of 403 instead of a 500 if CSRF protection is enabled but a token is missing from a request.
            • -
          -
          • -
        • Language Library changes include:
            -
          • Changed method load() to filter the language name with ctype_alpha().
            • -
          • Changed method load() to also accept an array of language files.
            • -
          • Added an optional second parameter to method line() to disable error logging for line keys that were not found.
            • -
          • Language files are now loaded in a cascading style with the one in system/ always loaded and overridden afterwards, if another one is found.
            • -
          -
          • -
        • Hooks Library changes include:
            -
          • Added support for closure hooks (or anything that is_callable() returns TRUE for).
            • -
          • Renamed method _call_hook() to call_hook().
            • -
          • Class instances are now stored in order to maintain their state.
            • -
          -
          • -
        • UTF-8 Library changes include:
            -
          • UTF8_ENABLED now requires only one of Multibyte String or iconv to be available instead of both.
            • -
          • Changed method clean_string() to utilize mb_convert_encoding() if it is available.
            • -
          • Renamed method _is_ascii() to is_ascii() and made it public.
            • -
          -
          • -
        • Log Library changes include:
            -
          • Added a $config['log_file_permissions'] setting.
            • -
          • Changed the library constructor to try to create the log_path directory if it doesn’t exist.
            • -
          • Added support for microseconds (“u” date format character) in $config['log_date_format'].
            • -
          -
          • -
        • Added compatibility layers for:
            -
          • Multibyte String (limited support).
            • -
          • Hash (hash_equals(), hash_pbkdf2()).
            • -
          • Password Hashing.
            • -
          • Standard Functions ``array_column()`, array_replace(), array_replace_recursive(), hex2bin(), quoted_printable_encode().
            • -
          -
          • -
        • Removed CI_CORE boolean constant from CodeIgniter.php (no longer Reactor and Core versions).
          • -
        • Added support for HTTP-Only cookies with new config option cookie_httponly (default FALSE).
          • -
        • $config['time_reference'] now supports all timezone strings supported by PHP.
          • -
        • Fatal PHP errors are now also passed to _error_handler(), so they can be logged.
          • -
        -
        • -
      -
      -

      Bug fixes for 3.0

      -
        -
      • Fixed a bug where unlink() raised an error if cache file did not exist when you try to delete it.
        • -
      • Fixed a bug (#181) - a typo in the form validation language file.
        • -
      • Fixed a bug (#159, #163) - Query Builder nested transactions didn’t work properly due to $_trans_depth not being incremented.
        • -
      • Fixed a bug (#737, #75) - Pagination anchor class was not set properly when using initialize method.
        • -
      • Fixed a bug (#419) - URL Helper auto_link() didn’t recognize URLs that come after a word boundary.
        • -
      • Fixed a bug (#724) - Form Validation Library rule is_unique didn’t check if a database connection exists.
        • -
      • Fixed a bug (#647) - Zip Library internal method _get_mod_time() didn’t suppress possible “stat failed” errors generated by filemtime().
        • -
      • Fixed a bug (#157, #174) - Image Manipulation Library method clear() didn’t completely clear properties.
        • -
      • Fixed a bug where Database Forge method create_table() with PostgreSQL database could lead to fetching the whole table.
        • -
      • Fixed a bug (#795) - Form Helper form_open() didn’t add the default form method and accept-charset when an empty array is passed to it.
        • -
      • Fixed a bug (#797) - Date Helper timespan() was using incorrect seconds for year and month.
        • -
      • Fixed a bug in Cart Library method contents() where if called without a TRUE (or equal) parameter, it would fail due to a typo.
        • -
      • Fixed a bug (#406) - SQLSRV DB driver not returning resource on db_pconnect().
        • -
      • Fixed a bug in Image Manipulation Library method gd_loaded() where it was possible for the script execution to end or a PHP E_WARNING message to be emitted.
        • -
      • Fixed a bug in the Pagination library where when use_page_numbers=TRUE previous link and page 1 link did not have the same url.
        • -
      • Fixed a bug (#561) - errors in XML-RPC Library were not properly escaped.
        • -
      • Fixed a bug (#904) - Loader Library method initialize() caused a PHP Fatal error to be triggered if error level E_STRICT is used.
        • -
      • Fixed a hosting edge case where an empty $_SERVER['HTTPS'] variable would evaluate to ‘on’.
        • -
      • Fixed a bug (#154) - Session Library method sess_update() caused the session to be destroyed on pages where multiple AJAX requests were executed at once.
        • -
      • Fixed a possible bug in Input Libary method is_ajax_request() where some clients might not send the X-Requested-With HTTP header value exactly as ‘XmlHttpRequest’.
        • -
      • Fixed a bug (#1039) - Database Utilities internal method _backup() method failed for the ‘mysql’ driver due to a table name not being escaped.
        • -
      • Fixed a bug (#1070) - CI_DB_driver::initialize() didn’t set a character set if a database is not selected.
        • -
      • Fixed a bug (#177) - Form Validation Library method set_value() didn’t set the default value if POST data is NULL.
        • -
      • Fixed a bug (#68, #414) - :Oracle’s escape_str() didn’t properly escape LIKE wild characters.
        • -
      • Fixed a bug (#81) - ODBC’s list_fields() and field_data() methods skipped the first column due to odbc_field_*() functions’ index starting at 1 instead of 0.
        • -
      • Fixed a bug (#129) - ODBC’s num_rows() method returned -1 in some cases, due to not all subdrivers supporting the odbc_num_rows() function.
        • -
      • Fixed a bug (#153) - E_NOTICE being generated by getimagesize() in the File Uploading Library.
        • -
      • Fixed a bug (#611) - SQLSRV’s error handling methods used to issue warnings when there’s no actual error.
        • -
      • Fixed a bug (#1036) - is_write_type() method in the Database Library didn’t return TRUE for RENAME queries.
        • -
      • Fixed a bug in PDO’s _version() method where it used to return the client version as opposed to the server one.
        • -
      • Fixed a bug in PDO’s insert_id() method where it could’ve failed if it’s used with Postgre versions prior to 8.1.
        • -
      • Fixed a bug in CUBRID’s affected_rows() method where a connection resource was passed to cubrid_affected_rows() instead of a result.
        • -
      • Fixed a bug (#638) - db_set_charset() ignored its arguments and always used the configured charset instead.
        • -
      • Fixed a bug (#413) - Oracle’s error handling methods used to only return connection-related errors.
        • -
      • Fixed a bug (#1101) - Database Result method field_data() for ‘mysql’, ‘mysqli’ drivers was implemented as if it was handling a DESCRIBE result instead of the actual result set.
        • -
      • Fixed a bug in Oracle’s Database Forge method _create_table() where it failed with AUTO_INCREMENT as it’s not supported.
        • -
      • Fixed a bug (#1080) - when using the SMTP protocol, Email Library method send() was returning TRUE even if the connection/authentication against the server failed.
        • -
      • Fixed a bug (#306) - ODBC’s insert_id() method was calling non-existent function odbc_insert_id(), which resulted in a fatal error.
        • -
      • Fixed a bug in Oracle’s Database Result implementation where the cursor ID passed to it was always NULL.
        • -
      • Fixed a bug (#64) - Regular expression in DB_query_builder.php failed to handle queries containing SQL bracket delimiters in the JOIN condition.
        • -
      • Fixed a bug in the Session Library where a PHP E_NOTICE error was triggered by _unserialize() due to results from databases such as MSSQL and Oracle being space-padded on the right.
        • -
      • Fixed a bug (#501) - Form Validation Library method set_rules() depended on count($_POST) instead of actually checking if the request method ‘POST’ before aborting.
        • -
      • Fixed a bug (#136) - PostgreSQL and MySQL’s escape_str() method didn’t properly escape LIKE wild characters.
        • -
      • Fixed a bug in Loader Library method library() where some PHP versions wouldn’t execute the class constructor.
        • -
      • Fixed a bug (#88) - An unexisting property was used for configuration of the Memcache cache driver.
        • -
      • Fixed a bug (#14) - Database Forge method create_database() didn’t utilize the configured database character set.
        • -
      • Fixed a bug (#23, #1238) - Database Caching method delete_all() used to delete .htaccess and index.html files, which is a potential security risk.
        • -
      • Fixed a bug in Trackback Library method validate_url() where it didn’t actually do anything, due to input not being passed by reference.
        • -
      • Fixed a bug (#11, #183, #863) - Form Validation Library method _execute() silently continued to the next rule, if a rule method/function is not found.
        • -
      • Fixed a bug (#122) - routed URI string was being reported incorrectly in sub-directories.
        • -
      • Fixed a bug (#1241) - Zip Library method read_dir() wasn’t compatible with Windows.
        • -
      • Fixed a bug (#306) - ODBC driver didn’t have an _insert_batch() method, which resulted in fatal error being triggered when insert_batch() is used with it.
        • -
      • Fixed a bug in MSSQL and SQLSrv’s _truncate() where the TABLE keyword was missing.
        • -
      • Fixed a bug in PDO’s trans_commit() method where it failed due to an erroneous property name.
        • -
      • Fixed a bug (#798) - Query Builder method update() used to ignore LIKE conditions that were set with like().
        • -
      • Fixed a bug in Oracle’s and MSSQL’s delete() methods where an erroneous SQL statement was generated when used with limit().
        • -
      • Fixed a bug in SQLSRV’s delete() method where like() and limit() conditions were ignored.
        • -
      • Fixed a bug (#1265) - Database connections were always closed, regardless of the ‘pconnect’ option value.
        • -
      • Fixed a bug (#128) - Language Library did not correctly keep track of loaded language files.
        • -
      • Fixed a bug (#1349) - File Uploading Library method get_extension() returned the original filename when it didn’t have an actual extension.
        • -
      • Fixed a bug (#1273) - Query Builder method set_update_batch() generated an E_NOTICE message.
        • -
      • Fixed a bug (#44, #110) - File Uploading Library method clean_file_name() didn’t clear ‘!’ and ‘#’ characters.
        • -
      • Fixed a bug (#121) - Database Results method row() returned an array when there’s no actual result to be returned.
        • -
      • Fixed a bug (#319) - SQLSRV’s affected_rows() method failed due to a scrollable cursor being created for write-type queries.
        • -
      • Fixed a bug (#356) - Database driver ‘postgre’ didn’t have an _update_batch() method, which resulted in fatal error being triggered when update_batch() is used with it.
        • -
      • Fixed a bug (#784, #862) - Database Forge method create_table() failed on SQLSRV/MSSQL when used with ‘IF NOT EXISTS’.
        • -
      • Fixed a bug (#1419) - Driver Library had a static variable that was causing an error.
        • -
      • Fixed a bug (#1411) - the Email Library used its own short list of MIMEs instead the one from config/mimes.php.
        • -
      • Fixed a bug where php.ini setting magic_quotes_runtime wasn’t turned off for PHP 5.3 (where it is indeed deprecated, but not non-existent).
        • -
      • Fixed a bug (#666) - Output Library method set_content_type() didn’t set the document charset.
        • -
      • Fixed a bug (#784, #861) - Database Forge method create_table() used to accept constraints for MSSQL/SQLSRV integer-type columns.
        • -
      • Fixed a bug (#706) - SQLSRV/MSSSQL Database drivers didn’t escape field names.
        • -
      • Fixed a bug (#1452) - Query Builder method protect_identifiers() didn’t properly detect identifiers with spaces in their names.
        • -
      • Fixed a bug where Query Builder method protect_identifiers() ignored its extra arguments when the value passed to it is an array.
        • -
      • Fixed a bug where Query Builder internal method _has_operator() didn’t detect BETWEEN.
        • -
      • Fixed a bug where Query Builder method join() failed with identifiers containing dashes.
        • -
      • Fixed a bug (#1264) - Database Forge and Database Utilities didn’t update/reset the databases and tables list cache when a table or a database is created, dropped or renamed.
        • -
      • Fixed a bug (#7) - Query Builder method join() only escaped one set of conditions.
        • -
      • Fixed a bug (#1321) - CI_Exceptions couldn’t find the errors/ directory in some cases.
        • -
      • Fixed a bug (#1202) - Encrypt Library encode_from_legacy() didn’t set back the encrypt mode on failure.
        • -
      • Fixed a bug (#145) - Database Class method compile_binds() failed when the bind marker was present in a literal string within the query.
        • -
      • Fixed a bug in Query Builder method protect_identifiers() where if passed along with the field names, operators got escaped as well.
        • -
      • Fixed a bug (#10) - URI Library internal method _detect_uri() failed with paths containing a colon.
        • -
      • Fixed a bug (#1387) - Query Builder method from() didn’t escape table aliases.
        • -
      • Fixed a bug (#520) - Date Helper function :php:func:nice_date() failed when the optional second parameter is not passed.
        • -
      • Fixed a bug (#318) - Profiling Library setting query_toggle_count was not settable as described in the manual.
        • -
      • Fixed a bug (#938) - Config Library method site_url() added a question mark to the URL string when query strings are enabled even if it already existed.
        • -
      • Fixed a bug (#999) - Config Library method site_url() always appended $config['url_suffix'] to the end of the URL string, regardless of whether a query string exists in it.
        • -
      • Fixed a bug where URL Helper function anchor_popup() ignored the attributes argument if it is not an array.
        • -
      • Fixed a bug (#1328) - Form Validation Library didn’t properly check the type of the form fields before processing them.
        • -
      • Fixed a bug (#79) - Form Validation Library didn’t properly validate array fields that use associative keys or have custom indexes.
        • -
      • Fixed a bug (#427) - Form Validation Library method strip_image_tags() was an alias to a non-existent method.
        • -
      • Fixed a bug (#1545) - Query Builder method limit() wasn’t executed properly under Oracle.
        • -
      • Fixed a bug (#1551) - Date Helper function standard_date() didn’t properly format W3C and ATOM standard dates.
        • -
      • Fixed a bug where Query Builder method join() escaped literal values as if they were fields.
        • -
      • Fixed a bug (#135) - PHP Error logging was impossible without the errors being displayed.
        • -
      • Fixed a bug (#1613) - Form Helper functions form_multiselect(), form_dropdown() didn’t properly handle empty array option groups.
        • -
      • Fixed a bug (#1605) - Pagination Library produced incorrect previous and next link values.
        • -
      • Fixed a bug in SQLSRV’s affected_rows() method where an erroneous function name was used.
        • -
      • Fixed a bug (#1000) - Change syntax of $view_file to $_ci_view_file to prevent being overwritten by application.
        • -
      • Fixed a bug (#1757) - Directory Helper function directory_map() was skipping files and directories named ‘0’.
        • -
      • Fixed a bug (#1789) - Database Library method escape_str() escaped quote characters in LIKE conditions twice under MySQL.
        • -
      • Fixed a bug (#395) - Unit Testing Library method result() didn’t properly check array result columns when called from report().
        • -
      • Fixed a bug (#1692) - Database Class method display_error() didn’t properly trace the possible error source on Windows systems.
        • -
      • Fixed a bug (#1745) - Database Class method is_write_type() didn’t return TRUE for LOAD queries.
        • -
      • Fixed a bug (#1765) - Database Class didn’t properly detect connection errors for the ‘mysqli’ driver.
        • -
      • Fixed a bug (#1257) - Query Builder used to (unnecessarily) group FROM clause contents, which breaks certain queries and is invalid for some databases.
        • -
      • Fixed a bug (#1709) - Email headers were broken when using long email subjects and rn as CRLF.
        • -
      • Fixed a bug where MB_ENABLED constant was only declared if UTF8_ENABLED was set to TRUE.
        • -
      • Fixed a bug where the Session Library accepted cookies with last_activity values being in the future.
        • -
      • Fixed a bug (#1897) - Email Library triggered PHP E_WARNING errors when mail protocol used and to() is never called.
        • -
      • Fixed a bug (#1409) - Email Library didn’t properly handle multibyte characters when applying Q-encoding to headers.
        • -
      • Fixed a bug where Email Library ignored its wordwrap setting while handling alternative messages.
        • -
      • Fixed a bug (#1476, #1909) - Pagination Library didn’t take into account actual routing when determining the current page.
        • -
      • Fixed a bug (#1766) - Query Builder didn’t always take into account the dbprefix setting.
        • -
      • Fixed a bug (#779) - URI Class didn’t always trim slashes from the uri_string as shown in the documentation.
        • -
      • Fixed a bug (#134) - Database Caching method delete_cache() didn’t work in some cases due to cachedir not being initialized properly.
        • -
      • Fixed a bug (#191) - Loader Library ignored attempts for (re)loading databases to get_instance()->db even when the old database connection is dead.
        • -
      • Fixed a bug (#1255) - User Agent Library method is_referral() only checked if $_SERVER['HTTP_REFERER'] exists.
        • -
      • Fixed a bug (#1146) - Download Helper function force_download() incorrectly sent Cache-Control directives pre-check and post-check to Internet Explorer.
        • -
      • Fixed a bug (#1811) - URI Library didn’t properly cache segments for uri_to_assoc() and ruri_to_assoc().
        • -
      • Fixed a bug (#1506) - Form Helpers set empty name attributes.
        • -
      • Fixed a bug (#59) - Query Builder method count_all_results() ignored the DISTINCT clause.
        • -
      • Fixed a bug (#1624) - Form Validation Library rule matches didn’t property handle array field names.
        • -
      • Fixed a bug (#1630) - Form Helper function set_value() didn’t escape HTML entities.
        • -
      • Fixed a bug (#142) - Form Helper function form_dropdown() didn’t escape HTML entities in option values.
        • -
      • Fixed a bug (#50) - Session Library unnecessarily stripped slashed from serialized data, making it impossible to read objects in a namespace.
        • -
      • Fixed a bug (#658) - Routing wildcard :any didn’t work as advertised and matched multiple URI segments instead of all characters within a single segment.
        • -
      • Fixed a bug (#1938) - Email Library removed multiple spaces inside a pre-formatted plain text message.
        • -
      • Fixed a bug (#122) - URI Library method ruri_string() didn’t include a directory if one is used.
        • -
      • Fixed a bug - Routing Library didn’t properly handle default_controller in a subdirectory when a method is also specified.
        • -
      • Fixed a bug (#953) - post_controller_constructor hook wasn’t called with a 404_override.
        • -
      • Fixed a bug (#1220) - Profiler Library didn’t display information for database objects that are instantiated inside models.
        • -
      • Fixed a bug (#1978) - Directory Helper function directory_map()‘s return array didn’t make a distinction between directories and file indexes when a directory with a numeric name is present.
        • -
      • Fixed a bug (#777) - Loader Library didn’t look for helper extensions in added package paths.
        • -
      • Fixed a bug (#18) - APC Cache driver didn’t (un)serialize data, resulting in failure to store objects.
        • -
      • Fixed a bug (#188) - Unit Testing Library filled up logs with error messages for non-existing language keys.
        • -
      • Fixed a bug (#113) - Form Validation Library didn’t properly handle empty fields that were specified as an array.
        • -
      • Fixed a bug (#2061) - Routing Class didn’t properly sanitize directory, controller and function triggers with enable_query_strings set to TRUE.
        • -
      • Fixed a bug - SQLSRV didn’t support escape_like_str() or escaping an array of values.
        • -
      • Fixed a bug - Database Results method list_fields() didn’t reset its field pointer for the ‘mysql’, ‘mysqli’ and ‘mssql’ drivers.
        • -
      • Fixed a bug (#2211) - Migration Library extensions couldn’t execute CI_Migration::__construct().
        • -
      • Fixed a bug (#2255) - Email Library didn’t apply smtp_timeout to socket reads and writes.
        • -
      • Fixed a bug (#2239) - Email Library improperly handled the Subject when used with bcc_batch_mode resulting in E_WARNING messages and an empty Subject.
        • -
      • Fixed a bug (#2234) - Query Builder didn’t reset JOIN cache for write-type queries.
        • -
      • Fixed a bug (#2298) - Database Results method next_row() kept returning the last row, allowing for infinite loops.
        • -
      • Fixed a bug (#2236, #2639) - Form Helper functions set_value(), set_select(), set_radio(), set_checkbox() didn’t parse array notation for keys if the rule was not present in the Form Validation Library.
        • -
      • Fixed a bug (#2353) - Query Builder erroneously prefixed literal strings with dbprefix.
        • -
      • Fixed a bug (#78) - Cart Library didn’t allow non-English letters in product names.
        • -
      • Fixed a bug (#77) - Database Class didn’t properly handle the transaction “test mode” flag.
        • -
      • Fixed a bug (#2380) - URI Routing method fetch_method() returned ‘index’ if the requested method name matches its controller name.
        • -
      • Fixed a bug (#2388) - Email Library used to ignore attachment errors, resulting in broken emails being sent.
        • -
      • Fixed a bug (#2498) - Form Validation Library rule valid_base64 only checked characters instead of actual validity.
        • -
      • Fixed a bug (#2425) - OCI8 database driver method stored_procedure() didn’t log an error unless db_debug was set to TRUE.
        • -
      • Fixed a bug (#2490) - Database Class method query() returning boolean instead of a result object for PostgreSQL-specific INSERT INTO ... RETURNING statements.
        • -
      • Fixed a bug (#249) - Cache Library didn’t properly handle Memcache(d) configurations with missing options.
        • -
      • Fixed a bug (#180) - config_item() didn’t take into account run-time configuration changes.
        • -
      • Fixed a bug (#2551) - Loader Library method library() didn’t properly check if a class that is being loaded already exists.
        • -
      • Fixed a bug (#2560) - Form Helper function form_open() set the ‘method=”post”’ attribute only if the passed attributes equaled an empty string.
        • -
      • Fixed a bug (#2585) - Query Builder methods min(), max(), avg(), sum() didn’t escape field names.
        • -
      • Fixed a bug (#2590) - Common function log_message() didn’t actually cache the CI_Log class instance.
        • -
      • Fixed a bug (#2609) - Common function get_config() optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
        • -
      • Fixed a bug in the ‘postgre’ database driver where the connection ID wasn’t passed to pg_escape_string().
        • -
      • Fixed a bug (#33) - Script execution was terminated when an invalid cookie key was encountered.
        • -
      • Fixed a bug (#2691) - nested database transactions could end in a deadlock when an error is encountered with db_debug set to TRUE.
        • -
      • Fixed a bug (#2515) - _exception_handler() used to send the 200 “OK” HTTP status code and didn’t stop script exection even on fatal errors.
        • -
      • Fixed a bug - Redis Caching driver didn’t handle connection failures properly.
        • -
      • Fixed a bug (#2756) - Database Class executed the MySQL-specific SET SESSION sql_mode query for all drivers when the ‘stricton’ option is set.
        • -
      • Fixed a bug (#2579) - Query Builder “no escape” functionality didn’t work properly with query cache.
        • -
      • Fixed a bug (#2237) - Parser Library failed if the same tag pair is used more than once within a template.
        • -
      • Fixed a bug (#2143) - Form Validation Library didn’t check for rule groups named in a controller/method manner when trying to load from a config file.
        • -
      • Fixed a bug (#2762) - Hooks Class didn’t properly check if the called class/function exists.
        • -
      • Fixed a bug (#148) - Input Library internal method _clean_input_data() assumed that it data is URL-encoded, stripping certain character sequences from it.
        • -
      • Fixed a bug (#346) - with $config['global_xss_filtering'] turned on, the $_GET, $_POST, $_COOKIE and $_SERVER superglobals were overwritten during initialization time, resulting in XSS filtering being either performed twice or there was no possible way to get the original data, even though options for this do exist.
        • -
      • Fixed an edge case (#555) - User Agent Library reported an incorrect version Opera 10+ due to a non-standard user-agent string.
        • -
      • Fixed a bug (#133) - Text Helper ascii_to_entities() stripped the last character if it happens to be in the extended ASCII group.
        • -
      • Fixed a bug (#2822) - fwrite() was used incorrectly throughout the whole framework, allowing incomplete writes when writing to a network stream and possibly a few other edge cases.
        • -
      • Fixed a bug where User Agent Library methods accept_charset() and accept_lang() didn’t properly parse HTTP headers that contain spaces.
        • -
      • Fixed a bug where default_controller was called instad of triggering a 404 error if the current route is in a controller directory.
        • -
      • Fixed a bug (#2737) - XML-RPC Library used objects as array keys, which triggered E_NOTICE messages.
        • -
      • Fixed a bug (#2771) - Security Library method xss_clean() didn’t take into account HTML5 entities.
        • -
      • Fixed a bug (#2856) - ODBC method affected_rows() passed an incorrect value to odbc_num_rows().
        • -
      • Fixed a bug (#43) Image Manipulation Library method text_watermark() didn’t properly determine watermark placement.
        • -
      • Fixed a bug where HTML Table Library ignored its auto_heading setting if headings were not already set.
        • -
      • Fixed a bug (#2364) - Pagination Library appended the query string (if used) multiple times when there are successive calls to create_links() with no initialize() in between them.
        • -
      • Partially fixed a bug (#261) - UTF-8 class method clean_string() generating log messages and/or not producing the desired result due to an upstream bug in iconv.
        • -
      • Fixed a bug where CI_Xmlrpcs::parseRequest() could fail if $HTTP_RAW_POST_DATA is not populated.
        • -
      • Fixed a bug in Zip Library internal method _get_mod_time() where it was not parsing result returned by filemtime().
        • -
      • Fixed a bug (#3161) - Cache Library methods increment(), decrement() didn’t auto-create non-existent items when using redis and/or file storage.
        • -
      • Fixed a bug (#3189) - Parser Library used double replacement on key->value pairs, exposing a potential template injection vulnerability.
        • -
      • Fixed a bug (#3573) - Email Library violated RFC5321 by sending ‘localhost.localdomain’ as a hostname.
        • -
      • Fixed a bug (#3572) - CI_Security::_remove_evil_attributes() failed for large-sized inputs due to pcre.backtrack_limit and didn’t properly match HTML tags.
        • -
      -
      -
      -
      -

      Version 2.2.3

      -

      Release Date: July 14, 2015

      -
        -
      • Security
          -
        • Removed a fallback to mysql_escape_string() in the ‘mysql’ database driver (escape_str() method) when there’s no active database connection.
          • -
        -
        • -
      -
      -
      -

      Version 2.2.2

      -

      Release Date: April 15, 2015

      -
        -
      • General Changes
          -
        • Added HTTP “Host” header character validation to prevent cache poisoning attacks when base_url auto-detection is used.
          • -
        • Added FSCommand and seekSegmentTime to the “evil attributes” list in CI_Security::xss_clean().
          • -
        -
        • -
      -
      -

      Bug fixes for 2.2.2

      -
        -
      • Fixed a bug (#3665) - CI_Security::entity_decode() triggered warnings under some circumstances.
        • -
      -
      -
      -
      -

      Version 2.2.1

      -

      Release Date: January 22, 2015

      -
        -
      • General Changes
          -
        • Improved security in xss_clean().
          • -
        • Updated timezones in Date Helper.
          • -
        -
        • -
      -
      -

      Bug fixes for 2.2.1

      -
        -
      • Fixed a bug (#3094) - Internal method CI_Input::_clean_input_data() breaks encrypted session cookies.
        • -
      • Fixed a bug (#2268) - Security Library method xss_clean() didn’t properly match JavaScript events.
        • -
      • Fixed a bug (#3309) - Security Library method xss_clean() used an overly-invasive pattern to strip JS event handlers.
        • -
      • Fixed a bug (#2771) - Security Library method xss_clean() didn’t take into account HTML5 entities.
        • -
      • Fixed a bug (#73) - Security Library method sanitize_filename() could be tricked by an XSS attack.
        • -
      • Fixed a bug (#2681) - Security Library method entity_decode() used the PREG_REPLACE_EVAL flag, which is deprecated since PHP 5.5.
        • -
      • Fixed a bug (#3302) - Internal function get_config() triggered an E_NOTICE message on PHP 5.6.
        • -
      • Fixed a bug (#2508) - Config Library didn’t properly detect if the current request is via HTTPS.
        • -
      • Fixed a bug (#3314) - SQLSRV Database driver‘s method count_all() didn’t escape the supplied table name.
        • -
      • Fixed a bug (#3404) - MySQLi Database driver‘s method escape_str() had a wrong fallback to mysql_escape_string() when there was no active connection.
        • -
      • Fixed a bug in the Session Library where session ID regeneration occurred during AJAX requests.
        • -
      -
      -
      -
      -

      Version 2.2.0

      -

      Release Date: June 2, 2014

      -
        -
      • General Changes
          -
        • Security: Encrypt Library method xor_encode() has been removed. The Encrypt Class now requires the Mcrypt extension to be installed.
          • -
        • Security: The Session Library now uses HMAC authentication instead of a simple MD5 checksum.
          • -
        -
        • -
      -
      -

      Bug fixes for 2.2.0

      -
        -
      • Fixed an edge case (#2583) in the Email Library where Suhosin <http://www.hardened-php.net/suhosin/> blocked messages sent via mail() due to trailing newspaces in headers.
        • -
      • Fixed a bug (#696) - make oci_execute() calls inside num_rows() non-committing, since they are only there to reset which row is next in line for oci_fetch calls and thus don’t need to be committed.
        • -
      • Fixed a bug (#2689) - Database Force methods create_table(), drop_table() and rename_table() produced broken SQL for tge ‘sqlsrv’ driver.
        • -
      • Fixed a bug (#2427) - PDO Database driver didn’t properly check for query failures.
        • -
      • Fixed a bug in the Session Library where authentication was not performed for encrypted cookies.
        • -
      -
      -
      -
      -

      Version 2.1.4

      -

      Release Date: July 8, 2013

      -
        -
      • General Changes
          -
        • Improved security in xss_clean().
          • -
        -
        • -
      -
      -

      Bug fixes for 2.1.4

      -
        -
      • Fixed a bug (#1936) - Migration Library method latest() had a typo when retrieving language values.
        • -
      • Fixed a bug (#2021) - Migration Library configuration file was mistakenly using Windows style line feeds.
        • -
      • Fixed a bug (#1273) - E_NOTICE being generated by Query Builder‘s set_update_batch() method.
        • -
      • Fixed a bug (#2337) - Email Library method print_debugger() didn’t apply htmlspecialchars() to headers.
        • -
      -
      -
      -
      -

      Version 2.1.3

      -

      Release Date: October 8, 2012

      - -
      -

      Bug fixes for 2.1.3

      -
        -
      • Fixed a bug (#1543) - File-based Caching method get_metadata() used a non-existent array key to look for the TTL value.
        • -
      • Fixed a bug (#1314) - Session Library method sess_destroy() didn’t destroy the userdata array.
        • -
      • Fixed a bug (#804) - Profiler library was trying to handle objects as strings in some cases, resulting in E_WARNING messages being issued by htmlspecialchars().
        • -
      • Fixed a bug (#1699) - Migration Library ignored the $config['migration_path'] setting.
        • -
      • Fixed a bug (#227) - Input Library allowed unconditional spoofing of HTTP clients’ IP addresses through the HTTP_CLIENT_IP header.
        • -
      • Fixed a bug (#907) - Input Library ignored HTTP_X_CLUSTER_CLIENT_IP and HTTP_X_CLIENT_IP headers when checking for proxies.
        • -
      • Fixed a bug (#940) - csrf_verify() used to set the CSRF cookie while processing a POST request with no actual POST data, which resulted in validating a request that should be considered invalid.
        • -
      • Fixed a bug (#499) - Security Library where a CSRF cookie was created even if $config['csrf_protection'] is set to FALSE.
        • -
      • Fixed a bug (#1715) - Input Library triggered csrf_verify() on CLI requests.
        • -
      • Fixed a bug (#751) - Query Builder didn’t properly handle cached field escaping overrides.
        • -
      • Fixed a bug (#2004) - Query Builder didn’t properly merge cached calls with non-cache ones.
        • -
      -
      -
      -
      -

      Version 2.1.2

      -

      Release Date: June 29, 2012

      -
        -
      • General Changes
          -
        • Improved security in xss_clean().
          • -
        -
        • -
      -
      -
      -

      Version 2.1.1

      -

      Release Date: June 12, 2012

      -
        -
      • General Changes
          -
        • Fixed support for docx, xlsx files in mimes.php.
          • -
        -
        • -
      • Libraries -
        • -
      • Helpers
          -
        • url_title() performance and output improved. You can now use any string as the word delimiter, but ‘dash’ and ‘underscore’ are still supported.
          • -
        -
        • -
      -
      -

      Bug fixes for 2.1.1

      -
        -
      • Fixed a bug (#697) - A wrong array key was used in the File Uploading Library to check for mime-types.
        • -
      • Fixed a bug - form_open() compared $action against site_url() instead of base_url().
        • -
      • Fixed a bug - CI_Upload::_file_mime_type() could’ve failed if mime_content_type() is used for the detection and returns FALSE.
        • -
      • Fixed a bug (#538) - Windows paths were ignored when using the Image Manipulation Library to create a new file.
        • -
      • Fixed a bug - When database caching was enabled, $this->db->query() checked the cache before binding variables which resulted in cached queries never being found.
        • -
      • Fixed a bug - CSRF cookie value was allowed to be any (non-empty) string before being written to the output, making code injection a risk.
        • -
      • Fixed a bug (#726) - PDO put a ‘dbname’ argument in its connection string regardless of the database platform in use, which made it impossible to use SQLite.
        • -
      • Fixed a bug - CI_DB_pdo_driver::num_rows() was not returning properly value with SELECT queries, cause it was relying on PDOStatement::rowCount().
        • -
      • Fixed a bug (#1059) - CI_Image_lib::clear() was not correctly clearing all necessary object properties, namely width and height.
        • -
      -
      -
      -
      -

      Version 2.1.0

      -

      Release Date: November 14, 2011

      -
        -
      • General Changes
          -
        • Callback validation rules can now accept parameters like any other -validation rule.
          • -
        • Added html_escape() to Common -functions to escape HTML output -for preventing XSS.
          • -
        -
        • -
      • Helpers
          -
        • Added increment_string() to String -Helper to turn “foo” into “foo-1” -or “foo-1” into “foo-2”.
          • -
        • Altered form helper - made action on form_open_multipart helper -function call optional. Fixes (#65)
          • -
        • url_title() will now trim extra dashes from beginning and end.
          • -
        • Improved speed of String Helper‘s random_string() method
          • -
        -
        • -
      • Database
          -
        • Added a CUBRID driver to the Database -Driver. Thanks to the CUBRID team for -supplying this patch.
          • -
        • Added a PDO driver to the Database Driver.
          • -
        • Typecast limit and offset in the Database -Driver to integers to avoid possible -injection.
          • -
        • Added additional option ‘none’ for the optional third argument for -$this->db->like() in the Database -Driver.
          • -
        • Added $this->db->insert_batch() support to the OCI8 (Oracle) driver.
          • -
        • Added failover if the main connections in the config should fail
          • -
        -
        • -
      • Libraries
          -
        • Changed $this->cart->insert() in the Cart -Library to return the Row ID if a single -item was inserted successfully.
          • -
        • Added support to set an optional parameter in your callback rules -of validation using the Form Validation -Library.
          • -
        • Added a Migration library to assist with applying -incremental updates to your database schema.
          • -
        • Driver children can be located in any package path.
          • -
        • Added max_filename_increment config setting for Upload library.
          • -
        • Added is_unique to the Form Validation library.
          • -
        • Added $config[‘use_page_numbers’] to the Pagination library, which enables real page numbers in the URI.
          • -
        • Added TLS and SSL Encryption for SMTP.
          • -
        -
        • -
      • Core
          -
        • Changed private functions in CI_URI to protected so MY_URI can -override them.
          • -
        • Removed CI_CORE boolean constant from CodeIgniter.php (no longer Reactor and Core versions).
          • -
        -
        • -
      -
      -

      Bug fixes for 2.1.0

      -
        -
      • Fixed #378 Robots identified as regular browsers by the User Agent -class.
        • -
      • If a config class was loaded first then a library with the same name -is loaded, the config would be ignored.
        • -
      • Fixed a bug (Reactor #19) where 1) the 404_override route was being -ignored in some cases, and 2) auto-loaded libraries were not -available to the 404_override controller when a controller existed -but the requested method did not.
        • -
      • Fixed a bug (Reactor #89) where MySQL export would fail if the table -had hyphens or other non alphanumeric/underscore characters.
        • -
      • Fixed a bug (#105) that stopped query errors from being logged unless database debugging was enabled
        • -
      • Fixed a bug (#160) - Removed unneeded array copy in the file cache -driver.
        • -
      • Fixed a bug (#150) - field_data() now correctly returns column -length.
        • -
      • Fixed a bug (#8) - load_class() now looks for core classes in -APPPATH first, allowing them to be replaced.
        • -
      • Fixed a bug (#24) - ODBC database driver called incorrect parent in __construct().
        • -
      • Fixed a bug (#85) - OCI8 (Oracle) database escape_str() function did not escape correct.
        • -
      • Fixed a bug (#344) - Using schema found in Saving Session Data to a Database, system would throw error “user_data does not have a default value” when deleting then creating a session.
        • -
      • Fixed a bug (#112) - OCI8 (Oracle) driver didn’t pass the configured database character set when connecting.
        • -
      • Fixed a bug (#182) - OCI8 (Oracle) driver used to re-execute the statement whenever num_rows() is called.
        • -
      • Fixed a bug (#82) - WHERE clause field names in the DB update_string() method were not escaped, resulting in failed queries in some cases.
        • -
      • Fixed a bug (#89) - Fix a variable type mismatch in DB display_error() where an array is expected, but a string could be set instead.
        • -
      • Fixed a bug (#467) - Suppress warnings generated from get_magic_quotes_gpc() (deprecated in PHP 5.4)
        • -
      • Fixed a bug (#484) - First time _csrf_set_hash() is called, hash is never set to the cookie (in Security.php).
        • -
      • Fixed a bug (#60) - Added _file_mime_type() method to the File Uploading Library in order to fix a possible MIME-type injection.
        • -
      • Fixed a bug (#537) - Support for all wav type in browser.
        • -
      • Fixed a bug (#576) - Using ini_get() function to detect if apc is enabled or not.
        • -
      • Fixed invalid date time format in Date helper and XMLRPC library.
        • -
      • Fixed a bug (#200) - MySQL queries would be malformed after calling db->count_all() then db->get().
        • -
      -
      -
      -
      -

      Version 2.0.3

      -

      Release Date: August 20, 2011

      -
        -

      • Security

        -
          -

        • An improvement was made to the MySQL and MySQLi drivers to prevent -exposing a potential vector for SQL injection on sites using -multi-byte character sets in the database client connection. -An incompatibility in PHP versions < 5.2.3 and MySQL < 5.0.7 with -mysql_set_charset() creates a situation where using multi-byte -character sets on these environments may potentially expose a SQL -injection attack vector. Latin-1, UTF-8, and other “low ASCII” -character sets are unaffected on all environments.

          -

          If you are running or considering running a multi-byte character -set for your database connection, please pay close attention to -the server environment you are deploying on to ensure you are not -vulnerable.

          -
          • -
        -
        • -

      • General Changes

        -
          -
        • Fixed a bug where there was a misspelling within a code comment in -the index.php file.
          • -
        • Added Session Class userdata to the output profiler. Additionally, -added a show/hide toggle on HTTP Headers, Session Data and Config -Variables.
          • -
        • Removed internal usage of the EXT constant.
          • -
        • Visual updates to the welcome_message view file and default error -templates. Thanks to danijelb -for the pull request.
          • -
        • Added insert_batch() function to the PostgreSQL database driver. -Thanks to epallerols for the patch.
          • -
        • Added “application/x-csv” to mimes.php.
          • -
        • Fixed a bug where Email library -attachments with a ”.” in the name would using invalid MIME-types.
          • -
        -
        • -

      • Helpers

        -
          -
        • Added an optional third parameter to heading() which allows adding -html attributes to the rendered heading tag.
          • -
        • form_open() now only adds a hidden (Cross-site Reference Forgery) -protection field when the form’s action is internal and is set to -the post method. (Reactor #165)
          • -
        • Re-worked plural() and singular() functions in the Inflector -helper to support considerably -more words.
          • -
        -
        • -

      • Libraries

        -
          -
        • Altered Session to use a longer match against the user_agent -string. See upgrade notes if using database sessions.
          • -
        • Added $this->db->set_dbprefix() to the Database -Driver.
          • -
        • Changed $this->cart->insert() in the Cart -Library to return the Row ID if a single -item was inserted successfully.
          • -
        • Added $this->load->get_var() to the Loader -library to retrieve global vars set with -$this->load->view() and $this->load->vars().
          • -
        • Changed $this->db->having() to insert quotes using escape() rather -than escape_str().
          • -
        -
        • -
      -
      -

      Bug fixes for 2.0.3

      -
        -
      • Added ENVIRONMENT to reserved constants. (Reactor #196)
        • -
      • Changed server check to ensure SCRIPT_NAME is defined. (Reactor #57)
        • -
      • Removed APPPATH.’third_party’ from the packages autoloader to negate -needless file stats if no packages exist or if the developer does not -load any other packages by default.
        • -
      • Fixed a bug (Reactor #231) where Sessions Library database table -example SQL did not contain an index on last_activity. See Upgrade -Notes.
        • -
      • Fixed a bug (Reactor #229) where the Sessions Library example SQL in -the documentation contained incorrect SQL.
        • -
      • Fixed a bug (Core #340) where when passing in the second parameter to -$this->db->select(), column names in subsequent queries would not be -properly escaped.
        • -
      • Fixed issue #199 - Attributes passed as string does not include a -space between it and the opening tag.
        • -
      • Fixed a bug where the method $this->cart->total_items() from Cart -Library now returns the sum of the quantity -of all items in the cart instead of your total count.
        • -
      • Fixed a bug where not setting ‘null’ when adding fields in db_forge -for mysql and mysqli drivers would default to NULL instead of NOT -NULL as the docs suggest.
        • -
      • Fixed a bug where using $this->db->select_max(), -$this->db->select_min(), etc could throw notices. Thanks to w43l for -the patch.
        • -
      • Replace checks for STDIN with php_sapi_name() == ‘cli’ which on the -whole is more reliable. This should get parameters in crontab -working.
        • -
      -
      -
      -
      -

      Version 2.0.2

      -

      Release Date: April 7, 2011 -Hg Tag: v2.0.2

      -
        -
      • General changes
          -
        • The Security library was moved to -the core and is now loaded automatically. Please remove your -loading calls.
          • -
        • The CI_SHA class is now deprecated. All supported versions of PHP -provide a sha1() function.
          • -
        • constants.php will now be loaded from the environment folder if -available.
          • -
        • Added language key error logging
          • -
        • Made Environment Support optional. Comment out or delete the -constant to stop environment checks.
          • -
        • Added Environment Support for Hooks.
          • -
        • Added CI_ Prefix to the Cache driver.
          • -
        • Added CLI usage documentation.
          • -
        -
        • -
      • Helpers
          -
        • Removed the previously deprecated dohash() from the Security -helper; use do_hash() instead.
          • -
        • Changed the ‘plural’ function so that it doesn’t ruin the -captalization of your string. It also take into consideration -acronyms which are all caps.
          • -
        -
        • -
      • Database
          -
        • $this->db->count_all_results() will now return an integer -instead of a string.
          • -
        -
        • -
      -
      -

      Bug fixes for 2.0.2

      -
        -
      • Fixed a bug (Reactor #145) where the Output Library had -parse_exec_vars set to protected.
        • -
      • Fixed a bug (Reactor #80) where is_really_writable would create an -empty file when on Windows or with safe_mode enabled.
        • -
      • Fixed various bugs with User Guide.
        • -
      • Added is_cli_request() method to documentation for Input -class.
        • -
      • Added form_validation_lang entries for decimal, less_than and -greater_than.
        • -
      • Fixed issue #153 Escape Str Bug in MSSQL driver.
        • -
      • Fixed issue #172 Google Chrome 11 posts incorrectly when action is empty.
        • -
      -
      -
      -
      -

      Version 2.0.1

      -

      Release Date: March 15, 2011 -Hg Tag: v2.0.1

      -
        -
      • General changes
          -
        • Added $config[‘cookie_secure’] to the config file to allow -requiring a secure (HTTPS) in order to set cookies.
          • -
        • Added the constant CI_CORE to help differentiate between Core: -TRUE and Reactor: FALSE.
          • -
        • Added an ENVIRONMENT constant in index.php, which affects PHP -error reporting settings, and optionally, which configuration -files are loaded (see below). Read more on the Handling -Environments page.
          • -
        • Added support for -environment-specific -configuration files.
          • -
        -
        • -
      • Libraries
          -
        • Added decimal, less_than and greater_than rules to the Form -validation Class.
          • -
        • Input Class methods post() and get() -will now return a full array if the first argument is not -provided.
          • -
        • Secure cookies can now be made with the set_cookie() helper and -Input Class method.
          • -
        • Added set_content_type() to Output -Class to set the output Content-Type -HTTP header based on a MIME Type or a config/mimes.php array key.
          • -
        • Output Class will now support method -chaining.
          • -
        -
        • -
      • Helpers
          -
        • Changed the logic for form_open() in Form -helper. If no value is passed it will -submit to the current URL.
          • -
        -
        • -
      -
      -

      Bug fixes for 2.0.1

      -
        -
      • CLI requests can now be run from any folder, not just when CD’ed next -to index.php.
        • -
      • Fixed issue #41: Added audio/mp3 mime type to mp3.
        • -
      • Fixed a bug (Core #329) where the file caching driver referenced the -incorrect cache directory.
        • -
      • Fixed a bug (Reactor #69) where the SHA1 library was named -incorrectly.
        • -
      -
      -
      -
      -

      Version 2.0.0

      -

      Release Date: January 28, 2011 -Hg Tag: v2.0.0

      -
        -
      • General changes
          -
        • PHP 4 support is removed. CodeIgniter now requires PHP 5.1.6.
          • -
        • Scaffolding, having been deprecated for a number of versions, has -been removed.
          • -
        • Plugins have been removed, in favor of Helpers. The CAPTCHA plugin -has been converted to a Helper and -documented. The JavaScript -calendar plugin was removed due to the ready availability of great -JavaScript calendars, particularly with jQuery.
          • -
        • Added new special Library type: -Drivers.
          • -
        • Added full query-string support. See the config file for details.
          • -
        • Moved the application folder outside of the system folder.
          • -
        • Moved system/cache and system/logs directories to the application -directory.
          • -
        • Added routing overrides to the main index.php file, enabling the -normal routing to be overridden on a per “index” file basis.
          • -
        • Added the ability to set config values (or override config values) -directly from data set in the main index.php file. This allows a -single application to be used with multiple front controllers, -each having its own config values.
          • -
        • Added $config[‘directory_trigger’] to the config file so that a -controller sub-directory can be specified when running _GET -strings instead of URI segments.
          • -
        • Added ability to set “Package” paths - specific paths where the -Loader and Config classes should try to look first for a requested -file. This allows distribution of sub-applications with their own -libraries, models, config files, etc. in a single “package” -directory. See the Loader class -documentation for more details.
          • -
        • In-development code is now hosted at BitBucket .
          • -
        • Removed the deprecated Validation Class.
          • -
        • Added CI_ Prefix to all core classes.
          • -
        • Package paths can now be set in application/config/autoload.php.
          • -
        • Upload library file_name can -now be set without an extension, the extension will be taken from -the uploaded file instead of the given name.
          • -
        • In Database Forge the name can be omitted -from $this->dbforge->modify_column()’s 2nd param if you aren’t -changing the name.
          • -
        • $config[‘base_url’] is now empty by default and will guess what -it should be.
          • -
        • Enabled full Command Line Interface compatibility with -config[‘uri_protocol’] = ‘CLI’;.
          • -
        -
        • -
      • Libraries
          -
        • Added a Cache driver with APC, -memcached, and file-based support.
          • -
        • Added $prefix, $suffix and $first_url properties to Pagination -library.
          • -
        • Added the ability to suppress first, previous, next, last, and -page links by setting their values to FALSE in the Pagination -library.
          • -
        • Added Security library, which now -contains the xss_clean function, filename_security function and -other security related functions.
          • -
        • Added CSRF (Cross-site Reference Forgery) protection to the -Security library.
          • -
        • Added $parse_exec_vars property to Output library.
          • -
        • Added ability to enable / disable individual sections of the -Profiler
          • -
        • Added a wildcard option $config[‘allowed_types’] = ‘*’ to the -File Uploading Class.
          • -
        • Added an ‘object’ config variable to the XML-RPC Server library so -that one can specify the object to look for requested methods, -instead of assuming it is in the $CI superobject.
          • -
        • Added “is_object” into the list of unit tests capable of being -run.
          • -
        • Table library will generate an empty cell with a blank string, or -NULL value.
          • -
        • Added ability to set tag attributes for individual cells in the -Table library
          • -
        • Added a parse_string() method to the Parser -Class.
          • -
        • Added HTTP headers and Config information to the -Profiler output.
          • -
        • Added Chrome and Flock to the list of detectable browsers by -browser() in the User Agent Class.
          • -
        • The Unit Test Class now has an -optional “notes” field available to it, and allows for discrete -display of test result items using -$this->unit->set_test_items().
          • -
        • Added a $xss_clean class variable to the XMLRPC library, enabling -control over the use of the Security library’s xss_clean() -method.
          • -
        • Added a download() method to the FTP -library
          • -
        • Changed do_xss_clean() to return FALSE if the uploaded file -fails XSS checks.
          • -
        • Added stripslashes() and trim()ing of double quotes from $_FILES -type value to standardize input in Upload library.
          • -
        • Added a second parameter (boolean) to -$this->zip->read_dir(‘/path/to/directory’, FALSE) to remove the -preceding trail of empty folders when creating a Zip archive. This -example would contain a zip with “directory” and all of its -contents.
          • -
        • Added ability in the Image Library to handle PNG transparency for -resize operations when using the GD lib.
          • -
        • Modified the Session class to prevent use if no encryption key is -set in the config file.
          • -
        • Added a new config item to the Session class -sess_expire_on_close to allow sessions to auto-expire when the -browser window is closed.
          • -
        • Improved performance of the Encryption library on servers where -Mcrypt is available.
          • -
        • Changed the default encryption mode in the Encryption library to -CBC.
          • -
        • Added an encode_from_legacy() method to provide a way to -transition encrypted data from CodeIgniter 1.x to CodeIgniter 2.x. -Please see the upgrade -instructions for details.
          • -
        • Altered Form_Validation library to allow for method chaining on -set_rules(), set_message() and set_error_delimiters() -functions.
          • -
        • Altered Email Library to allow for method chaining.
          • -
        • Added request_headers(), get_request_header() and -is_ajax_request() to the input class.
          • -
        • Altered User agent library so that -is_browser(), is_mobile() and is_robot() can optionally check -for a specific browser or mobile device.
          • -
        • Altered Input library so that post() and -get() will return all POST and GET items (respectively) if there -are no parameters passed in.
          • -
        -
        • -
      • Database
          -
        • database configuration.
          • -
        • Added autoinit value to database -configuration.
          • -
        • Added stricton value to database -configuration.
          • -
        • Added database_exists() to the Database Utilities -Class.
          • -
        • Semantic change to db->version() function to allow a list of -exceptions for databases with functions to return version string -instead of specially formed SQL queries. Currently this list only -includes Oracle and SQLite.
          • -
        • Fixed a bug where driver specific table identifier protection -could lead to malformed queries in the field_data() functions.
          • -
        • Fixed a bug where an undefined class variable was referenced in -database drivers.
          • -
        • Modified the database errors to show the filename and line number -of the problematic query.
          • -
        • Removed the following deprecated functions: orwhere, orlike, -groupby, orhaving, orderby, getwhere.
          • -
        • Removed deprecated _drop_database() and _create_database() -functions from the db utility drivers.
          • -
        • Improved dbforge create_table() function for the Postgres driver.
          • -
        -
        • -
      • Helpers
          -
        • Added convert_accented_characters() function to text -helper.
          • -
        • Added accept-charset to the list of inserted attributes of -form_open() in the Form Helper.
          • -
        • Deprecated the dohash() function in favour of do_hash() for -naming consistency.
          • -
        • Non-backwards compatible change made to get_dir_file_info() in -the File Helper. No longer recurses -by default so as to encourage responsible use (this function can -cause server performance issues when used without caution).
          • -
        • Modified the second parameter of directory_map() in the -Directory Helper to accept an -integer to specify recursion depth.
          • -
        • Modified delete_files() in the File -Helper to return FALSE on failure.
          • -
        • Added an optional second parameter to byte_format() in the -Number Helper to allow for decimal -precision.
          • -
        • Added alpha, and sha1 string types to random_string() in the -String Helper.
          • -
        • Modified prep_url() so as to not prepend http&#58;// if the supplied -string already has a scheme.
          • -
        • Modified get_file_info in the file helper, changing filectime() -to filemtime() for dates.
          • -
        • Modified smiley_js() to add optional third parameter to return -only the javascript with no script tags.
          • -
        • The img() function of the HTML -helper will now generate an empty -string as an alt attribute if one is not provided.
          • -
        • If CSRF is enabled in the application config file, form_open() -will automatically insert it as a hidden field.
          • -
        • Added sanitize_filename() into the Security -helper.
          • -
        • Added ellipsize() to the Text -Helper
          • -
        • Added elements() to the Array -Helper
          • -
        -
        • -
      • Other Changes
          -
        • Added an optional second parameter to show_404() to disable -logging.
          • -
        • Updated loader to automatically apply the sub-class prefix as an -option when loading classes. Class names can be prefixed with the -standard “CI_” or the same prefix as the subclass prefix, or no -prefix at all.
          • -
        • Increased randomness with is_really_writable() to avoid file -collisions when hundreds or thousands of requests occur at once.
          • -
        • Switched some DIR_WRITE_MODE constant uses to FILE_WRITE_MODE -where files and not directories are being operated on.
          • -
        • get_mime_by_extension() is now case insensitive.
          • -
        • Added “default” to the list Reserved -Names.
          • -
        • Added ‘application/x-msdownload’ for .exe files and -‘application/x-gzip-compressed’ for .tgz files to -config/mimes.php.
          • -
        • Updated the output library to no longer compress output or send -content-length headers if the server runs with -zlib.output_compression enabled.
          • -
        • Eliminated a call to is_really_writable() on each request unless -it is really needed (Output caching)
          • -
        • Documented append_output() in the Output -Class.
          • -
        • Documented a second argument in the decode() function for the -Encrypt Class.
          • -
        • Documented db->close().
          • -
        • Updated the router to support a default route with any number of -segments.
          • -
        • Moved _remove_invisible_characters() function from the -Security Library to common -functions.
          • -
        • Added audio/mpeg3 as a valid mime type for MP3.
          • -
        -
        • -
      -
      -

      Bug fixes for 2.0.0

      -
        -
      • Fixed a bug where you could not change the User-Agent when sending -email.
        • -
      • Fixed a bug where the Output class would send incorrect cached output -for controllers implementing their own _output() method.
        • -
      • Fixed a bug where a failed query would not have a saved query -execution time causing errors in the Profiler
        • -
      • Fixed a bug that was writing log entries when multiple identical -helpers and plugins were loaded.
        • -
      • Fixed assorted user guide typos or examples (#10693, #8951, #7825, -#8660, #7883, #6771, #10656).
        • -
      • Fixed a language key in the profiler: “profiler_no_memory_usage” -to “profiler_no_memory”.
        • -
      • Fixed an error in the Zip library that didn’t allow downloading on -PHP 4 servers.
        • -
      • Fixed a bug in the Form Validation library where fields passed as -rule parameters were not being translated (#9132)
        • -
      • Modified inflector helper to properly pluralize words that end in -‘ch’ or ‘sh’
        • -
      • Fixed a bug in xss_clean() that was not allowing hyphens in query -strings of submitted URLs.
        • -
      • Fixed bugs in get_dir_file_info() and get_file_info() in the -File Helper with recursion, and file paths on Windows.
        • -
      • Fixed a bug where Active Record override parameter would not let you -disable Active Record if it was enabled in your database config file.
        • -
      • Fixed a bug in reduce_double_slashes() in the String Helper to -properly remove duplicate leading slashes (#7585)
        • -
      • Fixed a bug in values_parsing() of the XML-RPC library which -prevented NULL variables typed as ‘string’ from being handled -properly.
        • -
      • Fixed a bug were form_open_multipart() didn’t accept string -attribute arguments (#10930).
        • -
      • Fixed a bug (#10470) where get_mime_by_extension() was case -sensitive.
        • -
      • Fixed a bug where some error messages for the SQLite and Oracle -drivers would not display.
        • -
      • Fixed a bug where files created with the Zip Library would result in -file creation dates of 1980.
        • -
      • Fixed a bug in the Session library that would result in PHP error -when attempting to store values with objects.
        • -
      • Fixed a bug where extending the Controller class would result in a -fatal PHP error.
        • -
      • Fixed a PHP Strict Standards Error in the index.php file.
        • -
      • Fixed a bug where getimagesize() was being needlessly checked on -non-image files in is_allowed_type().
        • -
      • Fixed a bug in the Encryption library where an empty key was not -triggering an error.
        • -
      • Fixed a bug in the Email library where CC and BCC recipients were not -reset when using the clear() method (#109).
        • -
      • Fixed a bug in the URL Helper where prep_url() could cause a PHP -error on PHP versions < 5.1.2.
        • -
      • Added a log message in core/output if the cache directory config -value was not found.
        • -
      • Fixed a bug where multiple libraries could not be loaded by passing -an array to load->library()
        • -
      • Fixed a bug in the html helper where too much white space was -rendered between the src and alt tags in the img() function.
        • -
      • Fixed a bug in the profilers _compile_queries() function.
        • -
      • Fixed a bug in the date helper where the DATE_ISO8601 variable was -returning an incorrectly formatted date string.
        • -
      -
      -
      -
      -

      Version 1.7.2

      -

      Release Date: September 11, 2009 -Hg Tag: v1.7.2

      -
        -
      • Libraries
          -
        • Added a new Cart Class.
          • -
        • Added the ability to pass $config[‘file_name’] for the File -Uploading Class and rename the -uploaded file.
          • -
        • Changed order of listed user-agents so Safari would more -accurately report itself. (#6844)
          • -
        -
        • -
      • Database
          -
        • Switched from using gettype() in escape() to is_* methods, since -future PHP versions might change its output.
          • -
        • Updated all database drivers to handle arrays in escape_str()
          • -
        • Added escape_like_str() method for escaping strings to be used -in LIKE conditions
          • -
        • Updated Active Record to utilize the new LIKE escaping mechanism.
          • -
        • Added reconnect() method to DB drivers to try to keep alive / -reestablish a connection after a long idle.
          • -
        • Modified MSSQL driver to use mssql_get_last_message() for error -messages.
          • -
        -
        • -
      • Helpers
          -
        • Added form_multiselect() to the Form -helper.
          • -
        • Modified form_hidden() in the Form -helper to accept multi-dimensional -arrays.
          • -
        • Modified form_prep() in the Form -helper to keep track of prepped -fields to avoid multiple prep/mutation from subsequent calls which -can occur when using Form Validation and form helper functions to -output form fields.
          • -
        • Modified directory_map() in the Directory -helper to allow the inclusion of -hidden files, and to return FALSE on failure to read directory.
          • -
        • Modified the Smiley helper to work -with multiple fields and insert the smiley at the last known -cursor position.
          • -
        -
        • -
      • General
          -
        • Compatible with PHP 5.3.0.
          • -
        • Modified show_error() to allow sending -of HTTP server response codes.
          • -
        • Modified show_404() to send 404 status -code, removing non-CGI compatible header() statement from -error_404.php template.
          • -
        • Added set_status_header() to the Common -functions to allow use when the -Output class is unavailable.
          • -
        • Added is_php() to Common -functions to facilitate PHP -version comparisons.
          • -
        • Added 2 CodeIgniter “cheatsheets” (thanks to DesignFellow.com for -this contribution).
          • -
        -
        • -
      -
      -

      Bug fixes for 1.7.2

      -
        -
      • Fixed assorted user guide typos or examples (#6743, #7214, #7516, -#7287, #7852, #8224, #8324, #8349).
        • -
      • Fixed a bug in the Form Validation library where multiple callbacks -weren’t working (#6110)
        • -
      • doctype helper default value was missing a “1”.
        • -
      • Fixed a bug in the language class when outputting an error for an -unfound file.
        • -
      • Fixed a bug in the Calendar library where the shortname was output -for “May”.
        • -
      • Fixed a bug with ORIG_PATH_INFO that was allowing URIs of just a -slash through.
        • -
      • Fixed a fatal error in the Oracle and ODBC drivers (#6752)
        • -
      • Fixed a bug where xml_from_result() was checking for a nonexistent -method.
        • -
      • Fixed a bug where Database Forge’s add_column and modify_column -were not looping through when sent multiple fields.
        • -
      • Fixed a bug where the File Helper was using ‘/’ instead of the -DIRECTORY_SEPARATOR constant.
        • -
      • Fixed a bug to prevent PHP errors when attempting to use sendmail on -servers that have manually disabled the PHP popen() function.
        • -
      • Fixed a bug that would cause PHP errors in XML-RPC data if the PHP -data type did not match the specified XML-RPC type.
        • -
      • Fixed a bug in the XML-RPC class with parsing dateTime.iso8601 data -types.
        • -
      • Fixed a case sensitive string replacement in xss_clean()
        • -
      • Fixed a bug in form_textarea() where form data was not prepped -correctly.
        • -
      • Fixed a bug in form_prep() causing it to not preserve entities in -the user’s original input when called back into a form element
        • -
      • Fixed a bug in _protect_identifiers() where the swap prefix -($swap_pre) was not being observed.
        • -
      • Fixed a bug where the 400 status header sent with the ‘disallowed URI -characters’ was not compatible with CGI environments.
        • -
      • Fixed a bug in the typography class where heading tags could have -paragraph tags inserted when using auto_typography().
        • -
      -
      -
      -
      -

      Version 1.7.1

      -

      Release Date: February 10, 2009 -Hg Tag: 1.7.1

      -
        -
      • Libraries
          -
        • Fixed an arbitrary script execution security flaw (#6068) in the -Form Validation library (thanks to hkk)
          • -
        • Changed default current page indicator in the Pagination library -to use <strong> instead of <b>
          • -
        • A “HTTP/1.1 400 Bad Request” header is now sent when disallowed -characters are encountered.
          • -
        • Added <big>, <small>, <q>, and <tt> to the Typography parser’s -inline elements.
          • -
        • Added more accurate error reporting for the Email library when -using sendmail.
          • -
        • Removed a strict type check from the rotate() function of the -Image Manipulation Class.
          • -
        • Added enhanced error checking in file saving in the Image library -when using the GD lib.
          • -
        • Added an additional newline between multipart email headers and -the MIME message text for better compatibility with a variety of -MUAs.
          • -
        • Made modest improvements to efficiency and accuracy of -explode_name() in the Image lib.
          • -
        -
        • -
      • Database
          -
        • Added where_in to the list of expected arguments received by -delete().
          • -
        -
        • -
      • Helpers
          -
        • Added the ability to have optgroups in form_dropdown() within the -form helper.
          • -
        • Added a doctype() function to the HTML -helper.
          • -
        • Added ability to force lowercase for url_title() in the URL -helper.
          • -
        • Changed the default “type” of form_button() to “button” from -“submit” in the form helper.
          • -
        • Changed redirect() in the URL helper to allow redirections to URLs -outside of the CI site.
          • -
        • Updated get_cookie() to try to fetch the cookie using the global -cookie prefix if the requested cookie name doesn’t exist.
          • -
        -
        • -
      • Other Changes
          -
        • Improved security in xss_clean() to help prevent attacks -targeting Internet Explorer.
          • -
        • Added ‘application/msexcel’ to config/mimes.php for .xls files.
          • -
        • Added ‘proxy_ips’ config item to whitelist reverse proxy servers -from which to trust the HTTP_X_FORWARDED_FOR header to to -determine the visitor’s IP address.
          • -
        • Improved accuracy of Upload::is_allowed_filetype() for images -(#6715)
          • -
        -
        • -
      -
      -

      Bug fixes for 1.7.1

      -
        -
      • Database
          -
        • Fixed a bug when doing ‘random’ on order_by() (#5706).
          • -
        • Fixed a bug where adding a primary key through Forge could fail -(#5731).
          • -
        • Fixed a bug when using DB cache on multiple databases (#5737).
          • -
        • Fixed a bug where TRUNCATE was not considered a “write” query -(#6619).
          • -
        • Fixed a bug where csv_from_result() was checking for a -nonexistent method.
          • -
        • Fixed a bug _protect_identifiers() where it was improperly -removing all pipe symbols from items
          • -
        -
        • -
      • Fixed assorted user guide typos or examples (#5998, #6093, #6259, -#6339, #6432, #6521).
        • -
      • Fixed a bug in the MySQLi driver when no port is specified
        • -
      • Fixed a bug (#5702), in which the field label was not being fetched -properly, when “matching” one field to another.
        • -
      • Fixed a bug in which identifers were not being escaped properly when -reserved characters were used.
        • -
      • Fixed a bug with the regular expression used to protect submitted -paragraph tags in auto typography.
        • -
      • Fixed a bug where double dashes within tag attributes were being -converted to em dash entities.
        • -
      • Fixed a bug where double spaces within tag attributes were being -converted to non-breaking space entities.
        • -
      • Fixed some accuracy issues with curly quotes in -Typography::format_characters()
        • -
      • Changed a few docblock comments to reflect actual return values.
        • -
      • Fixed a bug with high ascii characters in subject and from email -headers.
        • -
      • Fixed a bug in xss_clean() where whitespace following a validated -character entity would not be preserved.
        • -
      • Fixed a bug where HTML comments and <pre> tags were being parsed in -Typography::auto_typography().
        • -
      • Fixed a bug with non-breaking space cleanup in -Typography::auto_typography().
        • -
      • Fixed a bug in database escaping where a compound statement (ie: -SUM()) wasn’t handled correctly with database prefixes.
        • -
      • Fixed a bug when an opening quote is preceded by a paragraph tag and -immediately followed by another tag.
        • -
      • Fixed a bug in the Text Helper affecting some locales where -word_censor() would not work on words beginning or ending with an -accented character.
        • -
      • Fixed a bug in the Text Helper character limiter where the provided -limit intersects the last word of the string.
        • -
      • Fixed a bug (#6342) with plural() in the Inflection helper with words -ending in “y”.
        • -
      • Fixed bug (#6517) where Routed URI segments returned by -URI::rsegment() method were incorrect for the default controller.
        • -
      • Fixed a bug (#6706) in the Security Helper where xss_clean() was -using a deprecated second argument.
        • -
      • Fixed a bug in the URL helper url_title() function where trailing -periods were allowed at the end of a URL.
        • -
      • Fixed a bug (#6669) in the Email class when CRLF’s are used for the -newline character with headers when used with the “mail” protocol.
        • -
      • Fixed a bug (#6500) where URI::A_filter_uri() was exit()ing an -error instead of using show_error().
        • -
      • Fixed a bug (#6592) in the File Helper where get_dir_file_info() -where recursion was not occurring properly.
        • -
      • Tweaked Typography::auto_typography() for some edge-cases.
        • -
      -
      -
      -
      -

      Version 1.7

      -

      Release Date: October 23, 2008 -Hg Tag: 1.7.0

      -
        -
      • Libraries
          -
        • Added a new Form Validation -Class. It simplifies setting -rules and field names, supports arrays as field names, allows -groups of validation rules to be saved in a config file, and adds -some helper functions for use in view files. Please note that -the old Validation class is now deprecated. We will leave it in -the library folder for some time so that existing applications -that use it will not break, but you are encouraged to migrate to -the new version.
          • -
        • Updated the Sessions class so that -any custom data being saved gets stored to a database rather than -the session cookie (assuming you are using a database to store -session data), permitting much more data to be saved.
          • -
        • Added the ability to store libraries in subdirectories within -either the main “libraries” or the local application “libraries” -folder. Please see the Loader class for -more info.
          • -
        • Added the ability to assign library objects to your own variable -names when you use $this->load->library(). Please see the Loader -class for more info.
          • -
        • Added controller class/method info to Profiler -class and support for multiple database -connections.
          • -
        • Improved the “auto typography” feature and moved it out of the -helper into its own Typography -Class.
          • -
        • Improved performance and accuracy of xss_clean(), including -reduction of false positives on image/file tests.
          • -
        • Improved Parser class to allow -multiple calls to the parse() function. The output of each is -appended in the output.
          • -
        • Added max_filename option to set a file name length limit in the -File Upload Class.
          • -
        • Added set_status_header() function to Output -class.
          • -
        • Modified Pagination class to only -output the “First” link when the link for page one would not be -shown.
          • -
        • Added support for mb_strlen in the Form -Validation class so that -multi-byte languages will calculate string lengths properly.
          • -
        -
        • -
      • Database
          -
        • Improved Active Record class to allow full path column and table -names: hostname.database.table.column. Also improved the alias -handling.
          • -
        • Improved how table and column names are escaped and prefixed. It -now honors full path names when adding prefixes and escaping.
          • -
        • Added Active Record caching feature to “update” and “delete” -functions.
          • -
        • Added removal of non-printing control characters in escape_str() -of DB drivers that do not have native PHP escaping mechanisms -(mssql, oci8, odbc), to avoid potential SQL errors, and possible -sources of SQL injection.
          • -
        • Added port support to MySQL, MySQLi, and MS SQL database drivers.
          • -
        • Added driver name variable in each DB driver, based on bug report -#4436.
          • -
        -
        • -
      • Helpers
          -
        • Added several new “setting” functions to the Form -helper that allow POST data to be -retrieved and set into forms. These are intended to be used on -their own, or with the new Form Validation -Class.
          • -
        • Added current_url() and uri_segments() to URL -helper.
          • -
        • Altered auto_link() in the URL -helper so that email addresses with -“+” included will be linked.
          • -
        • Added meta() function to HTML -helper.
          • -
        • Improved accuracy of calculations in Number -helper.
          • -
        • Removed added newlines (“\n”) from most form and html helper -functions.
          • -
        • Tightened up validation in the Date -helper function human_to_unix(), -and eliminated the POSIX regex.
          • -
        • Updated Date helper to match the -world’s current time zones and offsets.
          • -
        • Modified url_title() in the URL -helper to remove characters and digits -that are part of character entities, to allow dashes, underscores, -and periods regardless of the $separator, and to allow uppercase -characters.
          • -
        • Added support for arbitrary attributes in anchor_popup() of the -URL helper.
          • -
        -
        • -
      • Other Changes
          -
        • Added PHP Style Guide to docs.
          • -
        • Added sanitization in xss_clean() for a deprecated HTML tag that -could be abused in user input in Internet Explorer.
          • -
        • Added a few openxml document mime types, and an additional mobile -agent to mimes.php and user_agents.php respectively.
          • -
        • Added a file lock check during caching, before trying to write to -the file.
          • -
        • Modified Cookie key cleaning to unset a few troublesome key names -that can be present in certain environments, preventing CI from -halting execution.
          • -
        • Changed the output of the profiler to use style attribute rather -than clear, and added the id “codeigniter_profiler” to the -container div.
          • -
        -
        • -
      -
      -

      Bug fixes for 1.7.0

      -
        -
      • Fixed bug in xss_clean() that could remove some desirable tag -attributes.
        • -
      • Fixed assorted user guide typos or examples (#4807, #4812, #4840, -#4862, #4864, #4899, #4930, #5006, #5071, #5158, #5229, #5254, -#5351).
        • -
      • Fixed an edit from 1.6.3 that made the $robots array in -user_agents.php go poof.
        • -
      • Fixed a bug in the Email library with -quoted-printable encoding improperly encoding space and tab -characters.
        • -
      • Modified XSS sanitization to no longer add semicolons after &[single -letter], such as in M&M’s, B&B, etc.
        • -
      • Modified XSS sanitization to no longer strip XHTML image tags of -closing slashes.
        • -
      • Fixed a bug in the Session class when database sessions are used -where upon session update all userdata would be errantly written to -the session cookie.
        • -
      • Fixed a bug (#4536) in backups with the MySQL driver where some -legacy code was causing certain characters to be double escaped.
        • -
      • Fixed a routing bug (#4661) that occurred when the default route -pointed to a subfolder.
        • -
      • Fixed the spelling of “Dhaka” in the timezone_menu() function of the -Date helper.
        • -
      • Fixed the spelling of “raspberry” in config/smileys.php.
        • -
      • Fixed incorrect parenthesis in form_open() function (#5135).
        • -
      • Fixed a bug that was ignoring case when comparing controller methods -(#4560).
        • -
      • Fixed a bug (#4615) that was not setting SMTP authorization settings -when using the initialize function.
        • -
      • Fixed a bug in highlight_code() in the Text -helper that would leave a stray </span> -in certain cases.
        • -
      • Fixed Oracle bug (#3306) that was preventing multiple queries in one -action.
        • -
      • Fixed ODBC bug that was ignoring connection params due to its use of -a constructor.
        • -
      • Fixed a DB driver bug with num_rows() that would cause an error with -the Oracle driver.
        • -
      • Fixed MS SQL bug (#4915). Added brackets around database name in MS -SQL driver when selecting the database, in the event that reserved -characters are used in the name.
        • -
      • Fixed a DB caching bug (4718) in which the path was incorrect when no -URI segments were present.
        • -
      • Fixed Image_lib class bug #4562. A path was not defined for NetPBM.
        • -
      • Fixed Image_lib class bug #4532. When cropping an image with -identical height/width settings on output, a copy is made.
        • -
      • Fixed DB_driver bug (4900), in which a database error was not being -logged correctly.
        • -
      • Fixed DB backup bug in which field names were not being escaped.
        • -
      • Fixed a DB Active Record caching bug in which multiple calls to -cached data were not being honored.
        • -
      • Fixed a bug in the Session class that was disallowing slashes in the -serialized array.
        • -
      • Fixed a Form Validation bug in which the “isset” error message was -being trigged by the “required” rule.
        • -
      • Fixed a spelling error in a Loader error message.
        • -
      • Fixed a bug (5050) with IP validation with empty segments.
        • -
      • Fixed a bug in which the parser was being greedy if multiple -identical sets of tags were encountered.
        • -
      -
      -
      -
      -

      Version 1.6.3

      -

      Release Date: June 26, 2008 -Hg Tag: v1.6.3

      -

      Version 1.6.3 is a security and maintenance release and is recommended -for all users.

      -
        -
      • Database
          -
        • Modified MySQL/MySQLi Forge class to give explicit names to keys
          • -
        • Added ability to set multiple column non-primary keys to the -Forge class
          • -
        • Added ability to set additional database config values in DSN -connections via the query string.
          • -
        -
        • -
      • Libraries
          -
        • Set the mime type check in the Upload -class to reference the global -mimes variable.
          • -
        • Added support for query strings to the Pagination -class, automatically detected or -explicitly declared.
          • -
        • Added get_post() to the Input class.
          • -
        • Documented get() in the Input class.
          • -
        • Added the ability to automatically output language items as form -labels in the Language class.
          • -
        -
        • -
      • Helpers -
        • -
      • Other changes
          -
        • Improved security in xss_clean().
          • -
        • Removed an unused Router reference in _display_cache().
          • -
        • Added ability to use xss_clean() to test -images for XSS, useful for upload -security.
          • -
        • Considerably expanded list of mobile user-agents in -config/user_agents.php.
          • -
        • Charset information in the userguide has been moved above title -for internationalization purposes (#4614).
          • -
        • Added “Using Associative Arrays In a Request Parameter” example to -the XMLRPC userguide page.
          • -
        • Removed maxlength and size as automatically added attributes of -form_input() in the form helper.
          • -
        • Documented the language file use of byte_format() in the number -helper.
          • -
        -
        • -
      -
      -

      Bug fixes for 1.6.3

      -
        -
      • Added a language key for valid_emails in validation_lang.php.
        • -
      • Amended fixes for bug (#3419) with parsing DSN database connections.
        • -
      • Moved the _has_operator() function (#4535) into DB_driver from -DB_active_rec.
        • -
      • Fixed a syntax error in upload_lang.php.
        • -
      • Fixed a bug (#4542) with a regular expression in the Image library.
        • -
      • Fixed a bug (#4561) where orhaving() wasn’t properly passing values.
        • -
      • Removed some unused variables from the code (#4563).
        • -
      • Fixed a bug where having() was not adding an = into the statement -(#4568).
        • -
      • Fixed assorted user guide typos or examples (#4574, #4706).
        • -
      • Added quoted-printable headers to Email class when the multi-part -override is used.
        • -
      • Fixed a double opening <p> tag in the index pages of each system -directory.
        • -
      -
      -
      -
      -

      Version 1.6.2

      -

      Release Date: May 13, 2008 -Hg Tag: 1.6.2

      -
        -
      • Active Record
          -
        • Added the ability to prevent escaping in having() clauses.
          • -
        • Added rename_table() into DBForge.
          • -
        • Fixed a bug that wasn’t allowing escaping to be turned off if the -value of a query was NULL.
          • -
        • DB Forge is now assigned to any models that exist after loading -(#3457).
          • -
        -
        • -
      • Database
          -
        • Added Strict Mode to database -transactions.
          • -
        • Escape behaviour in where() clauses has changed; values in those -with the “FALSE” argument are no longer escaped (ie: quoted).
          • -
        -
        • -
      • Config
          -
        • Added ‘application/vnd.ms-powerpoint’ to list of mime types.
          • -
        • Added ‘audio/mpg’ to list of mime types.
          • -
        • Added new user-modifiable file constants.php containing file mode -and fopen constants.
          • -
        • Added the ability to set CRLF settings via config in the -Email class.
          • -
        -
        • -
      • Libraries
          -
        • Added increased security for filename handling in the Upload -library.
          • -
        • Added increased security for sessions for client-side data -tampering.
          • -
        • The MySQLi forge class is now in sync with MySQL forge.
          • -
        • Added the ability to set CRLF settings via config in the -Email class.
          • -
        • Unit Testing results are now -colour coded, and a change was made to the default template of -results.
          • -
        • Added a valid_emails rule to the Validation class.
          • -
        • The Zip class now exits within download().
          • -
        • The Zip class has undergone a substantial -re-write for speed and clarity (thanks stanleyxu for the hard work -and code contribution in bug report #3425!)
          • -
        -
        • -
      • Helpers
          -
        • Added a Compatibility -Helper for using some common -PHP 5 functions safely in applications that might run on PHP 4 -servers (thanks Seppo for the hard work and code contribution!)
          • -
        • Added form_button() in the Form -helper.
          • -
        • Changed the radio() and checkbox() functions to default to not -checked by default.
          • -
        • Added the ability to include an optional HTTP Response Code in the -redirect() function of the URL -Helper.
          • -
        • Modified img() in the HTML Helper to -remove an unneeded space (#4208).
          • -
        • Modified anchor() in the URL helper -to no longer add a default title= attribute (#4209).
          • -
        • The Download helper now exits -within force_download().
          • -
        • Added get_dir_file_info(), get_file_info(), and -get_mime_by_extension() to the File -Helper.
          • -
        • Added symbolic_permissions() and octal_permissions() to the -File helper.
          • -
        -
        • -
      • Plugins
          -
        • Modified captcha generation to first look for the function -imagecreatetruecolor, and fallback to imagecreate if it isn’t -available (#4226).
          • -
        -
        • -
      • Other Changes
          -
        • Added ability for xss_clean() to accept -arrays.
          • -
        • Removed closing PHP tags from all PHP files to avoid accidental -output and potential ‘cannot modify headers’ errors.
          • -
        • Removed “scripts” from the auto-load search path. Scripts were -deprecated in Version 1.4.1 (September 21, 2006). If you still -need to use them for legacy reasons, they must now be manually -loaded in each Controller.
          • -
        • Added a Reserved Names page to -the userguide, and migrated reserved controller names into it.
          • -
        • Added a Common Functions page -to the userguide for globally available functions.
          • -
        • Improved security and performance of xss_clean().
          • -
        -
        • -
      -
      -

      Bugfixes for 1.6.2

      -
        -
      • Fixed a bug where SET queries were not being handled as “write” -queries.
        • -
      • Fixed a bug (#3191) with ORIG_PATH_INFO URI parsing.
        • -
      • Fixed a bug in DB Forge, when inserting an id field (#3456).
        • -
      • Fixed a bug in the table library that could cause identically -constructed rows to be dropped (#3459).
        • -
      • Fixed DB Driver and MySQLi result driver checking for resources -instead of objects (#3461).
        • -
      • Fixed an AR_caching error where it wasn’t tracking table aliases -(#3463).
        • -
      • Fixed a bug in AR compiling, where select statements with arguments -got incorrectly escaped (#3478).
        • -
      • Fixed an incorrect documentation of $this->load->language (#3520).
        • -
      • Fixed bugs (#3523, #4350) in get_filenames() with recursion and -problems with Windows when $include_path is used.
        • -
      • Fixed a bug (#4153) in the XML-RPC class preventing dateTime.iso8601 -from being used.
        • -
      • Fixed an AR bug with or_where_not_in() (#4171).
        • -
      • Fixed a bug with xss_clean() that would -add semicolons to GET URI variable strings.
        • -
      • Fixed a bug (#4206) in the Directory Helper where the directory -resource was not being closed, and minor improvements.
        • -
      • Fixed a bug in the FTP library where delete_dir() was not working -recursively (#4215).
        • -
      • Fixed a Validation bug when set_rules() is used with a non-array -field name and rule (#4220).
        • -
      • Fixed a bug (#4223) where DB caching would not work for returned DB -objects or multiple DB connections.
        • -
      • Fixed a bug in the Upload library that might output the same error -twice (#4390).
        • -
      • Fixed an AR bug when joining with a table alias and table prefix -(#4400).
        • -
      • Fixed a bug in the DB class testing the $params argument.
        • -
      • Fixed a bug in the Table library where the integer 0 in cell data -would be displayed as a blank cell.
        • -
      • Fixed a bug in link_tag() of the URL -helper where a key was passed instead of -a value.
        • -
      • Fixed a bug in DB_result::row() that prevented it from returning -individual fields with MySQL NULL values.
        • -
      • Fixed a bug where SMTP emails were not having dot transformation -performed on lines that begin with a dot.
        • -
      • Fixed a bug in display_error() in the DB driver that was -instantiating new Language and Exception objects, and not using the -error heading.
        • -
      • Fixed a bug (#4413) where a URI containing slashes only e.g. -‘http&#58;//example.com/index.php?//’ would result in PHP errors
        • -
      • Fixed an array to string conversion error in the Validation library -(#4425)
        • -
      • Fixed bug (#4451, #4299, #4339) where failed transactions will not -rollback when debug mode is enabled.
        • -
      • Fixed a bug (#4506) with overlay_watermark() in the Image library -preventing support for PNG-24s with alpha transparency
        • -
      • Fixed assorted user guide typos (#3453, #4364, #4379, #4399, #4408, -#4412, #4448, #4488).
        • -
      -
      -
      -
      -

      Version 1.6.1

      -

      Release Date: February 12, 2008 -Hg Tag: 1.6.1

      -
        -
      • Active Record -
        • -
      • Database drivers
          -
        • Added support for setting client character set and collation for -MySQLi.
          • -
        -
        • -
      • Core Changes
          -
        • Modified xss_clean() to be more intelligent with its handling of -URL encoded strings.
          • -
        • Added $_SERVER, $_FILES, $_ENV, and $_SESSION to sanitization -of globals.
          • -
        • Added a Path Helper.
          • -
        • Simplified _reindex_segments() in the URI class.
          • -
        • Escaped the ‘-‘ in the default ‘permitted_uri_chars’ config -item, to prevent errors if developers just try to add additional -characters to the end of the default expression.
          • -
        • Modified method calling to controllers to show a 404 when a -private or protected method is accessed via a URL.
          • -
        • Modified framework initiated 404s to log the controller and method -for invalid requests.
          • -
        -
        • -
      • Helpers
          -
        • Modified get_filenames() in the File Helper to return FALSE if -the $source_dir is not readable.
          • -
        -
        • -
      -
      -

      Bugfixes for 1.6.1

      -
        -
      • Deprecated is_numeric as a validation rule. Use of numeric and -integer are preferred.
        • -
      • Fixed bug (#3379) in DBForge with SQLite for table creation.
        • -
      • Made Active Record fully database prefix aware (#3384).
        • -
      • Fixed a bug where DBForge was outputting invalid SQL in Postgres by -adding brackets around the tables in FROM.
        • -
      • Changed the behaviour of Active Record’s update() to make the WHERE -clause optional (#3395).
        • -
      • Fixed a bug (#3396) where certain POST variables would cause a PHP -warning.
        • -
      • Fixed a bug in query binding (#3402).
        • -
      • Changed order of SQL keywords in the Profiler $highlight array so OR -would not be highlighted before ORDER BY.
        • -
      • Fixed a bug (#3404) where the MySQLi driver was testing if -$this->conn_id was a resource instead of an object.
        • -
      • Fixed a bug (#3419) connecting to a database via a DSN string.
        • -
      • Fixed a bug (#3445) where the routed segment array was not re-indexed -to begin with 1 when the default controller is used.
        • -
      • Fixed assorted user guide typos.
        • -
      -
      -
      -
      -

      Version 1.6.0

      -

      Release Date: January 30, 2008

      -
        -
      • DBForge
          -
        • Added DBForge to the database tools.
          • -
        • Moved create_database() and drop_database() into -DBForge.
          • -
        • Added add_field(), add_key(), create_table(), drop_table(), -add_column(), drop_column(), modify_column() into -DBForge.
          • -
        -
        • -
      • Active Record
          -
        • Added protect_identifiers() in Active -Record.
          • -
        • All AR queries are backticked if appropriate to the database.
          • -
        • Added where_in(), or_where_in(), where_not_in(), -or_where_not_in(), not_like() and or_not_like() to Active -Record.
          • -
        • Added support for limit() into update() and delete() statements in -Active Record.
          • -
        • Added empty_table() and truncate_table() to Active -Record.
          • -
        • Added the ability to pass an array of tables to the delete() -statement in Active Record.
          • -
        • Added count_all_results() function to Active -Record.
          • -
        • Added select_max(), select_min(), select_avg() and -select_sum() to Active Record.
          • -
        • Added the ability to use aliases with joins in Active -Record.
          • -
        • Added a third parameter to Active Record’s like() clause to -control where the wildcard goes.
          • -
        • Added a third parameter to set() in Active -Record that withholds escaping -data.
          • -
        • Changed the behaviour of variables submitted to the where() clause -with no values to auto set “IS NULL”
          • -
        -
        • -
      • Other Database Related
          -
        • MySQL driver now requires MySQL 4.1+
          • -
        • Added $this->DB->save_queries variable to DB driver, enabling -queries to get saved or not. Previously they were always saved.
          • -
        • Added $this->db->dbprefix() to manually add database prefixes.
          • -
        • Added ‘random’ as an order_by() option , and removed “rand()” as -a listed option as it was MySQL only.
          • -
        • Added a check for NULL fields in the MySQL database backup -utility.
          • -
        • Added “constrain_by_prefix” parameter to db->list_table() -function. If set to TRUE it will limit the result to only table -names with the current prefix.
          • -
        • Deprecated from Active Record; getwhere() for get_where(); -groupby() for group_by(); havingor() for having_or(); orderby() -for order_by; orwhere() for or_where(); and orlike() for -or_like().
          • -
        • Modified csv_from_result() to output CSV data more in the spirit -of basic rules of RFC 4180.
          • -
        • Added ‘char_set’ and ‘dbcollat’ database configuration settings, -to explicitly set the client communication properly.
          • -
        • Removed ‘active_r’ configuration setting and replaced with a -global $active_record setting, which is more in harmony with the -global nature of the behavior (#1834).
          • -
        -
        • -
      • Core changes
          -
        • Added ability to load multiple views, whose content will be -appended to the output in the order loaded.
          • -
        • Added the ability to auto-load -Models.
          • -
        • Reorganized the URI and Routes classes for better clarity.
          • -
        • Added Compat.php to allow function overrides for older versions of -PHP or PHP environments missing certain extensions / libraries
          • -
        • Added memory usage, GET, URI string data, and individual query -execution time to Profiler output.
          • -
        • Deprecated Scaffolding.
          • -
        • Added is_really_writable() to Common.php to provide a -cross-platform reliable method of testing file/folder writability.
          • -
        -
        • -
      • Libraries
          -
        • Changed the load protocol of Models to allow for extension.
          • -
        • Strengthened the Encryption library to help protect against man in -the middle attacks when MCRYPT_MODE_CBC mode is used.
          • -
        • Added Flashdata variables, session_id regeneration and -configurable session update times to the Session -class.
          • -
        • Removed ‘last_visit’ from the Session class.
          • -
        • Added a language entry for valid_ip validation error.
          • -
        • Modified prep_for_form() in the Validation class to accept -arrays, adding support for POST array validation (via callbacks -only)
          • -
        • Added an “integer” rule into the Validation library.
          • -
        • Added valid_base64() to the Validation library.
          • -
        • Documented clear() in the Image -Processing library.
          • -
        • Changed the behaviour of custom callbacks so that they no longer -trigger the “required” rule.
          • -
        • Modified Upload class $_FILES error messages to be more precise.
          • -
        • Moved the safe mode and auth checks for the Email library into the -constructor.
          • -
        • Modified variable names in _ci_load() method of Loader class to -avoid conflicts with view variables.
          • -
        • Added a few additional mime type variations for CSV.
          • -
        • Enabled the ‘system’ methods for the XML-RPC Server library, -except for ‘system.multicall’ which is still disabled.
          • -
        -
        • -
      • Helpers & Plugins
          -
        • Added link_tag() to the HTML -helper.
          • -
        • Added img() to the HTML helper.
          • -
        • Added ability to “extend” Helpers.
          • -
        • Added an email helper into core -helpers.
          • -
        • Added strip_quotes() function to string -helper.
          • -
        • Added reduce_multiples() function to string -helper.
          • -
        • Added quotes_to_entities() function to string -helper.
          • -
        • Added form_fieldset(), form_fieldset_close(), form_label(), -and form_reset() function to form -helper.
          • -
        • Added support for external urls in form_open().
          • -
        • Removed support for db_backup in MySQLi due to incompatible -functions.
          • -
        • Javascript Calendar plugin now uses the months and days from the -calendar language file, instead of hard-coded values, -internationalizing it.
          • -
        -
        • -
      • Documentation Changes
          -
        • Added Writing Documentation section -for the community to use in writing their own documentation.
          • -
        • Added titles to all user manual pages.
          • -
        • Added attributes into <html> of userguide for valid html.
          • -
        • Added Zip Encoding Class -to the table of contents of the userguide.
          • -
        • Moved part of the userguide menu javascript to an external file.
          • -
        • Documented distinct() in Active -Record.
          • -
        • Documented the timezones() function in the Date -Helper.
          • -
        • Documented unset_userdata in the Session -class.
          • -
        • Documented 2 config options to the Database -configuration page.
          • -
        -
        • -
      -
      -

      Bug fixes for Version 1.6.0

      -
        -
      • Fixed a bug (#1813) preventing using $CI->db in the same application -with returned database objects.
        • -
      • Fixed a bug (#1842) where the $this->uri->rsegments array would not -include the ‘index’ method if routed to the controller without an -implicit method.
        • -
      • Fixed a bug (#1872) where word_limiter() was not retaining -whitespace.
        • -
      • Fixed a bug (#1890) in csv_from_result() where content that -included the delimiter would break the file.
        • -
      • Fixed a bug (#2542)in the clean_email() method of the Email class to -allow for non-numeric / non-sequential array keys.
        • -
      • Fixed a bug (#2545) in _html_entity_decode_callback() when -‘global_xss_filtering’ is enabled.
        • -
      • Fixed a bug (#2668) in the parser class -where numeric data was ignored.
        • -
      • Fixed a bug (#2679) where the “previous” pagination link would get -drawn on the first page.
        • -
      • Fixed a bug (#2702) in _object_to_array that broke some types of -inserts and updates.
        • -
      • Fixed a bug (#2732) in the SQLite driver for PHP 4.
        • -
      • Fixed a bug (#2754) in Pagination to scan for non-positive -num_links.
        • -
      • Fixed a bug (#2762) in the Session -library where user agent matching would -fail on user agents ending with a space.
        • -
      • Fixed a bug (#2784) $field_names[] vs $Ffield_names[] in postgres -and sqlite drivers.
        • -
      • Fixed a bug (#2810) in the typography helper causing extraneous -paragraph tags when string contains tags.
        • -
      • Fixed a bug (#2849) where arguments passed to a subfolder controller -method would be incorrectly shifted, dropping the 3rd segment value.
        • -
      • Fixed a bug (#2858) which referenced a wrong variable in the Image -class.
        • -
      • Fixed a bug (#2875)when loading plugin files as _plugin. and not -_pi.
        • -
      • Fixed a bug (#2912) in get_filenames() in the File -Helper where the array wasn’t cleared -after each call.
        • -
      • Fixed a bug (#2974) in highlight_phrase() that caused an error with -slashes.
        • -
      • Fixed a bug (#3003) in the Encryption Library to support modes other -than MCRYPT_MODE_ECB
        • -
      • Fixed a bug (#3015) in the User Agent -library where more than 2 languages -where not reported with languages().
        • -
      • Fixed a bug (#3017) in the Email library -where some timezones were calculated incorrectly.
        • -
      • Fixed a bug (#3024) in which master_dim wasn’t getting reset by -clear() in the Image library.
        • -
      • Fixed a bug (#3156) in Text Helper highlight_code() causing PHP tags -to be handled incorrectly.
        • -
      • Fixed a bug (#3166) that prevented num_rows from working in Oracle.
        • -
      • Fixed a bug (#3175) preventing certain libraries from working -properly when autoloaded in PHP 4.
        • -
      • Fixed a bug (#3267) in the Typography Helper where unordered list was -listed “un.
        • -
      • Fixed a bug (#3268) where the Router could leave ‘/’ as the path.
        • -
      • Fixed a bug (#3279) where the Email class was sending the wrong -Content-Transfer-Encoding for some character sets.
        • -
      • Fixed a bug (#3284) where the rsegment array would not be set -properly if the requested URI contained more segments than the routed -URI.
        • -
      • Removed extraneous load of $CFG in _display_cache() of the Output -class (#3285).
        • -
      • Removed an extraneous call to loading models (#3286).
        • -
      • Fixed a bug (#3310) with sanitization of globals in the Input class -that could unset CI’s global variables.
        • -
      • Fixed a bug (#3314) which would cause the top level path to be -deleted in delete_files() of the File helper.
        • -
      • Fixed a bug (#3328) where the smiley helper might return an undefined -variable.
        • -
      • Fixed a bug (#3330) in the FTP class where a comparison wasn’t -getting made.
        • -
      • Removed an unused parameter from Profiler (#3332).
        • -
      • Fixed a bug in database driver where num_rows property wasn’t -getting updated.
        • -
      • Fixed a bug in the upload -library when allowed_files -wasn’t defined.
        • -
      • Fixed a bug in word_wrap() of the Text Helper that incorrectly -referenced an object.
        • -
      • Fixed a bug in Validation where valid_ip() wasn’t called properly.
        • -
      • Fixed a bug in Validation where individual error messages for -checkboxes wasn’t supported.
        • -
      • Fixed a bug in captcha calling an invalid PHP function.
        • -
      • Fixed a bug in the cookie helper “set_cookie” function. It was not -honoring the config settings.
        • -
      • Fixed a bug that was making validation callbacks required even when -not set as such.
        • -
      • Fixed a bug in the XML-RPC library so if a type is specified, a more -intelligent decision is made as to the default type.
        • -
      • Fixed an example of comma-separated emails in the email library -documentation.
        • -
      • Fixed an example in the Calendar library for Showing Next/Previous -Month Links.
        • -
      • Fixed a typo in the database language file.
        • -
      • Fixed a typo in the image language file “suppor” to “support”.
        • -
      • Fixed an example for XML RPC.
        • -
      • Fixed an example of accept_charset() in the User Agent -Library.
        • -
      • Fixed a typo in the docblock comments that had CodeIgniter spelled -CodeIgnitor.
        • -
      • Fixed a typo in the String Helper -(uniquid changed to uniqid).
        • -
      • Fixed typos in the email Language class -(email_attachment_unredable, email_filed_smtp_login), and FTP -Class (ftp_unable_to_remame).
        • -
      • Added a stripslashes() into the Upload Library.
        • -
      • Fixed a series of grammatical and spelling errors in the language -files.
        • -
      • Fixed assorted user guide typos.
        • -
      -
      -
      -
      -

      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 Postgres 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 than 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 -extended.
        • -
      • 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 Postgres -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 application/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 Postgres 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 Postgres 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 discrete 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 -(Postgres, 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.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/contributing/index.html b/user_guide/contributing/index.html deleted file mode 100755 index e27f221..0000000 --- a/user_guide/contributing/index.html +++ /dev/null @@ -1,618 +0,0 @@ - - - - - - - - - - Contributing to CodeIgniter — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Contributing to CodeIgniter
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Contributing to CodeIgniter

      -
      - -
      -

      CodeIgniter is a community driven project and accepts contributions of code -and documentation from the community. These contributions are made in the form -of Issues or Pull Requests -on the CodeIgniter repository on GitHub.

      -

      Issues are a quick way to point out a bug. If you find a bug or documentation -error in CodeIgniter then please check a few things first:

      -
        -
      • There is not already an open Issue
        • -
      • The issue has already been fixed (check the develop branch, or look for -closed Issues)
        • -
      • Is it something really obvious that you fix it yourself?
        • -
      -

      Reporting issues is helpful but an even better approach is to send a Pull -Request, which is done by “Forking” the main repository and committing to your -own copy. This will require you to use the version control system called Git.

      -
      -

      Support

      -

      Please note that GitHub is not for general support questions! If you are -having trouble using a feature of CodeIgniter, ask for help on our -forums instead.

      -

      If you are not sure whether you are using something correctly or if you -have found a bug, again - please ask on the forums first.

      -
      -
      -

      Security

      -

      Did you find a security issue in CodeIgniter?

      -

      Please don’t disclose it publicly, but e-mail us at security@codeigniter.com, -or report it via our page on HackerOne.

      -

      If you’ve found a critical vulnerability, we’d be happy to credit you in our -ChangeLog <../changelog>.

      -
      -
      -

      Tips for a Good Issue Report

      -

      Use a descriptive subject line (eg parser library chokes on commas) rather than a vague one (eg. your code broke).

      -

      Address a single issue in a report.

      -

      Identify the CodeIgniter version (eg 3.0-develop) and the component if you know it (eg. parser library)

      -

      Explain what you expected to happen, and what did happen. -Include error messages and stacktrace, if any.

      -

      Include short code segments if they help to explain. -Use a pastebin or dropbox facility to include longer segments of code or screenshots - do not include them in the issue report itself. -This means setting a reasonable expiry for those, until the issue is resolved or closed.

      -

      If you know how to fix the issue, you can do so in your own fork & branch, and submit a pull request. -The issue report information above should be part of that.

      -

      If your issue report can describe the steps to reproduce the problem, that is great. -If you can include a unit test that reproduces the problem, that is even better, as it gives whoever is fixing -it a clearer target!

      -
      -
      -

      Guidelines

      -

      Before we look into how, here are the guidelines. If your Pull Requests fail -to pass these guidelines it will be declined and you will need to re-submit -when you’ve made the changes. This might sound a bit tough, but it is required -for us to maintain quality of the code-base.

      -
      -

      PHP Style

      -

      All code must meet the Style Guide, which is -essentially the Allman indent style, underscores and -readable operators. This makes certain that all code is the same format as the -existing code and means it will be as readable as possible.

      -
      -
      -

      Documentation

      -

      If you change anything that requires a change to documentation then you will -need to add it. New classes, methods, parameters, changing default values, etc -are all things that will require a change to documentation. The change-log -must also be updated for every change. Also PHPDoc blocks must be maintained.

      -
      -
      -

      Compatibility

      -

      CodeIgniter recommends PHP 5.4 or newer to be used, but it should be -compatible with PHP 5.2.4 so all code supplied must stick to this -requirement. If PHP 5.3 (and above) functions or features are used then -there must be a fallback for PHP 5.2.4.

      -
      -
      -

      Branching

      -

      CodeIgniter uses the Git-Flow branching model -which requires all pull requests to be sent to the “develop” branch. This is -where the next planned version will be developed. The “master” branch will -always contain the latest stable version and is kept clean so a “hotfix” (e.g: -an emergency security patch) can be applied to master to create a new version, -without worrying about other features holding it up. For this reason all -commits need to be made to “develop” and any sent to “master” will be closed -automatically. If you have multiple changes to submit, please place all -changes into their own branch on your fork.

      -

      One thing at a time: A pull request should only contain one change. That does -not mean only one commit, but one change - however many commits it took. The -reason for this is that if you change X and Y but send a pull request for both -at the same time, we might really want X but disagree with Y, meaning we -cannot merge the request. Using the Git-Flow branching model you can create -new branches for both of these features and send two requests.

      -
      -
      -

      Signing

      -

      You must sign your work, certifying that you either wrote the work or -otherwise have the right to pass it on to an open source project. git makes -this trivial as you merely have to use –signoff on your commits to your -CodeIgniter fork.

      -
      git commit --signoff
-
      -
      -

      or simply

      -
      git commit -s
-
      -
      -

      This will sign your commits with the information setup in your git config, e.g.

      -
      -
      Signed-off-by: John Q Public <john.public@example.com>
      -

      If you are using Tower there is a “Sign-Off” checkbox in the commit window. You -could even alias git commit to use the -s flag so you don’t have to think about -it.

      -

      By signing your work in this manner, you certify to a “Developer’s Certificate -or Origin”. The current version of this certificate is in the Developer’s Certificate of Origin 1.1 file -in the root of this documentation.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/caching.html b/user_guide/database/caching.html deleted file mode 100755 index 3d507ec..0000000 --- a/user_guide/database/caching.html +++ /dev/null @@ -1,643 +0,0 @@ - - - - - - - - - - Database Caching Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Database Caching Class

      -

      The Database Caching Class permits you to cache your queries as text -files for reduced database load.

      -
      -

      Important

      -

      This class is initialized automatically by the database -driver when caching is enabled. Do NOT load this class manually.

      -
      -
      -

      Important

      -

      Not all query result functions are available when you -use caching. Please read this page carefully.

      -
      -
      -

      Enabling Caching

      -

      Caching is enabled in three steps:

      -
        -
      • Create a writable directory on your server where the cache files can -be stored.
        • -
      • Set the path to your cache folder in your -application/config/database.php file.
        • -
      • Enable the caching feature, either globally by setting the preference -in your application/config/database.php file, or manually as -described below.
        • -
      -

      Once enabled, caching will happen automatically whenever a page is -loaded that contains database queries.

      -
      -
      -

      How Does Caching Work?

      -

      CodeIgniter’s query caching system happens dynamically when your pages -are viewed. When caching is enabled, the first time a web page is -loaded, the query result object will be serialized and stored in a text -file on your server. The next time the page is loaded the cache file -will be used instead of accessing your database. Your database usage can -effectively be reduced to zero for any pages that have been cached.

      -

      Only read-type (SELECT) queries can be cached, since these are the only -type of queries that produce a result. Write-type (INSERT, UPDATE, etc.) -queries, since they don’t generate a result, will not be cached by the -system.

      -

      Cache files DO NOT expire. Any queries that have been cached will remain -cached until you delete them. The caching system permits you clear -caches associated with individual pages, or you can delete the entire -collection of cache files. Typically you’ll want to use the housekeeping -functions described below to delete cache files after certain events -take place, like when you’ve added new information to your database.

      -
      -
      -

      Will Caching Improve Your Site’s Performance?

      -

      Getting a performance gain as a result of caching depends on many -factors. If you have a highly optimized database under very little load, -you probably won’t see a performance boost. If your database is under -heavy use you probably will see an improved response, assuming your -file-system is not overly taxed. Remember that caching simply changes -how your information is retrieved, shifting it from being a database -operation to a file-system one.

      -

      In some clustered server environments, for example, caching may be -detrimental since file-system operations are so intense. On single -servers in shared environments, caching will probably be beneficial. -Unfortunately there is no single answer to the question of whether you -should cache your database. It really depends on your situation.

      -
      -
      -

      How are Cache Files Stored?

      -

      CodeIgniter places the result of EACH query into its own cache file. -Sets of cache files are further organized into sub-folders corresponding -to your controller functions. To be precise, the sub-folders are named -identically to the first two segments of your URI (the controller class -name and function name).

      -

      For example, let’s say you have a controller called blog with a function -called comments that contains three queries. The caching system will -create a cache folder called blog+comments, into which it will write -three cache files.

      -

      If you use dynamic queries that change based on information in your URI -(when using pagination, for example), each instance of the query will -produce its own cache file. It’s possible, therefore, to end up with -many times more cache files than you have queries.

      -
      -
      -

      Managing your Cache Files

      -

      Since cache files do not expire, you’ll need to build deletion routines -into your application. For example, let’s say you have a blog that -allows user commenting. Whenever a new comment is submitted you’ll want -to delete the cache files associated with the controller function that -serves up your comments. You’ll find two delete functions described -below that help you clear data.

      -
      -
      -

      Not All Database Functions Work with Caching

      -

      Lastly, we need to point out that the result object that is cached is a -simplified version of the full result object. For that reason, some of -the query result functions are not available for use.

      -

      The following functions ARE NOT available when using a cached result -object:

      -
        -
      • num_fields()
        • -
      • field_names()
        • -
      • field_data()
        • -
      • free_result()
        • -
      -

      Also, the two database resources (result_id and conn_id) are not -available when caching, since result resources only pertain to run-time -operations.

      -
      -

      Function Reference

      -
      -
      -
      -

      $this->db->cache_on() / $this->db->cache_off()

      -

      Manually enables/disables caching. This can be useful if you want to -keep certain queries from being cached. Example:

      -
      // Turn caching on
-$this->db->cache_on();
-$query = $this->db->query("SELECT * FROM mytable");
-
-// Turn caching off for this one query
-$this->db->cache_off();
-$query = $this->db->query("SELECT * FROM members WHERE member_id = '$current_user'");
-
-// Turn caching back on
-$this->db->cache_on();
-$query = $this->db->query("SELECT * FROM another_table");
-
      -
      -
      -
      -

      $this->db->cache_delete()

      -

      Deletes the cache files associated with a particular page. This is -useful if you need to clear caching after you update your database.

      -

      The caching system saves your cache files to folders that correspond to -the URI of the page you are viewing. For example, if you are viewing a -page at example.com/index.php/blog/comments, the caching system will put -all cache files associated with it in a folder called blog+comments. To -delete those particular cache files you will use:

      -
      $this->db->cache_delete('blog', 'comments');
-
      -
      -

      If you do not use any parameters the current URI will be used when -determining what should be cleared.

      -
      -
      -

      $this->db->cache_delete_all()

      -

      Clears all existing cache files. Example:

      -
      $this->db->cache_delete_all();
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/call_function.html b/user_guide/database/call_function.html deleted file mode 100755 index 22bc41c..0000000 --- a/user_guide/database/call_function.html +++ /dev/null @@ -1,530 +0,0 @@ - - - - - - - - - - Custom Function Calls — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Custom Function Calls

      -
      -

      $this->db->call_function();

      -

      This function enables you to call PHP database functions that are not -natively included in CodeIgniter, in a platform independent manner. For -example, let’s say you want to call the mysql_get_client_info() -function, which is not natively supported by CodeIgniter. You could -do so like this:

      -
      $this->db->call_function('get_client_info');
-
      -
      -

      You must supply the name of the function, without the mysql_ -prefix, in the first parameter. The prefix is added automatically based -on which database driver is currently being used. This permits you to -run the same function on different database platforms. Obviously not all -function calls are identical between platforms, so there are limits to -how useful this function can be in terms of portability.

      -

      Any parameters needed by the function you are calling will be added to -the second parameter.

      -
      $this->db->call_function('some_function', $param1, $param2, etc..);
-
      -
      -

      Often, you will either need to supply a database connection ID or a -database result ID. The connection ID can be accessed using:

      -
      $this->db->conn_id;
-
      -
      -

      The result ID can be accessed from within your result object, like this:

      -
      $query = $this->db->query("SOME QUERY");
-
-$query->result_id;
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/configuration.html b/user_guide/database/configuration.html deleted file mode 100755 index b2d3b44..0000000 --- a/user_guide/database/configuration.html +++ /dev/null @@ -1,759 +0,0 @@ - - - - - - - - - - Database Configuration — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Database Configuration

      -

      CodeIgniter has a config file that lets you store your database -connection values (username, password, database name, etc.). The config -file is located at application/config/database.php. You can also set -database connection values for specific -environments by placing database.php -it the respective environment config folder.

      -

      The config settings are stored in a multi-dimensional array with this -prototype:

      -
      $db['default'] = array(
-        'dsn'   => '',
-        'hostname' => 'localhost',
-        'username' => 'root',
-        'password' => '',
-        'database' => 'database_name',
-        'dbdriver' => 'mysqli',
-        'dbprefix' => '',
-        'pconnect' => TRUE,
-        'db_debug' => TRUE,
-        'cache_on' => FALSE,
-        'cachedir' => '',
-        'char_set' => 'utf8',
-        'dbcollat' => 'utf8_general_ci',
-        'swap_pre' => '',
-        'encrypt' => FALSE,
-        'compress' => FALSE,
-        'stricton' => FALSE,
-        'failover' => array()
-);
-
      -
      -

      Some database drivers (such as PDO, PostgreSQL, Oracle, ODBC) might -require a full DSN string to be provided. If that is the case, you -should use the ‘dsn’ configuration setting, as if you’re using the -driver’s underlying native PHP extension, like this:

      -
      // PDO
-$db['default']['dsn'] = 'pgsql:host=localhost;port=5432;dbname=database_name';
-
-// Oracle
-$db['default']['dsn'] = '//localhost/XE';
-
      -
      -
      -

      Note

      -

      If you do not specify a DSN string for a driver that requires it, CodeIgniter -will try to build it with the rest of the provided settings.

      -
      -
      -

      Note

      -

      If you provide a DSN string and it is missing some valid settings (e.g. the -database character set), which are present in the rest of the configuration -fields, CodeIgniter will append them.

      -
      -

      You can also specify failovers for the situation when the main connection cannot connect for some reason. -These failovers can be specified by setting the failover for a connection like this:

      -
      $db['default']['failover'] = array(
-                array(
-                        'hostname' => 'localhost1',
-                        'username' => '',
-                        'password' => '',
-                        'database' => '',
-                        'dbdriver' => 'mysqli',
-                        'dbprefix' => '',
-                        'pconnect' => TRUE,
-                        'db_debug' => TRUE,
-                        'cache_on' => FALSE,
-                        'cachedir' => '',
-                        'char_set' => 'utf8',
-                        'dbcollat' => 'utf8_general_ci',
-                        'swap_pre' => '',
-                        'encrypt' => FALSE,
-                        'compress' => FALSE,
-                        'stricton' => FALSE
-                ),
-                array(
-                        'hostname' => 'localhost2',
-                        'username' => '',
-                        'password' => '',
-                        'database' => '',
-                        'dbdriver' => 'mysqli',
-                        'dbprefix' => '',
-                        'pconnect' => TRUE,
-                        'db_debug' => TRUE,
-                        'cache_on' => FALSE,
-                        'cachedir' => '',
-                        'char_set' => 'utf8',
-                        'dbcollat' => 'utf8_general_ci',
-                        'swap_pre' => '',
-                        'encrypt' => FALSE,
-                        'compress' => FALSE,
-                        'stricton' => FALSE
-                )
-        );
-
      -
      -

      You can specify as many failovers as you like.

      -

      The reason we use a multi-dimensional array rather than a more simple -one is to permit you to optionally store multiple sets of connection -values. If, for example, you run multiple environments (development, -production, test, etc.) under a single installation, you can set up a -connection group for each, then switch between groups as needed. For -example, to set up a “test” environment you would do this:

      -
      $db['test'] = array(
-        'dsn'   => '',
-        'hostname' => 'localhost',
-        'username' => 'root',
-        'password' => '',
-        'database' => 'database_name',
-        'dbdriver' => 'mysqli',
-        'dbprefix' => '',
-        'pconnect' => TRUE,
-        'db_debug' => TRUE,
-        'cache_on' => FALSE,
-        'cachedir' => '',
-        'char_set' => 'utf8',
-        'dbcollat' => 'utf8_general_ci',
-        'swap_pre' => '',
-        'compress' => FALSE,
-        'encrypt' => FALSE,
-        'stricton' => FALSE,
-        'failover' => array()
-);
-
      -
      -

      Then, to globally tell the system to use that group you would set this -variable located in the config file:

      -
      $active_group = 'test';
-
      -
      -
      -

      Note

      -

      The name ‘test’ is arbitrary. It can be anything you want. By -default we’ve used the word “default” for the primary connection, -but it too can be renamed to something more relevant to your project.

      -
      -
      -

      Query Builder

      -

      The Query Builder Class is globally enabled or -disabled by setting the $query_builder variable in the database -configuration file to TRUE/FALSE (boolean). The default setting is TRUE. -If you are not using the -query builder class, setting it to FALSE will utilize fewer resources -when the database classes are initialized.

      -
      $query_builder = TRUE;
-
      -
      -
      -

      Note

      -

      that some CodeIgniter classes such as Sessions require Query -Builder to be enabled to access certain functionality.

      -
      -
      -
      -

      Explanation of Values:

      -
      ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Name ConfigDescription
      dsnThe DSN connect string (an all-in-one configuration sequence).
      hostnameThe hostname of your database server. Often this is ‘localhost’.
      usernameThe username used to connect to the database.
      passwordThe password used to connect to the database.
      databaseThe name of the database you want to connect to.
      dbdriverThe database type. ie: mysqli, postgre, odbc, etc. Must be specified in lower case.
      dbprefixAn optional table prefix which will added to the table name when running -Query Builder queries. This permits multiple CodeIgniter -installations to share one database.
      pconnectTRUE/FALSE (boolean) - Whether to use a persistent connection.
      db_debugTRUE/FALSE (boolean) - Whether database errors should be displayed.
      cache_onTRUE/FALSE (boolean) - Whether database query caching is enabled, -see also Database Caching Class.
      cachedirThe absolute server path to your database query cache directory.
      char_setThe character set used in communicating with the database.
      dbcollat

      The character collation used in communicating with the database

      -
      -

      Note

      -

      Only used in the ‘mysql’ and ‘mysqli’ drivers.

      -
      -
      swap_preA default table prefix that should be swapped with dbprefix. This is useful for distributed -applications where you might run manually written queries, and need the prefix to still be -customizable by the end user.
      schemaThe database schema, defaults to ‘public’. Used by PostgreSQL and ODBC drivers.
      encrypt

      Whether or not to use an encrypted connection.

      -
      -
        -
      • ‘mysql’ (deprecated), ‘sqlsrv’ and ‘pdo/sqlsrv’ drivers accept TRUE/FALSE
        • -
      • ‘mysqli’ and ‘pdo/mysql’ drivers accept an array with the following options:
          -
        • ‘ssl_key’ - Path to the private key file
          • -
        • ‘ssl_cert’ - Path to the public key certificate file
          • -
        • ‘ssl_ca’ - Path to the certificate authority file
          • -
        • ‘ssl_capath’ - Path to a directory containing trusted CA certificats in PEM format
          • -
        • ‘ssl_cipher’ - List of allowed ciphers to be used for the encryption, separated by colons (‘:’)
          • -
        • ‘ssl_verify’ - TRUE/FALSE; Whether to verify the server certificate or not (‘mysqli’ only)
          • -
        -
        • -
      -
      -
      compressWhether or not to use client compression (MySQL only).
      strictonTRUE/FALSE (boolean) - Whether to force “Strict Mode” connections, good for ensuring strict SQL -while developing an application.
      port

      The database port number. To use this value you have to add a line to the database config array.

      -
      $db['default']['port'] = 5432;
-
      -
      -
      -
      -

      Note

      -

      Depending on what database platform you are using (MySQL, PostgreSQL, -etc.) not all values will be needed. For example, when using SQLite you -will not need to supply a username or password, and the database name -will be the path to your database file. The information above assumes -you are using MySQL.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/connecting.html b/user_guide/database/connecting.html deleted file mode 100755 index 981c604..0000000 --- a/user_guide/database/connecting.html +++ /dev/null @@ -1,642 +0,0 @@ - - - - - - - - - - Connecting to your Database — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Connecting to your Database

      -

      There are two ways to connect to a database:

      -
      -

      Automatically Connecting

      -

      The “auto connect” feature will load and instantiate the database class -with every page load. To enable “auto connecting”, add the word database -to the library array, as indicated in the following file:

      -

      application/config/autoload.php

      -
      -
      -

      Manually Connecting

      -

      If only some of your pages require database connectivity you can -manually connect to your database by adding this line of code in any -function where it is needed, or in your class constructor to make the -database available globally in that class.

      -
      $this->load->database();
-
      -
      -

      If the above function does not contain any information in the first -parameter it will connect to the group specified in your database config -file. For most people, this is the preferred method of use.

      -
      -

      Available Parameters

      -
        -
      1. The database connection values, passed either as an array or a DSN -string.
        2. -
      2. TRUE/FALSE (boolean). Whether to return the connection ID (see -Connecting to Multiple Databases below).
        3. -
      3. TRUE/FALSE (boolean). Whether to enable the Query Builder class. Set -to TRUE by default.
        4. -
      -
      -
      -

      Manually Connecting to a Database

      -

      The first parameter of this function can optionally be used to -specify a particular database group from your config file, or you can -even submit connection values for a database that is not specified in -your config file. Examples:

      -

      To choose a specific group from your config file you can do this:

      -
      $this->load->database('group_name');
-
      -
      -

      Where group_name is the name of the connection group from your config -file.

      -

      To connect manually to a desired database you can pass an array of -values:

      -
      $config['hostname'] = 'localhost';
-$config['username'] = 'myusername';
-$config['password'] = 'mypassword';
-$config['database'] = 'mydatabase';
-$config['dbdriver'] = 'mysqli';
-$config['dbprefix'] = '';
-$config['pconnect'] = FALSE;
-$config['db_debug'] = TRUE;
-$config['cache_on'] = FALSE;
-$config['cachedir'] = '';
-$config['char_set'] = 'utf8';
-$config['dbcollat'] = 'utf8_general_ci';
-$this->load->database($config);
-
      -
      -

      For information on each of these values please see the configuration -page.

      -
      -

      Note

      -

      For the PDO driver, you should use the $config[‘dsn’] setting -instead of ‘hostname’ and ‘database’:

      -
      -

      -
      $config[‘dsn’] = ‘mysql:host=localhost;dbname=mydatabase’;
      -
      -
      -

      Or you can submit your database values as a Data Source Name. DSNs must -have this prototype:

      -
      $dsn = 'dbdriver://username:password@hostname/database';
-$this->load->database($dsn);
-
      -
      -

      To override default config values when connecting with a DSN string, add -the config variables as a query string.

      -
      $dsn = 'dbdriver://username:password@hostname/database?char_set=utf8&dbcollat=utf8_general_ci&cache_on=true&cachedir=/path/to/cache';
-$this->load->database($dsn);
-
      -
      -
      -
      -
      -

      Connecting to Multiple Databases

      -

      If you need to connect to more than one database simultaneously you can -do so as follows:

      -
      $DB1 = $this->load->database('group_one', TRUE);
-$DB2 = $this->load->database('group_two', TRUE);
-
      -
      -

      Note: Change the words “group_one” and “group_two” to the specific -group names you are connecting to (or you can pass the connection values -as indicated above).

      -

      By setting the second parameter to TRUE (boolean) the function will -return the database object.

      -
      -

      Note

      -

      When you connect this way, you will use your object name to issue -commands rather than the syntax used throughout this guide. In other -words, rather than issuing commands with:

      -
      -

      -
      $this->db->query();
      -
      $this->db->result();
      -
      etc...
      -

      -
      You will instead use:
      -

      -
      $DB1->query();
      -
      $DB1->result();
      -
      etc...
      -
      -
      -
      -

      Note

      -

      You don’t need to create separate database configurations if you -only need to use a different database on the same connection. You -can switch to a different database when you need to, like this:

      -
      -
      $this->db->db_select($database2_name);
      -
      -
      -
      -
      -

      Reconnecting / Keeping the Connection Alive

      -

      If the database server’s idle timeout is exceeded while you’re doing -some heavy PHP lifting (processing an image, for instance), you should -consider pinging the server by using the reconnect() method before -sending further queries, which can gracefully keep the connection alive -or re-establish it.

      -
      $this->db->reconnect();
-
      -
      -
      -
      -

      Manually closing the Connection

      -

      While CodeIgniter intelligently takes care of closing your database -connections, you can explicitly close the connection.

      -
      $this->db->close();
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/db_driver_reference.html b/user_guide/database/db_driver_reference.html deleted file mode 100755 index 0034309..0000000 --- a/user_guide/database/db_driver_reference.html +++ /dev/null @@ -1,1458 +0,0 @@ - - - - - - - - - - DB Driver Reference — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      DB Driver Reference

      -

      This is the platform-independent base DB implementation class. -This class will not be called directly. Rather, the adapter -class for the specific database will extend and instantiate it.

      -

      The how-to material for this has been split over several articles. -This article is intended to be a reference for them.

      -
      -

      Important

      -

      Not all methods are supported by all database drivers, -some of them may fail (and return FALSE) if the underlying -driver does not support them.

      -
      -
      -
      -class CI_DB_driver
      -
      -
      -initialize()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      Initialize database settings, establish a connection to -the database.

      -
      - -
      -
      -db_connect($persistent = TRUE)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $persistent (bool) – Whether to establish a persistent connection or a regular one
        • -
      -
      Returns:

      Database connection resource/object or FALSE on failure

      -
      Return type:

      mixed

      -
      -

      Establish a connection with the database.

      -
      -

      Note

      -

      The returned value depends on the underlying -driver in use. For example, a mysqli instance -will be returned with the ‘mysqli’ driver.

      -
      -
      - -
      -
      -db_pconnect()
      -
      --- - - - - - -
      Returns:Database connection resource/object or FALSE on failure
      Return type:mixed
      -

      Establish a persistent connection with the database.

      -
      -

      Note

      -

      This method is just an alias for db_connect(TRUE).

      -
      -
      - -
      -
      -reconnect()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      Keep / reestablish the database connection if no queries -have been sent for a length of time exceeding the -server’s idle timeout.

      -
      - -
      -
      -db_select([$database = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $database (string) – Database name
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Select / switch the current database.

      -
      - -
      -
      -db_set_charset($charset)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $charset (string) – Character set name
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Set client character set.

      -
      - -
      -
      -platform()
      -
      --- - - - - - -
      Returns:Platform name
      Return type:string
      -

      The name of the platform in use (mysql, mssql, etc...).

      -
      - -
      -
      -version()
      -
      --- - - - - - -
      Returns:The version of the database being used
      Return type:string
      -

      Database version number.

      -
      - -
      -
      -query($sql[, $binds = FALSE[, $return_object = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $sql (string) – The SQL statement to execute
        • -
      • $binds (array) – An array of binding data
        • -
      • $return_object (bool) – Whether to return a result object or not
        • -
      -
      Returns:

      TRUE for successful “write-type” queries, CI_DB_result instance (method chaining) on “query” success, FALSE on failure

      -
      Return type:

      mixed

      -
      -

      Execute an SQL query.

      -

      Accepts an SQL string as input and returns a result object -upon successful execution of a “read” type query.

      -

      Returns:

      -
      -
        -
      • Boolean TRUE upon successful execution of a “write type” queries
        • -
      • Boolean FALSE upon failure
        • -
      • CI_DB_result object for “read type” queries
        • -
      -
      -
      - -
      -
      -simple_query($sql)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $sql (string) – The SQL statement to execute
        • -
      -
      Returns:

      Whatever the underlying driver’s “query” function returns

      -
      Return type:

      mixed

      -
      -

      A simplified version of the query() method, appropriate -for use when you don’t need to get a result object or to -just send a query to the database and not care for the result.

      -
      - -
      -
      -trans_strict([$mode = TRUE])
      -
      --- - - - - - -
      Parameters:
        -
      • $mode (bool) – Strict mode flag
        • -
      -
      Return type:

      void

      -
      -

      Enable/disable transaction “strict” mode.

      -

      When strict mode is enabled, if you are running multiple -groups of transactions and one group fails, all subsequent -groups will be rolled back.

      -

      If strict mode is disabled, each group is treated -autonomously, meaning a failure of one group will not -affect any others.

      -
      - -
      -
      -trans_off()
      -
      --- - - - -
      Return type:void
      -

      Disables transactions at run-time.

      -
      - -
      -
      -trans_start([$test_mode = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $test_mode (bool) – Test mode flag
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Start a transaction.

      -
      - -
      -
      -trans_complete()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      Complete Transaction.

      -
      - -
      -
      -trans_status()
      -
      --- - - - - - -
      Returns:TRUE if the transaction succeeded, FALSE if it failed
      Return type:bool
      -

      Lets you retrieve the transaction status flag to -determine if it has failed.

      -
      - -
      -
      -compile_binds($sql, $binds)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $sql (string) – The SQL statement
        • -
      • $binds (array) – An array of binding data
        • -
      -
      Returns:

      The updated SQL statement

      -
      Return type:

      string

      -
      -

      Compiles an SQL query with the bind values passed for it.

      -
      - -
      -
      -is_write_type($sql)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $sql (string) – The SQL statement
        • -
      -
      Returns:

      TRUE if the SQL statement is of “write type”, FALSE if not

      -
      Return type:

      bool

      -
      -

      Determines if a query is of a “write” type (such as -INSERT, UPDATE, DELETE) or “read” type (i.e. SELECT).

      -
      - -
      -
      -elapsed_time([$decimals = 6])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $decimals (int) – The number of decimal places
        • -
      -
      Returns:

      The aggregate query elapsed time, in microseconds

      -
      Return type:

      string

      -
      -

      Calculate the aggregate query elapsed time.

      -
      - -
      -
      -total_queries()
      -
      --- - - - - - -
      Returns:The total number of queries executed
      Return type:int
      -

      Returns the total number of queries that have been -executed so far.

      -
      - -
      -
      -last_query()
      -
      --- - - - - - -
      Returns:The last query executed
      Return type:string
      -

      Returns the last query that was executed.

      -
      - -
      -
      -escape($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (mixed) – The value to escape, or an array of multiple ones
        • -
      -
      Returns:

      The escaped value(s)

      -
      Return type:

      mixed

      -
      -

      Escapes input data based on type, including boolean and -NULLs.

      -
      - -
      -
      -escape_str($str[, $like = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (mixed) – A string value or array of multiple ones
        • -
      • $like (bool) – Whether or not the string will be used in a LIKE condition
        • -
      -
      Returns:

      The escaped string(s)

      -
      Return type:

      mixed

      -
      -

      Escapes string values.

      -
      -

      Warning

      -

      The returned strings do NOT include quotes -around them.

      -
      -
      - -
      -
      -escape_like_str($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (mixed) – A string value or array of multiple ones
        • -
      -
      Returns:

      The escaped string(s)

      -
      Return type:

      mixed

      -
      -

      Escape LIKE strings.

      -

      Similar to escape_str(), but will also escape the % -and _ wildcard characters, so that they don’t cause -false-positives in LIKE conditions.

      -
      - -
      -
      -primary($table)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      -
      Returns:

      The primary key name, FALSE if none

      -
      Return type:

      string

      -
      -

      Retrieves the primary key of a table.

      -
      -

      Note

      -

      If the database platform does not support primary -key detection, the first column name may be assumed -as the primary key.

      -
      -
      - -
      -
      -count_all([$table = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      -
      Returns:

      Row count for the specified table

      -
      Return type:

      int

      -
      -

      Returns the total number of rows in a table, or 0 if no -table was provided.

      -
      - -
      -
      -list_tables([$constrain_by_prefix = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $constrain_by_prefix (bool) – TRUE to match table names by the configured dbprefix
        • -
      -
      Returns:

      Array of table names or FALSE on failure

      -
      Return type:

      array

      -
      -

      Gets a list of the tables in the current database.

      -
      - -
      -
      -table_exists($table_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table_name (string) – The table name
        • -
      -
      Returns:

      TRUE if that table exists, FALSE if not

      -
      Return type:

      bool

      -
      -

      Determine if a particular table exists.

      -
      - -
      -
      -list_fields($table)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – The table name
        • -
      -
      Returns:

      Array of field names or FALSE on failure

      -
      Return type:

      array

      -
      -

      Gets a list of the field names in a table.

      -
      - -
      -
      -field_exists($field_name, $table_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table_name (string) – The table name
        • -
      • $field_name (string) – The field name
        • -
      -
      Returns:

      TRUE if that field exists in that table, FALSE if not

      -
      Return type:

      bool

      -
      -

      Determine if a particular field exists.

      -
      - -
      -
      -field_data($table)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – The table name
        • -
      -
      Returns:

      Array of field data items or FALSE on failure

      -
      Return type:

      array

      -
      -

      Gets a list containing field data about a table.

      -
      - -
      -
      -escape_identifiers($item)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $item (mixed) – The item or array of items to escape
        • -
      -
      Returns:

      The input item(s), escaped

      -
      Return type:

      mixed

      -
      -

      Escape SQL identifiers, such as column, table and names.

      -
      - -
      -
      -insert_string($table, $data)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – The target table
        • -
      • $data (array) – An associative array of key/value pairs
        • -
      -
      Returns:

      The SQL INSERT statement, as a string

      -
      Return type:

      string

      -
      -

      Generate an INSERT statement string.

      -
      - -
      -
      -update_string($table, $data, $where)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – The target table
        • -
      • $data (array) – An associative array of key/value pairs
        • -
      • $where (mixed) – The WHERE statement conditions
        • -
      -
      Returns:

      The SQL UPDATE statement, as a string

      -
      Return type:

      string

      -
      -

      Generate an UPDATE statement string.

      -
      - -
      -
      -call_function($function)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $function (string) – Function name
        • -
      -
      Returns:

      The function result

      -
      Return type:

      string

      -
      -

      Runs a native PHP function , using a platform agnostic -wrapper.

      -
      - -
      -
      -cache_set_path([$path = ''])
      -
      --- - - - - - -
      Parameters:
        -
      • $path (string) – Path to the cache directory
        • -
      -
      Return type:

      void

      -
      -

      Sets the directory path to use for caching storage.

      -
      - -
      -
      -cache_on()
      -
      --- - - - - - -
      Returns:TRUE if caching is on, FALSE if not
      Return type:bool
      -

      Enable database results caching.

      -
      - -
      -
      -cache_off()
      -
      --- - - - - - -
      Returns:TRUE if caching is on, FALSE if not
      Return type:bool
      -

      Disable database results caching.

      -
      - -
      -
      -cache_delete([$segment_one = ''[, $segment_two = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $segment_one (string) – First URI segment
        • -
      • $segment_two (string) – Second URI segment
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Delete the cache files associated with a particular URI.

      -
      - -
      -
      -cache_delete_all()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      Delete all cache files.

      -
      - -
      -
      -close()
      -
      --- - - - -
      Return type:void
      -

      Close the DB Connection.

      -
      - -
      -
      -display_error([$error = ''[, $swap = ''[, $native = FALSE]]])
      -
      --- - - - - - - - - - -
      Parameters:
        -
      • $error (string) – The error message
        • -
      • $swap (string) – Any “swap” values
        • -
      • $native (bool) – Whether to localize the message
        • -
      -
      Return type:

      void

      -
      Returns:

      Displays the DB error screensends the application/views/errors/error_db.php template

      -
      Return type:

      string

      -
      -

      Display an error message and stop script execution.

      -

      The message is displayed using the -application/views/errors/error_db.php template.

      -
      - -
      -
      -protect_identifiers($item[, $prefix_single = FALSE[, $protect_identifiers = NULL[, $field_exists = TRUE]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $item (string) – The item to work with
        • -
      • $prefix_single (bool) – Whether to apply the dbprefix even if the input item is a single identifier
        • -
      • $protect_identifiers (bool) – Whether to quote identifiers
        • -
      • $field_exists (bool) – Whether the supplied item contains a field name or not
        • -
      -
      Returns:

      The modified item

      -
      Return type:

      string

      -
      -

      Takes a column or table name (optionally with an alias) -and applies the configured dbprefix to it.

      -

      Some logic is necessary in order to deal with -column names that include the path.

      -

      Consider a query like this:

      -
      SELECT * FROM hostname.database.table.column AS c FROM hostname.database.table
-
      -
      -

      Or a query with aliasing:

      -
      SELECT m.member_id, m.member_name FROM members AS m
-
      -
      -

      Since the column name can include up to four segments -(host, DB, table, column) or also have an alias prefix, -we need to do a bit of work to figure this out and -insert the table prefix (if it exists) in the proper -position, and escape only the correct identifiers.

      -

      This method is used extensively by the Query Builder class.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/examples.html b/user_guide/database/examples.html deleted file mode 100755 index dd4ba5c..0000000 --- a/user_guide/database/examples.html +++ /dev/null @@ -1,598 +0,0 @@ - - - - - - - - - - Database Quick Start: Example Code — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Database Quick Start: Example Code

      -

      The following page contains example code showing how the database class -is used. For complete details please read the individual pages -describing each function.

      -
      -

      Initializing the Database Class

      -

      The following code loads and initializes the database class based on -your configuration settings:

      -
      $this->load->database();
-
      -
      -

      Once loaded the class is ready to be used as described below.

      -

      Note: If all your pages require database access you can connect -automatically. See the connecting page for details.

      -
      -
      -

      Standard Query With Multiple Results (Object Version)

      -
      $query = $this->db->query('SELECT name, title, email FROM my_table');
-
-foreach ($query->result() as $row)
-{
-        echo $row->title;
-        echo $row->name;
-        echo $row->email;
-}
-
-echo 'Total Results: ' . $query->num_rows();
-
      -
      -

      The above result() function returns an array of objects. Example: -$row->title

      -
      -
      -

      Standard Query With Multiple Results (Array Version)

      -
      $query = $this->db->query('SELECT name, title, email FROM my_table');
-
-foreach ($query->result_array() as $row)
-{
-        echo $row['title'];
-        echo $row['name'];
-        echo $row['email'];
-}
-
      -
      -

      The above result_array() function returns an array of standard array -indexes. Example: $row[‘title’]

      -
      -
      -

      Standard Query With Single Result

      -
      $query = $this->db->query('SELECT name FROM my_table LIMIT 1');
-$row = $query->row();
-echo $row->name;
-
      -
      -

      The above row() function returns an object. Example: $row->name

      -
      -
      -

      Standard Query With Single Result (Array version)

      -
      $query = $this->db->query('SELECT name FROM my_table LIMIT 1');
-$row = $query->row_array();
-echo $row['name'];
-
      -
      -

      The above row_array() function returns an array. Example: -$row[‘name’]

      -
      -
      -

      Standard Insert

      -
      $sql = "INSERT INTO mytable (title, name) VALUES (".$this->db->escape($title).", ".$this->db->escape($name).")";
-$this->db->query($sql);
-echo $this->db->affected_rows();
-
      -
      -
      -
      -

      Query Builder Query

      -

      The Query Builder Pattern gives you a simplified -means of retrieving data:

      -
      $query = $this->db->get('table_name');
-
-foreach ($query->result() as $row)
-{
-        echo $row->title;
-}
-
      -
      -

      The above get() function retrieves all the results from the supplied -table. The Query Builder class contains a full -compliment of functions for working with data.

      -
      -
      -

      Query Builder Insert

      -
      $data = array(
-        'title' => $title,
-        'name' => $name,
-        'date' => $date
-);
-
-$this->db->insert('mytable', $data);  // Produces: INSERT INTO mytable (title, name, date) VALUES ('{$title}', '{$name}', '{$date}')
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/forge.html b/user_guide/database/forge.html deleted file mode 100755 index 6537539..0000000 --- a/user_guide/database/forge.html +++ /dev/null @@ -1,1033 +0,0 @@ - - - - - - - - - - Database Forge Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Database Forge Class

      -

      The Database Forge Class contains methods that help you manage your -database.

      - -
      -

      Initializing the Forge Class

      -
      -

      Important

      -

      In order to initialize the Forge class, your database -driver must already be running, since the forge class relies on it.

      -
      -

      Load the Forge Class as follows:

      -
      $this->load->dbforge()
-
      -
      -

      You can also pass another database object to the DB Forge loader, in case -the database you want to manage isn’t the default one:

      -
      $this->myforge = $this->load->dbforge($this->other_db, TRUE);
-
      -
      -

      In the above example, we’re passing a custom database object as the first -parameter and then tell it to return the dbforge object, instead of -assigning it directly to $this->dbforge.

      -
      -

      Note

      -

      Both of the parameters can be used individually, just pass an empty -value as the first one if you wish to skip it.

      -
      -

      Once initialized you will access the methods using the $this->dbforge -object:

      -
      $this->dbforge->some_method();
-
      -
      -
      -
      -

      Creating and Dropping Databases

      -

      $this->dbforge->create_database(‘db_name’)

      -

      Permits you to create the database specified in the first parameter. -Returns TRUE/FALSE based on success or failure:

      -
      if ($this->dbforge->create_database('my_db'))
-{
-        echo 'Database created!';
-}
-
      -
      -

      $this->dbforge->drop_database(‘db_name’)

      -

      Permits you to drop the database specified in the first parameter. -Returns TRUE/FALSE based on success or failure:

      -
      if ($this->dbforge->drop_database('my_db'))
-{
-        echo 'Database deleted!';
-}
-
      -
      -
      -
      -

      Creating and Dropping Tables

      -

      There are several things you may wish to do when creating tables. Add -fields, add keys to the table, alter columns. CodeIgniter provides a -mechanism for this.

      -
      -

      Adding fields

      -

      Fields are created via an associative array. Within the array you must -include a ‘type’ key that relates to the datatype of the field. For -example, INT, VARCHAR, TEXT, etc. Many datatypes (for example VARCHAR) -also require a ‘constraint’ key.

      -
      $fields = array(
-        'users' => array(
-                'type' => 'VARCHAR',
-                'constraint' => '100',
-        ),
-);
-// will translate to "users VARCHAR(100)" when the field is added.
-
      -
      -

      Additionally, the following key/values can be used:

      -
        -
      • unsigned/true : to generate “UNSIGNED” in the field definition.
        • -
      • default/value : to generate a default value in the field definition.
        • -
      • null/true : to generate “NULL” in the field definition. Without this, -the field will default to “NOT NULL”.
        • -
      • auto_increment/true : generates an auto_increment flag on the -field. Note that the field type must be a type that supports this, -such as integer.
        • -
      -
      $fields = array(
-        'blog_id' => array(
-                'type' => 'INT',
-                'constraint' => 5,
-                'unsigned' => TRUE,
-                'auto_increment' => TRUE
-        ),
-        'blog_title' => array(
-                'type' => 'VARCHAR',
-                'constraint' => '100',
-        ),
-        'blog_author' => array(
-                'type' =>'VARCHAR',
-                'constraint' => '100',
-                'default' => 'King of Town',
-        ),
-        'blog_description' => array(
-                'type' => 'TEXT',
-                'null' => TRUE,
-        ),
-);
-
      -
      -

      After the fields have been defined, they can be added using -$this->dbforge->add_field($fields); followed by a call to the -create_table() method.

      -

      $this->dbforge->add_field()

      -

      The add fields method will accept the above array.

      -
      -

      Passing strings as fields

      -

      If you know exactly how you want a field to be created, you can pass the -string into the field definitions with add_field()

      -
      $this->dbforge->add_field("label varchar(100) NOT NULL DEFAULT 'default label'");
-
      -
      -
      -

      Note

      -

      Passing raw strings as fields cannot be followed by add_key() calls on those fields.

      -
      -
      -

      Note

      -

      Multiple calls to add_field() are cumulative.

      -
      -
      -
      -

      Creating an id field

      -

      There is a special exception for creating id fields. A field with type -id will automatically be assigned as an INT(9) auto_incrementing -Primary Key.

      -
      $this->dbforge->add_field('id');
-// gives id INT(9) NOT NULL AUTO_INCREMENT
-
      -
      -
      -
      -
      -

      Adding Keys

      -

      Generally speaking, you’ll want your table to have Keys. This is -accomplished with $this->dbforge->add_key(‘field’). An optional second -parameter set to TRUE will make it a primary key. Note that add_key() -must be followed by a call to create_table().

      -

      Multiple column non-primary keys must be sent as an array. Sample output -below is for MySQL.

      -
      $this->dbforge->add_key('blog_id', TRUE);
-// gives PRIMARY KEY `blog_id` (`blog_id`)
-
-$this->dbforge->add_key('blog_id', TRUE);
-$this->dbforge->add_key('site_id', TRUE);
-// gives PRIMARY KEY `blog_id_site_id` (`blog_id`, `site_id`)
-
-$this->dbforge->add_key('blog_name');
-// gives KEY `blog_name` (`blog_name`)
-
-$this->dbforge->add_key(array('blog_name', 'blog_label'));
-// gives KEY `blog_name_blog_label` (`blog_name`, `blog_label`)
-
      -
      -
      -
      -

      Creating a table

      -

      After fields and keys have been declared, you can create a new table -with

      -
      $this->dbforge->create_table('table_name');
-// gives CREATE TABLE table_name
-
      -
      -

      An optional second parameter set to TRUE adds an “IF NOT EXISTS” clause -into the definition

      -
      $this->dbforge->create_table('table_name', TRUE);
-// gives CREATE TABLE IF NOT EXISTS table_name
-
      -
      -

      You could also pass optional table attributes, such as MySQL’s ENGINE:

      -
      $attributes = array('ENGINE' => 'InnoDB');
-$this->dbforge->create_table('table_name', FALSE, $attributes);
-// produces: CREATE TABLE `table_name` (...) ENGINE = InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci
-
      -
      -
      -

      Note

      -

      Unless you specify the CHARACTER SET and/or COLLATE attributes, -create_table() will always add them with your configured char_set -and dbcollat values, as long as they are not empty (MySQL only).

      -
      -
      -
      -

      Dropping a table

      -

      Execute a DROP TABLE statement and optionally add an IF EXISTS clause.

      -
      // Produces: DROP TABLE table_name
-$this->dbforge->drop_table('table_name');
-
-// Produces: DROP TABLE IF EXISTS table_name
-$this->dbforge->drop_table('table_name',TRUE);
-
      -
      -
      -
      -

      Renaming a table

      -

      Executes a TABLE rename

      -
      $this->dbforge->rename_table('old_table_name', 'new_table_name');
-// gives ALTER TABLE old_table_name RENAME TO new_table_name
-
      -
      -
      -
      -
      -

      Modifying Tables

      -
      -

      Adding a Column to a Table

      -

      $this->dbforge->add_column()

      -

      The add_column() method is used to modify an existing table. It -accepts the same field array as above, and can be used for an unlimited -number of additional fields.

      -
      $fields = array(
-        'preferences' => array('type' => 'TEXT')
-);
-$this->dbforge->add_column('table_name', $fields);
-// Executes: ALTER TABLE table_name ADD preferences TEXT
-
      -
      -

      If you are using MySQL or CUBIRD, then you can take advantage of their -AFTER and FIRST clauses to position the new column.

      -

      Examples:

      -
      // Will place the new column after the `another_field` column:
-$fields = array(
-        'preferences' => array('type' => 'TEXT', 'after' => 'another_field')
-);
-
-// Will place the new column at the start of the table definition:
-$fields = array(
-        'preferences' => array('type' => 'TEXT', 'first' => TRUE)
-);
-
      -
      -
      -
      -

      Dropping a Column From a Table

      -

      $this->dbforge->drop_column()

      -

      Used to remove a column from a table.

      -
      $this->dbforge->drop_column('table_name', 'column_to_drop');
-
      -
      -
      -
      -

      Modifying a Column in a Table

      -

      $this->dbforge->modify_column()

      -

      The usage of this method is identical to add_column(), except it -alters an existing column rather than adding a new one. In order to -change the name you can add a “name” key into the field defining array.

      -
      $fields = array(
-        'old_name' => array(
-                'name' => 'new_name',
-                'type' => 'TEXT',
-        ),
-);
-$this->dbforge->modify_column('table_name', $fields);
-// gives ALTER TABLE table_name CHANGE old_name new_name TEXT
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_DB_forge
      -
      -
      -add_column($table[, $field = array()[, $_after = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name to add the column to
        • -
      • $field (array) – Column definition(s)
        • -
      • $_after (string) – Column for AFTER clause (deprecated)
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Adds a column to a table. Usage: See Adding a Column to a Table.

      -
      - -
      -
      -add_field($field)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (array) – Field definition to add
        • -
      -
      Returns:

      CI_DB_forge instance (method chaining)

      -
      Return type:

      CI_DB_forge

      -
      -

      Adds a field to the set that will be used to create a table. Usage: See Adding fields.

      -
      - -
      -
      -add_key($key[, $primary = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (array) – Name of a key field
        • -
      • $primary (bool) – Set to TRUE if it should be a primary key or a regular one
        • -
      -
      Returns:

      CI_DB_forge instance (method chaining)

      -
      Return type:

      CI_DB_forge

      -
      -

      Adds a key to the set that will be used to create a table. Usage: See Adding Keys.

      -
      - -
      -
      -create_database($db_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $db_name (string) – Name of the database to create
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Creates a new database. Usage: See Creating and Dropping Databases.

      -
      - -
      -
      -create_table($table[, $if_not_exists = FALSE[, array $attributes = array()]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Name of the table to create
        • -
      • $if_not_exists (string) – Set to TRUE to add an ‘IF NOT EXISTS’ clause
        • -
      • $attributes (string) – An associative array of table attributes
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Creates a new table. Usage: See Creating a table.

      -
      - -
      -
      -drop_column($table, $column_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $column_name (array) – The column name to drop
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Drops a column from a table. Usage: See Dropping a Column From a Table.

      -
      - -
      -
      -drop_database($db_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $db_name (string) – Name of the database to drop
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Drops a database. Usage: See Creating and Dropping Databases.

      -
      - -
      -
      -drop_table($table_name[, $if_exists = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Name of the table to drop
        • -
      • $if_exists (string) – Set to TRUE to add an ‘IF EXISTS’ clause
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Drops a table. Usage: See Dropping a table.

      -
      - -
      -
      -modify_column($table, $field)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $field (array) – Column definition(s)
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Modifies a table column. Usage: See Modifying a Column in a Table.

      -
      - -
      -
      -rename_table($table_name, $new_table_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Current of the table
        • -
      • $new_table_name (string) – New name of the table
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Renames a table. Usage: See Renaming a table.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/helpers.html b/user_guide/database/helpers.html deleted file mode 100755 index 5f27f9d..0000000 --- a/user_guide/database/helpers.html +++ /dev/null @@ -1,593 +0,0 @@ - - - - - - - - - - Query Helper Methods — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Query Helper Methods

      -
      -

      Information From Executing a Query

      -

      $this->db->insert_id()

      -

      The insert ID number when performing database inserts.

      -
      -

      Note

      -

      If using the PDO driver with PostgreSQL, or using the Interbase -driver, this function requires a $name parameter, which specifies the -appropriate sequence to check for the insert id.

      -
      -

      $this->db->affected_rows()

      -

      Displays the number of affected rows, when doing “write” type queries -(insert, update, etc.).

      -
      -

      Note

      -

      In MySQL “DELETE FROM TABLE” returns 0 affected rows. The database -class has a small hack that allows it to return the correct number of -affected rows. By default this hack is enabled but it can be turned off -in the database driver file.

      -
      -

      $this->db->last_query()

      -

      Returns the last query that was run (the query string, not the result). -Example:

      -
      $str = $this->db->last_query();
-
-// Produces:  SELECT * FROM sometable....
-
      -
      -
      -

      Note

      -

      Disabling the save_queries setting in your database -configuration will render this function useless.

      -
      -
      -
      -

      Information About Your Database

      -

      $this->db->count_all()

      -

      Permits you to determine the number of rows in a particular table. -Submit the table name in the first parameter. Example:

      -
      echo $this->db->count_all('my_table');
-
-// Produces an integer, like 25
-
      -
      -

      $this->db->platform()

      -

      Outputs the database platform you are running (MySQL, MS SQL, Postgres, -etc...):

      -
      echo $this->db->platform();
-
      -
      -

      $this->db->version()

      -

      Outputs the database version you are running:

      -
      echo $this->db->version();
-
      -
      -
      -
      -

      Making Your Queries Easier

      -

      $this->db->insert_string()

      -

      This function simplifies the process of writing database inserts. It -returns a correctly formatted SQL insert string. Example:

      -
      $data = array('name' => $name, 'email' => $email, 'url' => $url);
-
-$str = $this->db->insert_string('table_name', $data);
-
      -
      -

      The first parameter is the table name, the second is an associative -array with the data to be inserted. The above example produces:

      -
      INSERT INTO table_name (name, email, url) VALUES ('Rick', 'rick@example.com', 'example.com')
-
      -
      -
      -

      Note

      -

      Values are automatically escaped, producing safer queries.

      -
      -

      $this->db->update_string()

      -

      This function simplifies the process of writing database updates. It -returns a correctly formatted SQL update string. Example:

      -
      $data = array('name' => $name, 'email' => $email, 'url' => $url);
-
-$where = "author_id = 1 AND status = 'active'";
-
-$str = $this->db->update_string('table_name', $data, $where);
-
      -
      -

      The first parameter is the table name, the second is an associative -array with the data to be updated, and the third parameter is the -“where” clause. The above example produces:

      -
      UPDATE table_name SET name = 'Rick', email = 'rick@example.com', url = 'example.com' WHERE author_id = 1 AND status = 'active'
-
      -
      -
      -

      Note

      -

      Values are automatically escaped, producing safer queries.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/index.html b/user_guide/database/index.html deleted file mode 100755 index e6afea2..0000000 --- a/user_guide/database/index.html +++ /dev/null @@ -1,541 +0,0 @@ - - - - - - - - - - Database Reference — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Database Reference
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Database Reference

      -

      CodeIgniter comes with a full-featured and very fast abstracted database -class that supports both traditional structures and Query Builder -patterns. The database functions offer clear, simple syntax.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/metadata.html b/user_guide/database/metadata.html deleted file mode 100755 index a6617df..0000000 --- a/user_guide/database/metadata.html +++ /dev/null @@ -1,615 +0,0 @@ - - - - - - - - - - Database Metadata — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Database Metadata

      -
      -

      Table MetaData

      -

      These functions let you fetch table information.

      -
      -

      List the Tables in Your Database

      -

      $this->db->list_tables();

      -

      Returns an array containing the names of all the tables in the database -you are currently connected to. Example:

      -
      $tables = $this->db->list_tables();
-
-foreach ($tables as $table)
-{
-        echo $table;
-}
-
      -
      -
      -
      -

      Determine If a Table Exists

      -

      $this->db->table_exists();

      -

      Sometimes it’s helpful to know whether a particular table exists before -running an operation on it. Returns a boolean TRUE/FALSE. Usage example:

      -
      if ($this->db->table_exists('table_name'))
-{
-        // some code...
-}
-
      -
      -
      -

      Note

      -

      Replace table_name with the name of the table you are looking for.

      -
      -
      -
      -
      -

      Field MetaData

      -
      -

      List the Fields in a Table

      -

      $this->db->list_fields()

      -

      Returns an array containing the field names. This query can be called -two ways:

      -

      1. You can supply the table name and call it from the $this->db-> -object:

      -
      $fields = $this->db->list_fields('table_name');
-
-foreach ($fields as $field)
-{
-        echo $field;
-}
-
      -
      -

      2. You can gather the field names associated with any query you run by -calling the function from your query result object:

      -
      $query = $this->db->query('SELECT * FROM some_table');
-
-foreach ($query->list_fields() as $field)
-{
-        echo $field;
-}
-
      -
      -
      -
      -

      Determine If a Field is Present in a Table

      -

      $this->db->field_exists()

      -

      Sometimes it’s helpful to know whether a particular field exists before -performing an action. Returns a boolean TRUE/FALSE. Usage example:

      -
      if ($this->db->field_exists('field_name', 'table_name'))
-{
-        // some code...
-}
-
      -
      -
      -

      Note

      -

      Replace field_name with the name of the column you are looking -for, and replace table_name with the name of the table you are -looking for.

      -
      -
      -
      -

      Retrieve Field Metadata

      -

      $this->db->field_data()

      -

      Returns an array of objects containing field information.

      -

      Sometimes it’s helpful to gather the field names or other metadata, like -the column type, max length, etc.

      -
      -

      Note

      -

      Not all databases provide meta-data.

      -
      -

      Usage example:

      -
      $fields = $this->db->field_data('table_name');
-
-foreach ($fields as $field)
-{
-        echo $field->name;
-        echo $field->type;
-        echo $field->max_length;
-        echo $field->primary_key;
-}
-
      -
      -

      If you have run a query already you can use the result object instead of -supplying the table name:

      -
      $query = $this->db->query("YOUR QUERY");
-$fields = $query->field_data();
-
      -
      -

      The following data is available from this function if supported by your -database:

      -
        -
      • name - column name
        • -
      • max_length - maximum length of the column
        • -
      • primary_key - 1 if the column is a primary key
        • -
      • type - the type of the column
        • -
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/queries.html b/user_guide/database/queries.html deleted file mode 100755 index 8dd3397..0000000 --- a/user_guide/database/queries.html +++ /dev/null @@ -1,651 +0,0 @@ - - - - - - - - - - Queries — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Queries

      -
      -

      Query Basics

      -
      -

      Regular Queries

      -

      To submit a query, use the query function:

      -
      $this->db->query('YOUR QUERY HERE');
-
      -
      -

      The query() function returns a database result object when “read” -type queries are run, which you can use to show your -results. When “write” type queries are run it simply -returns TRUE or FALSE depending on success or failure. When retrieving -data you will typically assign the query to your own variable, like -this:

      -
      $query = $this->db->query('YOUR QUERY HERE');
-
      -
      -
      -
      -

      Simplified Queries

      -

      The simple_query method is a simplified version of the -$this->db->query() method. It DOES -NOT return a database result set, nor does it set the query timer, or -compile bind data, or store your query for debugging. It simply lets you -submit a query. Most users will rarely use this function.

      -

      It returns whatever the database drivers’ “execute” function returns. -That typically is TRUE/FALSE on success or failure for write type queries -such as INSERT, DELETE or UPDATE statements (which is what it really -should be used for) and a resource/object on success for queries with -fetchable results.

      -
      if ($this->db->simple_query('YOUR QUERY'))
-{
-        echo "Success!";
-}
-else
-{
-        echo "Query failed!";
-}
-
      -
      -
      -

      Note

      -

      PostgreSQL’s pg_exec() function (for example) always -returns a resource on success, even for write type queries. -So take that in mind if you’re looking for a boolean value.

      -
      -
      -
      -
      -

      Working with Database prefixes manually

      -

      If you have configured a database prefix and would like to prepend it to -a table name for use in a native SQL query for example, then you can use -the following:

      -
      $this->db->dbprefix('tablename'); // outputs prefix_tablename
-
      -
      -

      If for any reason you would like to change the prefix programatically -without needing to create a new connection, you can use this method:

      -
      $this->db->set_dbprefix('newprefix');
-$this->db->dbprefix('tablename'); // outputs newprefix_tablename
-
      -
      -
      -
      -

      Protecting identifiers

      -

      In many databases it is advisable to protect table and field names - for -example with backticks in MySQL. Query Builder queries are -automatically protected, however if you need to manually protect an -identifier you can use:

      -
      $this->db->protect_identifiers('table_name');
-
      -
      -
      -

      Important

      -

      Although the Query Builder will try its best to properly -quote any field and table names that you feed it, note that it -is NOT designed to work with arbitrary user input. DO NOT feed it -with unsanitized user data.

      -
      -

      This function will also add a table prefix to your table, assuming you -have a prefix specified in your database config file. To enable the -prefixing set TRUE (boolean) via the second parameter:

      -
      $this->db->protect_identifiers('table_name', TRUE);
-
      -
      -
      -
      -

      Escaping Queries

      -

      It’s a very good security practice to escape your data before submitting -it into your database. CodeIgniter has three methods that help you do -this:

      -
        -

      1. $this->db->escape() This function determines the data type so -that it can escape only string data. It also automatically adds -single quotes around the data so you don’t have to:

        -
        $sql = "INSERT INTO table (title) VALUES(".$this->db->escape($title).")";
-
        -
        -
        2. -

      2. $this->db->escape_str() This function escapes the data passed to -it, regardless of type. Most of the time you’ll use the above -function rather than this one. Use the function like this:

        -
        $sql = "INSERT INTO table (title) VALUES('".$this->db->escape_str($title)."')";
-
        -
        -
        3. -

      3. $this->db->escape_like_str() This method should be used when -strings are to be used in LIKE conditions so that LIKE wildcards -(‘%’, ‘_’) in the string are also properly escaped.

        -
        4. -
      -
      $search = '20% raise';
-$sql = "SELECT id FROM table WHERE column LIKE '%" .
-    $this->db->escape_like_str($search)."%'";
-
      -
      -
      -
      -

      Query Bindings

      -

      Bindings enable you to simplify your query syntax by letting the system -put the queries together for you. Consider the following example:

      -
      $sql = "SELECT * FROM some_table WHERE id = ? AND status = ? AND author = ?";
-$this->db->query($sql, array(3, 'live', 'Rick'));
-
      -
      -

      The question marks in the query are automatically replaced with the -values in the array in the second parameter of the query function.

      -

      Binding also work with arrays, which will be transformed to IN sets:

      -
      $sql = "SELECT * FROM some_table WHERE id IN ? AND status = ? AND author = ?";
-$this->db->query($sql, array(array(3, 6), 'live', 'Rick'));
-
      -
      -

      The resulting query will be:

      -
      SELECT * FROM some_table WHERE id IN (3,6) AND status = 'live' AND author = 'Rick'
-
      -
      -

      The secondary benefit of using binds is that the values are -automatically escaped, producing safer queries. You don’t have to -remember to manually escape data; the engine does it automatically for -you.

      -
      -
      -

      Handling Errors

      -

      $this->db->error();

      -

      If you need to get the last error that has occured, the error() method -will return an array containing its code and message. Here’s a quick -example:

      -
      if ( ! $this->db->simple_query('SELECT `example_field` FROM `example_table`'))
-{
-        $error = $this->db->error(); // Has keys 'code' and 'message'
-}
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/query_builder.html b/user_guide/database/query_builder.html deleted file mode 100755 index 8496efa..0000000 --- a/user_guide/database/query_builder.html +++ /dev/null @@ -1,2701 +0,0 @@ - - - - - - - - - - Query Builder Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Query Builder Class

      -

      CodeIgniter gives you access to a Query Builder class. This pattern -allows information to be retrieved, inserted, and updated in your -database with minimal scripting. In some cases only one or two lines -of code are necessary to perform a database action. -CodeIgniter does not require that each database table be its own class -file. It instead provides a more simplified interface.

      -

      Beyond simplicity, a major benefit to using the Query Builder features -is that it allows you to create database independent applications, since -the query syntax is generated by each database adapter. It also allows -for safer queries, since the values are escaped automatically by the -system.

      -
      -

      Note

      -

      If you intend to write your own queries you can disable this -class in your database config file, allowing the core database library -and adapter to utilize fewer resources.

      -
      - -
      -

      Selecting Data

      -

      The following functions allow you to build SQL SELECT statements.

      -

      $this->db->get()

      -

      Runs the selection query and returns the result. Can be used by itself -to retrieve all records from a table:

      -
      $query = $this->db->get('mytable');  // Produces: SELECT * FROM mytable
-
      -
      -

      The second and third parameters enable you to set a limit and offset -clause:

      -
      $query = $this->db->get('mytable', 10, 20);
-
-// Executes: SELECT * FROM mytable LIMIT 20, 10
-// (in MySQL. Other databases have slightly different syntax)
-
      -
      -

      You’ll notice that the above function is assigned to a variable named -$query, which can be used to show the results:

      -
      $query = $this->db->get('mytable');
-
-foreach ($query->result() as $row)
-{
-        echo $row->title;
-}
-
      -
      -

      Please visit the result functions page for a full -discussion regarding result generation.

      -

      $this->db->get_compiled_select()

      -

      Compiles the selection query just like $this->db->get() but does not run -the query. This method simply returns the SQL query as a string.

      -

      Example:

      -
      $sql = $this->db->get_compiled_select('mytable');
-echo $sql;
-
-// Prints string: SELECT * FROM mytable
-
      -
      -

      The second parameter enables you to set whether or not the query builder query -will be reset (by default it will be reset, just like when using $this->db->get()):

      -
      echo $this->db->limit(10,20)->get_compiled_select('mytable', FALSE);
-
-// Prints string: SELECT * FROM mytable LIMIT 20, 10
-// (in MySQL. Other databases have slightly different syntax)
-
-echo $this->db->select('title, content, date')->get_compiled_select();
-
-// Prints string: SELECT title, content, date FROM mytable LIMIT 20, 10
-
      -
      -

      The key thing to notice in the above example is that the second query did not -utilize $this->db->from() and did not pass a table name into the first -parameter. The reason for this outcome is because the query has not been -executed using $this->db->get() which resets values or reset directly -using $this->db->reset_query().

      -

      $this->db->get_where()

      -

      Identical to the above function except that it permits you to add a -“where” clause in the second parameter, instead of using the db->where() -function:

      -
      $query = $this->db->get_where('mytable', array('id' => $id), $limit, $offset);
-
      -
      -

      Please read the about the where function below for more information.

      -
      -

      Note

      -

      get_where() was formerly known as getwhere(), which has been removed

      -
      -

      $this->db->select()

      -

      Permits you to write the SELECT portion of your query:

      -
      $this->db->select('title, content, date');
-$query = $this->db->get('mytable');
-
-// Executes: SELECT title, content, date FROM mytable
-
      -
      -
      -

      Note

      -

      If you are selecting all (*) from a table you do not need to -use this function. When omitted, CodeIgniter assumes that you wish -to select all fields and automatically adds ‘SELECT *’.

      -
      -

      $this->db->select() accepts an optional second parameter. If you set it -to FALSE, CodeIgniter will not try to protect your field or table names. -This is useful if you need a compound select statement where automatic -escaping of fields may break them.

      -
      $this->db->select('(SELECT SUM(payments.amount) FROM payments WHERE payments.invoice_id=4') AS amount_paid', FALSE);
-$query = $this->db->get('mytable');
-
      -
      -

      $this->db->select_max()

      -

      Writes a SELECT MAX(field) portion for your query. You can optionally -include a second parameter to rename the resulting field.

      -
      $this->db->select_max('age');
-$query = $this->db->get('members');  // Produces: SELECT MAX(age) as age FROM members
-
-$this->db->select_max('age', 'member_age');
-$query = $this->db->get('members'); // Produces: SELECT MAX(age) as member_age FROM members
-
      -
      -

      $this->db->select_min()

      -

      Writes a “SELECT MIN(field)” portion for your query. As with -select_max(), You can optionally include a second parameter to rename -the resulting field.

      -
      $this->db->select_min('age');
-$query = $this->db->get('members'); // Produces: SELECT MIN(age) as age FROM members
-
      -
      -

      $this->db->select_avg()

      -

      Writes a “SELECT AVG(field)” portion for your query. As with -select_max(), You can optionally include a second parameter to rename -the resulting field.

      -
      $this->db->select_avg('age');
-$query = $this->db->get('members'); // Produces: SELECT AVG(age) as age FROM members
-
      -
      -

      $this->db->select_sum()

      -

      Writes a “SELECT SUM(field)” portion for your query. As with -select_max(), You can optionally include a second parameter to rename -the resulting field.

      -
      $this->db->select_sum('age');
-$query = $this->db->get('members'); // Produces: SELECT SUM(age) as age FROM members
-
      -
      -

      $this->db->from()

      -

      Permits you to write the FROM portion of your query:

      -
      $this->db->select('title, content, date');
-$this->db->from('mytable');
-$query = $this->db->get();  // Produces: SELECT title, content, date FROM mytable
-
      -
      -
      -

      Note

      -

      As shown earlier, the FROM portion of your query can be specified -in the $this->db->get() function, so use whichever method you prefer.

      -
      -

      $this->db->join()

      -

      Permits you to write the JOIN portion of your query:

      -
      $this->db->select('*');
-$this->db->from('blogs');
-$this->db->join('comments', 'comments.id = blogs.id');
-$query = $this->db->get();
-
-// Produces:
-// SELECT * FROM blogs JOIN comments ON comments.id = blogs.id
-
      -
      -

      Multiple function calls can be made if you need several joins in one -query.

      -

      If you need a specific type of JOIN you can specify it via the third -parameter of the function. Options are: left, right, outer, inner, left -outer, and right outer.

      -
      $this->db->join('comments', 'comments.id = blogs.id', 'left');
-// Produces: LEFT JOIN comments ON comments.id = blogs.id
-
      -
      -
      -
      -

      Looking for Specific Data

      -

      $this->db->where()

      -

      This function enables you to set WHERE clauses using one of four -methods:

      -
      -

      Note

      -

      All values passed to this function are escaped automatically, -producing safer queries.

      -
      -
        -

      1. Simple key/value method:

        -
        -
        $this->db->where('name', $name); // Produces: WHERE name = 'Joe'
-
        -
        -

        Notice that the equal sign is added for you.

        -

        If you use multiple function calls they will be chained together with -AND between them:

        -
        $this->db->where('name', $name);
-$this->db->where('title', $title);
-$this->db->where('status', $status);
-// WHERE name = 'Joe' AND title = 'boss' AND status = 'active'
-
        -
        -
        -
        2. -

      2. Custom key/value method:

        -
        -

        You can include an operator in the first parameter in order to -control the comparison:

        -
        $this->db->where('name !=', $name);
-$this->db->where('id <', $id); // Produces: WHERE name != 'Joe' AND id < 45
-
        -
        -
        -
        3. -

      3. Associative array method:

        -
        -
        $array = array('name' => $name, 'title' => $title, 'status' => $status);
-$this->db->where($array);
-// Produces: WHERE name = 'Joe' AND title = 'boss' AND status = 'active'
-
        -
        -

        You can include your own operators using this method as well:

        -
        $array = array('name !=' => $name, 'id <' => $id, 'date >' => $date);
-$this->db->where($array);
-
        -
        -
        -
        4. -
      4. -
        Custom string:
        -

        You can write your own clauses manually:

        -
        $where = "name='Joe' AND status='boss' OR status='active'";
-$this->db->where($where);
-
        -
        -
        -
        -
        5. -
      -

      $this->db->where() accepts an optional third parameter. If you set it to -FALSE, CodeIgniter will not try to protect your field or table names.

      -
      $this->db->where('MATCH (field) AGAINST ("value")', NULL, FALSE);
-
      -
      -

      $this->db->or_where()

      -

      This function is identical to the one above, except that multiple -instances are joined by OR:

      -
      $this->db->where('name !=', $name);
-$this->db->or_where('id >', $id);  // Produces: WHERE name != 'Joe' OR id > 50
-
      -
      -
      -

      Note

      -

      or_where() was formerly known as orwhere(), which has been -removed.

      -
      -

      $this->db->where_in()

      -

      Generates a WHERE field IN (‘item’, ‘item’) SQL query joined with AND if -appropriate

      -
      $names = array('Frank', 'Todd', 'James');
-$this->db->where_in('username', $names);
-// Produces: WHERE username IN ('Frank', 'Todd', 'James')
-
      -
      -

      $this->db->or_where_in()

      -

      Generates a WHERE field IN (‘item’, ‘item’) SQL query joined with OR if -appropriate

      -
      $names = array('Frank', 'Todd', 'James');
-$this->db->or_where_in('username', $names);
-// Produces: OR username IN ('Frank', 'Todd', 'James')
-
      -
      -

      $this->db->where_not_in()

      -

      Generates a WHERE field NOT IN (‘item’, ‘item’) SQL query joined with -AND if appropriate

      -
      $names = array('Frank', 'Todd', 'James');
-$this->db->where_not_in('username', $names);
-// Produces: WHERE username NOT IN ('Frank', 'Todd', 'James')
-
      -
      -

      $this->db->or_where_not_in()

      -

      Generates a WHERE field NOT IN (‘item’, ‘item’) SQL query joined with OR -if appropriate

      -
      $names = array('Frank', 'Todd', 'James');
-$this->db->or_where_not_in('username', $names);
-// Produces: OR username NOT IN ('Frank', 'Todd', 'James')
-
      -
      -
      -
      -

      Looking for Similar Data

      -

      $this->db->like()

      -

      This method enables you to generate LIKE clauses, useful for doing -searches.

      -
      -

      Note

      -

      All values passed to this method are escaped automatically.

      -
      -
        -

      1. Simple key/value method:

        -
        -
        $this->db->like('title', 'match');
-// Produces: WHERE `title` LIKE '%match%' ESCAPE '!'
-
        -
        -

        If you use multiple method calls they will be chained together with -AND between them:

        -
        $this->db->like('title', 'match');
-$this->db->like('body', 'match');
-// WHERE `title` LIKE '%match%' ESCAPE '!' AND  `body` LIKE '%match% ESCAPE '!'
-
        -
        -

        If you want to control where the wildcard (%) is placed, you can use -an optional third argument. Your options are ‘before’, ‘after’ and -‘both’ (which is the default).

        -
        $this->db->like('title', 'match', 'before');    // Produces: WHERE `title` LIKE '%match' ESCAPE '!'
-$this->db->like('title', 'match', 'after');     // Produces: WHERE `title` LIKE 'match%' ESCAPE '!'
-$this->db->like('title', 'match', 'both');      // Produces: WHERE `title` LIKE '%match%' ESCAPE '!'
-
        -
        -
        -
        2. -

      2. Associative array method:

        -
        -
        $array = array('title' => $match, 'page1' => $match, 'page2' => $match);
-$this->db->like($array);
-// WHERE `title` LIKE '%match%' ESCAPE '!' AND  `page1` LIKE '%match%' ESCAPE '!' AND  `page2` LIKE '%match%' ESCAPE '!'
-
        -
        -
        -
        3. -
      -

      $this->db->or_like()

      -

      This method is identical to the one above, except that multiple -instances are joined by OR:

      -
      $this->db->like('title', 'match'); $this->db->or_like('body', $match);
-// WHERE `title` LIKE '%match%' ESCAPE '!' OR  `body` LIKE '%match%' ESCAPE '!'
-
      -
      -
      -

      Note

      -

      or_like() was formerly known as orlike(), which has been removed.

      -
      -

      $this->db->not_like()

      -

      This method is identical to like(), except that it generates -NOT LIKE statements:

      -
      $this->db->not_like('title', 'match');  // WHERE `title` NOT LIKE '%match% ESCAPE '!'
-
      -
      -

      $this->db->or_not_like()

      -

      This method is identical to not_like(), except that multiple -instances are joined by OR:

      -
      $this->db->like('title', 'match');
-$this->db->or_not_like('body', 'match');
-// WHERE `title` LIKE '%match% OR  `body` NOT LIKE '%match%' ESCAPE '!'
-
      -
      -

      $this->db->group_by()

      -

      Permits you to write the GROUP BY portion of your query:

      -
      $this->db->group_by("title"); // Produces: GROUP BY title
-
      -
      -

      You can also pass an array of multiple values as well:

      -
      $this->db->group_by(array("title", "date"));  // Produces: GROUP BY title, date
-
      -
      -
      -

      Note

      -

      group_by() was formerly known as groupby(), which has been -removed.

      -
      -

      $this->db->distinct()

      -

      Adds the “DISTINCT” keyword to a query

      -
      $this->db->distinct();
-$this->db->get('table'); // Produces: SELECT DISTINCT * FROM table
-
      -
      -

      $this->db->having()

      -

      Permits you to write the HAVING portion of your query. There are 2 -possible syntaxes, 1 argument or 2:

      -
      $this->db->having('user_id = 45');  // Produces: HAVING user_id = 45
-$this->db->having('user_id',  45);  // Produces: HAVING user_id = 45
-
      -
      -

      You can also pass an array of multiple values as well:

      -
      $this->db->having(array('title =' => 'My Title', 'id <' => $id));
-// Produces: HAVING title = 'My Title', id < 45
-
      -
      -

      If you are using a database that CodeIgniter escapes queries for, you -can prevent escaping content by passing an optional third argument, and -setting it to FALSE.

      -
      $this->db->having('user_id',  45);  // Produces: HAVING `user_id` = 45 in some databases such as MySQL
-$this->db->having('user_id',  45, FALSE);  // Produces: HAVING user_id = 45
-
      -
      -

      $this->db->or_having()

      -

      Identical to having(), only separates multiple clauses with “OR”.

      -
      -
      -

      Ordering results

      -

      $this->db->order_by()

      -

      Lets you set an ORDER BY clause.

      -

      The first parameter contains the name of the column you would like to order by.

      -

      The second parameter lets you set the direction of the result. -Options are ASC, DESC AND RANDOM.

      -
      $this->db->order_by('title', 'DESC');
-// Produces: ORDER BY `title` DESC
-
      -
      -

      You can also pass your own string in the first parameter:

      -
      $this->db->order_by('title DESC, name ASC');
-// Produces: ORDER BY `title` DESC, `name` ASC
-
      -
      -

      Or multiple function calls can be made if you need multiple fields.

      -
      $this->db->order_by('title', 'DESC');
-$this->db->order_by('name', 'ASC');
-// Produces: ORDER BY `title` DESC, `name` ASC
-
      -
      -

      If you choose the RANDOM direction option, then the first parameters will -be ignored, unless you specify a numeric seed value.

      -
      $this->db->order_by('title', 'RANDOM');
-// Produces: ORDER BY RAND()
-
-$this->db->order_by(42, 'RANDOM');
-// Produces: ORDER BY RAND(42)
-
      -
      -
      -

      Note

      -

      order_by() was formerly known as orderby(), which has been -removed.

      -
      -
      -

      Note

      -

      Random ordering is not currently supported in Oracle and -will default to ASC instead.

      -
      -
      -
      -

      Limiting or Counting Results

      -

      $this->db->limit()

      -

      Lets you limit the number of rows you would like returned by the query:

      -
      $this->db->limit(10);  // Produces: LIMIT 10
-
      -
      -

      The second parameter lets you set a result offset.

      -
      $this->db->limit(10, 20);  // Produces: LIMIT 20, 10 (in MySQL.  Other databases have slightly different syntax)
-
      -
      -

      $this->db->count_all_results()

      -

      Permits you to determine the number of rows in a particular Active -Record query. Queries will accept Query Builder restrictors such as -where(), or_where(), like(), or_like(), etc. Example:

      -
      echo $this->db->count_all_results('my_table');  // Produces an integer, like 25
-$this->db->like('title', 'match');
-$this->db->from('my_table');
-echo $this->db->count_all_results(); // Produces an integer, like 17
-
      -
      -

      However, this method also resets any field values that you may have passed -to select(). If you need to keep them, you can pass FALSE as the -second parameter:

      -
      echo $this->db->count_all_results('my_table', FALSE);
-
      -
      -

      $this->db->count_all()

      -

      Permits you to determine the number of rows in a particular table. -Submit the table name in the first parameter. Example:

      -
      echo $this->db->count_all('my_table');  // Produces an integer, like 25
-
      -
      -
      -
      -

      Query grouping

      -

      Query grouping allows you to create groups of WHERE clauses by enclosing them in parentheses. This will allow -you to create queries with complex WHERE clauses. Nested groups are supported. Example:

      -
      $this->db->select('*')->from('my_table')
-        ->group_start()
-                ->where('a', 'a')
-                ->or_group_start()
-                        ->where('b', 'b')
-                        ->where('c', 'c')
-                ->group_end()
-        ->group_end()
-        ->where('d', 'd')
-->get();
-
-// Generates:
-// SELECT * FROM (`my_table`) WHERE ( `a` = 'a' OR ( `b` = 'b' AND `c` = 'c' ) ) AND `d` = 'd'
-
      -
      -
      -

      Note

      -

      groups need to be balanced, make sure every group_start() is matched by a group_end().

      -
      -

      $this->db->group_start()

      -

      Starts a new group by adding an opening parenthesis to the WHERE clause of the query.

      -

      $this->db->or_group_start()

      -

      Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with ‘OR’.

      -

      $this->db->not_group_start()

      -

      Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with ‘NOT’.

      -

      $this->db->or_not_group_start()

      -

      Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with ‘OR NOT’.

      -

      $this->db->group_end()

      -

      Ends the current group by adding an closing parenthesis to the WHERE clause of the query.

      -
      -
      -

      Inserting Data

      -

      $this->db->insert()

      -

      Generates an insert string based on the data you supply, and runs the -query. You can either pass an array or an object to the -function. Here is an example using an array:

      -
      $data = array(
-        'title' => 'My title',
-        'name' => 'My Name',
-        'date' => 'My date'
-);
-
-$this->db->insert('mytable', $data);
-// Produces: INSERT INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date')
-
      -
      -

      The first parameter will contain the table name, the second is an -associative array of values.

      -

      Here is an example using an object:

      -
      /*
-class Myclass {
-        public $title = 'My Title';
-        public $content = 'My Content';
-        public $date = 'My Date';
-}
-*/
-
-$object = new Myclass;
-$this->db->insert('mytable', $object);
-// Produces: INSERT INTO mytable (title, content, date) VALUES ('My Title', 'My Content', 'My Date')
-
      -
      -

      The first parameter will contain the table name, the second is an -object.

      -
      -

      Note

      -

      All values are escaped automatically producing safer queries.

      -
      -

      $this->db->get_compiled_insert()

      -

      Compiles the insertion query just like $this->db->insert() but does not -run the query. This method simply returns the SQL query as a string.

      -

      Example:

      -
      $data = array(
-        'title' => 'My title',
-        'name'  => 'My Name',
-        'date'  => 'My date'
-);
-
-$sql = $this->db->set($data)->get_compiled_insert('mytable');
-echo $sql;
-
-// Produces string: INSERT INTO mytable (`title`, `name`, `date`) VALUES ('My title', 'My name', 'My date')
-
      -
      -

      The second parameter enables you to set whether or not the query builder query -will be reset (by default it will be–just like $this->db->insert()):

      -
      echo $this->db->set('title', 'My Title')->get_compiled_insert('mytable', FALSE);
-
-// Produces string: INSERT INTO mytable (`title`) VALUES ('My Title')
-
-echo $this->db->set('content', 'My Content')->get_compiled_insert();
-
-// Produces string: INSERT INTO mytable (`title`, `content`) VALUES ('My Title', 'My Content')
-
      -
      -

      The key thing to notice in the above example is that the second query did not -utlize $this->db->from() nor did it pass a table name into the first -parameter. The reason this worked is because the query has not been executed -using $this->db->insert() which resets values or reset directly using -$this->db->reset_query().

      -
      -

      Note

      -

      This method doesn’t work for batched inserts.

      -
      -

      $this->db->insert_batch()

      -

      Generates an insert string based on the data you supply, and runs the -query. You can either pass an array or an object to the -function. Here is an example using an array:

      -
      $data = array(
-        array(
-                'title' => 'My title',
-                'name' => 'My Name',
-                'date' => 'My date'
-        ),
-        array(
-                'title' => 'Another title',
-                'name' => 'Another Name',
-                'date' => 'Another date'
-        )
-);
-
-$this->db->insert_batch('mytable', $data);
-// Produces: INSERT INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date'),  ('Another title', 'Another name', 'Another date')
-
      -
      -

      The first parameter will contain the table name, the second is an -associative array of values.

      -
      -

      Note

      -

      All values are escaped automatically producing safer queries.

      -
      -
      -
      -

      Updating Data

      -

      $this->db->replace()

      -

      This method executes a REPLACE statement, which is basically the SQL -standard for (optional) DELETE + INSERT, using PRIMARY and UNIQUE -keys as the determining factor. -In our case, it will save you from the need to implement complex -logics with different combinations of select(), update(), -delete() and insert() calls.

      -

      Example:

      -
      $data = array(
-        'title' => 'My title',
-        'name'  => 'My Name',
-        'date'  => 'My date'
-);
-
-$this->db->replace('table', $data);
-
-// Executes: REPLACE INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date')
-
      -
      -

      In the above example, if we assume that the title field is our primary -key, then if a row containing ‘My title’ as the title value, that row -will be deleted with our new row data replacing it.

      -

      Usage of the set() method is also allowed and all fields are -automatically escaped, just like with insert().

      -

      $this->db->set()

      -

      This function enables you to set values for inserts or updates.

      -

      It can be used instead of passing a data array directly to the insert -or update functions:

      -
      $this->db->set('name', $name);
-$this->db->insert('mytable');  // Produces: INSERT INTO mytable (`name`) VALUES ('{$name}')
-
      -
      -

      If you use multiple function called they will be assembled properly -based on whether you are doing an insert or an update:

      -
      $this->db->set('name', $name);
-$this->db->set('title', $title);
-$this->db->set('status', $status);
-$this->db->insert('mytable');
-
      -
      -

      set() will also accept an optional third parameter ($escape), that -will prevent data from being escaped if set to FALSE. To illustrate the -difference, here is set() used both with and without the escape -parameter.

      -
      $this->db->set('field', 'field+1', FALSE);
-$this->db->where('id', 2);
-$this->db->update('mytable'); // gives UPDATE mytable SET field = field+1 WHERE id = 2
-
-$this->db->set('field', 'field+1');
-$this->db->where('id', 2);
-$this->db->update('mytable'); // gives UPDATE `mytable` SET `field` = 'field+1' WHERE `id` = 2
-
      -
      -

      You can also pass an associative array to this function:

      -
      $array = array(
-        'name' => $name,
-        'title' => $title,
-        'status' => $status
-);
-
-$this->db->set($array);
-$this->db->insert('mytable');
-
      -
      -

      Or an object:

      -
      /*
-class Myclass {
-        public $title = 'My Title';
-        public $content = 'My Content';
-        public $date = 'My Date';
-}
-*/
-
-$object = new Myclass;
-$this->db->set($object);
-$this->db->insert('mytable');
-
      -
      -

      $this->db->update()

      -

      Generates an update string and runs the query based on the data you -supply. You can pass an array or an object to the function. Here -is an example using an array:

      -
      $data = array(
-        'title' => $title,
-        'name' => $name,
-        'date' => $date
-);
-
-$this->db->where('id', $id);
-$this->db->update('mytable', $data);
-// Produces:
-//
-//      UPDATE mytable
-//      SET title = '{$title}', name = '{$name}', date = '{$date}'
-//      WHERE id = $id
-
      -
      -

      Or you can supply an object:

      -
      /*
-class Myclass {
-        public $title = 'My Title';
-        public $content = 'My Content';
-        public $date = 'My Date';
-}
-*/
-
-$object = new Myclass;
-$this->db->where('id', $id);
-$this->db->update('mytable', $object);
-// Produces:
-//
-// UPDATE `mytable`
-// SET `title` = '{$title}', `name` = '{$name}', `date` = '{$date}'
-// WHERE id = `$id`
-
      -
      -
      -

      Note

      -

      All values are escaped automatically producing safer queries.

      -
      -

      You’ll notice the use of the $this->db->where() function, enabling you -to set the WHERE clause. You can optionally pass this information -directly into the update function as a string:

      -
      $this->db->update('mytable', $data, "id = 4");
-
      -
      -

      Or as an array:

      -
      $this->db->update('mytable', $data, array('id' => $id));
-
      -
      -

      You may also use the $this->db->set() function described above when -performing updates.

      -

      $this->db->update_batch()

      -

      Generates an update string based on the data you supply, and runs the query. -You can either pass an array or an object to the function. -Here is an example using an array:

      -
      $data = array(
-   array(
-      'title' => 'My title' ,
-      'name' => 'My Name 2' ,
-      'date' => 'My date 2'
-   ),
-   array(
-      'title' => 'Another title' ,
-      'name' => 'Another Name 2' ,
-      'date' => 'Another date 2'
-   )
-);
-
-$this->db->update_batch('mytable', $data, 'title');
-
-// Produces:
-// UPDATE `mytable` SET `name` = CASE
-// WHEN `title` = 'My title' THEN 'My Name 2'
-// WHEN `title` = 'Another title' THEN 'Another Name 2'
-// ELSE `name` END,
-// `date` = CASE
-// WHEN `title` = 'My title' THEN 'My date 2'
-// WHEN `title` = 'Another title' THEN 'Another date 2'
-// ELSE `date` END
-// WHERE `title` IN ('My title','Another title')
-
      -
      -

      The first parameter will contain the table name, the second is an associative -array of values, the third parameter is the where key.

      -
      -

      Note

      -

      All values are escaped automatically producing safer queries.

      -
      -
      -

      Note

      -

      affected_rows() won’t give you proper results with this method, -due to the very nature of how it works. Instead, update_batch() -returns the number of rows affected.

      -
      -

      $this->db->get_compiled_update()

      -

      This works exactly the same way as $this->db->get_compiled_insert() except -that it produces an UPDATE SQL string instead of an INSERT SQL string.

      -

      For more information view documentation for $this->db->get_compiled_insert().

      -
      -

      Note

      -

      This method doesn’t work for batched updates.

      -
      -
      -
      -

      Deleting Data

      -

      $this->db->delete()

      -

      Generates a delete SQL string and runs the query.

      -
      $this->db->delete('mytable', array('id' => $id));  // Produces: // DELETE FROM mytable  // WHERE id = $id
-
      -
      -

      The first parameter is the table name, the second is the where clause. -You can also use the where() or or_where() functions instead of passing -the data to the second parameter of the function:

      -
      $this->db->where('id', $id);
-$this->db->delete('mytable');
-
-// Produces:
-// DELETE FROM mytable
-// WHERE id = $id
-
      -
      -

      An array of table names can be passed into delete() if you would like to -delete data from more than 1 table.

      -
      $tables = array('table1', 'table2', 'table3');
-$this->db->where('id', '5');
-$this->db->delete($tables);
-
      -
      -

      If you want to delete all data from a table, you can use the truncate() -function, or empty_table().

      -

      $this->db->empty_table()

      -

      Generates a delete SQL string and runs the -query.:

      -
      $this->db->empty_table('mytable'); // Produces: DELETE FROM mytable
-
      -
      -

      $this->db->truncate()

      -

      Generates a truncate SQL string and runs the query.

      -
      $this->db->from('mytable');
-$this->db->truncate();
-
-// or
-
-$this->db->truncate('mytable');
-
-// Produce:
-// TRUNCATE mytable
-
      -
      -
      -

      Note

      -

      If the TRUNCATE command isn’t available, truncate() will -execute as “DELETE FROM table”.

      -
      -

      $this->db->get_compiled_delete()

      -

      This works exactly the same way as $this->db->get_compiled_insert() except -that it produces a DELETE SQL string instead of an INSERT SQL string.

      -

      For more information view documentation for $this->db->get_compiled_insert().

      -
      -
      -

      Method Chaining

      -

      Method chaining allows you to simplify your syntax by connecting -multiple functions. Consider this example:

      -
      $query = $this->db->select('title')
-                ->where('id', $id)
-                ->limit(10, 20)
-                ->get('mytable');
-
      -
      -
      -
      -

      Query Builder Caching

      -

      While not “true” caching, Query Builder enables you to save (or “cache”) -certain parts of your queries for reuse at a later point in your -script’s execution. Normally, when an Query Builder call is completed, -all stored information is reset for the next call. With caching, you can -prevent this reset, and reuse information easily.

      -

      Cached calls are cumulative. If you make 2 cached select() calls, and -then 2 uncached select() calls, this will result in 4 select() calls. -There are three Caching functions available:

      -

      $this->db->start_cache()

      -

      This function must be called to begin caching. All Query Builder queries -of the correct type (see below for supported queries) are stored for -later use.

      -

      $this->db->stop_cache()

      -

      This function can be called to stop caching.

      -

      $this->db->flush_cache()

      -

      This function deletes all items from the Query Builder cache.

      -
      -

      An example of caching

      -

      Here’s a usage example:

      -
      $this->db->start_cache();
-$this->db->select('field1');
-$this->db->stop_cache();
-$this->db->get('tablename');
-//Generates: SELECT `field1` FROM (`tablename`)
-
-$this->db->select('field2');
-$this->db->get('tablename');
-//Generates:  SELECT `field1`, `field2` FROM (`tablename`)
-
-$this->db->flush_cache();
-$this->db->select('field2');
-$this->db->get('tablename');
-//Generates:  SELECT `field2` FROM (`tablename`)
-
      -
      -
      -

      Note

      -

      The following statements can be cached: select, from, join, -where, like, group_by, having, order_by

      -
      -
      -
      -
      -

      Resetting Query Builder

      -

      $this->db->reset_query()

      -

      Resetting Query Builder allows you to start fresh with your query without -executing it first using a method like $this->db->get() or $this->db->insert(). -Just like the methods that execute a query, this will not reset items you’ve -cached using Query Builder Caching.

      -

      This is useful in situations where you are using Query Builder to generate SQL -(ex. $this->db->get_compiled_select()) but then choose to, for instance, -run the query:

      -
      // Note that the second parameter of the get_compiled_select method is FALSE
-$sql = $this->db->select(array('field1','field2'))
-                                ->where('field3',5)
-                                ->get_compiled_select('mytable', FALSE);
-
-// ...
-// Do something crazy with the SQL code... like add it to a cron script for
-// later execution or something...
-// ...
-
-$data = $this->db->get()->result_array();
-
-// Would execute and return an array of results of the following query:
-// SELECT field1, field1 from mytable where field3 = 5;
-
      -
      -
      -

      Note

      -

      Double calls to get_compiled_select() while you’re using the -Query Builder Caching functionality and NOT resetting your queries -will results in the cache being merged twice. That in turn will -i.e. if you’re caching a select() - select the same field twice.

      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_DB_query_builder
      -
      -
      -reset_query()
      -
      --- - - - - - -
      Returns:CI_DB_query_builder instance (method chaining)
      Return type:CI_DB_query_builder
      -

      Resets the current Query Builder state. Useful when you want -to build a query that can be cancelled under certain conditions.

      -
      - -
      -
      -start_cache()
      -
      --- - - - - - -
      Returns:CI_DB_query_builder instance (method chaining)
      Return type:CI_DB_query_builder
      -

      Starts the Query Builder cache.

      -
      - -
      -
      -stop_cache()
      -
      --- - - - - - -
      Returns:CI_DB_query_builder instance (method chaining)
      Return type:CI_DB_query_builder
      -

      Stops the Query Builder cache.

      -
      - -
      -
      -flush_cache()
      -
      --- - - - - - -
      Returns:CI_DB_query_builder instance (method chaining)
      Return type:CI_DB_query_builder
      -

      Empties the Query Builder cache.

      -
      - -
      -
      -set_dbprefix([$prefix = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $prefix (string) – The new prefix to use
        • -
      -
      Returns:

      The DB prefix in use

      -
      Return type:

      string

      -
      -

      Sets the database prefix, without having to reconnect.

      -
      - -
      -
      -dbprefix([$table = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – The table name to prefix
        • -
      -
      Returns:

      The prefixed table name

      -
      Return type:

      string

      -
      -

      Prepends a database prefix, if one exists in configuration.

      -
      - -
      -
      -count_all_results([$table = ''[, $reset = TRUE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $reset (bool) – Whether to reset values for SELECTs
        • -
      -
      Returns:

      Number of rows in the query result

      -
      Return type:

      int

      -
      -

      Generates a platform-specific query string that counts -all records returned by an Query Builder query.

      -
      - -
      -
      -get([$table = ''[, $limit = NULL[, $offset = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – The table to query
        • -
      • $limit (int) – The LIMIT clause
        • -
      • $offset (int) – The OFFSET clause
        • -
      -
      Returns:

      CI_DB_result instance (method chaining)

      -
      Return type:

      CI_DB_result

      -
      -

      Compiles and runs SELECT statement based on the already -called Query Builder methods.

      -
      - -
      -
      -get_where([$table = ''[, $where = NULL[, $limit = NULL[, $offset = NULL]]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (mixed) – The table(s) to fetch data from; string or array
        • -
      • $where (string) – The WHERE clause
        • -
      • $limit (int) – The LIMIT clause
        • -
      • $offset (int) – The OFFSET clause
        • -
      -
      Returns:

      CI_DB_result instance (method chaining)

      -
      Return type:

      CI_DB_result

      -
      -

      Same as get(), but also allows the WHERE to be added directly.

      -
      - -
      -
      -select([$select = '*'[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $select (string) – The SELECT portion of a query
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a SELECT clause to a query.

      -
      - -
      -
      -select_avg([$select = ''[, $alias = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $select (string) – Field to compute the average of
        • -
      • $alias (string) – Alias for the resulting value name
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a SELECT AVG(field) clause to a query.

      -
      - -
      -
      -select_max([$select = ''[, $alias = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $select (string) – Field to compute the maximum of
        • -
      • $alias (string) – Alias for the resulting value name
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a SELECT MAX(field) clause to a query.

      -
      - -
      -
      -select_min([$select = ''[, $alias = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $select (string) – Field to compute the minimum of
        • -
      • $alias (string) – Alias for the resulting value name
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a SELECT MIN(field) clause to a query.

      -
      - -
      -
      -select_sum([$select = ''[, $alias = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $select (string) – Field to compute the sum of
        • -
      • $alias (string) – Alias for the resulting value name
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a SELECT SUM(field) clause to a query.

      -
      - -
      -
      -distinct([$val = TRUE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $val (bool) – Desired value of the “distinct” flag
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Sets a flag which tells the query builder to add -a DISTINCT clause to the SELECT portion of the query.

      -
      - -
      -
      -from($from)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $from (mixed) – Table name(s); string or array
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Specifies the FROM clause of a query.

      -
      - -
      -
      -join($table, $cond[, $type = ''[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name to join
        • -
      • $cond (string) – The JOIN ON condition
        • -
      • $type (string) – The JOIN type
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a JOIN clause to a query.

      -
      - -
      -
      -where($key[, $value = NULL[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Name of field to compare, or associative array
        • -
      • $value (mixed) – If a single key, compared to this value
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      DB_query_builder instance

      -
      Return type:

      object

      -
      -

      Generates the WHERE portion of the query. -Separates multiple calls with ‘AND’.

      -
      - -
      -
      -or_where($key[, $value = NULL[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Name of field to compare, or associative array
        • -
      • $value (mixed) – If a single key, compared to this value
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      DB_query_builder instance

      -
      Return type:

      object

      -
      -

      Generates the WHERE portion of the query. -Separates multiple calls with ‘OR’.

      -
      - -
      -
      -or_where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – The field to search
        • -
      • $values (array) – The values searched on
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      DB_query_builder instance

      -
      Return type:

      object

      -
      -

      Generates a WHERE field IN(‘item’, ‘item’) SQL query, -joined with ‘OR’ if appropriate.

      -
      - -
      -
      -or_where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – The field to search
        • -
      • $values (array) – The values searched on
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      DB_query_builder instance

      -
      Return type:

      object

      -
      -

      Generates a WHERE field NOT IN(‘item’, ‘item’) SQL query, -joined with ‘OR’ if appropriate.

      -
      - -
      -
      -where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Name of field to examine
        • -
      • $values (array) – Array of target values
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      DB_query_builder instance

      -
      Return type:

      object

      -
      -

      Generates a WHERE field IN(‘item’, ‘item’) SQL query, -joined with ‘AND’ if appropriate.

      -
      - -
      -
      -where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Name of field to examine
        • -
      • $values (array) – Array of target values
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      DB_query_builder instance

      -
      Return type:

      object

      -
      -

      Generates a WHERE field NOT IN(‘item’, ‘item’) SQL query, -joined with ‘AND’ if appropriate.

      -
      - -
      -
      -group_start()
      -
      --- - - - - - -
      Returns:CI_DB_query_builder instance (method chaining)
      Return type:CI_DB_query_builder
      -

      Starts a group expression, using ANDs for the conditions inside it.

      -
      - -
      -
      -or_group_start()
      -
      --- - - - - - -
      Returns:CI_DB_query_builder instance (method chaining)
      Return type:CI_DB_query_builder
      -

      Starts a group expression, using ORs for the conditions inside it.

      -
      - -
      -
      -not_group_start()
      -
      --- - - - - - -
      Returns:CI_DB_query_builder instance (method chaining)
      Return type:CI_DB_query_builder
      -

      Starts a group expression, using AND NOTs for the conditions inside it.

      -
      - -
      -
      -or_not_group_start()
      -
      --- - - - - - -
      Returns:CI_DB_query_builder instance (method chaining)
      Return type:CI_DB_query_builder
      -

      Starts a group expression, using OR NOTs for the conditions inside it.

      -
      - -
      -
      -group_end()
      -
      --- - - - - - -
      Returns:DB_query_builder instance
      Return type:object
      -

      Ends a group expression.

      -
      - -
      -
      -like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $match (string) – Text portion to match
        • -
      • $side (string) – Which side of the expression to put the ‘%’ wildcard on
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a LIKE clause to a query, separating multiple calls with AND.

      -
      - -
      -
      -or_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $match (string) – Text portion to match
        • -
      • $side (string) – Which side of the expression to put the ‘%’ wildcard on
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a LIKE clause to a query, separating multiple class with OR.

      -
      - -
      -
      -not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $match (string) – Text portion to match
        • -
      • $side (string) – Which side of the expression to put the ‘%’ wildcard on
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a NOT LIKE clause to a query, separating multiple calls with AND.

      -
      - -
      -
      -or_not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $match (string) – Text portion to match
        • -
      • $side (string) – Which side of the expression to put the ‘%’ wildcard on
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a NOT LIKE clause to a query, separating multiple calls with OR.

      -
      - -
      -
      -having($key[, $value = NULL[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Identifier (string) or associative array of field/value pairs
        • -
      • $value (string) – Value sought if $key is an identifier
        • -
      • $escape (string) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a HAVING clause to a query, separating multiple calls with AND.

      -
      - -
      -
      -or_having($key[, $value = NULL[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Identifier (string) or associative array of field/value pairs
        • -
      • $value (string) – Value sought if $key is an identifier
        • -
      • $escape (string) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a HAVING clause to a query, separating multiple calls with OR.

      -
      - -
      -
      -group_by($by[, $escape = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $by (mixed) – Field(s) to group by; string or array
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds a GROUP BY clause to a query.

      -
      - -
      -
      -order_by($orderby[, $direction = ''[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $orderby (string) – Field to order by
        • -
      • $direction (string) – The order requested - ASC, DESC or random
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds an ORDER BY clause to a query.

      -
      - -
      -
      -limit($value[, $offset = 0])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $value (int) – Number of rows to limit the results to
        • -
      • $offset (int) – Number of rows to skip
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds LIMIT and OFFSET clauses to a query.

      -
      - -
      -
      -offset($offset)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $offset (int) – Number of rows to skip
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds an OFFSET clause to a query.

      -
      - -
      -
      -set($key[, $value = ''[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Field name, or an array of field/value pairs
        • -
      • $value (string) – Field value, if $key is a single field
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds field/value pairs to be passed later to insert(), -update() or replace().

      -
      - -
      -
      -insert([$table = ''[, $set = NULL[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $set (array) – An associative array of field/value pairs
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Compiles and executes an INSERT statement.

      -
      - -
      -
      -insert_batch([$table = ''[, $set = NULL[, $escape = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $set (array) – Data to insert
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      Number of rows inserted or FALSE on failure

      -
      Return type:

      mixed

      -
      -

      Compiles and executes batch INSERT statements.

      -
      - -
      -
      -set_insert_batch($key[, $value = ''[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Field name or an array of field/value pairs
        • -
      • $value (string) – Field value, if $key is a single field
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds field/value pairs to be inserted in a table later via insert_batch().

      -
      - -
      -
      -update([$table = ''[, $set = NULL[, $where = NULL[, $limit = NULL]]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $set (array) – An associative array of field/value pairs
        • -
      • $where (string) – The WHERE clause
        • -
      • $limit (int) – The LIMIT clause
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Compiles and executes an UPDATE statement.

      -
      - -
      -
      -update_batch([$table = ''[, $set = NULL[, $value = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $set (array) – Field name, or an associative array of field/value pairs
        • -
      • $value (string) – Field value, if $set is a single field
        • -
      -
      Returns:

      Number of rows updated or FALSE on failure

      -
      Return type:

      mixed

      -
      -

      Compiles and executes batch UPDATE statements.

      -
      - -
      -
      -set_update_batch($key[, $value = ''[, $escape = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Field name or an array of field/value pairs
        • -
      • $value (string) – Field value, if $key is a single field
        • -
      • $escape (bool) – Whether to escape values and identifiers
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining)

      -
      Return type:

      CI_DB_query_builder

      -
      -

      Adds field/value pairs to be updated in a table later via update_batch().

      -
      - -
      -
      -replace([$table = ''[, $set = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $set (array) – An associative array of field/value pairs
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Compiles and executes a REPLACE statement.

      -
      - -
      -
      -delete([$table = ''[, $where = ''[, $limit = NULL[, $reset_data = TRUE]]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (mixed) – The table(s) to delete from; string or array
        • -
      • $where (string) – The WHERE clause
        • -
      • $limit (int) – The LIMIT clause
        • -
      • $reset_data (bool) – TRUE to reset the query “write” clause
        • -
      -
      Returns:

      CI_DB_query_builder instance (method chaining) or FALSE on failure

      -
      Return type:

      mixed

      -
      -

      Compiles and executes a DELETE query.

      -
      - -
      -
      -truncate([$table = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Executes a TRUNCATE statement on a table.

      -
      -

      Note

      -

      If the database platform in use doesn’t support TRUNCATE, -a DELETE statement will be used instead.

      -
      -
      - -
      -
      -empty_table([$table = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Deletes all records from a table via a DELETE statement.

      -
      - -
      -
      -get_compiled_select([$table = ''[, $reset = TRUE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $reset (bool) – Whether to reset the current QB values or not
        • -
      -
      Returns:

      The compiled SQL statement as a string

      -
      Return type:

      string

      -
      -

      Compiles a SELECT statement and returns it as a string.

      -
      - -
      -
      -get_compiled_insert([$table = ''[, $reset = TRUE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $reset (bool) – Whether to reset the current QB values or not
        • -
      -
      Returns:

      The compiled SQL statement as a string

      -
      Return type:

      string

      -
      -

      Compiles an INSERT statement and returns it as a string.

      -
      - -
      -
      -get_compiled_update([$table = ''[, $reset = TRUE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $reset (bool) – Whether to reset the current QB values or not
        • -
      -
      Returns:

      The compiled SQL statement as a string

      -
      Return type:

      string

      -
      -

      Compiles an UPDATE statement and returns it as a string.

      -
      - -
      -
      -get_compiled_delete([$table = ''[, $reset = TRUE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table (string) – Table name
        • -
      • $reset (bool) – Whether to reset the current QB values or not
        • -
      -
      Returns:

      The compiled SQL statement as a string

      -
      Return type:

      string

      -
      -

      Compiles a DELETE statement and returns it as a string.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/results.html b/user_guide/database/results.html deleted file mode 100755 index 54ba241..0000000 --- a/user_guide/database/results.html +++ /dev/null @@ -1,1232 +0,0 @@ - - - - - - - - - - Generating Query Results — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Generating Query Results

      -

      There are several ways to generate query results:

      - -
      -

      Result Arrays

      -

      result()

      -

      This method returns the query result as an array of objects, or -an empty array on failure. Typically you’ll use this in a foreach -loop, like this:

      -
      $query = $this->db->query("YOUR QUERY");
-
-foreach ($query->result() as $row)
-{
-        echo $row->title;
-        echo $row->name;
-        echo $row->body;
-}
-
      -
      -

      The above method is an alias of result_object().

      -

      You can also pass a string to result() which represents a class to -instantiate for each result object (note: this class must be loaded)

      -
      $query = $this->db->query("SELECT * FROM users;");
-
-foreach ($query->result('User') as $user)
-{
-        echo $user->name; // access attributes
-        echo $user->reverse_name(); // or methods defined on the 'User' class
-}
-
      -
      -

      result_array()

      -

      This method returns the query result as a pure array, or an empty -array when no result is produced. Typically you’ll use this in a foreach -loop, like this:

      -
      $query = $this->db->query("YOUR QUERY");
-
-foreach ($query->result_array() as $row)
-{
-        echo $row['title'];
-        echo $row['name'];
-        echo $row['body'];
-}
-
      -
      -
      -
      -

      Result Rows

      -

      row()

      -

      This method returns a single result row. If your query has more than -one row, it returns only the first row. The result is returned as an -object. Here’s a usage example:

      -
      $query = $this->db->query("YOUR QUERY");
-
-$row = $query->row();
-
-if (isset($row))
-{
-        echo $row->title;
-        echo $row->name;
-        echo $row->body;
-}
-
      -
      -

      If you want a specific row returned you can submit the row number as a -digit in the first parameter:

      -
      $row = $query->row(5);
-
      -
      -

      You can also add a second String parameter, which is the name of a class -to instantiate the row with:

      -
      $query = $this->db->query("SELECT * FROM users LIMIT 1;");
-$row = $query->row(0, 'User');
-
-echo $row->name; // access attributes
-echo $row->reverse_name(); // or methods defined on the 'User' class
-
      -
      -

      row_array()

      -

      Identical to the above row() method, except it returns an array. -Example:

      -
      $query = $this->db->query("YOUR QUERY");
-
-$row = $query->row_array();
-
-if (isset($row))
-{
-        echo $row['title'];
-        echo $row['name'];
-        echo $row['body'];
-}
-
      -
      -

      If you want a specific row returned you can submit the row number as a -digit in the first parameter:

      -
      $row = $query->row_array(5);
-
      -
      -

      In addition, you can walk forward/backwards/first/last through your -results using these variations:

      -
      -
      -
      $row = $query->first_row()
      -
      $row = $query->last_row()
      -
      $row = $query->next_row()
      -
      $row = $query->previous_row()
      -
      -
      -

      By default they return an object unless you put the word “array” in the -parameter:

      -
      -
      -
      $row = $query->first_row(‘array’)
      -
      $row = $query->last_row(‘array’)
      -
      $row = $query->next_row(‘array’)
      -
      $row = $query->previous_row(‘array’)
      -
      -
      -
      -

      Note

      -

      All the methods above will load the whole result into memory -(prefetching). Use unbuffered_row() for processing large -result sets.

      -
      -

      unbuffered_row()

      -

      This method returns a single result row without prefetching the whole -result in memory as row() does. If your query has more than one row, -it returns the current row and moves the internal data pointer ahead.

      -
      $query = $this->db->query("YOUR QUERY");
-
-while ($row = $query->unbuffered_row())
-{
-        echo $row->title;
-        echo $row->name;
-        echo $row->body;
-}
-
      -
      -

      You can optionally pass ‘object’ (default) or ‘array’ in order to specify -the returned value’s type:

      -
      $query->unbuffered_row();               // object
-$query->unbuffered_row('object');       // object
-$query->unbuffered_row('array');        // associative array
-
      -
      -
      -
      -

      Custom Result Objects

      -

      You can have the results returned as an instance of a custom class instead -of a stdClass or array, as the result() and result_array() -methods allow. This requires that the class is already loaded into memory. -The object will have all values returned from the database set as properties. -If these have been declared and are non-public then you should provide a -__set() method to allow them to be set.

      -

      Example:

      -
      class User {
-
-        public $id;
-        public $email;
-        public $username;
-
-        protected $last_login;
-
-        public function last_login($format)
-        {
-                return $this->last_login->format($format);
-        }
-
-        public function __set($name, $value)
-        {
-                if ($name === 'last_login')
-                {
-                        $this->last_login = DateTime::createFromFormat('U', $value);
-                }
-        }
-
-        public function __get($name)
-        {
-                if (isset($this->$name))
-                {
-                        return $this->$name;
-                }
-        }
-}
-
      -
      -

      In addition to the two methods listed below, the following methods also can -take a class name to return the results as: first_row(), last_row(), -next_row(), and previous_row().

      -

      custom_result_object()

      -

      Returns the entire result set as an array of instances of the class requested. -The only parameter is the name of the class to instantiate.

      -

      Example:

      -
      $query = $this->db->query("YOUR QUERY");
-
-$rows = $query->custom_result_object('User');
-
-foreach ($rows as $row)
-{
-        echo $row->id;
-        echo $row->email;
-        echo $row->last_login('Y-m-d');
-}
-
      -
      -

      custom_row_object()

      -

      Returns a single row from your query results. The first parameter is the row -number of the results. The second parameter is the class name to instantiate.

      -

      Example:

      -
      $query = $this->db->query("YOUR QUERY");
-
-$row = $query->custom_row_object(0, 'User');
-
-if (isset($row))
-{
-        echo $row->email;   // access attributes
-        echo $row->last_login('Y-m-d');   // access class methods
-}
-
      -
      -

      You can also use the row() method in exactly the same way.

      -

      Example:

      -
      $row = $query->custom_row_object(0, 'User');
-
      -
      -
      -
      -

      Result Helper Methods

      -

      num_rows()

      -

      The number of rows returned by the query. Note: In this example, $query -is the variable that the query result object is assigned to:

      -
      $query = $this->db->query('SELECT * FROM my_table');
-
-echo $query->num_rows();
-
      -
      -
      -

      Note

      -

      Not all database drivers have a native way of getting the total -number of rows for a result set. When this is the case, all of -the data is prefetched and count() is manually called on the -resulting array in order to achieve the same result.

      -
      -

      num_fields()

      -

      The number of FIELDS (columns) returned by the query. Make sure to call -the method using your query result object:

      -
      $query = $this->db->query('SELECT * FROM my_table');
-
-echo $query->num_fields();
-
      -
      -

      free_result()

      -

      It frees the memory associated with the result and deletes the result -resource ID. Normally PHP frees its memory automatically at the end of -script execution. However, if you are running a lot of queries in a -particular script you might want to free the result after each query -result has been generated in order to cut down on memory consumption.

      -

      Example:

      -
      $query = $this->db->query('SELECT title FROM my_table');
-
-foreach ($query->result() as $row)
-{
-        echo $row->title;
-}
-
-$query->free_result();  // The $query result object will no longer be available
-
-$query2 = $this->db->query('SELECT name FROM some_table');
-
-$row = $query2->row();
-echo $row->name;
-$query2->free_result(); // The $query2 result object will no longer be available
-
      -
      -

      data_seek()

      -

      This method sets the internal pointer for the next result row to be -fetched. It is only useful in combination with unbuffered_row().

      -

      It accepts a positive integer value, which defaults to 0 and returns -TRUE on success or FALSE on failure.

      -
      $query = $this->db->query('SELECT `field_name` FROM `table_name`');
-$query->data_seek(5); // Skip the first 5 rows
-$row = $query->unbuffered_row();
-
      -
      -
      -

      Note

      -

      Not all database drivers support this feature and will return FALSE. -Most notably - you won’t be able to use it with PDO.

      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_DB_result
      -
      -
      -result([$type = 'object'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $type (string) – Type of requested results - array, object, or class name
        • -
      -
      Returns:

      Array containing the fetched rows

      -
      Return type:

      array

      -
      -

      A wrapper for the result_array(), result_object() -and custom_result_object() methods.

      -

      Usage: see Result Arrays.

      -
      - -
      -
      -result_array()
      -
      --- - - - - - -
      Returns:Array containing the fetched rows
      Return type:array
      -

      Returns the query results as an array of rows, where each -row is itself an associative array.

      -

      Usage: see Result Arrays.

      -
      - -
      -
      -result_object()
      -
      --- - - - - - -
      Returns:Array containing the fetched rows
      Return type:array
      -

      Returns the query results as an array of rows, where each -row is an object of type stdClass.

      -

      Usage: see Result Arrays.

      -
      - -
      -
      -custom_result_object($class_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $class_name (string) – Class name for the resulting rows
        • -
      -
      Returns:

      Array containing the fetched rows

      -
      Return type:

      array

      -
      -

      Returns the query results as an array of rows, where each -row is an instance of the specified class.

      -
      - -
      -
      -row([$n = 0[, $type = 'object']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Index of the query results row to be returned
        • -
      • $type (string) – Type of the requested result - array, object, or class name
        • -
      -
      Returns:

      The requested row or NULL if it doesn’t exist

      -
      Return type:

      mixed

      -
      -

      A wrapper for the row_array(), row_object() and -``custom_row_object() methods.

      -

      Usage: see Result Rows.

      -
      - -
      -
      -unbuffered_row([$type = 'object'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $type (string) – Type of the requested result - array, object, or class name
        • -
      -
      Returns:

      Next row from the result set or NULL if it doesn’t exist

      -
      Return type:

      mixed

      -
      -

      Fetches the next result row and returns it in the -requested form.

      -

      Usage: see Result Rows.

      -
      - -
      -
      -row_array([$n = 0])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Index of the query results row to be returned
        • -
      -
      Returns:

      The requested row or NULL if it doesn’t exist

      -
      Return type:

      array

      -
      -

      Returns the requested result row as an associative array.

      -

      Usage: see Result Rows.

      -
      - -
      -
      -row_object([$n = 0])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Index of the query results row to be returned
        • -
      -
      Returns:

      The requested row or NULL if it doesn’t exist

      -
      Return type:

      stdClass

      -
      -

      Returns the requested result row as an object of type -stdClass.

      -

      Usage: see Result Rows.

      -
      - -
      -
      -custom_row_object($n, $type)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Index of the results row to return
        • -
      • $class_name (string) – Class name for the resulting row
        • -
      -
      Returns:

      The requested row or NULL if it doesn’t exist

      -
      Return type:

      $type

      -
      -

      Returns the requested result row as an instance of the -requested class.

      -
      - -
      -
      -data_seek([$n = 0])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Index of the results row to be returned next
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Moves the internal results row pointer to the desired offset.

      -

      Usage: see Result Helper Methods.

      -
      - -
      -
      -set_row($key[, $value = NULL])
      -
      --- - - - - - -
      Parameters:
        -
      • $key (mixed) – Column name or array of key/value pairs
        • -
      • $value (mixed) – Value to assign to the column, $key is a single field name
        • -
      -
      Return type:

      void

      -
      -

      Assigns a value to a particular column.

      -
      - -
      -
      -next_row([$type = 'object'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $type (string) – Type of the requested result - array, object, or class name
        • -
      -
      Returns:

      Next row of result set, or NULL if it doesn’t exist

      -
      Return type:

      mixed

      -
      -

      Returns the next row from the result set.

      -
      - -
      -
      -previous_row([$type = 'object'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $type (string) – Type of the requested result - array, object, or class name
        • -
      -
      Returns:

      Previous row of result set, or NULL if it doesn’t exist

      -
      Return type:

      mixed

      -
      -

      Returns the previous row from the result set.

      -
      - -
      -
      -first_row([$type = 'object'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $type (string) – Type of the requested result - array, object, or class name
        • -
      -
      Returns:

      First row of result set, or NULL if it doesn’t exist

      -
      Return type:

      mixed

      -
      -

      Returns the first row from the result set.

      -
      - -
      -
      -last_row([$type = 'object'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $type (string) – Type of the requested result - array, object, or class name
        • -
      -
      Returns:

      Last row of result set, or NULL if it doesn’t exist

      -
      Return type:

      mixed

      -
      -

      Returns the last row from the result set.

      -
      - -
      -
      -num_rows()
      -
      --- - - - - - -
      Returns:Number of rows in the result set
      Return type:int
      -

      Returns the number of rows in the result set.

      -

      Usage: see Result Helper Methods.

      -
      - -
      -
      -num_fields()
      -
      --- - - - - - -
      Returns:Number of fields in the result set
      Return type:int
      -

      Returns the number of fields in the result set.

      -

      Usage: see Result Helper Methods.

      -
      - -
      -
      -field_data()
      -
      --- - - - - - -
      Returns:Array containing field meta-data
      Return type:array
      -

      Generates an array of stdClass objects containing -field meta-data.

      -
      - -
      -
      -free_result()
      -
      --- - - - -
      Return type:void
      -

      Frees a result set.

      -

      Usage: see Result Helper Methods.

      -
      - -
      -
      -list_fields()
      -
      --- - - - - - -
      Returns:Array of column names
      Return type:array
      -

      Returns an array containing the field names in the -result set.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/transactions.html b/user_guide/database/transactions.html deleted file mode 100755 index 0cb42c9..0000000 --- a/user_guide/database/transactions.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - - - - - - - Transactions — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Transactions

      -

      CodeIgniter’s database abstraction allows you to use transactions with -databases that support transaction-safe table types. In MySQL, you’ll -need to be running InnoDB or BDB table types rather than the more common -MyISAM. Most other database platforms support transactions natively.

      -

      If you are not familiar with transactions we recommend you find a good -online resource to learn about them for your particular database. The -information below assumes you have a basic understanding of -transactions.

      -
      -

      CodeIgniter’s Approach to Transactions

      -

      CodeIgniter utilizes an approach to transactions that is very similar to -the process used by the popular database class ADODB. We’ve chosen that -approach because it greatly simplifies the process of running -transactions. In most cases all that is required are two lines of code.

      -

      Traditionally, transactions have required a fair amount of work to -implement since they demand that you keep track of your queries and -determine whether to commit or rollback based on the success or failure -of your queries. This is particularly cumbersome with nested queries. In -contrast, we’ve implemented a smart transaction system that does all -this for you automatically (you can also manage your transactions -manually if you choose to, but there’s really no benefit).

      -
      -
      -

      Running Transactions

      -

      To run your queries using transactions you will use the -$this->db->trans_start() and $this->db->trans_complete() functions as -follows:

      -
      $this->db->trans_start();
-$this->db->query('AN SQL QUERY...');
-$this->db->query('ANOTHER QUERY...');
-$this->db->query('AND YET ANOTHER QUERY...');
-$this->db->trans_complete();
-
      -
      -

      You can run as many queries as you want between the start/complete -functions and they will all be committed or rolled back based on success -or failure of any given query.

      -
      -
      -

      Strict Mode

      -

      By default CodeIgniter runs all transactions in Strict Mode. When strict -mode is enabled, if you are running multiple groups of transactions, if -one group fails all groups will be rolled back. If strict mode is -disabled, each group is treated independently, meaning a failure of one -group will not affect any others.

      -

      Strict Mode can be disabled as follows:

      -
      $this->db->trans_strict(FALSE);
-
      -
      -
      -
      -

      Managing Errors

      -

      If you have error reporting enabled in your config/database.php file -you’ll see a standard error message if the commit was unsuccessful. If -debugging is turned off, you can manage your own errors like this:

      -
      $this->db->trans_start();
-$this->db->query('AN SQL QUERY...');
-$this->db->query('ANOTHER QUERY...');
-$this->db->trans_complete();
-
-if ($this->db->trans_status() === FALSE)
-{
-        // generate an error... or use the log_message() function to log your error
-}
-
      -
      -
      -
      -

      Enabling Transactions

      -

      Transactions are enabled automatically the moment you use -$this->db->trans_start(). If you would like to disable transactions you -can do so using $this->db->trans_off():

      -
      $this->db->trans_off();
-
-$this->db->trans_start();
-$this->db->query('AN SQL QUERY...');
-$this->db->trans_complete();
-
      -
      -

      When transactions are disabled, your queries will be auto-commited, just -as they are when running queries without transactions.

      -
      -
      -

      Test Mode

      -

      You can optionally put the transaction system into “test mode”, which -will cause your queries to be rolled back – even if the queries produce -a valid result. To use test mode simply set the first parameter in the -$this->db->trans_start() function to TRUE:

      -
      $this->db->trans_start(TRUE); // Query will be rolled back
-$this->db->query('AN SQL QUERY...');
-$this->db->trans_complete();
-
      -
      -
      -
      -

      Running Transactions Manually

      -

      If you would like to run transactions manually you can do so as follows:

      -
      $this->db->trans_begin();
-
-$this->db->query('AN SQL QUERY...');
-$this->db->query('ANOTHER QUERY...');
-$this->db->query('AND YET ANOTHER QUERY...');
-
-if ($this->db->trans_status() === FALSE)
-{
-        $this->db->trans_rollback();
-}
-else
-{
-        $this->db->trans_commit();
-}
-
      -
      -
      -

      Note

      -

      Make sure to use $this->db->trans_begin() when running manual -transactions, NOT $this->db->trans_start().

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/database/utilities.html b/user_guide/database/utilities.html deleted file mode 100755 index 27778cf..0000000 --- a/user_guide/database/utilities.html +++ /dev/null @@ -1,994 +0,0 @@ - - - - - - - - - - Database Utility Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Database Utility Class

      -

      The Database Utility Class contains methods that help you manage your -database.

      - -
      -

      Initializing the Utility Class

      -
      -

      Important

      -

      In order to initialize the Utility class, your database -driver must already be running, since the utilities class relies on it.

      -
      -

      Load the Utility Class as follows:

      -
      $this->load->dbutil();
-
      -
      -

      You can also pass another database object to the DB Utility loader, in case -the database you want to manage isn’t the default one:

      -
      $this->myutil = $this->load->dbutil($this->other_db, TRUE);
-
      -
      -

      In the above example, we’re passing a custom database object as the first -parameter and then tell it to return the dbutil object, instead of -assigning it directly to $this->dbutil.

      -
      -

      Note

      -

      Both of the parameters can be used individually, just pass an empty -value as the first one if you wish to skip it.

      -
      -

      Once initialized you will access the methods using the $this->dbutil -object:

      -
      $this->dbutil->some_method();
-
      -
      -
      -
      -

      Using the Database Utilities

      -
      -

      Retrieve list of database names

      -

      Returns an array of database names:

      -
      $dbs = $this->dbutil->list_databases();
-
-foreach ($dbs as $db)
-{
-        echo $db;
-}
-
      -
      -
      -
      -

      Determine If a Database Exists

      -

      Sometimes it’s helpful to know whether a particular database exists. -Returns a boolean TRUE/FALSE. Usage example:

      -
      if ($this->dbutil->database_exists('database_name'))
-{
-        // some code...
-}
-
      -
      -
      -

      Note

      -

      Replace database_name with the name of the database you are -looking for. This method is case sensitive.

      -
      -
      -
      -

      Optimize a Table

      -

      Permits you to optimize a table using the table name specified in the -first parameter. Returns TRUE/FALSE based on success or failure:

      -
      if ($this->dbutil->optimize_table('table_name'))
-{
-        echo 'Success!';
-}
-
      -
      -
      -

      Note

      -

      Not all database platforms support table optimization. It is -mostly for use with MySQL.

      -
      -
      -
      -

      Repair a Table

      -

      Permits you to repair a table using the table name specified in the -first parameter. Returns TRUE/FALSE based on success or failure:

      -
      if ($this->dbutil->repair_table('table_name'))
-{
-        echo 'Success!';
-}
-
      -
      -
      -

      Note

      -

      Not all database platforms support table repairs.

      -
      -
      -
      -

      Optimize a Database

      -

      Permits you to optimize the database your DB class is currently -connected to. Returns an array containing the DB status messages or -FALSE on failure.

      -
      $result = $this->dbutil->optimize_database();
-
-if ($result !== FALSE)
-{
-        print_r($result);
-}
-
      -
      -
      -

      Note

      -

      Not all database platforms support database optimization. It -it is mostly for use with MySQL.

      -
      -
      -
      -

      Export a Query Result as a CSV File

      -

      Permits you to generate a CSV file from a query result. The first -parameter of the method must contain the result object from your -query. Example:

      -
      $this->load->dbutil();
-
-$query = $this->db->query("SELECT * FROM mytable");
-
-echo $this->dbutil->csv_from_result($query);
-
      -
      -

      The second, third, and fourth parameters allow you to set the delimiter -newline, and enclosure characters respectively. By default commas are -used as the delimiter, “n” is used as a new line, and a double-quote -is used as the enclosure. Example:

      -
      $delimiter = ",";
-$newline = "\r\n";
-$enclosure = '"';
-
-echo $this->dbutil->csv_from_result($query, $delimiter, $newline, $enclosure);
-
      -
      -
      -

      Important

      -

      This method will NOT write the CSV file for you. It -simply creates the CSV layout. If you need to write the file -use the File Helper.

      -
      -
      -
      -

      Export a Query Result as an XML Document

      -

      Permits you to generate an XML file from a query result. The first -parameter expects a query result object, the second may contain an -optional array of config parameters. Example:

      -
      $this->load->dbutil();
-
-$query = $this->db->query("SELECT * FROM mytable");
-
-$config = array (
-        'root'          => 'root',
-        'element'       => 'element',
-        'newline'       => "\n",
-        'tab'           => "\t"
-);
-
-echo $this->dbutil->xml_from_result($query, $config);
-
      -
      -
      -

      Important

      -

      This method will NOT write the XML file for you. It -simply creates the XML layout. If you need to write the file -use the File Helper.

      -
      -
      -
      -
      -

      Backup Your Database

      -
      -

      Database Backup Notes

      -

      Permits you to backup your full database or individual tables. The -backup data can be compressed in either Zip or Gzip format.

      -
      -

      Note

      -

      This feature is only available for MySQL and Interbase/Firebird databases.

      -
      -
      -

      Note

      -

      For Interbase/Firebird databases, the backup file name is the only parameter.

      -

      $this->dbutil->backup(‘db_backup_filename’);

      -
      -
      -

      Note

      -

      Due to the limited execution time and memory available to PHP, -backing up very large databases may not be possible. If your database is -very large you might need to backup directly from your SQL server via -the command line, or have your server admin do it for you if you do not -have root privileges.

      -
      -
      -
      -

      Usage Example

      -
      // Load the DB utility class
-$this->load->dbutil();
-
-// Backup your entire database and assign it to a variable
-$backup = $this->dbutil->backup();
-
-// Load the file helper and write the file to your server
-$this->load->helper('file');
-write_file('/path/to/mybackup.gz', $backup);
-
-// Load the download helper and send the file to your desktop
-$this->load->helper('download');
-force_download('mybackup.gz', $backup);
-
      -
      -
      -
      -

      Setting Backup Preferences

      -

      Backup preferences are set by submitting an array of values to the first -parameter of the backup() method. Example:

      -
      $prefs = array(
-        'tables'        => array('table1', 'table2'),   // Array of tables to backup.
-        'ignore'        => array(),                     // List of tables to omit from the backup
-        'format'        => 'txt',                       // gzip, zip, txt
-        'filename'      => 'mybackup.sql',              // File name - NEEDED ONLY WITH ZIP FILES
-        'add_drop'      => TRUE,                        // Whether to add DROP TABLE statements to backup file
-        'add_insert'    => TRUE,                        // Whether to add INSERT data to backup file
-        'newline'       => "\n"                         // Newline character used in backup file
-);
-
-$this->dbutil->backup($prefs);
-
      -
      -
      -
      -

      Description of Backup Preferences

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefault ValueOptionsDescription
      tablesempty arrayNoneAn array of tables you want backed up. If left blank all tables will be -exported.
      ignoreempty arrayNoneAn array of tables you want the backup routine to ignore.
      formatgzipgzip, zip, txtThe file format of the export file.
      filenamethe current date/timeNoneThe name of the backed-up file. The name is needed only if you are using -zip compression.
      add_dropTRUETRUE/FALSEWhether to include DROP TABLE statements in your SQL export file.
      add_insertTRUETRUE/FALSEWhether to include INSERT statements in your SQL export file.
      newline“\n”“\n”, “\r”, “\r\n”Type of newline to use in your SQL export file.
      foreign_key_checksTRUETRUE/FALSEWhether output should keep foreign key checks enabled.
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_DB_utility
      -
      -
      -backup([$params = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $params (array) – An associative array of options
        • -
      -
      Returns:

      raw/(g)zipped SQL query string

      -
      Return type:

      string

      -
      -

      Perform a database backup, per user preferences.

      -
      - -
      -
      -database_exists($database_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $database_name (string) – Database name
        • -
      -
      Returns:

      TRUE if the database exists, FALSE otherwise

      -
      Return type:

      bool

      -
      -

      Check for the existence of a database.

      -
      - -
      -
      -list_databases()
      -
      --- - - - - - -
      Returns:Array of database names found
      Return type:array
      -

      Retrieve a list of all the database names.

      -
      - -
      -
      -optimize_database()
      -
      --- - - - - - -
      Returns:Array of optimization messages or FALSE on failure
      Return type:array
      -

      Optimizes the database.

      -
      - -
      -
      -optimize_table($table_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table_name (string) – Name of the table to optimize
        • -
      -
      Returns:

      Array of optimization messages or FALSE on failure

      -
      Return type:

      array

      -
      -

      Optimizes a database table.

      -
      - -
      -
      -repair_table($table_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table_name (string) – Name of the table to repair
        • -
      -
      Returns:

      Array of repair messages or FALSE on failure

      -
      Return type:

      array

      -
      -

      Repairs a database table.

      -
      - -
      -
      -csv_from_result($query[, $delim = ', '[, $newline = "n"[, $enclosure = '"']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $query (object) – A database result object
        • -
      • $delim (string) – The CSV field delimiter to use
        • -
      • $newline (string) – The newline character to use
        • -
      • $enclosure (string) – The enclosure delimiter to use
        • -
      -
      Returns:

      The generated CSV file as a string

      -
      Return type:

      string

      -
      -

      Translates a database result object into a CSV document.

      -
      - -
      -
      -xml_from_result($query[, $params = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $query (object) – A database result object
        • -
      • $params (array) – An associative array of preferences
        • -
      -
      Returns:

      The generated XML document as a string

      -
      Return type:

      string

      -
      -

      Translates a database result object into an XML document.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/documentation/index.html b/user_guide/documentation/index.html deleted file mode 100755 index 7c8e12d..0000000 --- a/user_guide/documentation/index.html +++ /dev/null @@ -1,703 +0,0 @@ - - - - - - - - - - Writing CodeIgniter Documentation — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Writing CodeIgniter Documentation

      -

      CodeIgniter uses Sphinx to generate its documentation in a variety of formats, -using reStructuredText to handle the formatting. If you are familiar with -Markdown or Textile, you will quickly grasp reStructuredText. The focus is -on readability and user friendliness. -While they can be quite technical, we always write for humans!

      -

      A local table of contents should always be included, like the one below. -It is created automatically by inserting the following:

      -
      .. contents::
-        :local:
-
-.. raw:: html
-
-<div class="custom-index container"></div>
-
      -
      - -

      The <div> that is inserted as raw HTML is a hook for the documentation’s -JavaScript to dynamically add links to any function and method definitions -contained in the current page.

      -
      -

      Tools Required

      -

      To see the rendered HTML, ePub, PDF, etc., you will need to install Sphinx -along with the PHP domain extension for Sphinx. The underlying requirement -is to have Python installed. Lastly, you will install the CI Lexer for -Pygments, so that code blocks can be properly highlighted.

      -
      easy_install "sphinx==1.2.3"
-easy_install sphinxcontrib-phpdomain
-
      -
      -

      Then follow the directions in the README file in the cilexer folder -inside the documentation repository to install the CI Lexer.

      -
      -
      -

      Page and Section Headings and Subheadings

      -

      Headings not only provide order and sections within a page, but they also -are used to automatically build both the page and document table of contents. -Headings are formed by using certain characters as underlines for a bit of -text. Major headings, like page titles and section headings also use -overlines. Other headings just use underlines, with the following hierarchy:

      -
      # with overline for page titles
-* with overline for major sections
-= for subsections
-- for subsubsections
-^ for subsubsubsections
-" for subsubsubsubsections (!)
-
      -
      -

      The TextMate ELDocs Bundle can help you -create these with the following tab triggers:

      -
      title->
-
-        ##########
-        Page Title
-        ##########
-
-sec->
-
-        *************
-        Major Section
-        *************
-
-sub->
-
-        Subsection
-        ==========
-
-sss->
-
-        SubSubSection
-        -------------
-
-ssss->
-
-        SubSubSubSection
-        ^^^^^^^^^^^^^^^^
-
-sssss->
-
-        SubSubSubSubSection (!)
-        """""""""""""""""""""""
-
      -
      -
      -
      -

      Method Documentation

      -

      When documenting class methods for third party developers, Sphinx provides -directives to assist and keep things simple. -For example, consider the following ReST:

      -
      .. php:class:: Some_class
-
-        .. php:method:: some_method ( $foo [, $bar [, $bat]])
-
-                This function will perform some action. The ``$bar`` array must contain
-                a something and something else, and along with ``$bat`` is an optional
-                parameter.
-
-                :param int $foo: the foo id to do something in
-                :param mixed $bar: A data array that must contain a something and something else
-                :param bool $bat: whether or not to do something
-                :returns: FALSE on failure, TRUE if successful
-                :rtype: bool
-
-                ::
-
-                        $this->load->library('some_class');
-
-                        $bar = array(
-                                'something'             => 'Here is this parameter!',
-                                'something_else'        => 42
-                        );
-
-                        $bat = $this->some_class->should_do_something();
-
-                        if ($this->some_class->some_method(4, $bar, $bat) === FALSE)
-                        {
-                                show_error('An Error Occurred Doing Some Method');
-                        }
-
-                .. note:: Here is something that you should be aware of when using some_method().
-                                For real.
-
-                See also :meth:`Some_class::should_do_something`
-
-
-        .. php:method:: should_do_something()
-
-                :returns: Whether or not something should be done
-                :rtype: bool
-
      -
      -

      It creates the following display:

      -
      -
      -class Some_class
      -
      -
      -some_method($foo[, $bar[, $bat]])
      -

      This function will perform some action. The $bar array must contain -a something and something else, and along with $bat is an optional -parameter.

      - --- - - - - - - - -
      Parameters:
        -
      • $foo (int) – the foo id to do something in
        • -
      • $bar (mixed) – A data array that must contain a something and something else
        • -
      • $bat (bool) – whether or not to do something
        • -
      -
      Returns:

      FALSE on failure, TRUE if successful

      -
      Return type:

      bool

      -
      -
      $this->load->library('some_class');
-
-$bar = array(
-        'something'             => 'Here is this parameter!',
-        'something_else'        => 42
-);
-
-$bat = $this->some_class->should_do_something();
-
-if ($this->some_class->some_method(4, $bar, $bat) === FALSE)
-{
-        show_error('An Error Occurred Doing Some Method');
-}
-
      -
      -
      -

      Note

      -

      Here is something that you should be aware of when using some_method(). -For real.

      -
      -

      See also Some_class::should_do_something()

      -
      - -
      -
      -should_do_something()
      -
      --- - - - - - -
      Returns:Whether or not something should be done
      Return type:bool
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/alternative_php.html b/user_guide/general/alternative_php.html deleted file mode 100755 index 3b75203..0000000 --- a/user_guide/general/alternative_php.html +++ /dev/null @@ -1,567 +0,0 @@ - - - - - - - - - - Alternate PHP Syntax for View Files — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Alternate PHP Syntax for View Files

      -

      If you do not utilize CodeIgniter’s template -engine, you’ll be using pure PHP in your -View files. To minimize the PHP code in these files, and to make it -easier to identify the code blocks it is recommended that you use PHPs -alternative syntax for control structures and short tag echo statements. -If you are not familiar with this syntax, it allows you to eliminate the -braces from your code, and eliminate “echo” statements.

      -
      -

      Automatic Short Tag Support

      -
      -

      Note

      -

      If you find that the syntax described in this page does not -work on your server it might be that “short tags” are disabled in your -PHP ini file. CodeIgniter will optionally rewrite short tags on-the-fly, -allowing you to use that syntax even if your server doesn’t support it. -This feature can be enabled in your config/config.php file.

      -
      -

      Please note that if you do use this feature, if PHP errors are -encountered in your view files, the error message and line number -will not be accurately shown. Instead, all errors will be shown as -eval() errors.

      -
      -
      -

      Alternative Echos

      -

      Normally to echo, or print out a variable you would do this:

      -
      <?php echo $variable; ?>
-
      -
      -

      With the alternative syntax you can instead do it this way:

      -
      <?=$variable?>
-
      -
      -
      -
      -

      Alternative Control Structures

      -

      Controls structures, like if, for, foreach, and while can be written in -a simplified format as well. Here is an example using foreach:

      -
      <ul>
-
-<?php foreach ($todo as $item): ?>
-
-        <li><?=$item?></li>
-
-<?php endforeach; ?>
-
-</ul>
-
      -
      -

      Notice that there are no braces. Instead, the end brace is replaced with -endforeach. Each of the control structures listed above has a similar -closing syntax: endif, endfor, endforeach, and endwhile

      -

      Also notice that instead of using a semicolon after each structure -(except the last one), there is a colon. This is important!

      -

      Here is another example, using if/elseif/else. Notice the colons:

      -
      <?php if ($username === 'sally'): ?>
-
-        <h3>Hi Sally</h3>
-
-<?php elseif ($username === 'joe'): ?>
-
-        <h3>Hi Joe</h3>
-
-<?php else: ?>
-
-        <h3>Hi unknown user</h3>
-
-<?php endif; ?>
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/ancillary_classes.html b/user_guide/general/ancillary_classes.html deleted file mode 100755 index eecdf37..0000000 --- a/user_guide/general/ancillary_classes.html +++ /dev/null @@ -1,579 +0,0 @@ - - - - - - - - - - Creating Ancillary Classes — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Creating Ancillary Classes

      -

      In some cases you may want to develop classes that exist apart from your -controllers but have the ability to utilize all of CodeIgniter’s -resources. This is easily possible as you’ll see.

      -
      -

      get_instance()

      -
      -
      -get_instance()
      -
      --- - - - - - -
      Returns:Reference to your controller’s instance
      Return type:CI_Controller
      -
      - -

      Any class that you instantiate within your controller methods can -access CodeIgniter’s native resources simply by using the -get_instance() function. This function returns the main -CodeIgniter object.

      -

      Normally, to call any of the available CodeIgniter methods requires -you to use the $this construct:

      -
      $this->load->helper('url');
-$this->load->library('session');
-$this->config->item('base_url');
-// etc.
-
      -
      -

      $this, however, only works within your controllers, your models, -or your views. If you would like to use CodeIgniter’s classes from -within your own custom classes you can do so as follows:

      -

      First, assign the CodeIgniter object to a variable:

      -
      $CI =& get_instance();
-
      -
      -

      Once you’ve assigned the object to a variable, you’ll use that variable -instead of $this:

      -
      $CI =& get_instance();
-
-$CI->load->helper('url');
-$CI->load->library('session');
-$CI->config->item('base_url');
-// etc.
-
      -
      -

      If you’ll be using get_instance() inside another class, then it would -be better if you assign it to a property. This way, you won’t need to call -get_instance() in every single method.

      -

      Example:

      -
      class Example {
-
-        protected $CI;
-
-        // We'll use a constructor, as you can't directly call a function
-        // from a property definition.
-        public function __construct()
-        {
-                // Assign the CodeIgniter super-object
-                $this->CI =& get_instance();
-        }
-
-        public function foo()
-        {
-                $this->CI->load->helper('url');
-                redirect();
-        }
-
-        public function bar()
-        {
-                $this->CI->config->item('base_url');
-        }
-}
-
      -
      -

      In the above example, both methods foo() and bar() will work -after you instantiate the Example class, without the need to call -get_instance() in each of them.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/autoloader.html b/user_guide/general/autoloader.html deleted file mode 100755 index 36f8b5a..0000000 --- a/user_guide/general/autoloader.html +++ /dev/null @@ -1,520 +0,0 @@ - - - - - - - - - - Auto-loading Resources — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Auto-loading Resources

      -

      CodeIgniter comes with an “Auto-load” feature that permits libraries, -helpers, and models to be initialized automatically every time the -system runs. If you need certain resources globally throughout your -application you should consider auto-loading them for convenience.

      -

      The following items can be loaded automatically:

      -
        -
      • Classes found in the libraries/ directory
        • -
      • Helper files found in the helpers/ directory
        • -
      • Custom config files found in the config/ directory
        • -
      • Language files found in the system/language/ directory
        • -
      • Models found in the models/ folder
        • -
      -

      To autoload resources, open the application/config/autoload.php -file and add the item you want loaded to the autoload array. You’ll -find instructions in that file corresponding to each type of item.

      -
      -

      Note

      -

      Do not include the file extension (.php) when adding items to -the autoload array.

      -
      -

      Additionally, if you want CodeIgniter to use a Composer -auto-loader, just set $config['composer_autoload'] to TRUE or -a custom path in application/config/config.php.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/caching.html b/user_guide/general/caching.html deleted file mode 100755 index 3b479d5..0000000 --- a/user_guide/general/caching.html +++ /dev/null @@ -1,564 +0,0 @@ - - - - - - - - - - Web Page Caching — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Web Page Caching

      -

      CodeIgniter lets you cache your pages in order to achieve maximum -performance.

      -

      Although CodeIgniter is quite fast, the amount of dynamic information -you display in your pages will correlate directly to the server -resources, memory, and processing cycles utilized, which affect your -page load speeds. By caching your pages, since they are saved in their -fully rendered state, you can achieve performance that nears that of -static web pages.

      -
      -

      How Does Caching Work?

      -

      Caching can be enabled on a per-page basis, and you can set the length -of time that a page should remain cached before being refreshed. When a -page is loaded for the first time, the cache file will be written to -your application/cache folder. On subsequent page loads the cache file -will be retrieved and sent to the requesting user’s browser. If it has -expired, it will be deleted and refreshed before being sent to the -browser.

      -
      -
      -

      Enabling Caching

      -

      To enable caching, put the following tag in any of your controller -methods:

      -
      $this->output->cache($n);
-
      -
      -

      Where $n is the number of minutes you wish the page to remain -cached between refreshes.

      -

      The above tag can go anywhere within a method. It is not affected by -the order that it appears, so place it wherever it seems most logical to -you. Once the tag is in place, your pages will begin being cached.

      -
      -

      Important

      -

      Because of the way CodeIgniter stores content for output, -caching will only work if you are generating display for your -controller with a view.

      -
      -
      -

      Important

      -

      If you change configuration options that might affect -your output, you have to manually delete your cache files.

      -
      -
      -

      Note

      -

      Before the cache files can be written you must set the file -permissions on your application/cache/ directory such that -it is writable.

      -
      -
      -
      -

      Deleting Caches

      -

      If you no longer wish to cache a file you can remove the caching tag and -it will no longer be refreshed when it expires.

      -
      -

      Note

      -

      Removing the tag will not delete the cache immediately. It will -have to expire normally.

      -
      -

      If you need to manually delete the cache, you can use the delete_cache() -method:

      -
      // Deletes cache for the currently requested URI
-$this->output->delete_cache();
-
-// Deletes cache for /foo/bar
-$this->output->delete_cache('/foo/bar');
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/cli.html b/user_guide/general/cli.html deleted file mode 100755 index e0cbb40..0000000 --- a/user_guide/general/cli.html +++ /dev/null @@ -1,574 +0,0 @@ - - - - - - - - - - Running via the CLI — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Running via the CLI

      -

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

      -
      -

      Page Contents

      - -
      -
      -

      What is the CLI?

      -

      The command-line interface is a text-based method of interacting with -computers. For more information, check the Wikipedia -article.

      -
      -
      -

      Why run via the command-line?

      -

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

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

      Let’s try it: Hello World!

      -

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

      -
      <?php
-class Tools extends CI_Controller {
-
-        public function message($to = 'World')
-        {
-                echo "Hello {$to}!".PHP_EOL;
-        }
-}
-
      -
      -

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

      -

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

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

      Instead, we are going to open Terminal in Mac/Linux or go to Run > “cmd” -in Windows and navigate to our CodeIgniter project.

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

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

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

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

      -
      Hello John Smith!
-
      -
      -
      -
      -

      That’s it!

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/common_functions.html b/user_guide/general/common_functions.html deleted file mode 100755 index 225b148..0000000 --- a/user_guide/general/common_functions.html +++ /dev/null @@ -1,777 +0,0 @@ - - - - - - - - - - Common Functions — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Common Functions

      -

      CodeIgniter uses a few functions for its operation that are globally -defined, and are available to you at any point. These do not require -loading any libraries or helpers.

      -
      -
      -is_php($version)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $version (string) – Version number
        • -
      -
      Returns:

      TRUE if the running PHP version is at least the one specified or FALSE if not

      -
      Return type:

      bool

      -
      -

      Determines if the PHP version being used is greater than the -supplied version number.

      -

      Example:

      -
      if (is_php('5.3'))
-{
-        $str = quoted_printable_encode($str);
-}
-
      -
      -

      Returns boolean TRUE if the installed version of PHP is equal to or -greater than the supplied version number. Returns FALSE if the installed -version of PHP is lower than the supplied version number.

      -
      - -
      -
      -is_really_writable($file)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $file (string) – File path
        • -
      -
      Returns:

      TRUE if the path is writable, FALSE if not

      -
      Return type:

      bool

      -
      -

      is_writable() returns TRUE on Windows servers when you really can’t -write to the file as the OS reports to PHP as FALSE only if the -read-only attribute is marked.

      -

      This function determines if a file is actually writable by attempting -to write to it first. Generally only recommended on platforms where -this information may be unreliable.

      -

      Example:

      -
      if (is_really_writable('file.txt'))
-{
-        echo "I could write to this if I wanted to";
-}
-else
-{
-        echo "File is not writable";
-}
-
      -
      -
      -

      Note

      -

      See also PHP bug #54709 for more info.

      -
      -
      - -
      -
      -config_item($key)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Config item key
        • -
      -
      Returns:

      Configuration key value or NULL if not found

      -
      Return type:

      mixed

      -
      -

      The Config Library is the preferred way of -accessing configuration information, however config_item() can be used -to retrieve single keys. See Config Library -documentation for more information.

      -
      - -
      -
      -set_status_header($code[, $text = ''])
      -
      --- - - - - - -
      Parameters:
        -
      • $code (int) – HTTP Reponse status code
        • -
      • $text (string) – A custom message to set with the status code
        • -
      -
      Return type:

      void

      -
      -

      Permits you to manually set a server status header. Example:

      -
      set_status_header(401);
-// Sets the header as:  Unauthorized
-
      -
      -

      See here for -a full list of headers.

      -
      - -
      -
      -remove_invisible_characters($str[, $url_encoded = TRUE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $url_encoded (bool) – Whether to remove URL-encoded characters as well
        • -
      -
      Returns:

      Sanitized string

      -
      Return type:

      string

      -
      -

      This function prevents inserting NULL characters between ASCII -characters, like Java\0script.

      -

      Example:

      -
      remove_invisible_characters('Java\\0script');
-// Returns: 'Javascript'
-
      -
      -
      - -
      -
      -html_escape($var)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $var (mixed) – Variable to escape (string or array)
        • -
      -
      Returns:

      HTML escaped string(s)

      -
      Return type:

      mixed

      -
      -

      This function acts as an alias for PHP’s native htmlspecialchars() -function, with the advantage of being able to accept an array of strings.

      -

      It is useful in preventing Cross Site Scripting (XSS).

      -
      - -
      -
      -get_mimes()
      -
      --- - - - - - -
      Returns:An associative array of file types
      Return type:array
      -

      This function returns a reference to the MIMEs array from -application/config/mimes.php.

      -
      - -
      -
      -is_https()
      -
      --- - - - - - -
      Returns:TRUE if currently using HTTP-over-SSL, FALSE if not
      Return type:bool
      -

      Returns TRUE if a secure (HTTPS) connection is used and FALSE -in any other case (including non-HTTP requests).

      -
      - -
      -
      -is_cli()
      -
      --- - - - - - -
      Returns:TRUE if currently running under CLI, FALSE otherwise
      Return type:bool
      -

      Returns TRUE if the application is run through the command line -and FALSE if not.

      -
      -

      Note

      -

      This function checks both if the PHP_SAPI value is ‘cli’ -or if the STDIN constant is defined.

      -
      -
      - -
      -
      -function_usable($function_name)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $function_name (string) – Function name
        • -
      -
      Returns:

      TRUE if the function can be used, FALSE if not

      -
      Return type:

      bool

      -
      -

      Returns TRUE if a function exists and is usable, FALSE otherwise.

      -

      This function runs a function_exists() check and if the -Suhosin extension <http://www.hardened-php.net/suhosin/> is loaded, -checks if it doesn’t disable the function being checked.

      -

      It is useful if you want to check for the availability of functions -such as eval() and exec(), which are dangerous and might be -disabled on servers with highly restrictive security policies.

      -
      -

      Note

      -

      This function was introduced because Suhosin terminated -script execution, but this turned out to be a bug. A fix -has been available for some time (version 0.9.34), but is -unfortunately not released yet.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/compatibility_functions.html b/user_guide/general/compatibility_functions.html deleted file mode 100755 index fa457c5..0000000 --- a/user_guide/general/compatibility_functions.html +++ /dev/null @@ -1,994 +0,0 @@ - - - - - - - - - - Compatibility Functions — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Compatibility Functions

      -

      CodeIgniter provides a set of compatibility functions that enable -you to use functions what are otherwise natively available in PHP, -but only in higher versions or depending on a certain extension.

      -

      Being custom implementations, these functions will also have some -set of dependencies on their own, but are still useful if your -PHP setup doesn’t offer them natively.

      -
      -

      Note

      -

      Much like the common functions <common_functions>, the -compatibility functions are always available, as long as -their dependencies are met.

      -
      - -
      -

      Password Hashing

      -

      This set of compatibility functions offers a “backport” of PHP’s -standard Password Hashing extension -that is otherwise available only since PHP 5.5.

      -
      -

      Dependencies

      -
        -
      • PHP 5.3.7
        • -
      • CRYPT_BLOWFISH support for crypt()
        • -
      -
      -
      -

      Constants

      -
        -
      • PASSWORD_BCRYPT
        • -
      • PASSWORD_DEFAULT
        • -
      -
      -
      -

      Function reference

      -
      -
      -password_get_info($hash)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $hash (string) – Password hash
        • -
      -
      Returns:

      Information about the hashed password

      -
      Return type:

      array

      -
      -

      For more information, please refer to the PHP manual for -password_get_info().

      -
      - -
      -
      -password_hash($password, $algo[, $options = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $password (string) – Plain-text password
        • -
      • $algo (int) – Hashing algorithm
        • -
      • $options (array) – Hashing options
        • -
      -
      Returns:

      Hashed password or FALSE on failure

      -
      Return type:

      string

      -
      -

      For more information, please refer to the PHP manual for -password_hash().

      -
      -

      Note

      -

      Unless you provide your own (and valid) salt, this function -has a further dependency on an available CSPRNG source. Each -of the following would satisfy that: -- mcrypt_create_iv() with MCRYPT_DEV_URANDOM -- openssl_random_pseudo_bytes() -- /dev/arandom -- /dev/urandom

      -
      -
      - -
      -
      -password_needs_rehash()
      -
      --- - - - - - - - -
      Parameters:
        -
      • $hash (string) – Password hash
        • -
      • $algo (int) – Hashing algorithm
        • -
      • $options (array) – Hashing options
        • -
      -
      Returns:

      TRUE if the hash should be rehashed to match the given algorithm and options, FALSE otherwise

      -
      Return type:

      bool

      -
      -

      For more information, please refer to the PHP manual for -password_needs_rehash().

      -
      - -
      -
      -password_verify($password, $hash)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $password (string) – Plain-text password
        • -
      • $hash (string) – Password hash
        • -
      -
      Returns:

      TRUE if the password matches the hash, FALSE if not

      -
      Return type:

      bool

      -
      -

      For more information, please refer to the PHP manual for -password_verify().

      -
      - -
      -
      -
      -

      Hash (Message Digest)

      -

      This compatibility layer contains backports for the hash_equals() -and hash_pbkdf2() functions, which otherwise require PHP 5.6 and/or -PHP 5.5 respectively.

      -
      -

      Dependencies

      -
        -
      • None
        • -
      -
      -
      -

      Function reference

      -
      -
      -hash_equals($known_string, $user_string)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $known_string (string) – Known string
        • -
      • $user_string (string) – User-supplied string
        • -
      -
      Returns:

      TRUE if the strings match, FALSE otherwise

      -
      Return type:

      string

      -
      -

      For more information, please refer to the PHP manual for -hash_equals().

      -
      - -
      -
      -hash_pbkdf2($algo, $password, $salt, $iterations[, $length = 0[, $raw_output = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $algo (string) – Hashing algorithm
        • -
      • $password (string) – Password
        • -
      • $salt (string) – Hash salt
        • -
      • $iterations (int) – Number of iterations to perform during derivation
        • -
      • $length (int) – Output string length
        • -
      • $raw_output (bool) – Whether to return raw binary data
        • -
      -
      Returns:

      Password-derived key or FALSE on failure

      -
      Return type:

      string

      -
      -

      For more information, please refer to the PHP manual for -hash_pbkdf2().

      -
      - -
      -
      -
      -

      Multibyte String

      -

      This set of compatibility functions offers limited support for PHP’s -Multibyte String extension. Because of -the limited alternative solutions, only a few functions are available.

      -
      -

      Note

      -

      When a character set parameter is ommited, -$config['charset'] will be used.

      -
      -
      -

      Dependencies

      - -
      -

      Important

      -

      This dependency is optional and these functions will -always be declared. If iconv is not available, they WILL -fall-back to their non-mbstring versions.

      -
      -
      -

      Important

      -

      Where a character set is supplied, it must be -supported by iconv and in a format that it recognizes.

      -
      -
      -

      Note

      -

      For you own dependency check on the actual mbstring -extension, use the MB_ENABLED constant.

      -
      -
      -
      -

      Function reference

      -
      -
      -mb_strlen($str[, $encoding = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $encoding (string) – Character set
        • -
      -
      Returns:

      Number of characters in the input string or FALSE on failure

      -
      Return type:

      string

      -
      -

      For more information, please refer to the PHP manual for -mb_strlen().

      -
      - -
      -
      -mb_strpos($haystack, $needle[, $offset = 0[, $encoding = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $haystack (string) – String to search in
        • -
      • $needle (string) – Part of string to search for
        • -
      • $offset (int) – Search offset
        • -
      • $encoding (string) – Character set
        • -
      -
      Returns:

      Numeric character position of where $needle was found or FALSE if not found

      -
      Return type:

      mixed

      -
      -

      For more information, please refer to the PHP manual for -mb_strpos().

      -
      - -
      -
      -mb_substr($str, $start[, $length = NULL[, $encoding = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $start (int) – Position of first character
        • -
      • $length (int) – Maximum number of characters
        • -
      • $encoding (string) – Character set
        • -
      -
      Returns:

      Portion of $str specified by $start and $length or FALSE on failure

      -
      Return type:

      string

      -
      -

      For more information, please refer to the PHP manual for -mb_substr().

      -
      - -
      -
      -
      -

      Standard Functions

      -

      This set of compatibility functions offers support for a few -standard functions in PHP that otherwise require a newer PHP version.

      -
      -

      Dependencies

      -
        -
      • None
        • -
      -
      -
      -

      Function reference

      -
      -
      -array_column(array $array, $column_key[, $index_key = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $array (array) – Array to fetch results from
        • -
      • $column_key (mixed) – Key of the column to return values from
        • -
      • $index_key (mixed) – Key to use for the returned values
        • -
      -
      Returns:

      An array of values representing a single column from the input array

      -
      Return type:

      array

      -
      -

      For more information, please refer to the PHP manual for -array_column().

      -
      - -
      -
      -array_replace(array $array1[, ...])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $array1 (array) – Array in which to replace elements
        • -
      • ... (array) – Array (or multiple ones) from which to extract elements
        • -
      -
      Returns:

      Modified array

      -
      Return type:

      array

      -
      -

      For more information, please refer to the PHP manual for -array_replace().

      -
      - -
      -
      -array_replace_recursive(array $array1[, ...])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $array1 (array) – Array in which to replace elements
        • -
      • ... (array) – Array (or multiple ones) from which to extract elements
        • -
      -
      Returns:

      Modified array

      -
      Return type:

      array

      -
      -

      For more information, please refer to the PHP manual for -array_replace_recursive().

      -
      -

      Important

      -

      Only PHP’s native function can detect endless recursion. -Unless you are running PHP 5.3+, be careful with references!

      -
      -
      - -
      -
      -hex2bin($data)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (array) – Hexadecimal representation of data
        • -
      -
      Returns:

      Binary representation of the given data

      -
      Return type:

      string

      -
      -

      For more information, please refer to the PHP manual for hex2bin().

      -
      - -
      -
      -quoted_printable_encode($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      8bit-encoded string

      -
      Return type:

      string

      -
      -

      For more information, please refer to the PHP manual for -quoted_printable_encode().

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/controllers.html b/user_guide/general/controllers.html deleted file mode 100755 index c5bbb31..0000000 --- a/user_guide/general/controllers.html +++ /dev/null @@ -1,846 +0,0 @@ - - - - - - - - - - Controllers — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Controllers

      -

      Controllers are the heart of your application, as they determine how -HTTP requests should be handled.

      -
      -

      Page Contents

      - -
      -
      -

      What is a Controller?

      -

      A Controller is simply a class file that is named in a way that can be -associated with a URI.

      -

      Consider this URI:

      -
      example.com/index.php/blog/
-
      -
      -

      In the above example, CodeIgniter would attempt to find a controller -named Blog.php and load it.

      -

      When a controller’s name matches the first segment of a URI, it will -be loaded.

      -
      -
      -

      Let’s try it: Hello World!

      -

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

      -
      <?php
-class Blog extends CI_Controller {
-
-        public function index()
-        {
-                echo 'Hello World!';
-        }
-}
-
      -
      -

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

      -
      -

      Important

      -

      The file must be called ‘Blog.php’, with a capital ‘B’.

      -
      -

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

      -
      example.com/index.php/blog/
-
      -
      -

      If you did it right, you should see:

      -
      -
      Hello World!
      -
      -

      Important

      -

      Class names must start with an uppercase letter.

      -
      -

      This is valid:

      -
      <?php
-class Blog extends CI_Controller {
-
-}
-
      -
      -

      This is not valid:

      -
      <?php
-class blog extends CI_Controller {
-
-}
-
      -
      -

      Also, always make sure your controller extends the parent controller -class so that it can inherit all its methods.

      -
      -
      -

      Methods

      -

      In the above example the method name is index(). The “index” method -is always loaded by default if the second segment of the URI is -empty. Another way to show your “Hello World” message would be this:

      -
      example.com/index.php/blog/index/
-
      -
      -

      The second segment of the URI determines which method in the -controller gets called.

      -

      Let’s try it. Add a new method to your controller:

      -
      <?php
-class Blog extends CI_Controller {
-
-        public function index()
-        {
-                echo 'Hello World!';
-        }
-
-        public function comments()
-        {
-                echo 'Look at this!';
-        }
-}
-
      -
      -

      Now load the following URL to see the comment method:

      -
      example.com/index.php/blog/comments/
-
      -
      -

      You should see your new message.

      -
      -
      -

      Passing URI Segments to your methods

      -

      If your URI contains more than two segments they will be passed to your -method as parameters.

      -

      For example, let’s say you have a URI like this:

      -
      example.com/index.php/products/shoes/sandals/123
-
      -
      -

      Your method will be passed URI segments 3 and 4 (“sandals” and “123”):

      -
      <?php
-class Products extends CI_Controller {
-
-        public function shoes($sandals, $id)
-        {
-                echo $sandals;
-                echo $id;
-        }
-}
-
      -
      -
      -

      Important

      -

      If you are using the URI Routing -feature, the segments passed to your method will be the re-routed -ones.

      -
      -
      -
      -

      Defining a Default Controller

      -

      CodeIgniter can be told to load a default controller when a URI is not -present, as will be the case when only your site root URL is requested. -To specify a default controller, open your application/config/routes.php -file and set this variable:

      -
      $route['default_controller'] = 'blog';
-
      -
      -

      Where ‘blog’ is the name of the controller class you want used. If you now -load your main index.php file without specifying any URI segments you’ll -see your “Hello World” message by default.

      -

      For more information, please refer to the “Reserved Routes” section of the -URI Routing documentation.

      -
      -
      -

      Remapping Method Calls

      -

      As noted above, the second segment of the URI typically determines which -method in the controller gets called. CodeIgniter permits you to override -this behavior through the use of the _remap() method:

      -
      public function _remap()
-{
-        // Some code here...
-}
-
      -
      -
      -

      Important

      -

      If your controller contains a method named _remap(), -it will always get called regardless of what your URI contains. It -overrides the normal behavior in which the URI determines which method -is called, allowing you to define your own method routing rules.

      -
      -

      The overridden method call (typically the second segment of the URI) will -be passed as a parameter to the _remap() method:

      -
      public function _remap($method)
-{
-        if ($method === 'some_method')
-        {
-                $this->$method();
-        }
-        else
-        {
-                $this->default_method();
-        }
-}
-
      -
      -

      Any extra segments after the method name are passed into _remap() as an -optional second parameter. This array can be used in combination with -PHP’s call_user_func_array() -to emulate CodeIgniter’s default behavior.

      -

      Example:

      -
      public function _remap($method, $params = array())
-{
-        $method = 'process_'.$method;
-        if (method_exists($this, $method))
-        {
-                return call_user_func_array(array($this, $method), $params);
-        }
-        show_404();
-}
-
      -
      -
      -
      -

      Processing Output

      -

      CodeIgniter has an output class that takes care of sending your final -rendered data to the web browser automatically. More information on this -can be found in the Views and Output Class pages. In some cases, however, you might want to -post-process the finalized data in some way and send it to the browser -yourself. CodeIgniter permits you to add a method named _output() -to your controller that will receive the finalized output data.

      -
      -

      Important

      -

      If your controller contains a method named _output(), -it will always be called by the output class instead of -echoing the finalized data directly. The first parameter of the -method will contain the finalized output.

      -
      -

      Here is an example:

      -
      public function _output($output)
-{
-        echo $output;
-}
-
      -
      -
      -

      Note

      -

      Please note that your _output() method will receive the -data in its finalized state. Benchmark and memory usage data -will be rendered, cache files written (if you have caching -enabled), and headers will be sent (if you use that -feature) before it is handed off -to the _output() method. -To have your controller’s output cached properly, its -_output() method can use:

      -
      if ($this->output->cache_expiration > 0)
-{
-        $this->output->_write_cache($output);
-}
-
      -
      -

      If you are using this feature the page execution timer and -memory usage stats might not be perfectly accurate since they -will not take into account any further processing you do. -For an alternate way to control output before any of the -final processing is done, please see the available methods -in the Output Library.

      -
      -
      -
      -

      Private methods

      -

      In some cases you may want certain methods hidden from public access. -In order to achieve this, simply declare the method as being private -or protected and it will not be served via a URL request. For example, -if you were to have a method like this:

      -
      private function _utility()
-{
-        // some code
-}
-
      -
      -

      Trying to access it via the URL, like this, will not work:

      -
      example.com/index.php/blog/_utility/
-
      -
      -
      -

      Note

      -

      Prefixing method names with an underscore will also prevent -them from being called. This is a legacy feature that is left -for backwards-compatibility.

      -
      -
      -
      -

      Organizing Your Controllers into Sub-directories

      -

      If you are building a large application you might want to hierarchically -organize or structure your controllers into sub-directories. CodeIgniter -permits you to do this.

      -

      Simply create sub-directories under the main application/controllers/ -one and place your controller classes within them.

      -
      -

      Note

      -

      When using this feature the first segment of your URI must -specify the folder. For example, let’s say you have a controller located -here:

      -
      application/controllers/products/Shoes.php
-
      -
      -

      To call the above controller your URI will look something like this:

      -
      example.com/index.php/products/shoes/show/123
-
      -
      -
      -

      Each of your sub-directories may contain a default controller which will be -called if the URL contains only the sub-directory. Simply put a controller -in there that matches the name of your ‘default_controller’ as specified in -your application/config/routes.php file.

      -

      CodeIgniter also permits you to remap your URIs using its URI -Routing feature.

      -
      -
      -

      Class Constructors

      -

      If you intend to use a constructor in any of your Controllers, you -MUST place the following line of code in it:

      -
      parent::__construct();
-
      -
      -

      The reason this line is necessary is because your local constructor will -be overriding the one in the parent controller class so we need to -manually call it.

      -

      Example:

      -
      <?php
-class Blog extends CI_Controller {
-
-        public function __construct()
-        {
-                parent::__construct();
-                // Your own constructor code
-        }
-}
-
      -
      -

      Constructors are useful if you need to set some default values, or run a -default process when your class is instantiated. Constructors can’t -return a value, but they can do some default work.

      -
      -
      -

      Reserved method names

      -

      Since your controller classes will extend the main application -controller you must be careful not to name your methods identically to -the ones used by that class, otherwise your local functions will -override them. See Reserved Names for a full -list.

      -
      -

      Important

      -

      You should also never have a method named identically -to its class name. If you do, and there is no __construct() -method in the same class, then your e.g. Index::index() -method will be executed as a class constructor! This is a PHP4 -backwards-compatibility feature.

      -
      -
      -
      -

      That’s it!

      -

      That, in a nutshell, is all there is to know about controllers.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/core_classes.html b/user_guide/general/core_classes.html deleted file mode 100755 index 714240c..0000000 --- a/user_guide/general/core_classes.html +++ /dev/null @@ -1,612 +0,0 @@ - - - - - - - - - - Creating Core System Classes — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Creating Core System Classes

      -

      Every time CodeIgniter runs there are several base classes that are -initialized automatically as part of the core framework. It is possible, -however, to swap any of the core system classes with your own versions -or even extend the core versions.

      -

      Most users will never have any need to do this, but the option to -replace or extend them does exist for those who would like to -significantly alter the CodeIgniter core.

      -
      -

      Note

      -

      Messing with a core system class has a lot of implications, so -make sure you know what you are doing before attempting it.

      -
      -
      -

      System Class List

      -

      The following is a list of the core system files that are invoked every -time CodeIgniter runs:

      -
        -
      • Benchmark
        • -
      • Config
        • -
      • Controller
        • -
      • Exceptions
        • -
      • Hooks
        • -
      • Input
        • -
      • Language
        • -
      • Loader
        • -
      • Log
        • -
      • Output
        • -
      • Router
        • -
      • Security
        • -
      • URI
        • -
      • Utf8
        • -
      -
      -
      -

      Replacing Core Classes

      -

      To use one of your own system classes instead of a default one simply -place your version inside your local application/core/ directory:

      -
      application/core/some_class.php
-
      -
      -

      If this directory does not exist you can create it.

      -

      Any file named identically to one from the list above will be used -instead of the one normally used.

      -

      Please note that your class must use CI as a prefix. For example, if -your file is named Input.php the class will be named:

      -
      class CI_Input {
-
-}
-
      -
      -
      -
      -

      Extending Core Class

      -

      If all you need to do is add some functionality to an existing library - -perhaps add a method or two - then it’s overkill to replace the entire -library with your version. In this case it’s better to simply extend the -class. Extending a class is nearly identical to replacing a class with a -couple exceptions:

      -
        -
      • The class declaration must extend the parent class.
        • -
      • Your new class name and filename must be prefixed with MY_ (this -item is configurable. See below.).
        • -
      -

      For example, to extend the native Input class you’ll create a file named -application/core/MY_Input.php, and declare your class with:

      -
      class MY_Input extends CI_Input {
-
-}
-
      -
      -
      -

      Note

      -

      If you need to use a constructor in your class make sure you -extend the parent constructor:

      -
      class MY_Input extends CI_Input {
-
-        public function __construct()
-        {
-                parent::__construct();
-        }
-}
-
      -
      -
      -

      Tip: Any functions in your class that are named identically to the -methods in the parent class will be used instead of the native ones -(this is known as “method overriding”). This allows you to substantially -alter the CodeIgniter core.

      -

      If you are extending the Controller core class, then be sure to extend -your new class in your application controller’s constructors.

      -
      class Welcome extends MY_Controller {
-
-        public function __construct()
-        {
-                parent::__construct();
-        }
-
-        public function index()
-        {
-                $this->load->view('welcome_message');
-        }
-}
-
      -
      -
      -

      Setting Your Own Prefix

      -

      To set your own sub-class prefix, open your -application/config/config.php file and look for this item:

      -
      $config['subclass_prefix'] = 'MY_';
-
      -
      -

      Please note that all native CodeIgniter libraries are prefixed -with CI_ so DO NOT use that as your prefix.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/creating_drivers.html b/user_guide/general/creating_drivers.html deleted file mode 100755 index c66ccc1..0000000 --- a/user_guide/general/creating_drivers.html +++ /dev/null @@ -1,525 +0,0 @@ - - - - - - - - - - Creating Drivers — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Creating Drivers

      -
      -

      Driver Directory and File Structure

      -

      Sample driver directory and file structure layout:

      -
        -
      • /application/libraries/Driver_name
          -
        • Driver_name.php
          • -
        • drivers
            -
          • Driver_name_subclass_1.php
            • -
          • Driver_name_subclass_2.php
            • -
          • Driver_name_subclass_3.php
            • -
          -
          • -
        -
        • -
      -
      -

      Note

      -

      In order to maintain compatibility on case-sensitive -file systems, the Driver_name directory must be -named in the format returned by ucfirst().

      -
      -
      -

      Note

      -

      The Driver library’s architecture is such that -the subclasses don’t extend and therefore don’t inherit -properties or methods of the main driver.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/creating_libraries.html b/user_guide/general/creating_libraries.html deleted file mode 100755 index a5eefef..0000000 --- a/user_guide/general/creating_libraries.html +++ /dev/null @@ -1,754 +0,0 @@ - - - - - - - - - - Creating Libraries — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Creating Libraries

      -

      When we use the term “Libraries” we are normally referring to the -classes that are located in the libraries directory and described in the -Class Reference of this user guide. In this case, however, we will -instead describe how you can create your own libraries within your -application/libraries directory in order to maintain separation between -your local resources and the global framework resources.

      -

      As an added bonus, CodeIgniter permits your libraries to extend native -classes if you simply need to add some functionality to an existing -library. Or you can even replace native libraries just by placing -identically named versions in your application/libraries directory.

      -

      In summary:

      -
        -
      • You can create entirely new libraries.
        • -
      • You can extend native libraries.
        • -
      • You can replace native libraries.
        • -
      -

      The page below explains these three concepts in detail.

      -
      -

      Note

      -

      The Database classes can not be extended or replaced with your -own classes. All other classes are able to be replaced/extended.

      -
      -
      -

      Storage

      -

      Your library classes should be placed within your application/libraries -directory, as this is where CodeIgniter will look for them when they are -initialized.

      -
      -
      -

      Naming Conventions

      -
        -
      • File names must be capitalized. For example: Myclass.php
        • -
      • Class declarations must be capitalized. For example: class Myclass
        • -
      • Class names and file names must match.
        • -
      -
      -
      -

      The Class File

      -

      Classes should have this basic prototype:

      -
      <?php
-defined('BASEPATH') OR exit('No direct script access allowed');
-
-class Someclass {
-
-        public function some_method()
-        {
-        }
-}
-
      -
      -
      -

      Note

      -

      We are using the name Someclass purely as an example.

      -
      -
      -
      -

      Using Your Class

      -

      From within any of your Controller methods you -can initialize your class using the standard:

      -
      $this->load->library('someclass');
-
      -
      -

      Where someclass is the file name, without the ”.php” file extension. -You can submit the file name capitalized or lower case. CodeIgniter -doesn’t care.

      -

      Once loaded you can access your class using the lower case version:

      -
      $this->someclass->some_method();  // Object instances will always be lower case
-
      -
      -
      -
      -

      Passing Parameters When Initializing Your Class

      -

      In the library loading method you can dynamically pass data as an -array via the second parameter and it will be passed to your class -constructor:

      -
      $params = array('type' => 'large', 'color' => 'red');
-
-$this->load->library('someclass', $params);
-
      -
      -

      If you use this feature you must set up your class constructor to expect -data:

      -
      <?php defined('BASEPATH') OR exit('No direct script access allowed');
-
-class Someclass {
-
-        public function __construct($params)
-        {
-                // Do something with $params
-        }
-}
-
      -
      -

      You can also pass parameters stored in a config file. Simply create a -config file named identically to the class file name and store it in -your application/config/ directory. Note that if you dynamically pass -parameters as described above, the config file option will not be -available.

      -
      -
      -

      Utilizing CodeIgniter Resources within Your Library

      -

      To access CodeIgniter’s native resources within your library use the -get_instance() method. This method returns the CodeIgniter super -object.

      -

      Normally from within your controller methods you will call any of the -available CodeIgniter methods using the $this construct:

      -
      $this->load->helper('url');
-$this->load->library('session');
-$this->config->item('base_url');
-// etc.
-
      -
      -

      $this, however, only works directly within your controllers, your -models, or your views. If you would like to use CodeIgniter’s classes -from within your own custom classes you can do so as follows:

      -

      First, assign the CodeIgniter object to a variable:

      -
      $CI =& get_instance();
-
      -
      -

      Once you’ve assigned the object to a variable, you’ll use that variable -instead of $this:

      -
      $CI =& get_instance();
-
-$CI->load->helper('url');
-$CI->load->library('session');
-$CI->config->item('base_url');
-// etc.
-
      -
      -
      -

      Note

      -

      You’ll notice that the above get_instance() function is being -passed by reference:

      -
      $CI =& get_instance();
-
      -
      -

      This is very important. Assigning by reference allows you to use the -original CodeIgniter object rather than creating a copy of it.

      -
      -

      However, since a library is a class, it would be better if you -take full advantage of the OOP principles. So, in order to -be able to use the CodeIgniter super-object in all of the class -methods, you’re encouraged to assign it to a property instead:

      -
      class Example_library {
-
-        protected $CI;
-
-        // We'll use a constructor, as you can't directly call a function
-        // from a property definition.
-        public function __construct()
-        {
-                // Assign the CodeIgniter super-object
-                $this->CI =& get_instance();
-        }
-
-        public function foo()
-        {
-                $this->CI->load->helper('url');
-                redirect();
-        }
-
-        public function bar()
-        {
-                echo $this->CI->config->item('base_url');
-        }
-
-}
-
      -
      -
      -
      -

      Replacing Native Libraries with Your Versions

      -

      Simply by naming your class files identically to a native library will -cause CodeIgniter to use it instead of the native one. To use this -feature you must name the file and the class declaration exactly the -same as the native library. For example, to replace the native Email -library you’ll create a file named application/libraries/Email.php, -and declare your class with:

      -
      class CI_Email {
-
-}
-
      -
      -

      Note that most native classes are prefixed with CI_.

      -

      To load your library you’ll see the standard loading method:

      -
      $this->load->library('email');
-
      -
      -
      -

      Note

      -

      At this time the Database classes can not be replaced with -your own versions.

      -
      -
      -
      -

      Extending Native Libraries

      -

      If all you need to do is add some functionality to an existing library - -perhaps add a method or two - then it’s overkill to replace the entire -library with your version. In this case it’s better to simply extend the -class. Extending a class is nearly identical to replacing a class with a -couple exceptions:

      -
        -
      • The class declaration must extend the parent class.
        • -
      • Your new class name and filename must be prefixed with MY_ (this -item is configurable. See below.).
        • -
      -

      For example, to extend the native Email class you’ll create a file named -application/libraries/MY_Email.php, and declare your class with:

      -
      class MY_Email extends CI_Email {
-
-}
-
      -
      -

      If you need to use a constructor in your class make sure you -extend the parent constructor:

      -
      class MY_Email extends CI_Email {
-
-        public function __construct($config = array())
-        {
-                parent::__construct($config);
-        }
-
-}
-
      -
      -
      -

      Note

      -

      Not all of the libraries have the same (or any) parameters -in their constructor. Take a look at the library that you’re -extending first to see how it should be implemented.

      -
      -
      -

      Loading Your Sub-class

      -

      To load your sub-class you’ll use the standard syntax normally used. DO -NOT include your prefix. For example, to load the example above, which -extends the Email class, you will use:

      -
      $this->load->library('email');
-
      -
      -

      Once loaded you will use the class variable as you normally would for -the class you are extending. In the case of the email class all calls -will use:

      -
      $this->email->some_method();
-
      -
      -
      -
      -

      Setting Your Own Prefix

      -

      To set your own sub-class prefix, open your -application/config/config.php file and look for this item:

      -
      $config['subclass_prefix'] = 'MY_';
-
      -
      -

      Please note that all native CodeIgniter libraries are prefixed with CI_ -so DO NOT use that as your prefix.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/credits.html b/user_guide/general/credits.html deleted file mode 100755 index 1e3716b..0000000 --- a/user_guide/general/credits.html +++ /dev/null @@ -1,503 +0,0 @@ - - - - - - - - - - Credits — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Credits
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Credits

      -

      CodeIgniter was originally developed by Rick Ellis -(CEO of EllisLab, Inc.). The framework was written for -performance in the real world, with many of the class libraries, helpers, and -sub-systems borrowed from the code-base of ExpressionEngine.

      -

      It was, for years, developed and maintained by EllisLab, the ExpressionEngine -Development Team and a group of community members called the Reactor Team.

      -

      In 2014, CodeIgniter was acquired by the British Columbia Institute of Technology and was then officially announced as a community-maintained -project.

      -

      Bleeding edge development is spearheaded by the handpicked contributors -of the Reactor Team.

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/drivers.html b/user_guide/general/drivers.html deleted file mode 100755 index befe821..0000000 --- a/user_guide/general/drivers.html +++ /dev/null @@ -1,531 +0,0 @@ - - - - - - - - - - Using CodeIgniter Drivers — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Using CodeIgniter Drivers

      -

      Drivers are a special type of Library that has a parent class and any -number of potential child classes. Child classes have access to the -parent class, but not their siblings. Drivers provide an elegant syntax -in your controllers for libraries that benefit -from or require being broken down into discrete classes.

      -

      Drivers are found in the system/libraries/ directory, in their own -sub-directory which is identically named to the parent library class. -Also inside that directory is a subdirectory named drivers, which -contains all of the possible child class files.

      -

      To use a driver you will initialize it within a controller using the -following initialization method:

      -
      $this->load->driver('class_name');
-
      -
      -

      Where class name is the name of the driver class you want to invoke. For -example, to load a driver named “Some_parent” you would do this:

      -
      $this->load->driver('some_parent');
-
      -
      -

      Methods of that class can then be invoked with:

      -
      $this->some_parent->some_method();
-
      -
      -

      The child classes, the drivers themselves, can then be called directly -through the parent class, without initializing them:

      -
      $this->some_parent->child_one->some_method();
-$this->some_parent->child_two->another_method();
-
      -
      -
      -

      Creating Your Own Drivers

      -

      Please read the section of the user guide that discusses how to create -your own drivers.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/environments.html b/user_guide/general/environments.html deleted file mode 100755 index 39321d0..0000000 --- a/user_guide/general/environments.html +++ /dev/null @@ -1,539 +0,0 @@ - - - - - - - - - - Handling Multiple Environments — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Handling Multiple Environments

      -

      Developers often desire different system behavior depending on whether -an application is running in a development or production environment. -For example, verbose error output is something that would be useful -while developing an application, but it may also pose a security issue -when “live”.

      -
      -

      The ENVIRONMENT Constant

      -

      By default, CodeIgniter comes with the environment constant set to use -the value provided in $_SERVER['CI_ENV'], otherwise defaults to -‘development’. At the top of index.php, you will see:

      -
      define('ENVIRONMENT', isset($_SERVER['CI_ENV']) ? $_SERVER['CI_ENV'] : 'development');
-
      -
      -

      This server variable can be set in your .htaccess file, or Apache -config using SetEnv. -Alternative methods are available for nginx and other servers, or you can -remove this logic entirely and set the constant based on the server’s IP address.

      -

      In addition to affecting some basic framework behavior (see the next -section), you may use this constant in your own development to -differentiate between which environment you are running in.

      -
      -
      -

      Effects On Default Framework Behavior

      -

      There are some places in the CodeIgniter system where the ENVIRONMENT -constant is used. This section describes how default framework behavior -is affected.

      -
      -

      Error Reporting

      -

      Setting the ENVIRONMENT constant to a value of ‘development’ will cause -all PHP errors to be rendered to the browser when they occur. -Conversely, setting the constant to ‘production’ will disable all error -output. Disabling error reporting in production is a good security -practice.

      -
      -
      -

      Configuration Files

      -

      Optionally, you can have CodeIgniter load environment-specific -configuration files. This may be useful for managing things like -differing API keys across multiple environments. This is described in -more detail in the environment section of the Config Class documentation.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/errors.html b/user_guide/general/errors.html deleted file mode 100755 index e0fb028..0000000 --- a/user_guide/general/errors.html +++ /dev/null @@ -1,651 +0,0 @@ - - - - - - - - - - Error Handling — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Error Handling

      -

      CodeIgniter lets you build error reporting into your applications using -the functions described below. In addition, it has an error logging -class that permits error and debugging messages to be saved as text -files.

      -
      -

      Note

      -

      By default, CodeIgniter displays all PHP errors. You might -wish to change this behavior once your development is complete. You’ll -find the error_reporting() function located at the top of your main -index.php file. Disabling error reporting will NOT prevent log files -from being written if there are errors.

      -
      -

      Unlike most systems in CodeIgniter, the error functions are simple -procedural interfaces that are available globally throughout the -application. This approach permits error messages to get triggered -without having to worry about class/function scoping.

      -

      CodeIgniter also returns a status code whenever a portion of the core -calls exit(). This exit status code is separate from the HTTP status -code, and serves as a notice to other processes that may be watching of -whether the script completed successfully, or if not, what kind of -problem it encountered that caused it to abort. These values are -defined in application/config/constants.php. While exit status codes -are most useful in CLI settings, returning the proper code helps server -software keep track of your scripts and the health of your application.

      -

      The following functions let you generate errors:

      -
      -
      -show_error($message, $status_code, $heading = 'An Error Was Encountered')
      -
      --- - - - - - -
      Parameters:
        -
      • $message (mixed) – Error message
        • -
      • $status_code (int) – HTTP Response status code
        • -
      • $heading (string) – Error page heading
        • -
      -
      Return type:

      void

      -
      -

      This function will display the error message supplied to it using -the error template appropriate to your execution:

      -
      application/views/errors/html/error_general.php
-
      -
      -

      or:

      -
      -
      application/views/errors/cli/error_general.php
      -

      The optional parameter $status_code determines what HTTP status -code should be sent with the error. If $status_code is less -than 100, the HTTP status code will be set to 500, and the exit -status code will be set to $status_code + EXIT__AUTO_MIN. -If that value is larger than EXIT__AUTO_MAX, or if -$status_code is 100 or higher, the exit status code will be set -to EXIT_ERROR. -You can check in application/config/constants.php for more detail.

      -
      - -
      -
      -show_404($page = '', $log_error = TRUE)
      -
      --- - - - - - -
      Parameters:
        -
      • $page (string) – URI string
        • -
      • $log_error (bool) – Whether to log the error
        • -
      -
      Return type:

      void

      -
      -

      This function will display the 404 error message supplied to it -using the error template appropriate to your execution:

      -
      application/views/errors/html/error_404.php
-
      -
      -

      or:

      -
      -
      application/views/errors/cli/error_404.php
      -

      The function expects the string passed to it to be the file path to -the page that isn’t found. The exit status code will be set to -EXIT_UNKNOWN_FILE. -Note that CodeIgniter automatically shows 404 messages if -controllers are not found.

      -

      CodeIgniter automatically logs any show_404() calls. Setting the -optional second parameter to FALSE will skip logging.

      -
      - -
      -
      -log_message($level, $message, $php_error = FALSE)
      -
      --- - - - - - -
      Parameters:
        -
      • $level (string) – Log level: ‘error’, ‘debug’ or ‘info’
        • -
      • $message (string) – Message to log
        • -
      • $php_error (bool) – Whether we’re logging a native PHP error message
        • -
      -
      Return type:

      void

      -
      -

      This function lets you write messages to your log files. You must -supply one of three “levels” in the first parameter, indicating what -type of message it is (debug, error, info), with the message itself -in the second parameter.

      -

      Example:

      -
      if ($some_var == '')
-{
-        log_message('error', 'Some variable did not contain a value.');
-}
-else
-{
-        log_message('debug', 'Some variable was correctly set');
-}
-
-log_message('info', 'The purpose of some variable is to provide some value.');
-
      -
      -

      There are three message types:

      -
        -
      1. Error Messages. These are actual errors, such as PHP errors or -user errors.
        2. -
      2. Debug Messages. These are messages that assist in debugging. For -example, if a class has been initialized, you could log this as -debugging info.
        3. -
      3. Informational Messages. These are the lowest priority messages, -simply giving information regarding some process.
        4. -
      -
      -

      Note

      -

      In order for the log file to actually be written, the -logs/ directory must be writable. In addition, you must -set the “threshold” for logging in -application/config/config.php. You might, for example, -only want error messages to be logged, and not the other -two types. If you set it to zero logging will be disabled.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/helpers.html b/user_guide/general/helpers.html deleted file mode 100755 index 1e92ac2..0000000 --- a/user_guide/general/helpers.html +++ /dev/null @@ -1,630 +0,0 @@ - - - - - - - - - - Helper Functions — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Helper Functions

      -

      Helpers, as the name suggests, help you with tasks. Each helper file is -simply a collection of functions in a particular category. There are URL -Helpers, that assist in creating links, there are Form Helpers that help -you create form elements, Text Helpers perform various text formatting -routines, Cookie Helpers set and read cookies, File Helpers help you -deal with files, etc.

      -

      Unlike most other systems in CodeIgniter, Helpers are not written in an -Object Oriented format. They are simple, procedural functions. Each -helper function performs one specific task, with no dependence on other -functions.

      -

      CodeIgniter does not load Helper Files by default, so the first step in -using a Helper is to load it. Once loaded, it becomes globally available -in your controller and -views.

      -

      Helpers are typically stored in your system/helpers, or -application/helpers directory. CodeIgniter will look first in your -application/helpers directory. If the directory does not exist or the -specified helper is not located there CI will instead look in your -global system/helpers/ directory.

      -
      -

      Loading a Helper

      -

      Loading a helper file is quite simple using the following method:

      -
      $this->load->helper('name');
-
      -
      -

      Where name is the file name of the helper, without the .php file -extension or the “helper” part.

      -

      For example, to load the URL Helper file, which is named -url_helper.php, you would do this:

      -
      $this->load->helper('url');
-
      -
      -

      A helper can be loaded anywhere within your controller methods (or -even within your View files, although that’s not a good practice), as -long as you load it before you use it. You can load your helpers in your -controller constructor so that they become available automatically in -any function, or you can load a helper in a specific function that needs -it.

      -
      -

      Note

      -

      The Helper loading method above does not return a value, so -don’t try to assign it to a variable. Just use it as shown.

      -
      -
      -
      -

      Loading Multiple Helpers

      -

      If you need to load more than one helper you can specify them in an -array, like this:

      -
      $this->load->helper(
-        array('helper1', 'helper2', 'helper3')
-);
-
      -
      -
      -
      -

      Auto-loading Helpers

      -

      If you find that you need a particular helper globally throughout your -application, you can tell CodeIgniter to auto-load it during system -initialization. This is done by opening the application/config/autoload.php -file and adding the helper to the autoload array.

      -
      -
      -

      Using a Helper

      -

      Once you’ve loaded the Helper File containing the function you intend to -use, you’ll call it the way you would a standard PHP function.

      -

      For example, to create a link using the anchor() function in one of -your view files you would do this:

      -
      <?php echo anchor('blog/comments', 'Click Here');?>
-
      -
      -

      Where “Click Here” is the name of the link, and “blog/comments” is the -URI to the controller/method you wish to link to.

      -
      -
      -

      “Extending” Helpers

      -

      To “extend” Helpers, create a file in your application/helpers/ folder -with an identical name to the existing Helper, but prefixed with MY_ -(this item is configurable. See below.).

      -

      If all you need to do is add some functionality to an existing helper - -perhaps add a function or two, or change how a particular helper -function operates - then it’s overkill to replace the entire helper with -your version. In this case it’s better to simply “extend” the Helper.

      -
      -

      Note

      -

      The term “extend” is used loosely since Helper functions are -procedural and discrete and cannot be extended in the traditional -programmatic sense. Under the hood, this gives you the ability to -add to or or to replace the functions a Helper provides.

      -
      -

      For example, to extend the native Array Helper you’ll create a file -named application/helpers/MY_array_helper.php, and add or override -functions:

      -
      // any_in_array() is not in the Array Helper, so it defines a new function
-function any_in_array($needle, $haystack)
-{
-        $needle = is_array($needle) ? $needle : array($needle);
-
-        foreach ($needle as $item)
-        {
-                if (in_array($item, $haystack))
-                {
-                        return TRUE;
-                }
-        }
-
-        return FALSE;
-}
-
-// random_element() is included in Array Helper, so it overrides the native function
-function random_element($array)
-{
-        shuffle($array);
-        return array_pop($array);
-}
-
      -
      -
      -

      Setting Your Own Prefix

      -

      The filename prefix for “extending” Helpers is the same used to extend -libraries and core classes. To set your own prefix, open your -application/config/config.php file and look for this item:

      -
      $config['subclass_prefix'] = 'MY_';
-
      -
      -

      Please note that all native CodeIgniter libraries are prefixed with CI_ -so DO NOT use that as your prefix.

      -
      -
      -
      -

      Now What?

      -

      In the Table of Contents you’ll find a list of all the available Helper -Files. Browse each one to see what they do.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/hooks.html b/user_guide/general/hooks.html deleted file mode 100755 index f150830..0000000 --- a/user_guide/general/hooks.html +++ /dev/null @@ -1,618 +0,0 @@ - - - - - - - - - - Hooks - Extending the Framework Core — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Hooks - Extending the Framework Core

      -

      CodeIgniter’s Hooks feature provides a means to tap into and modify the -inner workings of the framework without hacking the core files. When -CodeIgniter runs it follows a specific execution process, diagramed in -the Application Flow page. There may be -instances, however, where you’d like to cause some action to take place -at a particular stage in the execution process. For example, you might -want to run a script right before your controllers get loaded, or right -after, or you might want to trigger one of your own scripts in some -other location.

      -
      -

      Enabling Hooks

      -

      The hooks feature can be globally enabled/disabled by setting the -following item in the application/config/config.php file:

      -
      $config['enable_hooks'] = TRUE;
-
      -
      -
      -
      -

      Defining a Hook

      -

      Hooks are defined in the application/config/hooks.php file. -Each hook is specified as an array with this prototype:

      -
      $hook['pre_controller'] = array(
-        'class'    => 'MyClass',
-        'function' => 'Myfunction',
-        'filename' => 'Myclass.php',
-        'filepath' => 'hooks',
-        'params'   => array('beer', 'wine', 'snacks')
-);
-
      -
      -

      Notes:

      -

      The array index correlates to the name of the particular hook point you -want to use. In the above example the hook point is pre_controller. A -list of hook points is found below. The following items should be -defined in your associative hook array:

      -
        -
      • class The name of the class you wish to invoke. If you prefer to -use a procedural function instead of a class, leave this item blank.
        • -
      • function The function (or method) name you wish to call.
        • -
      • filename The file name containing your class/function.
        • -
      • filepath The name of the directory containing your script. -Note: -Your script must be located in a directory INSIDE your application/ -directory, so the file path is relative to that directory. For example, -if your script is located in application/hooks/, you will simply use -‘hooks’ as your filepath. If your script is located in -application/hooks/utilities/ you will use ‘hooks/utilities’ as your -filepath. No trailing slash.
        • -
      • params Any parameters you wish to pass to your script. This item -is optional.
        • -
      -

      If you’re running PHP 5.3+, you can also use lambda/anoymous functions -(or closures) as hooks, with a simpler syntax:

      -
      $hook['post_controller'] = function()
-{
-        /* do something here */
-};
-
      -
      -
      -
      -

      Multiple Calls to the Same Hook

      -

      If want to use the same hook point with more than one script, simply -make your array declaration multi-dimensional, like this:

      -
      $hook['pre_controller'][] = array(
-        'class'    => 'MyClass',
-        'function' => 'MyMethod',
-        'filename' => 'Myclass.php',
-        'filepath' => 'hooks',
-        'params'   => array('beer', 'wine', 'snacks')
-);
-
-$hook['pre_controller'][] = array(
-        'class'    => 'MyOtherClass',
-        'function' => 'MyOtherMethod',
-        'filename' => 'Myotherclass.php',
-        'filepath' => 'hooks',
-        'params'   => array('red', 'yellow', 'blue')
-);
-
      -
      -

      Notice the brackets after each array index:

      -
      $hook['pre_controller'][]
-
      -
      -

      This permits you to have the same hook point with multiple scripts. The -order you define your array will be the execution order.

      -
      -
      -

      Hook Points

      -

      The following is a list of available hook points.

      -
        -
      • pre_system -Called very early during system execution. Only the benchmark and -hooks class have been loaded at this point. No routing or other -processes have happened.
        • -
      • pre_controller -Called immediately prior to any of your controllers being called. -All base classes, routing, and security checks have been done.
        • -
      • post_controller_constructor -Called immediately after your controller is instantiated, but prior -to any method calls happening.
        • -
      • post_controller -Called immediately after your controller is fully executed.
        • -
      • display_override -Overrides the _display() method, used to send the finalized page -to the web browser at the end of system execution. This permits you -to use your own display methodology. Note that you will need to -reference the CI superobject with $this->CI =& get_instance() and -then the finalized data will be available by calling -$this->CI->output->get_output().
        • -
      • cache_override -Enables you to call your own method instead of the _display_cache() -method in the Output Library. This permits -you to use your own cache display mechanism.
        • -
      • post_system -Called after the final rendered page is sent to the browser, at the -end of system execution after the finalized data is sent to the -browser.
        • -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/index.html b/user_guide/general/index.html deleted file mode 100755 index fd8e635..0000000 --- a/user_guide/general/index.html +++ /dev/null @@ -1,570 +0,0 @@ - - - - - - - - - - General Topics — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • General Topics
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - - - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/libraries.html b/user_guide/general/libraries.html deleted file mode 100755 index 315e728..0000000 --- a/user_guide/general/libraries.html +++ /dev/null @@ -1,522 +0,0 @@ - - - - - - - - - - Using CodeIgniter Libraries — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Using CodeIgniter Libraries

      -

      All of the available libraries are located in your system/libraries/ -directory. In most cases, to use one of these classes involves initializing -it within a controller using the following -initialization method:

      -
      $this->load->library('class_name');
-
      -
      -

      Where ‘class_name’ is the name of the class you want to invoke. For -example, to load the Form Validation Library you would do this:

      -
      $this->load->library('form_validation');
-
      -
      -

      Once initialized you can use it as indicated in the user guide page -corresponding to that class.

      -

      Additionally, multiple libraries can be loaded at the same time by -passing an array of libraries to the load method.

      -

      Example:

      -
      $this->load->library(array('email', 'table'));
-
      -
      -
      -

      Creating Your Own Libraries

      -

      Please read the section of the user guide that discusses how to -create your own libraries.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/managing_apps.html b/user_guide/general/managing_apps.html deleted file mode 100755 index 76602f6..0000000 --- a/user_guide/general/managing_apps.html +++ /dev/null @@ -1,555 +0,0 @@ - - - - - - - - - - Managing your Applications — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Managing your Applications

      -

      By default it is assumed that you only intend to use CodeIgniter to -manage one application, which you will build in your application/ -directory. It is possible, however, to have multiple sets of -applications that share a single CodeIgniter installation, or even to -rename or relocate your application directory.

      -
      -

      Renaming the Application Directory

      -

      If you would like to rename your application directory you may do so -as long as you open your main index.php file and set its name using -the $application_folder variable:

      -
      $application_folder = 'application';
-
      -
      -
      -
      -

      Relocating your Application Directory

      -

      It is possible to move your application directory to a different -location on your server than your web root. To do so open -your main index.php and set a full server path in the -$application_folder variable:

      -
      $application_folder = '/path/to/your/application';
-
      -
      -
      -
      -

      Running Multiple Applications with one CodeIgniter Installation

      -

      If you would like to share a common CodeIgniter installation to manage -several different applications simply put all of the directories located -inside your application directory into their own sub-directory.

      -

      For example, let’s say you want to create two applications, named “foo” -and “bar”. You could structure your application directories like this:

      -
      applications/foo/
-applications/foo/config/
-applications/foo/controllers/
-applications/foo/libraries/
-applications/foo/models/
-applications/foo/views/
-applications/bar/
-applications/bar/config/
-applications/bar/controllers/
-applications/bar/libraries/
-applications/bar/models/
-applications/bar/views/
-
      -
      -

      To select a particular application for use requires that you open your -main index.php file and set the $application_folder variable. For -example, to select the “foo” application for use you would do this:

      -
      $application_folder = 'applications/foo';
-
      -
      -
      -

      Note

      -

      Each of your applications will need its own index.php file -which calls the desired application. The index.php file can be named -anything you want.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/models.html b/user_guide/general/models.html deleted file mode 100755 index 5b07002..0000000 --- a/user_guide/general/models.html +++ /dev/null @@ -1,690 +0,0 @@ - - - - - - - - - - Models — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Models

      -

      Models are optionally available for those who want to use a more -traditional MVC approach.

      -
      -

      Page Contents

      - -
      -
      -

      What is a Model?

      -

      Models are PHP classes that are designed to work with information in -your database. For example, let’s say you use CodeIgniter to manage a -blog. You might have a model class that contains functions to insert, -update, and retrieve your blog data. Here is an example of what such a -model class might look like:

      -
      class Blog_model extends CI_Model {
-
-        public $title;
-        public $content;
-        public $date;
-
-        public function __construct()
-        {
-                // Call the CI_Model constructor
-                parent::__construct();
-        }
-
-        public function get_last_ten_entries()
-        {
-                $query = $this->db->get('entries', 10);
-                return $query->result();
-        }
-
-        public function insert_entry()
-        {
-                $this->title    = $_POST['title']; // please read the below note
-                $this->content  = $_POST['content'];
-                $this->date     = time();
-
-                $this->db->insert('entries', $this);
-        }
-
-        public function update_entry()
-        {
-                $this->title    = $_POST['title'];
-                $this->content  = $_POST['content'];
-                $this->date     = time();
-
-                $this->db->update('entries', $this, array('id' => $_POST['id']));
-        }
-
-}
-
      -
      -
      -

      Note

      -

      The methods in the above example use the Query Builder database methods.

      -
      -
      -

      Note

      -

      For the sake of simplicity in this example we’re using $_POST -directly. This is generally bad practice, and a more common approach -would be to use the Input Library -$this->input->post('title').

      -
      -
      -
      -

      Anatomy of a Model

      -

      Model classes are stored in your application/models/ directory. -They can be nested within sub-directories if you want this type of -organization.

      -

      The basic prototype for a model class is this:

      -
      class Model_name extends CI_Model {
-
-        public function __construct()
-        {
-                parent::__construct();
-        }
-
-}
-
      -
      -

      Where Model_name is the name of your class. Class names must have -the first letter capitalized with the rest of the name lowercase. Make -sure your class extends the base Model class.

      -

      The file name must match the class name. For example, if this is your class:

      -
      class User_model extends CI_Model {
-
-        public function __construct()
-        {
-                parent::__construct();
-        }
-
-}
-
      -
      -

      Your file will be this:

      -
      application/models/User_model.php
-
      -
      -
      -
      -

      Loading a Model

      -

      Your models will typically be loaded and called from within your -controller methods. To load a model you will use -the following method:

      -
      $this->load->model('model_name');
-
      -
      -

      If your model is located in a sub-directory, include the relative path -from your models directory. For example, if you have a model located at -application/models/blog/Queries.php you’ll load it using:

      -
      $this->load->model('blog/queries');
-
      -
      -

      Once loaded, you will access your model methods using an object with the -same name as your class:

      -
      $this->load->model('model_name');
-
-$this->model_name->method();
-
      -
      -

      If you would like your model assigned to a different object name you can -specify it via the second parameter of the loading method:

      -
      $this->load->model('model_name', 'foobar');
-
-$this->foobar->method();
-
      -
      -

      Here is an example of a controller, that loads a model, then serves a -view:

      -
      class Blog_controller extends CI_Controller {
-
-        public function blog()
-        {
-                $this->load->model('blog');
-
-                $data['query'] = $this->blog->get_last_ten_entries();
-
-                $this->load->view('blog', $data);
-        }
-}
-
      -
      -
      -
      -

      Auto-loading Models

      -

      If you find that you need a particular model globally throughout your -application, you can tell CodeIgniter to auto-load it during system -initialization. This is done by opening the -application/config/autoload.php file and adding the model to the -autoload array.

      -
      -
      -

      Connecting to your Database

      -

      When a model is loaded it does NOT connect automatically to your -database. The following options for connecting are available to you:

      -
        -

      • You can connect using the standard database methods described -here, either from within your -Controller class or your Model class.

        -
        • -

      • You can tell the model loading method to auto-connect by passing -TRUE (boolean) via the third parameter, and connectivity settings, -as defined in your database config file will be used:

        -
        $this->load->model('model_name', '', TRUE);
-
        -
        -
        • -

      • You can manually pass database connectivity settings via the third -parameter:

        -
        $config['hostname'] = 'localhost';
-$config['username'] = 'myusername';
-$config['password'] = 'mypassword';
-$config['database'] = 'mydatabase';
-$config['dbdriver'] = 'mysqli';
-$config['dbprefix'] = '';
-$config['pconnect'] = FALSE;
-$config['db_debug'] = TRUE;
-
-$this->load->model('model_name', '', $config);
-
        -
        -
        • -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/profiling.html b/user_guide/general/profiling.html deleted file mode 100755 index 5a931c2..0000000 --- a/user_guide/general/profiling.html +++ /dev/null @@ -1,625 +0,0 @@ - - - - - - - - - - Profiling Your Application — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Profiling Your Application

      -

      The Profiler Class will display benchmark results, queries you have run, -and $_POST data at the bottom of your pages. This information can be -useful during development in order to help with debugging and -optimization.

      -
      -

      Initializing the Class

      -
      -

      Important

      -

      This class does NOT need to be initialized. It is loaded -automatically by the Output Library -if profiling is enabled as shown below.

      -
      -
      -
      -

      Enabling the Profiler

      -

      To enable the profiler place the following line anywhere within your -Controller methods:

      -
      $this->output->enable_profiler(TRUE);
-
      -
      -

      When enabled a report will be generated and inserted at the bottom of -your pages.

      -

      To disable the profiler you will use:

      -
      $this->output->enable_profiler(FALSE);
-
      -
      -
      -
      -

      Setting Benchmark Points

      -

      In order for the Profiler to compile and display your benchmark data you -must name your mark points using specific syntax.

      -

      Please read the information on setting Benchmark points in the -Benchmark Library page.

      -
      -
      -

      Enabling and Disabling Profiler Sections

      -

      Each section of Profiler data can be enabled or disabled by setting a -corresponding config variable to TRUE or FALSE. This can be done one of -two ways. First, you can set application wide defaults with the -application/config/profiler.php config file.

      -

      Example:

      -
      $config['config']          = FALSE;
-$config['queries']         = FALSE;
-
      -
      -

      In your controllers, you can override the defaults and config file -values by calling the set_profiler_sections() method of the -Output Library:

      -
      $sections = array(
-        'config'  => TRUE,
-        'queries' => TRUE
-);
-
-$this->output->set_profiler_sections($sections);
-
      -
      -

      Available sections and the array key used to access them are described -in the table below.

      - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      KeyDescriptionDefault
      benchmarksElapsed time of Benchmark points and total execution timeTRUE
      configCodeIgniter Config variablesTRUE
      controller_infoThe Controller class and method requestedTRUE
      getAny GET data passed in the requestTRUE
      http_headersThe HTTP headers for the current requestTRUE
      memory_usageAmount of memory consumed by the current request, in bytesTRUE
      postAny POST data passed in the requestTRUE
      queriesListing of all database queries executed, including execution timeTRUE
      uri_stringThe URI of the current requestTRUE
      session_dataData stored in the current sessionTRUE
      query_toggle_countThe number of queries after which the query block will default to -hidden.25
      -
      -

      Note

      -

      Disabling the save_queries setting in -your database configuration will also effectively disable profiling for -database queries and render the ‘queries’ setting above useless. You can -optionally override this setting with $this->db->save_queries = TRUE;. -Without this setting you won’t be able to view the queries or the -last_query <database/helpers>.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/requirements.html b/user_guide/general/requirements.html deleted file mode 100755 index 599d578..0000000 --- a/user_guide/general/requirements.html +++ /dev/null @@ -1,512 +0,0 @@ - - - - - - - - - - Server Requirements — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Server Requirements
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Server Requirements

      -

      PHP version 5.4 or newer is recommended.

      -

      It should work on 5.2.4 as well, but we strongly advise you NOT to run -such old versions of PHP, because of potential security and performance -issues, as well as missing features.

      -

      A database is required for most web application programming. -Currently supported databases are:

      -
      -
        -
      • MySQL (5.1+) via the mysql (deprecated), mysqli and pdo drivers
        • -
      • Oracle via the oci8 and pdo drivers
        • -
      • PostgreSQL via the postgre and pdo drivers
        • -
      • MS SQL via the mssql, sqlsrv (version 2005 and above only) and pdo drivers
        • -
      • SQLite via the sqlite (version 2), sqlite3 (version 3) and pdo drivers
        • -
      • CUBRID via the cubrid and pdo drivers
        • -
      • Interbase/Firebird via the ibase and pdo drivers
        • -
      • ODBC via the odbc and pdo drivers (you should know that ODBC is actually an abstraction layer)
        • -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/reserved_names.html b/user_guide/general/reserved_names.html deleted file mode 100755 index 16c162e..0000000 --- a/user_guide/general/reserved_names.html +++ /dev/null @@ -1,584 +0,0 @@ - - - - - - - - - - Reserved Names — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Reserved Names

      -

      In order to help out, CodeIgniter uses a series of function, method, -class and variable names in its operation. Because of this, some names -cannot be used by a developer. Following is a list of reserved names -that cannot be used.

      -
      -

      Controller names

      -

      Since your controller classes will extend the main application -controller you must be careful not to name your methods identically to -the ones used by that class, otherwise your local methods will -override them. The following is a list of reserved names. Do not name -your controller any of these:

      -
        -
      • CI_Controller
        • -
      • Default
        • -
      • index
        • -
      -
      -
      -

      Functions

      - -
      -
      -

      Variables

      -
        -
      • $config
        • -
      • $db
        • -
      • $lang
        • -
      -
      -
      -

      Constants

      -
        -
      • ENVIRONMENT
        • -
      • FCPATH
        • -
      • SELF
        • -
      • BASEPATH
        • -
      • APPPATH
        • -
      • VIEWPATH
        • -
      • CI_VERSION
        • -
      • MB_ENABLED
        • -
      • ICONV_ENABLED
        • -
      • UTF8_ENABLED
        • -
      • FILE_READ_MODE
        • -
      • FILE_WRITE_MODE
        • -
      • DIR_READ_MODE
        • -
      • DIR_WRITE_MODE
        • -
      • FOPEN_READ
        • -
      • FOPEN_READ_WRITE
        • -
      • FOPEN_WRITE_CREATE_DESTRUCTIVE
        • -
      • FOPEN_READ_WRITE_CREATE_DESTRUCTIVE
        • -
      • FOPEN_WRITE_CREATE
        • -
      • FOPEN_READ_WRITE_CREATE
        • -
      • FOPEN_WRITE_CREATE_STRICT
        • -
      • FOPEN_READ_WRITE_CREATE_STRICT
        • -
      • SHOW_DEBUG_BACKTRACE
        • -
      • EXIT_SUCCESS
        • -
      • EXIT_ERROR
        • -
      • EXIT_CONFIG
        • -
      • EXIT_UNKNOWN_FILE
        • -
      • EXIT_UNKNOWN_CLASS
        • -
      • EXIT_UNKNOWN_METHOD
        • -
      • EXIT_USER_INPUT
        • -
      • EXIT_DATABASE
        • -
      • EXIT__AUTO_MIN
        • -
      • EXIT__AUTO_MAX
        • -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/routing.html b/user_guide/general/routing.html deleted file mode 100755 index 88f40e2..0000000 --- a/user_guide/general/routing.html +++ /dev/null @@ -1,691 +0,0 @@ - - - - - - - - - - URI Routing — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      URI Routing

      -

      Typically there is a one-to-one relationship between a URL string and -its corresponding controller class/method. The segments in a URI -normally follow this pattern:

      -
      example.com/class/function/id/
-
      -
      -

      In some instances, however, you may want to remap this relationship so -that a different class/method can be called instead of the one -corresponding to the URL.

      -

      For example, let’s say you want your URLs to have this prototype:

      -
      example.com/product/1/
-example.com/product/2/
-example.com/product/3/
-example.com/product/4/
-
      -
      -

      Normally the second segment of the URL is reserved for the method -name, but in the example above it instead has a product ID. To -overcome this, CodeIgniter allows you to remap the URI handler.

      -
      -

      Setting your own routing rules

      -

      Routing rules are defined in your application/config/routes.php file. -In it you’ll see an array called $route that permits you to specify -your own routing criteria. Routes can either be specified using wildcards -or Regular Expressions.

      -
      -
      -

      Wildcards

      -

      A typical wildcard route might look something like this:

      -
      $route['product/:num'] = 'catalog/product_lookup';
-
      -
      -

      In a route, the array key contains the URI to be matched, while the -array value contains the destination it should be re-routed to. In the -above example, if the literal word “product” is found in the first -segment of the URL, and a number is found in the second segment, the -“catalog” class and the “product_lookup” method are instead used.

      -

      You can match literal values or you can use two wildcard types:

      -

      (:num) will match a segment containing only numbers. -(:any) will match a segment containing any character (except for ‘/’, which is the segment delimiter).

      -
      -

      Note

      -

      Wildcards are actually aliases for regular expressions, with -:any being translated to [^/]+ and :num to [0-9]+, -respectively.

      -
      -
      -

      Note

      -

      Routes will run in the order they are defined. Higher routes -will always take precedence over lower ones.

      -
      -
      -

      Note

      -

      Route rules are not filters! Setting a rule of e.g. -‘foo/bar/(:num)’ will not prevent controller Foo and method -bar to be called with a non-numeric value if that is a valid -route.

      -
      -
      -
      -

      Examples

      -

      Here are a few routing examples:

      -
      $route['journals'] = 'blogs';
-
      -
      -

      A URL containing the word “journals” in the first segment will be -remapped to the “blogs” class.

      -
      $route['blog/joe'] = 'blogs/users/34';
-
      -
      -

      A URL containing the segments blog/joe will be remapped to the “blogs” -class and the “users” method. The ID will be set to “34”.

      -
      $route['product/(:any)'] = 'catalog/product_lookup';
-
      -
      -

      A URL with “product” as the first segment, and anything in the second -will be remapped to the “catalog” class and the “product_lookup” -method.

      -
      $route['product/(:num)'] = 'catalog/product_lookup_by_id/$1';
-
      -
      -

      A URL with “product” as the first segment, and a number in the second -will be remapped to the “catalog” class and the -“product_lookup_by_id” method passing in the match as a variable to -the method.

      -
      -

      Important

      -

      Do not use leading/trailing slashes.

      -
      -
      -
      -

      Regular Expressions

      -

      If you prefer you can use regular expressions to define your routing -rules. Any valid regular expression is allowed, as are back-references.

      -
      -

      Note

      -

      If you use back-references you must use the dollar syntax -rather than the double backslash syntax.

      -
      -

      A typical RegEx route might look something like this:

      -
      $route['products/([a-z]+)/(\d+)'] = '$1/id_$2';
-
      -
      -

      In the above example, a URI similar to products/shirts/123 would instead -call the “shirts” controller class and the “id_123” method.

      -

      With regular expressions, you can also catch a segment containing a -forward slash (‘/’), which would usually represent the delimiter between -multiple segments.

      -

      For example, if a user accesses a password protected area of your web -application and you wish to be able to redirect them back to the same -page after they log in, you may find this example useful:

      -
      $route['login/(.+)'] = 'auth/login/$1';
-
      -
      -

      For those of you who don’t know regular expressions and want to learn -more about them, regular-expressions.info <http://www.regular-expressions.info/> -might be a good starting point.

      -
      -

      Note

      -

      You can also mix and match wildcards with regular expressions.

      -
      -
      -
      -

      Callbacks

      -

      If you are using PHP >= 5.3 you can use callbacks in place of the normal -routing rules to process the back-references. Example:

      -
      $route['products/([a-zA-Z]+)/edit/(\d+)'] = function ($product_type, $id)
-{
-        return 'catalog/product_edit/' . strtolower($product_type) . '/' . $id;
-};
-
      -
      -
      -
      -

      Using HTTP verbs in routes

      -

      It is possible to use HTTP verbs (request method) to define your routing rules. -This is particularly useful when building RESTful applications. You can use standard HTTP -verbs (GET, PUT, POST, DELETE, PATCH) or a custom one such (e.g. PURGE). HTTP verb rules -are case-insensitive. All you need to do is to add the verb as an array key to your route. -Example:

      -
      $route['products']['put'] = 'product/insert';
-
      -
      -

      In the above example, a PUT request to URI “products” would call the Product::insert() -controller method.

      -
      $route['products/(:num)']['DELETE'] = 'product/delete/$1';
-
      -
      -

      A DELETE request to URL with “products” as first the segment and a number in the second will be -mapped to the Product::delete() method, passing the numeric value as the first parameter.

      -

      Using HTTP verbs is of course, optional.

      -
      -
      -

      Reserved Routes

      -

      There are three reserved routes:

      -
      $route['default_controller'] = 'welcome';
-
      -
      -

      This route points to the action that should be executed if the URI contains -no data, which will be the case when people load your root URL. -The setting accepts a controller/method value and index() would be -the default method if you don’t specify one. In the above example, it is -Welcome::index() that would be called.

      -
      -

      Note

      -

      You can NOT use a directory as a part of this setting!

      -
      -

      You are encouraged to always have a default route as otherwise a 404 page -will appear by default.

      -
      $route['404_override'] = '';
-
      -
      -

      This route indicates which controller class should be loaded if the -requested controller is not found. It will override the default 404 -error page. Same per-directory rules as with ‘default_controller’ -apply here as well.

      -

      It won’t affect to the show_404() function, which will -continue loading the default error_404.php file at -application/views/errors/error_404.php.

      -
      $route['translate_uri_dashes'] = FALSE;
-
      -
      -

      As evident by the boolean value, this is not exactly a route. This -option enables you to automatically replace dashes (‘-‘) with -underscores in the controller and method URI segments, thus saving you -additional route entries if you need to do that. -This is required, because the dash isn’t a valid class or method name -character and would cause a fatal error if you try to use it.

      -
      -

      Important

      -

      The reserved routes must come before any wildcard or -regular expression routes.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/security.html b/user_guide/general/security.html deleted file mode 100755 index 17fc6bf..0000000 --- a/user_guide/general/security.html +++ /dev/null @@ -1,668 +0,0 @@ - - - - - - - - - - Security — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Security

      -

      This page describes some “best practices” regarding web security, and -details CodeIgniter’s internal security features.

      -
      -

      Note

      -

      If you came here looking for a security contact, please refer to -our Contribution Guide <../contributing/index>.

      -
      -
      -

      URI Security

      -

      CodeIgniter is fairly restrictive regarding which characters it allows -in your URI strings in order to help minimize the possibility that -malicious data can be passed to your application. URIs may only contain -the following:

      -
        -
      • Alpha-numeric text (latin characters only)
        • -
      • Tilde: ~
        • -
      • Percent sign: %
        • -
      • Period: .
        • -
      • Colon: :
        • -
      • Underscore: _
        • -
      • Dash: -
        • -
      • Space
        • -
      -
      -
      -

      Register_globals

      -

      During system initialization all global variables that are found to exist -in the $_GET, $_POST, $_REQUEST and $_COOKIE are unset.

      -

      The unsetting routine is effectively the same as register_globals = off.

      -
      -
      -

      display_errors

      -

      In production environments, it is typically desirable to “disable” PHP’s -error reporting by setting the internal display_errors flag to a value -of 0. This disables native PHP errors from being rendered as output, -which may potentially contain sensitive information.

      -

      Setting CodeIgniter’s ENVIRONMENT constant in index.php to a value of -‘production’ will turn off these errors. In development mode, it is -recommended that a value of ‘development’ is used. More information -about differentiating between environments can be found on the -Handling Environments page.

      -
      -
      -

      magic_quotes_runtime

      -

      The magic_quotes_runtime directive is turned off during system -initialization so that you don’t have to remove slashes when retrieving -data from your database.

      -
      -

      Best Practices

      -

      Before accepting any data into your application, whether it be POST data -from a form submission, COOKIE data, URI data, XML-RPC data, or even -data from the SERVER array, you are encouraged to practice this three -step approach:

      -
        -
      1. Validate the data to ensure it conforms to the correct type, length, -size, etc.
        2. -
      2. Filter the data as if it were tainted.
        3. -
      3. Escape the data before submitting it into your database or outputting -it to a browser.
        4. -
      -

      CodeIgniter provides the following functions and tips to assist you -in this process:

      -
      -
      -
      -

      XSS Filtering

      -

      CodeIgniter comes with a Cross Site Scripting filter. This filter -looks for commonly used techniques to embed malicious JavaScript into -your data, or other types of code that attempt to hijack cookies or -do other malicious things. The XSS Filter is described -here.

      -
      -

      Note

      -

      XSS filtering should only be performed on output. Filtering -input data may modify the data in undesirable ways, including -stripping special characters from passwords, which reduces -security instead of improving it.

      -
      -
      -
      -

      CSRF protection

      -

      CSRF stands for Cross-Site Request Forgery, which is the process of an -attacker tricking their victim into unknowingly submitting a request.

      -

      CodeIgniter provides CSRF protection out of the box, which will get -automatically triggered for every non-GET HTTP request, but also needs -you to create your submit forms in a certain way. This is explained in -the Security Library documentation.

      -
      -
      -

      Password handling

      -

      It is critical that you handle passwords in your application properly.

      -

      Unfortunately, many developers don’t know how to do that, and the web is -full of outdated or otherwise wrongful advices, which doesn’t help.

      -

      We would like to give you a list of combined do’s and don’ts to help you -with that. Please read below.

      -
        -

      • DO NOT store passwords in plain-text format.

        -

        Always hash your passwords.

        -
        • -

      • DO NOT use Base64 or similar encoding for storing passwords.

        -

        This is as good as storing them in plain-text. Really. Do hashing, -not encoding.

        -

        Encoding, and encryption too, are two-way processes. Passwords are -secrets that must only be known to their owner, and thus must work -only in one direction. Hashing does that - there’s no un-hashing or -de-hashing, but there is decoding and decryption.

        -
        • -

      • DO NOT use weak or broken hashing algorithms like MD5 or SHA1.

        -

        These algorithms are old, proven to be flawed, and not designed for -password hashing in the first place.

        -

        Also, DON’T invent your own algorithms.

        -

        Only use strong password hashing algorithms like BCrypt, which is used -in PHP’s own Password Hashing functions.

        -

        Please use them, even if you’re not running PHP 5.5+, CodeIgniter -provides them for you as long as you’re running at least PHP version -5.3.7 (and if you don’t meet that requirement - please, upgrade).

        -

        If you’re one of the really unlucky people who can’t even upgrade to a -more recent PHP version, use hash_pbkdf() <http://php.net/hash_pbkdf2>, -which we also provide in our compatibility layer.

        -
        • -

      • DO NOT ever display or send a password in plain-text format!

        -

        Even to the password’s owner, if you need a “Forgotten password” -feature, just randomly generate a new, one-time (this is also important) -password and send that instead.

        -
        • -

      • DO NOT put unnecessary limits on your users’ passwords.

        -

        If you’re using a hashing algorithm other than BCrypt (which has a limit -of 72 characters), you should set a relatively high limit on password -lengths in order to mitigate DoS attacks - say, 1024 characters.

        -

        Other than that however, there’s no point in forcing a rule that a -password can only be up to a number of characters, or that it can’t -contain a certain set of special characters.

        -

        Not only does this reduce security instead of improving it, but -there’s literally no reason to do it. No technical limitations and -no (practical) storage constraints apply once you’ve hashed them, none!

        -
        • -
      -
      -
      -

      Validate input data

      -

      CodeIgniter has a Form Validation Library that assists you in -validating, filtering, and prepping your data.

      -

      Even if that doesn’t work for your use case however, be sure to always -validate and sanitize all input data. For example, if you expect a numeric -string for an input variable, you can check for that with is_numeric() -or ctype_digit(). Always try to narrow down your checks to a certain -pattern.

      -

      Have it in mind that this includes not only $_POST and $_GET -variables, but also cookies, the user-agent string and basically -all data that is not created directly by your own code.

      -
      -
      -

      Escape all data before database insertion

      -

      Never insert information into your database without escaping it. -Please see the section that discusses database queries for more information.

      -
      -
      -

      Hide your files

      -

      Another good security practice is to only leave your index.php -and “assets” (e.g. .js, css and image files) under your server’s -webroot directory (most commonly named “htdocs/”). These are -the only files that you would need to be accessible from the web.

      -

      Allowing your visitors to see anything else would potentially -allow them to access sensitive data, execute scripts, etc.

      -

      If you’re not allowed to do that, you can try using a .htaccess -file to restrict access to those resources.

      -

      CodeIgniter will have an index.html file in all of its -directories in an attempt to hide some of this data, but have -it in mind that this is not enough to prevent a serious -attacker.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/styleguide.html b/user_guide/general/styleguide.html deleted file mode 100755 index 305567d..0000000 --- a/user_guide/general/styleguide.html +++ /dev/null @@ -1,1129 +0,0 @@ - - - - - - - - - - PHP Style Guide — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      PHP Style Guide

      -

      The following page describes the coding styles adhered to when -contributing to the development of CodeIgniter. There is no requirement -to use these styles in your own CodeIgniter application, though they -are recommended.

      - -
      -

      File Format

      -

      Files should be saved with Unicode (UTF-8) encoding. The BOM should -not be used. Unlike UTF-16 and UTF-32, there’s no byte order to -indicate in a UTF-8 encoded file, and the BOM can have a negative side -effect in PHP of sending output, preventing the application from being -able to set its own headers. Unix line endings should be used (LF).

      -

      Here is how to apply these settings in some of the more common text -editors. Instructions for your text editor may vary; check your text -editor’s documentation.

      -
      -

      TextMate

      -
        -
      1. Open the Application Preferences
        2. -
      2. Click Advanced, and then the “Saving” tab
        3. -
      3. In “File Encoding”, select “UTF-8 (recommended)”
        4. -
      4. In “Line Endings”, select “LF (recommended)”
        5. -
      5. Optional: Check “Use for existing files as well” if you wish to -modify the line endings of files you open to your new preference.
        6. -
      -
      -
      -

      BBEdit

      -
        -
      1. Open the Application Preferences
        2. -
      2. Select “Text Encodings” on the left.
        3. -
      3. In “Default text encoding for new documents”, select “Unicode (UTF-8, -no BOM)”
        4. -
      4. Optional: In “If file’s encoding can’t be guessed, use”, select -“Unicode (UTF-8, no BOM)”
        5. -
      5. Select “Text Files” on the left.
        6. -
      6. In “Default line breaks”, select “Mac OS X and Unix (LF)”
        7. -
      -
      -
      -
      -

      PHP Closing Tag

      -

      The PHP closing tag on a PHP document ?> is optional to the PHP -parser. However, if used, any whitespace following the closing tag, -whether introduced by the developer, user, or an FTP application, can -cause unwanted output, PHP errors, or if the latter are suppressed, -blank pages. For this reason, all PHP files MUST OMIT the PHP closing -tag and end with a single empty line instead.

      -
      -
      -

      File Naming

      -

      Class files must be named in a Ucfirst-like manner, while any other file name -(configurations, views, generic scripts, etc.) should be in all lowercase.

      -

      INCORRECT:

      -
      somelibrary.php
-someLibrary.php
-SOMELIBRARY.php
-Some_Library.php
-
-Application_config.php
-Application_Config.php
-applicationConfig.php
-
      -
      -

      CORRECT:

      -
      Somelibrary.php
-Some_library.php
-
-applicationconfig.php
-application_config.php
-
      -
      -

      Furthermore, class file names should match the name of the class itself. -For example, if you have a class named Myclass, then its filename must -be Myclass.php.

      -
      -
      -

      Class and Method Naming

      -

      Class names should always start with an uppercase letter. Multiple words -should be separated with an underscore, and not CamelCased.

      -

      INCORRECT:

      -
      class superclass
-class SuperClass
-
      -
      -

      CORRECT:

      -
      class Super_class
-
      -
      -
      class Super_class {
-
-        public function __construct()
-        {
-
-        }
-}
-
      -
      -

      Class methods should be entirely lowercased and named to clearly -indicate their function, preferably including a verb. Try to avoid -overly long and verbose names. Multiple words should be separated -with an underscore.

      -

      INCORRECT:

      -
      function fileproperties()               // not descriptive and needs underscore separator
-function fileProperties()               // not descriptive and uses CamelCase
-function getfileproperties()            // Better!  But still missing underscore separator
-function getFileProperties()            // uses CamelCase
-function get_the_file_properties_from_the_file()        // wordy
-
      -
      -

      CORRECT:

      -
      function get_file_properties()  // descriptive, underscore separator, and all lowercase letters
-
      -
      -
      -
      -

      Variable Names

      -

      The guidelines for variable naming are very similar to those used for -class methods. Variables should contain only lowercase letters, -use underscore separators, and be reasonably named to indicate their -purpose and contents. Very short, non-word variables should only be used -as iterators in for() loops.

      -

      INCORRECT:

      -
      $j = 'foo';             // single letter variables should only be used in for() loops
-$Str                    // contains uppercase letters
-$bufferedText           // uses CamelCasing, and could be shortened without losing semantic meaning
-$groupid                // multiple words, needs underscore separator
-$name_of_last_city_used // too long
-
      -
      -

      CORRECT:

      -
      for ($j = 0; $j < 10; $j++)
-$str
-$buffer
-$group_id
-$last_city
-
      -
      -
      -
      -

      Commenting

      -

      In general, code should be commented prolifically. It not only helps -describe the flow and intent of the code for less experienced -programmers, but can prove invaluable when returning to your own code -months down the line. There is not a required format for comments, but -the following are recommended.

      -

      DocBlock -style comments preceding class, method, and property declarations so they can be -picked up by IDEs:

      -
      /**
- * Super Class
- *
- * @package     Package Name
- * @subpackage  Subpackage
- * @category    Category
- * @author      Author Name
- * @link        http://example.com
- */
-class Super_class {
-
      -
      -
      /**
- * Encodes string for use in XML
- *
- * @param       string  $str    Input string
- * @return      string
- */
-function xml_encode($str)
-
      -
      -
      /**
- * Data for class manipulation
- *
- * @var array
- */
-public $data = array();
-
      -
      -

      Use single line comments within code, leaving a blank line between large -comment blocks and code.

      -
      // break up the string by newlines
-$parts = explode("\n", $str);
-
-// A longer comment that needs to give greater detail on what is
-// occurring and why can use multiple single-line comments.  Try to
-// keep the width reasonable, around 70 characters is the easiest to
-// read.  Don't hesitate to link to permanent external resources
-// that may provide greater detail:
-//
-// http://example.com/information_about_something/in_particular/
-
-$parts = $this->foo($parts);
-
      -
      -
      -
      -

      Constants

      -

      Constants follow the same guidelines as do variables, except constants -should always be fully uppercase. Always use CodeIgniter constants when -appropriate, i.e. SLASH, LD, RD, PATH_CACHE, etc.

      -

      INCORRECT:

      -
      myConstant      // missing underscore separator and not fully uppercase
-N               // no single-letter constants
-S_C_VER         // not descriptive
-$str = str_replace('{foo}', 'bar', $str);       // should use LD and RD constants
-
      -
      -

      CORRECT:

      -
      MY_CONSTANT
-NEWLINE
-SUPER_CLASS_VERSION
-$str = str_replace(LD.'foo'.RD, 'bar', $str);
-
      -
      -
      -
      -

      TRUE, FALSE, and NULL

      -

      TRUE, FALSE, and NULL keywords should always be fully -uppercase.

      -

      INCORRECT:

      -
      if ($foo == true)
-$bar = false;
-function foo($bar = null)
-
      -
      -

      CORRECT:

      -
      if ($foo == TRUE)
-$bar = FALSE;
-function foo($bar = NULL)
-
      -
      -
      -
      -

      Logical Operators

      -

      Use of the || “or” comparison operator is discouraged, as its clarity -on some output devices is low (looking like the number 11, for instance). -&& is preferred over AND but either are acceptable, and a space should -always precede and follow !.

      -

      INCORRECT:

      -
      if ($foo || $bar)
-if ($foo AND $bar)  // okay but not recommended for common syntax highlighting applications
-if (!$foo)
-if (! is_array($foo))
-
      -
      -

      CORRECT:

      -
      if ($foo OR $bar)
-if ($foo && $bar) // recommended
-if ( ! $foo)
-if ( ! is_array($foo))
-
      -
      -
      -
      -

      Comparing Return Values and Typecasting

      -

      Some PHP functions return FALSE on failure, but may also have a valid -return value of “” or 0, which would evaluate to FALSE in loose -comparisons. Be explicit by comparing the variable type when using these -return values in conditionals to ensure the return value is indeed what -you expect, and not a value that has an equivalent loose-type -evaluation.

      -

      Use the same stringency in returning and checking your own variables. -Use === and !== as necessary.

      -

      INCORRECT:

      -
      // If 'foo' is at the beginning of the string, strpos will return a 0,
-// resulting in this conditional evaluating as TRUE
-if (strpos($str, 'foo') == FALSE)
-
      -
      -

      CORRECT:

      -
      if (strpos($str, 'foo') === FALSE)
-
      -
      -

      INCORRECT:

      -
      function build_string($str = "")
-{
-        if ($str == "") // uh-oh!  What if FALSE or the integer 0 is passed as an argument?
-        {
-
-        }
-}
-
      -
      -

      CORRECT:

      -
      function build_string($str = "")
-{
-        if ($str === "")
-        {
-
-        }
-}
-
      -
      -

      See also information regarding typecasting, -which can be quite useful. Typecasting has a slightly different effect -which may be desirable. When casting a variable as a string, for -instance, NULL and boolean FALSE variables become empty strings, 0 (and -other numbers) become strings of digits, and boolean TRUE becomes “1”:

      -
      $str = (string) $str; // cast $str as a string
-
      -
      -
      -
      -

      Debugging Code

      -

      Do not leave debugging code in your submissions, even when commented out. -Things such as var_dump(), print_r(), die()/exit() should not be included -in your code unless it serves a specific purpose other than debugging.

      -
      -
      -

      Whitespace in Files

      -

      No whitespace can precede the opening PHP tag or follow the closing PHP -tag. Output is buffered, so whitespace in your files can cause output to -begin before CodeIgniter outputs its content, leading to errors and an -inability for CodeIgniter to send proper headers.

      -
      -
      -

      Compatibility

      -

      CodeIgniter recommends PHP 5.4 or newer to be used, but it should be -compatible with PHP 5.2.4. Your code must either be compatible with this -requirement, provide a suitable fallback, or be an optional feature that -dies quietly without affecting a user’s application.

      -

      Additionally, do not use PHP functions that require non-default libraries -to be installed unless your code contains an alternative method when the -function is not available.

      -
      -
      -

      One File per Class

      -

      Use separate files for each class, unless the classes are closely related. -An example of a CodeIgniter file that contains multiple classes is the -Xmlrpc library file.

      -
      -
      -

      Whitespace

      -

      Use tabs for whitespace in your code, not spaces. This may seem like a -small thing, but using tabs instead of whitespace allows the developer -looking at your code to have indentation at levels that they prefer and -customize in whatever application they use. And as a side benefit, it -results in (slightly) more compact files, storing one tab character -versus, say, four space characters.

      -
      -
      -

      Line Breaks

      -

      Files must be saved with Unix line breaks. This is more of an issue for -developers who work in Windows, but in any case ensure that your text -editor is setup to save files with Unix line breaks.

      -
      -
      -

      Code Indenting

      -

      Use Allman style indenting. With the exception of Class declarations, -braces are always placed on a line by themselves, and indented at the -same level as the control statement that “owns” them.

      -

      INCORRECT:

      -
      function foo($bar) {
-        // ...
-}
-
-foreach ($arr as $key => $val) {
-        // ...
-}
-
-if ($foo == $bar) {
-        // ...
-} else {
-        // ...
-}
-
-for ($i = 0; $i < 10; $i++)
-        {
-        for ($j = 0; $j < 10; $j++)
-                {
-                // ...
-                }
-        }
-
-try {
-        // ...
-}
-catch() {
-        // ...
-}
-
      -
      -

      CORRECT:

      -
      function foo($bar)
-{
-        // ...
-}
-
-foreach ($arr as $key => $val)
-{
-        // ...
-}
-
-if ($foo == $bar)
-{
-        // ...
-}
-else
-{
-        // ...
-}
-
-for ($i = 0; $i < 10; $i++)
-{
-        for ($j = 0; $j < 10; $j++)
-        {
-                // ...
-        }
-}
-
-try
-{
-        // ...
-}
-catch()
-{
-        // ...
-}
-
      -
      -
      -
      -

      Bracket and Parenthetic Spacing

      -

      In general, parenthesis and brackets should not use any additional -spaces. The exception is that a space should always follow PHP control -structures that accept arguments with parenthesis (declare, do-while, -elseif, for, foreach, if, switch, while), to help distinguish them from -functions and increase readability.

      -

      INCORRECT:

      -
      $arr[ $foo ] = 'foo';
-
      -
      -

      CORRECT:

      -
      $arr[$foo] = 'foo'; // no spaces around array keys
-
      -
      -

      INCORRECT:

      -
      function foo ( $bar )
-{
-
-}
-
      -
      -

      CORRECT:

      -
      function foo($bar) // no spaces around parenthesis in function declarations
-{
-
-}
-
      -
      -

      INCORRECT:

      -
      foreach( $query->result() as $row )
-
      -
      -

      CORRECT:

      -
      foreach ($query->result() as $row) // single space following PHP control structures, but not in interior parenthesis
-
      -
      -
      -
      -

      Localized Text

      -

      CodeIgniter libraries should take advantage of corresponding language files -whenever possible.

      -

      INCORRECT:

      -
      return "Invalid Selection";
-
      -
      -

      CORRECT:

      -
      return $this->lang->line('invalid_selection');
-
      -
      -
      -
      -

      Private Methods and Variables

      -

      Methods and variables that are only accessed internally, -such as utility and helper functions that your public methods use for -code abstraction, should be prefixed with an underscore.

      -
      public function convert_text()
-private function _convert_text()
-
      -
      -
      -
      -

      PHP Errors

      -

      Code must run error free and not rely on warnings and notices to be -hidden to meet this requirement. For instance, never access a variable -that you did not set yourself (such as $_POST array keys) without first -checking to see that it isset().

      -

      Make sure that your dev environment has error reporting enabled -for ALL users, and that display_errors is enabled in the PHP -environment. You can check this setting with:

      -
      if (ini_get('display_errors') == 1)
-{
-        exit "Enabled";
-}
-
      -
      -

      On some servers where display_errors is disabled, and you do not have -the ability to change this in the php.ini, you can often enable it with:

      -
      ini_set('display_errors', 1);
-
      -
      -
      -

      Note

      -

      Setting the display_errors -setting with ini_set() at runtime is not identical to having -it enabled in the PHP environment. Namely, it will not have any -effect if the script has fatal errors.

      -
      -
      -
      -

      Short Open Tags

      -

      Always use full PHP opening tags, in case a server does not have -short_open_tag enabled.

      -

      INCORRECT:

      -
      <? echo $foo; ?>
-
-<?=$foo?>
-
      -
      -

      CORRECT:

      -
      <?php echo $foo; ?>
-
      -
      -
      -

      Note

      -

      PHP 5.4 will always have the <?= tag available.

      -
      -
      -
      -

      One Statement Per Line

      -

      Never combine statements on one line.

      -

      INCORRECT:

      -
      $foo = 'this'; $bar = 'that'; $bat = str_replace($foo, $bar, $bag);
-
      -
      -

      CORRECT:

      -
      $foo = 'this';
-$bar = 'that';
-$bat = str_replace($foo, $bar, $bag);
-
      -
      -
      -
      -

      Strings

      -

      Always use single quoted strings unless you need variables parsed, and -in cases where you do need variables parsed, use braces to prevent -greedy token parsing. You may also use double-quoted strings if the -string contains single quotes, so you do not have to use escape -characters.

      -

      INCORRECT:

      -
      "My String"                                     // no variable parsing, so no use for double quotes
-"My string $foo"                                // needs braces
-'SELECT foo FROM bar WHERE baz = \'bag\''       // ugly
-
      -
      -

      CORRECT:

      -
      'My String'
-"My string {$foo}"
-"SELECT foo FROM bar WHERE baz = 'bag'"
-
      -
      -
      -
      -

      SQL Queries

      -

      SQL keywords are always capitalized: SELECT, INSERT, UPDATE, WHERE, -AS, JOIN, ON, IN, etc.

      -

      Break up long queries into multiple lines for legibility, preferably -breaking for each clause.

      -

      INCORRECT:

      -
      // keywords are lowercase and query is too long for
-// a single line (... indicates continuation of line)
-$query = $this->db->query("select foo, bar, baz, foofoo, foobar as raboof, foobaz from exp_pre_email_addresses
-...where foo != 'oof' and baz != 'zab' order by foobaz limit 5, 100");
-
      -
      -

      CORRECT:

      -
      $query = $this->db->query("SELECT foo, bar, baz, foofoo, foobar AS raboof, foobaz
-                                FROM exp_pre_email_addresses
-                                WHERE foo != 'oof'
-                                AND baz != 'zab'
-                                ORDER BY foobaz
-                                LIMIT 5, 100");
-
      -
      -
      -
      -

      Default Function Arguments

      -

      Whenever appropriate, provide function argument defaults, which helps -prevent PHP errors with mistaken calls and provides common fallback -values which can save a few lines of code. Example:

      -
      function foo($bar = '', $baz = FALSE)
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/urls.html b/user_guide/general/urls.html deleted file mode 100755 index 8037cc4..0000000 --- a/user_guide/general/urls.html +++ /dev/null @@ -1,598 +0,0 @@ - - - - - - - - - - CodeIgniter URLs — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      CodeIgniter URLs

      -

      By default, URLs in CodeIgniter are designed to be search-engine and -human friendly. Rather than using the standard “query string” approach -to URLs that is synonymous with dynamic systems, CodeIgniter uses a -segment-based approach:

      -
      example.com/news/article/my_article
-
      -
      -
      -

      Note

      -

      Query string URLs can be optionally enabled, as described -below.

      -
      -
      -

      URI Segments

      -

      The segments in the URL, in following with the Model-View-Controller -approach, usually represent:

      -
      example.com/class/function/ID
-
      -
      -
        -
      1. The first segment represents the controller class that should be -invoked.
        2. -
      2. The second segment represents the class function, or method, that -should be called.
        3. -
      3. The third, and any additional segments, represent the ID and any -variables that will be passed to the controller.
        4. -
      -

      The URI Library and the URL Helper contain functions that make it easy to work -with your URI data. In addition, your URLs can be remapped using the -URI Routing feature for more flexibility.

      -
      -
      -

      Removing the index.php file

      -

      By default, the index.php file will be included in your URLs:

      -
      example.com/index.php/news/article/my_article
-
      -
      -

      If your Apache server has mod_rewrite enabled, you can easily remove this -file by using a .htaccess file with some simple rules. Here is an example -of such a file, using the “negative” method in which everything is redirected -except the specified items:

      -
      RewriteEngine On
-RewriteCond %{REQUEST_FILENAME} !-f
-RewriteCond %{REQUEST_FILENAME} !-d
-RewriteRule ^(.*)$ index.php/$1 [L]
-
      -
      -

      In the above example, any HTTP request other than those for existing -directories and existing files is treated as a request for your index.php file.

      -
      -

      Note

      -

      These specific rules might not work for all server configurations.

      -
      -
      -

      Note

      -

      Make sure to also exclude from the above rule any assets that you -might need to be accessible from the outside world.

      -
      -
      -
      -

      Adding a URL Suffix

      -

      In your config/config.php file you can specify a suffix that will be -added to all URLs generated by CodeIgniter. 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
-
      -
      -
      -
      -

      Enabling Query Strings

      -

      In some cases you might prefer to use query strings URLs:

      -
      index.php?c=products&m=view&id=345
-
      -
      -

      CodeIgniter optionally supports this capability, which can be enabled in -your application/config.php file. If you open your config file you’ll -see these items:

      -
      $config['enable_query_strings'] = FALSE;
-$config['controller_trigger'] = 'c';
-$config['function_trigger'] = 'm';
-
      -
      -

      If you change “enable_query_strings” to TRUE this feature will become -active. Your controllers and functions will then be accessible using the -“trigger” words you’ve set to invoke your controllers and methods:

      -
      index.php?c=controller&m=method
-
      -
      -
      -

      Note

      -

      If you are using query strings you will have to build your own -URLs, rather than utilizing the URL helpers (and other helpers -that generate URLs, like some of the form helpers) as these are -designed to work with segment based URLs.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/views.html b/user_guide/general/views.html deleted file mode 100755 index 1379932..0000000 --- a/user_guide/general/views.html +++ /dev/null @@ -1,705 +0,0 @@ - - - - - - - - - - Views — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Views

      -

      A view is simply a web page, or a page fragment, like a header, footer, -sidebar, etc. In fact, views can flexibly be embedded within other views -(within other views, etc., etc.) if you need this type of hierarchy.

      -

      Views are never called directly, they must be loaded by a -controller. Remember that in an MVC framework, the -Controller acts as the traffic cop, so it is responsible for fetching a -particular view. If you have not read the -Controllers page you should do so before -continuing.

      -

      Using the example controller you created in the -controller page, let’s add a view to it.

      -
      -

      Creating a View

      -

      Using your text editor, create a file called blogview.php, and put this -in it:

      -
      <html>
-<head>
-        <title>My Blog</title>
-</head>
-<body>
-        <h1>Welcome to my Blog!</h1>
-</body>
-</html>
-
      -
      -

      Then save the file in your application/views/ directory.

      -
      -
      -

      Loading a View

      -

      To load a particular view file you will use the following method:

      -
      $this->load->view('name');
-
      -
      -

      Where name is the name of your view file.

      -
      -

      Note

      -

      The .php file extension does not need to be specified -unless you use something other than .php.

      -
      -

      Now, open the controller file you made earlier called Blog.php, and -replace the echo statement with the view loading method:

      -
      <?php
-class Blog extends CI_Controller {
-
-        public function index()
-        {
-                $this->load->view('blogview');
-        }
-}
-
      -
      -

      If you visit your site using the URL you did earlier you should see your -new view. The URL was similar to this:

      -
      example.com/index.php/blog/
-
      -
      -
      -
      -

      Loading multiple views

      -

      CodeIgniter will intelligently handle multiple calls to -$this->load->view() from within a controller. If more than one call -happens they will be appended together. For example, you may wish to -have a header view, a menu view, a content view, and a footer view. That -might look something like this:

      -
      <?php
-
-class Page extends CI_Controller {
-
-        public function index()
-        {
-                $data['page_title'] = 'Your title';
-                $this->load->view('header');
-                $this->load->view('menu');
-                $this->load->view('content', $data);
-                $this->load->view('footer');
-        }
-
-}
-
      -
      -

      In the example above, we are using “dynamically added data”, which you -will see below.

      -
      -
      -

      Storing Views within Sub-directories

      -

      Your view files can also be stored within sub-directories if you prefer -that type of organization. When doing so you will need to include the -directory name loading the view. Example:

      -
      $this->load->view('directory_name/file_name');
-
      -
      -
      -
      -

      Adding Dynamic Data to the View

      -

      Data is passed from the controller to the view by way of an array or -an object in the second parameter of the view loading method. Here -is an example using an array:

      -
      $data = array(
-        'title' => 'My Title',
-        'heading' => 'My Heading',
-        'message' => 'My Message'
-);
-
-$this->load->view('blogview', $data);
-
      -
      -

      And here’s an example using an object:

      -
      $data = new Someclass();
-$this->load->view('blogview', $data);
-
      -
      -
      -

      Note

      -

      If you use an object, the class variables will be turned -into array elements.

      -
      -

      Let’s try it with your controller file. Open it add this code:

      -
      <?php
-class Blog extends CI_Controller {
-
-        public function index()
-        {
-                $data['title'] = "My Real Title";
-                $data['heading'] = "My Real Heading";
-
-                $this->load->view('blogview', $data);
-        }
-}
-
      -
      -

      Now open your view file and change the text to variables that correspond -to the array keys in your data:

      -
      <html>
-<head>
-        <title><?php echo $title;?></title>
-</head>
-<body>
-        <h1><?php echo $heading;?></h1>
-</body>
-</html>
-
      -
      -

      Then load the page at the URL you’ve been using and you should see the -variables replaced.

      -
      -
      -

      Creating Loops

      -

      The data array you pass to your view files is not limited to simple -variables. You can pass multi dimensional arrays, which can be looped to -generate multiple rows. For example, if you pull data from your database -it will typically be in the form of a multi-dimensional array.

      -

      Here’s a simple example. Add this to your controller:

      -
      <?php
-class Blog extends CI_Controller {
-
-        public function index()
-        {
-                $data['todo_list'] = array('Clean House', 'Call Mom', 'Run Errands');
-
-                $data['title'] = "My Real Title";
-                $data['heading'] = "My Real Heading";
-
-                $this->load->view('blogview', $data);
-        }
-}
-
      -
      -

      Now open your view file and create a loop:

      -
      <html>
-<head>
-        <title><?php echo $title;?></title>
-</head>
-<body>
-        <h1><?php echo $heading;?></h1>
-
-        <h3>My Todo List</h3>
-
-        <ul>
-        <?php foreach ($todo_list as $item):?>
-
-                <li><?php echo $item;?></li>
-
-        <?php endforeach;?>
-        </ul>
-
-</body>
-</html>
-
      -
      -
      -

      Note

      -

      You’ll notice that in the example above we are using PHP’s -alternative syntax. If you are not familiar with it you can read about -it here.

      -
      -
      -
      -

      Returning views as data

      -

      There is a third optional parameter lets you change the behavior of -the method so that it returns data as a string rather than sending it -to your browser. This can be useful if you want to process the data in -some way. If you set the parameter to TRUE (boolean) it will return -data. The default behavior is false, which sends it to your browser. -Remember to assign it to a variable if you want the data returned:

      -
      $string = $this->load->view('myfile', '', TRUE);
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/general/welcome.html b/user_guide/general/welcome.html deleted file mode 100755 index f6c7aba..0000000 --- a/user_guide/general/welcome.html +++ /dev/null @@ -1,521 +0,0 @@ - - - - - - - - - - Welcome to CodeIgniter — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Welcome to CodeIgniter
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Welcome to CodeIgniter

      -

      CodeIgniter is an Application Development Framework - a toolkit - for -people who build web sites using PHP. Its goal is to enable you to -develop projects much faster than you could if you were writing code -from scratch, by providing a rich set of libraries for commonly needed -tasks, as well as a simple interface and logical structure to access -these libraries. CodeIgniter lets you creatively focus on your project -by minimizing the amount of code needed for a given task.

      -
      -

      Who is CodeIgniter For?

      -

      CodeIgniter is right for you if:

      -
        -
      • You want a framework with a small footprint.
        • -
      • You need exceptional performance.
        • -
      • You need broad compatibility with standard hosting accounts that run -a variety of PHP versions and configurations.
        • -
      • You want a framework that requires nearly zero configuration.
        • -
      • You want a framework that does not require you to use the command -line.
        • -
      • You want a framework that does not require you to adhere to -restrictive coding rules.
        • -
      • You are not interested in large-scale monolithic libraries like PEAR.
        • -
      • You do not want to be forced to learn a templating language (although -a template parser is optionally available if you desire one).
        • -
      • You eschew complexity, favoring simple solutions.
        • -
      • You need clear, thorough documentation.
        • -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/genindex.html b/user_guide/genindex.html deleted file mode 100755 index 428ff52..0000000 --- a/user_guide/genindex.html +++ /dev/null @@ -1,3058 +0,0 @@ - - - - - - - - - - - Index — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - - -

      Index

      - -
      - _ - | A - | B - | C - | D - | E - | F - | G - | H - | I - | J - | K - | L - | M - | N - | O - | P - | Q - | R - | S - | T - | U - | V - | W - | X - -
      -

      _

      - - - -
      - -
      __get() (CI_Session method) -
      - - -
      __set() (CI_Session method) -
      - -
      - -
      _display() (CI_Output method) -
      - -
      - -

      A

      - - - -
      - -
      accept_charset() (CI_User_agent method) -
      - - -
      accept_lang() (CI_User_agent method) -
      - - -
      active() (CI_Unit_test method) -
      - - -
      add_column() (CI_DB_forge method) -
      - - -
      add_data() (CI_Zip method) -
      - - -
      add_dir() (CI_Zip method) -
      - - -
      add_field() (CI_DB_forge method) -
      - - -
      add_key() (CI_DB_forge method) -
      - - -
      add_package_path() (CI_Loader method) -
      - - -
      add_row() (CI_Table method) -
      - - -
      adjust_date() (CI_Calendar method) -
      - - -
      agent_string() (CI_User_agent method) -
      - - -
      all_userdata() (CI_Session method) -
      - - -
      alternator() (global function) -
      - -
      - -
      anchor() (global function) -
      - - -
      anchor_popup() (global function) -
      - - -
      append_output() (CI_Output method) -
      - - -
      archive() (CI_Zip method) -
      - - -
      array_column() (global function) -
      - - -
      array_replace() (global function) -
      - - -
      array_replace_recursive() (global function) -
      - - -
      ascii_to_entities() (global function) -
      - - -
      assoc_to_uri() (CI_URI method) -
      - - -
      attach() (CI_Email method) -
      - - -
      attachment_cid() (CI_Email method) -
      - - -
      auto_link() (global function) -
      - - -
      auto_typography() (global function) -
      - -
      - -

      B

      - - - -
      - -
      backup() (CI_DB_utility method) -
      - - -
      base_url() (CI_Config method) -
      - -
      - -
      (global function) -
      - -
      - -
      bcc() (CI_Email method) -
      - -
      - -
      br() (global function) -
      - - -
      browser() (CI_User_agent method) -
      - - -
      byte_format() (global function) -
      - -
      - -

      C

      - - - -
      - -
      cache() (CI_Output method) -
      - - -
      cache_delete() (CI_DB_driver method) -
      - - -
      cache_delete_all() (CI_DB_driver method) -
      - - -
      cache_info() (CI_Cache method) -
      - - -
      cache_off() (CI_DB_driver method) -
      - - -
      cache_on() (CI_DB_driver method) -
      - - -
      cache_set_path() (CI_DB_driver method) -
      - - -
      call_function() (CI_DB_driver method) -
      - - -
      camelize() (global function) -
      - - -
      cc() (CI_Email method) -
      - - -
      changedir() (CI_FTP method) -
      - - -
      character_limiter() (global function) -
      - - -
      charsets() (CI_User_agent method) -
      - - -
      chmod() (CI_FTP method) -
      - - -
      CI_Benchmark (class) -
      - - -
      CI_Cache (class) -
      - - -
      CI_Calendar (class) -
      - - -
      CI_Cart (class) -
      - - -
      CI_Config (class) -
      - - -
      CI_DB_driver (class) -
      - - -
      CI_DB_forge (class) -
      - - -
      CI_DB_query_builder (class) -
      - - -
      CI_DB_result (class) -
      - - -
      CI_DB_utility (class) -
      - - -
      CI_Email (class) -
      - - -
      CI_Encrypt (class) -
      - - -
      CI_Encryption (class) -
      - - -
      CI_Form_validation (class) -
      - - -
      CI_FTP (class) -
      - - -
      CI_Image_lib (class) -
      - - -
      CI_Input (class) -
      - - -
      CI_Lang (class) -
      - - -
      CI_Loader (class) -
      - - -
      CI_Migration (class) -
      - - -
      CI_Output (class) -
      - - -
      CI_Pagination (class) -
      - - -
      CI_Parser (class) -
      - - -
      CI_Security (class) -
      - -
      - -
      CI_Session (class) -
      - - -
      CI_Table (class) -
      - - -
      CI_Trackback (class) -
      - - -
      CI_Typography (class) -
      - - -
      CI_Unit_test (class) -
      - - -
      CI_Upload (class) -
      - - -
      CI_URI (class) -
      - - -
      CI_User_agent (class) -
      - - -
      CI_Xmlrpc (class) -
      - - -
      CI_Zip (class) -
      - - -
      clean() (CI_Cache method) -
      - - -
      clear() (CI_Email method) -
      - -
      - -
      (CI_Image_lib method) -
      - - -
      (CI_Table method) -
      - -
      - -
      clear_data() (CI_Zip method) -
      - - -
      clear_vars() (CI_Loader method) -
      - - -
      close() (CI_DB_driver method) -
      - -
      - -
      (CI_FTP method) -
      - -
      - -
      compile_binds() (CI_DB_driver method) -
      - - -
      config() (CI_Loader method) -
      - - -
      config_item() (global function) -
      - - -
      connect() (CI_FTP method) -
      - - -
      contents() (CI_Cart method) -
      - - -
      convert_accented_characters() (global function) -
      - - -
      convert_ascii() (CI_Trackback method) -
      - - -
      convert_xml() (CI_Trackback method) -
      - - -
      cookie() (CI_Input method) -
      - - -
      count_all() (CI_DB_driver method) -
      - - -
      count_all_results() (CI_DB_query_builder method) -
      - - -
      create_captcha() (global function) -
      - - -
      create_database() (CI_DB_forge method) -
      - - -
      create_key() (CI_Encryption method) -
      - - -
      create_links() (CI_Pagination method) -
      - - -
      create_table() (CI_DB_forge method) -
      - - -
      crop() (CI_Image_lib method) -
      - - -
      csv_from_result() (CI_DB_utility method) -
      - - -
      current() (CI_Migration method) -
      - - -
      current_url() (global function) -
      - - -
      custom_result_object() (CI_DB_result method) -
      - - -
      custom_row_object() (CI_DB_result method) -
      - -
      - -

      D

      - - - -
      - -
      data() (CI_Trackback method) -
      - -
      - -
      (CI_Upload method) -
      - -
      - -
      data_seek() (CI_DB_result method) -
      - - -
      database() (CI_Loader method) -
      - - -
      database_exists() (CI_DB_utility method) -
      - - -
      date_range() (global function) -
      - - -
      days_in_month() (global function) -
      - - -
      db_connect() (CI_DB_driver method) -
      - - -
      db_pconnect() (CI_DB_driver method) -
      - - -
      db_select() (CI_DB_driver method) -
      - - -
      db_set_charset() (CI_DB_driver method) -
      - - -
      dbforge() (CI_Loader method) -
      - - -
      dbprefix() (CI_DB_query_builder method) -
      - - -
      dbutil() (CI_Loader method) -
      - - -
      decode() (CI_Encrypt method) -
      - - -
      decrement() (CI_Cache method) -
      - - -
      decrypt() (CI_Encryption method) -
      - - -
      default_template() (CI_Calendar method) -
      - - -
      delete() (CI_Cache method) -
      - -
      - -
      (CI_DB_query_builder method) -
      - -
      -
      - -
      delete_dir() (CI_FTP method) -
      - - -
      delete_file() (CI_FTP method) -
      - - -
      delete_files() (global function) -
      - - -
      destroy() (CI_Cart method) -
      - - -
      directory_map() (global function) -
      - - -
      display_error() (CI_DB_driver method) -
      - -
      - -
      (CI_Xmlrpc method) -
      - -
      - -
      display_errors() (CI_Image_lib method) -
      - -
      - -
      (CI_Trackback method) -
      - - -
      (CI_Upload method) -
      - -
      - -
      display_response() (CI_Xmlrpc method) -
      - - -
      distinct() (CI_DB_query_builder method) -
      - - -
      do_hash() (global function) -
      - - -
      do_upload() (CI_Upload method) -
      - - -
      doctype() (global function) -
      - - -
      download() (CI_FTP method) -
      - -
      - -
      (CI_Zip method) -
      - -
      - -
      driver() (CI_Loader method) -
      - - -
      drop_column() (CI_DB_forge method) -
      - - -
      drop_database() (CI_DB_forge method) -
      - - -
      drop_table() (CI_DB_forge method) -
      - -
      - -

      E

      - - - -
      - -
      elapsed_time() (CI_Benchmark method) -
      - -
      - -
      (CI_DB_driver method) -
      - -
      - -
      element() (global function) -
      - - -
      elements() (global function) -
      - - -
      ellipsize() (global function) -
      - - -
      empty_table() (CI_DB_query_builder method) -
      - - -
      enable_profiler() (CI_Output method) -
      - - -
      encode() (CI_Encrypt method) -
      - - -
      encode_from_legacy() (CI_Encrypt method) -
      - - -
      encode_php_tags() (global function) -
      - - -
      encrypt() (CI_Encryption method) -
      - -
      - -
      entity_decode() (CI_Security method) -
      - -
      - -
      (global function) -
      - -
      - -
      error() (CI_Form_validation method) -
      - - -
      error_array() (CI_Form_validation method) -
      - - -
      error_string() (CI_Form_validation method) -
      - -
      - -
      (CI_Migration method) -
      - -
      - -
      escape() (CI_DB_driver method) -
      - - -
      escape_identifiers() (CI_DB_driver method) -
      - - -
      escape_like_str() (CI_DB_driver method) -
      - - -
      escape_str() (CI_DB_driver method) -
      - - -
      extract_urls() (CI_Trackback method) -
      - -
      - -

      F

      - - - -
      - -
      field_data() (CI_DB_driver method) -
      - -
      - -
      (CI_DB_result method) -
      - -
      - -
      field_exists() (CI_DB_driver method) -
      - - -
      file() (CI_Loader method) -
      - - -
      find_migrations() (CI_Migration method) -
      - - -
      first_row() (CI_DB_result method) -
      - - -
      flashdata() (CI_Session method) -
      - - -
      flush_cache() (CI_DB_query_builder method) -
      - - -
      force_download() (global function) -
      - - -
      form_button() (global function) -
      - - -
      form_checkbox() (global function) -
      - - -
      form_close() (global function) -
      - - -
      form_dropdown() (global function) -
      - - -
      form_error() (global function) -
      - - -
      form_fieldset() (global function) -
      - - -
      form_fieldset_close() (global function) -
      - -
      - -
      form_hidden() (global function) -
      - - -
      form_label() (global function) -
      - - -
      form_multiselect() (global function) -
      - - -
      form_open() (global function) -
      - - -
      form_password() (global function) -
      - - -
      form_prep() (global function) -
      - - -
      form_radio() (global function) -
      - - -
      form_reset() (global function) -
      - - -
      form_submit() (global function) -
      - - -
      form_textarea() (global function) -
      - - -
      form_upload() (global function) -
      - - -
      format_characters() (CI_Typography method) -
      - - -
      free_result() (CI_DB_result method) -
      - - -
      from() (CI_DB_query_builder method) -
      - -
      - -
      (CI_Email method) -
      - -
      - -
      function_usable() (global function) -
      - -
      - -

      G

      - - - -
      - -
      generate() (CI_Calendar method) -
      - -
      - -
      (CI_Table method) -
      - -
      - -
      get() (CI_Cache method) -
      - -
      - -
      (CI_DB_query_builder method) -
      - - -
      (CI_Input method) -
      - -
      - -
      get_clickable_smileys() (global function) -
      - - -
      get_compiled_delete() (CI_DB_query_builder method) -
      - - -
      get_compiled_insert() (CI_DB_query_builder method) -
      - - -
      get_compiled_select() (CI_DB_query_builder method) -
      - - -
      get_compiled_update() (CI_DB_query_builder method) -
      - - -
      get_content_type() (CI_Output method) -
      - - -
      get_csrf_hash() (CI_Security method) -
      - - -
      get_csrf_token_name() (CI_Security method) -
      - - -
      get_day_names() (CI_Calendar method) -
      - - -
      get_dir_file_info() (global function) -
      - - -
      get_file_info() (global function) -
      - - -
      get_filenames() (global function) -
      - - -
      get_flash_keys() (CI_Session method) -
      - - -
      get_header() (CI_Output method) -
      - - -
      get_id() (CI_Trackback method) -
      - - -
      get_instance() (global function) -
      - - -
      get_item() (CI_Cart method) -
      - -
      - -
      get_metadata() (CI_Cache method) -
      - - -
      get_mime_by_extension() (global function) -
      - - -
      get_mimes() (global function) -
      - - -
      get_month_name() (CI_Calendar method) -
      - - -
      get_output() (CI_Output method) -
      - - -
      get_package_paths() (CI_Loader method) -
      - - -
      get_post() (CI_Input method) -
      - - -
      get_random_bytes() (CI_Security method) -
      - - -
      get_request_header() (CI_Input method) -
      - - -
      get_temp_keys() (CI_Session method) -
      - - -
      get_total_days() (CI_Calendar method) -
      - - -
      get_var() (CI_Loader method) -
      - - -
      get_vars() (CI_Loader method) -
      - - -
      get_where() (CI_DB_query_builder method) -
      - - -
      get_zip() (CI_Zip method) -
      - - -
      gmt_to_local() (global function) -
      - - -
      group_by() (CI_DB_query_builder method) -
      - - -
      group_end() (CI_DB_query_builder method) -
      - - -
      group_start() (CI_DB_query_builder method) -
      - -
      - -

      H

      - - - -
      - -
      has_options() (CI_Cart method) -
      - - -
      has_rule() (CI_Form_validation method) -
      - - -
      has_userdata() (CI_Session method) -
      - - -
      hash_equals() (global function) -
      - - -
      hash_pbkdf2() (global function) -
      - - -
      having() (CI_DB_query_builder method) -
      - - -
      heading() (global function) -
      - - -
      helper() (CI_Loader method) -
      - -
      - -
      hex2bin() (global function) -
      - - -
      highlight_code() (global function) -
      - - -
      highlight_phrase() (global function) -
      - - -
      hkdf() (CI_Encryption method) -
      - - -
      html_escape() (global function) -
      - - -
      human_to_unix() (global function) -
      - - -
      humanize() (global function) -
      - -
      - -

      I

      - - - -
      - -
      img() (global function) -
      - - -
      increment() (CI_Cache method) -
      - - -
      increment_string() (global function) -
      - - -
      index_page() (global function) -
      - - -
      initialize() (CI_Calendar method) -
      - -
      - -
      (CI_DB_driver method) -
      - - -
      (CI_Encryption method) -
      - - -
      (CI_Image_lib method) -
      - - -
      (CI_Pagination method) -
      - - -
      (CI_Upload method) -
      - - -
      (CI_Xmlrpc method) -
      - -
      - -
      input_stream() (CI_Input method) -
      - - -
      insert() (CI_Cart method) -
      - -
      - -
      (CI_DB_query_builder method) -
      - -
      - -
      insert_batch() (CI_DB_query_builder method) -
      - - -
      insert_string() (CI_DB_driver method) -
      - - -
      ip_address() (CI_Input method) -
      - - -
      is_ajax_request() (CI_Input method) -
      - - -
      is_browser() (CI_User_agent method) -
      - - -
      is_cli() (global function) -
      - -
      - -
      is_cli_request() (CI_Input method) -
      - - -
      is_countable() (global function) -
      - - -
      is_https() (global function) -
      - - -
      is_loaded() (CI_Loader method) -
      - - -
      is_mobile() (CI_User_agent method) -
      - - -
      is_php() (global function) -
      - - -
      is_really_writable() (global function) -
      - - -
      is_referral() (CI_User_agent method) -
      - - -
      is_robot() (CI_User_agent method) -
      - - -
      is_supported() (CI_Cache method) -
      - - -
      is_write_type() (CI_DB_driver method) -
      - - -
      item() (CI_Config method) -
      - -
      - -

      J

      - - -
      - -
      join() (CI_DB_query_builder method) -
      - -
      - -

      K

      - - -
      - -
      keep_flashdata() (CI_Session method) -
      - -
      - -

      L

      - - - -
      - -
      lang() (global function) -
      - - -
      language() (CI_Loader method) -
      - - -
      languages() (CI_User_agent method) -
      - - -
      last_query() (CI_DB_driver method) -
      - - -
      last_row() (CI_DB_result method) -
      - - -
      latest() (CI_Migration method) -
      - - -
      library() (CI_Loader method) -
      - - -
      like() (CI_DB_query_builder method) -
      - - -
      limit() (CI_DB_query_builder method) -
      - - -
      limit_characters() (CI_Trackback method) -
      - -
      - -
      line() (CI_Lang method) -
      - - -
      link_tag() (global function) -
      - - -
      list_databases() (CI_DB_utility method) -
      - - -
      list_fields() (CI_DB_driver method) -
      - -
      - -
      (CI_DB_result method) -
      - -
      - -
      list_files() (CI_FTP method) -
      - - -
      list_tables() (CI_DB_driver method) -
      - - -
      load() (CI_Config method) -
      - -
      - -
      (CI_Lang method) -
      - -
      - -
      local_to_gmt() (global function) -
      - - -
      log_message() (global function) -
      - -
      - -

      M

      - - - -
      - -
      mailto() (global function) -
      - - -
      make_columns() (CI_Table method) -
      - - -
      mark() (CI_Benchmark method) -
      - - -
      mark_as_flash() (CI_Session method) -
      - - -
      mark_as_temp() (CI_Session method) -
      - - -
      mb_strlen() (global function) -
      - - -
      mb_strpos() (global function) -
      - - -
      mb_substr() (global function) -
      - - -
      mdate() (global function) -
      - - -
      memory_usage() (CI_Benchmark method) -
      - -
      - -
      message() (CI_Email method) -
      - - -
      meta() (global function) -
      - - -
      method() (CI_Input method) -
      - -
      - -
      (CI_Xmlrpc method) -
      - -
      - -
      mirror() (CI_FTP method) -
      - - -
      mkdir() (CI_FTP method) -
      - - -
      mobile() (CI_User_agent method) -
      - - -
      model() (CI_Loader method) -
      - - -
      modify_column() (CI_DB_forge method) -
      - - -
      move() (CI_FTP method) -
      - - -
      mysql_to_unix() (global function) -
      - -
      - -

      N

      - - - -
      - -
      nbs() (global function) -
      - - -
      next_row() (CI_DB_result method) -
      - - -
      nice_date() (global function) -
      - - -
      nl2br_except_pre() (CI_Typography method) -
      - -
      - -
      (global function) -
      - -
      - -
      not_group_start() (CI_DB_query_builder method) -
      - -
      - -
      not_like() (CI_DB_query_builder method) -
      - - -
      now() (global function) -
      - - -
      num_fields() (CI_DB_result method) -
      - - -
      num_rows() (CI_DB_result method) -
      - -
      - -

      O

      - - - -
      - -
      octal_permissions() (global function) -
      - - -
      offset() (CI_DB_query_builder method) -
      - - -
      ol() (global function) -
      - - -
      optimize_database() (CI_DB_utility method) -
      - - -
      optimize_table() (CI_DB_utility method) -
      - - -
      or_group_start() (CI_DB_query_builder method) -
      - - -
      or_having() (CI_DB_query_builder method) -
      - -
      - -
      or_like() (CI_DB_query_builder method) -
      - - -
      or_not_group_start() (CI_DB_query_builder method) -
      - - -
      or_not_like() (CI_DB_query_builder method) -
      - - -
      or_where() (CI_DB_query_builder method) -
      - - -
      or_where_in() (CI_DB_query_builder method) -
      - - -
      or_where_not_in() (CI_DB_query_builder method) -
      - - -
      order_by() (CI_DB_query_builder method) -
      - -
      - -

      P

      - - - -
      - -
      parse() (CI_Parser method) -
      - -
      - -
      (CI_User_agent method) -
      - -
      - -
      parse_smileys() (global function) -
      - - -
      parse_string() (CI_Parser method) -
      - - -
      parse_template() (CI_Calendar method) -
      - - -
      password_get_info() (global function) -
      - - -
      password_hash() (global function) -
      - - -
      password_needs_rehash() (global function) -
      - - -
      password_verify() (global function) -
      - - -
      platform() (CI_DB_driver method) -
      - -
      - -
      (CI_User_agent method) -
      - -
      - -
      plural() (global function) -
      - -
      - -
      post() (CI_Input method) -
      - - -
      post_get() (CI_Input method) -
      - - -
      prep_url() (global function) -
      - - -
      previous_row() (CI_DB_result method) -
      - - -
      primary() (CI_DB_driver method) -
      - - -
      print_debugger() (CI_Email method) -
      - - -
      process() (CI_Trackback method) -
      - - -
      product_options() (CI_Cart method) -
      - - -
      protect_identifiers() (CI_DB_driver method) -
      - -
      - -

      Q

      - - - -
      - -
      quoted_printable_encode() (global function) -
      - -
      - -
      quotes_to_entities() (global function) -
      - -
      - -

      R

      - - - -
      - -
      random_element() (global function) -
      - - -
      random_string() (global function) -
      - - -
      read_dir() (CI_Zip method) -
      - - -
      read_file() (CI_Zip method) -
      - -
      - -
      (global function) -
      - -
      - -
      receive() (CI_Trackback method) -
      - - -
      reconnect() (CI_DB_driver method) -
      - - -
      redirect() (global function) -
      - - -
      reduce_double_slashes() (global function) -
      - - -
      reduce_multiples() (global function) -
      - - -
      referrer() (CI_User_agent method) -
      - - -
      remove() (CI_Cart method) -
      - - -
      remove_invisible_characters() (global function) -
      - - -
      remove_package_path() (CI_Loader method) -
      - - -
      rename() (CI_FTP method) -
      - - -
      rename_table() (CI_DB_forge method) -
      - - -
      repair_table() (CI_DB_utility method) -
      - - -
      repeater() (global function) -
      - - -
      replace() (CI_DB_query_builder method) -
      - - -
      reply_to() (CI_Email method) -
      - -
      - -
      report() (CI_Unit_test method) -
      - - -
      request() (CI_Xmlrpc method) -
      - - -
      request_headers() (CI_Input method) -
      - - -
      reset_query() (CI_DB_query_builder method) -
      - - -
      reset_validation() (CI_Form_validation method) -
      - - -
      resize() (CI_Image_lib method) -
      - - -
      result() (CI_DB_result method) -
      - -
      - -
      (CI_Unit_test method) -
      - -
      - -
      result_array() (CI_DB_result method) -
      - - -
      result_object() (CI_DB_result method) -
      - - -
      robot() (CI_User_agent method) -
      - - -
      rotate() (CI_Image_lib method) -
      - - -
      row() (CI_DB_result method) -
      - - -
      row_array() (CI_DB_result method) -
      - - -
      row_object() (CI_DB_result method) -
      - - -
      rsegment() (CI_URI method) -
      - - -
      rsegment_array() (CI_URI method) -
      - - -
      run() (CI_Form_validation method) -
      - -
      - -
      (CI_Unit_test method) -
      - -
      - -
      ruri_string() (CI_URI method) -
      - - -
      ruri_to_assoc() (CI_URI method) -
      - -
      - -

      S

      - - - -
      - -
      safe_mailto() (global function) -
      - - -
      sanitize_filename() (CI_Security method) -
      - -
      - -
      (global function) -
      - -
      - -
      save() (CI_Cache method) -
      - - -
      segment() (CI_URI method) -
      - - -
      segment_array() (CI_URI method) -
      - - -
      select() (CI_DB_query_builder method) -
      - - -
      select_avg() (CI_DB_query_builder method) -
      - - -
      select_max() (CI_DB_query_builder method) -
      - - -
      select_min() (CI_DB_query_builder method) -
      - - -
      select_sum() (CI_DB_query_builder method) -
      - - -
      send() (CI_Email method) -
      - -
      - -
      (CI_Trackback method) -
      - -
      - -
      send_email() (global function) -
      - - -
      send_error_message() (CI_Xmlrpc method) -
      - - -
      send_request() (CI_Xmlrpc method) -
      - - -
      send_success() (CI_Trackback method) -
      - - -
      server() (CI_Input method) -
      - -
      - -
      (CI_Xmlrpc method) -
      - -
      - -
      sess_destroy() (CI_Session method) -
      - - -
      sess_regenerate() (CI_Session method) -
      - - -
      set() (CI_DB_query_builder method) -
      - - -
      set_alt_message() (CI_Email method) -
      - - -
      set_caption() (CI_Table method) -
      - - -
      set_checkbox() (global function) -
      - - -
      set_cipher() (CI_Encrypt method) -
      - - -
      set_content_type() (CI_Output method) -
      - - -
      set_cookie() (CI_Input method) -
      - - -
      set_data() (CI_Form_validation method) -
      - - -
      set_dbprefix() (CI_DB_query_builder method) -
      - - -
      set_delimiters() (CI_Parser method) -
      - - -
      set_empty() (CI_Table method) -
      - - -
      set_error() (CI_Trackback method) -
      - - -
      set_error_delimiters() (CI_Form_validation method) -
      - - -
      set_flashdata() (CI_Session method) -
      - - -
      set_header() (CI_Email method) -
      - -
      - -
      (CI_Output method) -
      - -
      - -
      set_heading() (CI_Table method) -
      - - -
      set_insert_batch() (CI_DB_query_builder method) -
      - - -
      set_item() (CI_Config method) -
      - - -
      set_message() (CI_Form_validation method) -
      - -
      - -
      set_mode() (CI_Encrypt method) -
      - - -
      set_output() (CI_Output method) -
      - - -
      set_profiler_sections() (CI_Output method) -
      - - -
      set_radio() (global function) -
      - - -
      set_realpath() (global function) -
      - - -
      set_row() (CI_DB_result method) -
      - - -
      set_rules() (CI_Form_validation method) -
      - - -
      set_select() (global function) -
      - - -
      set_status_header() (CI_Output method) -
      - -
      - -
      (global function) -
      - -
      - -
      set_tempdata() (CI_Session method) -
      - - -
      set_template() (CI_Table method) -
      - -
      - -
      (CI_Unit_test method) -
      - -
      - -
      set_test_items() (CI_Unit_test method) -
      - - -
      set_update_batch() (CI_DB_query_builder method) -
      - - -
      set_userdata() (CI_Session method) -
      - - -
      set_value() (global function) -
      - - -
      should_do_something() (Some_class method) -
      - - -
      show_404() (global function) -
      - - -
      show_error() (global function) -
      - - -
      simple_query() (CI_DB_driver method) -
      - - -
      singular() (global function) -
      - - -
      site_url() (CI_Config method) -
      - -
      - -
      (global function) -
      - -
      - -
      slash_item() (CI_Config method) -
      - - -
      slash_rsegment() (CI_URI method) -
      - - -
      slash_segment() (CI_URI method) -
      - - -
      smiley_js() (global function) -
      - - -
      Some_class (class) -
      - - -
      some_method() (Some_class method) -
      - - -
      standard_date() (global function) -
      - - -
      start_cache() (CI_DB_query_builder method) -
      - - -
      stop_cache() (CI_DB_query_builder method) -
      - - -
      strip_image_tags() (global function) -
      - - -
      strip_quotes() (global function) -
      - - -
      strip_slashes() (global function) -
      - - -
      subject() (CI_Email method) -
      - - -
      symbolic_permissions() (global function) -
      - - -
      system_url() (CI_Config method) -
      - -
      - -

      T

      - - - -
      - -
      table_exists() (CI_DB_driver method) -
      - - -
      tempdata() (CI_Session method) -
      - - -
      timeout() (CI_Xmlrpc method) -
      - - -
      timespan() (global function) -
      - - -
      timezone_menu() (global function) -
      - - -
      timezones() (global function) -
      - - -
      to() (CI_Email method) -
      - - -
      total() (CI_Cart method) -
      - - -
      total_items() (CI_Cart method) -
      - - -
      total_queries() (CI_DB_driver method) -
      - -
      - -
      total_rsegments() (CI_URI method) -
      - - -
      total_segments() (CI_URI method) -
      - - -
      trans_complete() (CI_DB_driver method) -
      - - -
      trans_off() (CI_DB_driver method) -
      - - -
      trans_start() (CI_DB_driver method) -
      - - -
      trans_status() (CI_DB_driver method) -
      - - -
      trans_strict() (CI_DB_driver method) -
      - - -
      trim_slashes() (global function) -
      - - -
      truncate() (CI_DB_query_builder method) -
      - -
      - -

      U

      - - - -
      - -
      ul() (global function) -
      - - -
      umark_flash() (CI_Session method) -
      - - -
      umark_temp() (CI_Session method) -
      - - -
      unbuffered_row() (CI_DB_result method) -
      - - -
      underscore() (global function) -
      - - -
      unix_to_human() (global function) -
      - - -
      unset_userdata() (CI_Session method) -
      - - -
      update() (CI_Cart method) -
      - -
      - -
      (CI_DB_query_builder method) -
      - -
      - -
      update_batch() (CI_DB_query_builder method) -
      - -
      - -
      update_string() (CI_DB_driver method) -
      - - -
      upload() (CI_FTP method) -
      - - -
      uri_string() (CI_URI method) -
      - -
      - -
      (global function) -
      - -
      - -
      uri_to_assoc() (CI_URI method) -
      - - -
      url_title() (global function) -
      - - -
      use_strict() (CI_Unit_test method) -
      - - -
      user_agent() (CI_Input method) -
      - - -
      userdata() (CI_Session method) -
      - -
      - -

      V

      - - - -
      - -
      valid_email() (global function) -
      - - -
      valid_ip() (CI_Input method) -
      - - -
      validate_url() (CI_Trackback method) -
      - - -
      validation_errors() (global function) -
      - -
      - -
      vars() (CI_Loader method) -
      - - -
      version() (CI_DB_driver method) -
      - -
      - -
      (CI_Migration method) -
      - - -
      (CI_User_agent method) -
      - -
      - -
      view() (CI_Loader method) -
      - -
      - -

      W

      - - - -
      - -
      watermark() (CI_Image_lib method) -
      - - -
      where() (CI_DB_query_builder method) -
      - - -
      where_in() (CI_DB_query_builder method) -
      - - -
      where_not_in() (CI_DB_query_builder method) -
      - -
      - -
      word_censor() (global function) -
      - - -
      word_limiter() (global function) -
      - - -
      word_wrap() (global function) -
      - - -
      write_file() (global function) -
      - -
      - -

      X

      - - - -
      - -
      xml_convert() (global function) -
      - - -
      xml_from_result() (CI_DB_utility method) -
      - -
      - -
      xss_clean() (CI_Security method) -
      - -
      - -
      (global function) -
      - -
      -
      - - - -
      -
      - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/array_helper.html b/user_guide/helpers/array_helper.html deleted file mode 100755 index 114062d..0000000 --- a/user_guide/helpers/array_helper.html +++ /dev/null @@ -1,661 +0,0 @@ - - - - - - - - - - Array Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Array Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Array Helper

      -

      The Array Helper file contains functions that assist in working with -arrays.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('array');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -element($item, $array[, $default = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $item (string) – Item to fetch from the array
        • -
      • $array (array) – Input array
        • -
      • $default (bool) – What to return if the array isn’t valid
        • -
      -
      Returns:

      NULL on failure or the array item.

      -
      Return type:

      mixed

      -
      -

      Lets you fetch an item from an array. The function tests whether the -array index is set and whether it has a value. If a value exists it is -returned. If a value does not exist it returns NULL, or whatever you’ve -specified as the default value via the third parameter.

      -

      Example:

      -
      $array = array(
-        'color' => 'red',
-        'shape' => 'round',
-        'size'  => ''
-);
-
-echo element('color', $array); // returns "red"
-echo element('size', $array, 'foobar'); // returns "foobar"
-
      -
      -
      - -
      -
      -elements($items, $array[, $default = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $item (string) – Item to fetch from the array
        • -
      • $array (array) – Input array
        • -
      • $default (bool) – What to return if the array isn’t valid
        • -
      -
      Returns:

      NULL on failure or the array item.

      -
      Return type:

      mixed

      -
      -

      Lets you fetch a number of items from an array. The function tests -whether each of the array indices is set. If an index does not exist it -is set to NULL, or whatever you’ve specified as the default value via -the third parameter.

      -

      Example:

      -
      $array = array(
-        'color' => 'red',
-        'shape' => 'round',
-        'radius' => '10',
-        'diameter' => '20'
-);
-
-$my_shape = elements(array('color', 'shape', 'height'), $array);
-
      -
      -

      The above will return the following array:

      -
      array(
-        'color' => 'red',
-        'shape' => 'round',
-        'height' => NULL
-);
-
      -
      -

      You can set the third parameter to any default value you like.

      -
      $my_shape = elements(array('color', 'shape', 'height'), $array, 'foobar');
-
      -
      -

      The above will return the following array:

      -
      array(
-        'color'         => 'red',
-        'shape'         => 'round',
-        'height'        => 'foobar'
-);
-
      -
      -

      This is useful when sending the $_POST array to one of your Models. -This prevents users from sending additional POST data to be entered into -your tables.

      -
      $this->load->model('post_model');
-$this->post_model->update(
-        elements(array('id', 'title', 'content'), $_POST)
-);
-
      -
      -

      This ensures that only the id, title and content fields are sent to be -updated.

      -
      - -
      -
      -random_element($array)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $array (array) – Input array
        • -
      -
      Returns:

      A random element from the array

      -
      Return type:

      mixed

      -
      -

      Takes an array as input and returns a random element from it.

      -

      Usage example:

      -
      $quotes = array(
-        "I find that the harder I work, the more luck I seem to have. - Thomas Jefferson",
-        "Don't stay in bed, unless you can make money in bed. - George Burns",
-        "We didn't lose the game; we just ran out of time. - Vince Lombardi",
-        "If everything seems under control, you're not going fast enough. - Mario Andretti",
-        "Reality is merely an illusion, albeit a very persistent one. - Albert Einstein",
-        "Chance favors the prepared mind - Louis Pasteur"
-);
-
-echo random_element($quotes);
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/captcha_helper.html b/user_guide/helpers/captcha_helper.html deleted file mode 100755 index c8f44b2..0000000 --- a/user_guide/helpers/captcha_helper.html +++ /dev/null @@ -1,671 +0,0 @@ - - - - - - - - - - CAPTCHA Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • CAPTCHA Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      CAPTCHA Helper

      -

      The CAPTCHA Helper file contains functions that assist in creating -CAPTCHA images.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('captcha');
-
      -
      -
      -
      -

      Using the CAPTCHA helper

      -

      Once loaded you can generate a CAPTCHA like this:

      -
      $vals = array(
-        'word'          => 'Random word',
-        'img_path'      => './captcha/',
-        'img_url'       => 'http://example.com/captcha/',
-        'font_path'     => './path/to/fonts/texb.ttf',
-        'img_width'     => '150',
-        'img_height'    => 30,
-        'expiration'    => 7200,
-        'word_length'   => 8,
-        'font_size'     => 16,
-        'img_id'        => 'Imageid',
-        'pool'          => '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
-
-        // White background and border, black text and red grid
-        'colors'        => array(
-                'background' => array(255, 255, 255),
-                'border' => array(255, 255, 255),
-                'text' => array(0, 0, 0),
-                'grid' => array(255, 40, 40)
-        )
-);
-
-$cap = create_captcha($vals);
-echo $cap['image'];
-
      -
      -
        -
      • The captcha function requires the GD image library.
        • -
      • Only the img_path and img_url are required.
        • -
      • If a word is not supplied, the function will generate a random -ASCII string. You might put together your own word library that you -can draw randomly from.
        • -
      • If you do not specify a path to a TRUE TYPE font, the native ugly GD -font will be used.
        • -
      • The “captcha” directory must be writable
        • -
      • The expiration (in seconds) signifies how long an image will remain -in the captcha folder before it will be deleted. The default is two -hours.
        • -
      • word_length defaults to 8, pool defaults to ‘0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ’
        • -
      • font_size defaults to 16, the native GD font has a size limit. Specify a “true type” font for bigger sizes.
        • -
      • The img_id will be set as the “id” of the captcha image.
        • -
      • If any of the colors values is missing, it will be replaced by the default.
        • -
      -
      -

      Adding a Database

      -

      In order for the captcha function to prevent someone from submitting, -you will need to add the information returned from create_captcha() -to your database. Then, when the data from the form is submitted by -the user you will need to verify that the data exists in the database -and has not expired.

      -

      Here is a table prototype:

      -
      CREATE TABLE captcha (
-        captcha_id bigint(13) unsigned NOT NULL auto_increment,
-        captcha_time int(10) unsigned NOT NULL,
-        ip_address varchar(45) NOT NULL,
-        word varchar(20) NOT NULL,
-        PRIMARY KEY `captcha_id` (`captcha_id`),
-        KEY `word` (`word`)
-);
-
      -
      -

      Here is an example of usage with a database. On the page where the -CAPTCHA will be shown you’ll have something like this:

      -
      $this->load->helper('captcha');
-$vals = array(
-        'img_path'      => './captcha/',
-        'img_url'       => 'http://example.com/captcha/'
-);
-
-$cap = create_captcha($vals);
-$data = array(
-        'captcha_time'  => $cap['time'],
-        'ip_address'    => $this->input->ip_address(),
-        'word'          => $cap['word']
-);
-
-$query = $this->db->insert_string('captcha', $data);
-$this->db->query($query);
-
-echo 'Submit the word you see below:';
-echo $cap['image'];
-echo '<input type="text" name="captcha" value="" />';
-
      -
      -

      Then, on the page that accepts the submission you’ll have something like -this:

      -
      // First, delete old captchas
-$expiration = time() - 7200; // Two hour limit
-$this->db->where('captcha_time < ', $expiration)
-        ->delete('captcha');
-
-// Then see if a captcha exists:
-$sql = 'SELECT COUNT(*) AS count FROM captcha WHERE word = ? AND ip_address = ? AND captcha_time > ?';
-$binds = array($_POST['captcha'], $this->input->ip_address(), $expiration);
-$query = $this->db->query($sql, $binds);
-$row = $query->row();
-
-if ($row->count == 0)
-{
-        echo 'You must submit the word that appears in the image.';
-}
-
      -
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -create_captcha([$data = ''[, $img_path = ''[, $img_url = ''[, $font_path = '']]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (array) – Array of data for the CAPTCHA
        • -
      • $img_path (string) – Path to create the image in
        • -
      • $img_url (string) – URL to the CAPTCHA image folder
        • -
      • $font_path (string) – Server path to font
        • -
      -
      Returns:

      array(‘word’ => $word, ‘time’ => $now, ‘image’ => $img)

      -
      Return type:

      array

      -
      -

      Takes an array of information to generate the CAPTCHA as input and -creates the image to your specifications, returning an array of -associative data about the image.

      -
      array(
-        'image' => IMAGE TAG
-        'time'  => TIMESTAMP (in microtime)
-        'word'  => CAPTCHA WORD
-)
-
      -
      -

      The image is the actual image tag:

      -
      <img src="http://example.com/captcha/12345.jpg" width="140" height="50" />
-
      -
      -

      The time is the micro timestamp used as the image name without the -file extension. It will be a number like this: 1139612155.3422

      -

      The word is the word that appears in the captcha image, which if not -supplied to the function, will be a random string.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/cookie_helper.html b/user_guide/helpers/cookie_helper.html deleted file mode 100755 index 3a3b700..0000000 --- a/user_guide/helpers/cookie_helper.html +++ /dev/null @@ -1,609 +0,0 @@ - - - - - - - - - - Cookie Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Cookie Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - - - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/date_helper.html b/user_guide/helpers/date_helper.html deleted file mode 100755 index 86d0884..0000000 --- a/user_guide/helpers/date_helper.html +++ /dev/null @@ -1,1253 +0,0 @@ - - - - - - - - - - Date Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Date Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Date Helper

      -

      The Date Helper file contains functions that help you work with dates.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('date');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -now([$timezone = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $timezone (string) – Timezone
        • -
      -
      Returns:

      UNIX timestamp

      -
      Return type:

      int

      -
      -

      Returns the current time as a UNIX timestamp, referenced either to your server’s -local time or any PHP suported timezone, based on the “time reference” setting -in your config file. If you do not intend to set your master time reference to -any other PHP supported timezone (which you’ll typically do if you run a site -that lets each user set their own timezone settings) there is no benefit to using -this function over PHP’s time() function.

      -
      echo now('Australia/Victoria');
-
      -
      -

      If a timezone is not provided, it will return time() based on the -time_reference setting.

      -
      - -
      -
      -mdate([$datestr = ''[, $time = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $datestr (string) – Date string
        • -
      • $time (int) – UNIX timestamp
        • -
      -
      Returns:

      MySQL-formatted date

      -
      Return type:

      string

      -
      -

      This function is identical to PHP’s date() -function, except that it lets you use MySQL style date codes, where each -code letter is preceded with a percent sign, e.g. %Y %m %d

      -

      The benefit of doing dates this way is that you don’t have to worry -about escaping any characters that are not date codes, as you would -normally have to do with the date() function.

      -

      Example:

      -
      $datestring = 'Year: %Y Month: %m Day: %d - %h:%i %a';
-$time = time();
-echo mdate($datestring, $time);
-
      -
      -

      If a timestamp is not included in the second parameter the current time -will be used.

      -
      - -
      -
      -standard_date([$fmt = 'DATE_RFC822'[, $time = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $fmt (string) – Date format
        • -
      • $time (int) – UNIX timestamp
        • -
      -
      Returns:

      Formatted date or FALSE on invalid format

      -
      Return type:

      string

      -
      -

      Lets you generate a date string in one of several standardized formats.

      -

      Example:

      -
      $format = 'DATE_RFC822';
-$time = time();
-echo standard_date($format, $time);
-
      -
      -
      -

      Note

      -

      This function is DEPRECATED. Use the native date() combined with -DateTime’s format constants -instead:

      -
      echo date(DATE_RFC822, time());
-
      -
      -
      -

      Supported formats:

      - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      ConstantDescriptionExample
      DATE_ATOMAtom2005-08-15T16:13:03+0000
      DATE_COOKIEHTTP CookiesSun, 14 Aug 2005 16:13:03 UTC
      DATE_ISO8601ISO-86012005-08-14T16:13:03+00:00
      DATE_RFC822RFC 822Sun, 14 Aug 05 16:13:03 UTC
      DATE_RFC850RFC 850Sunday, 14-Aug-05 16:13:03 UTC
      DATE_RFC1036RFC 1036Sunday, 14-Aug-05 16:13:03 UTC
      DATE_RFC1123RFC 1123Sun, 14 Aug 2005 16:13:03 UTC
      DATE_RFC2822RFC 2822Sun, 14 Aug 2005 16:13:03 +0000
      DATE_RSSRSSSun, 14 Aug 2005 16:13:03 UTC
      DATE_W3CW3C2005-08-14T16:13:03+0000
      -
      - -
      -
      -local_to_gmt([$time = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $time (int) – UNIX timestamp
        • -
      -
      Returns:

      UNIX timestamp

      -
      Return type:

      int

      -
      -

      Takes a UNIX timestamp as input and returns it as GMT.

      -

      Example:

      -
      $gmt = local_to_gmt(time());
-
      -
      -
      - -
      -
      -gmt_to_local([$time = ''[, $timezone = 'UTC'[, $dst = FALSE]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $time (int) – UNIX timestamp
        • -
      • $timezone (string) – Timezone
        • -
      • $dst (bool) – Whether DST is active
        • -
      -
      Returns:

      UNIX timestamp

      -
      Return type:

      int

      -
      -

      Takes a UNIX timestamp (referenced to GMT) as input, and converts it to -a localized timestamp based on the timezone and Daylight Saving Time -submitted.

      -

      Example:

      -
      $timestamp = 1140153693;
-$timezone  = 'UM8';
-$daylight_saving = TRUE;
-echo gmt_to_local($timestamp, $timezone, $daylight_saving);
-
      -
      -
      -

      Note

      -

      For a list of timezones see the reference at the bottom of this page.

      -
      -
      - -
      -
      -mysql_to_unix([$time = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $time (string) – MySQL timestamp
        • -
      -
      Returns:

      UNIX timestamp

      -
      Return type:

      int

      -
      -

      Takes a MySQL Timestamp as input and returns it as a UNIX timestamp.

      -

      Example:

      -
      $unix = mysql_to_unix('20061124092345');
-
      -
      -
      - -
      -
      -unix_to_human([$time = ''[, $seconds = FALSE[, $fmt = 'us']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $time (int) – UNIX timestamp
        • -
      • $seconds (bool) – Whether to show seconds
        • -
      • $fmt (string) – format (us or euro)
        • -
      -
      Returns:

      Formatted date

      -
      Return type:

      string

      -
      -

      Takes a UNIX timestamp as input and returns it in a human readable -format with this prototype:

      -
      YYYY-MM-DD HH:MM:SS AM/PM
-
      -
      -

      This can be useful if you need to display a date in a form field for -submission.

      -

      The time can be formatted with or without seconds, and it can be set to -European or US format. If only the timestamp is submitted it will return -the time without seconds formatted for the U.S.

      -

      Examples:

      -
      $now = time();
-echo unix_to_human($now); // U.S. time, no seconds
-echo unix_to_human($now, TRUE, 'us'); // U.S. time with seconds
-echo unix_to_human($now, TRUE, 'eu'); // Euro time with seconds
-
      -
      -
      - -
      -
      -human_to_unix([$datestr = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $datestr (int) – Date string
        • -
      -
      Returns:

      UNIX timestamp or FALSE on failure

      -
      Return type:

      int

      -
      -

      The opposite of the unix_to_time() function. Takes a “human” -time as input and returns it as a UNIX timestamp. This is useful if you -accept “human” formatted dates submitted via a form. Returns boolean FALSE -date string passed to it is not formatted as indicated above.

      -

      Example:

      -
      $now = time();
-$human = unix_to_human($now);
-$unix = human_to_unix($human);
-
      -
      -
      - -
      -
      -nice_date([$bad_date = ''[, $format = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $bad_date (int) – The terribly formatted date-like string
        • -
      • $format (string) – Date format to return (same as PHP’s date() function)
        • -
      -
      Returns:

      Formatted date

      -
      Return type:

      string

      -
      -

      This function can take a number poorly-formed date formats and convert -them into something useful. It also accepts well-formed dates.

      -

      The function will return a UNIX timestamp by default. You can, optionally, -pass a format string (the same type as the PHP date() function accepts) -as the second parameter.

      -

      Example:

      -
      $bad_date = '199605';
-// Should Produce: 1996-05-01
-$better_date = nice_date($bad_date, 'Y-m-d');
-
-$bad_date = '9-11-2001';
-// Should Produce: 2001-09-11
-$better_date = nice_date($bad_date, 'Y-m-d');
-
      -
      -
      - -
      -
      -timespan([$seconds = 1[, $time = ''[, $units = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $seconds (int) – Number of seconds
        • -
      • $time (string) – UNIX timestamp
        • -
      • $units (int) – Number of time units to display
        • -
      -
      Returns:

      Formatted time difference

      -
      Return type:

      string

      -
      -

      Formats a UNIX timestamp so that is appears similar to this:

      -
      1 Year, 10 Months, 2 Weeks, 5 Days, 10 Hours, 16 Minutes
-
      -
      -

      The first parameter must contain a UNIX timestamp. -The second parameter must contain a timestamp that is greater that the -first timestamp. -The thirdparameter is optional and limits the number of time units to display.

      -

      If the second parameter empty, the current time will be used.

      -

      The most common purpose for this function is to show how much time has -elapsed from some point in time in the past to now.

      -

      Example:

      -
      $post_date = '1079621429';
-$now = time();
-$units = 2;
-echo timespan($post_date, $now, $units);
-
      -
      -
      -

      Note

      -

      The text generated by this function is found in the following language -file: language/<your_lang>/date_lang.php

      -
      -
      - -
      -
      -days_in_month([$month = 0[, $year = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $month (int) – a numeric month
        • -
      • $year (int) – a numeric year
        • -
      -
      Returns:

      Count of days in the specified month

      -
      Return type:

      int

      -
      -

      Returns the number of days in a given month/year. Takes leap years into -account.

      -

      Example:

      -
      echo days_in_month(06, 2005);
-
      -
      -

      If the second parameter is empty, the current year will be used.

      -
      -

      Note

      -

      This function will alias the native cal_days_in_month(), if -it is available.

      -
      -
      - -
      -
      -date_range([$unix_start = ''[, $mixed = ''[, $is_unix = TRUE[, $format = 'Y-m-d']]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $unix_start (int) – UNIX timestamp of the range start date
        • -
      • $mixed (int) – UNIX timestamp of the range end date or interval in days
        • -
      • $is_unix (bool) – set to FALSE if $mixed is not a timestamp
        • -
      • $format (string) – Output date format, same as in date()
        • -
      -
      Returns:

      An array of dates

      -
      Return type:

      array

      -
      -

      Returns a list of dates within a specified period.

      -

      Example:

      -
      $range = date_range('2012-01-01', '2012-01-15');
-echo "First 15 days of 2012:";
-foreach ($range as $date)
-{
-        echo $date."\n";
-}
-
      -
      -
      - -
      -
      -timezones([$tz = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $tz (string) – A numeric timezone
        • -
      -
      Returns:

      Hour difference from UTC

      -
      Return type:

      int

      -
      -

      Takes a timezone reference (for a list of valid timezones, see the -“Timezone Reference” below) and returns the number of hours offset from -UTC.

      -

      Example:

      -
      echo timezones('UM5');
-
      -
      -

      This function is useful when used with timezone_menu().

      -
      - -
      -
      -timezone_menu([$default = 'UTC'[, $class = ''[, $name = 'timezones'[, $attributes = '']]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $default (string) – Timezone
        • -
      • $class (string) – Class name
        • -
      • $name (string) – Menu name
        • -
      • $attributes (mixed) – HTML attributes
        • -
      -
      Returns:

      HTML drop down menu with time zones

      -
      Return type:

      string

      -
      -

      Generates a pull-down menu of timezones, like this one:

      -
      - -

      This menu is useful if you run a membership site in which your users are -allowed to set their local timezone value.

      -

      The first parameter lets you set the “selected” state of the menu. For -example, to set Pacific time as the default you will do this:

      -
      echo timezone_menu('UM8');
-
      -
      -

      Please see the timezone reference below to see the values of this menu.

      -

      The second parameter lets you set a CSS class name for the menu.

      -

      The fourth parameter lets you set one or more attributes on the generated select tag.

      -
      -

      Note

      -

      The text contained in the menu is found in the following -language file: language/<your_lang>/date_lang.php

      -
      -
      - -
      -
      -

      Timezone Reference

      -

      The following table indicates each timezone and its location.

      -

      Note some of the location lists have been abridged for clarity and formatting.

      - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Time ZoneLocation
      UM12(UTC - 12:00) Baker/Howland Island
      UM11(UTC - 11:00) Samoa Time Zone, Niue
      UM10(UTC - 10:00) Hawaii-Aleutian Standard Time, Cook Islands
      UM95(UTC - 09:30) Marquesas Islands
      UM9(UTC - 09:00) Alaska Standard Time, Gambier Islands
      UM8(UTC - 08:00) Pacific Standard Time, Clipperton Island
      UM7(UTC - 07:00) Mountain Standard Time
      UM6(UTC - 06:00) Central Standard Time
      UM5(UTC - 05:00) Eastern Standard Time, Western Caribbean
      UM45(UTC - 04:30) Venezuelan Standard Time
      UM4(UTC - 04:00) Atlantic Standard Time, Eastern Caribbean
      UM35(UTC - 03:30) Newfoundland Standard Time
      UM3(UTC - 03:00) Argentina, Brazil, French Guiana, Uruguay
      UM2(UTC - 02:00) South Georgia/South Sandwich Islands
      UM1(UTC -1:00) Azores, Cape Verde Islands
      UTC(UTC) Greenwich Mean Time, Western European Time
      UP1(UTC +1:00) Central European Time, West Africa Time
      UP2(UTC +2:00) Central Africa Time, Eastern European Time
      UP3(UTC +3:00) Moscow Time, East Africa Time
      UP35(UTC +3:30) Iran Standard Time
      UP4(UTC +4:00) Azerbaijan Standard Time, Samara Time
      UP45(UTC +4:30) Afghanistan
      UP5(UTC +5:00) Pakistan Standard Time, Yekaterinburg Time
      UP55(UTC +5:30) Indian Standard Time, Sri Lanka Time
      UP575(UTC +5:45) Nepal Time
      UP6(UTC +6:00) Bangladesh Standard Time, Bhutan Time, Omsk Time
      UP65(UTC +6:30) Cocos Islands, Myanmar
      UP7(UTC +7:00) Krasnoyarsk Time, Cambodia, Laos, Thailand, Vietnam
      UP8(UTC +8:00) Australian Western Standard Time, Beijing Time
      UP875(UTC +8:45) Australian Central Western Standard Time
      UP9(UTC +9:00) Japan Standard Time, Korea Standard Time, Yakutsk
      UP95(UTC +9:30) Australian Central Standard Time
      UP10(UTC +10:00) Australian Eastern Standard Time, Vladivostok Time
      UP105(UTC +10:30) Lord Howe Island
      UP11(UTC +11:00) Srednekolymsk Time, Solomon Islands, Vanuatu
      UP115(UTC +11:30) Norfolk Island
      UP12(UTC +12:00) Fiji, Gilbert Islands, Kamchatka, New Zealand
      UP1275(UTC +12:45) Chatham Islands Standard Time
      UP13(UTC +13:00) Phoenix Islands Time, Tonga
      UP14(UTC +14:00) Line Islands
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/directory_helper.html b/user_guide/helpers/directory_helper.html deleted file mode 100755 index 30370f4..0000000 --- a/user_guide/helpers/directory_helper.html +++ /dev/null @@ -1,588 +0,0 @@ - - - - - - - - - - Directory Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Directory Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Directory Helper

      -

      The Directory Helper file contains functions that assist in working with -directories.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('directory');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $source_dir (string) – Path to the source directory
        • -
      • $directory_depth (int) – Depth of directories to traverse (0 = fully recursive, 1 = current dir, etc)
        • -
      • $hidden (bool) – Whether to include hidden directories
        • -
      -
      Returns:

      An array of files

      -
      Return type:

      array

      -
      -

      Examples:

      -
      $map = directory_map('./mydirectory/');
-
      -
      -
      -

      Note

      -

      Paths are almost always relative to your main index.php file.

      -
      -

      Sub-folders contained within the directory will be mapped as well. If -you wish to control the recursion depth, you can do so using the second -parameter (integer). A depth of 1 will only map the top level directory:

      -
      $map = directory_map('./mydirectory/', 1);
-
      -
      -

      By default, hidden files will not be included in the returned array. To -override this behavior, you may set a third parameter to true (boolean):

      -
      $map = directory_map('./mydirectory/', FALSE, TRUE);
-
      -
      -

      Each folder name will be an array index, while its contained files will -be numerically indexed. Here is an example of a typical array:

      -
      Array (
-        [libraries] => Array
-                (
-                        [0] => benchmark.html
-                        [1] => config.html
-                        ["database/"] => Array
-                                (
-                                        [0] => query_builder.html
-                                        [1] => binds.html
-                                        [2] => configuration.html
-                                        [3] => connecting.html
-                                        [4] => examples.html
-                                        [5] => fields.html
-                                        [6] => index.html
-                                        [7] => queries.html
-                                )
-                        [2] => email.html
-                        [3] => file_uploading.html
-                        [4] => image_lib.html
-                        [5] => input.html
-                        [6] => language.html
-                        [7] => loader.html
-                        [8] => pagination.html
-                        [9] => uri.html
-                )
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/download_helper.html b/user_guide/helpers/download_helper.html deleted file mode 100755 index 2a39a79..0000000 --- a/user_guide/helpers/download_helper.html +++ /dev/null @@ -1,557 +0,0 @@ - - - - - - - - - - Download Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Download Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Download Helper

      -

      The Download Helper lets you download data to your desktop.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('download');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -force_download([$filename = ''[, $data = ''[, $set_mime = FALSE]]])
      -
      --- - - - - - -
      Parameters:
        -
      • $filename (string) – Filename
        • -
      • $data (mixed) – File contents
        • -
      • $set_mime (bool) – Whether to try to send the actual MIME type
        • -
      -
      Return type:

      void

      -
      -

      Generates server headers which force data to be downloaded to your -desktop. Useful with file downloads. The first parameter is the name -you want the downloaded file to be named, the second parameter is the -file data.

      -

      If you set the second parameter to NULL and $filename is an existing, readable -file path, then its content will be read instead.

      -

      If you set the third parameter to boolean TRUE, then the actual file MIME type -(based on the filename extension) will be sent, so that if your browser has a -handler for that type - it can use it.

      -

      Example:

      -
      $data = 'Here is some text!';
-$name = 'mytext.txt';
-force_download($name, $data);
-
      -
      -

      If you want to download an existing file from your server you’ll need to -do the following:

      -
      // Contents of photo.jpg will be automatically read
-force_download('/path/to/photo.jpg', NULL);
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/email_helper.html b/user_guide/helpers/email_helper.html deleted file mode 100755 index 239b1ba..0000000 --- a/user_guide/helpers/email_helper.html +++ /dev/null @@ -1,599 +0,0 @@ - - - - - - - - - - Email Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Email Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Email Helper

      -

      The Email Helper provides some assistive functions for working with -Email. For a more robust email solution, see CodeIgniter’s Email -Class.

      -
      -

      Important

      -

      The Email helper is DEPRECATED and is currently -only kept for backwards compatibility.

      -
      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('email');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -valid_email($email)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $email (string) – E-mail address
        • -
      -
      Returns:

      TRUE if a valid email is supplied, FALSE otherwise

      -
      Return type:

      bool

      -
      -

      Checks if the input is a correctly formatted e-mail address. Note that is -doesn’t actually prove that the address will be able recieve mail, but -simply that it is a validly formed address.

      -

      Example:

      -
      if (valid_email('email@somesite.com'))
-{
-        echo 'email is valid';
-}
-else
-{
-        echo 'email is not valid';
-}
-
      -
      -
      -

      Note

      -

      All that this function does is to use PHP’s native filter_var():

      -
      (bool) filter_var($email, FILTER_VALIDATE_EMAIL);
-
      -
      -
      -
      - -
      -
      -send_email($recipient, $subject, $message)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $recipient (string) – E-mail address
        • -
      • $subject (string) – Mail subject
        • -
      • $message (string) – Message body
        • -
      -
      Returns:

      TRUE if the mail was successfully sent, FALSE in case of an error

      -
      Return type:

      bool

      -
      -

      Sends an email using PHP’s native mail() -function.

      -
      -

      Note

      -

      All that this function does is to use PHP’s native mail

      -
      mail($recipient, $subject, $message);
-
      -
      -
      -

      For a more robust email solution, see CodeIgniter’s Email Library.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/file_helper.html b/user_guide/helpers/file_helper.html deleted file mode 100755 index 390e8b9..0000000 --- a/user_guide/helpers/file_helper.html +++ /dev/null @@ -1,830 +0,0 @@ - - - - - - - - - - File Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • File Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      File Helper

      -

      The File Helper file contains functions that assist in working with files.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('file');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -read_file($file)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $file (string) – File path
        • -
      -
      Returns:

      File contents or FALSE on failure

      -
      Return type:

      string

      -
      -

      Returns the data contained in the file specified in the path.

      -

      Example:

      -
      $string = read_file('./path/to/file.php');
-
      -
      -

      The path can be a relative or full server path. Returns FALSE (boolean) on failure.

      -
      -

      Note

      -

      The path is relative to your main site index.php file, NOT your -controller or view files. CodeIgniter uses a front controller so paths -are always relative to the main site index.

      -
      -
      -

      Note

      -

      This function is DEPRECATED. Use the native file_get_contents() -instead.

      -
      -
      -

      Important

      -

      If your server is running an open_basedir restriction this -function might not work if you are trying to access a file above the -calling script.

      -
      -
      - -
      -
      -write_file($path, $data[, $mode = 'wb'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – File path
        • -
      • $data (string) – Data to write to file
        • -
      • $mode (string) – fopen() mode
        • -
      -
      Returns:

      TRUE if the write was successful, FALSE in case of an error

      -
      Return type:

      bool

      -
      -

      Writes data to the file specified in the path. If the file does not exist then the -function will create it.

      -

      Example:

      -
      $data = 'Some file data';
-if ( ! write_file('./path/to/file.php', $data))
-{
-        echo 'Unable to write the file';
-}
-else
-{
-        echo 'File written!';
-}
-
      -
      -

      You can optionally set the write mode via the third parameter:

      -
      write_file('./path/to/file.php', $data, 'r+');
-
      -
      -

      The default mode is ‘wb’. Please see the PHP user guide -for mode options.

      -
      -

      Note

      -

      The path is relative to your main site index.php file, NOT your -controller or view files. CodeIgniter uses a front controller so paths -are always relative to the main site index.

      -
      -
      -

      Note

      -

      This function acquires an exclusive lock on the file while writing to it.

      -
      -
      - -
      -
      -delete_files($path[, $del_dir = FALSE[, $htdocs = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Directory path
        • -
      • $del_dir (bool) – Whether to also delete directories
        • -
      • $htdocs (bool) – Whether to skip deleting .htaccess and index page files
        • -
      -
      Returns:

      TRUE on success, FALSE in case of an error

      -
      Return type:

      bool

      -
      -

      Deletes ALL files contained in the supplied path.

      -

      Example:

      -
      delete_files('./path/to/directory/');
-
      -
      -

      If the second parameter is set to TRUE, any directories contained within the supplied -root path will be deleted as well.

      -

      Example:

      -
      delete_files('./path/to/directory/', TRUE);
-
      -
      -
      -

      Note

      -

      The files must be writable or owned by the system in order to be deleted.

      -
      -
      - -
      -
      -get_filenames($source_dir[, $include_path = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $source_dir (string) – Directory path
        • -
      • $include_path (bool) – Whether to include the path as part of the filenames
        • -
      -
      Returns:

      An array of file names

      -
      Return type:

      array

      -
      -

      Takes a server path as input and returns an array containing the names of all files -contained within it. The file path can optionally be added to the file names by setting -the second parameter to TRUE.

      -

      Example:

      -
      $controllers = get_filenames(APPPATH.'controllers/');
-
      -
      -
      - -
      -
      -get_dir_file_info($source_dir, $top_level_only)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $source_dir (string) – Directory path
        • -
      • $top_level_only (bool) – Whether to look only at the specified directory (excluding sub-directories)
        • -
      -
      Returns:

      An array containing info on the supplied directory’s contents

      -
      Return type:

      array

      -
      -

      Reads the specified directory and builds an array containing the filenames, filesize, -dates, and permissions. Sub-folders contained within the specified path are only read -if forced by sending the second parameter to FALSE, as this can be an intensive -operation.

      -

      Example:

      -
      $models_info = get_dir_file_info(APPPATH.'models/');
-
      -
      -
      - -
      -
      -get_file_info($file[, $returned_values = array('name', 'server_path', 'size', 'date')])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $file (string) – File path
        • -
      • $returned_values (array) – What type of info to return
        • -
      -
      Returns:

      An array containing info on the specified file or FALSE on failure

      -
      Return type:

      array

      -
      -

      Given a file and path, returns (optionally) the name, path, size and date modified -information attributes for a file. Second parameter allows you to explicitly declare what -information you want returned.

      -

      Valid $returned_values options are: name, size, date, readable, writeable, -executable and fileperms.

      -
      - -
      -
      -get_mime_by_extension($filename)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $filename (string) – File name
        • -
      -
      Returns:

      MIME type string or FALSE on failure

      -
      Return type:

      string

      -
      -

      Translates a filename extension into a MIME type based on config/mimes.php. -Returns FALSE if it can’t determine the type, or read the MIME config file.

      -
      $file = 'somefile.png';
-echo $file.' is has a mime type of '.get_mime_by_extension($file);
-
      -
      -
      -

      Note

      -

      This is not an accurate way of determining file MIME types, and -is here strictly for convenience. It should not be used for security -purposes.

      -
      -
      - -
      -
      -symbolic_permissions($perms)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $perms (int) – Permissions
        • -
      -
      Returns:

      Symbolic permissions string

      -
      Return type:

      string

      -
      -

      Takes numeric permissions (such as is returned by fileperms()) and returns -standard symbolic notation of file permissions.

      -
      echo symbolic_permissions(fileperms('./index.php'));  // -rw-r--r--
-
      -
      -
      - -
      -
      -octal_permissions($perms)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $perms (int) – Permissions
        • -
      -
      Returns:

      Octal permissions string

      -
      Return type:

      string

      -
      -

      Takes numeric permissions (such as is returned by fileperms()) and returns -a three character octal notation of file permissions.

      -
      echo octal_permissions(fileperms('./index.php')); // 644
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/form_helper.html b/user_guide/helpers/form_helper.html deleted file mode 100755 index ba73661..0000000 --- a/user_guide/helpers/form_helper.html +++ /dev/null @@ -1,1599 +0,0 @@ - - - - - - - - - - Form Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Form Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Form Helper

      -

      The Form Helper file contains functions that assist in working with -forms.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('form');
-
      -
      -
      -
      -

      Escaping field values

      -

      You may need to use HTML and characters such as quotes within your form -elements. In order to do that safely, you’ll need to use -common function -html_escape().

      -

      Consider the following example:

      -
      $string = 'Here is a string containing "quoted" text.';
-
-<input type="text" name="myfield" value="<?php echo $string; ?>" />
-
      -
      -

      Since the above string contains a set of quotes, it will cause the form -to break. The html_escape() function converts HTML special -characters so that it can be used safely:

      -
      <input type="text" name="myfield" value="<?php echo html_escape($string); ?>" />
-
      -
      -
      -

      Note

      -

      If you use any of the form helper functions listed on this page, -the form values will be automatically escaped, so there is no need -to call this function. Use it only if you are creating your own -form elements.

      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -form_open([$action = ''[, $attributes = ''[, $hidden = array()]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $action (string) – Form action/target URI string
        • -
      • $attributes (array) – HTML attributes
        • -
      • $hidden (array) – An array of hidden fields’ definitions
        • -
      -
      Returns:

      An HTML form opening tag

      -
      Return type:

      string

      -
      -

      Creates an opening form tag with a base URL built from your config preferences. -It will optionally let you add form attributes and hidden input fields, and -will always add the accept-charset attribute based on the charset value in your -config file.

      -

      The main benefit of using this tag rather than hard coding your own HTML is that -it permits your site to be more portable in the event your URLs ever change.

      -

      Here’s a simple example:

      -
      echo form_open('email/send');
-
      -
      -

      The above example would create a form that points to your base URL plus the -“email/send” URI segments, like this:

      -
      <form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">
-
      -
      -

      Adding Attributes

      -
      -

      Attributes can be added by passing an associative array to the second -parameter, like this:

      -
      $attributes = array('class' => 'email', 'id' => 'myform');
-echo form_open('email/send', $attributes);
-
      -
      -

      Alternatively, you can specify the second parameter as a string:

      -
      echo form_open('email/send', 'class="email" id="myform"');
-
      -
      -

      The above examples would create a form similar to this:

      -
      <form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" class="email" id="myform">
-
      -
      -
      -

      Adding Hidden Input Fields

      -
      -

      Hidden fields can be added by passing an associative array to the -third parameter, like this:

      -
      $hidden = array('username' => 'Joe', 'member_id' => '234');
-echo form_open('email/send', '', $hidden);
-
      -
      -

      You can skip the second parameter by passing any falsy value to it.

      -

      The above example would create a form similar to this:

      -
      <form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">
-        <input type="hidden" name="username" value="Joe" />
-        <input type="hidden" name="member_id" value="234" />
-
      -
      -
      -
      - -
      -
      -form_open_multipart([$action = ''[, $attributes = array()[, $hidden = array()]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $action (string) – Form action/target URI string
        • -
      • $attributes (array) – HTML attributes
        • -
      • $hidden (array) – An array of hidden fields’ definitions
        • -
      -
      Returns:

      An HTML multipart form opening tag

      -
      Return type:

      string

      -
      -

      This function is absolutely identical to form_open() above, -except that it adds a multipart attribute, which is necessary if you -would like to use the form to upload files with.

      -
      - -
      -
      -form_hidden($name[, $value = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $name (string) – Field name
        • -
      • $value (string) – Field value
        • -
      -
      Returns:

      An HTML hidden input field tag

      -
      Return type:

      string

      -
      -

      Lets you generate hidden input fields. You can either submit a -name/value string to create one field:

      -
      form_hidden('username', 'johndoe');
-// Would produce: <input type="hidden" name="username" value="johndoe" />
-
      -
      -

      ... or you can submit an associative array to create multiple fields:

      -
      $data = array(
-        'name'  => 'John Doe',
-        'email' => 'john@example.com',
-        'url'   => 'http://example.com'
-);
-
-echo form_hidden($data);
-
-/*
-        Would produce:
-        <input type="hidden" name="name" value="John Doe" />
-        <input type="hidden" name="email" value="john@example.com" />
-        <input type="hidden" name="url" value="http://example.com" />
-*/
-
      -
      -

      You can also pass an associative array to the value field:

      -
      $data = array(
-        'name'  => 'John Doe',
-        'email' => 'john@example.com',
-        'url'   => 'http://example.com'
-);
-
-echo form_hidden('my_array', $data);
-
-/*
-        Would produce:
-
-        <input type="hidden" name="my_array[name]" value="John Doe" />
-        <input type="hidden" name="my_array[email]" value="john@example.com" />
-        <input type="hidden" name="my_array[url]" value="http://example.com" />
-*/
-
      -
      -

      If you want to create hidden input fields with extra attributes:

      -
      $data = array(
-        'type'  => 'hidden',
-        'name'  => 'email',
-        'id'    => 'hiddenemail',
-        'value' => 'john@example.com',
-        'class' => 'hiddenemail'
-);
-
-echo form_input($data);
-
-/*
-        Would produce:
-
-        <input type="hidden" name="email" value="john@example.com" id="hiddenemail" class="hiddenemail" />
-*/
-
      -
      -
      - -
      -
      -form_input([$data = ''[, $value = ''[, $extra = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (array) – Field attributes data
        • -
      • $value (string) – Field value
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML text input field tag

      -
      Return type:

      string

      -
      -

      Lets you generate a standard text input field. You can minimally pass -the field name and value in the first and second parameter:

      -
      echo form_input('username', 'johndoe');
-
      -
      -

      Or you can pass an associative array containing any data you wish your -form to contain:

      -
      $data = array(
-        'name'          => 'username',
-        'id'            => 'username',
-        'value'         => 'johndoe',
-        'maxlength'     => '100',
-        'size'          => '50',
-        'style'         => 'width:50%'
-);
-
-echo form_input($data);
-
-/*
-        Would produce:
-
-        <input type="text" name="username" value="johndoe" id="username" maxlength="100" size="50" style="width:50%"  />
-*/
-
      -
      -

      If you would like your form to contain some additional data, like -JavaScript, you can pass it as a string in the third parameter:

      -
      $js = 'onClick="some_function()"';
-echo form_input('username', 'johndoe', $js);
-
      -
      -

      Or you can pass it as an array:

      -
      $js = array('onClick' => 'some_function();');
-echo form_input('username', 'johndoe', $js);
-
      -
      -
      - -
      -
      -form_password([$data = ''[, $value = ''[, $extra = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (array) – Field attributes data
        • -
      • $value (string) – Field value
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML password input field tag

      -
      Return type:

      string

      -
      -

      This function is identical in all respects to the form_input() -function above except that it uses the “password” input type.

      -
      - -
      -
      -form_upload([$data = ''[, $value = ''[, $extra = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (array) – Field attributes data
        • -
      • $value (string) – Field value
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML file upload input field tag

      -
      Return type:

      string

      -
      -

      This function is identical in all respects to the form_input() -function above except that it uses the “file” input type, allowing it to -be used to upload files.

      -
      - -
      -
      -form_textarea([$data = ''[, $value = ''[, $extra = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (array) – Field attributes data
        • -
      • $value (string) – Field value
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML textarea tag

      -
      Return type:

      string

      -
      -

      This function is identical in all respects to the form_input() -function above except that it generates a “textarea” type.

      -
      -

      Note

      -

      Instead of the maxlength and size attributes in the above example, -you will instead specify rows and cols.

      -
      -
      - -
      -
      -form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $name (string) – Field name
        • -
      • $options (array) – An associative array of options to be listed
        • -
      • $selected (array) – List of fields to mark with the selected attribute
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML dropdown select field tag

      -
      Return type:

      string

      -
      -

      Lets you create a standard drop-down field. The first parameter will -contain the name of the field, the second parameter will contain an -associative array of options, and the third parameter will contain the -value you wish to be selected. You can also pass an array of multiple -items through the third parameter, and CodeIgniter will create a -multiple select for you.

      -

      Example:

      -
      $options = array(
-        'small'         => 'Small Shirt',
-        'med'           => 'Medium Shirt',
-        'large'         => 'Large Shirt',
-        'xlarge'        => 'Extra Large Shirt',
-);
-
-$shirts_on_sale = array('small', 'large');
-echo form_dropdown('shirts', $options, 'large');
-
-/*
-        Would produce:
-
-        <select name="shirts">
-                <option value="small">Small Shirt</option>
-                <option value="med">Medium  Shirt</option>
-                <option value="large" selected="selected">Large Shirt</option>
-                <option value="xlarge">Extra Large Shirt</option>
-        </select>
-*/
-
-echo form_dropdown('shirts', $options, $shirts_on_sale);
-
-/*
-        Would produce:
-
-        <select name="shirts" multiple="multiple">
-                <option value="small" selected="selected">Small Shirt</option>
-                <option value="med">Medium  Shirt</option>
-                <option value="large" selected="selected">Large Shirt</option>
-                <option value="xlarge">Extra Large Shirt</option>
-        </select>
-*/
-
      -
      -

      If you would like the opening <select> to contain additional data, like -an id attribute or JavaScript, you can pass it as a string in the fourth -parameter:

      -
      $js = 'id="shirts" onChange="some_function();"';
-echo form_dropdown('shirts', $options, 'large', $js);
-
      -
      -

      Or you can pass it as an array:

      -
      $js = array(
-        'id'       => 'shirts',
-        'onChange' => 'some_function();'
-);
-echo form_dropdown('shirts', $options, 'large', $js);
-
      -
      -

      If the array passed as $options is a multidimensional array, then -form_dropdown() will produce an <optgroup> with the array key as the -label.

      -
      - -
      -
      -form_multiselect([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $name (string) – Field name
        • -
      • $options (array) – An associative array of options to be listed
        • -
      • $selected (array) – List of fields to mark with the selected attribute
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML dropdown multiselect field tag

      -
      Return type:

      string

      -
      -

      Lets you create a standard multiselect field. The first parameter will -contain the name of the field, the second parameter will contain an -associative array of options, and the third parameter will contain the -value or values you wish to be selected.

      -

      The parameter usage is identical to using form_dropdown() above, -except of course that the name of the field will need to use POST array -syntax, e.g. foo[].

      -
      - -
      -
      -form_fieldset([$legend_text = ''[, $attributes = array()]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $legend_text (string) – Text to put in the <legend> tag
        • -
      • $attributes (array) – Attributes to be set on the <fieldset> tag
        • -
      -
      Returns:

      An HTML fieldset opening tag

      -
      Return type:

      string

      -
      -

      Lets you generate fieldset/legend fields.

      -

      Example:

      -
      echo form_fieldset('Address Information');
-echo "<p>fieldset content here</p>\n";
-echo form_fieldset_close();
-
-/*
-        Produces:
-
-                <fieldset>
-                        <legend>Address Information</legend>
-                                <p>form content here</p>
-                </fieldset>
-*/
-
      -
      -

      Similar to other functions, you can submit an associative array in the -second parameter if you prefer to set additional attributes:

      -
      $attributes = array(
-        'id'    => 'address_info',
-        'class' => 'address_info'
-);
-
-echo form_fieldset('Address Information', $attributes);
-echo "<p>fieldset content here</p>\n";
-echo form_fieldset_close();
-
-/*
-        Produces:
-
-        <fieldset id="address_info" class="address_info">
-                <legend>Address Information</legend>
-                <p>form content here</p>
-        </fieldset>
-*/
-
      -
      -
      - -
      -
      -form_fieldset_close([$extra = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $extra (string) – Anything to append after the closing tag, as is
        • -
      -
      Returns:

      An HTML fieldset closing tag

      -
      Return type:

      string

      -
      -

      Produces a closing </fieldset> tag. The only advantage to using this -function is it permits you to pass data to it which will be added below -the tag. For example

      -
      $string = '</div></div>';
-echo form_fieldset_close($string);
-// Would produce: </fieldset></div></div>
-
      -
      -
      - -
      -
      -form_checkbox([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (array) – Field attributes data
        • -
      • $value (string) – Field value
        • -
      • $checked (bool) – Whether to mark the checkbox as being checked
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML checkbox input tag

      -
      Return type:

      string

      -
      -

      Lets you generate a checkbox field. Simple example:

      -
      echo form_checkbox('newsletter', 'accept', TRUE);
-// Would produce:  <input type="checkbox" name="newsletter" value="accept" checked="checked" />
-
      -
      -

      The third parameter contains a boolean TRUE/FALSE to determine whether -the box should be checked or not.

      -

      Similar to the other form functions in this helper, you can also pass an -array of attributes to the function:

      -
      $data = array(
-        'name'          => 'newsletter',
-        'id'            => 'newsletter',
-        'value'         => 'accept',
-        'checked'       => TRUE,
-        'style'         => 'margin:10px'
-);
-
-echo form_checkbox($data);
-// Would produce: <input type="checkbox" name="newsletter" id="newsletter" value="accept" checked="checked" style="margin:10px" />
-
      -
      -

      Also as with other functions, if you would like the tag to contain -additional data like JavaScript, you can pass it as a string in the -fourth parameter:

      -
      $js = 'onClick="some_function()"';
-echo form_checkbox('newsletter', 'accept', TRUE, $js)
-
      -
      -

      Or you can pass it as an array:

      -
      $js = array('onClick' => 'some_function();');
-echo form_checkbox('newsletter', 'accept', TRUE, $js)
-
      -
      -
      - -
      -
      -form_radio([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (array) – Field attributes data
        • -
      • $value (string) – Field value
        • -
      • $checked (bool) – Whether to mark the radio button as being checked
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML radio input tag

      -
      Return type:

      string

      -
      -

      This function is identical in all respects to the form_checkbox() -function above except that it uses the “radio” input type.

      -
      - -
      -
      -form_label([$label_text = ''[, $id = ''[, $attributes = array()]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $label_text (string) – Text to put in the <label> tag
        • -
      • $id (string) – ID of the form element that we’re making a label for
        • -
      • $attributes (string) – HTML attributes
        • -
      -
      Returns:

      An HTML field label tag

      -
      Return type:

      string

      -
      -

      Lets you generate a <label>. Simple example:

      -
      echo form_label('What is your Name', 'username');
-// Would produce:  <label for="username">What is your Name</label>
-
      -
      -

      Similar to other functions, you can submit an associative array in the -third parameter if you prefer to set additional attributes.

      -

      Example:

      -
      $attributes = array(
-        'class' => 'mycustomclass',
-        'style' => 'color: #000;'
-);
-
-echo form_label('What is your Name', 'username', $attributes);
-// Would produce:  <label for="username" class="mycustomclass" style="color: #000;">What is your Name</label>
-
      -
      -
      - -
      -
      -form_submit([$data = ''[, $value = ''[, $extra = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (string) – Button name
        • -
      • $value (string) – Button value
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML input submit tag

      -
      Return type:

      string

      -
      -

      Lets you generate a standard submit button. Simple example:

      -
      echo form_submit('mysubmit', 'Submit Post!');
-// Would produce:  <input type="submit" name="mysubmit" value="Submit Post!" />
-
      -
      -

      Similar to other functions, you can submit an associative array in the -first parameter if you prefer to set your own attributes. The third -parameter lets you add extra data to your form, like JavaScript.

      -
      - -
      -
      -form_reset([$data = ''[, $value = ''[, $extra = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (string) – Button name
        • -
      • $value (string) – Button value
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML input reset button tag

      -
      Return type:

      string

      -
      -

      Lets you generate a standard reset button. Use is identical to -form_submit().

      -
      - -
      -
      -form_button([$data = ''[, $content = ''[, $extra = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (string) – Button name
        • -
      • $content (string) – Button label
        • -
      • $extra (mixed) – Extra attributes to be added to the tag either as an array or a literal string
        • -
      -
      Returns:

      An HTML button tag

      -
      Return type:

      string

      -
      -

      Lets you generate a standard button element. You can minimally pass the -button name and content in the first and second parameter:

      -
      echo form_button('name','content');
-// Would produce: <button name="name" type="button">Content</button>
-
      -
      -

      Or you can pass an associative array containing any data you wish your -form to contain:

      -
      $data = array(
-        'name'          => 'button',
-        'id'            => 'button',
-        'value'         => 'true',
-        'type'          => 'reset',
-        'content'       => 'Reset'
-);
-
-echo form_button($data);
-// Would produce: <button name="button" id="button" value="true" type="reset">Reset</button>
-
      -
      -

      If you would like your form to contain some additional data, like -JavaScript, you can pass it as a string in the third parameter:

      -
      $js = 'onClick="some_function()"';
-echo form_button('mybutton', 'Click Me', $js);
-
      -
      -
      - -
      -
      -form_close([$extra = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $extra (string) – Anything to append after the closing tag, as is
        • -
      -
      Returns:

      An HTML form closing tag

      -
      Return type:

      string

      -
      -

      Produces a closing </form> tag. The only advantage to using this -function is it permits you to pass data to it which will be added below -the tag. For example:

      -
      $string = '</div></div>';
-echo form_close($string);
-// Would produce:  </form> </div></div>
-
      -
      -
      - -
      -
      -set_value($field[, $default = ''[, $html_escape = TRUE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $default (string) – Default value
        • -
      • $html_escape (bool) – Whether to turn off HTML escaping of the value
        • -
      -
      Returns:

      Field value

      -
      Return type:

      string

      -
      -

      Permits you to set the value of an input form or textarea. You must -supply the field name via the first parameter of the function. The -second (optional) parameter allows you to set a default value for the -form. The third (optional) parameter allows you to turn off HTML escaping -of the value, in case you need to use this function in combination with -i.e. form_input() and avoid double-escaping.

      -

      Example:

      -
      <input type="text" name="quantity" value="<?php echo set_value('quantity', '0'); ?>" size="50" />
-
      -
      -

      The above form will show “0” when loaded for the first time.

      -
      -

      Note

      -

      If you’ve loaded the Form Validation Library and -have set a validation rule for the field name in use with this helper, then it will -forward the call to the Form Validation Library‘s -own set_value() method. Otherwise, this function looks in $_POST for the -field value.

      -
      -
      - -
      -
      -set_select($field[, $value = ''[, $default = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $value (string) – Value to check for
        • -
      • $default (string) – Whether the value is also a default one
        • -
      -
      Returns:

      ‘selected’ attribute or an empty string

      -
      Return type:

      string

      -
      -

      If you use a <select> menu, this function permits you to display the -menu item that was selected.

      -

      The first parameter must contain the name of the select menu, the second -parameter must contain the value of each item, and the third (optional) -parameter lets you set an item as the default (use boolean TRUE/FALSE).

      -

      Example:

      -
      <select name="myselect">
-        <option value="one" <?php echo  set_select('myselect', 'one', TRUE); ?> >One</option>
-        <option value="two" <?php echo  set_select('myselect', 'two'); ?> >Two</option>
-        <option value="three" <?php echo  set_select('myselect', 'three'); ?> >Three</option>
-</select>
-
      -
      -
      - -
      -
      -set_checkbox($field[, $value = ''[, $default = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $value (string) – Value to check for
        • -
      • $default (string) – Whether the value is also a default one
        • -
      -
      Returns:

      ‘checked’ attribute or an empty string

      -
      Return type:

      string

      -
      -

      Permits you to display a checkbox in the state it was submitted.

      -

      The first parameter must contain the name of the checkbox, the second -parameter must contain its value, and the third (optional) parameter -lets you set an item as the default (use boolean TRUE/FALSE).

      -

      Example:

      -
      <input type="checkbox" name="mycheck" value="1" <?php echo set_checkbox('mycheck', '1'); ?> />
-<input type="checkbox" name="mycheck" value="2" <?php echo set_checkbox('mycheck', '2'); ?> />
-
      -
      -
      - -
      -
      -set_radio($field[, $value = ''[, $default = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $value (string) – Value to check for
        • -
      • $default (string) – Whether the value is also a default one
        • -
      -
      Returns:

      ‘checked’ attribute or an empty string

      -
      Return type:

      string

      -
      -

      Permits you to display radio buttons in the state they were submitted. -This function is identical to the set_checkbox() function above.

      -

      Example:

      -
      <input type="radio" name="myradio" value="1" <?php echo  set_radio('myradio', '1', TRUE); ?> />
-<input type="radio" name="myradio" value="2" <?php echo  set_radio('myradio', '2'); ?> />
-
      -
      -
      -

      Note

      -

      If you are using the Form Validation class, you must always specify -a rule for your field, even if empty, in order for the set_*() -functions to work. This is because if a Form Validation object is -defined, the control for set_*() is handed over to a method of the -class instead of the generic helper function.

      -
      -
      - -
      -
      -form_error([$field = ''[, $prefix = ''[, $suffix = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $prefix (string) – Error opening tag
        • -
      • $suffix (string) – Error closing tag
        • -
      -
      Returns:

      HTML-formatted form validation error message(s)

      -
      Return type:

      string

      -
      -

      Returns a validation error message from the Form Validation Library, associated with the specified field name. -You can optionally specify opening and closing tag(s) to put around the error -message.

      -

      Example:

      -
      // Assuming that the 'username' field value was incorrect:
-echo form_error('myfield', '<div class="error">', '</div>');
-
-// Would produce: <div class="error">Error message associated with the "username" field.</div>
-
      -
      -
      - -
      -
      -validation_errors([$prefix = ''[, $suffix = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $prefix (string) – Error opening tag
        • -
      • $suffix (string) – Error closing tag
        • -
      -
      Returns:

      HTML-formatted form validation error message(s)

      -
      Return type:

      string

      -
      -

      Similarly to the form_error() function, returns all validation -error messages produced by the Form Validation Library, with optional opening and closing tags -around each of the messages.

      -

      Example:

      -
      echo validation_errors('<span class="error">', '</span>');
-
-/*
-        Would produce, e.g.:
-
-        <span class="error">The "email" field doesn't contain a valid e-mail address!</span>
-        <span class="error">The "password" field doesn't match the "repeat_password" field!</span>
-
- */
-
      -
      -
      - -
      -
      -form_prep($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Value to escape
        • -
      -
      Returns:

      Escaped value

      -
      Return type:

      string

      -
      -

      Allows you to safely use HTML and characters such as quotes within form -elements without breaking out of the form.

      -
      -

      Note

      -

      If you use any of the form helper functions listed in this page the form -values will be prepped automatically, so there is no need to call this -function. Use it only if you are creating your own form elements.

      -
      -
      -

      Note

      -

      This function is DEPRECATED and is just an alias for -common function -html_escape() - please use that instead.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/html_helper.html b/user_guide/helpers/html_helper.html deleted file mode 100755 index 7c91679..0000000 --- a/user_guide/helpers/html_helper.html +++ /dev/null @@ -1,1092 +0,0 @@ - - - - - - - - - - HTML Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • HTML Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      HTML Helper

      -

      The HTML Helper file contains functions that assist in working with -HTML.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('html');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -heading([$data = ''[, $h = '1'[, $attributes = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (string) – Content
        • -
      • $h (string) – Heading level
        • -
      • $attributes (mixed) – HTML attributes
        • -
      -
      Returns:

      HTML heading tag

      -
      Return type:

      string

      -
      -

      Lets you create HTML heading tags. The first parameter will contain the -data, the second the size of the heading. Example:

      -
      echo heading('Welcome!', 3);
-
      -
      -

      The above would produce: <h3>Welcome!</h3>

      -

      Additionally, in order to add attributes to the heading tag such as HTML -classes, ids or inline styles, a third parameter accepts either a string -or an array:

      -
      echo heading('Welcome!', 3, 'class="pink"');
-echo heading('How are you?', 4, array('id' => 'question', 'class' => 'green'));
-
      -
      -

      The above code produces:

      -
      <h3 class="pink">Welcome!<h3>
-<h4 id="question" class="green">How are you?</h4>
-
      -
      -
      - -
      -
      -img([$src = ''[, $index_page = FALSE[, $attributes = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $src (string) – Image source data
        • -
      • $index_page (bool) – Whether to treat $src as a routed URI string
        • -
      • $attributes (array) – HTML attributes
        • -
      -
      Returns:

      HTML image tag

      -
      Return type:

      string

      -
      -

      Lets you create HTML <img /> tags. The first parameter contains the -image source. Example:

      -
      echo img('images/picture.jpg'); // gives <img src="http://site.com/images/picture.jpg" />
-
      -
      -

      There is an optional second parameter that is a TRUE/FALSE value that -specifics if the src should have the page specified by -$config['index_page'] added to the address it creates. -Presumably, this would be if you were using a media controller:

      -
      echo img('images/picture.jpg', TRUE); // gives <img src="http://site.com/index.php/images/picture.jpg" alt="" />
-
      -
      -

      Additionally, an associative array can be passed to the img() function -for complete control over all attributes and values. If an alt attribute -is not provided, CodeIgniter will generate an empty string.

      -

      Example:

      -
      $image_properties = array(
-        'src'   => 'images/picture.jpg',
-        'alt'   => 'Me, demonstrating how to eat 4 slices of pizza at one time',
-        'class' => 'post_images',
-        'width' => '200',
-        'height'=> '200',
-        'title' => 'That was quite a night',
-        'rel'   => 'lightbox'
-);
-
-img($image_properties);
-// <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" />
-
      -
      -
      - -
      - -
      --- - - - - - - - -
      Parameters:
        -
      • $href (string) – What are we linking to
        • -
      • $rel (string) – Relation type
        • -
      • $type (string) – Type of the related document
        • -
      • $title (string) – Link title
        • -
      • $media (string) – Media type
        • -
      • $index_page (bool) – Whether to treat $src as a routed URI string
        • -
      -
      Returns:

      HTML link tag

      -
      Return type:

      string

      -
      -

      Lets you create HTML <link /> tags. This is useful for stylesheet links, -as well as other links. The parameters are href, with optional rel, -type, title, media and index_page.

      -

      index_page is a boolean value that specifies if the href should have -the page specified by $config['index_page'] added to the address it creates.

      -

      Example:

      -
      echo link_tag('css/mystyles.css');
-// gives <link href="http://site.com/css/mystyles.css" rel="stylesheet" type="text/css" />
-
      -
      -

      Further examples:

      -
      echo link_tag('favicon.ico', 'shortcut icon', 'image/ico');
-// <link href="http://site.com/favicon.ico" rel="shortcut icon" type="image/ico" />
-
-echo link_tag('feed', 'alternate', 'application/rss+xml', 'My RSS Feed');
-// <link href="http://site.com/feed" rel="alternate" type="application/rss+xml" title="My RSS Feed" />
-
      -
      -

      Additionally, an associative array can be passed to the link() function -for complete control over all attributes and values:

      -
      $link = array(
-        'href'  => 'css/printer.css',
-        'rel'   => 'stylesheet',
-        'type'  => 'text/css',
-        'media' => 'print'
-);
-
-echo link_tag($link);
-// <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" />
-
      -
      -
      - -
      -
      -ul($list[, $attributes = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $list (array) – List entries
        • -
      • $attributes (array) – HTML attributes
        • -
      -
      Returns:

      HTML-formatted unordered list

      -
      Return type:

      string

      -
      -

      Permits you to generate unordered HTML lists from simple or -multi-dimensional arrays. Example:

      -
      $list = array(
-        'red',
-        'blue',
-        'green',
-        'yellow'
-);
-
-$attributes = array(
-        'class' => 'boldlist',
-        'id'    => 'mylist'
-);
-
-echo ul($list, $attributes);
-
      -
      -

      The above code will produce this:

      -
      <ul class="boldlist" id="mylist">
-        <li>red</li>
-        <li>blue</li>
-        <li>green</li>
-        <li>yellow</li>
-</ul>
-
      -
      -

      Here is a more complex example, using a multi-dimensional array:

      -
      $attributes = array(
-        'class' => 'boldlist',
-        'id'    => 'mylist'
-);
-
-$list = array(
-        'colors'  => array(
-                'red',
-                'blue',
-                'green'
-        ),
-        'shapes'  => array(
-                'round',
-                'square',
-                'circles' => array(
-                        'ellipse',
-                        'oval',
-                        'sphere'
-                )
-        ),
-        'moods'  => array(
-                'happy',
-                'upset' => array(
-                        'defeated' => array(
-                                'dejected',
-                                'disheartened',
-                                'depressed'
-                        ),
-                        'annoyed',
-                        'cross',
-                        'angry'
-                )
-        )
-);
-
-echo ul($list, $attributes);
-
      -
      -

      The above code will produce this:

      -
      <ul class="boldlist" id="mylist">
-        <li>colors
-                <ul>
-                        <li>red</li>
-                        <li>blue</li>
-                        <li>green</li>
-                </ul>
-        </li>
-        <li>shapes
-                <ul>
-                        <li>round</li>
-                        <li>suare</li>
-                        <li>circles
-                                <ul>
-                                        <li>elipse</li>
-                                        <li>oval</li>
-                                        <li>sphere</li>
-                                </ul>
-                        </li>
-                </ul>
-        </li>
-        <li>moods
-                <ul>
-                        <li>happy</li>
-                        <li>upset
-                                <ul>
-                                        <li>defeated
-                                                <ul>
-                                                        <li>dejected</li>
-                                                        <li>disheartened</li>
-                                                        <li>depressed</li>
-                                                </ul>
-                                        </li>
-                                        <li>annoyed</li>
-                                        <li>cross</li>
-                                        <li>angry</li>
-                                </ul>
-                        </li>
-                </ul>
-        </li>
-</ul>
-
      -
      -
      - -
      -
      -ol($list, $attributes = '')
      -
      --- - - - - - - - -
      Parameters:
        -
      • $list (array) – List entries
        • -
      • $attributes (array) – HTML attributes
        • -
      -
      Returns:

      HTML-formatted ordered list

      -
      Return type:

      string

      -
      -

      Identical to ul(), only it produces the <ol> tag for -ordered lists instead of <ul>.

      -
      - -
      -
      -meta([$name = ''[, $content = ''[, $type = 'name'[, $newline = "n"]]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $name (string) – Meta name
        • -
      • $content (string) – Meta content
        • -
      • $type (string) – Meta type
        • -
      • $newline (string) – Newline character
        • -
      -
      Returns:

      HTML meta tag

      -
      Return type:

      string

      -
      -

      Helps you generate meta tags. You can pass strings to the function, or -simple arrays, or multidimensional ones.

      -

      Examples:

      -
      echo meta('description', 'My Great site');
-// Generates:  <meta name="description" content="My Great Site" />
-
-echo meta('Content-type', 'text/html; charset=utf-8', 'equiv');
-// Note the third parameter.  Can be "equiv" or "name"
-// Generates:  <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-
-echo meta(array('name' => 'robots', 'content' => 'no-cache'));
-// Generates:  <meta name="robots" content="no-cache" />
-
-$meta = array(
-        array(
-                'name' => 'robots',
-                'content' => 'no-cache'
-        ),
-        array(
-                'name' => 'description',
-                'content' => 'My Great Site'
-        ),
-        array(
-                'name' => 'keywords',
-                'content' => 'love, passion, intrigue, deception'
-        ),
-        array(
-                'name' => 'robots',
-                'content' => 'no-cache'
-        ),
-        array(
-                'name' => 'Content-type',
-                'content' => 'text/html; charset=utf-8', 'type' => 'equiv'
-        )
-);
-
-echo meta($meta);
-// Generates:
-// <meta name="robots" content="no-cache" />
-// <meta name="description" content="My Great Site" />
-// <meta name="keywords" content="love, passion, intrigue, deception" />
-// <meta name="robots" content="no-cache" />
-// <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-
      -
      -
      - -
      -
      -doctype([$type = 'xhtml1-strict'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $type (string) – Doctype name
        • -
      -
      Returns:

      HTML DocType tag

      -
      Return type:

      string

      -
      -

      Helps you generate document type declarations, or DTD’s. XHTML 1.0 -Strict is used by default, but many doctypes are available.

      -

      Example:

      -
      echo doctype(); // <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-echo doctype('html4-trans'); // <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-
      -
      -

      The following is a list of doctype choices. These are configurable, and -pulled from application/config/doctypes.php

      - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Document typeOptionResult
      XHTML 1.1xhtml11<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.1//EN” “http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd“>
      XHTML 1.0 Strictxhtml1-strict<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Strict//EN” “http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd“>
      XHTML 1.0 Transitionalxhtml1-trans<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Transitional//EN” “http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd“>
      XHTML 1.0 Framesetxhtml1-frame<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Frameset//EN” “http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd“>
      XHTML Basic 1.1xhtml-basic11<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML Basic 1.1//EN” “http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd“>
      HTML 5html5<!DOCTYPE html>
      HTML 4 Stricthtml4-strict<!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01//EN” “http://www.w3.org/TR/html4/strict.dtd“>
      HTML 4 Transitionalhtml4-trans<!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01 Transitional//EN” “http://www.w3.org/TR/html4/loose.dtd“>
      HTML 4 Framesethtml4-frame<!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01 Frameset//EN” “http://www.w3.org/TR/html4/frameset.dtd“>
      MathML 1.01mathml1<!DOCTYPE math SYSTEM “http://www.w3.org/Math/DTD/mathml1/mathml.dtd“>
      MathML 2.0mathml2<!DOCTYPE math PUBLIC “-//W3C//DTD MathML 2.0//EN” “http://www.w3.org/Math/DTD/mathml2/mathml2.dtd“>
      SVG 1.0svg10<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.0//EN” “http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd“>
      SVG 1.1 Fullsvg11<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1//EN” “http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd“>
      SVG 1.1 Basicsvg11-basic<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1 Basic//EN” “http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd“>
      SVG 1.1 Tinysvg11-tiny<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1 Tiny//EN” “http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd“>
      XHTML+MathML+SVG (XHTML host)xhtml-math-svg-xh<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN” “http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd“>
      XHTML+MathML+SVG (SVG host)xhtml-math-svg-sh<!DOCTYPE svg:svg PUBLIC “-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN” “http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd”>
      XHTML+RDFa 1.0xhtml-rdfa-1<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML+RDFa 1.0//EN” “http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd“>
      XHTML+RDFa 1.1xhtml-rdfa-2<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML+RDFa 1.1//EN” “http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd“>
      -
      - -
      -
      -br([$count = 1])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $count (int) – Number of times to repeat the tag
        • -
      -
      Returns:

      HTML line break tag

      -
      Return type:

      string

      -
      -

      Generates line break tags (<br />) based on the number you submit. -Example:

      -
      echo br(3);
-
      -
      -

      The above would produce:

      -
      <br /><br /><br />
-
      -
      -
      -

      Note

      -

      This function is DEPRECATED. Use the native str_repeat() -in combination with <br /> instead.

      -
      -
      - -
      -
      -nbs([$num = 1])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $num (int) – Number of space entities to produce
        • -
      -
      Returns:

      A sequence of non-breaking space HTML entities

      -
      Return type:

      string

      -
      -

      Generates non-breaking spaces (&nbsp;) based on the number you submit. -Example:

      -
      echo nbs(3);
-
      -
      -

      The above would produce:

      -
      &nbsp;&nbsp;&nbsp;
-
      -
      -
      -

      Note

      -

      This function is DEPRECATED. Use the native str_repeat() -in combination with &nbsp; instead.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/index.html b/user_guide/helpers/index.html deleted file mode 100755 index 17b69d2..0000000 --- a/user_guide/helpers/index.html +++ /dev/null @@ -1,561 +0,0 @@ - - - - - - - - - - Helpers — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - - - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/inflector_helper.html b/user_guide/helpers/inflector_helper.html deleted file mode 100755 index b08f20c..0000000 --- a/user_guide/helpers/inflector_helper.html +++ /dev/null @@ -1,681 +0,0 @@ - - - - - - - - - - Inflector Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Inflector Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Inflector Helper

      -

      The Inflector Helper file contains functions that permits you to change -words to plural, singular, camel case, etc.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('inflector');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -singular($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      A singular word

      -
      Return type:

      string

      -
      -

      Changes a plural word to singular. Example:

      -
      echo singular('dogs'); // Prints 'dog'
-
      -
      -
      - -
      -
      -plural($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      A plular word

      -
      Return type:

      string

      -
      -

      Changes a singular word to plural. Example:

      -
      echo plural('dog'); // Prints 'dogs'
-
      -
      -
      - -
      -
      -camelize($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      Camelized string

      -
      Return type:

      string

      -
      -

      Changes a string of words separated by spaces or underscores to camel -case. Example:

      -
      echo camelize('my_dog_spot'); // Prints 'myDogSpot'
-
      -
      -
      - -
      -
      -underscore($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      String containing underscores instead of spaces

      -
      Return type:

      string

      -
      -

      Takes multiple words separated by spaces and underscores them. -Example:

      -
      echo underscore('my dog spot'); // Prints 'my_dog_spot'
-
      -
      -
      - -
      -
      -humanize($str[, $separator = '_'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $separator (string) – Input separator
        • -
      -
      Returns:

      Humanized string

      -
      Return type:

      string

      -
      -

      Takes multiple words separated by underscores and adds spaces between -them. Each word is capitalized.

      -

      Example:

      -
      echo humanize('my_dog_spot'); // Prints 'My Dog Spot'
-
      -
      -

      To use dashes instead of underscores:

      -
      echo humanize('my-dog-spot', '-'); // Prints 'My Dog Spot'
-
      -
      -
      - -
      -
      -is_countable($word)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $word (string) – Input string
        • -
      -
      Returns:

      TRUE if the word is countable or FALSE if not

      -
      Return type:

      bool

      -
      -

      Checks if the given word has a plural version. Example:

      -
      is_countable('equipment'); // Returns FALSE
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/language_helper.html b/user_guide/helpers/language_helper.html deleted file mode 100755 index 2cfc39a..0000000 --- a/user_guide/helpers/language_helper.html +++ /dev/null @@ -1,548 +0,0 @@ - - - - - - - - - - Language Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Language Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Language Helper

      -

      The Language Helper file contains functions that assist in working with -language files.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('language');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -lang($line[, $for = ''[, $attributes = array()]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $line (string) – Language line key
        • -
      • $for (string) – HTML “for” attribute (ID of the element we’re creating a label for)
        • -
      • $attributes (array) – Any additional HTML attributes
        • -
      -
      Returns:

      HTML-formatted language line label

      -
      Return type:

      string

      -
      -

      This function returns a line of text from a loaded language file with -simplified syntax that may be more desirable for view files than -CI_Lang::line().

      -

      Example:

      -
      echo lang('language_key', 'form_item_id', array('class' => 'myClass'));
-// Outputs: <label for="form_item_id" class="myClass">Language line</label>
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/number_helper.html b/user_guide/helpers/number_helper.html deleted file mode 100755 index 678a113..0000000 --- a/user_guide/helpers/number_helper.html +++ /dev/null @@ -1,560 +0,0 @@ - - - - - - - - - - Number Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Number Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Number Helper

      -

      The Number Helper file contains functions that help you work with -numeric data.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('number');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -byte_format($num[, $precision = 1])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $num (mixed) – Number of bytes
        • -
      • $precision (int) – Floating point precision
        • -
      -
      Returns:

      Formatted data size string

      -
      Return type:

      string

      -
      -

      Formats numbers as bytes, based on size, and adds the appropriate -suffix. Examples:

      -
      echo byte_format(456); // Returns 456 Bytes
-echo byte_format(4567); // Returns 4.5 KB
-echo byte_format(45678); // Returns 44.6 KB
-echo byte_format(456789); // Returns 447.8 KB
-echo byte_format(3456789); // Returns 3.3 MB
-echo byte_format(12345678912345); // Returns 1.8 GB
-echo byte_format(123456789123456789); // Returns 11,228.3 TB
-
      -
      -

      An optional second parameter allows you to set the precision of the -result:

      -
      echo byte_format(45678, 2); // Returns 44.61 KB
-
      -
      -
      -

      Note

      -

      The text generated by this function is found in the following -language file: language/<your_lang>/number_lang.php

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/path_helper.html b/user_guide/helpers/path_helper.html deleted file mode 100755 index ac5ddb2..0000000 --- a/user_guide/helpers/path_helper.html +++ /dev/null @@ -1,558 +0,0 @@ - - - - - - - - - - Path Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Path Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Path Helper

      -

      The Path Helper file contains functions that permits you to work with -file paths on the server.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('path');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -set_realpath($path[, $check_existance = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Path
        • -
      • $check_existance (bool) – Whether to check if the path actually exists
        • -
      -
      Returns:

      An absolute path

      -
      Return type:

      string

      -
      -

      This function will return a server path without symbolic links or -relative directory structures. An optional second argument will -cause an error to be triggered if the path cannot be resolved.

      -

      Examples:

      -
      $file = '/etc/php5/apache2/php.ini';
-echo set_realpath($file); // Prints '/etc/php5/apache2/php.ini'
-
-$non_existent_file = '/path/to/non-exist-file.txt';
-echo set_realpath($non_existent_file, TRUE);    // Shows an error, as the path cannot be resolved
-echo set_realpath($non_existent_file, FALSE);   // Prints '/path/to/non-exist-file.txt'
-
-$directory = '/etc/php5';
-echo set_realpath($directory);  // Prints '/etc/php5/'
-
-$non_existent_directory = '/path/to/nowhere';
-echo set_realpath($non_existent_directory, TRUE);       // Shows an error, as the path cannot be resolved
-echo set_realpath($non_existent_directory, FALSE);      // Prints '/path/to/nowhere'
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/security_helper.html b/user_guide/helpers/security_helper.html deleted file mode 100755 index 99d8da1..0000000 --- a/user_guide/helpers/security_helper.html +++ /dev/null @@ -1,670 +0,0 @@ - - - - - - - - - - Security Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Security Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Security Helper

      -

      The Security Helper file contains security related functions.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('security');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -xss_clean($str[, $is_image = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input data
        • -
      • $is_image (bool) – Whether we’re dealing with an image
        • -
      -
      Returns:

      XSS-clean string

      -
      Return type:

      string

      -
      -

      Provides Cross Site Script Hack filtering.

      -

      This function is an alias for CI_Input::xss_clean(). For more info, -please see the Input Library documentation.

      -
      - -
      -
      -sanitize_filename($filename)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $filename (string) – Filename
        • -
      -
      Returns:

      Sanitized file name

      -
      Return type:

      string

      -
      -

      Provides protection against directory traversal.

      -

      This function is an alias for CI_Security::sanitize_filename(). -For more info, please see the Security Library -documentation.

      -
      - -
      -
      -do_hash($str[, $type = 'sha1'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input
        • -
      • $type (string) – Algorithm
        • -
      -
      Returns:

      Hex-formatted hash

      -
      Return type:

      string

      -
      -

      Permits you to create one way hashes suitable for encrypting -passwords. Will use SHA1 by default.

      -

      See hash_algos() -for a full list of supported algorithms.

      -

      Examples:

      -
      $str = do_hash($str); // SHA1
-$str = do_hash($str, 'md5'); // MD5
-
      -
      -
      -

      Note

      -

      This function was formerly named dohash(), which has been -removed in favor of do_hash().

      -
      -
      -

      Note

      -

      This function is DEPRECATED. Use the native hash() instead.

      -
      -
      - -
      -
      -strip_image_tags($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      The input string with no image tags

      -
      Return type:

      string

      -
      -

      This is a security function that will strip image tags from a string. -It leaves the image URL as plain text.

      -

      Example:

      -
      $string = strip_image_tags($string);
-
      -
      -

      This function is an alias for CI_Security::strip_image_tags(). For -more info, please see the Security Library -documentation.

      -
      - -
      -
      -encode_php_tags($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      Safely formatted string

      -
      Return type:

      string

      -
      -

      This is a security function that converts PHP tags to entities.

      -
      -

      Note

      -

      xss_clean() does this automatically, if you use it.

      -
      -

      Example:

      -
      $string = encode_php_tags($string);
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/smiley_helper.html b/user_guide/helpers/smiley_helper.html deleted file mode 100755 index 909e31d..0000000 --- a/user_guide/helpers/smiley_helper.html +++ /dev/null @@ -1,709 +0,0 @@ - - - - - - - - - - Smiley Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Smiley Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Smiley Helper

      -

      The Smiley Helper file contains functions that let you manage smileys -(emoticons).

      -
      -

      Important

      -

      The Smiley helper is DEPRECATED and should not be used. -It is currently only kept for backwards compatibility.

      -
      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('smiley');
-
      -
      -
      -
      -

      Overview

      -

      The Smiley helper has a renderer that takes plain text smileys, like -:-) and turns them into a image representation, like smile!

      -

      It also lets you display a set of smiley images that when clicked will -be inserted into a form field. For example, if you have a blog that -allows user commenting you can show the smileys next to the comment -form. Your users can click a desired smiley and with the help of some -JavaScript it will be placed into the form field.

      -
      -
      -

      Clickable Smileys Tutorial

      -

      Here is an example demonstrating how you might create a set of clickable -smileys next to a form field. This example requires that you first -download and install the smiley images, then create a controller and the -View as described.

      -
      -

      Important

      -

      Before you begin, please download the smiley images -and put them in a publicly accessible place on your server. -This helper also assumes you have the smiley replacement array -located at application/config/smileys.php

      -
      -
      -

      The Controller

      -

      In your application/controllers/ directory, create a file called -Smileys.php and place the code below in it.

      -
      -

      Important

      -

      Change the URL in the get_clickable_smileys() -function below so that it points to your smiley folder.

      -
      -

      You’ll notice that in addition to the smiley helper, we are also using -the Table Class:

      -
      <?php
-
-class Smileys extends CI_Controller {
-
-        public function index()
-        {
-                $this->load->helper('smiley');
-                $this->load->library('table');
-
-                $image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comments');
-                $col_array = $this->table->make_columns($image_array, 8);
-
-                $data['smiley_table'] = $this->table->generate($col_array);
-                $this->load->view('smiley_view', $data);
-        }
-
-}
-
      -
      -

      In your application/views/ directory, create a file called smiley_view.php -and place this code in it:

      -
      <html>
-        <head>
-                <title>Smileys</title>
-                <?php echo smiley_js(); ?>
-        </head>
-        <body>
-                <form name="blog">
-                        <textarea name="comments" id="comments" cols="40" rows="4"></textarea>
-                </form>
-                <p>Click to insert a smiley!</p>
-                <?php echo $smiley_table; ?> </body> </html>
-                When you have created the above controller and view, load it by visiting http://www.example.com/index.php/smileys/
-        </body>
-</html>
-
      -
      -
      -
      -

      Field Aliases

      -

      When making changes to a view it can be inconvenient to have the field -id in the controller. To work around this, you can give your smiley -links a generic name that will be tied to a specific id in your view.

      -
      $image_array = get_smiley_links("http://example.com/images/smileys/", "comment_textarea_alias");
-
      -
      -

      To map the alias to the field id, pass them both into the -smiley_js() function:

      -
      $image_array = smiley_js("comment_textarea_alias", "comments");
-
      -
      -
      -
      -
      -

      Available Functions

      -
      -
      -get_clickable_smileys($image_url[, $alias = ''[, $smileys = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $image_url (string) – URL path to the smileys directory
        • -
      • $alias (string) – Field alias
        • -
      -
      Returns:

      An array of ready to use smileys

      -
      Return type:

      array

      -
      -

      Returns an array containing your smiley images wrapped in a clickable -link. You must supply the URL to your smiley folder and a field id or -field alias.

      -

      Example:

      -
      $image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comment');
-
      -
      -
      - -
      -
      -smiley_js([$alias = ''[, $field_id = ''[, $inline = TRUE]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $alias (string) – Field alias
        • -
      • $field_id (string) – Field ID
        • -
      • $inline (bool) – Whether we’re inserting an inline smiley
        • -
      -
      Returns:

      Smiley-enabling JavaScript code

      -
      Return type:

      string

      -
      -

      Generates the JavaScript that allows the images to be clicked and -inserted into a form field. If you supplied an alias instead of an id -when generating your smiley links, you need to pass the alias and -corresponding form id into the function. This function is designed to be -placed into the <head> area of your web page.

      -

      Example:

      -
      <?php echo smiley_js(); ?>
-
      -
      -
      - -
      -
      -parse_smileys([$str = ''[, $image_url = ''[, $smileys = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Text containing smiley codes
        • -
      • $image_url (string) – URL path to the smileys directory
        • -
      • $smileys (array) – An array of smileys
        • -
      -
      Returns:

      Parsed smileys

      -
      Return type:

      string

      -
      -

      Takes a string of text as input and replaces any contained plain text -smileys into the image equivalent. The first parameter must contain your -string, the second must contain the URL to your smiley folder

      -

      Example:

      -
      $str = 'Here are some smileys: :-)  ;-)';
-$str = parse_smileys($str, 'http://example.com/images/smileys/');
-echo $str;
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/string_helper.html b/user_guide/helpers/string_helper.html deleted file mode 100755 index 45e625b..0000000 --- a/user_guide/helpers/string_helper.html +++ /dev/null @@ -1,874 +0,0 @@ - - - - - - - - - - String Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • String Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      String Helper

      -

      The String Helper file contains functions that assist in working with -strings.

      -
      -

      Important

      -

      Please note that these functions are NOT intended, nor -suitable to be used for any kind of security-related logic.

      -
      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('string');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -random_string([$type = 'alnum'[, $len = 8]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $type (string) – Randomization type
        • -
      • $len (int) – Output string length
        • -
      -
      Returns:

      A random string

      -
      Return type:

      string

      -
      -

      Generates a random string based on the type and length you specify. -Useful for creating passwords or generating random hashes.

      -

      The first parameter specifies the type of string, the second parameter -specifies the length. The following choices are available:

      -
        -
      • alpha: A string with lower and uppercase letters only.
        • -
      • alnum: Alpha-numeric string with lower and uppercase characters.
        • -
      • basic: A random number based on mt_rand().
        • -
      • numeric: Numeric string.
        • -
      • nozero: Numeric string with no zeros.
        • -
      • md5: An encrypted random number based on md5() (fixed length of 32).
        • -
      • sha1: An encrypted random number based on sha1() (fixed length of 40).
        • -
      -

      Usage example:

      -
      echo random_string('alnum', 16);
-
      -
      -
      -

      Note

      -

      Usage of the unique and encrypt types is DEPRECATED. They -are just aliases for md5 and sha1 respectively.

      -
      -
      - -
      -
      -increment_string($str[, $separator = '_'[, $first = 1]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $separator (string) – Separator to append a duplicate number with
        • -
      • $first (int) – Starting number
        • -
      -
      Returns:

      An incremented string

      -
      Return type:

      string

      -
      -

      Increments a string by appending a number to it or increasing the -number. Useful for creating “copies” or a file or duplicating database -content which has unique titles or slugs.

      -

      Usage example:

      -
      echo increment_string('file', '_'); // "file_1"
-echo increment_string('file', '-', 2); // "file-2"
-echo increment_string('file_4'); // "file_5"
-
      -
      -
      - -
      -
      -alternator($args)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $args (mixed) – A variable number of arguments
        • -
      -
      Returns:

      Alternated string(s)

      -
      Return type:

      mixed

      -
      -

      Allows two or more items to be alternated between, when cycling through -a loop. Example:

      -
      for ($i = 0; $i < 10; $i++)
-{
-        echo alternator('string one', 'string two');
-}
-
      -
      -

      You can add as many parameters as you want, and with each iteration of -your loop the next item will be returned.

      -
      for ($i = 0; $i < 10; $i++)
-{
-        echo alternator('one', 'two', 'three', 'four', 'five');
-}
-
      -
      -
      -

      Note

      -

      To use multiple separate calls to this function simply call the -function with no arguments to re-initialize.

      -
      -
      - -
      -
      -repeater($data[, $num = 1])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (string) – Input
        • -
      • $num (int) – Number of times to repeat
        • -
      -
      Returns:

      Repeated string

      -
      Return type:

      string

      -
      -

      Generates repeating copies of the data you submit. Example:

      -
      $string = "\n";
-echo repeater($string, 30);
-
      -
      -

      The above would generate 30 newlines.

      -
      -

      Note

      -

      This function is DEPRECATED. Use the native str_repeat() -instead.

      -
      -
      - -
      -
      -reduce_double_slashes($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      A string with normalized slashes

      -
      Return type:

      string

      -
      -

      Converts double slashes in a string to a single slash, except those -found in URL protocol prefixes (e.g. http&#58;//).

      -

      Example:

      -
      $string = "http://example.com//index.php";
-echo reduce_double_slashes($string); // results in "http://example.com/index.php"
-
      -
      -
      - -
      -
      -strip_slashes($data)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (mixed) – Input string or an array of strings
        • -
      -
      Returns:

      String(s) with stripped slashes

      -
      Return type:

      mixed

      -
      -

      Removes any slashes from an array of strings.

      -

      Example:

      -
      $str = array(
-        'question'  => 'Is your name O\'reilly?',
-        'answer' => 'No, my name is O\'connor.'
-);
-
-$str = strip_slashes($str);
-
      -
      -

      The above will return the following array:

      -
      array(
-        'question'  => "Is your name O'reilly?",
-        'answer' => "No, my name is O'connor."
-);
-
      -
      -
      -

      Note

      -

      For historical reasons, this function will also accept -and handle string inputs. This however makes it just an -alias for stripslashes().

      -
      -
      - -
      -
      -trim_slashes($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      Slash-trimmed string

      -
      Return type:

      string

      -
      -

      Removes any leading/trailing slashes from a string. Example:

      -
      $string = "/this/that/theother/";
-echo trim_slashes($string); // results in this/that/theother
-
      -
      -
      -

      Note

      -

      This function is DEPRECATED. Use the native trim() instead: -| -| trim($str, ‘/’);

      -
      -
      - -
      -
      -reduce_multiples($str[, $character = ''[, $trim = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Text to search in
        • -
      • $character (string) – Character to reduce
        • -
      • $trim (bool) – Whether to also trim the specified character
        • -
      -
      Returns:

      Reduced string

      -
      Return type:

      string

      -
      -

      Reduces multiple instances of a particular character occuring directly -after each other. Example:

      -
      $string = "Fred, Bill,, Joe, Jimmy";
-$string = reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy"
-
      -
      -

      If the third parameter is set to TRUE it will remove occurrences of the -character at the beginning and the end of the string. Example:

      -
      $string = ",Fred, Bill,, Joe, Jimmy,";
-$string = reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy"
-
      -
      -
      - -
      -
      -quotes_to_entities($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      String with quotes converted to HTML entities

      -
      Return type:

      string

      -
      -

      Converts single and double quotes in a string to the corresponding HTML -entities. Example:

      -
      $string = "Joe's \"dinner\"";
-$string = quotes_to_entities($string); //results in "Joe&#39;s &quot;dinner&quot;"
-
      -
      -
      - -
      -
      -strip_quotes($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      String with quotes stripped

      -
      Return type:

      string

      -
      -

      Removes single and double quotes from a string. Example:

      -
      $string = "Joe's \"dinner\"";
-$string = strip_quotes($string); //results in "Joes dinner"
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/text_helper.html b/user_guide/helpers/text_helper.html deleted file mode 100755 index 721215f..0000000 --- a/user_guide/helpers/text_helper.html +++ /dev/null @@ -1,848 +0,0 @@ - - - - - - - - - - Text Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Text Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Text Helper

      -

      The Text Helper file contains functions that assist in working with -text.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('text');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -word_limiter($str[, $limit = 100[, $end_char = '&#8230;']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $limit (int) – Limit
        • -
      • $end_char (string) – End character (usually an ellipsis)
        • -
      -
      Returns:

      Word-limited string

      -
      Return type:

      string

      -
      -

      Truncates a string to the number of words specified. Example:

      -
      $string = "Here is a nice text string consisting of eleven words.";
-$string = word_limiter($string, 4);
-// Returns:  Here is a nice
-
      -
      -

      The third parameter is an optional suffix added to the string. By -default it adds an ellipsis.

      -
      - -
      -
      -character_limiter($str[, $n = 500[, $end_char = '&#8230;']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $n (int) – Number of characters
        • -
      • $end_char (string) – End character (usually an ellipsis)
        • -
      -
      Returns:

      Character-limited string

      -
      Return type:

      string

      -
      -

      Truncates a string to the number of characters specified. It -maintains the integrity of words so the character count may be slightly -more or less than what you specify.

      -

      Example:

      -
      $string = "Here is a nice text string consisting of eleven words.";
-$string = character_limiter($string, 20);
-// Returns:  Here is a nice text string
-
      -
      -

      The third parameter is an optional suffix added to the string, if -undeclared this helper uses an ellipsis.

      -
      -

      Note

      -

      If you need to truncate to an exact number of characters please -see the ellipsize() function below.

      -
      -
      - -
      -
      -ascii_to_entities($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      A string with ASCII values converted to entities

      -
      Return type:

      string

      -
      -

      Converts ASCII values to character entities, including high ASCII and MS -Word characters that can cause problems when used in a web page, so that -they can be shown consistently regardless of browser settings or stored -reliably in a database. There is some dependence on your server’s -supported character sets, so it may not be 100% reliable in all cases, -but for the most part it should correctly identify characters outside -the normal range (like accented characters).

      -

      Example:

      -
      $string = ascii_to_entities($string);
-
      -
      -
      - -
      -
      -convert_accented_characters($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      A string with accented characters converted

      -
      Return type:

      string

      -
      -

      Transliterates high ASCII characters to low ASCII equivalents. Useful -when non-English characters need to be used where only standard ASCII -characters are safely used, for instance, in URLs.

      -

      Example:

      -
      $string = convert_accented_characters($string);
-
      -
      -
      -

      Note

      -

      This function uses a companion config file -application/config/foreign_chars.php to define the to and -from array for transliteration.

      -
      -
      - -
      -
      -word_censor($str, $censored[, $replacement = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $censored (array) – List of bad words to censor
        • -
      • $replacement (string) – What to replace bad words with
        • -
      -
      Returns:

      Censored string

      -
      Return type:

      string

      -
      -

      Enables you to censor words within a text string. The first parameter -will contain the original string. The second will contain an array of -words which you disallow. The third (optional) parameter can contain -a replacement value for the words. If not specified they are replaced -with pound signs: ####.

      -

      Example:

      -
      $disallowed = array('darn', 'shucks', 'golly', 'phooey');
-$string = word_censor($string, $disallowed, 'Beep!');
-
      -
      -
      - -
      -
      -highlight_code($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      String with code highlighted via HTML

      -
      Return type:

      string

      -
      -

      Colorizes a string of code (PHP, HTML, etc.). Example:

      -
      $string = highlight_code($string);
-
      -
      -

      The function uses PHP’s highlight_string() function, so the -colors used are the ones specified in your php.ini file.

      -
      - -
      -
      -highlight_phrase($str, $phrase[, $tag_open = '<mark>'[, $tag_close = '</mark>']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $phrase (string) – Phrase to highlight
        • -
      • $tag_open (string) – Opening tag used for the highlight
        • -
      • $tag_close (string) – Closing tag for the highlight
        • -
      -
      Returns:

      String with a phrase highlighted via HTML

      -
      Return type:

      string

      -
      -

      Will highlight a phrase within a text string. The first parameter will -contain the original string, the second will contain the phrase you wish -to highlight. The third and fourth parameters will contain the -opening/closing HTML tags you would like the phrase wrapped in.

      -

      Example:

      -
      $string = "Here is a nice text string about nothing in particular.";
-echo highlight_phrase($string, "nice text", '<span style="color:#990000;">', '</span>');
-
      -
      -

      The above code prints:

      -
      Here is a <span style="color:#990000;">nice text</span> string about nothing in particular.
-
      -
      -
      -

      Note

      -

      This function used to use the <strong> tag by default. Older browsers -might not support the new HTML5 mark tag, so it is recommended that you -insert the following CSS code into your stylesheet if you need to support -such browsers:

      -
      mark {
-        background: #ff0;
-        color: #000;
-};
-
      -
      -
      -
      - -
      -
      -word_wrap($str[, $charlim = 76])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $charlim (int) – Character limit
        • -
      -
      Returns:

      Word-wrapped string

      -
      Return type:

      string

      -
      -

      Wraps text at the specified character count while maintaining -complete words.

      -

      Example:

      -
      $string = "Here is a simple string of text that will help us demonstrate this function.";
-echo word_wrap($string, 25);
-
-// Would produce:
-// Here is a simple string
-// of text that will help us
-// demonstrate this
-// function.
-
      -
      -
      - -
      -
      -ellipsize($str, $max_length[, $position = 1[, $ellipsis = '&hellip;']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $max_length (int) – String length limit
        • -
      • $position (mixed) – Position to split at (int or float)
        • -
      • $ellipsis (string) – What to use as the ellipsis character
        • -
      -
      Returns:

      Ellipsized string

      -
      Return type:

      string

      -
      -

      This function will strip tags from a string, split it at a defined -maximum length, and insert an ellipsis.

      -

      The first parameter is the string to ellipsize, the second is the number -of characters in the final string. The third parameter is where in the -string the ellipsis should appear from 0 - 1, left to right. For -example. a value of 1 will place the ellipsis at the right of the -string, .5 in the middle, and 0 at the left.

      -

      An optional forth parameter is the kind of ellipsis. By default, -&hellip; will be inserted.

      -

      Example:

      -
      $str = 'this_string_is_entirely_too_long_and_might_break_my_design.jpg';
-echo ellipsize($str, 32, .5);
-
      -
      -

      Produces:

      -
      this_string_is_e&hellip;ak_my_design.jpg
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/typography_helper.html b/user_guide/helpers/typography_helper.html deleted file mode 100755 index 1804631..0000000 --- a/user_guide/helpers/typography_helper.html +++ /dev/null @@ -1,608 +0,0 @@ - - - - - - - - - - Typography Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • Typography Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Typography Helper

      -

      The Typography Helper file contains functions that help your format text -in semantically relevant ways.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('typography');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -auto_typography($str[, $reduce_linebreaks = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $reduce_linebreaks (bool) – Whether to reduce multiple instances of double newlines to two
        • -
      -
      Returns:

      HTML-formatted typography-safe string

      -
      Return type:

      string

      -
      -

      Formats text so that it is semantically and typographically correct -HTML.

      -

      This function is an alias for CI_Typography::auto_typography. -For more info, please see the Typography Library documentation.

      -

      Usage example:

      -
      $string = auto_typography($string);
-
      -
      -
      -

      Note

      -

      Typographic formatting can be processor intensive, particularly if -you have a lot of content being formatted. If you choose to use this -function you may want to consider caching <../general/caching> your -pages.

      -
      -
      - -
      -
      -nl2br_except_pre($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      String with HTML-formatted line breaks

      -
      Return type:

      string

      -
      -

      Converts newlines to <br /> tags unless they appear within <pre> tags. -This function is identical to the native PHP nl2br() function, -except that it ignores <pre> tags.

      -

      Usage example:

      -
      $string = nl2br_except_pre($string);
-
      -
      -
      - -
      -
      -entity_decode($str, $charset = NULL)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $charset (string) – Character set
        • -
      -
      Returns:

      String with decoded HTML entities

      -
      Return type:

      string

      -
      -

      This function is an alias for CI_Security::entity_decode(). -Fore more info, please see the Security Library documentation.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/url_helper.html b/user_guide/helpers/url_helper.html deleted file mode 100755 index b01af9a..0000000 --- a/user_guide/helpers/url_helper.html +++ /dev/null @@ -1,1045 +0,0 @@ - - - - - - - - - - URL Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • URL Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      URL Helper

      -

      The URL Helper file contains functions that assist in working with URLs.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code:

      -
      $this->load->helper('url');
-
      -
      -

      The following functions are available:

      -
      -
      -

      Available Functions

      -
      -
      -site_url([$uri = ''[, $protocol = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $uri (string) – URI string
        • -
      • $protocol (string) – Protocol, e.g. ‘http’ or ‘https’
        • -
      -
      Returns:

      Site URL

      -
      Return type:

      string

      -
      -

      Returns your site URL, as specified in your config file. The index.php -file (or whatever you have set as your site index_page in your config -file) will be added to the URL, as will any URI segments you pass to the -function, plus the url_suffix as set in your config file.

      -

      You are encouraged to use this function any time you need to generate a -local URL so that your pages become more portable in the event your URL -changes.

      -

      Segments can be optionally passed to the function as a string or an -array. Here is a string example:

      -
      echo site_url('news/local/123');
-
      -
      -

      The above example would return something like: -http://example.com/index.php/news/local/123

      -

      Here is an example of segments passed as an array:

      -
      $segments = array('news', 'local', '123');
-echo site_url($segments);
-
      -
      -

      This function is an alias for CI_Config::site_url(). For more info, -please see the Config Library documentation.

      -
      - -
      -
      -base_url($uri = '', $protocol = NULL)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $uri (string) – URI string
        • -
      • $protocol (string) – Protocol, e.g. ‘http’ or ‘https’
        • -
      -
      Returns:

      Base URL

      -
      Return type:

      string

      -
      -

      Returns your site base URL, as specified in your config file. Example:

      -
      echo base_url();
-
      -
      -

      This function returns the same thing as site_url(), without -the index_page or url_suffix being appended.

      -

      Also like site_url(), you can supply segments as a string or -an array. Here is a string example:

      -
      echo base_url("blog/post/123");
-
      -
      -

      The above example would return something like: -http://example.com/blog/post/123

      -

      This is useful because unlike site_url(), you can supply a -string to a file, such as an image or stylesheet. For example:

      -
      echo base_url("images/icons/edit.png");
-
      -
      -

      This would give you something like: -http://example.com/images/icons/edit.png

      -

      This function is an alias for CI_Config::base_url(). For more info, -please see the Config Library documentation.

      -
      - -
      -
      -current_url()
      -
      --- - - - - - -
      Returns:The current URL
      Return type:string
      -

      Returns the full URL (including segments) of the page being currently -viewed.

      -
      -

      Note

      -

      Calling this function is the same as doing this: -| -| site_url(uri_string());

      -
      -
      - -
      -
      -uri_string()
      -
      --- - - - - - -
      Returns:An URI string
      Return type:string
      -

      Returns the URI segments of any page that contains this function. -For example, if your URL was this:

      -
      http://some-site.com/blog/comments/123
-
      -
      -

      The function would return:

      -
      blog/comments/123
-
      -
      -

      This function is an alias for CI_Config::uri_string(). For more info, -please see the Config Library documentation.

      -
      - -
      -
      -index_page()
      -
      --- - - - - - -
      Returns:‘index_page’ value
      Return type:mixed
      -

      Returns your site index_page, as specified in your config file. -Example:

      -
      echo index_page();
-
      -
      -
      - -
      -
      -anchor($uri = '', $title = '', $attributes = '')
      -
      --- - - - - - - - -
      Parameters:
        -
      • $uri (string) – URI string
        • -
      • $title (string) – Anchor title
        • -
      • $attributes (mixed) – HTML attributes
        • -
      -
      Returns:

      HTML hyperlink (anchor tag)

      -
      Return type:

      string

      -
      -

      Creates a standard HTML anchor link based on your local site URL.

      -

      The first parameter can contain any segments you wish appended to the -URL. As with the site_url() function above, segments can -be a string or an array.

      -
      -

      Note

      -

      If you are building links that are internal to your application -do not include the base URL (http&#58;//...). This will be added -automatically from the information specified in your config file. -Include only the URI segments you wish appended to the URL.

      -
      -

      The second segment is the text you would like the link to say. If you -leave it blank, the URL will be used.

      -

      The third parameter can contain a list of attributes you would like -added to the link. The attributes can be a simple string or an -associative array.

      -

      Here are some examples:

      -
      echo anchor('news/local/123', 'My News', 'title="News title"');
-// Prints: <a href="http://example.com/index.php/news/local/123" title="News title">My News</a>
-
-echo anchor('news/local/123', 'My News', array('title' => 'The best news!'));
-// Prints: <a href="http://example.com/index.php/news/local/123" title="The best news!">My News</a>
-
-echo anchor('', 'Click here');
-// Prints: <a href="http://example.com">Click Here</a>
-
      -
      -
      - -
      -
      -anchor_popup($uri = '', $title = '', $attributes = FALSE)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $uri (string) – URI string
        • -
      • $title (string) – Anchor title
        • -
      • $attributes (mixed) – HTML attributes
        • -
      -
      Returns:

      Pop-up hyperlink

      -
      Return type:

      string

      -
      -

      Nearly identical to the anchor() function except that it -opens the URL in a new window. You can specify JavaScript window -attributes in the third parameter to control how the window is opened. -If the third parameter is not set it will simply open a new window with -your own browser settings.

      -

      Here is an example with attributes:

      -
      $atts = array(
-        'width'       => 800,
-        'height'      => 600,
-        'scrollbars'  => 'yes',
-        'status'      => 'yes',
-        'resizable'   => 'yes',
-        'screenx'     => 0,
-        'screeny'     => 0,
-        'window_name' => '_blank'
-);
-
-echo anchor_popup('news/local/123', 'Click Me!', $atts);
-
      -
      -
      -

      Note

      -

      The above attributes are the function defaults so you only need to -set the ones that are different from what you need. If you want the -function to use all of its defaults simply pass an empty array in the -third parameter: -| -| echo anchor_popup(‘news/local/123’, ‘Click Me!’, array());

      -
      -
      -

      Note

      -

      The window_name is not really an attribute, but an argument to -the JavaScript window.open() <http://www.w3schools.com/jsref/met_win_open.asp> -method, which accepts either a window name or a window target.

      -
      -
      -

      Note

      -

      Any other attribute than the listed above will be parsed as an -HTML attribute to the anchor tag.

      -
      -
      - -
      -
      -mailto($email, $title = '', $attributes = '')
      -
      --- - - - - - - - -
      Parameters:
        -
      • $email (string) – E-mail address
        • -
      • $title (string) – Anchor title
        • -
      • $attributes (mixed) – HTML attributes
        • -
      -
      Returns:

      A “mail to” hyperlink

      -
      Return type:

      string

      -
      -

      Creates a standard HTML e-mail link. Usage example:

      -
      echo mailto('me@my-site.com', 'Click Here to Contact Me');
-
      -
      -

      As with the anchor() tab above, you can set attributes using the -third parameter:

      -
      $attributes = array('title' => 'Mail me');
-echo mailto('me@my-site.com', 'Contact Me', $attributes);
-
      -
      -
      - -
      -
      -safe_mailto($email, $title = '', $attributes = '')
      -
      --- - - - - - - - -
      Parameters:
        -
      • $email (string) – E-mail address
        • -
      • $title (string) – Anchor title
        • -
      • $attributes (mixed) – HTML attributes
        • -
      -
      Returns:

      A spam-safe “mail to” hyperlink

      -
      Return type:

      string

      -
      -

      Identical to the mailto() function except it writes an obfuscated -version of the mailto tag using ordinal numbers written with JavaScript to -help prevent the e-mail address from being harvested by spam bots.

      -
      - -
      - -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $type (string) – Link type (‘email’, ‘url’ or ‘both’)
        • -
      • $popup (bool) – Whether to create popup links
        • -
      -
      Returns:

      Linkified string

      -
      Return type:

      string

      -
      -

      Automatically turns URLs and e-mail addresses contained in a string into -links. Example:

      -
      $string = auto_link($string);
-
      -
      -

      The second parameter determines whether URLs and e-mails are converted or -just one or the other. Default behavior is both if the parameter is not -specified. E-mail links are encoded as safe_mailto() as shown -above.

      -

      Converts only URLs:

      -
      $string = auto_link($string, 'url');
-
      -
      -

      Converts only e-mail addresses:

      -
      $string = auto_link($string, 'email');
-
      -
      -

      The third parameter determines whether links are shown in a new window. -The value can be TRUE or FALSE (boolean):

      -
      $string = auto_link($string, 'both', TRUE);
-
      -
      -
      - -
      -
      -url_title($str, $separator = '-', $lowercase = FALSE)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $separator (string) – Word separator
        • -
      • $lowercase (string) – Whether to transform the output string to lower-case
        • -
      -
      Returns:

      URL-formatted string

      -
      Return type:

      string

      -
      -

      Takes a string as input and creates a human-friendly URL string. This is -useful if, for example, you have a blog in which you’d like to use the -title of your entries in the URL. Example:

      -
      $title = "What's wrong with CSS?";
-$url_title = url_title($title);
-// Produces: Whats-wrong-with-CSS
-
      -
      -

      The second parameter determines the word delimiter. By default dashes -are used. Preferred options are: - (dash) or _ (underscore)

      -

      Example:

      -
      $title = "What's wrong with CSS?";
-$url_title = url_title($title, 'underscore');
-// Produces: Whats_wrong_with_CSS
-
      -
      -
      -

      Note

      -

      Old usage of ‘dash’ and ‘underscore’ as the second parameter -is DEPRECATED.

      -
      -

      The third parameter determines whether or not lowercase characters are -forced. By default they are not. Options are boolean TRUE/FALSE.

      -

      Example:

      -
      $title = "What's wrong with CSS?";
-$url_title = url_title($title, 'underscore', TRUE);
-// Produces: whats_wrong_with_css
-
      -
      -
      - -
      -
      -prep_url($str = '')
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – URL string
        • -
      -
      Returns:

      Protocol-prefixed URL string

      -
      Return type:

      string

      -
      -

      This function will add http&#58;// in the event that a protocol prefix -is missing from a URL.

      -

      Pass the URL string to the function like this:

      -
      $url = prep_url('example.com');
-
      -
      -
      - -
      -
      -redirect($uri = '', $method = 'auto', $code = NULL)
      -
      --- - - - - - -
      Parameters:
        -
      • $uri (string) – URI string
        • -
      • $method (string) – Redirect method (‘auto’, ‘location’ or ‘refresh’)
        • -
      • $code (string) – HTTP Response code (usually 302 or 303)
        • -
      -
      Return type:

      void

      -
      -

      Does a “header redirect” to the URI specified. If you specify the full -site URL that link will be built, but for local links simply providing -the URI segments to the controller you want to direct to will create the -link. The function will build the URL based on your config file values.

      -

      The optional second parameter allows you to force a particular redirection -method. The available methods are auto, location and refresh, -with location being faster but less reliable on IIS servers. -The default is auto, which will attempt to intelligently choose the -method based on the server environment.

      -

      The optional third parameter allows you to send a specific HTTP Response -Code - this could be used for example to create 301 redirects for search -engine purposes. The default Response Code is 302. The third parameter is -only available with location redirects, and not refresh. Examples:

      -
      if ($logged_in == FALSE)
-{
-        redirect('/login/form/');
-}
-
-// with 301 redirect
-redirect('/article/13', 'location', 301);
-
      -
      -
      -

      Note

      -

      In order for this function to work it must be used before anything -is outputted to the browser since it utilizes server headers.

      -
      -
      -

      Note

      -

      For very fine grained control over headers, you should use the -Output Library </libraries/output> set_header() method.

      -
      -
      -

      Note

      -

      To IIS users: if you hide the Server HTTP header, the auto -method won’t detect IIS, in that case it is advised you explicitly -use the refresh method.

      -
      -
      -

      Note

      -

      When the location method is used, an HTTP status code of 303 -will automatically be selected when the page is currently accessed -via POST and HTTP/1.1 is used.

      -
      -
      -

      Important

      -

      This function will terminate script execution.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/helpers/xml_helper.html b/user_guide/helpers/xml_helper.html deleted file mode 100755 index 9b69228..0000000 --- a/user_guide/helpers/xml_helper.html +++ /dev/null @@ -1,560 +0,0 @@ - - - - - - - - - - XML Helper — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Helpers »
        • - -
      • XML Helper
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      XML Helper

      -

      The XML Helper file contains functions that assist in working with XML -data.

      - -
      -

      Loading this Helper

      -

      This helper is loaded using the following code

      -
      $this->load->helper('xml');
-
      -
      -
      -
      -

      Available Functions

      -

      The following functions are available:

      -
      -
      -xml_convert($str[, $protect_all = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – the text string to convert
        • -
      • $protect_all (bool) – Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo;
        • -
      -
      Returns:

      XML-converted string

      -
      Return type:

      string

      -
      -

      Takes a string as input and converts the following reserved XML -characters to entities:

      -
      -
        -
      • Ampersands: &
        • -
      • Less than and greater than characters: < >
        • -
      • Single and double quotes: ‘ “
        • -
      • Dashes: -
        • -
      -
      -

      This function ignores ampersands if they are part of existing numbered -character entities, e.g. &#123;. Example:

      -
      $string = '<p>Here is a paragraph & an entity (&#123;).</p>';
-$string = xml_convert($string);
-echo $string;
-
      -
      -

      outputs:

      -
      &lt;p&gt;Here is a paragraph &amp; an entity (&#123;).&lt;/p&gt;
-
      -
      -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/index.html b/user_guide/index.html deleted file mode 100755 index ee4cae8..0000000 --- a/user_guide/index.html +++ /dev/null @@ -1,899 +0,0 @@ - - - - - - - - - - CodeIgniter User Guide — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • CodeIgniter User Guide
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      CodeIgniter User Guide

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/downloads.html b/user_guide/installation/downloads.html deleted file mode 100755 index b60a99a..0000000 --- a/user_guide/installation/downloads.html +++ /dev/null @@ -1,521 +0,0 @@ - - - - - - - - - - Downloading CodeIgniter — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Downloading CodeIgniter

      - -
      -

      GitHub

      -

      Git is a distributed version control system.

      -

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

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/index.html b/user_guide/installation/index.html deleted file mode 100755 index cffef15..0000000 --- a/user_guide/installation/index.html +++ /dev/null @@ -1,533 +0,0 @@ - - - - - - - - - - Installation Instructions — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Installation Instructions
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Installation Instructions

      -

      CodeIgniter is installed in four steps:

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

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

      -

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

      -

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

      -

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

      -

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

      -

      That’s it!

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/troubleshooting.html b/user_guide/installation/troubleshooting.html deleted file mode 100755 index 637d9f3..0000000 --- a/user_guide/installation/troubleshooting.html +++ /dev/null @@ -1,512 +0,0 @@ - - - - - - - - - - Troubleshooting — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Troubleshooting

      -

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

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

      To this:

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_120.html b/user_guide/installation/upgrade_120.html deleted file mode 100755 index 68a081a..0000000 --- a/user_guide/installation/upgrade_120.html +++ /dev/null @@ -1,517 +0,0 @@ - - - - - - - - - - Upgrading From Beta 1.0 to Final 1.2 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading From Beta 1.0 to Final 1.2

      -

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

      -
      -

      Note

      -

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

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

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_130.html b/user_guide/installation/upgrade_130.html deleted file mode 100755 index e62be9b..0000000 --- a/user_guide/installation/upgrade_130.html +++ /dev/null @@ -1,620 +0,0 @@ - - - - - - - - - - Upgrading from 1.2 to 1.3 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.2 to 1.3

      -
      -

      Note

      -

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

      -
      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace the following directories in your “system” folder with the new -versions:

      -
      -

      Note

      -

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

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

      Step 2: Update your error files

      -

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

      -

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

      -
        -
      • application/errors/
        • -
      -

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

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

      Step 3: Update your index.php file

      -

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

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

      To this:

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

      Step 4: Update your config.php file

      -

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

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

      Step 5: Update your database.php file

      -

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

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

      Step 6: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_131.html b/user_guide/installation/upgrade_131.html deleted file mode 100755 index c9dc257..0000000 --- a/user_guide/installation/upgrade_131.html +++ /dev/null @@ -1,528 +0,0 @@ - - - - - - - - - - Upgrading from 1.3 to 1.3.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.3 to 1.3.1

      -
      -

      Note

      -

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

      -
      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace the following directories in your “system” folder with the new -versions:

      -
      -

      Note

      -

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

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

      Step 2: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_132.html b/user_guide/installation/upgrade_132.html deleted file mode 100755 index af5c8a0..0000000 --- a/user_guide/installation/upgrade_132.html +++ /dev/null @@ -1,526 +0,0 @@ - - - - - - - - - - Upgrading from 1.3.1 to 1.3.2 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.3.1 to 1.3.2

      -
      -

      Note

      -

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

      -
      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace the following directories in your “system” folder with the new -versions:

      -
      -

      Note

      -

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

      -
      -
        -
      • drivers
        • -
      • init
        • -
      • libraries
        • -
      -
      -
      -

      Step 2: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_133.html b/user_guide/installation/upgrade_133.html deleted file mode 100755 index a4f3281..0000000 --- a/user_guide/installation/upgrade_133.html +++ /dev/null @@ -1,540 +0,0 @@ - - - - - - - - - - Upgrading from 1.3.2 to 1.3.3 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.3.2 to 1.3.3

      -
      -

      Note

      -

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

      -
      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace the following directories in your “system” folder with the new -versions:

      -
      -

      Note

      -

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

      -
      -
        -
      • codeigniter
        • -
      • drivers
        • -
      • helpers
        • -
      • init
        • -
      • libraries
        • -
      -
      -
      -

      Step 2: Update your Models

      -

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

      -

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

      -
      -
      -

      Step 3: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_140.html b/user_guide/installation/upgrade_140.html deleted file mode 100755 index a8fded9..0000000 --- a/user_guide/installation/upgrade_140.html +++ /dev/null @@ -1,568 +0,0 @@ - - - - - - - - - - Upgrading from 1.3.3 to 1.4.0 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.3.3 to 1.4.0

      -
      -

      Note

      -

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

      -
      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace the following directories in your “system” folder with the new -versions:

      -
      -

      Note

      -

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

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

      Step 2: Update your config.php file

      -

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

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

      Step 3: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_141.html b/user_guide/installation/upgrade_141.html deleted file mode 100755 index c8bcc4c..0000000 --- a/user_guide/installation/upgrade_141.html +++ /dev/null @@ -1,565 +0,0 @@ - - - - - - - - - - Upgrading from 1.4.0 to 1.4.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.4.0 to 1.4.1

      -
      -

      Note

      -

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

      -
      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace the following directories in your “system” folder with the new -versions:

      -
      -

      Note

      -

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

      -
      -
        -
      • codeigniter
        • -
      • drivers
        • -
      • helpers
        • -
      • libraries
        • -
      -
      -
      -

      Step 2: Update your config.php file

      -

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

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

      Step 3: Rename an Autoload Item

      -

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

      -

      Find this array item:

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

      And rename it to this:

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

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

      -
      -
      -

      Step 4: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_150.html b/user_guide/installation/upgrade_150.html deleted file mode 100755 index 66a1d40..0000000 --- a/user_guide/installation/upgrade_150.html +++ /dev/null @@ -1,592 +0,0 @@ - - - - - - - - - - Upgrading from 1.4.1 to 1.5.0 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.4.1 to 1.5.0

      -
      -

      Note

      -

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

      -
      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your database.php file

      -

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

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

      Step 3: Update your config.php file

      -

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

      -
      /*
-|--------------------------------------------------------------------------
-| Class Extension Prefix
-|--------------------------------------------------------------------------
-|
-| This item allows you to set the filename/classname prefix when extending
-| native libraries.  For more information please see the user guide:
-|
-| 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.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_152.html b/user_guide/installation/upgrade_152.html deleted file mode 100755 index 3ea2753..0000000 --- a/user_guide/installation/upgrade_152.html +++ /dev/null @@ -1,537 +0,0 @@ - - - - - - - - - - Upgrading from 1.5.0 to 1.5.2 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.5.0 to 1.5.2

      -
      -

      Note

      -

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

      -
      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_153.html b/user_guide/installation/upgrade_153.html deleted file mode 100755 index 72f93d5..0000000 --- a/user_guide/installation/upgrade_153.html +++ /dev/null @@ -1,524 +0,0 @@ - - - - - - - - - - Upgrading from 1.5.2 to 1.5.3 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.5.2 to 1.5.3

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_154.html b/user_guide/installation/upgrade_154.html deleted file mode 100755 index 4cf11e6..0000000 --- a/user_guide/installation/upgrade_154.html +++ /dev/null @@ -1,548 +0,0 @@ - - - - - - - - - - Upgrading from 1.5.3 to 1.5.4 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.5.3 to 1.5.4

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Add charset to your config.php

      -

      Add the following to application/config/config.php

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

      Step 3: Autoloading language files

      -

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

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

      Step 4: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_160.html b/user_guide/installation/upgrade_160.html deleted file mode 100755 index a236406..0000000 --- a/user_guide/installation/upgrade_160.html +++ /dev/null @@ -1,567 +0,0 @@ - - - - - - - - - - Upgrading from 1.5.4 to 1.6.0 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.5.4 to 1.6.0

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Add time_to_update to your config.php

      -

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

      -
      $config['sess_time_to_update']         = 300;
-
      -
      -
      -
      -

      Step 3: Add $autoload[‘model’]

      -

      Add the following to application/config/autoload.php

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

      Step 4: Add to your database.php

      -

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

      -

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

      -
      $active_record = TRUE;
-
      -
      -

      Remove the following from your database configuration options

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

      Add the following to your database configuration options

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

      Step 5: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_161.html b/user_guide/installation/upgrade_161.html deleted file mode 100755 index 1b57a0a..0000000 --- a/user_guide/installation/upgrade_161.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - - - - - - Upgrading from 1.6.0 to 1.6.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.6.0 to 1.6.1

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_162.html b/user_guide/installation/upgrade_162.html deleted file mode 100755 index 02e6840..0000000 --- a/user_guide/installation/upgrade_162.html +++ /dev/null @@ -1,538 +0,0 @@ - - - - - - - - - - Upgrading from 1.6.1 to 1.6.2 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.6.1 to 1.6.2

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Encryption Key

      -

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

      -
      -
      -

      Step 3: Constants File

      -

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

      -
      -
      -

      Step 4: Mimes File

      -

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

      -
      -
      -

      Step 5: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_163.html b/user_guide/installation/upgrade_163.html deleted file mode 100755 index 719c9c5..0000000 --- a/user_guide/installation/upgrade_163.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - - - - - - Upgrading from 1.6.2 to 1.6.3 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.6.2 to 1.6.3

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_170.html b/user_guide/installation/upgrade_170.html deleted file mode 100755 index bd71dfc..0000000 --- a/user_guide/installation/upgrade_170.html +++ /dev/null @@ -1,550 +0,0 @@ - - - - - - - - - - Upgrading from 1.6.3 to 1.7.0 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.6.3 to 1.7.0

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your Session Table

      -

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

      -
      user_data text NOT NULL
-
      -
      -

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

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

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

      -
      -
      -

      Step 3: Update your Validation Syntax

      -

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

      -
      -
      -

      Step 4: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_171.html b/user_guide/installation/upgrade_171.html deleted file mode 100755 index 4f3ec50..0000000 --- a/user_guide/installation/upgrade_171.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - - - - - - Upgrading from 1.7.0 to 1.7.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.7.0 to 1.7.1

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_172.html b/user_guide/installation/upgrade_172.html deleted file mode 100755 index 474d51b..0000000 --- a/user_guide/installation/upgrade_172.html +++ /dev/null @@ -1,540 +0,0 @@ - - - - - - - - - - Upgrading from 1.7.1 to 1.7.2 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.7.1 to 1.7.2

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace these files and directories in your “system” folder with the new -versions:

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

      Note

      -

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

      -
      -
      -
      -

      Step 2: Remove header() from 404 error template

      -

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

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

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

      -
      -
      -

      Step 3: Confirm your system_path

      -

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

      -
      -
      -

      Step 4: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_200.html b/user_guide/installation/upgrade_200.html deleted file mode 100755 index 5bcfe6c..0000000 --- a/user_guide/installation/upgrade_200.html +++ /dev/null @@ -1,633 +0,0 @@ - - - - - - - - - - Upgrading from 1.7.2 to 2.0.0 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 1.7.2 to 2.0.0

      -

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

      -
      -

      Update Instructions

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder except -your application folder.

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Adjust get_dir_file_info() where necessary

      -

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

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

      Step 3: Convert your Plugins to Helpers

      -

      2.0.0 gets rid of the “Plugin” system as their functionality was -identical to Helpers, but non-extensible. You will need to rename your -plugin files from filename_pi.php to filename_helper.php, move them to -your helpers folder, and change all instances of:

      -
      $this->load->plugin('foo');
-
      -
      -

      to

      -
      $this->load->helper('foo');
-
      -
      -
      -
      -

      Step 4: Update stored encrypted data

      -
      -

      Note

      -

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

      -
      -

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

      -

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

      -
      -
      -

      Step 5: Remove loading calls for the compatibility helper.

      -

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

      -
      -
      -

      Step 6: Update Class extension

      -

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

      -
      -
      -

      Step 7: Update Parent Constructor calls

      -

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

      -
      -
      -

      Step 8: Move any core extensions to application/core

      -

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

      -
      -
      -

      Step 9: Update your user guide

      -

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

      -
      -
      -
      -

      Update Notes

      -

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

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

      The config folder

      -

      The following files have been changed:

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

      The following files have been added:

      -
        -
      • foreign_chars.php
        • -
      • profiler.php
        • -
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_201.html b/user_guide/installation/upgrade_201.html deleted file mode 100755 index 3c97856..0000000 --- a/user_guide/installation/upgrade_201.html +++ /dev/null @@ -1,533 +0,0 @@ - - - - - - - - - - Upgrading from 2.0.0 to 2.0.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.0.0 to 2.0.1

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Replace config/mimes.php

      -

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

      -
      -
      -

      Step 3: Check for forms posting to default controller

      -

      The default behavior for form_open() when called with no parameters -used to be to post to the default controller, but it will now just leave -an empty action=”” meaning the form will submit to the current URL. If -submitting to the default controller was the expected behavior it will -need to be changed from:

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

      to use either a / or base_url():

      -
      echo form_open('/'); //<form action="http://example.com/index.php/" method="post" accept-charset="utf-8">
-echo form_open(base_url()); //<form action="http://example.com/" method="post" accept-charset="utf-8">
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_202.html b/user_guide/installation/upgrade_202.html deleted file mode 100755 index a6bbab0..0000000 --- a/user_guide/installation/upgrade_202.html +++ /dev/null @@ -1,526 +0,0 @@ - - - - - - - - - - Upgrading from 2.0.1 to 2.0.2 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.0.1 to 2.0.2

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Remove loading calls for the Security Library

      -

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

      -
      -
      -

      Step 3: Move MY_Security

      -

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

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_203.html b/user_guide/installation/upgrade_203.html deleted file mode 100755 index 444109f..0000000 --- a/user_guide/installation/upgrade_203.html +++ /dev/null @@ -1,556 +0,0 @@ - - - - - - - - - - Upgrading from 2.0.2 to 2.0.3 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.0.2 to 2.0.3

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your main index.php file

      -

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

      -

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

      -
      -
      -

      Step 3: Replace config/user_agents.php

      -

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

      -
      -
      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

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

      -

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

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

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

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

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

      -
      -
      -

      Update Sessions Database Tables

      -

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

      -
      CREATE INDEX last_activity_idx ON ci_sessions(last_activity);
-ALTER TABLE ci_sessions MODIFY user_agent VARCHAR(120);
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_210.html b/user_guide/installation/upgrade_210.html deleted file mode 100755 index e2c23e6..0000000 --- a/user_guide/installation/upgrade_210.html +++ /dev/null @@ -1,520 +0,0 @@ - - - - - - - - - - Upgrading from 2.0.3 to 2.1.0 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.0.3 to 2.1.0

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder.

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Replace config/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 3: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_211.html b/user_guide/installation/upgrade_211.html deleted file mode 100755 index 40e83f1..0000000 --- a/user_guide/installation/upgrade_211.html +++ /dev/null @@ -1,524 +0,0 @@ - - - - - - - - - - Upgrading from 2.1.0 to 2.1.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.1.0 to 2.1.1

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder.

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Replace config/mimes.php

      -

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

      -
      -
      -

      Step 3: Update your IP address tables

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_212.html b/user_guide/installation/upgrade_212.html deleted file mode 100755 index 6e8421a..0000000 --- a/user_guide/installation/upgrade_212.html +++ /dev/null @@ -1,515 +0,0 @@ - - - - - - - - - - Upgrading from 2.1.1 to 2.1.2 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.1.1 to 2.1.2

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder.

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_213.html b/user_guide/installation/upgrade_213.html deleted file mode 100755 index b75f3df..0000000 --- a/user_guide/installation/upgrade_213.html +++ /dev/null @@ -1,515 +0,0 @@ - - - - - - - - - - Upgrading from 2.1.2 to 2.1.3 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.1.2 to 2.1.3

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder.

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your user guide

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_214.html b/user_guide/installation/upgrade_214.html deleted file mode 100755 index 6de00e7..0000000 --- a/user_guide/installation/upgrade_214.html +++ /dev/null @@ -1,510 +0,0 @@ - - - - - - - - - - Upgrading from 2.1.3 to 2.1.4 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.1.3 to 2.1.4

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder.

      -
      -

      Note

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_220.html b/user_guide/installation/upgrade_220.html deleted file mode 100755 index 01485e8..0000000 --- a/user_guide/installation/upgrade_220.html +++ /dev/null @@ -1,519 +0,0 @@ - - - - - - - - - - Upgrading from 2.1.4 to 2.2.x — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.1.4 to 2.2.x

      -
      -

      Note

      -

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

      -
      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder.

      -
      -

      Note

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_221.html b/user_guide/installation/upgrade_221.html deleted file mode 100755 index 6afe36f..0000000 --- a/user_guide/installation/upgrade_221.html +++ /dev/null @@ -1,510 +0,0 @@ - - - - - - - - - - Upgrading from 2.2.0 to 2.2.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.2.0 to 2.2.1

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder.

      -
      -

      Note

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_222.html b/user_guide/installation/upgrade_222.html deleted file mode 100755 index 9bd6927..0000000 --- a/user_guide/installation/upgrade_222.html +++ /dev/null @@ -1,510 +0,0 @@ - - - - - - - - - - Upgrading from 2.2.1 to 2.2.2 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.2.1 to 2.2.2

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder.

      -
      -

      Note

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_223.html b/user_guide/installation/upgrade_223.html deleted file mode 100755 index 690312b..0000000 --- a/user_guide/installation/upgrade_223.html +++ /dev/null @@ -1,510 +0,0 @@ - - - - - - - - - - Upgrading from 2.2.2 to 2.2.3 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.2.2 to 2.2.3

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your “system” folder.

      -
      -

      Note

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_300.html b/user_guide/installation/upgrade_300.html deleted file mode 100755 index 686e9c9..0000000 --- a/user_guide/installation/upgrade_300.html +++ /dev/null @@ -1,1313 +0,0 @@ - - - - - - - - - - Upgrading from 2.2.x to 3.0.x — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 2.2.x to 3.0.x

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

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

      -
      -

      Important

      -

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

      -
      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your classes file names

      -

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

      -

      For example, if you have the following library file:

      -
      -
      application/libraries/mylibrary.php
      -

      ... then you’ll have to rename it to:

      -
      -
      application/libraries/Mylibrary.php
      -

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

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

      The above files should respectively be renamed to the following:

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

      Controllers:

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

      Models:

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

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

      -

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

      -
      -
      -

      Step 3: Replace config/mimes.php

      -

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

      -
      -
      -

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

      -

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

      -
      -
      -

      Step 5: Move your Log class overrides or extensions

      -

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

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

      Step 6: Update your Session library usage

      -

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

      -

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

      -

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

      -

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

      -
      -
        -

      • Set your $config['sess_driver'] value

        -

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

        -
        • -

      • Set a $config['sess_save_path'] value

        -

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

        -
        • -

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

        -

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

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

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

        -
        -

        Important

        -

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

        -
        -
        • -

      • Remove $config['sess_match_useragent']

        -

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

        -
        • -

      • Remove $config['sess_encrypt_cookie']

        -

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

        -
        • -

      • Remove $config['sess_expire_on_close']

        -

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

        -
        • -

      • Check “flashdata” for collisions with “userdata”

        -

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

        -
        • -

      • Check usage of session metadata

        -

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

        -
        • -

      • Check unset_userdata() usage

        -

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

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

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

      -
      -
      -

      Step 7: Update your config/database.php

      -

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

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

      Step 8: Replace your error templates

      -

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

      -

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

      -

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

      -
      -
      -

      Step 9: Update your config/routes.php file

      -
      -

      Routes containing :any

      -

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

      -

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

      -

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

      -

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

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

      Directories and ‘default_controller’, ‘404_override’

      -

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

      -

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

      -

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

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

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

      -

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

      -

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

      -
      -
      -
      -

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

      -

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

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

      Step 11: Usage of XSS filtering

      -

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

      -

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

      -

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

      -
      -
        -
      • Input Library
          -
        • input->get()
          • -
        • input->post()
          • -
        • input->get_post()
          • -
        • input->cookie()
          • -
        • input->server()
          • -
        • input->input_stream()
          • -
        -
        • -
      • Cookie Helper get_cookie()
        • -
      -
      -
      -

      Important

      -

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

      -
      -
      -
      -

      Step 12: Check for potential XSS issues with URIs

      -

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

      -

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

      -

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

      -
      -
      -

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

      -

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

      -

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

      -

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

      -

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

      -
      -
      -

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

      -

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

      -

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

      -
      -
      -

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

      -

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

      -
      -
      -

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

      -

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

      -

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

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

      Note

      -

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

      -
      -
      -
      -

      Step 17: Change usage of Email library with multiple emails

      -

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

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

      Step 18: Update your Form_validation language lines

      -

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

      -
      -
        -

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

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

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

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

      Note

      -

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

      -
      -
      -
      -

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

      -

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

      -

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

      -

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

      -

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

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

      Step 20: Remove usage of (previously) deprecated functionalities

      -

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

      -
      -

      The SHA1 library

      -

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

      -

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

      -
      -
      -

      The EXT constant

      -

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

      -
      -
      -

      Smiley helper

      -

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

      -

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

      -
      -
      -

      The Encrypt library

      -

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

      -

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

      -
      -

      Note

      -

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

      -
      -
      -

      Important

      -

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

      -
      -
      -
      -

      The Cart library

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

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

      -

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

      -

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

      -

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

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Security helper do_hash()

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      The $config[‘global_xss_filtering’] setting

      -

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

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      File helper read_file()

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      String helper repeater()

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      String helper trim_slashes()

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Form helper form_prep()

      -

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

      -

      Please use html_escape() instead.

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Email helper functions

      -

      Email Helper only has two functions

      -
      -
      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Date helper standard_date()

      -

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

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

      Note

      -

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

      -
      -
      -
      -

      HTML helpers nbs(), br()

      -

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

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Pagination library ‘anchor_class’ setting

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

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

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

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

      -

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

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Session Library method all_userdata()

      -

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

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

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Database Forge method add_column() with an AFTER clause

      -

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

      -

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

      -

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

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

      Note

      -

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

      -
      -
      -

      Note

      -

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

      -
      -
      -
      -

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

      -

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

      -

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

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

      Note

      -

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

      -
      -
      -
      -

      Input library method is_cli_request()

      -

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

      -

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

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

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

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Config library method system_url()

      -

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

      -

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

      -
      -

      Note

      -

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

      -
      -
      -

      The Javascript library

      -

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

      -

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

      -
      -

      Note

      -

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

      -
      -
      -
      -
      -
      -

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

      -

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

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_301.html b/user_guide/installation/upgrade_301.html deleted file mode 100755 index 1cf242c..0000000 --- a/user_guide/installation/upgrade_301.html +++ /dev/null @@ -1,514 +0,0 @@ - - - - - - - - - - Upgrading from 3.0.0 to 3.0.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 3.0.0 to 3.0.1

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your system/ directory.

      -
      -

      Note

      -

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

      -
      -
      -
      -

      Step 2: Update your CLI error templates

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_302.html b/user_guide/installation/upgrade_302.html deleted file mode 100755 index 64086ea..0000000 --- a/user_guide/installation/upgrade_302.html +++ /dev/null @@ -1,521 +0,0 @@ - - - - - - - - - - Upgrading from 3.0.1 to 3.0.2 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading from 3.0.1 to 3.0.2

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your system/ directory.

      -
      -

      Note

      -

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

      -
      -
      -
      -

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

      -

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

      -
      -

      Note

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

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

      Upgrading from 3.0.2 to 3.0.3

      -

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

      -
      -

      Step 1: Update your CodeIgniter files

      -

      Replace all files and directories in your system/ directory.

      -
      -

      Note

      -

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

      -
      -
      -
      -

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

      -

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

      -

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

      -

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

      -

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

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrade_b11.html b/user_guide/installation/upgrade_b11.html deleted file mode 100755 index 947b0ac..0000000 --- a/user_guide/installation/upgrade_b11.html +++ /dev/null @@ -1,568 +0,0 @@ - - - - - - - - - - Upgrading From Beta 1.0 to Beta 1.1 — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Upgrading From Beta 1.0 to Beta 1.1

      -

      To upgrade to Beta 1.1 please perform the following steps:

      -
      -

      Step 1: Replace your index file

      -

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

      -
      -
      -

      Step 2: Relocate your config folder

      -

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

      -
      -
      -

      Step 3: Replace directories

      -

      Replace the following directories with the new versions:

      -
        -
      • drivers
        • -
      • helpers
        • -
      • init
        • -
      • libraries
        • -
      • scaffolding
        • -
      -
      -
      -

      Step 4: Add the calendar language file

      -

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

      -
      -
      -

      Step 5: Edit your config file

      -

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

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

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

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

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

      -
      /*
-|------------------------------------------------
-| URI PROTOCOL
-|------------------------------------------------
-|
-| This item determines which server global
-| should be used to retrieve the URI string. The
-| default setting of "auto" works for most servers.
-| If your links do not seem to work, try one of
-| the other delicious flavors:
-|
-| 'auto'         Default - auto detects
-| 'path_info'    Uses the PATH_INFO
-| 'query_string'        Uses the QUERY_STRING
-*/
-
-$config['uri_protocol'] = "auto";
-
      -
      -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/installation/upgrading.html b/user_guide/installation/upgrading.html deleted file mode 100755 index 7d40d27..0000000 --- a/user_guide/installation/upgrading.html +++ /dev/null @@ -1,609 +0,0 @@ - - - - - - - - - - Upgrading From a Previous Version — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - - - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/benchmark.html b/user_guide/libraries/benchmark.html deleted file mode 100755 index bb5f3e6..0000000 --- a/user_guide/libraries/benchmark.html +++ /dev/null @@ -1,704 +0,0 @@ - - - - - - - - - - Benchmarking Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries »
        • - -
      • Benchmarking Class
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Benchmarking Class

      -

      CodeIgniter has a Benchmarking class that is always active, enabling the -time difference between any two marked points to be calculated.

      -
      -

      Note

      -

      This class is initialized automatically by the system so there -is no need to do it manually.

      -
      -

      In addition, the benchmark is always started the moment the framework is -invoked, and ended by the output class right before sending the final -view to the browser, enabling a very accurate timing of the entire -system execution to be shown.

      - -
      -

      Using the Benchmark Class

      -

      The Benchmark class can be used within your -controllers, -views, or your models. -The process for usage is this:

      -
        -
      1. Mark a start point
        2. -
      2. Mark an end point
        3. -
      3. Run the “elapsed time” function to view the results
        4. -
      -

      Here’s an example using real code:

      -
      $this->benchmark->mark('code_start');
-
-// Some code happens here
-
-$this->benchmark->mark('code_end');
-
-echo $this->benchmark->elapsed_time('code_start', 'code_end');
-
      -
      -
      -

      Note

      -

      The words “code_start” and “code_end” are arbitrary. They -are simply words used to set two markers. You can use any words you -want, and you can set multiple sets of markers. Consider this example:

      -
      $this->benchmark->mark('dog');
-
-// Some code happens here
-
-$this->benchmark->mark('cat');
-
-// More code happens here
-
-$this->benchmark->mark('bird');
-
-echo $this->benchmark->elapsed_time('dog', 'cat');
-echo $this->benchmark->elapsed_time('cat', 'bird');
-echo $this->benchmark->elapsed_time('dog', 'bird');
-
      -
      -
      -
      -

      Profiling Your Benchmark Points

      -

      If you want your benchmark data to be available to the -Profiler all of your marked points must -be set up in pairs, and each mark point name must end with _start and -_end. Each pair of points must otherwise be named identically. Example:

      -
      $this->benchmark->mark('my_mark_start');
-
-// Some code happens here...
-
-$this->benchmark->mark('my_mark_end');
-
-$this->benchmark->mark('another_mark_start');
-
-// Some more code happens here...
-
-$this->benchmark->mark('another_mark_end');
-
      -
      -

      Please read the Profiler page for more -information.

      -
      -
      -

      Displaying Total Execution Time

      -

      If you would like to display the total elapsed time from the moment -CodeIgniter starts to the moment the final output is sent to the -browser, simply place this in one of your view templates:

      -
      <?php echo $this->benchmark->elapsed_time();?>
-
      -
      -

      You’ll notice that it’s the same function used in the examples above to -calculate the time between two point, except you are not using any -parameters. When the parameters are absent, CodeIgniter does not stop -the benchmark until right before the final output is sent to the -browser. It doesn’t matter where you use the function call, the timer -will continue to run until the very end.

      -

      An alternate way to show your elapsed time in your view files is to use -this pseudo-variable, if you prefer not to use the pure PHP:

      -
      {elapsed_time}
-
      -
      -
      -

      Note

      -

      If you want to benchmark anything within your controller -functions you must set your own start/end points.

      -
      -
      -
      -

      Displaying Memory Consumption

      -

      If your PHP installation is configured with –enable-memory-limit, you -can display the amount of memory consumed by the entire system using the -following code in one of your view file:

      -
      <?php echo $this->benchmark->memory_usage();?>
-
      -
      -
      -

      Note

      -

      This function can only be used in your view files. The consumption -will reflect the total memory used by the entire app.

      -
      -

      An alternate way to show your memory usage in your view files is to use -this pseudo-variable, if you prefer not to use the pure PHP:

      -
      {memory_usage}
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Benchmark
      -
      -
      -mark($name)
      -
      --- - - - - - -
      Parameters:
        -
      • $name (string) – the name you wish to assign to your marker
        • -
      -
      Return type:

      void

      -
      -

      Sets a benchmark marker.

      -
      - -
      -
      -elapsed_time([$point1 = ''[, $point2 = ''[, $decimals = 4]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $point1 (string) – a particular marked point
        • -
      • $point2 (string) – a particular marked point
        • -
      • $decimals (int) – number of decimal places for precision
        • -
      -
      Returns:

      Elapsed time

      -
      Return type:

      string

      -
      -

      Calculates and returns the time difference between two marked points.

      -

      If the first parameter is empty this function instead returns the -{elapsed_time} pseudo-variable. This permits the full system -execution time to be shown in a template. The output class will -swap the real value for this variable.

      -
      - -
      -
      -memory_usage()
      -
      --- - - - - - -
      Returns:Memory usage info
      Return type:string
      -

      Simply returns the {memory_usage} marker.

      -

      This permits it to be put it anywhere in a template without the memory -being calculated until the end. The Output Class will -swap the real value for this variable.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/caching.html b/user_guide/libraries/caching.html deleted file mode 100755 index 226701e..0000000 --- a/user_guide/libraries/caching.html +++ /dev/null @@ -1,896 +0,0 @@ - - - - - - - - - - Caching Driver — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Caching Driver

      -

      CodeIgniter features wrappers around some of the most popular forms of -fast and dynamic caching. All but file-based caching require specific -server requirements, and a Fatal Exception will be thrown if server -requirements are not met.

      - -
      -

      Example Usage

      -

      The following example will load the cache driver, specify APC -as the driver to use, and fall back to file-based caching if APC is not -available in the hosting environment.

      -
      $this->load->driver('cache', array('adapter' => 'apc', 'backup' => 'file'));
-
-if ( ! $foo = $this->cache->get('foo'))
-{
-        echo 'Saving to the cache!<br />';
-        $foo = 'foobarbaz!';
-
-        // Save into the cache for 5 minutes
-        $this->cache->save('foo', $foo, 300);
-}
-
-echo $foo;
-
      -
      -

      You can also prefix cache item names via the key_prefix setting, which is useful -to avoid collisions when you’re running multiple applications on the same environment.

      -
      $this->load->driver('cache',
-        array('adapter' => 'apc', 'backup' => 'file', 'key_prefix' => 'my_')
-);
-
-$this->cache->get('foo'); // Will get the cache entry named 'my_foo'
-
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Cache
      -
      -
      -is_supported($driver)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $driver (string) – the name of the caching driver
        • -
      -
      Returns:

      TRUE if supported, FALSE if not

      -
      Return type:

      bool

      -
      -

      This method is automatically called when accessing drivers via -$this->cache->get(). However, if the individual drivers are used, -make sure to call this method to ensure the driver is supported in the -hosting environment.

      -
      if ($this->cache->apc->is_supported())
-{
-        if ($data = $this->cache->apc->get('my_cache'))
-        {
-                // do things.
-        }
-}
-
      -
      -
      - -
      -
      -get($id)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $id (string) – Cache item name
        • -
      -
      Returns:

      Item value or FALSE if not found

      -
      Return type:

      mixed

      -
      -

      This method will attempt to fetch an item from the cache store. If the -item does not exist, the method will return FALSE.

      -
      $foo = $this->cache->get('my_cached_item');
-
      -
      -
      - -
      -
      -save($id, $data[, $ttl = 60[, $raw = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $id (string) – Cache item name
        • -
      • $data (mixed) – the data to save
        • -
      • $ttl (int) – Time To Live, in seconds (default 60)
        • -
      • $raw (bool) – Whether to store the raw value
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      string

      -
      -

      This method will save an item to the cache store. If saving fails, the -method will return FALSE.

      -
      $this->cache->save('cache_item_id', 'data_to_cache');
-
      -
      -
      -

      Note

      -

      The $raw parameter is only utilized by APC and Memcache, -in order to allow usage of increment() and decrement().

      -
      -
      - -
      -
      -delete($id)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $id (string) – name of cached item
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      This method will delete a specific item from the cache store. If item -deletion fails, the method will return FALSE.

      -
      $this->cache->delete('cache_item_id');
-
      -
      -
      - -
      -
      -increment($id[, $offset = 1])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $id (string) – Cache ID
        • -
      • $offset (int) – Step/value to add
        • -
      -
      Returns:

      New value on success, FALSE on failure

      -
      Return type:

      mixed

      -
      -

      Performs atomic incrementation of a raw stored value.

      -
      // 'iterator' has a value of 2
-
-$this->cache->increment('iterator'); // 'iterator' is now 3
-
-$this->cache->increment('iterator', 3); // 'iterator' is now 6
-
      -
      -
      - -
      -
      -decrement($id[, $offset = 1])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $id (string) – Cache ID
        • -
      • $offset (int) – Step/value to reduce by
        • -
      -
      Returns:

      New value on success, FALSE on failure

      -
      Return type:

      mixed

      -
      -

      Performs atomic decrementation of a raw stored value.

      -
      // 'iterator' has a value of 6
-
-$this->cache->decrement('iterator'); // 'iterator' is now 5
-
-$this->cache->decrement('iterator', 2); // 'iterator' is now 3
-
      -
      -
      - -
      -
      -clean()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      This method will ‘clean’ the entire cache. If the deletion of the -cache files fails, the method will return FALSE.

      -
      $this->cache->clean();
-
      -
      -
      - -
      -
      -cache_info()
      -
      --- - - - - - -
      Returns:Information on the entire cache database
      Return type:mixed
      -

      This method will return information on the entire cache.

      -
      var_dump($this->cache->cache_info());
-
      -
      -
      -

      Note

      -

      The information returned and the structure of the data is dependent -on which adapter is being used.

      -
      -
      - -
      -
      -get_metadata($id)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $id (string) – Cache item name
        • -
      -
      Returns:

      Metadata for the cached item

      -
      Return type:

      mixed

      -
      -

      This method will return detailed information on a specific item in the -cache.

      -
      var_dump($this->cache->get_metadata('my_cached_item'));
-
      -
      -
      -

      Note

      -

      The information returned and the structure of the data is dependent -on which adapter is being used.

      -
      -
      - -
      - -
      -
      -

      Drivers

      -
      -

      Alternative PHP Cache (APC) Caching

      -

      All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:

      -
      $this->load->driver('cache');
-$this->cache->apc->save('foo', 'bar', 10);
-
      -
      -

      For more information on APC, please see -http://php.net/apc.

      -
      -
      -

      File-based Caching

      -

      Unlike caching from the Output Class, the driver file-based caching -allows for pieces of view files to be cached. Use this with care, and -make sure to benchmark your application, as a point can come where disk -I/O will negate positive gains by caching.

      -

      All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:

      -
      $this->load->driver('cache');
-$this->cache->file->save('foo', 'bar', 10);
-
      -
      -
      -
      -

      Memcached Caching

      -

      Multiple Memcached servers can be specified in the memcached.php -configuration file, located in the _application/config/* directory.

      -

      All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:

      -
      $this->load->driver('cache');
-$this->cache->memcached->save('foo', 'bar', 10);
-
      -
      -

      For more information on Memcached, please see -http://php.net/memcached.

      -
      -
      -

      WinCache Caching

      -

      Under Windows, you can also utilize the WinCache driver.

      -

      All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:

      -
      $this->load->driver('cache');
-$this->cache->wincache->save('foo', 'bar', 10);
-
      -
      -

      For more information on WinCache, please see -http://php.net/wincache.

      -
      -
      -

      Redis Caching

      -

      Redis is an in-memory key-value store which can operate in LRU cache mode. -To use it, you need Redis server and phpredis PHP extension.

      -

      Config options to connect to redis server must be stored in the application/config/redis.php file. -Available options are:

      -
      $config['socket_type'] = 'tcp'; //`tcp` or `unix`
-$config['socket'] = '/var/run/redis.sock'; // in case of `unix` socket type
-$config['host'] = '127.0.0.1';
-$config['password'] = NULL;
-$config['port'] = 6379;
-$config['timeout'] = 0;
-
      -
      -

      All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:

      -
      $this->load->driver('cache');
-$this->cache->redis->save('foo', 'bar', 10);
-
      -
      -

      For more information on Redis, please see -http://redis.io.

      -
      -
      -

      Dummy Cache

      -

      This is a caching backend that will always ‘miss.’ It stores no data, -but lets you keep your caching code in place in environments that don’t -support your chosen cache.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/calendar.html b/user_guide/libraries/calendar.html deleted file mode 100755 index a16011e..0000000 --- a/user_guide/libraries/calendar.html +++ /dev/null @@ -1,973 +0,0 @@ - - - - - - - - - - Calendaring Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Calendaring Class

      -

      The Calendar class enables you to dynamically create calendars. Your -calendars can be formatted through the use of a calendar template, -allowing 100% control over every aspect of its design. In addition, you -can pass data to your calendar cells.

      - -
      -

      Using the Calendaring Class

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the Calendar class is -initialized in your controller using the $this->load->library function:

      -
      $this->load->library('calendar');
-
      -
      -

      Once loaded, the Calendar object will be available using:

      -
      $this->calendar
-
      -
      -
      -
      -

      Displaying a Calendar

      -

      Here is a very simple example showing how you can display a calendar:

      -
      $this->load->library('calendar');
-echo $this->calendar->generate();
-
      -
      -

      The above code will generate a calendar for the current month/year based -on your server time. To show a calendar for a specific month and year -you will pass this information to the calendar generating function:

      -
      $this->load->library('calendar');
-echo $this->calendar->generate(2006, 6);
-
      -
      -

      The above code will generate a calendar showing the month of June in -2006. The first parameter specifies the year, the second parameter -specifies the month.

      -
      -
      -

      Passing Data to your Calendar Cells

      -

      To add data to your calendar cells involves creating an associative -array in which the keys correspond to the days you wish to populate and -the array value contains the data. The array is passed to the third -parameter of the calendar generating function. Consider this example:

      -
      $this->load->library('calendar');
-
-$data = array(
-        3  => 'http://example.com/news/article/2006/03/',
-        7  => 'http://example.com/news/article/2006/07/',
-        13 => 'http://example.com/news/article/2006/13/',
-        26 => 'http://example.com/news/article/2006/26/'
-);
-
-echo $this->calendar->generate(2006, 6, $data);
-
      -
      -

      Using the above example, day numbers 3, 7, 13, and 26 will become links -pointing to the URLs you’ve provided.

      -
      -

      Note

      -

      By default it is assumed that your array will contain links. -In the section that explains the calendar template below you’ll see how -you can customize how data passed to your cells is handled so you can -pass different types of information.

      -
      -
      -
      -

      Setting Display Preferences

      -

      There are seven preferences you can set to control various aspects of -the calendar. Preferences are set by passing an array of preferences in -the second parameter of the loading function. Here is an example:

      -
      $prefs = array(
-        'start_day'    => 'saturday',
-        'month_type'   => 'long',
-        'day_type'     => 'short'
-);
-
-$this->load->library('calendar', $prefs);
-
-echo $this->calendar->generate();
-
      -
      -

      The above code would start the calendar on saturday, use the “long” -month heading, and the “short” day names. More information regarding -preferences below.

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefaultOptionsDescription
      templateNoneNone
      -
      A string or array containing your calendar template.
      -
      See the template section below.
      -
      -
      local_timetime()NoneA Unix timestamp corresponding to the current time.
      start_daysundayAny week day (sunday, monday, tuesday, etc.)Sets the day of the week the calendar should start on.
      month_typelonglong, short
      -
      Determines what version of the month name to use in the header.
      -
      long = January, short = Jan.
      -
      -
      day_typeabrlong, short, abr
      -
      Determines what version of the weekday names to use in
      -
      the column headers. long = Sunday, short = Sun, abr = Su.
      -
      -
      show_next_prevFALSETRUE/FALSE (boolean)
      -
      Determines whether to display links allowing you to toggle
      -
      to next/previous months. See information on this feature below.
      -
      -
      next_prev_urlcontroller/methodA URLSets the basepath used in the next/previous calendar links.
      show_other_daysFALSETRUE/FALSE (boolean)
      -
      Determines whether to display days of other months that share the
      -
      first or last week of the calendar month.
      -
      -
      -
      - -
      -

      Creating a Calendar Template

      -

      By creating a calendar template you have 100% control over the design of -your calendar. Using the string method, each component of your calendar -will be placed within a pair of pseudo-variables as shown here:

      -
      $prefs['template'] = '
-
-        {table_open}<table border="0" cellpadding="0" cellspacing="0">{/table_open}
-
-        {heading_row_start}<tr>{/heading_row_start}
-
-        {heading_previous_cell}<th><a href="{previous_url}">&lt;&lt;</a></th>{/heading_previous_cell}
-        {heading_title_cell}<th colspan="{colspan}">{heading}</th>{/heading_title_cell}
-        {heading_next_cell}<th><a href="{next_url}">&gt;&gt;</a></th>{/heading_next_cell}
-
-        {heading_row_end}</tr>{/heading_row_end}
-
-        {week_row_start}<tr>{/week_row_start}
-        {week_day_cell}<td>{week_day}</td>{/week_day_cell}
-        {week_row_end}</tr>{/week_row_end}
-
-        {cal_row_start}<tr>{/cal_row_start}
-        {cal_cell_start}<td>{/cal_cell_start}
-        {cal_cell_start_today}<td>{/cal_cell_start_today}
-        {cal_cell_start_other}<td class="other-month">{/cal_cell_start_other}
-
-        {cal_cell_content}<a href="{content}">{day}</a>{/cal_cell_content}
-        {cal_cell_content_today}<div class="highlight"><a href="{content}">{day}</a></div>{/cal_cell_content_today}
-
-        {cal_cell_no_content}{day}{/cal_cell_no_content}
-        {cal_cell_no_content_today}<div class="highlight">{day}</div>{/cal_cell_no_content_today}
-
-        {cal_cell_blank}&nbsp;{/cal_cell_blank}
-
-        {cal_cell_other}{day}{/cal_cel_other}
-
-        {cal_cell_end}</td>{/cal_cell_end}
-        {cal_cell_end_today}</td>{/cal_cell_end_today}
-        {cal_cell_end_other}</td>{/cal_cell_end_other}
-        {cal_row_end}</tr>{/cal_row_end}
-
-        {table_close}</table>{/table_close}
-';
-
-$this->load->library('calendar', $prefs);
-
-echo $this->calendar->generate();
-
      -
      -

      Using the array method, you will pass key => value pairs. You can pass as -many or as few values as you’d like. Omitted keys will use the default values -inherited in the calendar class.

      -

      Example:

      -
      $prefs['template'] = array(
-        'table_open'           => '<table class="calendar">',
-        'cal_cell_start'       => '<td class="day">',
-        'cal_cell_start_today' => '<td class="today">'
-);
-
-$this->load->library('calendar', $prefs);
-
-echo $this->calendar->generate();
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Calendar
      -
      -
      -initialize([$config = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $config (array) – Configuration parameters
        • -
      -
      Returns:

      CI_Calendar instance (method chaining)

      -
      Return type:

      CI_Calendar

      -
      -

      Initializes the Calendaring preferences. Accepts an associative array as input, containing display preferences.

      -
      - -
      -
      -generate([$year = ''[, $month = ''[, $data = array()]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $year (int) – Year
        • -
      • $month (int) – Month
        • -
      • $data (array) – Data to be shown in the calendar cells
        • -
      -
      Returns:

      HTML-formatted calendar

      -
      Return type:

      string

      -
      -

      Generate the calendar.

      -
      - -
      -
      -get_month_name($month)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $month (int) – Month
        • -
      -
      Returns:

      Month name

      -
      Return type:

      string

      -
      -

      Generates a textual month name based on the numeric month provided.

      -
      - -
      -
      -get_day_names($day_type = '')
      -
      --- - - - - - - - -
      Parameters:
        -
      • $day_type (string) – ‘long’, ‘short’, or ‘abr’
        • -
      -
      Returns:

      Array of day names

      -
      Return type:

      array

      -
      -

      Returns an array of day names (Sunday, Monday, etc.) based on the type -provided. Options: long, short, abr. If no $day_type is provided (or -if an invalid type is provided) this method will return the “abbreviated” -style.

      -
      - -
      -
      -adjust_date($month, $year)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $month (int) – Month
        • -
      • $year (int) – Year
        • -
      -
      Returns:

      An associative array containing month and year

      -
      Return type:

      array

      -
      -

      This method makes sure that you have a valid month/year. For example, if -you submit 13 as the month, the year will increment and the month will -become January:

      -
      print_r($this->calendar->adjust_date(13, 2014));
-
      -
      -

      outputs:

      -
      Array
-(
-        [month] => '01'
-        [year] => '2015'
-)
-
      -
      -
      - -
      -
      -get_total_days($month, $year)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $month (int) – Month
        • -
      • $year (int) – Year
        • -
      -
      Returns:

      Count of days in the specified month

      -
      Return type:

      int

      -
      -

      Total days in a given month:

      -
      echo $this->calendar->get_total_days(2, 2012);
-// 29
-
      -
      -
      -

      Note

      -

      This method is an alias for Date Helper function days_in_month().

      -
      -
      - -
      -
      -default_template()
      -
      --- - - - - - -
      Returns:An array of template values
      Return type:array
      -

      Sets the default template. This method is used when you have not created -your own template.

      -
      - -
      -
      -parse_template()
      -
      --- - - - - - -
      Returns:CI_Calendar instance (method chaining)
      Return type:CI_Calendar
      -

      Harvests the data within the template {pseudo-variables} used to -display the calendar.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/cart.html b/user_guide/libraries/cart.html deleted file mode 100755 index ffa0290..0000000 --- a/user_guide/libraries/cart.html +++ /dev/null @@ -1,1026 +0,0 @@ - - - - - - - - - - Shopping Cart Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries »
        • - -
      • Shopping Cart Class
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Shopping Cart Class

      -

      The Cart Class permits items to be added to a session that stays active -while a user is browsing your site. These items can be retrieved and -displayed in a standard “shopping cart” format, allowing the user to -update the quantity or remove items from the cart.

      -
      -

      Important

      -

      The Cart library is DEPRECATED and should not be used. -It is currently only kept for backwards compatibility.

      -
      -

      Please note that the Cart Class ONLY provides the core “cart” -functionality. It does not provide shipping, credit card authorization, -or other processing components.

      - -
      -

      Using the Cart Class

      -
      -

      Initializing the Shopping Cart Class

      -
      -

      Important

      -

      The Cart class utilizes CodeIgniter’s Session -Class to save the cart information to a database, so -before using the Cart class you must set up a database table as -indicated in the Session Documentation, and set the -session preferences in your application/config/config.php file to -utilize a database.

      -
      -

      To initialize the Shopping Cart Class in your controller constructor, -use the $this->load->library() method:

      -
      $this->load->library('cart');
-
      -
      -

      Once loaded, the Cart object will be available using:

      -
      $this->cart
-
      -
      -
      -

      Note

      -

      The Cart Class will load and initialize the Session Class -automatically, so unless you are using sessions elsewhere in your -application, you do not need to load the Session class.

      -
      -
      -
      -

      Adding an Item to The Cart

      -

      To add an item to the shopping cart, simply pass an array with the -product information to the $this->cart->insert() method, as shown -below:

      -
      $data = array(
-        'id'      => 'sku_123ABC',
-        'qty'     => 1,
-        'price'   => 39.95,
-        'name'    => 'T-Shirt',
-        'options' => array('Size' => 'L', 'Color' => 'Red')
-);
-
-$this->cart->insert($data);
-
      -
      -
      -

      Important

      -

      The first four array indexes above (id, qty, price, and -name) are required. If you omit any of them the data will not be -saved to the cart. The fifth index (options) is optional. It is intended -to be used in cases where your product has options associated with it. -Use an array for options, as shown above.

      -
      -

      The five reserved indexes are:

      -
        -
      • id - Each product in your store must have a unique identifier. -Typically this will be an “sku” or other such identifier.
        • -
      • qty - The quantity being purchased.
        • -
      • price - The price of the item.
        • -
      • name - The name of the item.
        • -
      • options - Any additional attributes that are needed to identify -the product. These must be passed via an array.
        • -
      -

      In addition to the five indexes above, there are two reserved words: -rowid and subtotal. These are used internally by the Cart class, so -please do NOT use those words as index names when inserting data into -the cart.

      -

      Your array may contain additional data. Anything you include in your -array will be stored in the session. However, it is best to standardize -your data among all your products in order to make displaying the -information in a table easier.

      -
      $data = array(
-        'id'      => 'sku_123ABC',
-        'qty'     => 1,
-        'price'   => 39.95,
-        'name'    => 'T-Shirt',
-        'coupon'         => 'XMAS-50OFF'
-);
-
-$this->cart->insert($data);
-
      -
      -

      The insert() method will return the $rowid if you successfully insert a -single item.

      -
      -
      -

      Adding Multiple Items to The Cart

      -

      By using a multi-dimensional array, as shown below, it is possible to -add multiple products to the cart in one action. This is useful in cases -where you wish to allow people to select from among several items on the -same page.

      -
      $data = array(
-        array(
-                'id'      => 'sku_123ABC',
-                'qty'     => 1,
-                'price'   => 39.95,
-                'name'    => 'T-Shirt',
-                'options' => array('Size' => 'L', 'Color' => 'Red')
-        ),
-        array(
-                'id'      => 'sku_567ZYX',
-                'qty'     => 1,
-                'price'   => 9.95,
-                'name'    => 'Coffee Mug'
-        ),
-        array(
-                'id'      => 'sku_965QRS',
-                'qty'     => 1,
-                'price'   => 29.95,
-                'name'    => 'Shot Glass'
-        )
-);
-
-$this->cart->insert($data);
-
      -
      -
      -
      -

      Displaying the Cart

      -

      To display the cart you will create a view -file with code similar to the one shown below.

      -

      Please note that this example uses the form -helper.

      -
      <?php echo form_open('path/to/controller/update/method'); ?>
-
-<table cellpadding="6" cellspacing="1" style="width:100%" border="0">
-
-<tr>
-        <th>QTY</th>
-        <th>Item Description</th>
-        <th style="text-align:right">Item Price</th>
-        <th style="text-align:right">Sub-Total</th>
-</tr>
-
-<?php $i = 1; ?>
-
-<?php foreach ($this->cart->contents() as $items): ?>
-
-        <?php echo form_hidden($i.'[rowid]', $items['rowid']); ?>
-
-        <tr>
-                <td><?php echo form_input(array('name' => $i.'[qty]', 'value' => $items['qty'], 'maxlength' => '3', 'size' => '5')); ?></td>
-                <td>
-                        <?php echo $items['name']; ?>
-
-                        <?php if ($this->cart->has_options($items['rowid']) == TRUE): ?>
-
-                                <p>
-                                        <?php foreach ($this->cart->product_options($items['rowid']) as $option_name => $option_value): ?>
-
-                                                <strong><?php echo $option_name; ?>:</strong> <?php echo $option_value; ?><br />
-
-                                        <?php endforeach; ?>
-                                </p>
-
-                        <?php endif; ?>
-
-                </td>
-                <td style="text-align:right"><?php echo $this->cart->format_number($items['price']); ?></td>
-                <td style="text-align:right">$<?php echo $this->cart->format_number($items['subtotal']); ?></td>
-        </tr>
-
-<?php $i++; ?>
-
-<?php endforeach; ?>
-
-<tr>
-        <td colspan="2"> </td>
-        <td class="right"><strong>Total</strong></td>
-        <td class="right">$<?php echo $this->cart->format_number($this->cart->total()); ?></td>
-</tr>
-
-</table>
-
-<p><?php echo form_submit('', 'Update your Cart'); ?></p>
-
      -
      -
      -
      -

      Updating The Cart

      -

      To update the information in your cart, you must pass an array -containing the Row ID and one or more pre-defined properties to the -$this->cart->update() method.

      -
      -

      Note

      -

      If the quantity is set to zero, the item will be removed from -the cart.

      -
      -
      $data = array(
-        'rowid' => 'b99ccdf16028f015540f341130b6d8ec',
-        'qty'   => 3
-);
-
-$this->cart->update($data);
-
-// Or a multi-dimensional array
-
-$data = array(
-        array(
-                'rowid'   => 'b99ccdf16028f015540f341130b6d8ec',
-                'qty'     => 3
-        ),
-        array(
-                'rowid'   => 'xw82g9q3r495893iajdh473990rikw23',
-                'qty'     => 4
-        ),
-        array(
-                'rowid'   => 'fh4kdkkkaoe30njgoe92rkdkkobec333',
-                'qty'     => 2
-        )
-);
-
-$this->cart->update($data);
-
      -
      -

      You may also update any property you have previously defined when -inserting the item such as options, price or other custom fields.

      -
      $data = array(
-        'rowid'  => 'b99ccdf16028f015540f341130b6d8ec',
-        'qty'    => 1,
-        'price'  => 49.95,
-        'coupon' => NULL
-);
-
-$this->cart->update($data);
-
      -
      -
      -

      What is a Row ID?

      -

      The row ID is a unique identifier that is generated by the cart code -when an item is added to the cart. The reason a unique ID is created -is so that identical products with different options can be managed -by the cart.

      -

      For example, let’s say someone buys two identical t-shirts (same product -ID), but in different sizes. The product ID (and other attributes) will -be identical for both sizes because it’s the same shirt. The only -difference will be the size. The cart must therefore have a means of -identifying this difference so that the two sizes of shirts can be -managed independently. It does so by creating a unique “row ID” based on -the product ID and any options associated with it.

      -

      In nearly all cases, updating the cart will be something the user does -via the “view cart” page, so as a developer, it is unlikely that you -will ever have to concern yourself with the “row ID”, other than making -sure your “view cart” page contains this information in a hidden form -field, and making sure it gets passed to the update() method when -the update form is submitted. Please examine the construction of the -“view cart” page above for more information.

      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Cart
      -
      -
      -$product_id_rules = '.a-z0-9_-'
      -

      These are the regular expression rules that we use to validate the product -ID - alpha-numeric, dashes, underscores, or periods by default

      -
      - -
      -
      -$product_name_rules = 'w -.:'
      -

      These are the regular expression rules that we use to validate the product ID and product name - alpha-numeric, dashes, underscores, colons or periods by -default

      -
      - -
      -
      -$product_name_safe = TRUE
      -

      Whether or not to only allow safe product names. Default TRUE.

      -
      - -
      -
      -insert([$items = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $items (array) – Items to insert into the cart
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Insert items into the cart and save it to the session table. Returns TRUE -on success and FALSE on failure.

      -
      - -
      -
      -update([$items = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $items (array) – Items to update in the cart
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      This method permits changing the properties of a given item. -Typically it is called from the “view cart” page if a user makes changes -to the quantity before checkout. That array must contain the rowid -for each item.

      -
      - -
      -
      -remove($rowid)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $rowid (int) – ID of the item to remove from the cart
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Allows you to remove an item from the shopping cart by passing it the -$rowid.

      -
      - -
      -
      -total()
      -
      --- - - - - - -
      Returns:Total amount
      Return type:int
      -

      Displays the total amount in the cart.

      -
      - -
      -
      -total_items()
      -
      --- - - - - - -
      Returns:Total amount of items in the cart
      Return type:int
      -

      Displays the total number of items in the cart.

      -
      - -
      -
      -contents([$newest_first = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $newest_first (bool) – Whether to order the array with newest items first
        • -
      -
      Returns:

      An array of cart contents

      -
      Return type:

      array

      -
      -

      Returns an array containing everything in the cart. You can sort the -order by which the array is returned by passing it TRUE where the contents -will be sorted from newest to oldest, otherwise it is sorted from oldest -to newest.

      -
      - -
      -
      -get_item($row_id)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $row_id (int) – Row ID to retrieve
        • -
      -
      Returns:

      Array of item data

      -
      Return type:

      array

      -
      -

      Returns an array containing data for the item matching the specified row -ID, or FALSE if no such item exists.

      -
      - -
      -
      -has_options($row_id = '')
      -
      --- - - - - - - - -
      Parameters:
        -
      • $row_id (int) – Row ID to inspect
        • -
      -
      Returns:

      TRUE if options exist, FALSE otherwise

      -
      Return type:

      bool

      -
      -

      Returns TRUE (boolean) if a particular row in the cart contains options. -This method is designed to be used in a loop with contents(), since -you must pass the rowid to this method, as shown in the Displaying -the Cart example above.

      -
      - -
      -
      -product_options([$row_id = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $row_id (int) – Row ID
        • -
      -
      Returns:

      Array of product options

      -
      Return type:

      array

      -
      -

      Returns an array of options for a particular product. This method is -designed to be used in a loop with contents(), since you -must pass the rowid to this method, as shown in the Displaying the -Cart example above.

      -
      - -
      -
      -destroy()
      -
      --- - - - -
      Return type:void
      -

      Permits you to destroy the cart. This method will likely be called -when you are finished processing the customer’s order.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/config.html b/user_guide/libraries/config.html deleted file mode 100755 index a136f67..0000000 --- a/user_guide/libraries/config.html +++ /dev/null @@ -1,835 +0,0 @@ - - - - - - - - - - Config Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Config Class

      -

      The Config class provides a means to retrieve configuration preferences. -These preferences can come from the default config file -(application/config/config.php) or from your own custom config files.

      -
      -

      Note

      -

      This class is initialized automatically by the system so there -is no need to do it manually.

      -
      - -
      -

      Working with the Config Class

      -
      -

      Anatomy of a Config File

      -

      By default, CodeIgniter has one primary config file, located at -application/config/config.php. If you open the file using your text -editor you’ll see that config items are stored in an array called -$config.

      -

      You can add your own config items to this file, or if you prefer to keep -your configuration items separate (assuming you even need config items), -simply create your own file and save it in config folder.

      -
      -

      Note

      -

      If you do create your own config files use the same format as -the primary one, storing your items in an array called $config. -CodeIgniter will intelligently manage these files so there will be no -conflict even though the array has the same name (assuming an array -index is not named the same as another).

      -
      -
      -
      -

      Loading a Config File

      -
      -

      Note

      -

      CodeIgniter automatically loads the primary config file -(application/config/config.php), so you will only need to load a config -file if you have created your own.

      -
      -

      There are two ways to load a config file:

      -
      -

      Manual Loading

      -

      To load one of your custom config files you will use the following -function within the controller that -needs it:

      -
      $this->config->load('filename');
-
      -
      -

      Where filename is the name of your config file, without the .php file -extension.

      -

      If you need to load multiple config files normally they will be -merged into one master config array. Name collisions can occur, -however, if you have identically named array indexes in different -config files. To avoid collisions you can set the second parameter to -TRUE and each config file will be stored in an array index -corresponding to the name of the config file. Example:

      -
      // Stored in an array with this prototype: $this->config['blog_settings'] = $config
-$this->config->load('blog_settings', TRUE);
-
      -
      -

      Please see the section entitled Fetching Config Items below to learn -how to retrieve config items set this way.

      -

      The third parameter allows you to suppress errors in the event that a -config file does not exist:

      -
      $this->config->load('blog_settings', FALSE, TRUE);
-
      -
      -
      -
      -

      Auto-loading

      -

      If you find that you need a particular config file globally, you can -have it loaded automatically by the system. To do this, open the -autoload.php file, located at application/config/autoload.php, -and add your config file as indicated in the file.

      -
      -
      -
      -

      Fetching Config Items

      -

      To retrieve an item from your config file, use the following function:

      -
      $this->config->item('item_name');
-
      -
      -

      Where item_name is the $config array index you want to retrieve. For -example, to fetch your language choice you’ll do this:

      -
      $lang = $this->config->item('language');
-
      -
      -

      The function returns NULL if the item you are trying to fetch -does not exist.

      -

      If you are using the second parameter of the $this->config->load -function in order to assign your config items to a specific index you -can retrieve it by specifying the index name in the second parameter of -the $this->config->item() function. Example:

      -
      // Loads a config file named blog_settings.php and assigns it to an index named "blog_settings"
-$this->config->load('blog_settings', TRUE);
-
-// Retrieve a config item named site_name contained within the blog_settings array
-$site_name = $this->config->item('site_name', 'blog_settings');
-
-// An alternate way to specify the same item:
-$blog_config = $this->config->item('blog_settings');
-$site_name = $blog_config['site_name'];
-
      -
      -
      -
      -

      Setting a Config Item

      -

      If you would like to dynamically set a config item or change an existing -one, you can do so using:

      -
      $this->config->set_item('item_name', 'item_value');
-
      -
      -

      Where item_name is the $config array index you want to change, and -item_value is its value.

      -
      -
      -

      Environments

      -

      You may load different configuration files depending on the current -environment. The ENVIRONMENT constant is defined in index.php, and is -described in detail in the Handling -Environments section.

      -

      To create an environment-specific configuration file, create or copy a -configuration file in application/config/{ENVIRONMENT}/{FILENAME}.php

      -

      For example, to create a production-only config.php, you would:

      -
        -
      1. Create the directory application/config/production/
        2. -
      2. Copy your existing config.php into the above directory
        3. -
      3. Edit application/config/production/config.php so it contains your -production settings
        4. -
      -

      When you set the ENVIRONMENT constant to ‘production’, the settings for -your new production-only config.php will be loaded.

      -

      You can place the following configuration files in environment-specific -folders:

      -
        -
      • Default CodeIgniter configuration files
        • -
      • Your own custom configuration files
        • -
      -
      -

      Note

      -

      CodeIgniter always loads the global config file first (i.e., the one in application/config/), -then tries to load the configuration files for the current environment. -This means you are not obligated to place all of your configuration files in an -environment folder. Only the files that change per environment. Additionally you don’t -have to copy all the config items in the environment config file. Only the config items -that you wish to change for your environment. The config items declared in your environment -folders always overwrite those in your global config files.

      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Config
      -
      -
      -$config
      -

      Array of all loaded config values

      -
      - -
      -
      -$is_loaded
      -

      Array of all loaded config files

      -
      - -
      -
      -item($item[, $index=''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $item (string) – Config item name
        • -
      • $index (string) – Index name
        • -
      -
      Returns:

      Config item value or NULL if not found

      -
      Return type:

      mixed

      -
      -

      Fetch a config file item.

      -
      - -
      -
      -set_item($item, $value)
      -
      --- - - - - - -
      Parameters:
        -
      • $item (string) – Config item name
        • -
      • $value (string) – Config item value
        • -
      -
      Return type:

      void

      -
      -

      Sets a config file item to the specified value.

      -
      - -
      -
      -slash_item($item)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $item (string) – config item name
        • -
      -
      Returns:

      Config item value with a trailing forward slash or NULL if not found

      -
      Return type:

      mixed

      -
      -

      This method is identical to item(), except it appends a forward -slash to the end of the item, if it exists.

      -
      - -
      -
      -load([$file = ''[, $use_sections = FALSE[, $fail_gracefully = FALSE]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $file (string) – Configuration file name
        • -
      • $use_sections (bool) – Whether config values shoud be loaded into their own section (index of the main config array)
        • -
      • $fail_gracefully (bool) – Whether to return FALSE or to display an error message
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Loads a configuration file.

      -
      - -
      -
      -site_url()
      -
      --- - - - - - -
      Returns:Site URL
      Return type:string
      -

      This method retrieves the URL to your site, along with the “index” value -you’ve specified in the config file.

      -

      This method is normally accessed via the corresponding functions in the -URL Helper.

      -
      - -
      -
      -base_url()
      -
      --- - - - - - -
      Returns:Base URL
      Return type:string
      -

      This method retrieves the URL to your site, plus an optional path such -as to a stylesheet or image.

      -

      This method is normally accessed via the corresponding functions in the -URL Helper.

      -
      - -
      -
      -system_url()
      -
      --- - - - - - -
      Returns:URL pointing at your CI system/ directory
      Return type:string
      -

      This method retrieves the URL to your CodeIgniter system/ directory.

      -
      -

      Note

      -

      This method is DEPRECATED because it encourages usage of -insecure coding practices. Your system/ directory shouldn’t -be publicly accessible.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/email.html b/user_guide/libraries/email.html deleted file mode 100755 index a1d55d5..0000000 --- a/user_guide/libraries/email.html +++ /dev/null @@ -1,1219 +0,0 @@ - - - - - - - - - - Email Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Email Class

      -

      CodeIgniter’s robust Email Class supports the following features:

      -
        -
      • Multiple Protocols: Mail, Sendmail, and SMTP
        • -
      • TLS and SSL Encryption for SMTP
        • -
      • Multiple recipients
        • -
      • CC and BCCs
        • -
      • HTML or Plaintext email
        • -
      • Attachments
        • -
      • Word wrapping
        • -
      • Priorities
        • -
      • BCC Batch Mode, enabling large email lists to be broken into small -BCC batches.
        • -
      • Email Debugging tools
        • -
      - -
      -

      Using the Email Library

      -
      -

      Sending Email

      -

      Sending email is not only simple, but you can configure it on the fly or -set your preferences in a config file.

      -

      Here is a basic example demonstrating how you might send email. Note: -This example assumes you are sending the email from one of your -controllers.

      -
      $this->load->library('email');
-
-$this->email->from('your@example.com', 'Your Name');
-$this->email->to('someone@example.com');
-$this->email->cc('another@another-example.com');
-$this->email->bcc('them@their-example.com');
-
-$this->email->subject('Email Test');
-$this->email->message('Testing the email class.');
-
-$this->email->send();
-
      -
      -
      -
      -

      Setting Email Preferences

      -

      There are 21 different preferences available to tailor how your email -messages are sent. You can either set them manually as described here, -or automatically via preferences stored in your config file, described -below:

      -

      Preferences are set by passing an array of preference values to the -email initialize method. Here is an example of how you might set some -preferences:

      -
      $config['protocol'] = 'sendmail';
-$config['mailpath'] = '/usr/sbin/sendmail';
-$config['charset'] = 'iso-8859-1';
-$config['wordwrap'] = TRUE;
-
-$this->email->initialize($config);
-
      -
      -
      -

      Note

      -

      Most of the preferences have default values that will be used -if you do not set them.

      -
      -
      -

      Setting Email Preferences in a Config File

      -

      If you prefer not to set preferences using the above method, you can -instead put them into a config file. Simply create a new file called the -email.php, add the $config array in that file. Then save the file at -config/email.php and it will be used automatically. You will NOT need to -use the $this->email->initialize() method if you save your -preferences in a config file.

      -
      -
      -
      -

      Email Preferences

      -

      The following is a list of all the preferences that can be set when -sending email.

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefault ValueOptionsDescription
      useragentCodeIgniterNoneThe “user agent”.
      protocolmailmail, sendmail, or smtpThe mail sending protocol.
      mailpath/usr/sbin/sendmailNoneThe server path to Sendmail.
      smtp_hostNo DefaultNoneSMTP Server Address.
      smtp_userNo DefaultNoneSMTP Username.
      smtp_passNo DefaultNoneSMTP Password.
      smtp_port25NoneSMTP Port.
      smtp_timeout5NoneSMTP Timeout (in seconds).
      smtp_keepaliveFALSETRUE or FALSE (boolean)Enable persistent SMTP connections.
      smtp_cryptoNo Defaulttls or sslSMTP Encryption
      wordwrapTRUETRUE or FALSE (boolean)Enable word-wrap.
      wrapchars76 Character count to wrap at.
      mailtypetexttext or htmlType of mail. If you send HTML email you must send it as a complete web -page. Make sure you don’t have any relative links or relative image -paths otherwise they will not work.
      charset$config['charset'] Character set (utf-8, iso-8859-1, etc.).
      validateFALSETRUE or FALSE (boolean)Whether to validate the email address.
      priority31, 2, 3, 4, 5Email Priority. 1 = highest. 5 = lowest. 3 = normal.
      crlf\n“\r\n” or “\n” or “\r”Newline character. (Use “\r\n” to comply with RFC 822).
      newline\n“\r\n” or “\n” or “\r”Newline character. (Use “\r\n” to comply with RFC 822).
      bcc_batch_modeFALSETRUE or FALSE (boolean)Enable BCC Batch Mode.
      bcc_batch_size200NoneNumber of emails in each BCC batch.
      dsnFALSETRUE or FALSE (boolean)Enable notify message from server
      -
      -
      -

      Overriding Word Wrapping

      -

      If you have word wrapping enabled (recommended to comply with RFC 822) -and you have a very long link in your email it can get wrapped too, -causing it to become un-clickable by the person receiving it. -CodeIgniter lets you manually override word wrapping within part of your -message like this:

      -
      The text of your email that
-gets wrapped normally.
-
-{unwrap}http://example.com/a_long_link_that_should_not_be_wrapped.html{/unwrap}
-
-More text that will be
-wrapped normally.
-
      -
      -

      Place the item you do not want word-wrapped between: {unwrap} {/unwrap}

      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Email
      -
      -
      -from($from[, $name = ''[, $return_path = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $from (string) – “From” e-mail address
        • -
      • $name (string) – “From” display name
        • -
      • $return_path (string) – Optional email address to redirect undelivered e-mail to
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Sets the email address and name of the person sending the email:

      -
      $this->email->from('you@example.com', 'Your Name');
-
      -
      -

      You can also set a Return-Path, to help redirect undelivered mail:

      -
      $this->email->from('you@example.com', 'Your Name', 'returned_emails@example.com');
-
      -
      -
      -

      Note

      -

      Return-Path can’t be used if you’ve configured ‘smtp’ as -your protocol.

      -
      -
      - -
      -
      -reply_to($replyto[, $name = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $replyto (string) – E-mail address for replies
        • -
      • $name (string) – Display name for the reply-to e-mail address
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Sets the reply-to address. If the information is not provided the -information in the :meth:from method is used. Example:

      -
      $this->email->reply_to('you@example.com', 'Your Name');
-
      -
      -
      - -
      -
      -to($to)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $to (mixed) – Comma-delimited string or an array of e-mail addresses
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Sets the email address(s) of the recipient(s). Can be a single e-mail, -a comma-delimited list or an array:

      -
      $this->email->to('someone@example.com');
-
      -
      -
      $this->email->to('one@example.com, two@example.com, three@example.com');
-
      -
      -
      $this->email->to(
-        array('one@example.com', 'two@example.com', 'three@example.com')
-);
-
      -
      -
      - -
      -
      -cc($cc)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $cc (mixed) – Comma-delimited string or an array of e-mail addresses
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Sets the CC email address(s). Just like the “to”, can be a single e-mail, -a comma-delimited list or an array.

      -
      - -
      -
      -bcc($bcc[, $limit = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $bcc (mixed) – Comma-delimited string or an array of e-mail addresses
        • -
      • $limit (int) – Maximum number of e-mails to send per batch
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Sets the BCC email address(s). Just like the to() method, can be a single -e-mail, a comma-delimited list or an array.

      -

      If $limit is set, “batch mode” will be enabled, which will send -the emails to batches, with each batch not exceeding the specified -$limit.

      -
      - -
      -
      -subject($subject)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $subject (string) – E-mail subject line
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Sets the email subject:

      -
      $this->email->subject('This is my subject');
-
      -
      -
      - -
      -
      -message($body)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $body (string) – E-mail message body
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Sets the e-mail message body:

      -
      $this->email->message('This is my message');
-
      -
      -
      - -
      -
      -set_alt_message($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Alternative e-mail message body
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Sets the alternative e-mail message body:

      -
      $this->email->set_alt_message('This is the alternative message');
-
      -
      -

      This is an optional message string which can be used if you send -HTML formatted email. It lets you specify an alternative message -with no HTML formatting which is added to the header string for -people who do not accept HTML email. If you do not set your own -message CodeIgniter will extract the message from your HTML email -and strip the tags.

      -
      - -
      -
      -set_header($header, $value)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $header (string) – Header name
        • -
      • $value (string) – Header value
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Appends additional headers to the e-mail:

      -
      $this->email->set_header('Header1', 'Value1');
-$this->email->set_header('Header2', 'Value2');
-
      -
      -
      - -
      -
      -clear([$clear_attachments = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $clear_attachments (bool) – Whether or not to clear attachments
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Initializes all the email variables to an empty state. This method -is intended for use if you run the email sending method in a loop, -permitting the data to be reset between cycles.

      -
      foreach ($list as $name => $address)
-{
-        $this->email->clear();
-
-        $this->email->to($address);
-        $this->email->from('your@example.com');
-        $this->email->subject('Here is your info '.$name);
-        $this->email->message('Hi '.$name.' Here is the info you requested.');
-        $this->email->send();
-}
-
      -
      -

      If you set the parameter to TRUE any attachments will be cleared as -well:

      -
      $this->email->clear(TRUE);
-
      -
      -
      - -
      -
      -send([$auto_clear = TRUE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $auto_clear (bool) – Whether to clear message data automatically
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      The e-mail sending method. Returns boolean TRUE or FALSE based on -success or failure, enabling it to be used conditionally:

      -
      if ( ! $this->email->send())
-{
-        // Generate error
-}
-
      -
      -

      This method will automatically clear all parameters if the request was -successful. To stop this behaviour pass FALSE:

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

      Note

      -

      In order to use the print_debugger() method, you need -to avoid clearing the email parameters.

      -
      -
      - -
      -
      -attach($filename[, $disposition = ''[, $newname = NULL[, $mime = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $filename (string) – File name
        • -
      • $disposition (string) – ‘disposition’ of the attachment. Most -email clients make their own decision regardless of the MIME -specification used here. https://www.iana.org/assignments/cont-disp/cont-disp.xhtml
        • -
      • $newname (string) – Custom file name to use in the e-mail
        • -
      • $mime (string) – MIME type to use (useful for buffered data)
        • -
      -
      Returns:

      CI_Email instance (method chaining)

      -
      Return type:

      CI_Email

      -
      -

      Enables you to send an attachment. Put the file path/name in the first -parameter. For multiple attachments use the method multiple times. -For example:

      -
      $this->email->attach('/path/to/photo1.jpg');
-$this->email->attach('/path/to/photo2.jpg');
-$this->email->attach('/path/to/photo3.jpg');
-
      -
      -

      To use the default disposition (attachment), leave the second parameter blank, -otherwise use a custom disposition:

      -
      $this->email->attach('image.jpg', 'inline');
-
      -
      -

      You can also use a URL:

      -
      $this->email->attach('http://example.com/filename.pdf');
-
      -
      -

      If you’d like to use a custom file name, you can use the third paramater:

      -
      $this->email->attach('filename.pdf', 'attachment', 'report.pdf');
-
      -
      -

      If you need to use a buffer string instead of a real - physical - file you can -use the first parameter as buffer, the third parameter as file name and the fourth -parameter as mime-type:

      -
      $this->email->attach($buffer, 'attachment', 'report.pdf', 'application/pdf');
-
      -
      -
      - -
      -
      -attachment_cid($filename)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $filename (string) – Existing attachment filename
        • -
      -
      Returns:

      Attachment Content-ID or FALSE if not found

      -
      Return type:

      string

      -
      -

      Sets and returns an attachment’s Content-ID, which enables your to embed an inline -(picture) attachment into HTML. First parameter must be the already attached file name.

      -
      $filename = '/img/photo1.jpg';
-$this->email->attach($filename);
-foreach ($list as $address)
-{
-        $this->email->to($address);
-        $cid = $this->email->attachment_cid($filename);
-        $this->email->message('<img src='cid:". $cid ."' alt="photo1" />');
-        $this->email->send();
-}
-
      -
      -
      -

      Note

      -

      Content-ID for each e-mail must be re-created for it to be unique.

      -
      -
      - -
      -
      -print_debugger([$include = array('headers', 'subject', 'body')])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $include (array) – Which parts of the message to print out
        • -
      -
      Returns:

      Formatted debug data

      -
      Return type:

      string

      -
      -

      Returns a string containing any server messages, the email headers, and -the email messsage. Useful for debugging.

      -

      You can optionally specify which parts of the message should be printed. -Valid options are: headers, subject, body.

      -

      Example:

      -
      // You need to pass FALSE while sending in order for the email data
-// to not be cleared - if that happens, print_debugger() would have
-// nothing to output.
-$this->email->send(FALSE);
-
-// Will only print the email headers, excluding the message subject and body
-$this->email->print_debugger(array('headers'));
-
      -
      -
      -

      Note

      -

      By default, all of the raw data will be printed.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/encrypt.html b/user_guide/libraries/encrypt.html deleted file mode 100755 index 0aa3323..0000000 --- a/user_guide/libraries/encrypt.html +++ /dev/null @@ -1,788 +0,0 @@ - - - - - - - - - - Encrypt Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Encrypt Class

      -

      The Encrypt Class provides two-way data encryption. It encrypted using -the Mcrypt PHP extension, which is required for the Encrypt Class to run.

      -
      -

      Important

      -

      This library has been DEPRECATED and is only kept for -backwards compatibility. Please use the new Encryption Library.

      -
      - -
      -

      Using the Encrypt Library

      -
      -

      Setting your Key

      -

      A key is a piece of information that controls the cryptographic -process and permits an encrypted string to be decoded. In fact, the key -you chose will provide the only means to decode data that was -encrypted with that key, so not only must you choose the key carefully, -you must never change it if you intend use it for persistent data.

      -

      It goes without saying that you should guard your key carefully. Should -someone gain access to your key, the data will be easily decoded. If -your server is not totally under your control it’s impossible to ensure -key security so you may want to think carefully before using it for -anything that requires high security, like storing credit card numbers.

      -

      To take maximum advantage of the encryption algorithm, your key should -be 32 characters in length (256 bits). The key should be as random a -string as you can concoct, with numbers and uppercase and lowercase -letters. Your key should not be a simple text string. In order to be -cryptographically secure it needs to be as random as possible.

      -

      Your key can be either stored in your application/config/config.php, or -you can design your own storage mechanism and pass the key dynamically -when encoding/decoding.

      -

      To save your key to your application/config/config.php, open the file -and set:

      -
      $config['encryption_key'] = "YOUR KEY";
-
      -
      -
      -
      -

      Message Length

      -

      It’s important for you to know that the encoded messages the encryption -function generates will be approximately 2.6 times longer than the -original message. For example, if you encrypt the string “my super -secret data”, which is 21 characters in length, you’ll end up with an -encoded string that is roughly 55 characters (we say “roughly” because -the encoded string length increments in 64 bit clusters, so it’s not -exactly linear). Keep this information in mind when selecting your data -storage mechanism. Cookies, for example, can only hold 4K of -information.

      -
      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the Encrypt class is -initialized in your controller using the $this->load->library() -method:

      -
      $this->load->library('encrypt');
-
      -
      -

      Once loaded, the Encrypt library object will be available using:

      -
      $this->encrypt
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Encrypt
      -
      -
      -encode($string[, $key = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $string (string) – Data to encrypt
        • -
      • $key (string) – Encryption key
        • -
      -
      Returns:

      Encrypted string

      -
      Return type:

      string

      -
      -

      Performs the data encryption and returns it as a string. Example:

      -
      $msg = 'My secret message';
-
-$encrypted_string = $this->encrypt->encode($msg);
-
      -
      -

      You can optionally pass your encryption key via the second parameter if -you don’t want to use the one in your config file:

      -
      $msg = 'My secret message';
-$key = 'super-secret-key';
-
-$encrypted_string = $this->encrypt->encode($msg, $key);
-
      -
      -
      - -
      -
      -decode($string[, $key = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $string (string) – String to decrypt
        • -
      • $key (string) – Encryption key
        • -
      -
      Returns:

      Plain-text string

      -
      Return type:

      string

      -
      -

      Decrypts an encoded string. Example:

      -
      $encrypted_string = 'APANtByIGI1BpVXZTJgcsAG8GZl8pdwwa84';
-
-$plaintext_string = $this->encrypt->decode($encrypted_string);
-
      -
      -

      You can optionally pass your encryption key via the second parameter if -you don’t want to use the one in your config file:

      -
      $msg = 'My secret message';
-$key = 'super-secret-key';
-
-$encrypted_string = $this->encrypt->decode($msg, $key);
-
      -
      -
      - -
      -
      -set_cipher($cipher)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $cipher (int) – Valid PHP MCrypt cypher constant
        • -
      -
      Returns:

      CI_Encrypt instance (method chaining)

      -
      Return type:

      CI_Encrypt

      -
      -

      Permits you to set an Mcrypt cipher. By default it uses -MCRYPT_RIJNDAEL_256. Example:

      -
      $this->encrypt->set_cipher(MCRYPT_BLOWFISH);
-
      -
      -

      Please visit php.net for a list of available ciphers.

      -

      If you’d like to manually test whether your server supports MCrypt you -can use:

      -
      echo extension_loaded('mcrypt') ? 'Yup' : 'Nope';
-
      -
      -
      - -
      -
      -set_mode($mode)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $mode (int) – Valid PHP MCrypt mode constant
        • -
      -
      Returns:

      CI_Encrypt instance (method chaining)

      -
      Return type:

      CI_Encrypt

      -
      -

      Permits you to set an Mcrypt mode. By default it uses MCRYPT_MODE_CBC. -Example:

      -
      $this->encrypt->set_mode(MCRYPT_MODE_CFB);
-
      -
      -

      Please visit php.net for a list of available modes.

      -
      - -
      -
      -encode_from_legacy($string[, $legacy_mode = MCRYPT_MODE_ECB[, $key = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $string (string) – String to encrypt
        • -
      • $legacy_mode (int) – Valid PHP MCrypt cipher constant
        • -
      • $key (string) – Encryption key
        • -
      -
      Returns:

      Newly encrypted string

      -
      Return type:

      string

      -
      -

      Enables you to re-encode data that was originally encrypted with -CodeIgniter 1.x to be compatible with the Encrypt library in -CodeIgniter 2.x. It is only necessary to use this method if you have -encrypted data stored permanently such as in a file or database and are -on a server that supports Mcrypt. “Light” use encryption such as -encrypted session data or transitory encrypted flashdata require no -intervention on your part. However, existing encrypted Sessions will be -destroyed since data encrypted prior to 2.x will not be decoded.

      -
      -

      Important

      -

      Why only a method to re-encode the data instead of maintaining legacy -methods for both encoding and decoding? The algorithms in the -Encrypt library have improved in CodeIgniter 2.x both for performance -and security, and we do not wish to encourage continued use of the older -methods. You can of course extend the Encryption library if you wish and -replace the new methods with the old and retain seamless compatibility -with CodeIgniter 1.x encrypted data, but this a decision that a -developer should make cautiously and deliberately, if at all.

      -
      -
      $new_data = $this->encrypt->encode_from_legacy($old_encrypted_string);
-
      -
      - ----- - - - - - - - - - - - - - - - - - - - - -
      ParameterDefaultDescription
      $orig_datan/aThe original encrypted data from CodeIgniter 1.x’s Encryption library
      $legacy_modeMCRYPT_MODE_ECBThe Mcrypt mode that was used to generate the original encrypted data. -CodeIgniter 1.x’s default was MCRYPT_MODE_ECB, and it will assume that -to be the case unless overridden by this parameter.
      $keyn/aThe encryption key. This it typically specified in your config file as -outlined above.
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/encryption.html b/user_guide/libraries/encryption.html deleted file mode 100755 index 6d115fe..0000000 --- a/user_guide/libraries/encryption.html +++ /dev/null @@ -1,1406 +0,0 @@ - - - - - - - - - - Encryption Library — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries »
        • - -
      • Encryption Library
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Encryption Library

      -
      -

      Important

      -

      DO NOT use this or any other encryption library for -user password storage! Passwords must be hashed instead, and you -should do that via PHP’s own Password Hashing extension.

      -
      -

      The Encryption Library provides two-way data encryption. To do so in -a cryptographically secure way, it utilizes PHP extensions that are -unfortunately not always available on all systems. -You must meet one of the following dependencies in order to use this -library:

      -
        -
      • OpenSSL (and PHP 5.3.3)
        • -
      • MCrypt (and MCRYPT_DEV_URANDOM availability)
        • -
      -

      If neither of the above dependencies is met, we simply cannot offer -you a good enough implementation to meet the high standards required -for proper cryptography.

      - -
      -

      Using the Encryption Library

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the Encryption library is -initialized in your controller using the $this->load->library() -method:

      -
      $this->load->library('encryption');
-
      -
      -

      Once loaded, the Encryption library object will be available using:

      -
      $this->encryption
-
      -
      -
      -
      -

      Default behavior

      -

      By default, the Encryption Library will use the AES-128 cipher in CBC -mode, using your configured encryption_key and SHA512 HMAC authentication.

      -
      -

      Note

      -

      AES-128 is chosen both because it is proven to be strong and -because of its wide availability across different cryptographic -software and programming languages’ APIs.

      -
      -

      However, the encryption_key is not used as is.

      -

      If you are somewhat familiar with cryptography, you should already know -that a HMAC also requires a secret key and using the same key for both -encryption and authentication is a bad practice.

      -

      Because of that, two separate keys are derived from your already configured -encryption_key: one for encryption and one for authentication. This is -done via a technique called HMAC-based Key Derivation Function (HKDF).

      -
      -
      -

      Setting your encryption_key

      -

      An encryption key is a piece of information that controls the -cryptographic process and permits a plain-text string to be encrypted, -and afterwards - decrypted. It is the secret “ingredient” in the whole -process that allows you to be the only one who is able to decrypt data -that you’ve decided to hide from the eyes of the public. -After one key is used to encrypt data, that same key provides the only -means to decrypt it, so not only must you chose one carefully, but you -must not lose it or you will also lose access to the data.

      -

      It must be noted that to ensure maximum security, such key should not -only be as strong as possible, but also often changed. Such behavior -however is rarely practical or possible to implement, and that is why -CodeIgniter gives you the ability to configure a single key that is to be -used (almost) every time.

      -

      It goes without saying that you should guard your key carefully. Should -someone gain access to your key, the data will be easily decrypted. If -your server is not totally under your control it’s impossible to ensure -key security so you may want to think carefully before using it for -anything that requires high security, like storing credit card numbers.

      -

      Your encryption key must be as long as the encyption algorithm in use -allows. For AES-128, that’s 128 bits or 16 bytes (charcters) long. -You will find a table below that shows the supported key lengths of -different ciphers.

      -

      The key should be as random as possible and it must not be a regular -text string, nor the output of a hashing function, etc. In order to create -a proper key, you must use the Encryption library’s create_key() method

      -
      // $key will be assigned a 16-byte (128-bit) random key
-$key = $this->encryption->create_key(16);
-
      -
      -

      The key can be either stored in your application/config/config.php, or -you can design your own storage mechanism and pass the key dynamically -when encrypting/decrypting.

      -

      To save your key to your application/config/config.php, open the file -and set:

      -
      $config['encryption_key'] = 'YOUR KEY';
-
      -
      -

      You’ll notice that the create_key() method outputs binary data, which -is hard to deal with (i.e. a copy-paste may damage it), so you may use -bin2hex(), hex2bin() or Base64-encoding to work with the key in -a more friendly manner. For example:

      -
      // Get a hex-encoded representation of the key:
-$key = bin2hex($this->encryption->create_key(16));
-
-// Put the same value in your config with hex2bin(),
-// so that it is still passed as binary to the library:
-$config['encryption_key'] = hex2bin(<your hex-encoded key>);
-
      -
      -
      -
      -

      Supported encryption ciphers and modes

      -
      -

      Note

      -

      The terms ‘cipher’ and ‘encryption algorithm’ are interchangeable.

      -
      -
      -

      Portable ciphers

      -

      Because MCrypt and OpenSSL (also called drivers throughout this document) -each support different sets of encryption algorithms and often implement -them in different ways, our Encryption library is designed to use them in -a portable fashion, or in other words - it enables you to use them -interchangeably, at least for the ciphers supported by both drivers.

      -

      It is also implemented in a way that aims to match the standard -implementations in other programming languages and libraries.

      -

      Here’s a list of the so called “portable” ciphers, where -“CodeIgniter name” is the string value that you’d have to pass to the -Encryption library to use that cipher:

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Cipher nameCodeIgniter nameKey lengths (bits / bytes)Supported modes
      AES-128 / Rijndael-128aes-128128 / 16CBC, CTR, CFB, CFB8, OFB, ECB
      AES-192aes-192192 / 24CBC, CTR, CFB, CFB8, OFB, ECB
      AES-256aes-256256 / 32CBC, CTR, CFB, CFB8, OFB, ECB
      DESdes56 / 7CBC, CFB, CFB8, OFB, ECB
      TripleDEStripledes56 / 7, 112 / 14, 168 / 21CBC, CFB, CFB8, OFB
      Blowfishblowfish128-448 / 16-56CBC, CFB, OFB, ECB
      CAST5 / CAST-128cast588-128 / 11-16CBC, CFB, OFB, ECB
      RC4 / ARCFourrc440-2048 / 5-256Stream
      -
      -

      Important

      -

      Because of how MCrypt works, if you fail to provide a key -with the appropriate length, you might end up using a different -algorithm than the one configured, so be really careful with that!

      -
      -
      -

      Note

      -

      In case it isn’t clear from the above table, Blowfish, CAST5 -and RC4 support variable length keys. That is, any number in the -shown ranges is valid, although in bit terms that only happens -in 8-bit increments.

      -
      -
      -

      Note

      -

      Even though CAST5 supports key lengths lower than 128 bits -(16 bytes), in fact they will just be zero-padded to the -maximum length, as specified in RFC 2144.

      -
      -
      -

      Note

      -

      Blowfish supports key lengths as small as 32 bits (4 bytes), but -our tests have shown that only lengths of 128 bits (16 bytes) or -higher are properly supported by both MCrypt and OpenSSL. It is -also a bad practice to use such low-length keys anyway.

      -
      -
      -
      -

      Driver-specific ciphers

      -

      As noted above, MCrypt and OpenSSL support different sets of encryption -ciphers. For portability reasons and because we haven’t tested them -properly, we do not advise you to use the ones that are driver-specific, -but regardless, here’s a list of most of them:

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Cipher nameDriverKey lengths (bits / bytes)Supported modes
      AES-128OpenSSL128 / 16CBC, CTR, CFB, CFB8, OFB, ECB, XTS
      AES-192OpenSSL192 / 24CBC, CTR, CFB, CFB8, OFB, ECB, XTS
      AES-256OpenSSL256 / 32CBC, CTR, CFB, CFB8, OFB, ECB, XTS
      Rijndael-128MCrypt128 / 16, 192 / 24, 256 / 32CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      Rijndael-192MCrypt128 / 16, 192 / 24, 256 / 32CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      Rijndael-256MCrypt128 / 16, 192 / 24, 256 / 32CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      GOSTMCrypt256 / 32CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      TwofishMCrypt128 / 16, 192 / 24, 256 / 32CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      CAST-128MCrypt40-128 / 5-16CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      CAST-256MCrypt128 / 16, 192 / 24, 256 / 32CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      Loki97MCrypt128 / 16, 192 / 24, 256 / 32CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      SaferPlusMCrypt128 / 16, 192 / 24, 256 / 32CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      SerpentMCrypt128 / 16, 192 / 24, 256 / 32CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      XTEAMCrypt128 / 16CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      RC2MCrypt8-1024 / 1-128CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
      RC2OpenSSL8-1024 / 1-128CBC, CFB, OFB, ECB
      Camellia-128OpenSSL128 / 16CBC, CFB, CFB8, OFB, ECB
      Camellia-192OpenSSL192 / 24CBC, CFB, CFB8, OFB, ECB
      Camellia-256OpenSSL256 / 32CBC, CFB, CFB8, OFB, ECB
      SeedOpenSSL128 / 16CBC, CFB, OFB, ECB
      -
      -

      Note

      -

      If you wish to use one of those ciphers, you’d have to pass -its name in lower-case to the Encryption library.

      -
      -
      -

      Note

      -

      You’ve probably noticed that all AES cipers (and Rijndael-128) -are also listed in the portable ciphers list. This is because -drivers support different modes for these ciphers. Also, it is -important to note that AES-128 and Rijndael-128 are actually -the same cipher, but only when used with a 128-bit key.

      -
      -
      -

      Note

      -

      CAST-128 / CAST-5 is also listed in both the portable and -driver-specific ciphers list. This is because OpenSSL’s -implementation doesn’t appear to be working correctly with -key sizes of 80 bits and lower.

      -
      -
      -

      Note

      -

      RC2 is listed as supported by both MCrypt and OpenSSL. -However, both drivers implement them differently and they -are not portable. It is probably worth noting that we only -found one obscure source confirming that it is MCrypt that -is not properly implementing it.

      -
      -
      -
      -

      Encryption modes

      -

      Different modes of encryption have different characteristics and serve -for different purposes. Some are stronger than others, some are faster -and some offer extra features. -We are not going in depth into that here, we’ll leave that to the -cryptography experts. The table below is to provide brief informational -reference to our more experienced users. If you are a beginner, just -stick to the CBC mode - it is widely accepted as strong and secure for -general purposes.

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Mode nameCodeIgniter nameDriver supportAdditional info
      CBCcbcMCrypt, OpenSSLA safe default choice
      CTRctrMCrypt, OpenSSLConsidered as theoretically better than CBC, but not as widely available
      CFBcfbMCrypt, OpenSSLN/A
      CFB8cfb8MCrypt, OpenSSLSame as CFB, but operates in 8-bit mode (not recommended).
      OFBofbMCrypt, OpenSSLN/A
      OFB8ofb8MCryptSame as OFB, but operates in 8-bit mode (not recommended).
      ECBecbMCrypt, OpenSSLIgnores IV (not recommended).
      XTSxtsOpenSSLUsually used for encrypting random access data such as RAM or hard-disk storage.
      StreamstreamMCrypt, OpenSSLThis is not actually a mode, it just says that a stream cipher is being used. Required because of the general cipher+mode initialization process.
      -
      -
      -
      -

      Message Length

      -

      It’s probably important for you to know that an encrypted string is usually -longer than the original, plain-text string (depending on the cipher).

      -

      This is influenced by the cipher algorithm itself, the IV prepended to the -cipher-text and the HMAC authentication message that is also prepended. -Furthermore, the encrypted message is also Base64-encoded so that it is safe -for storage and transmission, regardless of a possible character set in use.

      -

      Keep this information in mind when selecting your data storage mechanism. -Cookies, for example, can only hold 4K of information.

      -
      -
      -

      Configuring the library

      -

      For usability, performance, but also historical reasons tied to our old -Encrypt Class, the Encryption library is designed to -use repeatedly the same driver, encryption cipher, mode and key.

      -

      As noted in the “Default behavior” section above, this means using an -auto-detected driver (OpenSSL has a higher priority), the AES-128 ciper -in CBC mode, and your $config['encryption_key'] value.

      -

      If you wish to change that however, you need to use the initialize() -method. It accepts an associative array of parameters, all of which are -optional:

      - ---- - - - - - - - - - - - - - - - - - - - -
      OptionPossible values
      driver‘mcrypt’, ‘openssl’
      cipherCipher name (see Supported encryption ciphers and modes)
      modeEncryption mode (see Encryption modes)
      keyEncryption key
      -

      For example, if you were to change the encryption algorithm and -mode to AES-256 in CTR mode, this is what you should do:

      -
      $this->encryption->initialize(
-        array(
-                'cipher' => 'aes-256',
-                'mode' => 'ctr',
-                'key' => '<a 32-character random string>'
-        )
-);
-
      -
      -

      Note that we only mentioned that you want to change the ciper and mode, -but we also included a key in the example. As previously noted, it is -important that you choose a key with a proper size for the used algorithm.

      -

      There’s also the ability to change the driver, if for some reason you -have both, but want to use MCrypt instead of OpenSSL:

      -
      // Switch to the MCrypt driver
-$this->encryption->initialize(array('driver' => 'mcrypt'));
-
-// Switch back to the OpenSSL driver
-$this->encryption->initialize(array('driver' => 'openssl'));
-
      -
      -
      -
      -

      Encrypting and decrypting data

      -

      Encrypting and decrypting data with the already configured library -settings is simple. As simple as just passing the string to the -encrypt() and/or decrypt() methods:

      -
      $plain_text = 'This is a plain-text message!';
-$ciphertext = $this->encryption->encrypt($plain_text);
-
-// Outputs: This is a plain-text message!
-echo $this->encryption->decrypt($ciphertext);
-
      -
      -

      And that’s it! The Encryption library will do everything necessary -for the whole process to be cryptographically secure out-of-the-box. -You don’t need to worry about it.

      -
      -

      Important

      -

      Both methods will return FALSE in case of an error. -While for encrypt() this can only mean incorrect -configuration, you should always check the return value -of decrypt() in production code.

      -
      -
      -

      How it works

      -

      If you must know how the process works, here’s what happens under -the hood:

      -
        -
      • $this->encryption->encrypt($plain_text)
          -
        1. Derive an encryption key and a HMAC key from your configured -encryption_key via HKDF, using the SHA-512 digest algorithm.
          2. -
        2. Generate a random initialization vector (IV).
          3. -
        3. Encrypt the data via AES-128 in CBC mode (or another previously -configured cipher and mode), using the above-mentioned derived -encryption key and IV.
          4. -
        4. Prepend said IV to the resulting cipher-text.
          5. -
        5. Base64-encode the resulting string, so that it can be safely -stored or transferred without worrying about character sets.
          6. -
        6. Create a SHA-512 HMAC authentication message using the derived -HMAC key to ensure data integrity and prepend it to the Base64 -string.
          7. -
        -
        • -
      • $this->encryption->decrypt($ciphertext)
          -
        1. Derive an encryption key and a HMAC key from your configured -encryption_key via HKDF, using the SHA-512 digest algorithm. -Because your configured encryption_key is the same, this -will produce the same result as in the encrypt() method -above - otherwise you won’t be able to decrypt it.
          2. -
        2. Check if the string is long enough, separate the HMAC out of -it and validate if it is correct (this is done in a way that -prevents timing attacks agains it). Return FALSE if either of -the checks fails.
          3. -
        3. Base64-decode the string.
          4. -
        4. Separate the IV out of the cipher-text and decrypt the said -cipher-text using that IV and the derived encryption key.
          5. -
        -
        • -
      -
      -
      -

      Using custom parameters

      -

      Let’s say you have to interact with another system that is out -of your control and uses another method to encrypt data. A -method that will most certainly not match the above-described -sequence and probably not use all of the steps either.

      -

      The Encryption library allows you to change how its encryption -and decryption processes work, so that you can easily tailor a -custom solution for such situations.

      -
      -

      Note

      -

      It is possible to use the library in this way, without -setting an encryption_key in your configuration file.

      -
      -

      All you have to do is to pass an associative array with a few -parameters to either the encrypt() or decrypt() method. -Here’s an example:

      -
      // Assume that we have $ciphertext, $key and $hmac_key
-// from on outside source
-
-$message = $this->encryption->decrypt(
-        $ciphertext,
-        array(
-                'cipher' => 'blowfish',
-                'mode' => 'cbc',
-                'key' => $key,
-                'hmac_digest' => 'sha256',
-                'hmac_key' => $hmac_key
-        )
-);
-
      -
      -

      In the above example, we are decrypting a message that was encrypted -using the Blowfish cipher in CBC mode and authenticated via a SHA-256 -HMAC.

      -
      -

      Important

      -

      Note that both ‘key’ and ‘hmac_key’ are used in this -example. When using custom parameters, encryption and HMAC keys -are not derived like the default behavior of the library is.

      -
      -

      Below is a list of the available options.

      -

      However, unless you really need to and you know what you are doing, -we advise you to not change the encryption process as this could -impact security, so please do so with caution.

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      OptionDefault valueMandatory / OptionalDescription
      cipherN/AYesEncryption algorithm (see Supported encryption ciphers and modes).
      modeN/AYesEncryption mode (see Encryption modes).
      keyN/AYesEncryption key.
      hmacTRUENoWhether to use a HMAC. -Boolean. If set to FALSE, then hmac_digest and -hmac_key will be ignored.
      hmac_digestsha512NoHMAC message digest algorithm (see Supported HMAC authentication algorithms).
      hmac_keyN/AYes, unless hmac is FALSEHMAC key.
      raw_dataFALSENoWhether the cipher-text should be raw. -Boolean. If set to TRUE, then Base64 encoding and -decoding will not be performed and HMAC will not -be a hexadecimal string.
      -
      -

      Important

      -

      encrypt() and decrypt() will return FALSE if -a mandatory parameter is not provided or if a provided -value is incorrect. This includes hmac_key, unless hmac -is set to FALSE.

      -
      -
      -
      -

      Supported HMAC authentication algorithms

      -

      For HMAC message authentication, the Encryption library supports -usage of the SHA-2 family of algorithms:

      - ----- - - - - - - - - - - - - - - - - - - - - - - - - -
      AlgorithmRaw length (bytes)Hex-encoded length (bytes)
      sha51264128
      sha3844896
      sha2563264
      sha2242856
      -

      The reason for not including other popular algorithms, such as -MD5 or SHA1 is that they are no longer considered secure enough -and as such, we don’t want to encourage their usage. -If you absolutely need to use them, it is easy to do so via PHP’s -native hash_hmac() function.

      -

      Stronger algorithms of course will be added in the future as they -appear and become widely available.

      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Encryption
      -
      -
      -initialize($params)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $params (array) – Configuration parameters
        • -
      -
      Returns:

      CI_Encryption instance (method chaining)

      -
      Return type:

      CI_Encryption

      -
      -

      Initializes (configures) the library to use a different -driver, cipher, mode or key.

      -

      Example:

      -
      $this->encryption->initialize(
-        array('mode' => 'ctr')
-);
-
      -
      -

      Please refer to the Configuring the library section for detailed info.

      -
      - -
      -
      -encrypt($data[, $params = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (string) – Data to encrypt
        • -
      • $params (array) – Optional parameters
        • -
      -
      Returns:

      Encrypted data or FALSE on failure

      -
      Return type:

      string

      -
      -

      Encrypts the input data and returns its ciphertext.

      -

      Example:

      -
      $ciphertext = $this->encryption->encrypt('My secret message');
-
      -
      -

      Please refer to the Using custom parameters section for information -on the optional parameters.

      -
      - -
      -
      -decrypt($data[, $params = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (string) – Data to decrypt
        • -
      • $params (array) – Optional parameters
        • -
      -
      Returns:

      Decrypted data or FALSE on failure

      -
      Return type:

      string

      -
      -

      Decrypts the input data and returns it in plain-text.

      -

      Example:

      -
      echo $this->encryption->decrypt($ciphertext);
-
      -
      -

      Please refer to the Using custom parameters secrion for information -on the optional parameters.

      -
      - -
      -
      -create_key($length)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $length (int) – Output length
        • -
      -
      Returns:

      A pseudo-random cryptographic key with the specified length, or FALSE on failure

      -
      Return type:

      string

      -
      -

      Creates a cryptographic key by fetching random data from -the operating system’s sources (i.e. /dev/urandom).

      -
      - -
      -
      -hkdf($key[, $digest = 'sha512'[, $salt = NULL[, $length = NULL[, $info = '']]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Input key material
        • -
      • $digest (string) – A SHA-2 family digest algorithm
        • -
      • $salt (string) – Optional salt
        • -
      • $length (int) – Optional output length
        • -
      • $info (string) – Optional context/application-specific info
        • -
      -
      Returns:

      A pseudo-random key or FALSE on failure

      -
      Return type:

      string

      -
      -

      Derives a key from another, presumably weaker key.

      -

      This method is used internally to derive an encryption and HMAC key -from your configured encryption_key.

      -

      It is publicly available due to its otherwise general purpose. It is -described in RFC 5869.

      -

      However, as opposed to the description in RFC 5869, this implementation -doesn’t support SHA1.

      -

      Example:

      -
      $hmac_key = $this->encryption->hkdf(
-        $key,
-        'sha512',
-        NULL,
-        NULL,
-        'authentication'
-);
-
-// $hmac_key is a pseudo-random key with a length of 64 bytes
-
      -
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/file_uploading.html b/user_guide/libraries/file_uploading.html deleted file mode 100755 index dbdef6e..0000000 --- a/user_guide/libraries/file_uploading.html +++ /dev/null @@ -1,1026 +0,0 @@ - - - - - - - - - - File Uploading Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries »
        • - -
      • File Uploading Class
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      File Uploading Class

      -

      CodeIgniter’s File Uploading Class permits files to be uploaded. You can -set various preferences, restricting the type and size of the files.

      - -
      -

      The Process

      -

      Uploading a file involves the following general process:

      -
        -
      • An upload form is displayed, allowing a user to select a file and -upload it.
        • -
      • When the form is submitted, the file is uploaded to the destination -you specify.
        • -
      • Along the way, the file is validated to make sure it is allowed to be -uploaded based on the preferences you set.
        • -
      • Once uploaded, the user will be shown a success message.
        • -
      -

      To demonstrate this process here is brief tutorial. Afterward you’ll -find reference information.

      -
      -

      Creating the Upload Form

      -

      Using a text editor, create a form called upload_form.php. In it, place -this code and save it to your application/views/ directory:

      -
      <html>
-<head>
-<title>Upload Form</title>
-</head>
-<body>
-
-<?php echo $error;?>
-
-<?php echo form_open_multipart('upload/do_upload');?>
-
-<input type="file" name="userfile" size="20" />
-
-<br /><br />
-
-<input type="submit" value="upload" />
-
-</form>
-
-</body>
-</html>
-
      -
      -

      You’ll notice we are using a form helper to create the opening form tag. -File uploads require a multipart form, so the helper creates the proper -syntax for you. You’ll also notice we have an $error variable. This is -so we can show error messages in the event the user does something -wrong.

      -
      -
      -

      The Success Page

      -

      Using a text editor, create a form called upload_success.php. In it, -place this code and save it to your application/views/ directory:

      -
      <html>
-<head>
-<title>Upload Form</title>
-</head>
-<body>
-
-<h3>Your file was successfully uploaded!</h3>
-
-<ul>
-<?php foreach ($upload_data as $item => $value):?>
-<li><?php echo $item;?>: <?php echo $value;?></li>
-<?php endforeach; ?>
-</ul>
-
-<p><?php echo anchor('upload', 'Upload Another File!'); ?></p>
-
-</body>
-</html>
-
      -
      -
      -
      -

      The Controller

      -

      Using a text editor, create a controller called Upload.php. In it, place -this code and save it to your application/controllers/ directory:

      -
      <?php
-
-class Upload extends CI_Controller {
-
-        public function __construct()
-        {
-                parent::__construct();
-                $this->load->helper(array('form', 'url'));
-        }
-
-        public function index()
-        {
-                $this->load->view('upload_form', array('error' => ' ' ));
-        }
-
-        public function do_upload()
-        {
-                $config['upload_path']          = './uploads/';
-                $config['allowed_types']        = 'gif|jpg|png';
-                $config['max_size']             = 100;
-                $config['max_width']            = 1024;
-                $config['max_height']           = 768;
-
-                $this->load->library('upload', $config);
-
-                if ( ! $this->upload->do_upload('userfile'))
-                {
-                        $error = array('error' => $this->upload->display_errors());
-
-                        $this->load->view('upload_form', $error);
-                }
-                else
-                {
-                        $data = array('upload_data' => $this->upload->data());
-
-                        $this->load->view('upload_success', $data);
-                }
-        }
-}
-?>
-
      -
      -
      -
      -

      The Upload Directory

      -

      You’ll need a destination directory for your uploaded images. Create a -directory at the root of your CodeIgniter installation called uploads -and set its file permissions to 777.

      -
      -
      -

      Try it!

      -

      To try your form, visit your site using a URL similar to this one:

      -
      example.com/index.php/upload/
-
      -
      -

      You should see an upload form. Try uploading an image file (either a -jpg, gif, or png). If the path in your controller is correct it should -work.

      -
      -
      -
      -

      Reference Guide

      -
      -

      Initializing the Upload Class

      -

      Like most other classes in CodeIgniter, the Upload class is initialized -in your controller using the $this->load->library() method:

      -
      $this->load->library('upload');
-
      -
      -

      Once the Upload class is loaded, the object will be available using: -$this->upload

      -
      -
      -

      Setting Preferences

      -

      Similar to other libraries, you’ll control what is allowed to be upload -based on your preferences. In the controller you built above you set the -following preferences:

      -
      $config['upload_path'] = './uploads/';
-$config['allowed_types'] = 'gif|jpg|png';
-$config['max_size']     = '100';
-$config['max_width'] = '1024';
-$config['max_height'] = '768';
-
-$this->load->library('upload', $config);
-
-// Alternately you can set preferences by calling the ``initialize()`` method. Useful if you auto-load the class:
-$this->upload->initialize($config);
-
      -
      -

      The above preferences should be fairly self-explanatory. Below is a -table describing all available preferences.

      -
      -
      -

      Preferences

      -

      The following preferences are available. The default value indicates -what will be used if you do not specify that preference.

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefault ValueOptionsDescription
      upload_pathNoneNoneThe path to the directory where the upload should be placed. The -directory must be writable and the path can be absolute or relative.
      allowed_typesNoneNoneThe mime types corresponding to the types of files you allow to be -uploaded. Usually the file extension can be used as the mime type. -Can be either an array or a pipe-separated string.
      file_nameNoneDesired file nameIf set CodeIgniter will rename the uploaded file to this name. The -extension provided in the file name must also be an allowed file type. -If no extension is provided in the original file_name will be used.
      file_ext_tolowerFALSETRUE/FALSE (boolean)If set to TRUE, the file extension will be forced to lower case
      overwriteFALSETRUE/FALSE (boolean)If set to true, if a file with the same name as the one you are -uploading exists, it will be overwritten. If set to false, a number will -be appended to the filename if another with the same name exists.
      max_size0NoneThe maximum size (in kilobytes) that the file can be. Set to zero for no -limit. Note: Most PHP installations have their own limit, as specified -in the php.ini file. Usually 2 MB (or 2048 KB) by default.
      max_width0NoneThe maximum width (in pixels) that the image can be. Set to zero for no -limit.
      max_height0NoneThe maximum height (in pixels) that the image can be. Set to zero for no -limit.
      min_width0NoneThe minimum width (in pixels) that the image can be. Set to zero for no -limit.
      min_height0NoneThe minimum height (in pixels) that the image can be. Set to zero for no -limit.
      max_filename0NoneThe maximum length that a file name can be. Set to zero for no limit.
      max_filename_increment100NoneWhen overwrite is set to FALSE, use this to set the maximum filename -increment for CodeIgniter to append to the filename.
      encrypt_nameFALSETRUE/FALSE (boolean)If set to TRUE the file name will be converted to a random encrypted -string. This can be useful if you would like the file saved with a name -that can not be discerned by the person uploading it.
      remove_spacesTRUETRUE/FALSE (boolean)If set to TRUE, any spaces in the file name will be converted to -underscores. This is recommended.
      detect_mimeTRUETRUE/FALSE (boolean)If set to TRUE, a server side detection of the file type will be -performed to avoid code injection attacks. DO NOT disable this option -unless you have no other option as that would cause a security risk.
      mod_mime_fixTRUETRUE/FALSE (boolean)If set to TRUE, multiple filename extensions will be suffixed with an -underscore in order to avoid triggering Apache mod_mime. -DO NOT turn off this option if your upload directory is public, as this -is a security risk.
      -
      -
      -

      Setting preferences in a config file

      -

      If you prefer not to set preferences using the above method, you can -instead put them into a config file. Simply create a new file called the -upload.php, add the $config array in that file. Then save the file in: -config/upload.php and it will be used automatically. You will NOT -need to use the $this->upload->initialize() method if you save your -preferences in a config file.

      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Upload
      -
      -
      -initialize([array $config = array()[, $reset = TRUE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $config (array) – Preferences
        • -
      • $reset (bool) – Whether to reset preferences (that are not provided in $config) to their defaults
        • -
      -
      Returns:

      CI_Upload instance (method chaining)

      -
      Return type:

      CI_Upload

      -
      -
      - -
      -
      -do_upload([$field = 'userfile'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Name of the form field
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Performs the upload based on the preferences you’ve set.

      -
      -

      Note

      -

      By default the upload routine expects the file to come from -a form field called userfile, and the form must be of type -“multipart”.

      -
      -
      <form method="post" action="some_action" enctype="multipart/form-data" />
-
      -
      -

      If you would like to set your own field name simply pass its value to -the do_upload() method:

      -
      $field_name = "some_field_name";
-$this->upload->do_upload($field_name);
-
      -
      -
      - -
      -
      -display_errors([$open = '<p>'[, $close = '</p>']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $open (string) – Opening markup
        • -
      • $close (string) – Closing markup
        • -
      -
      Returns:

      Formatted error message(s)

      -
      Return type:

      string

      -
      -

      Retrieves any error messages if the do_upload() method returned -false. The method does not echo automatically, it returns the data so -you can assign it however you need.

      -

      Formatting Errors

      -
      -

      By default the above method wraps any errors within <p> tags. You can -set your own delimiters like this:

      -
      $this->upload->display_errors('<p>', '</p>');
-
      -
      -
      -
      - -
      -
      -data([$index = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (string) – Element to return instead of the full array
        • -
      -
      Returns:

      Information about the uploaded file

      -
      Return type:

      mixed

      -
      -

      This is a helper method that returns an array containing all of the -data related to the file you uploaded. Here is the array prototype:

      -
      Array
-(
-        [file_name]     => mypic.jpg
-        [file_type]     => image/jpeg
-        [file_path]     => /path/to/your/upload/
-        [full_path]     => /path/to/your/upload/jpg.jpg
-        [raw_name]      => mypic
-        [orig_name]     => mypic.jpg
-        [client_name]   => mypic.jpg
-        [file_ext]      => .jpg
-        [file_size]     => 22.2
-        [is_image]      => 1
-        [image_width]   => 800
-        [image_height]  => 600
-        [image_type]    => jpeg
-        [image_size_str] => width="800" height="200"
-)
-
      -
      -

      To return one element from the array:

      -
      $this->upload->data('file_name');       // Returns: mypic.jpg
-
      -
      -

      Here’s a table explaining the above-displayed array items:

      - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      ItemDescription
      file_nameName of the file that was uploaded, including the filename extension
      file_typeFile MIME type identifier
      file_pathAbsolute server path to the file
      full_pathAbsolute server path, including the file name
      raw_nameFile name, without the extension
      orig_nameOriginal file name. This is only useful if you use the encrypted name option.
      client_nameFile name as supplied by the client user agent, prior to any file name preparation or incrementing
      file_extFilename extension, period included
      file_sizeFile size in kilobytes
      is_imageWhether the file is an image or not. 1 = image. 0 = not.
      image_widthImage width
      image_heightImage height
      image_typeImage type (usually the file name extension without the period)
      image_size_strA string containing the width and height (useful to put into an image tag)
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/form_validation.html b/user_guide/libraries/form_validation.html deleted file mode 100755 index add2cbe..0000000 --- a/user_guide/libraries/form_validation.html +++ /dev/null @@ -1,1933 +0,0 @@ - - - - - - - - - - Form Validation — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Form Validation

      -

      CodeIgniter provides a comprehensive form validation and data prepping -class that helps minimize the amount of code you’ll write.

      -
      -

      Page Contents

      - -
      -
      -

      Overview

      -

      Before explaining CodeIgniter’s approach to data validation, let’s -describe the ideal scenario:

      -
        -
      1. A form is displayed.
        2. -
      2. You fill it in and submit it.
        3. -
      3. If you submitted something invalid, or perhaps missed a required -item, the form is redisplayed containing your data along with an -error message describing the problem.
        4. -
      4. This process continues until you have submitted a valid form.
        5. -
      -

      On the receiving end, the script must:

      -
        -
      1. Check for required data.
        2. -
      2. Verify that the data is of the correct type, and meets the correct -criteria. For example, if a username is submitted it must be -validated to contain only permitted characters. It must be of a -minimum length, and not exceed a maximum length. The username can’t -be someone else’s existing username, or perhaps even a reserved word. -Etc.
        3. -
      3. Sanitize the data for security.
        4. -
      4. Pre-format the data if needed (Does the data need to be trimmed? HTML -encoded? Etc.)
        5. -
      5. Prep the data for insertion in the database.
        6. -
      -

      Although there is nothing terribly complex about the above process, it -usually requires a significant amount of code, and to display error -messages, various control structures are usually placed within the form -HTML. Form validation, while simple to create, is generally very messy -and tedious to implement.

      -
      -
      -

      Form Validation Tutorial

      -

      What follows is a “hands on” tutorial for implementing CodeIgniters Form -Validation.

      -

      In order to implement form validation you’ll need three things:

      -
        -
      1. A View file containing a form.
        2. -
      2. A View file containing a “success” message to be displayed upon -successful submission.
        3. -
      3. A controller method to receive and -process the submitted data.
        4. -
      -

      Let’s create those three things, using a member sign-up form as the -example.

      -
      -

      The Form

      -

      Using a text editor, create a form called myform.php. In it, place this -code and save it to your application/views/ folder:

      -
      <html>
-<head>
-<title>My Form</title>
-</head>
-<body>
-
-<?php echo validation_errors(); ?>
-
-<?php echo form_open('form'); ?>
-
-<h5>Username</h5>
-<input type="text" name="username" value="" size="50" />
-
-<h5>Password</h5>
-<input type="text" name="password" value="" size="50" />
-
-<h5>Password Confirm</h5>
-<input type="text" name="passconf" value="" size="50" />
-
-<h5>Email Address</h5>
-<input type="text" name="email" value="" size="50" />
-
-<div><input type="submit" value="Submit" /></div>
-
-</form>
-
-</body>
-</html>
-
      -
      -
      -
      -

      The Success Page

      -

      Using a text editor, create a form called formsuccess.php. In it, place -this code and save it to your application/views/ folder:

      -
      <html>
-<head>
-<title>My Form</title>
-</head>
-<body>
-
-<h3>Your form was successfully submitted!</h3>
-
-<p><?php echo anchor('form', 'Try it again!'); ?></p>
-
-</body>
-</html>
-
      -
      -
      -
      -

      The Controller

      -

      Using a text editor, create a controller called form.php. In it, place -this code and save it to your application/controllers/ folder:

      -
      <?php
-
-class Form extends CI_Controller {
-
-        public function index()
-        {
-                $this->load->helper(array('form', 'url'));
-
-                $this->load->library('form_validation');
-
-                if ($this->form_validation->run() == FALSE)
-                {
-                        $this->load->view('myform');
-                }
-                else
-                {
-                        $this->load->view('formsuccess');
-                }
-        }
-}
-
      -
      -
      -
      -

      Try it!

      -

      To try your form, visit your site using a URL similar to this one:

      -
      example.com/index.php/form/
-
      -
      -

      If you submit the form you should simply see the form reload. That’s -because you haven’t set up any validation rules yet.

      -

      Since you haven’t told the Form Validation class to validate anything -yet, it returns FALSE (boolean false) by default. ``The run()`` method -only returns TRUE if it has successfully applied your rules without any -of them failing.

      -
      -
      -

      Explanation

      -

      You’ll notice several things about the above pages:

      -

      The form (myform.php) is a standard web form with a couple exceptions:

      -
        -

      1. It uses a form helper to create the form opening. Technically, this -isn’t necessary. You could create the form using standard HTML. -However, the benefit of using the helper is that it generates the -action URL for you, based on the URL in your config file. This makes -your application more portable in the event your URLs change.

        -
        2. -

      2. At the top of the form you’ll notice the following function call:

        -
        <?php echo validation_errors(); ?>
-
        -
        -

        This function will return any error messages sent back by the -validator. If there are no messages it returns an empty string.

        -
        3. -
      -

      The controller (form.php) has one method: index(). This method -initializes the validation class and loads the form helper and URL -helper used by your view files. It also runs the validation routine. -Based on whether the validation was successful it either presents the -form or the success page.

      -
      -
      -

      Setting Validation Rules

      -

      CodeIgniter lets you set as many validation rules as you need for a -given field, cascading them in order, and it even lets you prep and -pre-process the field data at the same time. To set validation rules you -will use the set_rules() method:

      -
      $this->form_validation->set_rules();
-
      -
      -

      The above method takes three parameters as input:

      -
        -
      1. The field name - the exact name you’ve given the form field.
        2. -
      2. A “human” name for this field, which will be inserted into the error -message. For example, if your field is named “user” you might give it -a human name of “Username”.
        3. -
      3. The validation rules for this form field.
        4. -
      4. (optional) Set custom error messages on any rules given for current field. If not provided will use the default one.
        5. -
      -
      -

      Note

      -

      If you would like the field name to be stored in a language -file, please see Translating Field Names.

      -
      -

      Here is an example. In your controller (form.php), add this code just -below the validation initialization method:

      -
      $this->form_validation->set_rules('username', 'Username', 'required');
-$this->form_validation->set_rules('password', 'Password', 'required');
-$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');
-$this->form_validation->set_rules('email', 'Email', 'required');
-
      -
      -

      Your controller should now look like this:

      -
      <?php
-
-class Form extends CI_Controller {
-
-        public function index()
-        {
-                $this->load->helper(array('form', 'url'));
-
-                $this->load->library('form_validation');
-
-                $this->form_validation->set_rules('username', 'Username', 'required');
-                $this->form_validation->set_rules('password', 'Password', 'required',
-                        array('required' => 'You must provide a %s.')
-                );
-                $this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');
-                $this->form_validation->set_rules('email', 'Email', 'required');
-
-                if ($this->form_validation->run() == FALSE)
-                {
-                        $this->load->view('myform');
-                }
-                else
-                {
-                        $this->load->view('formsuccess');
-                }
-        }
-}
-
      -
      -

      Now submit the form with the fields blank and you should see the error -messages. If you submit the form with all the fields populated you’ll -see your success page.

      -
      -

      Note

      -

      The form fields are not yet being re-populated with the data -when there is an error. We’ll get to that shortly.

      -
      -
      -
      -

      Setting Rules Using an Array

      -

      Before moving on it should be noted that the rule setting method can -be passed an array if you prefer to set all your rules in one action. If -you use this approach, you must name your array keys as indicated:

      -
      $config = array(
-        array(
-                'field' => 'username',
-                'label' => 'Username',
-                'rules' => 'required'
-        ),
-        array(
-                'field' => 'password',
-                'label' => 'Password',
-                'rules' => 'required',
-                'errors' => array(
-                        'required' => 'You must provide a %s.',
-                ),
-        ),
-        array(
-                'field' => 'passconf',
-                'label' => 'Password Confirmation',
-                'rules' => 'required'
-        ),
-        array(
-                'field' => 'email',
-                'label' => 'Email',
-                'rules' => 'required'
-        )
-);
-
-$this->form_validation->set_rules($config);
-
      -
      -
      -
      -

      Cascading Rules

      -

      CodeIgniter lets you pipe multiple rules together. Let’s try it. Change -your rules in the third parameter of rule setting method, like this:

      -
      $this->form_validation->set_rules(
-        'username', 'Username',
-        'required|min_length[5]|max_length[12]|is_unique[users.username]',
-        array(
-                'required'      => 'You have not provided %s.',
-                'is_unique'     => 'This %s already exists.'
-        )
-);
-$this->form_validation->set_rules('password', 'Password', 'required');
-$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required|matches[password]');
-$this->form_validation->set_rules('email', 'Email', 'required|valid_email|is_unique[users.email]');
-
      -
      -

      The above code sets the following rules:

      -
        -
      1. The username field be no shorter than 5 characters and no longer than -12.
        2. -
      2. The password field must match the password confirmation field.
        3. -
      3. The email field must contain a valid email address.
        4. -
      -

      Give it a try! Submit your form without the proper data and you’ll see -new error messages that correspond to your new rules. There are numerous -rules available which you can read about in the validation reference.

      -
      -

      Note

      -

      You can also pass an array of rules to set_rules(), -instead of a string. Example:

      -
      $this->form_validation->set_rules('username', 'Username', array('required', 'min_length[5]'));
-
      -
      -
      -
      -
      -

      Prepping Data

      -

      In addition to the validation method like the ones we used above, you -can also prep your data in various ways. For example, you can set up -rules like this:

      -
      $this->form_validation->set_rules('username', 'Username', 'trim|required|min_length[5]|max_length[12]');
-$this->form_validation->set_rules('password', 'Password', 'trim|required|min_length[8]');
-$this->form_validation->set_rules('passconf', 'Password Confirmation', 'trim|required|matches[password]');
-$this->form_validation->set_rules('email', 'Email', 'trim|required|valid_email');
-
      -
      -

      In the above example, we are “trimming” the fields, checking for length -where necessary and making sure that both password fields match.

      -

      Any native PHP function that accepts one parameter can be used as a -rule, like ``htmlspecialchars()``, ``trim()``, etc.

      -
      -

      Note

      -

      You will generally want to use the prepping functions -after the validation rules so if there is an error, the -original data will be shown in the form.

      -
      -
      -
      -

      Re-populating the form

      -

      Thus far we have only been dealing with errors. It’s time to repopulate -the form field with the submitted data. CodeIgniter offers several -helper functions that permit you to do this. The one you will use most -commonly is:

      -
      set_value('field name')
-
      -
      -

      Open your myform.php view file and update the value in each field -using the set_value() function:

      -

      Don’t forget to include each field name in the :php:func:`set_value()` -function calls!

      -
      <html>
-<head>
-<title>My Form</title>
-</head>
-<body>
-
-<?php echo validation_errors(); ?>
-
-<?php echo form_open('form'); ?>
-
-<h5>Username</h5>
-<input type="text" name="username" value="<?php echo set_value('username'); ?>" size="50" />
-
-<h5>Password</h5>
-<input type="text" name="password" value="<?php echo set_value('password'); ?>" size="50" />
-
-<h5>Password Confirm</h5>
-<input type="text" name="passconf" value="<?php echo set_value('passconf'); ?>" size="50" />
-
-<h5>Email Address</h5>
-<input type="text" name="email" value="<?php echo set_value('email'); ?>" size="50" />
-
-<div><input type="submit" value="Submit" /></div>
-
-</form>
-
-</body>
-</html>
-
      -
      -

      Now reload your page and submit the form so that it triggers an error. -Your form fields should now be re-populated

      -
      -

      Note

      -

      The Class Reference section below -contains methods that permit you to re-populate <select> menus, -radio buttons, and checkboxes.

      -
      -
      -

      Important

      -

      If you use an array as the name of a form field, you -must supply it as an array to the function. Example:

      -
      <input type="text" name="colors[]" value="<?php echo set_value('colors[]'); ?>" size="50" />
-
      -
      -
      -

      For more info please see the Using Arrays as Field Names section below.

      -
      -
      -

      Callbacks: Your own Validation Methods

      -

      The validation system supports callbacks to your own validation -methods. This permits you to extend the validation class to meet your -needs. For example, if you need to run a database query to see if the -user is choosing a unique username, you can create a callback method -that does that. Let’s create an example of this.

      -

      In your controller, change the “username” rule to this:

      -
      $this->form_validation->set_rules('username', 'Username', 'callback_username_check');
-
      -
      -

      Then add a new method called username_check() to your controller. -Here’s how your controller should now look:

      -
      <?php
-
-class Form extends CI_Controller {
-
-        public function index()
-        {
-                $this->load->helper(array('form', 'url'));
-
-                $this->load->library('form_validation');
-
-                $this->form_validation->set_rules('username', 'Username', 'callback_username_check');
-                $this->form_validation->set_rules('password', 'Password', 'required');
-                $this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');
-                $this->form_validation->set_rules('email', 'Email', 'required|is_unique[users.email]');
-
-                if ($this->form_validation->run() == FALSE)
-                {
-                        $this->load->view('myform');
-                }
-                else
-                {
-                        $this->load->view('formsuccess');
-                }
-        }
-
-        public function username_check($str)
-        {
-                if ($str == 'test')
-                {
-                        $this->form_validation->set_message('username_check', 'The {field} field can not be the word "test"');
-                        return FALSE;
-                }
-                else
-                {
-                        return TRUE;
-                }
-        }
-
-}
-
      -
      -

      Reload your form and submit it with the word “test” as the username. You -can see that the form field data was passed to your callback method -for you to process.

      -

      To invoke a callback just put the method name in a rule, with -“callback_” as the rule prefix. If you need to receive an extra -parameter in your callback method, just add it normally after the -method name between square brackets, as in: “callback_foo**[bar]**”, -then it will be passed as the second argument of your callback method.

      -
      -

      Note

      -

      You can also process the form data that is passed to your -callback and return it. If your callback returns anything other than a -boolean TRUE/FALSE it is assumed that the data is your newly processed -form data.

      -
      -
      -
      -

      Callable: Use anything as a rule

      -

      If callback rules aren’t good enough for you (for example, because they are -limited to your controller), don’t get disappointed, there’s one more way -to create custom rules: anything that is_callable() would return TRUE for.

      -

      Consider the following example:

      -
      $this->form_validation->set_rules(
-        'username', 'Username',
-        array(
-                'required',
-                array($this->users_model, 'valid_username')
-        )
-);
-
      -
      -

      The above code would use the valid_username() method from your -Users_model object.

      -

      This is just an example of course, and callbacks aren’t limited to models. -You can use any object/method that accepts the field value as its’ first -parameter. Or if you’re running PHP 5.3+, you can also use an anonymous -function:

      -
      $this->form_validation->set_rules(
-        'username', 'Username',
-        array(
-                'required',
-                function($value)
-                {
-                        // Check $value
-                }
-        )
-);
-
      -
      -

      Of course, since a Callable rule by itself is not a string, it isn’t -a rule name either. That is a problem when you want to set error messages -for them. In order to get around that problem, you can put such rules as -the second element of an array, with the first one being the rule name:

      -
      $this->form_validation->set_rules(
-        'username', 'Username',
-        array(
-                'required',
-                array('username_callable', array($this->users_model, 'valid_username'))
-        )
-);
-
      -
      -

      Anonymous function (PHP 5.3+) version:

      -
      $this->form_validation->set_rules(
-        'username', 'Username',
-        array(
-                'required',
-                array(
-                        'username_callable',
-                        function($str)
-                        {
-                                // Check validity of $str and return TRUE or FALSE
-                        }
-                )
-        )
-);
-
      -
      -
      -
      -

      Setting Error Messages

      -

      All of the native error messages are located in the following language -file: system/language/english/form_validation_lang.php

      -

      To set your own global custom message for a rule, you can either -extend/override the language file by creating your own in -application/language/english/form_validation_lang.php (read more -about this in the Language Class documentation), -or use the following method:

      -
      $this->form_validation->set_message('rule', 'Error Message');
-
      -
      -

      If you need to set a custom error message for a particular field on -some particular rule, use the set_rules() method:

      -
      $this->form_validation->set_rules('field_name', 'Field Label', 'rule1|rule2|rule3',
-        array('rule2' => 'Error Message on rule2 for this field_name')
-);
-
      -
      -

      Where rule corresponds to the name of a particular rule, and Error -Message is the text you would like displayed.

      -

      If you’d like to include a field’s “human” name, or the optional -parameter some rules allow for (such as max_length), you can add the -{field} and {param} tags to your message, respectively:

      -
      $this->form_validation->set_message('min_length', '{field} must have at least {param} characters.');
-
      -
      -

      On a field with the human name Username and a rule of min_length[5], an -error would display: “Username must have at least 5 characters.”

      -
      -

      Note

      -

      The old sprintf() method of using %s in your error messages -will still work, however it will override the tags above. You should -use one or the other.

      -
      -

      In the callback rule example above, the error message was set by passing -the name of the method (without the “callback_” prefix):

      -
      $this->form_validation->set_message('username_check')
-
      -
      -
      -
      -

      Translating Field Names

      -

      If you would like to store the “human” name you passed to the -set_rules() method in a language file, and therefore make the name -able to be translated, here’s how:

      -

      First, prefix your “human” name with lang:, as in this example:

      -
      $this->form_validation->set_rules('first_name', 'lang:first_name', 'required');
-
      -
      -

      Then, store the name in one of your language file arrays (without the -prefix):

      -
      $lang['first_name'] = 'First Name';
-
      -
      -
      -

      Note

      -

      If you store your array item in a language file that is not -loaded automatically by CI, you’ll need to remember to load it in your -controller using:

      -
      $this->lang->load('file_name');
-
      -
      -
      -

      See the Language Class page for more info regarding -language files.

      -
      -
      -

      Changing the Error Delimiters

      -

      By default, the Form Validation class adds a paragraph tag (<p>) around -each error message shown. You can either change these delimiters -globally, individually, or change the defaults in a config file.

      -
        -

      1. Changing delimiters Globally -To globally change the error delimiters, in your controller method, -just after loading the Form Validation class, add this:

        -
        $this->form_validation->set_error_delimiters('<div class="error">', '</div>');
-
        -
        -

        In this example, we’ve switched to using div tags.

        -
        2. -

      2. Changing delimiters Individually -Each of the two error generating functions shown in this tutorial can -be supplied their own delimiters as follows:

        -
        <?php echo form_error('field name', '<div class="error">', '</div>'); ?>
-
        -
        -

        Or:

        -
        <?php echo validation_errors('<div class="error">', '</div>'); ?>
-
        -
        -
        3. -

      3. Set delimiters in a config file -You can add your error delimiters in application/config/form_validation.php as follows:

        -
        $config['error_prefix'] = '<div class="error_prefix">';
-$config['error_suffix'] = '</div>';
-
        -
        -
        4. -
      -
      -
      -

      Showing Errors Individually

      -

      If you prefer to show an error message next to each form field, rather -than as a list, you can use the form_error() function.

      -

      Try it! Change your form so that it looks like this:

      -
      <h5>Username</h5>
-<?php echo form_error('username'); ?>
-<input type="text" name="username" value="<?php echo set_value('username'); ?>" size="50" />
-
-<h5>Password</h5>
-<?php echo form_error('password'); ?>
-<input type="text" name="password" value="<?php echo set_value('password'); ?>" size="50" />
-
-<h5>Password Confirm</h5>
-<?php echo form_error('passconf'); ?>
-<input type="text" name="passconf" value="<?php echo set_value('passconf'); ?>" size="50" />
-
-<h5>Email Address</h5>
-<?php echo form_error('email'); ?>
-<input type="text" name="email" value="<?php echo set_value('email'); ?>" size="50" />
-
      -
      -

      If there are no errors, nothing will be shown. If there is an error, the -message will appear.

      -
      -

      Important

      -

      If you use an array as the name of a form field, you -must supply it as an array to the function. Example:

      -
      <?php echo form_error('options[size]'); ?>
-<input type="text" name="options[size]" value="<?php echo set_value("options[size]"); ?>" size="50" />
-
      -
      -
      -

      For more info please see the Using Arrays as Field Names section below.

      -
      -
      -

      Validating an Array (other than $_POST)

      -

      Sometimes you may want to validate an array that does not originate from $_POST data.

      -

      In this case, you can specify the array to be validated:

      -
      $data = array(
-        'username' => 'johndoe',
-        'password' => 'mypassword',
-        'passconf' => 'mypassword'
-);
-
-$this->form_validation->set_data($data);
-
      -
      -

      Creating validation rules, running the validation, and retrieving error -messages works the same whether you are validating $_POST data or -another array of your choice.

      -
      -

      Important

      -

      You have to call the set_data() method before defining -any validation rules.

      -
      -
      -

      Important

      -

      If you want to validate more than one array during a single -execution, then you should call the reset_validation() method -before setting up rules and validating the new array.

      -
      -

      For more info please see the Class Reference section below.

      -
      -
      -
      -

      Saving Sets of Validation Rules to a Config File

      -

      A nice feature of the Form Validation class is that it permits you to -store all your validation rules for your entire application in a config -file. You can organize these rules into “groups”. These groups can -either be loaded automatically when a matching controller/method is -called, or you can manually call each set as needed.

      -
      -

      How to save your rules

      -

      To store your validation rules, simply create a file named -form_validation.php in your application/config/ folder. In that file -you will place an array named $config with your rules. As shown earlier, -the validation array will have this prototype:

      -
      $config = array(
-        array(
-                'field' => 'username',
-                'label' => 'Username',
-                'rules' => 'required'
-        ),
-        array(
-                'field' => 'password',
-                'label' => 'Password',
-                'rules' => 'required'
-        ),
-        array(
-                'field' => 'passconf',
-                'label' => 'Password Confirmation',
-                'rules' => 'required'
-        ),
-        array(
-                'field' => 'email',
-                'label' => 'Email',
-                'rules' => 'required'
-        )
-);
-
      -
      -

      Your validation rule file will be loaded automatically and used when you -call the run() method.

      -

      Please note that you MUST name your $config array.

      -
      -
      -

      Creating Sets of Rules

      -

      In order to organize your rules into “sets” requires that you place them -into “sub arrays”. Consider the following example, showing two sets of -rules. We’ve arbitrarily called these two rules “signup” and “email”. -You can name your rules anything you want:

      -
      $config = array(
-        'signup' => array(
-                array(
-                        'field' => 'username',
-                        'label' => 'Username',
-                        'rules' => 'required'
-                ),
-                array(
-                        'field' => 'password',
-                        'label' => 'Password',
-                        'rules' => 'required'
-                ),
-                array(
-                        'field' => 'passconf',
-                        'label' => 'Password Confirmation',
-                        'rules' => 'required'
-                ),
-                array(
-                        'field' => 'email',
-                        'label' => 'Email',
-                        'rules' => 'required'
-                )
-        ),
-        'email' => array(
-                array(
-                        'field' => 'emailaddress',
-                        'label' => 'EmailAddress',
-                        'rules' => 'required|valid_email'
-                ),
-                array(
-                        'field' => 'name',
-                        'label' => 'Name',
-                        'rules' => 'required|alpha'
-                ),
-                array(
-                        'field' => 'title',
-                        'label' => 'Title',
-                        'rules' => 'required'
-                ),
-                array(
-                        'field' => 'message',
-                        'label' => 'MessageBody',
-                        'rules' => 'required'
-                )
-        )
-);
-
      -
      -
      -
      -

      Calling a Specific Rule Group

      -

      In order to call a specific group, you will pass its name to the run() -method. For example, to call the signup rule you will do this:

      -
      if ($this->form_validation->run('signup') == FALSE)
-{
-        $this->load->view('myform');
-}
-else
-{
-        $this->load->view('formsuccess');
-}
-
      -
      -
      -
      -

      Associating a Controller Method with a Rule Group

      -

      An alternate (and more automatic) method of calling a rule group is to -name it according to the controller class/method you intend to use it -with. For example, let’s say you have a controller named Member and a -method named signup. Here’s what your class might look like:

      -
      <?php
-
-class Member extends CI_Controller {
-
-        public function signup()
-        {
-                $this->load->library('form_validation');
-
-                if ($this->form_validation->run() == FALSE)
-                {
-                        $this->load->view('myform');
-                }
-                else
-                {
-                        $this->load->view('formsuccess');
-                }
-        }
-}
-
      -
      -

      In your validation config file, you will name your rule group -member/signup:

      -
      $config = array(
-        'member/signup' => array(
-                array(
-                        'field' => 'username',
-                        'label' => 'Username',
-                        'rules' => 'required'
-                ),
-                array(
-                        'field' => 'password',
-                        'label' => 'Password',
-                        'rules' => 'required'
-                ),
-                array(
-                        'field' => 'passconf',
-                        'label' => 'PasswordConfirmation',
-                        'rules' => 'required'
-                ),
-                array(
-                        'field' => 'email',
-                        'label' => 'Email',
-                        'rules' => 'required'
-                )
-        )
-);
-
      -
      -

      When a rule group is named identically to a controller class/method it -will be used automatically when the run() method is invoked from that -class/method.

      -
      -
      -
      -

      Using Arrays as Field Names

      -

      The Form Validation class supports the use of arrays as field names. -Consider this example:

      -
      <input type="text" name="options[]" value="" size="50" />
-
      -
      -

      If you do use an array as a field name, you must use the EXACT array -name in the Helper Functions that require the -field name, and as your Validation Rule field name.

      -

      For example, to set a rule for the above field you would use:

      -
      $this->form_validation->set_rules('options[]', 'Options', 'required');
-
      -
      -

      Or, to show an error for the above field you would use:

      -
      <?php echo form_error('options[]'); ?>
-
      -
      -

      Or to re-populate the field you would use:

      -
      <input type="text" name="options[]" value="<?php echo set_value('options[]'); ?>" size="50" />
-
      -
      -

      You can use multidimensional arrays as field names as well. For example:

      -
      <input type="text" name="options[size]" value="" size="50" />
-
      -
      -

      Or even:

      -
      <input type="text" name="sports[nba][basketball]" value="" size="50" />
-
      -
      -

      As with our first example, you must use the exact array name in the -helper functions:

      -
      <?php echo form_error('sports[nba][basketball]'); ?>
-
      -
      -

      If you are using checkboxes (or other fields) that have multiple -options, don’t forget to leave an empty bracket after each option, so -that all selections will be added to the POST array:

      -
      <input type="checkbox" name="options[]" value="red" />
-<input type="checkbox" name="options[]" value="blue" />
-<input type="checkbox" name="options[]" value="green" />
-
      -
      -

      Or if you use a multidimensional array:

      -
      <input type="checkbox" name="options[color][]" value="red" />
-<input type="checkbox" name="options[color][]" value="blue" />
-<input type="checkbox" name="options[color][]" value="green" />
-
      -
      -

      When you use a helper function you’ll include the bracket as well:

      -
      <?php echo form_error('options[color][]'); ?>
-
      -
      -
      -
      -

      Rule Reference

      -

      The following is a list of all the native rules that are available to -use:

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      RuleParameterDescriptionExample
      requiredNoReturns FALSE if the form element is empty. 
      matchesYesReturns FALSE if the form element does not match the one in the parameter.matches[form_item]
      regex_matchYesReturns FALSE if the form element does not match the regular expression.regex_match[/regex/]
      differsYesReturns FALSE if the form element does not differ from the one in the parameter.differs[form_item]
      is_uniqueYesReturns FALSE if the form element is not unique to the table and field name in the -parameter. Note: This rule requires Query Builder to be -enabled in order to work.is_unique[table.field]
      min_lengthYesReturns FALSE if the form element is shorter than the parameter value.min_length[3]
      max_lengthYesReturns FALSE if the form element is longer than the parameter value.max_length[12]
      exact_lengthYesReturns FALSE if the form element is not exactly the parameter value.exact_length[8]
      greater_thanYesReturns FALSE if the form element is less than or equal to the parameter value or not -numeric.greater_than[8]
      greater_than_equal_toYesReturns FALSE if the form element is less than the parameter value, -or not numeric.greater_than_equal_to[8]
      less_thanYesReturns FALSE if the form element is greater than or equal to the parameter value or -not numeric.less_than[8]
      less_than_equal_toYesReturns FALSE if the form element is greater than the parameter value, -or not numeric.less_than_equal_to[8]
      in_listYesReturns FALSE if the form element is not within a predetermined list.in_list[red,blue,green]
      alphaNoReturns FALSE if the form element contains anything other than alphabetical characters. 
      alpha_numericNoReturns FALSE if the form element contains anything other than alpha-numeric characters. 
      alpha_numeric_spacesNoReturns FALSE if the form element contains anything other than alpha-numeric characters -or spaces. Should be used after trim to avoid spaces at the beginning or end. 
      alpha_dashNoReturns FALSE if the form element contains anything other than alpha-numeric characters, -underscores or dashes. 
      numericNoReturns FALSE if the form element contains anything other than numeric characters. 
      integerNoReturns FALSE if the form element contains anything other than an integer. 
      decimalNoReturns FALSE if the form element contains anything other than a decimal number. 
      is_naturalNoReturns FALSE if the form element contains anything other than a natural number: -0, 1, 2, 3, etc. 
      is_natural_no_zeroNoReturns FALSE if the form element contains anything other than a natural -number, but not zero: 1, 2, 3, etc. 
      valid_urlNoReturns FALSE if the form element does not contain a valid URL. 
      valid_emailNoReturns FALSE if the form element does not contain a valid email address. 
      valid_emailsNoReturns FALSE if any value provided in a comma separated list is not a valid email. 
      valid_ipNoReturns FALSE if the supplied IP is not valid. -Accepts an optional parameter of ‘ipv4’ or ‘ipv6’ to specify an IP format. 
      valid_base64NoReturns FALSE if the supplied string contains anything other than valid Base64 characters. 
      -
      -

      Note

      -

      These rules can also be called as discrete methods. For -example:

      -
      $this->form_validation->required($string);
-
      -
      -
      -
      -

      Note

      -

      You can also use any native PHP functions that permit up -to two parameters, where at least one is required (to pass -the field data).

      -
      -
      -
      -

      Prepping Reference

      -

      The following is a list of all the prepping methods that are available -to use:

      - ----- - - - - - - - - - - - - - - - - - - - - - - - - -
      NameParameterDescription
      prep_for_formNoConverts special characters so that HTML data can be shown in a form field without breaking it.
      prep_urlNoAdds “http://” to URLs if missing.
      strip_image_tagsNoStrips the HTML from image tags leaving the raw URL.
      encode_php_tagsNoConverts PHP tags to entities.
      -
      -

      Note

      -

      You can also use any native PHP functions that permits one -parameter, like trim(), htmlspecialchars(), urldecode(), -etc.

      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Form_validation
      -
      -
      -set_rules($field[, $label = ''[, $rules = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $label (string) – Field label
        • -
      • $rules (mixed) – Validation rules, as a string list separated by a pipe “|”, or as an array or rules
        • -
      -
      Returns:

      CI_Form_validation instance (method chaining)

      -
      Return type:

      CI_Form_validation

      -
      -

      Permits you to set validation rules, as described in the tutorial -sections above:

      - -
      - -
      -
      -run([$group = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $group (string) – The name of the validation group to run
        • -
      -
      Returns:

      TRUE on success, FALSE if validation failed

      -
      Return type:

      bool

      -
      -

      Runs the validation routines. Returns boolean TRUE on success and FALSE -on failure. You can optionally pass the name of the validation group via -the method, as described in: Saving Sets of Validation Rules to a Config File

      -
      - -
      -
      -set_message($lang[, $val = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $lang (string) – The rule the message is for
        • -
      • $val (string) – The message
        • -
      -
      Returns:

      CI_Form_validation instance (method chaining)

      -
      Return type:

      CI_Form_validation

      -
      -

      Permits you to set custom error messages. See Setting Error Messages

      -
      - -
      -
      -set_error_delimiters([$prefix = '<p>'[, $suffix = '</p>']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $prefix (string) – Error message prefix
        • -
      • $suffix (string) – Error message suffix
        • -
      -
      Returns:

      CI_Form_validation instance (method chaining)

      -
      Return type:

      CI_Form_validation

      -
      -

      Sets the default prefix and suffix for error messages.

      -
      - -
      -
      -set_data($data)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $data (array) – Array of data validate
        • -
      -
      Returns:

      CI_Form_validation instance (method chaining)

      -
      Return type:

      CI_Form_validation

      -
      -

      Permits you to set an array for validation, instead of using the default -$_POST array.

      -
      - -
      -
      -reset_validation()
      -
      --- - - - - - -
      Returns:CI_Form_validation instance (method chaining)
      Return type:CI_Form_validation
      -

      Permits you to reset the validation when you validate more than one array. -This method should be called before validating each new array.

      -
      - -
      -
      -error_array()
      -
      --- - - - - - -
      Returns:Array of error messages
      Return type:array
      -

      Returns the error messages as an array.

      -
      - -
      -
      -error_string([$prefix = ''[, $suffix = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $prefix (string) – Error message prefix
        • -
      • $suffix (string) – Error message suffix
        • -
      -
      Returns:

      Error messages as a string

      -
      Return type:

      string

      -
      -

      Returns all error messages (as returned from error_array()) formatted as a -string and separated by a newline character.

      -
      - -
      -
      -error($field[, $prefix = ''[, $suffix = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      • $prefix (string) – Optional prefix
        • -
      • $suffix (string) – Optional suffix
        • -
      -
      Returns:

      Error message string

      -
      Return type:

      string

      -
      -

      Returns the error message for a specific field, optionally adding a -prefix and/or suffix to it (usually HTML tags).

      -
      - -
      -
      -has_rule($field)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $field (string) – Field name
        • -
      -
      Returns:

      TRUE if the field has rules set, FALSE if not

      -
      Return type:

      bool

      -
      -

      Checks to see if there is a rule set for the specified field.

      -
      - -
      - -
      -
      -

      Helper Reference

      -

      Please refer to the Form Helper manual for -the following functions:

      - -

      Note that these are procedural functions, so they do not require you -to prepend them with $this->form_validation.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/ftp.html b/user_guide/libraries/ftp.html deleted file mode 100755 index 6989cfd..0000000 --- a/user_guide/libraries/ftp.html +++ /dev/null @@ -1,1017 +0,0 @@ - - - - - - - - - - FTP Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      FTP Class

      -

      CodeIgniter’s FTP Class permits files to be transfered to a remote -server. Remote files can also be moved, renamed, and deleted. The FTP -class also includes a “mirroring” function that permits an entire local -directory to be recreated remotely via FTP.

      -
      -

      Note

      -

      SFTP and SSL FTP protocols are not supported, only standard -FTP.

      -
      - -
      -

      Working with the FTP Class

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the FTP class is initialized in -your controller using the $this->load->library function:

      -
      $this->load->library('ftp');
-
      -
      -

      Once loaded, the FTP object will be available using: $this->ftp

      -
      -
      -

      Usage Examples

      -

      In this example a connection is opened to the FTP server, and a local -file is read and uploaded in ASCII mode. The file permissions are set to -755.

      -
      $this->load->library('ftp');
-
-$config['hostname'] = 'ftp.example.com';
-$config['username'] = 'your-username';
-$config['password'] = 'your-password';
-$config['debug']        = TRUE;
-
-$this->ftp->connect($config);
-
-$this->ftp->upload('/local/path/to/myfile.html', '/public_html/myfile.html', 'ascii', 0775);
-
-$this->ftp->close();
-
      -
      -

      In this example a list of files is retrieved from the server.

      -
      $this->load->library('ftp');
-
-$config['hostname'] = 'ftp.example.com';
-$config['username'] = 'your-username';
-$config['password'] = 'your-password';
-$config['debug']        = TRUE;
-
-$this->ftp->connect($config);
-
-$list = $this->ftp->list_files('/public_html/');
-
-print_r($list);
-
-$this->ftp->close();
-
      -
      -

      In this example a local directory is mirrored on the server.

      -
      $this->load->library('ftp');
-
-$config['hostname'] = 'ftp.example.com';
-$config['username'] = 'your-username';
-$config['password'] = 'your-password';
-$config['debug']        = TRUE;
-
-$this->ftp->connect($config);
-
-$this->ftp->mirror('/path/to/myfolder/', '/public_html/myfolder/');
-
-$this->ftp->close();
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_FTP
      -
      -
      -connect([$config = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $config (array) – Connection values
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Connects and logs into to the FTP server. Connection preferences are set -by passing an array to the function, or you can store them in a config -file.

      -

      Here is an example showing how you set preferences manually:

      -
      $this->load->library('ftp');
-
-$config['hostname'] = 'ftp.example.com';
-$config['username'] = 'your-username';
-$config['password'] = 'your-password';
-$config['port']     = 21;
-$config['passive']  = FALSE;
-$config['debug']    = TRUE;
-
-$this->ftp->connect($config);
-
      -
      -

      Setting FTP Preferences in a Config File

      -

      If you prefer you can store your FTP preferences in a config file. -Simply create a new file called the ftp.php, add the $config array in -that file. Then save the file at application/config/ftp.php and it -will be used automatically.

      -

      Available connection options

      - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Option nameDefault valueDescription
      hostnamen/aFTP hostname (usually something like: ftp.example.com)
      usernamen/aFTP username
      passwordn/aFTP password
      port21FTP server port number
      debugFALSETRUE/FALSE (boolean): Whether to enable debugging to display error messages
      passiveTRUETRUE/FALSE (boolean): Whether to use passive mode
      -
      - -
      -
      -upload($locpath, $rempath[, $mode = 'auto'[, $permissions = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $locpath (string) – Local file path
        • -
      • $rempath (string) – Remote file path
        • -
      • $mode (string) – FTP mode, defaults to ‘auto’ (options are: ‘auto’, ‘binary’, ‘ascii’)
        • -
      • $permissions (int) – File permissions (octal)
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Uploads a file to your server. You must supply the local path and the -remote path, and you can optionally set the mode and permissions. -Example:

      -
      $this->ftp->upload('/local/path/to/myfile.html', '/public_html/myfile.html', 'ascii', 0775);
-
      -
      -

      If ‘auto’ mode is used it will base the mode on the file extension of the source file.

      -

      If set, permissions have to be passed as an octal value.

      -
      - -
      -
      -download($rempath, $locpath[, $mode = 'auto'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $rempath (string) – Remote file path
        • -
      • $locpath (string) – Local file path
        • -
      • $mode (string) – FTP mode, defaults to ‘auto’ (options are: ‘auto’, ‘binary’, ‘ascii’)
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Downloads a file from your server. You must supply the remote path and -the local path, and you can optionally set the mode. Example:

      -
      $this->ftp->download('/public_html/myfile.html', '/local/path/to/myfile.html', 'ascii');
-
      -
      -

      If ‘auto’ mode is used it will base the mode on the file extension of the source file.

      -

      Returns FALSE if the download does not execute successfully -(including if PHP does not have permission to write the local file).

      -
      - -
      -
      -rename($old_file, $new_file[, $move = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $old_file (string) – Old file name
        • -
      • $new_file (string) – New file name
        • -
      • $move (bool) – Whether a move is being performed
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Permits you to rename a file. Supply the source file name/path and the new file name/path.

      -
      // Renames green.html to blue.html
-$this->ftp->rename('/public_html/foo/green.html', '/public_html/foo/blue.html');
-
      -
      -
      - -
      -
      -move($old_file, $new_file)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $old_file (string) – Old file name
        • -
      • $new_file (string) – New file name
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Lets you move a file. Supply the source and destination paths:

      -
      // Moves blog.html from "joe" to "fred"
-$this->ftp->move('/public_html/joe/blog.html', '/public_html/fred/blog.html');
-
      -
      -
      -

      Note

      -

      If the destination file name is different the file will be renamed.

      -
      -
      - -
      -
      -delete_file($filepath)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $filepath (string) – Path to file to delete
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Lets you delete a file. Supply the source path with the file name.

      -
      $this->ftp->delete_file('/public_html/joe/blog.html');
-
      -
      -
      - -
      -
      -delete_dir($filepath)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $filepath (string) – Path to directory to delete
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Lets you delete a directory and everything it contains. Supply the -source path to the directory with a trailing slash.

      -
      -

      Important

      -

      Be VERY careful with this method! -It will recursively delete everything within the supplied path, -including sub-folders and all files. Make absolutely sure your path -is correct. Try using list_files() first to verify that your path is correct.

      -
      -
      $this->ftp->delete_dir('/public_html/path/to/folder/');
-
      -
      -
      - -
      -
      -list_files([$path = '.'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Directory path
        • -
      -
      Returns:

      An array list of files or FALSE on failure

      -
      Return type:

      array

      -
      -

      Permits you to retrieve a list of files on your server returned as an -array. You must supply the path to the desired directory.

      -
      $list = $this->ftp->list_files('/public_html/');
-print_r($list);
-
      -
      -
      - -
      -
      -mirror($locpath, $rempath)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $locpath (string) – Local path
        • -
      • $rempath (string) – Remote path
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Recursively reads a local folder and everything it contains (including -sub-folders) and creates a mirror via FTP based on it. Whatever the -directory structure of the original file path will be recreated on the -server. You must supply a source path and a destination path:

      -
      $this->ftp->mirror('/path/to/myfolder/', '/public_html/myfolder/');
-
      -
      -
      - -
      -
      -mkdir($path[, $permissions = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Path to directory to create
        • -
      • $permissions (int) – Permissions (octal)
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Lets you create a directory on your server. Supply the path ending in -the folder name you wish to create, with a trailing slash.

      -

      Permissions can be set by passing an octal value in the second parameter.

      -
      // Creates a folder named "bar"
-$this->ftp->mkdir('/public_html/foo/bar/', 0755);
-
      -
      -
      - -
      -
      -chmod($path, $perm)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Path to alter permissions for
        • -
      • $perm (int) – Permissions (octal)
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Permits you to set file permissions. Supply the path to the file or -directory you wish to alter permissions on:

      -
      // Chmod "bar" to 755
-$this->ftp->chmod('/public_html/foo/bar/', 0755);
-
      -
      -
      - -
      -
      -changedir($path[, $suppress_debug = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Directory path
        • -
      • $suppress_debug (bool) – Whether to turn off debug messages for this command
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Changes the current working directory to the specified path.

      -

      The $suppress_debug parameter is useful in case you want to use this method -as an is_dir() alternative for FTP.

      -
      - -
      -
      -close()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      Closes the connection to your server. It’s recommended that you use this -when you are finished uploading.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/image_lib.html b/user_guide/libraries/image_lib.html deleted file mode 100755 index f888ecb..0000000 --- a/user_guide/libraries/image_lib.html +++ /dev/null @@ -1,1255 +0,0 @@ - - - - - - - - - - Image Manipulation Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries »
        • - -
      • Image Manipulation Class
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Image Manipulation Class

      -

      CodeIgniter’s Image Manipulation class lets you perform the following -actions:

      -
        -
      • Image Resizing
        • -
      • Thumbnail Creation
        • -
      • Image Cropping
        • -
      • Image Rotating
        • -
      • Image Watermarking
        • -
      -

      All three major image libraries are supported: GD/GD2, NetPBM, and -ImageMagick

      -
      -

      Note

      -

      Watermarking is only available using the GD/GD2 library. In -addition, even though other libraries are supported, GD is required in -order for the script to calculate the image properties. The image -processing, however, will be performed with the library you specify.

      -
      - -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the image class is initialized -in your controller using the $this->load->library function:

      -
      $this->load->library('image_lib');
-
      -
      -

      Once the library is loaded it will be ready for use. The image library -object you will use to call all functions is: $this->image_lib

      -
      -

      Processing an Image

      -

      Regardless of the type of processing you would like to perform -(resizing, cropping, rotation, or watermarking), the general process is -identical. You will set some preferences corresponding to the action you -intend to perform, then call one of four available processing functions. -For example, to create an image thumbnail you’ll do this:

      -
      $config['image_library'] = 'gd2';
-$config['source_image'] = '/path/to/image/mypic.jpg';
-$config['create_thumb'] = TRUE;
-$config['maintain_ratio'] = TRUE;
-$config['width']         = 75;
-$config['height']       = 50;
-
-$this->load->library('image_lib', $config);
-
-$this->image_lib->resize();
-
      -
      -

      The above code tells the image_resize function to look for an image -called mypic.jpg located in the source_image folder, then create a -thumbnail that is 75 X 50 pixels using the GD2 image_library. Since the -maintain_ratio option is enabled, the thumb will be as close to the -target width and height as possible while preserving the original aspect -ratio. The thumbnail will be called mypic_thumb.jpg

      -
      -

      Note

      -

      In order for the image class to be allowed to do any -processing, the folder containing the image files must have write -permissions.

      -
      -
      -

      Note

      -

      Image processing can require a considerable amount of server -memory for some operations. If you are experiencing out of memory errors -while processing images you may need to limit their maximum size, and/or -adjust PHP memory limits.

      -
      -
      -
      -

      Processing Methods

      -

      There are four available processing methods:

      -
        -
      • $this->image_lib->resize()
        • -
      • $this->image_lib->crop()
        • -
      • $this->image_lib->rotate()
        • -
      • $this->image_lib->watermark()
        • -
      -

      These methods return boolean TRUE upon success and FALSE for failure. -If they fail you can retrieve the error message using this function:

      -
      echo $this->image_lib->display_errors();
-
      -
      -

      A good practice is to use the processing function conditionally, showing an -error upon failure, like this:

      -
      if ( ! $this->image_lib->resize())
-{
-        echo $this->image_lib->display_errors();
-}
-
      -
      -
      -

      Note

      -

      You can optionally specify the HTML formatting to be applied to -the errors, by submitting the opening/closing tags in the function, -like this:

      -
      $this->image_lib->display_errors('<p>', '</p>');
-
      -
      -
      -
      -
      -

      Preferences

      -

      The preferences described below allow you to tailor the image processing -to suit your needs.

      -

      Note that not all preferences are available for every function. For -example, the x/y axis preferences are only available for image cropping. -Likewise, the width and height preferences have no effect on cropping. -The “availability” column indicates which functions support a given -preference.

      -

      Availability Legend:

      -
        -
      • R - Image Resizing
        • -
      • C - Image Cropping
        • -
      • X - Image Rotation
        • -
      • W - Image Watermarking
        • -
      - ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefault ValueOptionsDescriptionAvailability
      image_libraryGD2GD, GD2, ImageMagick, NetPBMSets the image library to be used.R, C, X, W
      library_pathNoneNoneSets the server path to your ImageMagick or NetPBM library. If you use -either of those libraries you must supply the path.R, C, X -R, C, S, W
      source_imageNoneNoneSets the source image name/path. The path must be a relative or absolute -server path, not a URL. 
      dynamic_outputFALSETRUE/FALSE (boolean)Determines whether the new image file should be written to disk or -generated dynamically. Note: If you choose the dynamic setting, only one -image can be shown at a time, and it can’t be positioned on the page. It -simply outputs the raw image dynamically to your browser, along with -image headers.R, C, X, W
      file_permissions0644(integer)File system permissions to apply on the resulting image file, -writing it to the disk. WARNING: Use octal integer notation!R, C, X, W
      quality90%1 - 100%Sets the quality of the image. The higher the quality the larger the -file size.R, C, X, W
      new_imageNoneNoneSets the destination image name/path. You’ll use this preference when -creating an image copy. The path must be a relative or absolute server -path, not a URL.R, C, X, W
      widthNoneNoneSets the width you would like the image set to.R, C
      heightNoneNoneSets the height you would like the image set to.R, C
      create_thumbFALSETRUE/FALSE (boolean)Tells the image processing function to create a thumb.R
      thumb_marker_thumbNoneSpecifies the thumbnail indicator. It will be inserted just before the -file extension, so mypic.jpg would become mypic_thumb.jpgR
      maintain_ratioTRUETRUE/FALSE (boolean)Specifies whether to maintain the original aspect ratio when resizing or -use hard values.R, C
      master_dimautoauto, width, heightSpecifies what to use as the master axis when resizing or creating -thumbs. For example, let’s say you want to resize an image to 100 X 75 -pixels. If the source image size does not allow perfect resizing to -those dimensions, this setting determines which axis should be used as -the hard value. “auto” sets the axis automatically based on whether the -image is taller than wider, or vice versa.R
      rotation_angleNone90, 180, 270, vrt, horSpecifies the angle of rotation when rotating images. Note that PHP -rotates counter-clockwise, so a 90 degree rotation to the right must be -specified as 270.X
      x_axisNoneNoneSets the X coordinate in pixels for image cropping. For example, a -setting of 30 will crop an image 30 pixels from the left.C
      y_axisNoneNoneSets the Y coordinate in pixels for image cropping. For example, a -setting of 30 will crop an image 30 pixels from the top.C
      -
      -
      -

      Setting preferences in a config file

      -

      If you prefer not to set preferences using the above method, you can -instead put them into a config file. Simply create a new file called -image_lib.php, add the $config array in that file. Then save the file -in config/image_lib.php and it will be used automatically. You will -NOT need to use the $this->image_lib->initialize() method if you save -your preferences in a config file.

      -
      -
      -
      -

      Image Watermarking

      -

      The Watermarking feature requires the GD/GD2 library.

      -
      -

      Two Types of Watermarking

      -

      There are two types of watermarking that you can use:

      -
        -
      • Text: The watermark message will be generated using text, either -with a True Type font that you specify, or using the native text -output that the GD library supports. If you use the True Type version -your GD installation must be compiled with True Type support (most -are, but not all).
        • -
      • Overlay: The watermark message will be generated by overlaying an -image (usually a transparent PNG or GIF) containing your watermark -over the source image.
        • -
      -
      -
      -

      Watermarking an Image

      -

      Just as with the other methods (resizing, cropping, and rotating) the -general process for watermarking involves setting the preferences -corresponding to the action you intend to perform, then calling the -watermark function. Here is an example:

      -
      $config['source_image'] = '/path/to/image/mypic.jpg';
-$config['wm_text'] = 'Copyright 2006 - John Doe';
-$config['wm_type'] = 'text';
-$config['wm_font_path'] = './system/fonts/texb.ttf';
-$config['wm_font_size'] = '16';
-$config['wm_font_color'] = 'ffffff';
-$config['wm_vrt_alignment'] = 'bottom';
-$config['wm_hor_alignment'] = 'center';
-$config['wm_padding'] = '20';
-
-$this->image_lib->initialize($config);
-
-$this->image_lib->watermark();
-
      -
      -

      The above example will use a 16 pixel True Type font to create the text -“Copyright 2006 - John Doe”. The watermark will be positioned at the -bottom/center of the image, 20 pixels from the bottom of the image.

      -
      -

      Note

      -

      In order for the image class to be allowed to do any -processing, the image file must have “write” file permissions -For example, 777.

      -
      -
      -
      -

      Watermarking Preferences

      -

      This table shows the preferences that are available for both types of -watermarking (text or overlay)

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefault ValueOptionsDescription
      wm_typetexttext, overlaySets the type of watermarking that should be used.
      source_imageNoneNoneSets the source image name/path. The path must be a relative or absolute -server path, not a URL.
      dynamic_outputFALSETRUE/FALSE (boolean)Determines whether the new image file should be written to disk or -generated dynamically. Note: If you choose the dynamic setting, only one -image can be shown at a time, and it can’t be positioned on the page. It -simply outputs the raw image dynamically to your browser, along with -image headers.
      quality90%1 - 100%Sets the quality of the image. The higher the quality the larger the -file size.
      wm_paddingNoneA numberThe amount of padding, set in pixels, that will be applied to the -watermark to set it away from the edge of your images.
      wm_vrt_alignmentbottomtop, middle, bottomSets the vertical alignment for the watermark image.
      wm_hor_alignmentcenterleft, center, rightSets the horizontal alignment for the watermark image.
      wm_hor_offsetNoneNoneYou may specify a horizontal offset (in pixels) to apply to the -watermark position. The offset normally moves the watermark to the -right, except if you have your alignment set to “right” then your offset -value will move the watermark toward the left of the image.
      wm_vrt_offsetNoneNoneYou may specify a vertical offset (in pixels) to apply to the watermark -position. The offset normally moves the watermark down, except if you -have your alignment set to “bottom” then your offset value will move the -watermark toward the top of the image.
      -
      -

      Text Preferences

      -

      This table shows the preferences that are available for the text type of -watermarking.

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefault ValueOptionsDescription
      wm_textNoneNoneThe text you would like shown as the watermark. Typically this will be a -copyright notice.
      wm_font_pathNoneNoneThe server path to the True Type Font you would like to use. If you do -not use this option, the native GD font will be used.
      wm_font_size16NoneThe size of the text. Note: If you are not using the True Type option -above, the number is set using a range of 1 - 5. Otherwise, you can use -any valid pixel size for the font you’re using.
      wm_font_colorffffffNoneThe font color, specified in hex. Both the full 6-length (ie, 993300) and -the short three character abbreviated version (ie, fff) are supported.
      wm_shadow_colorNoneNoneThe color of the drop shadow, specified in hex. If you leave this blank -a drop shadow will not be used. Both the full 6-length (ie, 993300) and -the short three character abbreviated version (ie, fff) are supported.
      wm_shadow_distance3NoneThe distance (in pixels) from the font that the drop shadow should -appear.
      -
      -
      -

      Overlay Preferences

      -

      This table shows the preferences that are available for the overlay type -of watermarking.

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefault ValueOptionsDescription
      wm_overlay_pathNoneNoneThe server path to the image you wish to use as your watermark. Required -only if you are using the overlay method.
      wm_opacity501 - 100Image opacity. You may specify the opacity (i.e. transparency) of your -watermark image. This allows the watermark to be faint and not -completely obscure the details from the original image behind it. A 50% -opacity is typical.
      wm_x_transp4A numberIf your watermark image is a PNG or GIF image, you may specify a color -on the image to be “transparent”. This setting (along with the next) -will allow you to specify that color. This works by specifying the “X” -and “Y” coordinate pixel (measured from the upper left) within the image -that corresponds to a pixel representative of the color you want to be -transparent.
      wm_y_transp4A numberAlong with the previous setting, this allows you to specify the -coordinate to a pixel representative of the color you want to be -transparent.
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Image_lib
      -
      -
      -initialize([$props = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $props (array) – Image processing preferences
        • -
      -
      Returns:

      TRUE on success, FALSE in case of invalid settings

      -
      Return type:

      bool

      -
      -

      Initializes the class for processing an image.

      -
      - -
      -
      -resize()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      The image resizing method lets you resize the original image, create a -copy (with or without resizing), or create a thumbnail image.

      -

      For practical purposes there is no difference between creating a copy -and creating a thumbnail except a thumb will have the thumbnail marker -as part of the name (i.e. mypic_thumb.jpg).

      -

      All preferences listed in the Preferences table are available for this -method except these three: rotation_angle, x_axis and y_axis.

      -

      Creating a Thumbnail

      -

      The resizing method will create a thumbnail file (and preserve the -original) if you set this preference to TRUE:

      -
      $config['create_thumb'] = TRUE;
-
      -
      -

      This single preference determines whether a thumbnail is created or not.

      -

      Creating a Copy

      -

      The resizing method will create a copy of the image file (and preserve -the original) if you set a path and/or a new filename using this -preference:

      -
      $config['new_image'] = '/path/to/new_image.jpg';
-
      -
      -

      Notes regarding this preference:

      -
        -
      • If only the new image name is specified it will be placed in the same -folder as the original
        • -
      • If only the path is specified, the new image will be placed in the -destination with the same name as the original.
        • -
      • If both the path and image name are specified it will placed in its -own destination and given the new name.
        • -
      -

      Resizing the Original Image

      -

      If neither of the two preferences listed above (create_thumb, and -new_image) are used, the resizing method will instead target the -original image for processing.

      -
      - -
      -
      -crop()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      The cropping method works nearly identically to the resizing function -except it requires that you set preferences for the X and Y axis (in -pixels) specifying where to crop, like this:

      -
      $config['x_axis'] = 100;
-$config['y_axis'] = 40;
-
      -
      -

      All preferences listed in the Preferences table are available for this -method except these: rotation_angle, create_thumb and new_image.

      -

      Here’s an example showing how you might crop an image:

      -
      $config['image_library'] = 'imagemagick';
-$config['library_path'] = '/usr/X11R6/bin/';
-$config['source_image'] = '/path/to/image/mypic.jpg';
-$config['x_axis'] = 100;
-$config['y_axis'] = 60;
-
-$this->image_lib->initialize($config);
-
-if ( ! $this->image_lib->crop())
-{
-        echo $this->image_lib->display_errors();
-}
-
      -
      -
      -

      Note

      -

      Without a visual interface it is difficult to crop images, so this -method is not very useful unless you intend to build such an -interface. That’s exactly what we did using for the photo gallery module -in ExpressionEngine, the CMS we develop. We added a JavaScript UI that -lets the cropping area be selected.

      -
      -
      - -
      -
      -rotate()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      The image rotation method requires that the angle of rotation be set -via its preference:

      -
      $config['rotation_angle'] = '90';
-
      -
      -

      There are 5 rotation options:

      -
        -
      1. 90 - rotates counter-clockwise by 90 degrees.
        2. -
      2. 180 - rotates counter-clockwise by 180 degrees.
        3. -
      3. 270 - rotates counter-clockwise by 270 degrees.
        4. -
      4. hor - flips the image horizontally.
        5. -
      5. vrt - flips the image vertically.
        6. -
      -

      Here’s an example showing how you might rotate an image:

      -
      $config['image_library'] = 'netpbm';
-$config['library_path'] = '/usr/bin/';
-$config['source_image'] = '/path/to/image/mypic.jpg';
-$config['rotation_angle'] = 'hor';
-
-$this->image_lib->initialize($config);
-
-if ( ! $this->image_lib->rotate())
-{
-        echo $this->image_lib->display_errors();
-}
-
      -
      -
      - -
      -
      -watermark()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      Creates a watermark over an image, please refer to the Watermarking an Image -section for more info.

      -
      - -
      -
      -clear()
      -
      --- - - - -
      Return type:void
      -

      The clear method resets all of the values used when processing an -image. You will want to call this if you are processing images in a -loop.

      -
      $this->image_lib->clear();
-
      -
      -
      - -
      -
      -display_errors([$open = '<p>[, $close = '</p>']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $open (string) – Error message opening tag
        • -
      • $close (string) – Error message closing tag
        • -
      -
      Returns:

      Error messages

      -
      Return type:

      string

      -
      -

      Returns all detected errors formatted as a string.

      -
      echo $this->image_lib->diplay_errors();
-
      -
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/index.html b/user_guide/libraries/index.html deleted file mode 100755 index 32a3aec..0000000 --- a/user_guide/libraries/index.html +++ /dev/null @@ -1,588 +0,0 @@ - - - - - - - - - - Libraries — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - - - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/input.html b/user_guide/libraries/input.html deleted file mode 100755 index 7734332..0000000 --- a/user_guide/libraries/input.html +++ /dev/null @@ -1,1192 +0,0 @@ - - - - - - - - - - Input Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Input Class

      -

      The Input Class serves two purposes:

      -
        -
      1. It pre-processes global input data for security.
        2. -
      2. It provides some helper methods for fetching input data and pre-processing it.
        3. -
      -
      -

      Note

      -

      This class is initialized automatically by the system so there -is no need to do it manually.

      -
      - -
      -

      Input Filtering

      -
      -

      Security Filtering

      -

      The security filtering method is called automatically when a new -controller is invoked. It does the -following:

      -
        -
      • If $config['allow_get_array'] is FALSE (default is TRUE), destroys -the global GET array.
        • -
      • Destroys all global variables in the event register_globals is -turned on.
        • -
      • Filters the GET/POST/COOKIE array keys, permitting only alpha-numeric -(and a few other) characters.
        • -
      • Provides XSS (Cross-site Scripting Hacks) filtering. This can be -enabled globally, or upon request.
        • -
      • Standardizes newline characters to PHP_EOL (\n in UNIX-based OSes, -\r\n under Windows). This is configurable.
        • -
      -
      -
      -

      XSS Filtering

      -

      The Input class has the ability to filter input automatically to prevent -cross-site scripting attacks. If you want the filter to run -automatically every time it encounters POST or COOKIE data you can -enable it by opening your application/config/config.php file and setting -this:

      -
      $config['global_xss_filtering'] = TRUE;
-
      -
      -

      Please refer to the Security class documentation for -information on using XSS Filtering in your application.

      -
      -

      Important

      -

      The ‘global_xss_filtering’ setting is DEPRECATED and kept -solely for backwards-compatibility purposes. XSS escaping should -be performed on output, not input!

      -
      -
      -
      -
      -

      Accessing form data

      -
      -

      Using POST, GET, COOKIE, or SERVER Data

      -

      CodeIgniter comes with helper methods that let you fetch POST, GET, -COOKIE or SERVER items. The main advantage of using the provided -methods rather than fetching an item directly ($_POST['something']) -is that the methods will check to see if the item is set and return -NULL if not. This lets you conveniently use data without -having to test whether an item exists first. In other words, normally -you might do something like this:

      -
      $something = isset($_POST['something']) ? $_POST['something'] : NULL;
-
      -
      -

      With CodeIgniter’s built in methods you can simply do this:

      -
      $something = $this->input->post('something');
-
      -
      -

      The main methods are:

      -
        -
      • $this->input->post()
        • -
      • $this->input->get()
        • -
      • $this->input->cookie()
        • -
      • $this->input->server()
        • -
      -
      -
      -

      Using the php://input stream

      -

      If you want to utilize the PUT, DELETE, PATCH or other exotic request -methods, they can only be accessed via a special input stream, that -can only be read once. This isn’t as easy as just reading from e.g. -the $_POST array, because it will always exist and you can try -and access multiple variables without caring that you might only have -one shot at all of the POST data.

      -

      CodeIgniter will take care of that for you, and you can read the data -from the php://input stream at any time, just by using the -$raw_input_stream property:

      -
      $this->input->raw_input_stream;
-
      -
      -

      Additionally if the input stream is form-encoded like $_POST you can -access its values by calling the -input_stream() method:

      -
      $this->input->input_stream('key');
-
      -
      -

      Similar to other methods such as get() and post(), if the -requested data is not found, it will return NULL and you can also -decide whether to run the data through xss_clean() by passing -a boolean value as the second parameter:

      -
      $this->input->input_stream('key', TRUE); // XSS Clean
-$this->input->input_stream('key', FALSE); // No XSS filter
-
      -
      -
      -

      Note

      -

      You can utilize method() in order to know if you’re reading -PUT, DELETE or PATCH data.

      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Input
      -
      -
      -$raw_input_stream
      -

      Read only property that will return php://input data as is.

      -

      The property can be read multiple times.

      -
      - -
      -
      -post([$index = NULL[, $xss_clean = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $index (mixed) – POST parameter name
        • -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Returns:

      $_POST if no parameters supplied, otherwise the POST value if found or NULL if not

      -
      Return type:

      mixed

      -
      -

      The first parameter will contain the name of the POST item you are -looking for:

      -
      $this->input->post('some_data');
-
      -
      -

      The method returns NULL if the item you are attempting to retrieve -does not exist.

      -

      The second optional parameter lets you run the data through the XSS -filter. It’s enabled by setting the second parameter to boolean TRUE -or by setting your $config['global_xss_filtering'] to TRUE.

      -
      $this->input->post('some_data', TRUE);
-
      -
      -

      To return an array of all POST items call without any parameters.

      -

      To return all POST items and pass them through the XSS filter set the -first parameter NULL while setting the second parameter to boolean TRUE.

      -
      $this->input->post(NULL, TRUE); // returns all POST items with XSS filter
-$this->input->post(NULL, FALSE); // returns all POST items without XSS filter
-
      -
      -

      To return an array of multiple POST parameters, pass all the required keys -as an array.

      -
      $this->input->post(array('field1', 'field2'));
-
      -
      -

      Same rule applied here, to retrive the parameters with XSS filtering enabled, set the -second parameter to boolean TRUE.

      -
      $this->input->post(array('field1', 'field2'), TRUE);
-
      -
      -
      - -
      -
      -get([$index = NULL[, $xss_clean = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $index (mixed) – GET parameter name
        • -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Returns:

      $_GET if no parameters supplied, otherwise the GET value if found or NULL if not

      -
      Return type:

      mixed

      -
      -

      This method is identical to post(), only it fetches GET data.

      -
      $this->input->get('some_data', TRUE);
-
      -
      -

      To return an array of all GET items call without any parameters.

      -

      To return all GET items and pass them through the XSS filter set the -first parameter NULL while setting the second parameter to boolean TRUE.

      -
      $this->input->get(NULL, TRUE); // returns all GET items with XSS filter
-$this->input->get(NULL, FALSE); // returns all GET items without XSS filtering
-
      -
      -

      To return an array of multiple GET parameters, pass all the required keys -as an array.

      -
      $this->input->get(array('field1', 'field2'));
-
      -
      -

      Same rule applied here, to retrive the parameters with XSS filtering enabled, set the -second parameter to boolean TRUE.

      -
      $this->input->get(array('field1', 'field2'), TRUE);
-
      -
      -
      - -
      -
      -post_get($index[, $xss_clean = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $index (string) – POST/GET parameter name
        • -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Returns:

      POST/GET value if found, NULL if not

      -
      Return type:

      mixed

      -
      -

      This method works pretty much the same way as post() and get(), -only combined. It will search through both POST and GET streams for data, -looking in POST first, and then in GET:

      -
      $this->input->post_get('some_data', TRUE);
-
      -
      -
      - -
      -
      -get_post($index[, $xss_clean = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $index (string) – GET/POST parameter name
        • -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Returns:

      GET/POST value if found, NULL if not

      -
      Return type:

      mixed

      -
      -

      This method works the same way as post_get() only it looks for GET -data first.

      -
      -
      $this->input->get_post(‘some_data’, TRUE);
      -
      -

      Note

      -

      This method used to act EXACTLY like post_get(), but it’s -behavior has changed in CodeIgniter 3.0.

      -
      -
      - -
      -
      -cookie([$index = NULL[, $xss_clean = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $index (mixed) – COOKIE name
        • -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Returns:

      $_COOKIE if no parameters supplied, otherwise the COOKIE value if found or NULL if not

      -
      Return type:

      mixed

      -
      -

      This method is identical to post() and get(), only it fetches cookie -data:

      -
      $this->input->cookie('some_cookie');
-$this->input->cookie('some_cookie, TRUE); // with XSS filter
-
      -
      -

      To return an array of multiple cookie values, pass all the required keys -as an array.

      -
      $this->input->cookie(array('some_cookie', 'some_cookie2'));
-
      -
      -
      -

      Note

      -

      Unlike the Cookie Helper -function get_cookie(), this method does NOT prepend -your configured $config['cookie_prefix'] value.

      -
      -
      - -
      -
      -server($index[, $xss_clean = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $index (mixed) – Value name
        • -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Returns:

      $_SERVER item value if found, NULL if not

      -
      Return type:

      mixed

      -
      -

      This method is identical to the post(), get() and cookie() -methods, only it fetches server data ($_SERVER):

      -
      $this->input->server('some_data');
-
      -
      -

      To return an array of multiple $_SERVER values, pass all the required keys -as an array.

      -
      $this->input->server(array('SERVER_PROTOCOL', 'REQUEST_URI'));
-
      -
      -
      - -
      -
      -input_stream([$index = NULL[, $xss_clean = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $index (mixed) – Key name
        • -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Returns:

      Input stream array if no parameters supplied, otherwise the specified value if found or NULL if not

      -
      Return type:

      mixed

      -
      -

      This method is identical to get(), post() and cookie(), -only it fetches the php://input stream data.

      -
      - -
      - -
      --- - - - - - -
      Parameters:
        -
      • $name (mixed) – Cookie name or an array of parameters
        • -
      • $value (string) – Cookie value
        • -
      • $expire (int) – Cookie expiration time in seconds
        • -
      • $domain (string) – Cookie domain
        • -
      • $path (string) – Cookie path
        • -
      • $prefix (string) – Cookie name prefix
        • -
      • $secure (bool) – Whether to only transfer the cookie through HTTPS
        • -
      • $httponly (bool) – Whether to only make the cookie accessible for HTTP requests (no JavaScript)
        • -
      -
      Return type:

      void

      -
      -

      Sets a cookie containing the values you specify. There are two ways to -pass information to this method so that a cookie can be set: Array -Method, and Discrete Parameters:

      -

      Array Method

      -

      Using this method, an associative array is passed to the first -parameter:

      -
      $cookie = array(
-        'name'   => 'The Cookie Name',
-        'value'  => 'The Value',
-        'expire' => '86500',
-        'domain' => '.some-domain.com',
-        'path'   => '/',
-        'prefix' => 'myprefix_',
-        'secure' => TRUE
-);
-
-$this->input->set_cookie($cookie);
-
      -
      -

      Notes

      -

      Only the name and value are required. To delete a cookie set it with the -expiration blank.

      -

      The expiration is set in seconds, which will be added to the current -time. Do not include the time, but rather only the number of seconds -from now that you wish the cookie to be valid. If the expiration is -set to zero the cookie will only last as long as the browser is open.

      -

      For site-wide cookies regardless of how your site is requested, add your -URL to the domain starting with a period, like this: -.your-domain.com

      -

      The path is usually not needed since the method sets a root path.

      -

      The prefix is only needed if you need to avoid name collisions with -other identically named cookies for your server.

      -

      The secure boolean is only needed if you want to make it a secure cookie -by setting it to TRUE.

      -

      Discrete Parameters

      -

      If you prefer, you can set the cookie by passing data using individual -parameters:

      -
      $this->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure);
-
      -
      -
      - -
      -
      -ip_address()
      -
      --- - - - - - -
      Returns:Visitor’s IP address or ‘0.0.0.0’ if not valid
      Return type:string
      -

      Returns the IP address for the current user. If the IP address is not -valid, the method will return ‘0.0.0.0’:

      -
      echo $this->input->ip_address();
-
      -
      -
      -

      Important

      -

      This method takes into account the $config['proxy_ips'] -setting and will return the reported HTTP_X_FORWARDED_FOR, -HTTP_CLIENT_IP, HTTP_X_CLIENT_IP or HTTP_X_CLUSTER_CLIENT_IP -address for the allowed IP addresses.

      -
      -
      - -
      -
      -valid_ip($ip[, $which = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $ip (string) – IP address
        • -
      • $which (string) – IP protocol (‘ipv4’ or ‘ipv6’)
        • -
      -
      Returns:

      TRUE if the address is valid, FALSE if not

      -
      Return type:

      bool

      -
      -

      Takes an IP address as input and returns TRUE or FALSE (boolean) depending -on whether it is valid or not.

      -
      -

      Note

      -

      The $this->input->ip_address() method above automatically -validates the IP address.

      -
      -
      if ( ! $this->input->valid_ip($ip))
-{
-        echo 'Not Valid';
-}
-else
-{
-        echo 'Valid';
-}
-
      -
      -

      Accepts an optional second string parameter of ‘ipv4’ or ‘ipv6’ to specify -an IP format. The default checks for both formats.

      -
      - -
      -
      -user_agent([$xss_clean = NULL])
      -
      --- - - - - - - - -
      Returns:

      User agent string or NULL if not set

      -
      Parameters:
        -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Return type:

      mixed

      -
      -

      Returns the user agent string (web browser) being used by the current user, -or NULL if it’s not available.

      -
      echo $this->input->user_agent();
-
      -
      -

      See the User Agent Class for methods which extract -information from the user agent string.

      -
      - -
      -
      -request_headers([$xss_clean = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Returns:

      An array of HTTP request headers

      -
      Return type:

      array

      -
      -

      Returns an array of HTTP request headers. -Useful if running in a non-Apache environment where -apache_request_headers() -will not be supported.

      -
      $headers = $this->input->request_headers();
-
      -
      -
      - -
      -
      -get_request_header($index[, $xss_clean = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $index (string) – HTTP request header name
        • -
      • $xss_clean (bool) – Whether to apply XSS filtering
        • -
      -
      Returns:

      An HTTP request header or NULL if not found

      -
      Return type:

      string

      -
      -

      Returns a single member of the request headers array or NULL -if the searched header is not found.

      -
      $this->input->get_request_header('some-header', TRUE);
-
      -
      -
      - -
      -
      -is_ajax_request()
      -
      --- - - - - - -
      Returns:TRUE if it is an Ajax request, FALSE if not
      Return type:bool
      -

      Checks to see if the HTTP_X_REQUESTED_WITH server header has been -set, and returns boolean TRUE if it is or FALSE if not.

      -
      - -
      -
      -is_cli_request()
      -
      --- - - - - - -
      Returns:TRUE if it is a CLI request, FALSE if not
      Return type:bool
      -

      Checks to see if the application was run from the command-line -interface.

      -
      -

      Note

      -

      This method checks both the PHP SAPI name currently in use -and if the STDIN constant is defined, which is usually a -failsafe way to see if PHP is being run via the command line.

      -
      -
      $this->input->is_cli_request()
-
      -
      -
      -

      Note

      -

      This method is DEPRECATED and is now just an alias for the -is_cli() function.

      -
      -
      - -
      -
      -method([$upper = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $upper (bool) – Whether to return the request method name in upper or lower case
        • -
      -
      Returns:

      HTTP request method

      -
      Return type:

      string

      -
      -

      Returns the $_SERVER['REQUEST_METHOD'], with the option to set it -in uppercase or lowercase.

      -
      echo $this->input->method(TRUE); // Outputs: POST
-echo $this->input->method(FALSE); // Outputs: post
-echo $this->input->method(); // Outputs: post
-
      -
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/javascript.html b/user_guide/libraries/javascript.html deleted file mode 100755 index 66b2cbf..0000000 --- a/user_guide/libraries/javascript.html +++ /dev/null @@ -1,803 +0,0 @@ - - - - - - - - - - Javascript Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Javascript Class

      -

      CodeIgniter provides a library to help you with certain common functions -that you may want to use with Javascript. Please note that CodeIgniter -does not require the jQuery library to run, and that any scripting -library will work equally well. The jQuery library is simply presented -as a convenience if you choose to use it.

      -
      -

      Important

      -

      This library is DEPRECATED and should not be used. It has always -been with an ‘experimental’ status and is now no longer supported. -Currently only kept for backwards compatibility.

      -
      - -
      -

      Using the Javascript Class

      -
      -

      Initializing the Class

      -

      To initialize the Javascript class manually in your controller -constructor, use the $this->load->library() method. Currently, -the only available library is jQuery, which will automatically be -loaded like this:

      -
      $this->load->library('javascript');
-
      -
      -

      The Javascript class also accepts parameters:

      -
        -
      • js_library_driver (string) default: ‘jquery’
        • -
      • autoload (bool) default: TRUE
        • -
      -

      You may override the defaults by sending an associative array:

      -
      $this->load->library(
-        'javascript',
-        array(
-                'js_library_driver' => 'scripto',
-                'autoload' => FALSE
-        )
-);
-
      -
      -

      Again, presently only ‘jquery’ is available. You may wish to set -autoload to FALSE, though, if you do not want the jQuery library to -automatically include a script tag for the main jQuery script file. This -is useful if you are loading it from a location outside of CodeIgniter, -or already have the script tag in your markup.

      -

      Once loaded, the jQuery library object will be available using:

      -
      -
      $this->javascript
      -
      -
      -

      Setup and Configuration

      -
      -

      Set these variables in your view

      -

      As a Javascript library, your files must be available to your -application.

      -

      As Javascript is a client side language, the library must be able to -write content into your final output. This generally means a view. -You’ll need to include the following variables in the <head> -sections of your output.

      -
      <?php echo $library_src;?>
-<?php echo $script_head;?>
-
      -
      -

      $library_src, is where the actual library file will be loaded, as -well as any subsequent plugin script calls; $script_head is where -specific events, functions and other commands will be rendered.

      -
      -
      -

      Set the path to the librarys with config items

      -

      There are some configuration items in Javascript library. These can -either be set in application/config.php, within its own -config/javascript.php file, or within any controller usings the -set_item() function.

      -

      An image to be used as an “ajax loader”, or progress indicator. Without -one, the simple text message of “loading” will appear when Ajax calls -need to be made.

      -
      $config['javascript_location'] = 'http://localhost/codeigniter/themes/js/jquery/';
-$config['javascript_ajax_img'] = 'images/ajax-loader.gif';
-
      -
      -

      If you keep your files in the same directories they were downloaded -from, then you need not set this configuration items.

      -
      -
      -
      -

      The jQuery Class

      -

      To initialize the jQuery class manually in your controller constructor, -use the $this->load->library() method:

      -
      $this->load->library('javascript/jquery');
-
      -
      -

      You may send an optional parameter to determine whether or not a script -tag for the main jQuery file will be automatically included when loading -the library. It will be created by default. To prevent this, load the -library as follows:

      -
      $this->load->library('javascript/jquery', FALSE);
-
      -
      -

      Once loaded, the jQuery library object will be available using:

      -
      -
      $this->jquery
      -
      -
      -

      jQuery Events

      -

      Events are set using the following syntax.

      -
      $this->jquery->event('element_path', code_to_run());
-
      -
      -

      In the above example:

      -
        -
      • “event” is any of blur, change, click, dblclick, error, focus, hover, -keydown, keyup, load, mousedown, mouseup, mouseover, mouseup, resize, -scroll, or unload.
        • -
      • “element_path” is any valid jQuery selector. Due to jQuery’s unique -selector syntax, this is usually an element id, or CSS selector. For -example “#notice_area” would effect <div id="notice_area">, and -“#content a.notice” would effect all anchors with a class of “notice” -in the div with id “content”.
        • -
      • “code_to_run()” is script your write yourself, or an action such as -an effect from the jQuery library below.
        • -
      -
      -
      -

      Effects

      -

      The query library supports a powerful -Effects repertoire. Before an effect -can be used, it must be loaded:

      -
      $this->jquery->effect([optional path] plugin name); // for example $this->jquery->effect('bounce');
-
      -
      -
      -

      hide() / show()

      -

      Each of this functions will affect the visibility of an item on your -page. hide() will set an item invisible, show() will reveal it.

      -
      $this->jquery->hide(target, optional speed, optional extra information);
-$this->jquery->show(target, optional speed, optional extra information);
-
      -
      -
        -
      • “target” will be any valid jQuery selector or selectors.
        • -
      • “speed” is optional, and is set to either slow, normal, fast, or -alternatively a number of milliseconds.
        • -
      • “extra information” is optional, and could include a callback, or -other additional information.
        • -
      -
      -
      -

      toggle()

      -

      toggle() will change the visibility of an item to the opposite of its -current state, hiding visible elements, and revealing hidden ones.

      -
      $this->jquery->toggle(target);
-
      -
      -
        -
      • “target” will be any valid jQuery selector or selectors.
        • -
      -
      -
      -

      animate()

      -
      $this->jquery->animate(target, parameters, optional speed, optional extra information);
-
      -
      -
        -
      • “target” will be any valid jQuery selector or selectors.
        • -
      • “parameters” in jQuery would generally include a series of CSS -properties that you wish to change.
        • -
      • “speed” is optional, and is set to either slow, normal, fast, or -alternatively a number of milliseconds.
        • -
      • “extra information” is optional, and could include a callback, or -other additional information.
        • -
      -

      For a full summary, see -http://api.jquery.com/animate/

      -

      Here is an example of an animate() called on a div with an id of “note”, -and triggered by a click using the jQuery library’s click() event.

      -
      $params = array(
-'height' => 80,
-'width' => '50%',
-'marginLeft' => 125
-);
-$this->jquery->click('#trigger', $this->jquery->animate('#note', $params, 'normal'));
-
      -
      -
      -
      -

      fadeIn() / fadeOut()

      -
      $this->jquery->fadeIn(target,  optional speed, optional extra information);
-$this->jquery->fadeOut(target,  optional speed, optional extra information);
-
      -
      -
        -
      • “target” will be any valid jQuery selector or selectors.
        • -
      • “speed” is optional, and is set to either slow, normal, fast, or -alternatively a number of milliseconds.
        • -
      • “extra information” is optional, and could include a callback, or -other additional information.
        • -
      -
      -
      -

      toggleClass()

      -

      This function will add or remove a CSS class to its target.

      -
      $this->jquery->toggleClass(target, class)
-
      -
      -
        -
      • “target” will be any valid jQuery selector or selectors.
        • -
      • “class” is any CSS classname. Note that this class must be defined -and available in a CSS that is already loaded.
        • -
      -
      -
      -

      fadeIn() / fadeOut()

      -

      These effects cause an element(s) to disappear or reappear over time.

      -
      $this->jquery->fadeIn(target,  optional speed, optional extra information);
-$this->jquery->fadeOut(target,  optional speed, optional extra information);
-
      -
      -
        -
      • “target” will be any valid jQuery selector or selectors.
        • -
      • “speed” is optional, and is set to either slow, normal, fast, or -alternatively a number of milliseconds.
        • -
      • “extra information” is optional, and could include a callback, or -other additional information.
        • -
      -
      -
      -

      slideUp() / slideDown() / slideToggle()

      -

      These effects cause an element(s) to slide.

      -
      $this->jquery->slideUp(target,  optional speed, optional extra information);
-$this->jquery->slideDown(target,  optional speed, optional extra information);
-$this->jquery->slideToggle(target,  optional speed, optional extra information);
-
      -
      -
        -
      • “target” will be any valid jQuery selector or selectors.
        • -
      • “speed” is optional, and is set to either slow, normal, fast, or -alternatively a number of milliseconds.
        • -
      • “extra information” is optional, and could include a callback, or -other additional information.
        • -
      -
      -
      -
      -

      Plugins

      -

      Some select jQuery plugins are made available using this library.

      -
      -

      corner()

      -

      Used to add distinct corners to page elements. For full details see -http://malsup.com/jquery/corner/

      -
      $this->jquery->corner(target, corner_style);
-
      -
      -
        -
      • “target” will be any valid jQuery selector or selectors.
        • -
      • “corner_style” is optional, and can be set to any valid style such -as round, sharp, bevel, bite, dog, etc. Individual corners can be set -by following the style with a space and using “tl” (top left), “tr” -(top right), “bl” (bottom left), or “br” (bottom right).
        • -
      -
      $this->jquery->corner("#note", "cool tl br");
-
      -
      -
      -
      -

      tablesorter()

      -

      description to come

      -
      - -
      -

      calendar()

      -

      description to come

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/language.html b/user_guide/libraries/language.html deleted file mode 100755 index 119be14..0000000 --- a/user_guide/libraries/language.html +++ /dev/null @@ -1,734 +0,0 @@ - - - - - - - - - - Language Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Language Class

      -

      The Language Class provides functions to retrieve language files and -lines of text for purposes of internationalization.

      -

      In your CodeIgniter system folder, you will find a language sub-directory -containing a set of language files for the english idiom. -The files in this directory (system/language/english/) define the regular messages, -error messages, and other generally output terms or expressions, for the different parts -of the CodeIgniter framework.

      -

      You can create or incorporate your own language files, as needed, in order to provide -application-specific error and other messages, or to provide translations of the core -messages into other languages. These translations or additional messages would go inside -your application/language/ directory, with separate sub-directories for each idiom -(for instance, ‘french’ or ‘german’).

      -

      The CodeIgniter framework comes with a set of language files for the “english” idiom. -Additional approved translations for different idioms may be found in the -CodeIgniter 3 Translations repositories. -Each repository deals with a single idiom.

      -

      When CodeIgniter loads language files, it will load the one in system/language/ -first and will then look for an override in your application/language/ directory.

      -
      -

      Note

      -

      Each language should be stored in its own folder. For example, -the English files are located at: system/language/english

      -
      - -
      -

      Handling Multiple Languages

      -

      If you want to support multiple languages in your application, you would provide folders inside -your application/language/ directory for each of them, and you would specify the default -language in your application/config/config.php.

      -

      The application/language/english/ directory would contain any additional language files -needed by your application, for instance for error messages.

      -

      Each of the other idiom-specific directories would contain the core language files that you -obtained from the translations repositories, or that you translated yourself, as well as -any additional ones needed by your application.

      -

      You would store the language you are currently using, for instance in a session variable.

      -
      -

      Sample Language Files

      -
      system/
-        language/
-                english/
-                        ...
-                        email_lang.php
-                        form_validation_lang.php
-                        ...
-
-application/
-        language/
-                english/
-                        error_messages_lang.php
-                french/
-                        ...
-                        email_lang.php
-                        error_messages_lang.php
-                        form_validation_lang.php
-                        ...
-
      -
      -
      -
      -

      Example of switching languages

      -
      $idiom = $this->session->get_userdata('language');
-$this->lang->load('error_messages', $idiom);
-$oops = $this->lang->line('message_key');
-
      -
      -
      -
      -
      -

      Internationalization

      -

      The Language class in CodeIgniter is meant to provide an easy and lightweight -way to support multiplelanguages in your application. It is not meant to be a -full implementation of what is commonly called internationalization and localization.

      -

      We use the term “idiom” to refer to a language using its common name, -rather than using any of the international standards, such as “en”, “en-US”, -or “en-CA-x-ca” for English and some of its variants.

      -
      -

      Note

      -

      There is nothing to prevent you from using those abbreviations in your application!

      -
      -
      -
      -

      Using the Language Class

      -
      -

      Creating Language Files

      -

      Language files must be named with _lang.php as the filename extension. -For example, let’s say you want to create a file containing error messages. -You might name it: error_lang.php

      -

      Within the file you will assign each line of text to an array called -$lang with this prototype:

      -
      $lang['language_key'] = 'The actual message to be shown';
-
      -
      -
      -

      Note

      -

      It’s a good practice to use a common prefix for all messages -in a given file to avoid collisions with similarly named items in other -files. For example, if you are creating error messages you might prefix -them with error_

      -
      -
      $lang['error_email_missing'] = 'You must submit an email address';
-$lang['error_url_missing'] = 'You must submit a URL';
-$lang['error_username_missing'] = 'You must submit a username';
-
      -
      -
      -
      -

      Loading A Language File

      -

      In order to fetch a line from a particular file you must load the file -first. Loading a language file is done with the following code:

      -
      $this->lang->load('filename', 'language');
-
      -
      -

      Where filename is the name of the file you wish to load (without the -file extension), and language is the language set containing it (ie, -english). If the second parameter is missing, the default language set -in your application/config/config.php file will be used.

      -

      You can also load multiple language files at the same time by passing an array of language files as first parameter.

      -
      $this->lang->load(array('filename1', 'filename2'));
-
      -
      -
      -

      Note

      -

      The language parameter can only consist of letters.

      -
      -
      -
      -

      Fetching a Line of Text

      -

      Once your desired language file is loaded you can access any line of -text using this function:

      -
      $this->lang->line('language_key');
-
      -
      -

      Where language_key is the array key corresponding to the line you wish -to show.

      -

      You can optionally pass FALSE as the second argument of that method to -disable error logging, in case you’re not sure if the line exists:

      -
      $this->lang->line('misc_key', FALSE);
-
      -
      -
      -

      Note

      -

      This method simply returns the line. It does not echo it.

      -
      -
      -

      Using language lines as form labels

      -

      This feature has been deprecated from the language library and moved to -the lang() function of the Language Helper.

      -
      -
      -
      -

      Auto-loading Languages

      -

      If you find that you need a particular language globally throughout your -application, you can tell CodeIgniter to auto-load it during system initialization. This is done -by opening the application/config/autoload.php file and adding the -language(s) to the autoload array.

      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Lang
      -
      -
      -load($langfile[, $idiom = ''[, $return = FALSE[, $add_suffix = TRUE[, $alt_path = '']]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $langfile (mixed) – Language file to load or array with multiple files
        • -
      • $idiom (string) – Language name (i.e. ‘english’)
        • -
      • $return (bool) – Whether to return the loaded array of translations
        • -
      • $add_suffix (bool) – Whether to add the ‘_lang’ suffix to the language file name
        • -
      • $alt_path (string) – An alternative path to look in for the language file
        • -
      -
      Returns:

      Array of language lines if $return is set to TRUE, otherwise void

      -
      Return type:

      mixed

      -
      -

      Loads a language file.

      -
      - -
      -
      -line($line[, $log_errors = TRUE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $line (string) – Language line key name
        • -
      • $log_errors (bool) – Whether to log an error if the line isn’t found
        • -
      -
      Returns:

      Language line string or FALSE on failure

      -
      Return type:

      string

      -
      -

      Fetches a single translation line from the already loaded language files, -based on the line’s name.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/loader.html b/user_guide/libraries/loader.html deleted file mode 100755 index 5203621..0000000 --- a/user_guide/libraries/loader.html +++ /dev/null @@ -1,1214 +0,0 @@ - - - - - - - - - - Loader Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Loader Class

      -

      Loader, as the name suggests, is used to load elements. These elements -can be libraries (classes) View files, -Drivers, -Helpers, -Models, or your own files.

      -
      -

      Note

      -

      This class is initialized automatically by the system so there -is no need to do it manually.

      -
      - -
      -

      Application “Packages”

      -

      An application package allows for the easy distribution of complete sets -of resources in a single directory, complete with its own libraries, -models, helpers, config, and language files. It is recommended that -these packages be placed in the application/third_party directory. Below -is a sample map of an package directory.

      -

      The following is an example of a directory for an application package -named “Foo Bar”.

      -
      /application/third_party/foo_bar
-
-config/
-helpers/
-language/
-libraries/
-models/
-
      -
      -

      Whatever the purpose of the “Foo Bar” application package, it has its -own config files, helpers, language files, libraries, and models. To use -these resources in your controllers, you first need to tell the Loader -that you are going to be loading resources from a package, by adding the -package path via the add_package_path() method.

      -
      -

      Package view files

      -

      By Default, package view files paths are set when add_package_path() -is called. View paths are looped through, and once a match is -encountered that view is loaded.

      -

      In this instance, it is possible for view naming collisions within -packages to occur, and possibly the incorrect package being loaded. To -ensure against this, set an optional second parameter of FALSE when -calling add_package_path().

      -
      $this->load->add_package_path(APPPATH.'my_app', FALSE);
-$this->load->view('my_app_index'); // Loads
-$this->load->view('welcome_message'); // Will not load the default welcome_message b/c the second param to add_package_path is FALSE
-
-// Reset things
-$this->load->remove_package_path(APPPATH.'my_app');
-
-// Again without the second parameter:
-$this->load->add_package_path(APPPATH.'my_app');
-$this->load->view('my_app_index'); // Loads
-$this->load->view('welcome_message'); // Loads
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Loader
      -
      -
      -library($library[, $params = NULL[, $object_name = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $library (mixed) – Library name as a string or an array with multiple libraries
        • -
      • $params (array) – Optional array of parameters to pass to the loaded library’s constructor
        • -
      • $object_name (string) – Optional object name to assign the library to
        • -
      -
      Returns:

      CI_Loader instance (method chaining)

      -
      Return type:

      CI_Loader

      -
      -

      This method is used to load core classes.

      -
      -

      Note

      -

      We use the terms “class” and “library” interchangeably.

      -
      -

      For example, if you would like to send email with CodeIgniter, the first -step is to load the email class within your controller:

      -
      $this->load->library('email');
-
      -
      -

      Once loaded, the library will be ready for use, using $this->email.

      -

      Library files can be stored in subdirectories within the main -“libraries” directory, or within your personal application/libraries -directory. To load a file located in a subdirectory, simply include the -path, relative to the “libraries” directory. For example, if you have -file located at:

      -
      libraries/flavors/Chocolate.php
-
      -
      -

      You will load it using:

      -
      $this->load->library('flavors/chocolate');
-
      -
      -

      You may nest the file in as many subdirectories as you want.

      -

      Additionally, multiple libraries can be loaded at the same time by -passing an array of libraries to the load method.

      -
      $this->load->library(array('email', 'table'));
-
      -
      -

      Setting options

      -

      The second (optional) parameter allows you to optionally pass -configuration setting. You will typically pass these as an array:

      -
      $config = array (
-        'mailtype' => 'html',
-        'charset'  => 'utf-8,
-        'priority' => '1'
-);
-
-$this->load->library('email', $config);
-
      -
      -

      Config options can usually also be set via a config file. Each library -is explained in detail in its own page, so please read the information -regarding each one you would like to use.

      -

      Please take note, when multiple libraries are supplied in an array for -the first parameter, each will receive the same parameter information.

      -

      Assigning a Library to a different object name

      -

      If the third (optional) parameter is blank, the library will usually be -assigned to an object with the same name as the library. For example, if -the library is named Calendar, it will be assigned to a variable named -$this->calendar.

      -

      If you prefer to set your own class names you can pass its value to the -third parameter:

      -
      $this->load->library('calendar', NULL, 'my_calendar');
-
-// Calendar class is now accessed using:
-$this->my_calendar
-
      -
      -

      Please take note, when multiple libraries are supplied in an array for -the first parameter, this parameter is discarded.

      -
      - -
      -
      -driver($library[, $params = NULL[, $object_name]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $library (mixed) – Library name as a string or an array with multiple libraries
        • -
      • $params (array) – Optional array of parameters to pass to the loaded library’s constructor
        • -
      • $object_name (string) – Optional object name to assign the library to
        • -
      -
      Returns:

      CI_Loader instance (method chaining)

      -
      Return type:

      CI_Loader

      -
      -

      This method is used to load driver libraries, acts very much like the -library() method.

      -

      As an example, if you would like to use sessions with CodeIgniter, the first -step is to load the session driver within your controller:

      -
      $this->load->driver('session');
-
      -
      -

      Once loaded, the library will be ready for use, using $this->session.

      -

      Driver files must be stored in a subdirectory within the main -“libraries” directory, or within your personal application/libraries -directory. The subdirectory must match the parent class name. Read the -Drivers description for details.

      -

      Additionally, multiple driver libraries can be loaded at the same time by -passing an array of drivers to the load method.

      -
      $this->load->driver(array('session', 'cache'));
-
      -
      -

      Setting options

      -

      The second (optional) parameter allows you to optionally pass -configuration settings. You will typically pass these as an array:

      -
      $config = array(
-        'sess_driver' => 'cookie',
-        'sess_encrypt_cookie'  => true,
-        'encryption_key' => 'mysecretkey'
-);
-
-$this->load->driver('session', $config);
-
      -
      -

      Config options can usually also be set via a config file. Each library -is explained in detail in its own page, so please read the information -regarding each one you would like to use.

      -

      Assigning a Driver to a different object name

      -

      If the third (optional) parameter is blank, the library will be assigned -to an object with the same name as the parent class. For example, if -the library is named Session, it will be assigned to a variable named -$this->session.

      -

      If you prefer to set your own class names you can pass its value to the -third parameter:

      -
      $this->load->library('session', '', 'my_session');
-
-// Session class is now accessed using:
-$this->my_session
-
      -
      -
      - -
      -
      -view($view[, $vars = array()[, return = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $view (string) – View name
        • -
      • $vars (array) – An associative array of variables
        • -
      • $return (bool) – Whether to return the loaded view
        • -
      -
      Returns:

      View content string if $return is set to TRUE, otherwise CI_Loader instance (method chaining)

      -
      Return type:

      mixed

      -
      -

      This method is used to load your View files. If you haven’t read the -Views section of the user guide it is -recommended that you do since it shows you how this method is -typically used.

      -

      The first parameter is required. It is the name of the view file you -would like to load.

      -
      -

      Note

      -

      The .php file extension does not need to be specified unless -you use something other than .php.

      -
      -

      The second optional parameter can take an associative array or an -object as input, which it runs through the PHP -extract() function to convert to variables -that can be used in your view files. Again, read the -Views page to learn how this might be useful.

      -

      The third optional parameter lets you change the behavior of the -method so that it returns data as a string rather than sending it to -your browser. This can be useful if you want to process the data in some -way. If you set the parameter to TRUE (boolean) it will return data. The -default behavior is FALSE, which sends it to your browser. Remember to -assign it to a variable if you want the data returned:

      -
      $string = $this->load->view('myfile', '', TRUE);
-
      -
      -
      - -
      -
      -vars($vars[, $val = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $vars (mixed) – An array of variables or a single variable name
        • -
      • $val (mixed) – Optional variable value
        • -
      -
      Returns:

      CI_Loader instance (method chaining)

      -
      Return type:

      CI_Loader

      -
      -

      This method takes an associative array as input and generates -variables using the PHP extract() -function. This method produces the same result as using the second -parameter of the $this->load->view() method above. The reason you -might want to use this method independently is if you would like to -set some global variables in the constructor of your controller and have -them become available in any view file loaded from any method. You can -have multiple calls to this method. The data get cached and merged -into one array for conversion to variables.

      -
      - -
      -
      -get_var($key)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Variable name key
        • -
      -
      Returns:

      Value if key is found, NULL if not

      -
      Return type:

      mixed

      -
      -

      This method checks the associative array of variables available to -your views. This is useful if for any reason a var is set in a library -or another controller method using $this->load->vars().

      -
      - -
      -
      -get_vars()
      -
      --- - - - - - -
      Returns:An array of all assigned view variables
      Return type:array
      -

      This method retrieves all variables available to your views.

      -
      - -
      -
      -clear_vars()
      -
      --- - - - - - -
      Returns:CI_Loader instance (method chaining)
      Return type:CI_Loader
      -

      Clears cached view variables.

      -
      - -
      -
      -model($model[, $name = ''[, $db_conn = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $model (mixed) – Model name or an array containing multiple models
        • -
      • $name (string) – Optional object name to assign the model to
        • -
      • $db_conn (string) – Optional database configuration group to load
        • -
      -
      Returns:

      CI_Loader instance (method chaining)

      -
      Return type:

      CI_Loader

      -
      -
      $this->load->model('model_name');
-
      -
      -

      If your model is located in a subdirectory, include the relative path -from your models directory. For example, if you have a model located at -application/models/blog/Queries.php you’ll load it using:

      -
      $this->load->model('blog/queries');
-
      -
      -

      If you would like your model assigned to a different object name you can -specify it via the second parameter of the loading method:

      -
      $this->load->model('model_name', 'fubar');
-$this->fubar->method();
-
      -
      -
      - -
      -
      -database([$params = ''[, $return = FALSE[, $query_builder = NULL]]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $params (mixed) – Database group name or configuration options
        • -
      • $return (bool) – Whether to return the loaded database object
        • -
      • $query_builder (bool) – Whether to load the Query Builder
        • -
      -
      Returns:

      Loaded CI_DB instance or FALSE on failure if $return is set to TRUE, otherwise CI_Loader instance (method chaining)

      -
      Return type:

      mixed

      -
      -

      This method lets you load the database class. The two parameters are -optional. Please see the database -section for more info.

      -
      - -
      -
      -dbforge([$db = NULL[, $return = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $db (object) – Database object
        • -
      • $return (bool) – Whether to return the Database Forge instance
        • -
      -
      Returns:

      Loaded CI_DB_forge instance if $return is set to TRUE, otherwise CI_Loader instance (method chaining)

      -
      Return type:

      mixed

      -
      -

      Loads the Database Forge class, please refer -to that manual for more info.

      -
      - -
      -
      -dbutil([$db = NULL[, $return = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $db (object) – Database object
        • -
      • $return (bool) – Whether to return the Database Utilities instance
        • -
      -
      Returns:

      Loaded CI_DB_utility instance if $return is set to TRUE, otherwise CI_Loader instance (method chaining)

      -
      Return type:

      mixed

      -
      -

      Loads the Database Utilities class, please -refer to that manual for more info.

      -
      - -
      -
      -helper($helpers)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $helpers (mixed) – Helper name as a string or an array containing multiple helpers
        • -
      -
      Returns:

      CI_Loader instance (method chaining)

      -
      Return type:

      CI_Loader

      -
      -

      This method loads helper files, where file_name is the name of the -file, without the _helper.php extension.

      -
      - -
      -
      -file($path[, $return = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – File path
        • -
      • $return (bool) – Whether to return the loaded file
        • -
      -
      Returns:

      File contents if $return is set to TRUE, otherwise CI_Loader instance (method chaining)

      -
      Return type:

      mixed

      -
      -

      This is a generic file loading method. Supply the filepath and name in -the first parameter and it will open and read the file. By default the -data is sent to your browser, just like a View file, but if you set the -second parameter to boolean TRUE it will instead return the data as a -string.

      -
      - -
      -
      -language($files[, $lang = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $files (mixed) – Language file name or an array of multiple language files
        • -
      • $lang (string) – Language name
        • -
      -
      Returns:

      CI_Loader instance (method chaining)

      -
      Return type:

      CI_Loader

      -
      -

      This method is an alias of the language loading -method: $this->lang->load().

      -
      - -
      -
      -config($file[, $use_sections = FALSE[, $fail_gracefully = FALSE]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $file (string) – Configuration file name
        • -
      • $use_sections (bool) – Whether configuration values should be loaded into their own section
        • -
      • $fail_gracefully (bool) – Whether to just return FALSE in case of failure
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      This method is an alias of the config file loading -method: $this->config->load()

      -
      - -
      -
      -is_loaded($class)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $class (string) – Class name
        • -
      -
      Returns:

      Singleton property name if found, FALSE if not

      -
      Return type:

      mixed

      -
      -

      Allows you to check if a class has already been loaded or not.

      -
      -

      Note

      -

      The word “class” here refers to libraries and drivers.

      -
      -

      If the requested class has been loaded, the method returns its assigned -name in the CI Super-object and FALSE if it’s not:

      -
      $this->load->library('form_validation');
-$this->load->is_loaded('Form_validation');      // returns 'form_validation'
-
-$this->load->is_loaded('Nonexistent_library');  // returns FALSE
-
      -
      -
      -

      Important

      -

      If you have more than one instance of a class (assigned to -different properties), then the first one will be returned.

      -
      -
      $this->load->library('form_validation', $config, 'fv');
-$this->load->library('form_validation');
-
-$this->load->is_loaded('Form_validation');      // returns 'fv'
-
      -
      -
      - -
      -
      -add_package_path($path[, $view_cascade = TRUE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Path to add
        • -
      • $view_cascade (bool) – Whether to use cascading views
        • -
      -
      Returns:

      CI_Loader instance (method chaining)

      -
      Return type:

      CI_Loader

      -
      -

      Adding a package path instructs the Loader class to prepend a given path -for subsequent requests for resources. As an example, the “Foo Bar” -application package above has a library named Foo_bar.php. In our -controller, we’d do the following:

      -
      $this->load->add_package_path(APPPATH.'third_party/foo_bar/')
-        ->library('foo_bar');
-
      -
      -
      - -
      -
      -remove_package_path([$path = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Path to remove
        • -
      -
      Returns:

      CI_Loader instance (method chaining)

      -
      Return type:

      CI_Loader

      -
      -

      When your controller is finished using resources from an application -package, and particularly if you have other application packages you -want to work with, you may wish to remove the package path so the Loader -no longer looks in that directory for resources. To remove the last path -added, simply call the method with no parameters.

      -

      Or to remove a specific package path, specify the same path previously -given to add_package_path() for a package.:

      -
      $this->load->remove_package_path(APPPATH.'third_party/foo_bar/');
-
      -
      -
      - -
      -
      -get_package_paths([$include_base = TRUE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $include_base (bool) – Whether to include BASEPATH
        • -
      -
      Returns:

      An array of package paths

      -
      Return type:

      array

      -
      -

      Returns all currently available package paths.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/migration.html b/user_guide/libraries/migration.html deleted file mode 100755 index 0414613..0000000 --- a/user_guide/libraries/migration.html +++ /dev/null @@ -1,759 +0,0 @@ - - - - - - - - - - Migrations Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Migrations Class

      -

      Migrations are a convenient way for you to alter your database in a -structured and organized manner. You could edit fragments of SQL by hand -but you would then be responsible for telling other developers that they -need to go and run them. You would also have to keep track of which changes -need to be run against the production machines next time you deploy.

      -

      The database table migration tracks which migrations have already been -run so all you have to do is update your application files and -call $this->migration->current() to work out which migrations should be run. -The current version is found in application/config/migration.php.

      - -
      -

      Migration file names

      -

      Each Migration is run in numeric order forward or backwards depending on the -method taken. Two numbering styles are available:

      -
        -
      • Sequential: each migration is numbered in sequence, starting with 001. -Each number must be three digits, and there must not be any gaps in the -sequence. (This was the numbering scheme prior to CodeIgniter 3.0.)
        • -
      • Timestamp: each migration is numbered using the timestamp when the migration -was created, in YYYYMMDDHHIISS format (e.g. 20121031100537). This -helps prevent numbering conflicts when working in a team environment, and is -the preferred scheme in CodeIgniter 3.0 and later.
        • -
      -

      The desired style may be selected using the $config['migration_type'] -setting in your application/config/migration.php file.

      -

      Regardless of which numbering style you choose to use, prefix your migration -files with the migration number followed by an underscore and a descriptive -name for the migration. For example:

      -
        -
      • 001_add_blog.php (sequential numbering)
        • -
      • 20121031100537_add_blog.php (timestamp numbering)
        • -
      -
      -
      -

      Create a Migration

      -

      This will be the first migration for a new site which has a blog. All -migrations go in the application/migrations/ directory and have names such -as 20121031100537_add_blog.php.

      -
      <?php
-
-defined('BASEPATH') OR exit('No direct script access allowed');
-
-class Migration_Add_blog extends CI_Migration {
-
-        public function up()
-        {
-                $this->dbforge->add_field(array(
-                        'blog_id' => array(
-                                'type' => 'INT',
-                                'constraint' => 5,
-                                'unsigned' => TRUE,
-                                'auto_increment' => TRUE
-                        ),
-                        'blog_title' => array(
-                                'type' => 'VARCHAR',
-                                'constraint' => '100',
-                        ),
-                        'blog_description' => array(
-                                'type' => 'TEXT',
-                                'null' => TRUE,
-                        ),
-                ));
-                $this->dbforge->add_key('blog_id', TRUE);
-                $this->dbforge->create_table('blog');
-        }
-
-        public function down()
-        {
-                $this->dbforge->drop_table('blog');
-        }
-}
-
      -
      -

      Then in application/config/migration.php set $config['migration_version'] = 20121031100537;.

      -
      -
      -

      Usage Example

      -

      In this example some simple code is placed in application/controllers/Migrate.php -to update the schema.:

      -
      <?php
-
-class Migrate extends CI_Controller
-{
-
-        public function index()
-        {
-                $this->load->library('migration');
-
-                if ($this->migration->current() === FALSE)
-                {
-                        show_error($this->migration->error_string());
-                }
-        }
-
-}
-
      -
      -
      -
      -

      Migration Preferences

      -

      The following is a table of all the config options for migrations.

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefaultOptionsDescription
      migration_enabledFALSETRUE / FALSEEnable or disable migrations.
      migration_pathAPPPATH.’migrations/’NoneThe path to your migrations folder.
      migration_version0NoneThe current version your database should use.
      migration_tablemigrationsNoneThe table name for storing the schema -version number.
      migration_auto_latestFALSETRUE / FALSEEnable or disable automatically -running migrations.
      migration_type‘timestamp’‘timestamp’ / ‘sequential’The type of numeric identifier used to name -migration files.
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Migration
      -
      -
      -current()
      -
      --- - - - - - -
      Returns:TRUE if no migrations are found, current version string on success, FALSE on failure
      Return type:mixed
      -

      Migrates up to the current version (whatever is set for -$config['migration_version'] in application/config/migration.php).

      -
      - -
      -
      -error_string()
      -
      --- - - - - - -
      Returns:Error messages
      Return type:string
      -

      This returns a string of errors that were detected while performing a migration.

      -
      - -
      -
      -find_migrations()
      -
      --- - - - - - -
      Returns:An array of migration files
      Return type:array
      -

      An array of migration filenames are returned that are found in the migration_path property.

      -
      - -
      -
      -latest()
      -
      --- - - - - - -
      Returns:Current version string on success, FALSE on failure
      Return type:mixed
      -

      This works much the same way as current() but instead of looking for -the $config['migration_version'] the Migration class will use the very -newest migration found in the filesystem.

      -
      - -
      -
      -version($target_version)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $target_version (mixed) – Migration version to process
        • -
      -
      Returns:

      TRUE if no migrations are found, current version string on success, FALSE on failure

      -
      Return type:

      mixed

      -
      -

      Version can be used to roll back changes or step forwards programmatically to -specific versions. It works just like current() but ignores $config['migration_version'].

      -
      $this->migration->version(5);
-
      -
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/output.html b/user_guide/libraries/output.html deleted file mode 100755 index 2c3643e..0000000 --- a/user_guide/libraries/output.html +++ /dev/null @@ -1,913 +0,0 @@ - - - - - - - - - - Output Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Output Class

      -

      The Output class is a core class with one main function: To send the -finalized web page to the requesting browser. It is also responsible for -caching your web pages, if you use that -feature.

      -
      -

      Note

      -

      This class is initialized automatically by the system so there -is no need to do it manually.

      -
      -

      Under normal circumstances you won’t even notice the Output class since -it works transparently without your intervention. For example, when you -use the Loader class to load a view file, -it’s automatically passed to the Output class, which will be called -automatically by CodeIgniter at the end of system execution. It is -possible, however, for you to manually intervene with the output if you -need to.

      - -
      -

      Class Reference

      -
      -
      -class CI_Output
      -
      -
      -$parse_exec_vars = TRUE;
      -

      Enables/disables parsing of the {elapsed_time} and {memory_usage} pseudo-variables.

      -

      CodeIgniter will parse those tokens in your output by default. To disable this, set -this property to FALSE in your controller.

      -
      $this->output->parse_exec_vars = FALSE;
-
      -
      -
      - -
      -
      -set_output($output)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $output (string) – String to set the output to
        • -
      -
      Returns:

      CI_Output instance (method chaining)

      -
      Return type:

      CI_Output

      -
      -

      Permits you to manually set the final output string. Usage example:

      -
      $this->output->set_output($data);
-
      -
      -
      -

      Important

      -

      If you do set your output manually, it must be the last thing done -in the function you call it from. For example, if you build a page in one -of your controller methods, don’t set the output until the end.

      -
      -
      - -
      -
      -set_content_type($mime_type[, $charset = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $mime_type (string) – MIME Type idenitifer string
        • -
      • $charset (string) – Character set
        • -
      -
      Returns:

      CI_Output instance (method chaining)

      -
      Return type:

      CI_Output

      -
      -

      Permits you to set the mime-type of your page so you can serve JSON data, JPEG’s, XML, etc easily.

      -
      $this->output
-        ->set_content_type('application/json')
-        ->set_output(json_encode(array('foo' => 'bar')));
-
-$this->output
-        ->set_content_type('jpeg') // You could also use ".jpeg" which will have the full stop removed before looking in config/mimes.php
-        ->set_output(file_get_contents('files/something.jpg'));
-
      -
      -
      -

      Important

      -

      Make sure any non-mime string you pass to this method -exists in application/config/mimes.php or it will have no effect.

      -
      -

      You can also set the character set of the document, by passing a second argument:

      -
      $this->output->set_content_type('css', 'utf-8');
-
      -
      -
      - -
      -
      -get_content_type()
      -
      --- - - - - - -
      Returns:Content-Type string
      Return type:string
      -

      Returns the Content-Type HTTP header that’s currently in use, excluding the character set value.

      -
      $mime = $this->output->get_content_type();
-
      -
      -
      -

      Note

      -

      If not set, the default return value is ‘text/html’.

      -
      -
      - -
      -
      -get_header($header)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $header (string) – HTTP header name
        • -
      -
      Returns:

      HTTP response header or NULL if not found

      -
      Return type:

      mixed

      -
      -

      Returns the requested HTTP header value, or NULL if the requested header is not set. -Example:

      -
      $this->output->set_content_type('text/plain', 'UTF-8');
-echo $this->output->get_header('content-type');
-// Outputs: text/plain; charset=utf-8
-
      -
      -
      -

      Note

      -

      The header name is compared in a case-insensitive manner.

      -
      -
      -

      Note

      -

      Raw headers sent via PHP’s native header() function are also detected.

      -
      -
      - -
      -
      -get_output()
      -
      --- - - - - - -
      Returns:Output string
      Return type:string
      -

      Permits you to manually retrieve any output that has been sent for -storage in the output class. Usage example:

      -
      $string = $this->output->get_output();
-
      -
      -

      Note that data will only be retrievable from this function if it has -been previously sent to the output class by one of the CodeIgniter -functions like $this->load->view().

      -
      - -
      -
      -append_output($output)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $output (string) – Additional output data to append
        • -
      -
      Returns:

      CI_Output instance (method chaining)

      -
      Return type:

      CI_Output

      -
      -

      Appends data onto the output string.

      -
      $this->output->append_output($data);
-
      -
      -
      - -
      -
      -set_header($header[, $replace = TRUE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $header (string) – HTTP response header
        • -
      • $replace (bool) – Whether to replace the old header value, if it is already set
        • -
      -
      Returns:

      CI_Output instance (method chaining)

      -
      Return type:

      CI_Output

      -
      -

      Permits you to manually set server headers, which the output class will -send for you when outputting the final rendered display. Example:

      -
      $this->output->set_header('HTTP/1.0 200 OK');
-$this->output->set_header('HTTP/1.1 200 OK');
-$this->output->set_header('Last-Modified: '.gmdate('D, d M Y H:i:s', $last_update).' GMT');
-$this->output->set_header('Cache-Control: no-store, no-cache, must-revalidate');
-$this->output->set_header('Cache-Control: post-check=0, pre-check=0');
-$this->output->set_header('Pragma: no-cache');
-
      -
      -
      - -
      -
      -set_status_header([$code = 200[, $text = '']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $code (int) – HTTP status code
        • -
      • $text (string) – Optional message
        • -
      -
      Returns:

      CI_Output instance (method chaining)

      -
      Return type:

      CI_Output

      -
      -

      Permits you to manually set a server status header. Example:

      -
      $this->output->set_status_header(401);
-// Sets the header as:  Unauthorized
-
      -
      -

      See here for a full list of headers.

      -
      -

      Note

      -

      This method is an alias for Common function -set_status_header().

      -
      -
      - -
      -
      -enable_profiler([$val = TRUE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $val (bool) – Whether to enable or disable the Profiler
        • -
      -
      Returns:

      CI_Output instance (method chaining)

      -
      Return type:

      CI_Output

      -
      -

      Permits you to enable/disable the Profiler, which will display benchmark -and other data at the bottom of your pages for debugging and optimization purposes.

      -

      To enable the profiler place the following line anywhere within your -Controller methods:

      -
      $this->output->enable_profiler(TRUE);
-
      -
      -

      When enabled a report will be generated and inserted at the bottom of your pages.

      -

      To disable the profiler you would use:

      -
      $this->output->enable_profiler(FALSE);
-
      -
      -
      - -
      -
      -set_profiler_sections($sections)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $sections (array) – Profiler sections
        • -
      -
      Returns:

      CI_Output instance (method chaining)

      -
      Return type:

      CI_Output

      -
      -

      Permits you to enable/disable specific sections of the Profiler when it is enabled. -Please refer to the Profiler documentation for further information.

      -
      - -
      -
      -cache($time)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $time (int) – Cache expiration time in seconds
        • -
      -
      Returns:

      CI_Output instance (method chaining)

      -
      Return type:

      CI_Output

      -
      -

      Caches the current page for the specified amount of seconds.

      -

      For more information, please see the caching documentation.

      -
      - -
      -
      -_display([$output = ''])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $output (string) – Output data override
        • -
      -
      Returns:

      void

      -
      Return type:

      void

      -
      -

      Sends finalized output data to the browser along with any server headers. It also stops benchmark -timers.

      -
      -

      Note

      -

      This method is called automatically at the end of script execution, you won’t need to -call it manually unless you are aborting script execution using exit() or die() in your code.

      -
      -

      Example:

      -
      $response = array('status' => 'OK');
-
-$this->output
-        ->set_status_header(200)
-        ->set_content_type('application/json', 'utf-8')
-        ->set_output(json_encode($response, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES))
-        ->_display();
-exit;
-
      -
      -
      -

      Note

      -

      Calling this method manually without aborting script execution will result in duplicated output.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/pagination.html b/user_guide/libraries/pagination.html deleted file mode 100755 index 859b202..0000000 --- a/user_guide/libraries/pagination.html +++ /dev/null @@ -1,785 +0,0 @@ - - - - - - - - - - Pagination Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Pagination Class

      -

      CodeIgniter’s Pagination class is very easy to use, and it is 100% -customizable, either dynamically or via stored preferences.

      - -

      If you are not familiar with the term “pagination”, it refers to links -that allows you to navigate from page to page, like this:

      -
      « First  < 1 2 3 4 5 >  Last »
-
      -
      -
      -

      Example

      -

      Here is a simple example showing how to create pagination in one of your -controller methods:

      -
      $this->load->library('pagination');
-
-$config['base_url'] = 'http://example.com/index.php/test/page/';
-$config['total_rows'] = 200;
-$config['per_page'] = 20;
-
-$this->pagination->initialize($config);
-
-echo $this->pagination->create_links();
-
      -
      -
      -

      Notes

      -

      The $config array contains your configuration variables. It is passed to -the $this->pagination->initialize() method as shown above. Although -there are some twenty items you can configure, at minimum you need the -three shown. Here is a description of what those items represent:

      -
        -
      • base_url This is the full URL to the controller class/function -containing your pagination. In the example above, it is pointing to a -controller called “Test” and a function called “page”. Keep in mind -that you can re-route your URI if you -need a different structure.
        • -
      • total_rows This number represents the total rows in the result -set you are creating pagination for. Typically this number will be -the total rows that your database query returned.
        • -
      • per_page The number of items you intend to show per page. In the -above example, you would be showing 20 items per page.
        • -
      -

      The create_links() method returns an empty string when there is no -pagination to show.

      -
      -
      -

      Setting preferences in a config file

      -

      If you prefer not to set preferences using the above method, you can -instead put them into a config file. Simply create a new file called -pagination.php, add the $config array in that file. Then save the file -in application/config/pagination.php and it will be used automatically. -You will NOT need to use $this->pagination->initialize() if you save -your preferences in a config file.

      -
      -
      -
      -

      Customizing the Pagination

      -

      The following is a list of all the preferences you can pass to the -initialization function to tailor the display.

      -

      $config[‘uri_segment’] = 3;

      -

      The pagination function automatically determines which segment of your -URI contains the page number. If you need something different you can -specify it.

      -

      $config[‘num_links’] = 2;

      -

      The number of “digit” links you would like before and after the selected -page number. For example, the number 2 will place two digits on either -side, as in the example links at the very top of this page.

      -

      $config[‘use_page_numbers’] = TRUE;

      -

      By default, the URI segment will use the starting index for the items -you are paginating. If you prefer to show the the actual page number, -set this to TRUE.

      -

      $config[‘page_query_string’] = TRUE;

      -

      By default, the pagination library assume you are using URI -Segments, and constructs your links something -like:

      -
      http://example.com/index.php/test/page/20
-
      -
      -

      If you have $config['enable_query_strings'] set to TRUE your links -will automatically be re-written using Query Strings. This option can -also be explictly set. Using $config['page_query_string'] set to TRUE, -the pagination link will become:

      -
      http://example.com/index.php?c=test&m=page&per_page=20
-
      -
      -

      Note that “per_page” is the default query string passed, however can be -configured using $config['query_string_segment'] = 'your_string'

      -

      $config[‘reuse_query_string’] = FALSE;

      -

      By default your Query String arguments (nothing to do with other -query string options) will be ignored. Setting this config to -TRUE will add existing query string arguments back into the -URL after the URI segment and before the suffix.:

      -
      http://example.com/index.php/test/page/20?query=search%term
-
      -
      -

      This helps you mix together normal URI Segments -as well as query string arguments, which until 3.0 was not possible.

      -

      $config[‘prefix’] = ‘’;

      -

      A custom prefix added to the path. The prefix value will be right before -the offset segment.

      -

      $config[‘suffix’] = ‘’;

      -

      A custom suffix added to the path. The sufix value will be right after -the offset segment.

      -

      $config[‘use_global_url_suffix’] = FALSE;

      -

      When set to TRUE, it will override the $config['suffix'] value and -instead set it to the one that you have in $config['url_suffix'] in -your application/config/config.php file.

      -
      -
      -

      Adding Enclosing Markup

      -

      If you would like to surround the entire pagination with some markup you -can do it with these two preferences:

      -

      $config[‘full_tag_open’] = ‘<p>’;

      -

      The opening tag placed on the left side of the entire result.

      -

      $config[‘full_tag_close’] = ‘</p>’;

      -

      The closing tag placed on the right side of the entire result.

      -
      - - - - -
      -

      Customizing the “Current Page” Link

      -

      $config[‘cur_tag_open’] = ‘<b>’;

      -

      The opening tag for the “current” link.

      -

      $config[‘cur_tag_close’] = ‘</b>’;

      -

      The closing tag for the “current” link.

      -
      - -
      -

      Hiding the Pages

      -

      If you wanted to not list the specific pages (for example, you only want -“next” and “previous” links), you can suppress their rendering by -adding:

      -
      $config['display_pages'] = FALSE;
-
      -
      -
      -
      -

      Adding attributes to anchors

      -

      If you want to add an extra attribute to be added to every link rendered -by the pagination class, you can set them as key/value pairs in the -“attributes” config:

      -
      // Produces: class="myclass"
-$config['attributes'] = array('class' => 'myclass');
-
      -
      -
      -

      Note

      -

      Usage of the old method of setting classes via “anchor_class” -is deprecated.

      -
      -
      -
      -

      Disabling the “rel” attribute

      -

      By default the rel attribute is dynamically generated and appended to -the appropriate anchors. If for some reason you want to turn it off, -you can pass boolean FALSE as a regular attribute

      -
      $config['attributes']['rel'] = FALSE;
-
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Pagination
      -
      -
      -initialize([$params = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $params (array) – Configuration parameters
        • -
      -
      Returns:

      CI_Pagination instance (method chaining)

      -
      Return type:

      CI_Pagination

      -
      -

      Initializes the Pagination class with your preferred options.

      -
      - -
      - -
      --- - - - - - -
      Returns:HTML-formatted pagination
      Return type:string
      -

      Returns a “pagination” bar, containing the generated links or an empty string if there’s just a single page.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/parser.html b/user_guide/libraries/parser.html deleted file mode 100755 index da7f8e0..0000000 --- a/user_guide/libraries/parser.html +++ /dev/null @@ -1,851 +0,0 @@ - - - - - - - - - - Template Parser Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries »
        • - -
      • Template Parser Class
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Template Parser Class

      -

      The Template Parser Class can perform simple text substitution for -pseudo-variables contained within your view files. -It can parse simple variables or variable tag pairs.

      -

      If you’ve never used a template engine, -pseudo-variable names are enclosed in braces, like this:

      -
      <html>
-        <head>
-                <title>{blog_title}</title>
-        </head>
-        <body>
-                <h3>{blog_heading}</h3>
-
-        {blog_entries}
-                <h5>{title}</h5>
-                <p>{body}</p>
-        {/blog_entries}
-
-        </body>
-</html>
-
      -
      -

      These variables are not actual PHP variables, but rather plain text -representations that allow you to eliminate PHP from your templates -(view files).

      -
      -

      Note

      -

      CodeIgniter does not require you to use this class since -using pure PHP in your view pages lets them run a little faster. -However, some developers prefer to use a template engine if -they work with designers who they feel would find some -confusion working with PHP.

      -
      -
      -

      Important

      -

      The Template Parser Class is not a full-blown -template parsing solution. We’ve kept it very lean on purpose in order -to maintain maximum performance.

      -
      - -
      -

      Using the Template Parser Class

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the Parser class is initialized -in your controller using the $this->load->library() method:

      -
      $this->load->library('parser');
-
      -
      -

      Once loaded, the Parser library object will be available using: -$this->parser

      -
      -
      -

      Parsing templates

      -

      You can use the parse() method to parse (or render) simple templates, -like this:

      -
      $data = array(
-        'blog_title' => 'My Blog Title',
-        'blog_heading' => 'My Blog Heading'
-);
-
-$this->parser->parse('blog_template', $data);
-
      -
      -

      The first parameter contains the name of the view -file (in this example the file would be called -blog_template.php), and the second parameter contains an associative -array of data to be replaced in the template. In the above example, the -template would contain two variables: {blog_title} and {blog_heading}

      -

      There is no need to “echo” or do something with the data returned by -$this->parser->parse(). It is automatically passed to the output class -to be sent to the browser. However, if you do want the data returned -instead of sent to the output class you can pass TRUE (boolean) as the -third parameter:

      -
      $string = $this->parser->parse('blog_template', $data, TRUE);
-
      -
      -
      -
      -

      Variable Pairs

      -

      The above example code allows simple variables to be replaced. What if -you would like an entire block of variables to be repeated, with each -iteration containing new values? Consider the template example we showed -at the top of the page:

      -
      <html>
-        <head>
-                <title>{blog_title}</title>
-        </head>
-        <body>
-                <h3>{blog_heading}</h3>
-
-        {blog_entries}
-                <h5>{title}</h5>
-                <p>{body}</p>
-        {/blog_entries}
-
-        </body>
-</html>
-
      -
      -

      In the above code you’ll notice a pair of variables: {blog_entries} -data... {/blog_entries}. In a case like this, the entire chunk of data -between these pairs would be repeated multiple times, corresponding to -the number of rows in the “blog_entries” element of the parameters array.

      -

      Parsing variable pairs is done using the identical code shown above to -parse single variables, except, you will add a multi-dimensional array -corresponding to your variable pair data. Consider this example:

      -
      $this->load->library('parser');
-
-$data = array(
-        'blog_title'   => 'My Blog Title',
-        'blog_heading' => 'My Blog Heading',
-        'blog_entries' => array(
-                array('title' => 'Title 1', 'body' => 'Body 1'),
-                array('title' => 'Title 2', 'body' => 'Body 2'),
-                array('title' => 'Title 3', 'body' => 'Body 3'),
-                array('title' => 'Title 4', 'body' => 'Body 4'),
-                array('title' => 'Title 5', 'body' => 'Body 5')
-        )
-);
-
-$this->parser->parse('blog_template', $data);
-
      -
      -

      If your “pair” data is coming from a database result, which is already a -multi-dimensional array, you can simply use the database result_array() -method:

      -
      $query = $this->db->query("SELECT * FROM blog");
-
-$this->load->library('parser');
-
-$data = array(
-        'blog_title'   => 'My Blog Title',
-        'blog_heading' => 'My Blog Heading',
-        'blog_entries' => $query->result_array()
-);
-
-$this->parser->parse('blog_template', $data);
-
      -
      -
      -
      -

      Usage Notes

      -

      If you include substitution parameters that are not referenced in your -template, they are ignored:

      -
      $template = 'Hello, {firstname} {lastname}';
-$data = array(
-        'title' => 'Mr',
-        'firstname' => 'John',
-        'lastname' => 'Doe'
-);
-$this->parser->parse_string($template, $data);
-
-// Result: Hello, John Doe
-
      -
      -

      If you do not include a substitution parameter that is referenced in your -template, the original pseudo-variable is shown in the result:

      -
      $template = 'Hello, {firstname} {initials} {lastname}';
-$data = array(
-        'title' => 'Mr',
-        'firstname' => 'John',
-        'lastname' => 'Doe'
-);
-$this->parser->parse_string($template, $data);
-
-// Result: Hello, John {initials} Doe
-
      -
      -

      If you provide a string substitution parameter when an array is expected, -i.e. for a variable pair, the substitution is done for the opening variable -pair tag, but the closing variable pair tag is not rendered properly:

      -
      $template = 'Hello, {firstname} {lastname} ({degrees}{degree} {/degrees})';
-$data = array(
-        'degrees' => 'Mr',
-        'firstname' => 'John',
-        'lastname' => 'Doe',
-        'titles' => array(
-                array('degree' => 'BSc'),
-                array('degree' => 'PhD')
-        )
-);
-$this->parser->parse_string($template, $data);
-
-// Result: Hello, John Doe (Mr{degree} {/degrees})
-
      -
      -

      If you name one of your individual substitution parameters the same as one -used inside a variable pair, the results may not be as expected:

      -
      $template = 'Hello, {firstname} {lastname} ({degrees}{degree} {/degrees})';
-$data = array(
-        'degree' => 'Mr',
-        'firstname' => 'John',
-        'lastname' => 'Doe',
-        'degrees' => array(
-                array('degree' => 'BSc'),
-                array('degree' => 'PhD')
-        )
-);
-$this->parser->parse_string($template, $data);
-
-// Result: Hello, John Doe (Mr Mr )
-
      -
      -
      -
      -

      View Fragments

      -

      You do not have to use variable pairs to get the effect of iteration in -your views. It is possible to use a view fragment for what would be inside -a variable pair, and to control the iteration in your controller instead -of in the view.

      -

      An example with the iteration controlled in the view:

      -
      $template = '<ul>{menuitems}
-        <li><a href="{link}">{title}</a></li>
-{/menuitems}</ul>';
-
-$data = array(
-        'menuitems' => array(
-                array('title' => 'First Link', 'link' => '/first'),
-                array('title' => 'Second Link', 'link' => '/second'),
-        )
-);
-$this->parser->parse_string($template, $data);
-
      -
      -

      Result:

      -
      <ul>
-        <li><a href="/first">First Link</a></li>
-        <li><a href="/second">Second Link</a></li>
-</ul>
-
      -
      -

      An example with the iteration controlled in the controller, -using a view fragment:

      -
      $temp = '';
-$template1 = '<li><a href="{link}">{title}</a></li>';
-$data1 = array(
-        array('title' => 'First Link', 'link' => '/first'),
-        array('title' => 'Second Link', 'link' => '/second'),
-);
-
-foreach ($data1 as $menuitem)
-{
-        $temp .= $this->parser->parse_string($template1, $menuitem, TRUE);
-}
-
-$template = '<ul>{menuitems}</ul>';
-$data = array(
-        'menuitems' => $temp
-);
-$this->parser->parse_string($template, $data);
-
      -
      -

      Result:

      -
      <ul>
-        <li><a href="/first">First Link</a></li>
-        <li><a href="/second">Second Link</a></li>
-</ul>
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Parser
      -
      -
      -parse($template, $data[, $return = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $template (string) – Path to view file
        • -
      • $data (array) – Variable data
        • -
      • $return (bool) – Whether to only return the parsed template
        • -
      -
      Returns:

      Parsed template string

      -
      Return type:

      string

      -
      -

      Parses a template from the provided path and variables.

      -
      - -
      -
      -parse_string($template, $data[, $return = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $template (string) – Path to view file
        • -
      • $data (array) – Variable data
        • -
      • $return (bool) – Whether to only return the parsed template
        • -
      -
      Returns:

      Parsed template string

      -
      Return type:

      string

      -
      -

      This method works exactly like parse(), only it accepts -the template as a string instead of loading a view file.

      -
      - -
      -
      -set_delimiters([$l = '{'[, $r = '}']])
      -
      --- - - - - - -
      Parameters:
        -
      • $l (string) – Left delimiter
        • -
      • $r (string) – Right delimiter
        • -
      -
      Return type:

      void

      -
      -

      Sets the delimiters (opening and closing) for a -pseudo-variable “tag” in a template.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/security.html b/user_guide/libraries/security.html deleted file mode 100755 index c67e208..0000000 --- a/user_guide/libraries/security.html +++ /dev/null @@ -1,729 +0,0 @@ - - - - - - - - - - Security Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Security Class

      -

      The Security Class contains methods that help you create a secure -application, processing input data for security.

      - -
      -

      XSS Filtering

      -

      CodeIgniter comes with a Cross Site Scripting prevention filter, which -looks for commonly used techniques to trigger JavaScript or other types -of code that attempt to hijack cookies or do other malicious things. -If anything disallowed is encountered it is rendered safe by converting -the data to character entities.

      -

      To filter data through the XSS filter use the xss_clean() method:

      -
      $data = $this->security->xss_clean($data);
-
      -
      -

      An optional second parameter, is_image, allows this function to be used -to test images for potential XSS attacks, useful for file upload -security. When this second parameter is set to TRUE, instead of -returning an altered string, the function returns TRUE if the image is -safe, and FALSE if it contained potentially malicious information that a -browser may attempt to execute.

      -
      if ($this->security->xss_clean($file, TRUE) === FALSE)
-{
-        // file failed the XSS test
-}
-
      -
      -
      -
      -

      Cross-site request forgery (CSRF)

      -

      You can enable CSRF protection by altering your application/config/config.php -file in the following way:

      -
      $config['csrf_protection'] = TRUE;
-
      -
      -

      If you use the form helper, then -form_open() will automatically insert a hidden csrf field in -your forms. If not, then you can use get_csrf_token_name() -and get_csrf_hash()

      -
      $csrf = array(
-        'name' => $this->security->get_csrf_token_name(),
-        'hash' => $this->security->get_csrf_hash()
-);
-
-...
-
-<input type="hidden" name="<?=$csrf['name'];?>" value="<?=$csrf['hash'];?>" />
-
      -
      -

      Tokens may be either regenerated on every submission (default) or -kept the same throughout the life of the CSRF cookie. The default -regeneration of tokens provides stricter security, but may result -in usability concerns as other tokens become invalid (back/forward -navigation, multiple tabs/windows, asynchronous actions, etc). You -may alter this behavior by editing the following config parameter

      -
      $config['csrf_regenerate'] = TRUE;
-
      -
      -

      Select URIs can be whitelisted from csrf protection (for example API -endpoints expecting externally POSTed content). You can add these URIs -by editing the ‘csrf_exclude_uris’ config parameter:

      -
      $config['csrf_exclude_uris'] = array('api/person/add');
-
      -
      -

      Regular expressions are also supported (case-insensitive):

      -
      $config['csrf_exclude_uris'] = array(
-        'api/record/[0-9]+',
-        'api/title/[a-z]+'
-);
-
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Security
      -
      -
      -xss_clean($str[, $is_image = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (mixed) – Input string or an array of strings
        • -
      -
      Returns:

      XSS-clean data

      -
      Return type:

      mixed

      -
      -

      Tries to remove XSS exploits from the input data and returns the cleaned string. -If the optional second parameter is set to true, it will return boolean TRUE if the image is safe to use and FALSE if malicious data was detected in it.

      -
      - -
      -
      -sanitize_filename($str[, $relative_path = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – File name/path
        • -
      • $relative_path (bool) – Whether to preserve any directories in the file path
        • -
      -
      Returns:

      Sanitized file name/path

      -
      Return type:

      string

      -
      -

      Tries to sanitize filenames in order to prevent directory traversal attempts -and other security threats, which is particularly useful for files that were supplied via user input.

      -
      $filename = $this->security->sanitize_filename($this->input->post('filename'));
-
      -
      -

      If it is acceptable for the user input to include relative paths, e.g. -file/in/some/approved/folder.txt, you can set the second optional parameter, $relative_path to TRUE.

      -
      $filename = $this->security->sanitize_filename($this->input->post('filename'), TRUE);
-
      -
      -
      - -
      -
      -get_csrf_token_name()
      -
      --- - - - - - -
      Returns:CSRF token name
      Return type:string
      -

      Returns the CSRF token name (the $config['csrf_token_name'] value).

      -
      - -
      -
      -get_csrf_hash()
      -
      --- - - - - - -
      Returns:CSRF hash
      Return type:string
      -

      Returns the CSRF hash value. Useful in combination with get_csrf_token_name() -for manually building forms or sending valid AJAX POST requests.

      -
      - -
      -
      -entity_decode($str[, $charset = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $charset (string) – Character set of the input string
        • -
      -
      Returns:

      Entity-decoded string

      -
      Return type:

      string

      -
      -

      This method acts a lot like PHP’s own native html_entity_decode() function in ENT_COMPAT mode, only -it tries to detect HTML entities that don’t end in a semicolon because some browsers allow that.

      -

      If the $charset parameter is left empty, then your configured $config['charset'] value will be used.

      -
      - -
      -
      -get_random_bytes($length)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $length (int) – Output length
        • -
      -
      Returns:

      A binary stream of random bytes or FALSE on failure

      -
      Return type:

      string

      -
      -

      A convenience method for getting proper random bytes via mcrypt_create_iv(), -/dev/urandom or openssl_random_pseudo_bytes() (in that order), if one -of them is available.

      -

      Used for generating CSRF and XSS tokens.

      -
      -

      Note

      -

      The output is NOT guaranteed to be cryptographically secure, -just the best attempt at that.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/sessions.html b/user_guide/libraries/sessions.html deleted file mode 100755 index 216bf3b..0000000 --- a/user_guide/libraries/sessions.html +++ /dev/null @@ -1,1923 +0,0 @@ - - - - - - - - - - Session Library — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Session Library

      -

      The Session class permits you maintain a user’s “state” and track their -activity while they browse your site.

      -

      CodeIgniter comes with a few session storage drivers:

      -
      -
        -
      • files (default; file-system based)
        • -
      • database
        • -
      • redis
        • -
      • memcached
        • -
      -
      -

      In addition, you may create your own, custom session drivers based on other -kinds of storage, while still taking advantage of the features of the -Session class.

      - -
      -

      Using the Session Class

      -
      -

      Initializing a Session

      -

      Sessions will typically run globally with each page load, so the Session -class should either be initialized in your controller constructors, or it can be auto-loaded by the system. -For the most part the session class will run unattended in the background, -so simply initializing the class will cause it to read, create, and update -sessions when necessary.

      -

      To initialize the Session class manually in your controller constructor, -use the $this->load->library() method:

      -
      $this->load->library('session');
-
      -
      -

      Once loaded, the Sessions library object will be available using:

      -
      $this->session
-
      -
      -
      -

      Important

      -

      Because the Loader Class is instantiated -by CodeIgniter’s base controller, make sure to call -parent::__construct() before trying to load a library from -inside a controller constructor.

      -
      -
      -
      -

      How do Sessions work?

      -

      When a page is loaded, the session class will check to see if valid -session cookie is sent by the user’s browser. If a sessions cookie does -not exist (or if it doesn’t match one stored on the server or has -expired) a new session will be created and saved.

      -

      If a valid session does exist, its information will be updated. With each -update, the session ID may be regenerated if configured to do so.

      -

      It’s important for you to understand that once initialized, the Session -class runs automatically. There is nothing you need to do to cause the -above behavior to happen. You can, as you’ll see below, work with session -data, but the process of reading, writing, and updating a session is -automatic.

      -
      -

      Note

      -

      Under CLI, the Session library will automatically halt itself, -as this is a concept based entirely on the HTTP protocol.

      -
      -
      -

      A note about concurrency

      -

      Unless you’re developing a website with heavy AJAX usage, you can skip this -section. If you are, however, and if you’re experiencing performance -issues, then this note is exactly what you’re looking for.

      -

      Sessions in previous versions of CodeIgniter didn’t implement locking, -which meant that two HTTP requests using the same session could run exactly -at the same time. To use a more appropriate technical term - requests were -non-blocking.

      -

      However, non-blocking requests in the context of sessions also means -unsafe, because modifications to session data (or session ID regeneration) -in one request can interfere with the execution of a second, concurrent -request. This detail was at the root of many issues and the main reason why -CodeIgniter 3.0 has a completely re-written Session library.

      -

      Why are we telling you this? Because it is likely that after trying to -find the reason for your performance issues, you may conclude that locking -is the issue and therefore look into how to remove the locks ...

      -

      DO NOT DO THAT! Removing locks would be wrong and it will cause you -more problems!

      -

      Locking is not the issue, it is a solution. Your issue is that you still -have the session open, while you’ve already processed it and therefore no -longer need it. So, what you need is to close the session for the -current request after you no longer need it.

      -

      Long story short - call session_write_close() once you no longer need -anything to do with session variables.

      -
      -
      -
      -

      What is Session Data?

      -

      Session data is simply an array associated with a particular session ID -(cookie).

      -

      If you’ve used sessions in PHP before, you should be familiar with PHP’s -$_SESSION superglobal -(if not, please read the content on that link).

      -

      CodeIgniter gives access to its session data through the same means, as it -uses the session handlers’ mechanism provided by PHP. Using session data is -as simple as manipulating (read, set and unset values) the $_SESSION -array.

      -

      In addition, CodeIgniter also provides 2 special types of session data -that are further explained below: flashdata and tempdata.

      -
      -

      Note

      -

      In previous versions, regular session data in CodeIgniter was -referred to as ‘userdata’. Have this in mind if that term is used -elsewhere in the manual. Most of it is written to explain how -the custom ‘userdata’ methods work.

      -
      -
      -
      -

      Retrieving Session Data

      -

      Any piece of information from the session array is available through the -$_SESSION superglobal:

      -
      $_SESSION['item']
-
      -
      -

      Or through the magic getter:

      -
      $this->session->item
-
      -
      -

      And for backwards compatibility, through the userdata() method:

      -
      $this->session->userdata('item');
-
      -
      -

      Where item is the array key corresponding to the item you wish to fetch. -For example, to assign a previously stored ‘name’ item to the $name -variable, you will do this:

      -
      $name = $_SESSION['name'];
-
-// or:
-
-$name = $this->session->name
-
-// or:
-
-$name = $this->session->userdata('name');
-
      -
      -
      -

      Note

      -

      The userdata() method returns NULL if the item you are trying -to access does not exist.

      -
      -

      If you want to retrieve all of the existing userdata, you can simply -omit the item key (magic getter only works for properties):

      -
      $_SESSION
-
-// or:
-
-$this->session->userdata();
-
      -
      -
      -
      -

      Adding Session Data

      -

      Let’s say a particular user logs into your site. Once authenticated, you -could add their username and e-mail address to the session, making that -data globally available to you without having to run a database query when -you need it.

      -

      You can simply assign data to the $_SESSION array, as with any other -variable. Or as a property of $this->session.

      -

      Alternatively, the old method of assigning it as “userdata” is also -available. That however passing an array containing your new data to the -set_userdata() method:

      -
      $this->session->set_userdata($array);
-
      -
      -

      Where $array is an associative array containing your new data. Here’s -an example:

      -
      $newdata = array(
-        'username'  => 'johndoe',
-        'email'     => 'johndoe@some-site.com',
-        'logged_in' => TRUE
-);
-
-$this->session->set_userdata($newdata);
-
      -
      -

      If you want to add userdata one value at a time, set_userdata() also -supports this syntax:

      -
      $this->session->set_userdata('some_name', 'some_value');
-
      -
      -

      If you want to verify that a session value exists, simply check with -isset():

      -
      // returns FALSE if the 'some_name' item doesn't exist or is NULL,
-// TRUE otherwise:
-isset($_SESSION['some_name'])
-
      -
      -

      Or you can call has_userdata():

      -
      $this->session->has_userdata('some_name');
-
      -
      -
      -
      -

      Removing Session Data

      -

      Just as with any other variable, unsetting a value in $_SESSION can be -done through unset():

      -
      unset($_SESSION['some_name']);
-
-// or multiple values:
-
-unset(
-        $_SESSION['some_name'],
-        $_SESSION['another_name']
-);
-
      -
      -

      Also, just as set_userdata() can be used to add information to a -session, unset_userdata() can be used to remove it, by passing the -session key. For example, if you wanted to remove ‘some_name’ from your -session data array:

      -
      $this->session->unset_userdata('some_name');
-
      -
      -

      This method also accepts an array of item keys to unset:

      -
      $array_items = array('username', 'email');
-
-$this->session->unset_userdata($array_items);
-
      -
      -
      -

      Note

      -

      In previous versions, the unset_userdata() method used -to accept an associative array of key => 'dummy value' -pairs. This is no longer supported.

      -
      -
      -
      -

      Flashdata

      -

      CodeIgniter supports “flashdata”, or session data that will only be -available for the next request, and is then automatically cleared.

      -

      This can be very useful, especially for one-time informational, error or -status messages (for example: “Record 2 deleted”).

      -

      It should be noted that flashdata variables are regular session vars, -only marked in a specific way under the ‘__ci_vars’ key (please don’t touch -that one, you’ve been warned).

      -

      To mark an existing item as “flashdata”:

      -
      $this->session->mark_as_flash('item');
-
      -
      -

      If you want to mark multiple items as flashdata, simply pass the keys as an -array:

      -
      $this->session->mark_as_flash(array('item', 'item2'));
-
      -
      -

      To add flashdata:

      -
      $_SESSION['item'] = 'value';
-$this->session->mark_as_flash('item');
-
      -
      -

      Or alternatively, using the set_flashdata() method:

      -
      $this->session->set_flashdata('item', 'value');
-
      -
      -

      You can also pass an array to set_flashdata(), in the same manner as -set_userdata().

      -

      Reading flashdata variables is the same as reading regular session data -through $_SESSION:

      -
      $_SESSION['item']
-
      -
      -
      -

      Important

      -

      The userdata() method will NOT return flashdata items.

      -
      -

      However, if you want to be sure that you’re reading “flashdata” (and not -any other kind), you can also use the flashdata() method:

      -
      $this->session->flashdata('item');
-
      -
      -

      Or to get an array with all flashdata, simply omit the key parameter:

      -
      $this->session->flashdata();
-
      -
      -
      -

      Note

      -

      The flashdata() method returns NULL if the item cannot be -found.

      -
      -

      If you find that you need to preserve a flashdata variable through an -additional request, you can do so using the keep_flashdata() method. -You can either pass a single item or an array of flashdata items to keep.

      -
      $this->session->keep_flashdata('item');
-$this->session->keep_flashdata(array('item1', 'item2', 'item3'));
-
      -
      -
      -
      -

      Tempdata

      -

      CodeIgniter also supports “tempdata”, or session data with a specific -expiration time. After the value expires, or the session expires or is -deleted, the value is automatically removed.

      -

      Similarly to flashdata, tempdata variables are regular session vars that -are marked in a specific way under the ‘__ci_vars’ key (again, don’t touch -that one).

      -

      To mark an existing item as “tempdata”, simply pass its key and expiry time -(in seconds!) to the mark_as_temp() method:

      -
      // 'item' will be erased after 300 seconds
-$this->session->mark_as_temp('item', 300);
-
      -
      -

      You can mark multiple items as tempdata in two ways, depending on whether -you want them all to have the same expiry time or not:

      -
      // Both 'item' and 'item2' will expire after 300 seconds
-$this->session->mark_as_temp(array('item', 'item2'), 300);
-
-// 'item' will be erased after 300 seconds, while 'item2'
-// will do so after only 240 seconds
-$this->session->mark_as_temp(array(
-        'item'  => 300,
-        'item2' => 240
-));
-
      -
      -

      To add tempdata:

      -
      $_SESSION['item'] = 'value';
-$this->session->mark_as_temp('item', 300); // Expire in 5 minutes
-
      -
      -

      Or alternatively, using the set_tempdata() method:

      -
      $this->session->set_tempdata('item', 'value', 300);
-
      -
      -

      You can also pass an array to set_tempdata():

      -
      $tempdata = array('newuser' => TRUE, 'message' => 'Thanks for joining!');
-
-$this->session->set_tempdata($tempdata, NULL, $expire);
-
      -
      -
      -

      Note

      -

      If the expiration is omitted or set to 0, the default -time-to-live value of 300 seconds (or 5 minutes) will be used.

      -
      -

      To read a tempdata variable, again you can just access it through the -$_SESSION superglobal array:

      -
      $_SESSION['item']
-
      -
      -
      -

      Important

      -

      The userdata() method will NOT return tempdata items.

      -
      -

      Or if you want to be sure that you’re reading “tempdata” (and not any -other kind), you can also use the tempdata() method:

      -
      $this->session->tempdata('item');
-
      -
      -

      And of course, if you want to retrieve all existing tempdata:

      -
      $this->session->tempdata();
-
      -
      -
      -

      Note

      -

      The tempdata() method returns NULL if the item cannot be -found.

      -
      -

      If you need to remove a tempdata value before it expires, you can directly -unset it from the $_SESSION array:

      -
      unset($_SESSION['item']);
-
      -
      -

      However, this won’t remove the marker that makes this specific item to be -tempdata (it will be invalidated on the next HTTP request), so if you -intend to reuse that same key in the same request, you’d want to use -unset_tempdata():

      -
      $this->session->unset_tempdata('item');
-
      -
      -
      -
      -

      Destroying a Session

      -

      To clear the current session (for example, during a logout), you may -simply use either PHP’s session_destroy() -function, or the sess_destroy() method. Both will work in exactly the -same way:

      -
      session_destroy();
-
-// or
-
-$this->session->sess_destroy();
-
      -
      -
      -

      Note

      -

      This must be the last session-related operation that you do -during the same request. All session data (including flashdata and -tempdata) will be destroyed permanently and functions will be -unusable during the same request after you destroy the session.

      -
      -
      -
      -

      Accessing session metadata

      -

      In previous CodeIgniter versions, the session data array included 4 items -by default: ‘session_id’, ‘ip_address’, ‘user_agent’, ‘last_activity’.

      -

      This was due to the specifics of how sessions worked, but is now no longer -necessary with our new implementation. However, it may happen that your -application relied on these values, so here are alternative methods of -accessing them:

      -
      -
        -
      • session_id: session_id()
        • -
      • ip_address: $_SERVER['REMOTE_ADDR']
        • -
      • user_agent: $this->input->user_agent() (unused by sessions)
        • -
      • last_activity: Depends on the storage, no straightforward way. Sorry!
        • -
      -
      -
      -
      -

      Session Preferences

      -

      CodeIgniter will usually make everything work out of the box. However, -Sessions are a very sensitive component of any application, so some -careful configuration must be done. Please take your time to consider -all of the options and their effects.

      -

      You’ll find the following Session related preferences in your -application/config/config.php file:

      - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefaultOptionsDescription
      sess_driverfilesfiles/database/redis/memcached/customThe session storage driver to use.
      sess_cookie_nameci_session[A-Za-z_-] characters onlyThe name used for the session cookie.
      sess_expiration7200 (2 hours)Time in seconds (integer)The number of seconds you would like the session to last. -If you would like a non-expiring session (until browser is closed) set the value to zero: 0
      sess_save_pathNULLNoneSpecifies the storage location, depends on the driver being used.
      sess_match_ipFALSETRUE/FALSE (boolean)Whether to validate the user’s IP address when reading the session cookie. -Note that some ISPs dynamically changes the IP, so if you want a non-expiring session you -will likely set this to FALSE.
      sess_time_to_update300Time in seconds (integer)This option controls how often the session class will regenerate itself and create a new -session ID. Setting it to 0 will disable session ID regeneration.
      sess_regenerate_destroyFALSETRUE/FALSE (boolean)Whether to destroy session data associated with the old session ID when auto-regenerating -the session ID. When set to FALSE, the data will be later deleted by the garbage collector.
      -
      -

      Note

      -

      As a last resort, the Session library will try to fetch PHP’s -session related INI settings, as well as legacy CI settings such as -‘sess_expire_on_close’ when any of the above is not configured. -However, you should never rely on this behavior as it can cause -unexpected results or be changed in the future. Please configure -everything properly.

      -
      -

      In addition to the values above, the cookie and native drivers apply the -following configuration values shared by the Input and -Security classes:

      - ----- - - - - - - - - - - - - - - - - - - - - -
      PreferenceDefaultDescription
      cookie_domain‘’The domain for which the session is applicable
      cookie_path/The path to which the session is applicable
      cookie_secureFALSEWhether to create the session cookie only on encrypted (HTTPS) connections
      -
      -

      Note

      -

      The ‘cookie_httponly’ setting doesn’t have an effect on sessions. -Instead the HttpOnly parameter is always enabled, for security -reasons. Additionaly, the ‘cookie_prefix’ setting is completely -ignored.

      -
      -
      -
      -

      Session Drivers

      -

      As already mentioned, the Session library comes with 4 drivers, or storage -engines, that you can use:

      -
      -
        -
      • files
        • -
      • database
        • -
      • redis
        • -
      • memcached
        • -
      -
      -

      By default, the Files Driver will be used when a session is initialized, -because it is the most safe choice and is expected to work everywhere -(virtually every environment has a file system).

      -

      However, any other driver may be selected via the $config['sess_driver'] -line in your application/config/config.php file, if you chose to do so. -Have it in mind though, every driver has different caveats, so be sure to -get yourself familiar with them (below) before you make that choice.

      -

      In addition, you may also create and use Custom Drivers, if the ones -provided by default don’t satisfy your use case.

      -
      -

      Note

      -

      In previous CodeIgniter versions, a different, “cookie driver” -was the only option and we have received negative feedback on not -providing that option. While we do listen to feedback from the -community, we want to warn you that it was dropped because it is -unsafe and we advise you NOT to try to replicate it via a -custom driver.

      -
      -
      -

      Files Driver

      -

      The ‘files’ driver uses your file system for storing session data.

      -

      It can safely be said that it works exactly like PHP’s own default session -implementation, but in case this is an important detail for you, have it -mind that it is in fact not the same code and it has some limitations -(and advantages).

      -

      To be more specific, it doesn’t support PHP’s directory level and mode -formats used in session.save_path, -and it has most of the options hard-coded for safety. Instead, only -absolute paths are supported for $config['sess_save_path'].

      -

      Another important thing that you should know, is to make sure that you -don’t use a publicly-readable or shared directory for storing your session -files. Make sure that only you have access to see the contents of your -chosen sess_save_path directory. Otherwise, anybody who can do that, can -also steal any of the current sessions (also known as “session fixation” -attack).

      -

      On UNIX-like operating systems, this is usually achieved by setting the -0700 mode permissions on that directory via the chmod command, which -allows only the directory’s owner to perform read and write operations on -it. But be careful because the system user running the script is usually -not your own, but something like ‘www-data’ instead, so only setting those -permissions will probable break your application.

      -

      Instead, you should do something like this, depending on your environment

      -
      mkdir /<path to your application directory>/sessions/
-chmod 0700 /<path to your application directory>/sessions/
-chown www-data /<path to your application directory>/sessions/
-
      -
      -
      -
      Bonus Tip
      -

      Some of you will probably opt to choose another session driver because -file storage is usually slower. This is only half true.

      -

      A very basic test will probably trick you into believing that an SQL -database is faster, but in 99% of the cases, this is only true while you -only have a few current sessions. As the sessions count and server loads -increase - which is the time when it matters - the file system will -consistently outperform almost all relational database setups.

      -

      In addition, if performance is your only concern, you may want to look -into using tmpfs, -(warning: external resource), which can make your sessions blazing fast.

      -
      -
      -
      -

      Database Driver

      -

      The ‘database’ driver uses a relational database such as MySQL or -PostgreSQL to store sessions. This is a popular choice among many users, -because it allows the developer easy access to the session data within -an application - it is just another table in your database.

      -

      However, there are some conditions that must be met:

      -
      -
        -
      • Only your default database connection (or the one that you access -as $this->db from your controllers) can be used.
        • -
      • You must have the Query Builder -enabled.
        • -
      • You can NOT use a persistent connection.
        • -
      • You can NOT use a connection with the cache_on setting enabled.
        • -
      -
      -

      In order to use the ‘database’ session driver, you must also create this -table that we already mentioned and then set it as your -$config['sess_save_path'] value. -For example, if you would like to use ‘ci_sessions’ as your table name, -you would do this:

      -
      $config['sess_driver'] = 'database';
-$config['sess_save_path'] = 'ci_sessions';
-
      -
      -
      -

      Note

      -

      If you’ve upgraded from a previous version of CodeIgniter and -you don’t have ‘sess_save_path’ configured, then the Session -library will look for the old ‘sess_table_name’ setting and use -it instead. Please don’t rely on this behavior as it will get -removed in the future.

      -
      -

      And then of course, create the database table ...

      -

      For MySQL:

      -
      CREATE TABLE IF NOT EXISTS `ci_sessions` (
-        `id` varchar(40) NOT NULL,
-        `ip_address` varchar(45) NOT NULL,
-        `timestamp` int(10) unsigned DEFAULT 0 NOT NULL,
-        `data` blob NOT NULL,
-        KEY `ci_sessions_timestamp` (`timestamp`)
-);
-
      -
      -

      For PostgreSQL:

      -
      CREATE TABLE "ci_sessions" (
-        "id" varchar(40) NOT NULL,
-        "ip_address" varchar(45) NOT NULL,
-        "timestamp" bigint DEFAULT 0 NOT NULL,
-        "data" text DEFAULT '' NOT NULL
-);
-
-CREATE INDEX "ci_sessions_timestamp" ON "ci_sessions" ("timestamp");
-
      -
      -

      You will also need to add a PRIMARY KEY depending on your ‘sess_match_ip’ -setting. The examples below work both on MySQL and PostgreSQL:

      -
      // When sess_match_ip = TRUE
-ALTER TABLE ci_sessions ADD PRIMARY KEY (id, ip_address);
-
-// When sess_match_ip = FALSE
-ALTER TABLE ci_sessions ADD PRIMARY KEY (id);
-
-// To drop a previously created primary key (use when changing the setting)
-ALTER TABLE ci_sessions DROP PRIMARY KEY;
-
      -
      -
      -

      Important

      -

      Only MySQL and PostgreSQL databases are officially -supported, due to lack of advisory locking mechanisms on other -platforms. Using sessions without locks can cause all sorts of -problems, especially with heavy usage of AJAX, and we will not -support such cases. Use session_write_close() after you’ve -done processing session data if you’re having performance -issues.

      -
      -
      -
      -

      Redis Driver

      -
      -

      Note

      -

      Since Redis doesn’t have a locking mechanism exposed, locks for -this driver are emulated by a separate value that is kept for up -to 300 seconds.

      -
      -

      Redis is a storage engine typically used for caching and popular because -of its high performance, which is also probably your reason to use the -‘redis’ session driver.

      -

      The downside is that it is not as ubiquitous as relational databases and -requires the phpredis PHP -extension to be installed on your system, and that one doesn’t come -bundled with PHP. -Chances are, you’re only be using the ‘redis’ driver only if you’re already -both familiar with Redis and using it for other purposes.

      -

      Just as with the ‘files’ and ‘database’ drivers, you must also configure -the storage location for your sessions via the -$config['sess_save_path'] setting. -The format here is a bit different and complicated at the same time. It is -best explained by the phpredis extension’s README file, so we’ll simply -link you to it:

      -
      -
      -
      -

      Warning

      -

      CodeIgniter’s Session library does NOT use the actual ‘redis’ -session.save_handler. Take note only of the path format in -the link above.

      -
      -

      For the most common case however, a simple host:port pair should be -sufficient:

      -
      $config['sess_driver'] = 'redis';
-$config['sess_save_path'] = 'tcp://localhost:6379';
-
      -
      -
      -
      -

      Memcached Driver

      -
      -

      Note

      -

      Since Memcache doesn’t have a locking mechanism exposed, locks -for this driver are emulated by a separate value that is kept for -up to 300 seconds.

      -
      -

      The ‘memcached’ driver is very similar to the ‘redis’ one in all of its -properties, except perhaps for availability, because PHP’s Memcached extension is distributed via PECL and some -Linux distrubutions make it available as an easy to install package.

      -

      Other than that, and without any intentional bias towards Redis, there’s -not much different to be said about Memcached - it is also a popular -product that is usually used for caching and famed for its speed.

      -

      However, it is worth noting that the only guarantee given by Memcached -is that setting value X to expire after Y seconds will result in it being -deleted after Y seconds have passed (but not necessarily that it won’t -expire earlier than that time). This happens very rarely, but should be -considered as it may result in loss of sessions.

      -

      The $config['sess_save_path'] format is fairly straightforward here, -being just a host:port pair:

      -
      $config['sess_driver'] = 'memcached';
-$config['sess_save_path'] = 'localhost:11211';
-
      -
      -
      -
      Bonus Tip
      -

      Multi-server configuration with an optional weight parameter as the -third colon-separated (:weight) value is also supported, but we have -to note that we haven’t tested if that is reliable.

      -

      If you want to experiment with this feature (on your own risk), simply -separate the multiple server paths with commas:

      -
      // localhost will be given higher priority (5) here,
-// compared to 192.0.2.1 with a weight of 1.
-$config['sess_save_path'] = 'localhost:11211:5,192.0.2.1:11211:1';
-
      -
      -
      -
      -
      -

      Custom Drivers

      -

      You may also create your own, custom session drivers. However, have it in -mind that this is typically not an easy task, as it takes a lot of -knowledge to do it properly.

      -

      You need to know not only how sessions work in general, but also how they -work specifically in PHP, how the underlying storage mechanism works, how -to handle concurrency, avoid deadlocks (but NOT through lack of locks) and -last but not least - how to handle the potential security issues, which -is far from trivial.

      -

      Long story short - if you don’t know how to do that already in raw PHP, -you shouldn’t be trying to do it within CodeIgniter either. You’ve been -warned.

      -

      If you only want to add some extra functionality to your sessions, just -extend the base Session class, which is a lot more easier. Read the -Creating Libraries article to -learn how to do that.

      -

      Now, to the point - there are three general rules that you must follow -when creating a session driver for CodeIgniter:

      -
      -
        -

      • Put your driver’s file under application/libraries/Session/drivers/ -and follow the naming conventions used by the Session class.

        -

        For example, if you were to create a ‘dummy’ driver, you would have -a Session_dummy_driver class name, that is declared in -application/libraries/Session/drivers/Session_dummy_driver.php.

        -
        • -

      • Extend the CI_Session_driver class.

        -

        This is just a basic class with a few internal helper methods. It is -also extendable like any other library, if you really need to do that, -but we are not going to explain how ... if you’re familiar with how -class extensions/overrides work in CI, then you already know how to do -it. If not, well, you shouldn’t be doing it in the first place.

        -
        • -

      • Implement the SessionHandlerInterface interface.

        -
        -

        Note

        -

        You may notice that SessionHandlerInterface is provided -by PHP since version 5.4.0. CodeIgniter will automatically declare -the same interface if you’re running an older PHP version.

        -
        -

        The link will explain why and how.

        -
        • -
      -
      -

      So, based on our ‘dummy’ driver example above, you’d end up with something -like this:

      -
      // application/libraries/Session/drivers/Session_dummy_driver.php:
-
-class CI_Session_dummy_driver extends CI_Session_driver implements SessionHandlerInterface
-{
-
-        public function __construct(&$params)
-        {
-                // DO NOT forget this
-                parent::__construct($params);
-
-                // Configuration & other initializations
-        }
-
-        public function open($save_path, $name)
-        {
-                // Initialize storage mechanism (connection)
-        }
-
-        public function read($session_id)
-        {
-                // Read session data (if exists), acquire locks
-        }
-
-        public function write($session_id, $session_data)
-        {
-                // Create / update session data (it might not exist!)
-        }
-
-        public function close()
-        {
-                // Free locks, close connections / streams / etc.
-        }
-
-        public function destroy($session_id)
-        {
-                // Call close() method & destroy data for current session (order may differ)
-        }
-
-        public function gc($maxlifetime)
-        {
-                // Erase data for expired sessions
-        }
-
-}
-
      -
      -

      If you’ve done everything properly, you can now set your sess_driver -configuration value to ‘dummy’ and use your own driver. Congratulations!

      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Session
      -
      -
      -userdata([$key = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Session item key or NULL
        • -
      -
      Returns:

      Value of the specified item key, or an array of all userdata

      -
      Return type:

      mixed

      -
      -

      Gets the value for a specific $_SESSION item, or an -array of all “userdata” items if not key was specified.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications. You should -directly access $_SESSION instead.

      -
      -
      - -
      -
      -all_userdata()
      -
      --- - - - - - -
      Returns:An array of all userdata
      Return type:array
      -

      Returns an array containing all “userdata” items.

      -
      -

      Note

      -

      This method is DEPRECATED. Use userdata() -with no parameters instead.

      -
      -
      - -
      -
      -&get_userdata()
      -
      --- - - - - - -
      Returns:A reference to $_SESSION
      Return type:array
      -

      Returns a reference to the $_SESSION array.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications.

      -
      -
      - -
      -
      -has_userdata($key)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Session item key
        • -
      -
      Returns:

      TRUE if the specified key exists, FALSE if not

      -
      Return type:

      bool

      -
      -

      Checks if an item exists in $_SESSION.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications. It is just -an alias for isset($_SESSION[$key]) - please -use that instead.

      -
      -
      - -
      -
      -set_userdata($data[, $value = NULL])
      -
      --- - - - - - -
      Parameters:
        -
      • $data (mixed) – An array of key/value pairs to set as session data, or the key for a single item
        • -
      • $value (mixed) – The value to set for a specific session item, if $data is a key
        • -
      -
      Return type:

      void

      -
      -

      Assigns data to the $_SESSION superglobal.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications.

      -
      -
      - -
      -
      -unset_userdata($key)
      -
      --- - - - - - -
      Parameters:
        -
      • $key (mixed) – Key for the session data item to unset, or an array of multiple keys
        • -
      -
      Return type:

      void

      -
      -

      Unsets the specified key(s) from the $_SESSION -superglobal.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications. It is just -an alias for unset($_SESSION[$key]) - please -use that instead.

      -
      -
      - -
      -
      -mark_as_flash($key)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Key to mark as flashdata, or an array of multiple keys
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Marks a $_SESSION item key (or multiple ones) as -“flashdata”.

      -
      - -
      -
      -get_flash_keys()
      -
      --- - - - - - -
      Returns:Array containing the keys of all “flashdata” items.
      Return type:array
      -

      Gets a list of all $_SESSION that have been marked as -“flashdata”.

      -
      - -
      -
      -umark_flash($key)
      -
      --- - - - - - -
      Parameters:
        -
      • $key (mixed) – Key to be un-marked as flashdata, or an array of multiple keys
        • -
      -
      Return type:

      void

      -
      -

      Unmarks a $_SESSION item key (or multiple ones) as -“flashdata”.

      -
      - -
      -
      -flashdata([$key = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Flashdata item key or NULL
        • -
      -
      Returns:

      Value of the specified item key, or an array of all flashdata

      -
      Return type:

      mixed

      -
      -

      Gets the value for a specific $_SESSION item that has -been marked as “flashdata”, or an array of all “flashdata” -items if no key was specified.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications. You should -directly access $_SESSION instead.

      -
      -
      - -
      -
      -keep_flashdata($key)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Flashdata key to keep, or an array of multiple keys
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Retains the specified session data key(s) as “flashdata” -through the next request.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications. It is just -an alias for the mark_as_flash() method.

      -
      -
      - -
      -
      -set_flashdata($data[, $value = NULL])
      -
      --- - - - - - -
      Parameters:
        -
      • $data (mixed) – An array of key/value pairs to set as flashdata, or the key for a single item
        • -
      • $value (mixed) – The value to set for a specific session item, if $data is a key
        • -
      -
      Return type:

      void

      -
      -

      Assigns data to the $_SESSION superglobal and marks it -as “flashdata”.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications.

      -
      -
      - -
      -
      -mark_as_temp($key[, $ttl = 300])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Key to mark as tempdata, or an array of multiple keys
        • -
      • $ttl (int) – Time-to-live value for the tempdata, in seconds
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Marks a $_SESSION item key (or multiple ones) as -“tempdata”.

      -
      - -
      -
      -get_temp_keys()
      -
      --- - - - - - -
      Returns:Array containing the keys of all “tempdata” items.
      Return type:array
      -

      Gets a list of all $_SESSION that have been marked as -“tempdata”.

      -
      - -
      -
      -umark_temp($key)
      -
      --- - - - - - -
      Parameters:
        -
      • $key (mixed) – Key to be un-marked as tempdata, or an array of multiple keys
        • -
      -
      Return type:

      void

      -
      -

      Unmarks a $_SESSION item key (or multiple ones) as -“tempdata”.

      -
      - -
      -
      -tempdata([$key = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (mixed) – Tempdata item key or NULL
        • -
      -
      Returns:

      Value of the specified item key, or an array of all tempdata

      -
      Return type:

      mixed

      -
      -

      Gets the value for a specific $_SESSION item that has -been marked as “tempdata”, or an array of all “tempdata” -items if no key was specified.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications. You should -directly access $_SESSION instead.

      -
      -
      - -
      -
      -set_tempdata($data[, $value = NULL])
      -
      --- - - - - - -
      Parameters:
        -
      • $data (mixed) – An array of key/value pairs to set as tempdata, or the key for a single item
        • -
      • $value (mixed) – The value to set for a specific session item, if $data is a key
        • -
      • $ttl (int) – Time-to-live value for the tempdata item(s), in seconds
        • -
      -
      Return type:

      void

      -
      -

      Assigns data to the $_SESSION superglobal and marks it -as “tempdata”.

      -
      -

      Note

      -

      This is a legacy method kept only for backwards -compatibility with older applications.

      -
      -
      - -
      -
      -sess_regenerate([$destroy = FALSE])
      -
      --- - - - - - -
      Parameters:
        -
      • $destroy (bool) – Whether to destroy session data
        • -
      -
      Return type:

      void

      -
      -

      Regenerate session ID, optionally destroying the current -session’s data.

      -
      -

      Note

      -

      This method is just an alias for PHP’s native -session_regenerate_id() function.

      -
      -
      - -
      -
      -sess_destroy()
      -
      --- - - - -
      Return type:void
      -

      Destroys the current session.

      -
      -

      Note

      -

      This must be the last session-related function -that you call. All session data will be lost after -you do that.

      -
      -
      -

      Note

      -

      This method is just an alias for PHP’s native -session_destroy() function.

      -
      -
      - -
      -
      -__get($key)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Session item key
        • -
      -
      Returns:

      The requested session data item, or NULL if it doesn’t exist

      -
      Return type:

      mixed

      -
      -

      A magic method that allows you to use -$this->session->item instead of $_SESSION['item'], -if that’s what you prefer.

      -

      It will also return the session ID by calling -session_id() if you try to access -$this->session->session_id.

      -
      - -
      -
      -__set($key, $value)
      -
      --- - - - - - -
      Parameters:
        -
      • $key (string) – Session item key
        • -
      • $value (mixed) – Value to assign to the session item key
        • -
      -
      Returns:

      void

      -
      -

      A magic method that allows you to assign items to -$_SESSION by accessing them as $this->session -properties:

      -
      $this->session->foo = 'bar';
-
-// Results in:
-// $_SESSION['foo'] = 'bar';
-
      -
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/table.html b/user_guide/libraries/table.html deleted file mode 100755 index ca0d0ce..0000000 --- a/user_guide/libraries/table.html +++ /dev/null @@ -1,912 +0,0 @@ - - - - - - - - - - HTML Table Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      HTML Table Class

      -

      The Table Class provides functions that enable you to auto-generate HTML -tables from arrays or database result sets.

      - -
      -

      Using the Table Class

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the Table class is initialized -in your controller using the $this->load->library() method:

      -
      $this->load->library('table');
-
      -
      -

      Once loaded, the Table library object will be available using:

      -
      $this->table
-
      -
      -
      -
      -

      Examples

      -

      Here is an example showing how you can create a table from a -multi-dimensional array. Note that the first array index will become the -table heading (or you can set your own headings using the set_heading() -method described in the function reference below).

      -
      $this->load->library('table');
-
-$data = array(
-        array('Name', 'Color', 'Size'),
-        array('Fred', 'Blue', 'Small'),
-        array('Mary', 'Red', 'Large'),
-        array('John', 'Green', 'Medium')
-);
-
-echo $this->table->generate($data);
-
      -
      -

      Here is an example of a table created from a database query result. The -table class will automatically generate the headings based on the table -names (or you can set your own headings using the set_heading() -method described in the class reference below).

      -
      $this->load->library('table');
-
-$query = $this->db->query('SELECT * FROM my_table');
-
-echo $this->table->generate($query);
-
      -
      -

      Here is an example showing how you might create a table using discrete -parameters:

      -
      $this->load->library('table');
-
-$this->table->set_heading('Name', 'Color', 'Size');
-
-$this->table->add_row('Fred', 'Blue', 'Small');
-$this->table->add_row('Mary', 'Red', 'Large');
-$this->table->add_row('John', 'Green', 'Medium');
-
-echo $this->table->generate();
-
      -
      -

      Here is the same example, except instead of individual parameters, -arrays are used:

      -
      $this->load->library('table');
-
-$this->table->set_heading(array('Name', 'Color', 'Size'));
-
-$this->table->add_row(array('Fred', 'Blue', 'Small'));
-$this->table->add_row(array('Mary', 'Red', 'Large'));
-$this->table->add_row(array('John', 'Green', 'Medium'));
-
-echo $this->table->generate();
-
      -
      -
      -
      -

      Changing the Look of Your Table

      -

      The Table Class permits you to set a table template with which you can -specify the design of your layout. Here is the template prototype:

      -
      $template = array(
-        'table_open'            => '<table border="0" cellpadding="4" cellspacing="0">',
-
-        'thead_open'            => '<thead>',
-        'thead_close'           => '</thead>',
-
-        'heading_row_start'     => '<tr>',
-        'heading_row_end'       => '</tr>',
-        'heading_cell_start'    => '<th>',
-        'heading_cell_end'      => '</th>',
-
-        'tbody_open'            => '<tbody>',
-        'tbody_close'           => '</tbody>',
-
-        'row_start'             => '<tr>',
-        'row_end'               => '</tr>',
-        'cell_start'            => '<td>',
-        'cell_end'              => '</td>',
-
-        'row_alt_start'         => '<tr>',
-        'row_alt_end'           => '</tr>',
-        'cell_alt_start'        => '<td>',
-        'cell_alt_end'          => '</td>',
-
-        'table_close'           => '</table>'
-);
-
-$this->table->set_template($template);
-
      -
      -
      -

      Note

      -

      You’ll notice there are two sets of “row” blocks in the -template. These permit you to create alternating row colors or design -elements that alternate with each iteration of the row data.

      -
      -

      You are NOT required to submit a complete template. If you only need to -change parts of the layout you can simply submit those elements. In this -example, only the table opening tag is being changed:

      -
      $template = array(
-        'table_open' => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">'
-);
-
-$this->table->set_template($template);
-
      -
      -

      You can also set defaults for these in a config file.

      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Table
      -
      -
      -$function = NULL
      -

      Allows you to specify a native PHP function or a valid function array object to be applied to all cell data.

      -
      $this->load->library('table');
-
-$this->table->set_heading('Name', 'Color', 'Size');
-$this->table->add_row('Fred', '<strong>Blue</strong>', 'Small');
-
-$this->table->function = 'htmlspecialchars';
-echo $this->table->generate();
-
      -
      -

      In the above example, all cell data would be ran through PHP’s htmlspecialchars() function, resulting in:

      -
      <td>Fred</td><td>&lt;strong&gt;Blue&lt;/strong&gt;</td><td>Small</td>
-
      -
      -
      - -
      -
      -generate([$table_data = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $table_data (mixed) – Data to populate the table rows with
        • -
      -
      Returns:

      HTML table

      -
      Return type:

      string

      -
      -

      Returns a string containing the generated table. Accepts an optional parameter which can be an array or a database result object.

      -
      - -
      -
      -set_caption($caption)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $caption (string) – Table caption
        • -
      -
      Returns:

      CI_Table instance (method chaining)

      -
      Return type:

      CI_Table

      -
      -

      Permits you to add a caption to the table.

      -
      $this->table->set_caption('Colors');
-
      -
      -
      - -
      -
      -set_heading([$args = array()[, ...]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $args (mixed) – An array or multiple strings containing the table column titles
        • -
      -
      Returns:

      CI_Table instance (method chaining)

      -
      Return type:

      CI_Table

      -
      -

      Permits you to set the table heading. You can submit an array or discrete params:

      -
      $this->table->set_heading('Name', 'Color', 'Size');
-
-$this->table->set_heading(array('Name', 'Color', 'Size'));
-
      -
      -
      - -
      -
      -add_row([$args = array()[, ...]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $args (mixed) – An array or multiple strings containing the row values
        • -
      -
      Returns:

      CI_Table instance (method chaining)

      -
      Return type:

      CI_Table

      -
      -

      Permits you to add a row to your table. You can submit an array or discrete params:

      -
      $this->table->add_row('Blue', 'Red', 'Green');
-
-$this->table->add_row(array('Blue', 'Red', 'Green'));
-
      -
      -

      If you would like to set an individual cell’s tag attributes, you can use an associative array for that cell. -The associative key data defines the cell’s data. Any other key => val pairs are added as key=’val’ attributes to the tag:

      -
      $cell = array('data' => 'Blue', 'class' => 'highlight', 'colspan' => 2);
-$this->table->add_row($cell, 'Red', 'Green');
-
-// generates
-// <td class='highlight' colspan='2'>Blue</td><td>Red</td><td>Green</td>
-
      -
      -
      - -
      -
      -make_columns([$array = array()[, $col_limit = 0]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $array (array) – An array containing multiple rows’ data
        • -
      • $col_limit (int) – Count of columns in the table
        • -
      -
      Returns:

      An array of HTML table columns

      -
      Return type:

      array

      -
      -

      This method takes a one-dimensional array as input and creates a multi-dimensional array with a depth equal to the number of columns desired. -This allows a single array with many elements to be displayed in a table that has a fixed column count. Consider this example:

      -
      $list = array('one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten', 'eleven', 'twelve');
-
-$new_list = $this->table->make_columns($list, 3);
-
-$this->table->generate($new_list);
-
-// Generates a table with this prototype
-
-<table border="0" cellpadding="4" cellspacing="0">
-<tr>
-<td>one</td><td>two</td><td>three</td>
-</tr><tr>
-<td>four</td><td>five</td><td>six</td>
-</tr><tr>
-<td>seven</td><td>eight</td><td>nine</td>
-</tr><tr>
-<td>ten</td><td>eleven</td><td>twelve</td></tr>
-</table>
-
      -
      -
      - -
      -
      -set_template($template)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $template (array) – An associative array containing template values
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Permits you to set your template. You can submit a full or partial template.

      -
      $template = array(
-        'table_open'  => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">'
-);
-
-$this->table->set_template($template);
-
      -
      -
      - -
      -
      -set_empty($value)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $value (mixed) – Value to put in empty cells
        • -
      -
      Returns:

      CI_Table instance (method chaining)

      -
      Return type:

      CI_Table

      -
      -

      Lets you set a default value for use in any table cells that are empty. -You might, for example, set a non-breaking space:

      -
      $this->table->set_empty("&nbsp;");
-
      -
      -
      - -
      -
      -clear()
      -
      --- - - - - - -
      Returns:CI_Table instance (method chaining)
      Return type:CI_Table
      -

      Lets you clear the table heading and row data. If you need to show multiple tables with different data you should to call this method -after each table has been generated to clear the previous table information. Example:

      -
      $this->load->library('table');
-
-$this->table->set_heading('Name', 'Color', 'Size');
-$this->table->add_row('Fred', 'Blue', 'Small');
-$this->table->add_row('Mary', 'Red', 'Large');
-$this->table->add_row('John', 'Green', 'Medium');
-
-echo $this->table->generate();
-
-$this->table->clear();
-
-$this->table->set_heading('Name', 'Day', 'Delivery');
-$this->table->add_row('Fred', 'Wednesday', 'Express');
-$this->table->add_row('Mary', 'Monday', 'Air');
-$this->table->add_row('John', 'Saturday', 'Overnight');
-
-echo $this->table->generate();
-
      -
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/trackback.html b/user_guide/libraries/trackback.html deleted file mode 100755 index 2eb6bdd..0000000 --- a/user_guide/libraries/trackback.html +++ /dev/null @@ -1,1036 +0,0 @@ - - - - - - - - - - Trackback Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Trackback Class

      -

      The Trackback Class provides functions that enable you to send and -receive Trackback data.

      -

      If you are not familiar with Trackbacks you’ll find more information -here.

      - -
      -

      Using the Trackback Class

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the Trackback class is -initialized in your controller using the $this->load->library() method:

      -
      $this->load->library('trackback');
-
      -
      -

      Once loaded, the Trackback library object will be available using:

      -
      $this->trackback
-
      -
      -
      -
      -

      Sending Trackbacks

      -

      A Trackback can be sent from any of your controller functions using code -similar to this example:

      -
      $this->load->library('trackback');
-
-$tb_data = array(
-        'ping_url'  => 'http://example.com/trackback/456',
-        'url'       => 'http://www.my-example.com/blog/entry/123',
-        'title'     => 'The Title of My Entry',
-        'excerpt'   => 'The entry content.',
-        'blog_name' => 'My Blog Name',
-        'charset'   => 'utf-8'
-);
-
-if ( ! $this->trackback->send($tb_data))
-{
-        echo $this->trackback->display_errors();
-}
-else
-{
-        echo 'Trackback was sent!';
-}
-
      -
      -

      Description of array data:

      -
        -
      • ping_url - The URL of the site you are sending the Trackback to. -You can send Trackbacks to multiple URLs by separating each URL with a comma.
        • -
      • url - The URL to YOUR site where the weblog entry can be seen.
        • -
      • title - The title of your weblog entry.
        • -
      • excerpt - The content of your weblog entry.
        • -
      • blog_name - The name of your weblog.
        • -
      • charset - The character encoding your weblog is written in. If omitted, UTF-8 will be used.
        • -
      -
      -

      Note

      -

      The Trackback class will automatically send only the first 500 characters of your -entry. It will also strip all HTML.

      -
      -

      The Trackback sending method returns TRUE/FALSE (boolean) on success -or failure. If it fails, you can retrieve the error message using:

      -
      $this->trackback->display_errors();
-
      -
      -
      -
      -

      Receiving Trackbacks

      -

      Before you can receive Trackbacks you must create a weblog. If you don’t -have a blog yet there’s no point in continuing.

      -

      Receiving Trackbacks is a little more complex than sending them, only -because you will need a database table in which to store them, and you -will need to validate the incoming trackback data. You are encouraged to -implement a thorough validation process to guard against spam and -duplicate data. You may also want to limit the number of Trackbacks you -allow from a particular IP within a given span of time to further -curtail spam. The process of receiving a Trackback is quite simple; the -validation is what takes most of the effort.

      -
      -
      -

      Your Ping URL

      -

      In order to accept Trackbacks you must display a Trackback URL next to -each one of your weblog entries. This will be the URL that people will -use to send you Trackbacks (we will refer to this as your “Ping URL”).

      -

      Your Ping URL must point to a controller function where your Trackback -receiving code is located, and the URL must contain the ID number for -each particular entry, so that when the Trackback is received you’ll be -able to associate it with a particular entry.

      -

      For example, if your controller class is called Trackback, and the -receiving function is called receive, your Ping URLs will look something -like this:

      -
      http://example.com/index.php/trackback/receive/entry_id
-
      -
      -

      Where entry_id represents the individual ID number for each of your -entries.

      -
      -
      -

      Creating a Trackback Table

      -

      Before you can receive Trackbacks you must create a table in which to -store them. Here is a basic prototype for such a table:

      -
      CREATE TABLE trackbacks (
-        tb_id int(10) unsigned NOT NULL auto_increment,
-        entry_id int(10) unsigned NOT NULL default 0,
-        url varchar(200) NOT NULL,
-        title varchar(100) NOT NULL,
-        excerpt text NOT NULL,
-        blog_name varchar(100) NOT NULL,
-        tb_date int(10) NOT NULL,
-        ip_address varchar(45) NOT NULL,
-        PRIMARY KEY `tb_id` (`tb_id`),
-        KEY `entry_id` (`entry_id`)
-);
-
      -
      -

      The Trackback specification only requires four pieces of information to -be sent in a Trackback (url, title, excerpt, blog_name), but to make -the data more useful we’ve added a few more fields in the above table -schema (date, IP address, etc.).

      -
      -
      -

      Processing a Trackback

      -

      Here is an example showing how you will receive and process a Trackback. -The following code is intended for use within the controller function -where you expect to receive Trackbacks.:

      -
      $this->load->library('trackback');
-$this->load->database();
-
-if ($this->uri->segment(3) == FALSE)
-{
-        $this->trackback->send_error('Unable to determine the entry ID');
-}
-
-if ( ! $this->trackback->receive())
-{
-        $this->trackback->send_error('The Trackback did not contain valid data');
-}
-
-$data = array(
-        'tb_id'      => '',
-        'entry_id'   => $this->uri->segment(3),
-        'url'        => $this->trackback->data('url'),
-        'title'      => $this->trackback->data('title'),
-        'excerpt'    => $this->trackback->data('excerpt'),
-        'blog_name'  => $this->trackback->data('blog_name'),
-        'tb_date'    => time(),
-        'ip_address' => $this->input->ip_address()
-);
-
-$sql = $this->db->insert_string('trackbacks', $data);
-$this->db->query($sql);
-
-$this->trackback->send_success();
-
      -
      -
      -

      Notes:

      -

      The entry ID number is expected in the third segment of your URL. This -is based on the URI example we gave earlier:

      -
      http://example.com/index.php/trackback/receive/entry_id
-
      -
      -

      Notice the entry_id is in the third URI segment, which you can retrieve -using:

      -
      $this->uri->segment(3);
-
      -
      -

      In our Trackback receiving code above, if the third segment is missing, -we will issue an error. Without a valid entry ID, there’s no reason to -continue.

      -

      The $this->trackback->receive() function is simply a validation function -that looks at the incoming data and makes sure it contains the four -pieces of data that are required (url, title, excerpt, blog_name). It -returns TRUE on success and FALSE on failure. If it fails you will issue -an error message.

      -

      The incoming Trackback data can be retrieved using this function:

      -
      $this->trackback->data('item')
-
      -
      -

      Where item represents one of these four pieces of info: url, title, -excerpt, or blog_name

      -

      If the Trackback data is successfully received, you will issue a success -message using:

      -
      $this->trackback->send_success();
-
      -
      -
      -

      Note

      -

      The above code contains no data validation, which you are -encouraged to add.

      -
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Trackback
      -
      -
      -$data = array('url' => '', 'title' => '', 'excerpt' => '', 'blog_name' => '', 'charset' => '')
      -

      Trackback data array.

      -
      - -
      -
      -$convert_ascii = TRUE
      -

      Whether to convert high ASCII and MS Word characters to HTML entities.

      -
      - -
      -
      -send($tb_data)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $tb_data (array) – Trackback data
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Send trackback.

      -
      - -
      -
      -receive()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      This method simply validates the incoming TB data, returning TRUE on success and FALSE on failure. -If the data is valid it is set to the $this->data array so that it can be inserted into a database.

      -
      - -
      -
      -send_error([$message = 'Incomplete information')
      -
      --- - - - - - -
      Parameters:
        -
      • $message (string) – Error message
        • -
      -
      Return type:

      void

      -
      -

      Responses to a trackback request with an error message.

      -
      -

      Note

      -

      This method will terminate script execution.

      -
      -
      - -
      -
      -send_success()
      -
      --- - - - -
      Return type:void
      -

      Responses to a trackback request with a success message.

      -
      -

      Note

      -

      This method will terminate script execution.

      -
      -
      - -
      -
      -data($item)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $item (string) – Data key
        • -
      -
      Returns:

      Data value or empty string if not found

      -
      Return type:

      string

      -
      -

      Returns a single item from the reponse data array.

      -
      - -
      -
      -process($url, $data)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $url (string) – Target url
        • -
      • $data (string) – Raw POST data
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Opens a socket connection and passes the data to the server, returning TRUE on success and FALSE on failure.

      -
      - -
      -
      -extract_urls($urls)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $urls (string) – Comma-separated URL list
        • -
      -
      Returns:

      Array of URLs

      -
      Return type:

      array

      -
      -

      This method lets multiple trackbacks to be sent. It takes a string of URLs (separated by comma or space) and puts each URL into an array.

      -
      - -
      -
      -validate_url(&$url)
      -
      --- - - - - - -
      Parameters:
        -
      • $url (string) – Trackback URL
        • -
      -
      Return type:

      void

      -
      -

      Simply adds the http:// prefix it it’s not already present in the URL.

      -
      - -
      -
      -get_id($url)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $url (string) – Trackback URL
        • -
      -
      Returns:

      URL ID or FALSE on failure

      -
      Return type:

      string

      -
      -

      Find and return a trackback URL’s ID or FALSE on failure.

      -
      - -
      -
      -convert_xml($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      Converted string

      -
      Return type:

      string

      -
      -

      Converts reserved XML characters to entities.

      -
      - -
      -
      -limit_characters($str[, $n = 500[, $end_char = '&#8230;']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      • $n (int) – Max characters number
        • -
      • $end_char (string) – Character to put at end of string
        • -
      -
      Returns:

      Shortened string

      -
      Return type:

      string

      -
      -

      Limits the string based on the character count. Will preserve complete words.

      -
      - -
      -
      -convert_ascii($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      Converted string

      -
      Return type:

      string

      -
      -

      Converts high ASCII text and MS Word special characterss to HTML entities.

      -
      - -
      -
      -set_error($msg)
      -
      --- - - - - - -
      Parameters:
        -
      • $msg (string) – Error message
        • -
      -
      Return type:

      void

      -
      -

      Set an log an error message.

      -
      - -
      -
      -display_errors([$open = '<p>'[, $close = '</p>']])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $open (string) – Open tag
        • -
      • $close (string) – Close tag
        • -
      -
      Returns:

      HTML formatted error messages

      -
      Return type:

      string

      -
      -

      Returns error messages formatted in HTML or an empty string if there are no errors.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/typography.html b/user_guide/libraries/typography.html deleted file mode 100755 index 2d1ebd6..0000000 --- a/user_guide/libraries/typography.html +++ /dev/null @@ -1,607 +0,0 @@ - - - - - - - - - - Typography Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Typography Class

      -

      The Typography Class provides methods that help you format text.

      - -
      -

      Using the Typography Class

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the Typography class is -initialized in your controller using the $this->load->library() method:

      -
      $this->load->library('typography');
-
      -
      -

      Once loaded, the Typography library object will be available using:

      -
      $this->typography
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Typography
      -
      -
      -$protect_braced_quotes = FALSE
      -

      When using the Typography library in conjunction with the Template Parser library -it can often be desirable to protect single and double quotes within curly braces. -To enable this, set the protect_braced_quotes class property to TRUE.

      -

      Usage example:

      -
      $this->load->library('typography');
-$this->typography->protect_braced_quotes = TRUE;
-
      -
      -
      - -
      -
      -format_characters($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      Formatted string

      -
      Return type:

      string

      -
      -

      This method is similar to auto_typography() above, except that it only does character conversion:

      -
      -
        -
      • Quotes are converted to correctly facing curly quote entities, except those that appear within tags.
        • -
      • Apostrophes are converted to curly apostrophe entities.
        • -
      • Double dashes (either like – this or like–this) are converted to em—dashes.
        • -
      • Three consecutive periods either preceding or following a word are converted to ellipsis (…).
        • -
      • Double spaces following sentences are converted to non-breaking spaces to mimic double spacing.
        • -
      -
      -

      Usage example:

      -
      $string = $this->typography->format_characters($string);
-
      -
      -
      - -
      -
      -nl2br_except_pre($str)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $str (string) – Input string
        • -
      -
      Returns:

      Formatted string

      -
      Return type:

      string

      -
      -

      Converts newlines to <br /> tags unless they appear within <pre> tags. -This method is identical to the native PHP nl2br() function, except that it ignores <pre> tags.

      -

      Usage example:

      -
      $string = $this->typography->nl2br_except_pre($string);
-
      -
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/unit_testing.html b/user_guide/libraries/unit_testing.html deleted file mode 100755 index 1be92dc..0000000 --- a/user_guide/libraries/unit_testing.html +++ /dev/null @@ -1,847 +0,0 @@ - - - - - - - - - - Unit Testing Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries »
        • - -
      • Unit Testing Class
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Unit Testing Class

      -

      Unit testing is an approach to software development in which tests are -written for each function in your application. If you are not familiar -with the concept you might do a little googling on the subject.

      -

      CodeIgniter’s Unit Test class is quite simple, consisting of an -evaluation function and two result functions. It’s not intended to be a -full-blown test suite but rather a simple mechanism to evaluate your -code to determine if it is producing the correct data type and result.

      - -
      -

      Using the Unit Testing Library

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the Unit Test class is -initialized in your controller using the $this->load->library function:

      -
      $this->load->library('unit_test');
-
      -
      -

      Once loaded, the Unit Test object will be available using $this->unit

      -
      -
      -

      Running Tests

      -

      Running a test involves supplying a test and an expected result in the -following way:

      -
      -
      $this->unit->run(‘test’, ‘expected result’, ‘test name’, ‘notes’);
      -

      Where test is the result of the code you wish to test, expected result -is the data type you expect, test name is an optional name you can give -your test, and notes are optional notes. Example:

      -
      $test = 1 + 1;
-
-$expected_result = 2;
-
-$test_name = 'Adds one plus one';
-
-$this->unit->run($test, $expected_result, $test_name);
-
      -
      -

      The expected result you supply can either be a literal match, or a data -type match. Here’s an example of a literal:

      -
      $this->unit->run('Foo', 'Foo');
-
      -
      -

      Here is an example of a data type match:

      -
      $this->unit->run('Foo', 'is_string');
-
      -
      -

      Notice the use of “is_string” in the second parameter? This tells the -function to evaluate whether your test is producing a string as the -result. Here is a list of allowed comparison types:

      -
        -
      • is_object
        • -
      • is_string
        • -
      • is_bool
        • -
      • is_true
        • -
      • is_false
        • -
      • is_int
        • -
      • is_numeric
        • -
      • is_float
        • -
      • is_double
        • -
      • is_array
        • -
      • is_null
        • -
      • is_resource
        • -
      -
      -
      -

      Generating Reports

      -

      You can either display results after each test, or your can run several -tests and generate a report at the end. To show a report directly simply -echo or return the run function:

      -
      echo $this->unit->run($test, $expected_result);
-
      -
      -

      To run a full report of all tests, use this:

      -
      echo $this->unit->report();
-
      -
      -

      The report will be formatted in an HTML table for viewing. If you prefer -the raw data you can retrieve an array using:

      -
      echo $this->unit->result();
-
      -
      -
      -
      -

      Strict Mode

      -

      By default the unit test class evaluates literal matches loosely. -Consider this example:

      -
      $this->unit->run(1, TRUE);
-
      -
      -

      The test is evaluating an integer, but the expected result is a boolean. -PHP, however, due to it’s loose data-typing will evaluate the above code -as TRUE using a normal equality test:

      -
      if (1 == TRUE) echo 'This evaluates as true';
-
      -
      -

      If you prefer, you can put the unit test class in to strict mode, which -will compare the data type as well as the value:

      -
      if (1 === TRUE) echo 'This evaluates as FALSE';
-
      -
      -

      To enable strict mode use this:

      -
      $this->unit->use_strict(TRUE);
-
      -
      -
      -
      -

      Enabling/Disabling Unit Testing

      -

      If you would like to leave some testing in place in your scripts, but -not have it run unless you need it, you can disable unit testing using:

      -
      $this->unit->active(FALSE);
-
      -
      -
      -
      -

      Unit Test Display

      -

      When your unit test results display, the following items show by -default:

      -
        -
      • Test Name (test_name)
        • -
      • Test Datatype (test_datatype)
        • -
      • Expected Datatype (res_datatype)
        • -
      • Result (result)
        • -
      • File Name (file)
        • -
      • Line Number (line)
        • -
      • Any notes you entered for the test (notes)
        • -
      -

      You can customize which of these items get displayed by using -$this->unit->set_test_items(). For example, if you only wanted the test name -and the result displayed:

      -
      -

      Customizing displayed tests

      -
      $this->unit->set_test_items(array('test_name', 'result'));
-
      -
      -
      -
      -

      Creating a Template

      -

      If you would like your test results formatted differently then the -default you can set your own template. Here is an example of a simple -template. Note the required pseudo-variables:

      -
      $str = '
-<table border="0" cellpadding="4" cellspacing="1">
-{rows}
-        <tr>
-                <td>{item}</td>
-                <td>{result}</td>
-        </tr>
-{/rows}
-</table>';
-
-$this->unit->set_template($str);
-
      -
      -
      -

      Note

      -

      Your template must be declared before running the unit -test process.

      -
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Unit_test
      -
      -
      -set_test_items($items)
      -
      --- - - - - - -
      Parameters:
        -
      • $items (array) – List of visible test items
        • -
      -
      Returns:

      void

      -
      -

      Sets a list of items that should be visible in tests. -Valid options are:

      -
      -
        -
      • test_name
        • -
      • test_datatype
        • -
      • res_datatype
        • -
      • result
        • -
      • file
        • -
      • line
        • -
      • notes
        • -
      -
      -
      - -
      -
      -run($test[, $expected = TRUE[, $test_name = 'undefined'[, $notes = '']]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $test (mixed) – Test data
        • -
      • $expected (mixed) – Expected result
        • -
      • $test_name (string) – Test name
        • -
      • $notes (string) – Any notes to be attached to the test
        • -
      -
      Returns:

      Test report

      -
      Return type:

      string

      -
      -

      Runs unit tests.

      -
      - -
      -
      -report([$result = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $result (array) – Array containing tests results
        • -
      -
      Returns:

      Test report

      -
      Return type:

      string

      -
      -

      Generates a report about already complete tests.

      -
      - -
      -
      -use_strict([$state = TRUE])
      -
      --- - - - - - -
      Parameters:
        -
      • $state (bool) – Strict state flag
        • -
      -
      Return type:

      void

      -
      -

      Enables/disables strict type comparison in tests.

      -
      - -
      -
      -active([$state = TRUE])
      -
      --- - - - - - -
      Parameters:
        -
      • $state (bool) – Whether to enable testing
        • -
      -
      Return type:

      void

      -
      -

      Enables/disables unit testing.

      -
      - -
      -
      -result([$results = array()])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $results (array) – Tests results list
        • -
      -
      Returns:

      Array of raw result data

      -
      Return type:

      array

      -
      -

      Returns raw tests results data.

      -
      - -
      -
      -set_template($template)
      -
      --- - - - - - -
      Parameters:
        -
      • $template (string) – Test result template
        • -
      -
      Return type:

      void

      -
      -

      Sets the template for displaying tests results.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/uri.html b/user_guide/libraries/uri.html deleted file mode 100755 index a6366c9..0000000 --- a/user_guide/libraries/uri.html +++ /dev/null @@ -1,891 +0,0 @@ - - - - - - - - - - URI Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      URI Class

      -

      The URI Class provides methods that help you retrieve information from -your URI strings. If you use URI routing, you can also retrieve -information about the re-routed segments.

      -
      -

      Note

      -

      This class is initialized automatically by the system so there -is no need to do it manually.

      -
      - -
      -

      Class Reference

      -
      -
      -class CI_URI
      -
      -
      -segment($n[, $no_result = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Segment index number
        • -
      • $no_result (mixed) – What to return if the searched segment is not found
        • -
      -
      Returns:

      Segment value or $no_result value if not found

      -
      Return type:

      mixed

      -
      -

      Permits you to retrieve a specific segment. Where n is the segment -number you wish to retrieve. Segments are numbered from left to right. -For example, if your full URL is this:

      -
      http://example.com/index.php/news/local/metro/crime_is_up
-
      -
      -

      The segment numbers would be this:

      -
        -
      1. news
        2. -
      2. local
        3. -
      3. metro
        4. -
      4. crime_is_up
        5. -
      -

      The optional second parameter defaults to NULL and allows you to set the return value -of this method when the requested URI segment is missing. -For example, this would tell the method to return the number zero in the event of failure:

      -
      $product_id = $this->uri->segment(3, 0);
-
      -
      -

      It helps avoid having to write code like this:

      -
      if ($this->uri->segment(3) === FALSE)
-{
-        $product_id = 0;
-}
-else
-{
-        $product_id = $this->uri->segment(3);
-}
-
      -
      -
      - -
      -
      -rsegment($n[, $no_result = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Segment index number
        • -
      • $no_result (mixed) – What to return if the searched segment is not found
        • -
      -
      Returns:

      Routed segment value or $no_result value if not found

      -
      Return type:

      mixed

      -
      -

      This method is identical to segment(), except that it lets you retrieve -a specific segment from your re-routed URI in the event you are -using CodeIgniter’s URI Routing feature.

      -
      - -
      -
      -slash_segment($n[, $where = 'trailing'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Segment index number
        • -
      • $where (string) – Where to add the slash (‘trailing’ or ‘leading’)
        • -
      -
      Returns:

      Segment value, prepended/suffixed with a forward slash, or a slash if not found

      -
      Return type:

      string

      -
      -

      This method is almost identical to segment(), except it -adds a trailing and/or leading slash based on the second parameter. -If the parameter is not used, a trailing slash added. Examples:

      -
      $this->uri->slash_segment(3);
-$this->uri->slash_segment(3, 'leading');
-$this->uri->slash_segment(3, 'both');
-
      -
      -

      Returns:

      -
        -
      1. segment/
        2. -
      2. /segment
        3. -
      3. /segment/
        4. -
      -
      - -
      -
      -slash_rsegment($n[, $where = 'trailing'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Segment index number
        • -
      • $where (string) – Where to add the slash (‘trailing’ or ‘leading’)
        • -
      -
      Returns:

      Routed segment value, prepended/suffixed with a forward slash, or a slash if not found

      -
      Return type:

      string

      -
      -

      This method is identical to slash_segment(), except that it lets you -add slashes a specific segment from your re-routed URI in the event you -are using CodeIgniter’s URI Routing -feature.

      -
      - -
      -
      -uri_to_assoc([$n = 3[, $default = array()]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Segment index number
        • -
      • $default (array) – Default values
        • -
      -
      Returns:

      Associative URI segments array

      -
      Return type:

      array

      -
      -

      This method lets you turn URI segments into an associative array of -key/value pairs. Consider this URI:

      -
      index.php/user/search/name/joe/location/UK/gender/male
-
      -
      -

      Using this method you can turn the URI into an associative array with -this prototype:

      -
      [array]
-(
-        'name'          => 'joe'
-        'location'      => 'UK'
-        'gender'        => 'male'
-)
-
      -
      -

      The first parameter lets you set an offset, which defaults to 3 since your -URI will normally contain a controller/method pair in the first and second segments. -Example:

      -
      $array = $this->uri->uri_to_assoc(3);
-echo $array['name'];
-
      -
      -

      The second parameter lets you set default key names, so that the array -returned will always contain expected indexes, even if missing from the URI. -Example:

      -
      $default = array('name', 'gender', 'location', 'type', 'sort');
-$array = $this->uri->uri_to_assoc(3, $default);
-
      -
      -

      If the URI does not contain a value in your default, an array index will -be set to that name, with a value of NULL.

      -

      Lastly, if a corresponding value is not found for a given key (if there -is an odd number of URI segments) the value will be set to NULL.

      -
      - -
      -
      -ruri_to_assoc([$n = 3[, $default = array()]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $n (int) – Segment index number
        • -
      • $default (array) – Default values
        • -
      -
      Returns:

      Associative routed URI segments array

      -
      Return type:

      array

      -
      -

      This method is identical to uri_to_assoc(), except that it creates -an associative array using the re-routed URI in the event you are using -CodeIgniter’s URI Routing feature.

      -
      - -
      -
      -assoc_to_uri($array)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $array (array) – Input array of key/value pairs
        • -
      -
      Returns:

      URI string

      -
      Return type:

      string

      -
      -

      Takes an associative array as input and generates a URI string from it. -The array keys will be included in the string. Example:

      -
      $array = array('product' => 'shoes', 'size' => 'large', 'color' => 'red');
-$str = $this->uri->assoc_to_uri($array);
-
-// Produces: product/shoes/size/large/color/red
-
      -
      -
      - -
      -
      -uri_string()
      -
      --- - - - - - -
      Returns:URI string
      Return type:string
      -

      Returns a string with the complete URI. For example, if this is your full URL:

      -
      http://example.com/index.php/news/local/345
-
      -
      -

      The method would return this:

      -
      news/local/345
-
      -
      -
      - -
      -
      -ruri_string()
      -
      --- - - - - - -
      Returns:Routed URI string
      Return type:string
      -

      This method is identical to uri_string(), except that it returns -the re-routed URI in the event you are using CodeIgniter’s URI -Routing feature.

      -
      - -
      -
      -total_segments()
      -
      --- - - - - - -
      Returns:Count of URI segments
      Return type:int
      -

      Returns the total number of segments.

      -
      - -
      -
      -total_rsegments()
      -
      --- - - - - - -
      Returns:Count of routed URI segments
      Return type:int
      -

      This method is identical to total_segments(), except that it returns -the total number of segments in your re-routed URI in the event you are -using CodeIgniter’s URI Routing feature.

      -
      - -
      -
      -segment_array()
      -
      --- - - - - - -
      Returns:URI segments array
      Return type:array
      -

      Returns an array containing the URI segments. For example:

      -
      $segs = $this->uri->segment_array();
-
-foreach ($segs as $segment)
-{
-        echo $segment;
-        echo '<br />';
-}
-
      -
      -
      - -
      -
      -rsegment_array()
      -
      --- - - - - - -
      Returns:Routed URI segments array
      Return type:array
      -

      This method is identical to segment_array(), except that it returns -the array of segments in your re-routed URI in the event you are using -CodeIgniter’s URI Routing feature.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/user_agent.html b/user_guide/libraries/user_agent.html deleted file mode 100755 index 593d30a..0000000 --- a/user_guide/libraries/user_agent.html +++ /dev/null @@ -1,932 +0,0 @@ - - - - - - - - - - User Agent Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      User Agent Class

      -

      The User Agent Class provides functions that help identify information -about the browser, mobile device, or robot visiting your site. In -addition you can get referrer information as well as language and -supported character-set information.

      - -
      -

      Using the User Agent Class

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the User Agent class is -initialized in your controller using the $this->load->library function:

      -
      $this->load->library('user_agent');
-
      -
      -

      Once loaded, the object will be available using: $this->agent

      -
      -
      -

      User Agent Definitions

      -

      The user agent name definitions are located in a config file located at: -application/config/user_agents.php. You may add items to the various -user agent arrays if needed.

      -
      -
      -

      Example

      -

      When the User Agent class is initialized it will attempt to determine -whether the user agent browsing your site is a web browser, a mobile -device, or a robot. It will also gather the platform information if it -is available.

      -
      $this->load->library('user_agent');
-
-if ($this->agent->is_browser())
-{
-        $agent = $this->agent->browser().' '.$this->agent->version();
-}
-elseif ($this->agent->is_robot())
-{
-        $agent = $this->agent->robot();
-}
-elseif ($this->agent->is_mobile())
-{
-        $agent = $this->agent->mobile();
-}
-else
-{
-        $agent = 'Unidentified User Agent';
-}
-
-echo $agent;
-
-echo $this->agent->platform(); // Platform info (Windows, Linux, Mac, etc.)
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_User_agent
      -
      -
      -is_browser([$key = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Optional browser name
        • -
      -
      Returns:

      TRUE if the user agent is a (specified) browser, FALSE if not

      -
      Return type:

      bool

      -
      -

      Returns TRUE/FALSE (boolean) if the user agent is a known web browser.

      -
      if ($this->agent->is_browser('Safari'))
-{
-        echo 'You are using Safari.';
-}
-elseif ($this->agent->is_browser())
-{
-        echo 'You are using a browser.';
-}
-
      -
      -
      -

      Note

      -

      The string “Safari” in this example is an array key in the list of browser definitions. -You can find this list in application/config/user_agents.php if you want to add new -browsers or change the stings.

      -
      -
      - -
      -
      -is_mobile([$key = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Optional mobile device name
        • -
      -
      Returns:

      TRUE if the user agent is a (specified) mobile device, FALSE if not

      -
      Return type:

      bool

      -
      -

      Returns TRUE/FALSE (boolean) if the user agent is a known mobile device.

      -
      if ($this->agent->is_mobile('iphone'))
-{
-        $this->load->view('iphone/home');
-}
-elseif ($this->agent->is_mobile())
-{
-        $this->load->view('mobile/home');
-}
-else
-{
-        $this->load->view('web/home');
-}
-
      -
      -
      - -
      -
      -is_robot([$key = NULL])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $key (string) – Optional robot name
        • -
      -
      Returns:

      TRUE if the user agent is a (specified) robot, FALSE if not

      -
      Return type:

      bool

      -
      -

      Returns TRUE/FALSE (boolean) if the user agent is a known robot.

      -
      -

      Note

      -

      The user agent library only contains the most common robot definitions. It is not a complete list of bots. -There are hundreds of them so searching for each one would not be very efficient. If you find that some bots -that commonly visit your site are missing from the list you can add them to your -application/config/user_agents.php file.

      -
      -
      - -
      -
      -is_referral()
      -
      --- - - - - - -
      Returns:TRUE if the user agent is a referral, FALSE if not
      Return type:bool
      -

      Returns TRUE/FALSE (boolean) if the user agent was referred from another site.

      -
      - -
      -
      -browser()
      -
      --- - - - - - -
      Returns:Detected browser or an empty string
      Return type:string
      -

      Returns a string containing the name of the web browser viewing your site.

      -
      - -
      -
      -version()
      -
      --- - - - - - -
      Returns:Detected browser version or an empty string
      Return type:string
      -

      Returns a string containing the version number of the web browser viewing your site.

      -
      - -
      -
      -mobile()
      -
      --- - - - - - -
      Returns:Detected mobile device brand or an empty string
      Return type:string
      -

      Returns a string containing the name of the mobile device viewing your site.

      -
      - -
      -
      -robot()
      -
      --- - - - - - -
      Returns:Detected robot name or an empty string
      Return type:string
      -

      Returns a string containing the name of the robot viewing your site.

      -
      - -
      -
      -platform()
      -
      --- - - - - - -
      Returns:Detected operating system or an empty string
      Return type:string
      -

      Returns a string containing the platform viewing your site (Linux, Windows, OS X, etc.).

      -
      - -
      -
      -referrer()
      -
      --- - - - - - -
      Returns:Detected referrer or an empty string
      Return type:string
      -

      The referrer, if the user agent was referred from another site. Typically you’ll test for this as follows:

      -
      if ($this->agent->is_referral())
-{
-        echo $this->agent->referrer();
-}
-
      -
      -
      - -
      -
      -agent_string()
      -
      --- - - - - - -
      Returns:Full user agent string or an empty string
      Return type:string
      -

      Returns a string containing the full user agent string. Typically it will be something like this:

      -
      Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.0.4) Gecko/20060613 Camino/1.0.2
-
      -
      -
      - -
      -
      -accept_lang([$lang = 'en'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $lang (string) – Language key
        • -
      -
      Returns:

      TRUE if provided language is accepted, FALSE if not

      -
      Return type:

      bool

      -
      -

      Lets you determine if the user agent accepts a particular language. Example:

      -
      if ($this->agent->accept_lang('en'))
-{
-        echo 'You accept English!';
-}
-
      -
      -
      -

      Note

      -

      This method is not typically very reliable since some browsers do not provide language info, -and even among those that do, it is not always accurate.

      -
      -
      - -
      -
      -languages()
      -
      --- - - - - - -
      Returns:An array list of accepted languages
      Return type:array
      -

      Returns an array of languages supported by the user agent.

      -
      - -
      -
      -accept_charset([$charset = 'utf-8'])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $charset (string) – Character set
        • -
      -
      Returns:

      TRUE if the character set is accepted, FALSE if not

      -
      Return type:

      bool

      -
      -

      Lets you determine if the user agent accepts a particular character set. Example:

      -
      if ($this->agent->accept_charset('utf-8'))
-{
-        echo 'You browser supports UTF-8!';
-}
-
      -
      -
      -

      Note

      -

      This method is not typically very reliable since some browsers do not provide character-set info, -and even among those that do, it is not always accurate.

      -
      -
      - -
      -
      -charsets()
      -
      --- - - - - - -
      Returns:An array list of accepted character sets
      Return type:array
      -

      Returns an array of character sets accepted by the user agent.

      -
      - -
      -
      -parse($string)
      -
      --- - - - - - -
      Parameters:
        -
      • $string (string) – A custom user-agent string
        • -
      -
      Return type:

      void

      -
      -

      Parses a custom user-agent string, different from the one reported by the current visitor.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/xmlrpc.html b/user_guide/libraries/xmlrpc.html deleted file mode 100755 index 7b0cc77..0000000 --- a/user_guide/libraries/xmlrpc.html +++ /dev/null @@ -1,1149 +0,0 @@ - - - - - - - - - - XML-RPC and XML-RPC Server Classes — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries »
        • - -
      • XML-RPC and XML-RPC Server Classes
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      XML-RPC and XML-RPC Server Classes

      -

      CodeIgniter’s XML-RPC classes permit you to send requests to another -server, or set up your own XML-RPC server to receive requests.

      - -
      -

      What is XML-RPC?

      -

      Quite simply it is a way for two computers to communicate over the -internet using XML. One computer, which we will call the client, sends -an XML-RPC request to another computer, which we will call the -server. Once the server receives and processes the request it will send -back a response to the client.

      -

      For example, using the MetaWeblog API, an XML-RPC Client (usually a -desktop publishing tool) will send a request to an XML-RPC Server -running on your site. This request might be a new weblog entry being -sent for publication, or it could be a request for an existing entry for -editing. When the XML-RPC Server receives this request it will examine -it to determine which class/method should be called to process the -request. Once processed, the server will then send back a response -message.

      -

      For detailed specifications, you can visit the XML-RPC site.

      -
      -
      -

      Using the XML-RPC Class

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the XML-RPC and XML-RPCS classes -are initialized in your controller using the $this->load->library -function:

      -

      To load the XML-RPC class you will use:

      -
      $this->load->library('xmlrpc');
-
      -
      -

      Once loaded, the xml-rpc library object will be available using: -$this->xmlrpc

      -

      To load the XML-RPC Server class you will use:

      -
      $this->load->library('xmlrpc');
-$this->load->library('xmlrpcs');
-
      -
      -

      Once loaded, the xml-rpcs library object will be available using: -$this->xmlrpcs

      -
      -

      Note

      -

      When using the XML-RPC Server class you must load BOTH the -XML-RPC class and the XML-RPC Server class.

      -
      -
      -
      -

      Sending XML-RPC Requests

      -

      To send a request to an XML-RPC server you must specify the following -information:

      -
        -
      • The URL of the server
        • -
      • The method on the server you wish to call
        • -
      • The request data (explained below).
        • -
      -

      Here is a basic example that sends a simple Weblogs.com ping to the -Ping-o-Matic

      -
      $this->load->library('xmlrpc');
-
-$this->xmlrpc->server('http://rpc.pingomatic.com/', 80);
-$this->xmlrpc->method('weblogUpdates.ping');
-
-$request = array('My Photoblog', 'http://www.my-site.com/photoblog/');
-$this->xmlrpc->request($request);
-
-if ( ! $this->xmlrpc->send_request())
-{
-        echo $this->xmlrpc->display_error();
-}
-
      -
      -
      -

      Explanation

      -

      The above code initializes the XML-RPC class, sets the server URL and -method to be called (weblogUpdates.ping). The request (in this case, the -title and URL of your site) is placed into an array for transportation, -and compiled using the request() function. Lastly, the full request is -sent. If the send_request() method returns false we will display the -error message sent back from the XML-RPC Server.

      -
      -
      -
      -

      Anatomy of a Request

      -

      An XML-RPC request is simply the data you are sending to the XML-RPC -server. Each piece of data in a request is referred to as a request -parameter. The above example has two parameters: The URL and title of -your site. When the XML-RPC server receives your request, it will look -for parameters it requires.

      -

      Request parameters must be placed into an array for transportation, and -each parameter can be one of seven data types (strings, numbers, dates, -etc.). If your parameters are something other than strings you will have -to include the data type in the request array.

      -

      Here is an example of a simple array with three parameters:

      -
      $request = array('John', 'Doe', 'www.some-site.com');
-$this->xmlrpc->request($request);
-
      -
      -

      If you use data types other than strings, or if you have several -different data types, you will place each parameter into its own array, -with the data type in the second position:

      -
      $request = array(
-        array('John', 'string'),
-        array('Doe', 'string'),
-        array(FALSE, 'boolean'),
-        array(12345, 'int')
-);
-$this->xmlrpc->request($request);
-
      -
      -

      The Data Types section below has a full list of data -types.

      -
      -
      -

      Creating an XML-RPC Server

      -

      An XML-RPC Server acts as a traffic cop of sorts, waiting for incoming -requests and redirecting them to the appropriate functions for -processing.

      -

      To create your own XML-RPC server involves initializing the XML-RPC -Server class in your controller where you expect the incoming request to -appear, then setting up an array with mapping instructions so that -incoming requests can be sent to the appropriate class and method for -processing.

      -

      Here is an example to illustrate:

      -
      $this->load->library('xmlrpc');
-$this->load->library('xmlrpcs');
-
-$config['functions']['new_post'] = array('function' => 'My_blog.new_entry');
-$config['functions']['update_post'] = array('function' => 'My_blog.update_entry');
-$config['object'] = $this;
-
-$this->xmlrpcs->initialize($config);
-$this->xmlrpcs->serve();
-
      -
      -

      The above example contains an array specifying two method requests that -the Server allows. The allowed methods are on the left side of the -array. When either of those are received, they will be mapped to the -class and method on the right.

      -

      The ‘object’ key is a special key that you pass an instantiated class -object with, which is necessary when the method you are mapping to is -not part of the CodeIgniter super object.

      -

      In other words, if an XML-RPC Client sends a request for the new_post -method, your server will load the My_blog class and call the new_entry -function. If the request is for the update_post method, your server -will load the My_blog class and call the update_entry() method.

      -

      The function names in the above example are arbitrary. You’ll decide -what they should be called on your server, or if you are using -standardized APIs, like the Blogger or MetaWeblog API, you’ll use their -function names.

      -

      There are two additional configuration keys you may make use of when -initializing the server class: debug can be set to TRUE in order to -enable debugging, and xss_clean may be set to FALSE to prevent sending -data through the Security library’s xss_clean() method.

      -
      -
      -

      Processing Server Requests

      -

      When the XML-RPC Server receives a request and loads the class/method -for processing, it will pass an object to that method containing the -data sent by the client.

      -

      Using the above example, if the new_post method is requested, the -server will expect a class to exist with this prototype:

      -
      class My_blog extends CI_Controller {
-
-        public function new_post($request)
-        {
-
-        }
-}
-
      -
      -

      The $request variable is an object compiled by the Server, which -contains the data sent by the XML-RPC Client. Using this object you will -have access to the request parameters enabling you to process the -request. When you are done you will send a Response back to the Client.

      -

      Below is a real-world example, using the Blogger API. One of the methods -in the Blogger API is getUserInfo(). Using this method, an XML-RPC -Client can send the Server a username and password, in return the Server -sends back information about that particular user (nickname, user ID, -email address, etc.). Here is how the processing function might look:

      -
      class My_blog extends CI_Controller {
-
-        public function getUserInfo($request)
-        {
-                $username = 'smitty';
-                $password = 'secretsmittypass';
-
-                $this->load->library('xmlrpc');
-
-                $parameters = $request->output_parameters();
-
-                if ($parameters[1] != $username && $parameters[2] != $password)
-                {
-                        return $this->xmlrpc->send_error_message('100', 'Invalid Access');
-                }
-
-                $response = array(
-                        array(
-                                'nickname'  => array('Smitty', 'string'),
-                                'userid'    => array('99', 'string'),
-                                'url'       => array('http://yoursite.com', 'string'),
-                                'email'     => array('jsmith@yoursite.com', 'string'),
-                                'lastname'  => array('Smith', 'string'),
-                                'firstname' => array('John', 'string')
-                        ),
-                         'struct'
-                );
-
-                return $this->xmlrpc->send_response($response);
-        }
-}
-
      -
      -
      -

      Notes:

      -

      The output_parameters() method retrieves an indexed array -corresponding to the request parameters sent by the client. In the above -example, the output parameters will be the username and password.

      -

      If the username and password sent by the client were not valid, and -error message is returned using send_error_message().

      -

      If the operation was successful, the client will be sent back a response -array containing the user’s info.

      -
      -
      -
      -

      Formatting a Response

      -

      Similar to Requests, Responses must be formatted as an array. -However, unlike requests, a response is an array that contains a -single item. This item can be an array with several additional arrays, -but there can be only one primary array index. In other words, the basic -prototype is this:

      -
      $response = array('Response data', 'array');
-
      -
      -

      Responses, however, usually contain multiple pieces of information. In -order to accomplish this we must put the response into its own array so -that the primary array continues to contain a single piece of data. -Here’s an example showing how this might be accomplished:

      -
      $response = array(
-        array(
-                'first_name' => array('John', 'string'),
-                'last_name' => array('Doe', 'string'),
-                'member_id' => array(123435, 'int'),
-                'todo_list' => array(array('clean house', 'call mom', 'water plants'), 'array'),
-        ),
-        'struct'
-);
-
      -
      -

      Notice that the above array is formatted as a struct. This is the most -common data type for responses.

      -

      As with Requests, a response can be one of the seven data types listed -in the Data Types section.

      -
      -
      -

      Sending an Error Response

      -

      If you need to send the client an error response you will use the -following:

      -
      return $this->xmlrpc->send_error_message('123', 'Requested data not available');
-
      -
      -

      The first parameter is the error number while the second parameter is -the error message.

      -
      -
      -

      Creating Your Own Client and Server

      -

      To help you understand everything we’ve covered thus far, let’s create a -couple controllers that act as XML-RPC Client and Server. You’ll use the -Client to send a request to the Server and receive a response.

      -
      -

      The Client

      -

      Using a text editor, create a controller called Xmlrpc_client.php. In -it, place this code and save it to your application/controllers/ -folder:

      -
      <?php
-
-class Xmlrpc_client extends CI_Controller {
-
-        public function index()
-        {
-                $this->load->helper('url');
-                $server_url = site_url('xmlrpc_server');
-
-                $this->load->library('xmlrpc');
-
-                $this->xmlrpc->server($server_url, 80);
-                $this->xmlrpc->method('Greetings');
-
-                $request = array('How is it going?');
-                $this->xmlrpc->request($request);
-
-                if ( ! $this->xmlrpc->send_request())
-                {
-                        echo $this->xmlrpc->display_error();
-                }
-                else
-                {
-                        echo '<pre>';
-                        print_r($this->xmlrpc->display_response());
-                        echo '</pre>';
-                }
-        }
-}
-?>
-
      -
      -
      -

      Note

      -

      In the above code we are using a “url helper”. You can find more -information in the Helpers Functions page.

      -
      -
      -
      -

      The Server

      -

      Using a text editor, create a controller called Xmlrpc_server.php. In -it, place this code and save it to your application/controllers/ -folder:

      -
      <?php
-
-class Xmlrpc_server extends CI_Controller {
-
-        public function index()
-        {
-                $this->load->library('xmlrpc');
-                $this->load->library('xmlrpcs');
-
-                $config['functions']['Greetings'] = array('function' => 'Xmlrpc_server.process');
-
-                $this->xmlrpcs->initialize($config);
-                $this->xmlrpcs->serve();
-        }
-
-
-        public function process($request)
-        {
-                $parameters = $request->output_parameters();
-
-                $response = array(
-                        array(
-                                'you_said'  => $parameters[0],
-                                'i_respond' => 'Not bad at all.'
-                        ),
-                        'struct'
-                );
-
-                return $this->xmlrpc->send_response($response);
-        }
-}
-
      -
      -
      -
      -

      Try it!

      -

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

      -
      example.com/index.php/xmlrpc_client/
-
      -
      -

      You should now see the message you sent to the server, and its response -back to you.

      -

      The client you created sends a message (“How’s is going?”) to the -server, along with a request for the “Greetings” method. The Server -receives the request and maps it to the process() method, where a -response is sent back.

      -
      -
      -
      -

      Using Associative Arrays In a Request Parameter

      -

      If you wish to use an associative array in your method parameters you -will need to use a struct datatype:

      -
      $request = array(
-        array(
-                // Param 0
-                array('name' => 'John'),
-                'struct'
-        ),
-        array(
-                // Param 1
-                array(
-                        'size' => 'large',
-                        'shape'=>'round'
-                ),
-                'struct'
-        )
-);
-
-$this->xmlrpc->request($request);
-
      -
      -

      You can retrieve the associative array when processing the request in -the Server.

      -
      $parameters = $request->output_parameters();
-$name = $parameters[0]['name'];
-$size = $parameters[1]['size'];
-$shape = $parameters[1]['shape'];
-
      -
      -
      -
      -

      Data Types

      -

      According to the XML-RPC spec there are -seven types of values that you can send via XML-RPC:

      -
        -
      • int or i4
        • -
      • boolean
        • -
      • string
        • -
      • double
        • -
      • dateTime.iso8601
        • -
      • base64
        • -
      • struct (contains array of values)
        • -
      • array (contains array of values)
        • -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Xmlrpc
      -
      -
      -initialize([$config = array()])
      -
      --- - - - - - -
      Parameters:
        -
      • $config (array) – Configuration data
        • -
      -
      Return type:

      void

      -
      -

      Initializes the XML-RPC library. Accepts an associative array containing your settings.

      -
      - -
      -
      -server($url[, $port = 80[, $proxy = FALSE[, $proxy_port = 8080]]])
      -
      --- - - - - - -
      Parameters:
        -
      • $url (string) – XML-RPC server URL
        • -
      • $port (int) – Server port
        • -
      • $proxy (string) – Optional proxy
        • -
      • $proxy_port (int) – Proxy listening port
        • -
      -
      Return type:

      void

      -
      -

      Sets the URL and port number of the server to which a request is to be sent:

      -
      $this->xmlrpc->server('http://www.sometimes.com/pings.php', 80);
-
      -
      -

      Basic HTTP authentication is also supported, simply add it to the server URL:

      -
      $this->xmlrpc->server('http://user:pass@localhost/', 80);
-
      -
      -
      - -
      -
      -timeout($seconds = 5)
      -
      --- - - - - - -
      Parameters:
        -
      • $seconds (int) – Timeout in seconds
        • -
      -
      Return type:

      void

      -
      -

      Set a time out period (in seconds) after which the request will be canceled:

      -
      $this->xmlrpc->timeout(6);
-
      -
      -
      - -
      -
      -method($function)
      -
      --- - - - - - -
      Parameters:
        -
      • $function (string) – Method name
        • -
      -
      Return type:

      void

      -
      -

      Sets the method that will be requested from the XML-RPC server:

      -
      $this->xmlrpc->method('method');
-
      -
      -

      Where method is the name of the method.

      -
      - -
      -
      -request($incoming)
      -
      --- - - - - - -
      Parameters:
        -
      • $incoming (array) – Request data
        • -
      -
      Return type:

      void

      -
      -

      Takes an array of data and builds request to be sent to XML-RPC server:

      -
      $request = array(array('My Photoblog', 'string'), 'http://www.yoursite.com/photoblog/');
-$this->xmlrpc->request($request);
-
      -
      -
      - -
      -
      -send_request()
      -
      --- - - - - - -
      Returns:TRUE on success, FALSE on failure
      Return type:bool
      -

      The request sending method. Returns boolean TRUE or FALSE based on success for failure, enabling it to be used conditionally.

      -
      - -
      -
      -display_error()
      -
      --- - - - - - -
      Returns:Error message string
      Return type:string
      -

      Returns an error message as a string if your request failed for some reason.

      -
      echo $this->xmlrpc->display_error();
-
      -
      -
      - -
      -
      -display_response()
      -
      --- - - - - - -
      Returns:Response
      Return type:mixed
      -

      Returns the response from the remote server once request is received. The response will typically be an associative array.

      -
      $this->xmlrpc->display_response();
-
      -
      -
      - -
      -
      -send_error_message($number, $message)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $number (int) – Error number
        • -
      • $message (string) – Error message
        • -
      -
      Returns:

      XML_RPC_Response instance

      -
      Return type:

      XML_RPC_Response

      -
      -

      This method lets you send an error message from your server to the client. -First parameter is the error number while the second parameter is the error message.

      -
      return $this->xmlrpc->send_error_message(123, 'Requested data not available');
-
      -
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/libraries/zip.html b/user_guide/libraries/zip.html deleted file mode 100755 index e2aa64c..0000000 --- a/user_guide/libraries/zip.html +++ /dev/null @@ -1,846 +0,0 @@ - - - - - - - - - - Zip Encoding Class — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Libraries »
        • - -
      • Zip Encoding Class
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Zip Encoding Class

      -

      CodeIgniter’s Zip Encoding Class permits you to create Zip archives. -Archives can be downloaded to your desktop or saved to a directory.

      - -
      -

      Using the Zip Encoding Class

      -
      -

      Initializing the Class

      -

      Like most other classes in CodeIgniter, the Zip class is initialized in -your controller using the $this->load->library function:

      -
      $this->load->library('zip');
-
      -
      -

      Once loaded, the Zip library object will be available using:

      -
      -
      $this->zip
      -
      -
      -

      Usage Example

      -

      This example demonstrates how to compress a file, save it to a folder on -your server, and download it to your desktop.

      -
      $name = 'mydata1.txt';
-$data = 'A Data String!';
-
-$this->zip->add_data($name, $data);
-
-// Write the zip file to a folder on your server. Name it "my_backup.zip"
-$this->zip->archive('/path/to/directory/my_backup.zip');
-
-// Download the file to your desktop. Name it "my_backup.zip"
-$this->zip->download('my_backup.zip');
-
      -
      -
      -
      -
      -

      Class Reference

      -
      -
      -class CI_Zip
      -
      -
      -$compression_level = 2
      -

      The compression level to use.

      -

      It can range from 0 to 9, with 9 being the highest and 0 effectively disabling compression:

      -
      $this->zip->compression_level = 0;
-
      -
      -
      - -
      -
      -add_data($filepath[, $data = NULL])
      -
      --- - - - - - -
      Parameters:
        -
      • $filepath (mixed) – A single file path or an array of file => data pairs
        • -
      • $data (array) – File contents (ignored if $filepath is an array)
        • -
      -
      Return type:

      void

      -
      -

      Adds data to the Zip archive. Can work both in single and multiple files mode.

      -

      When adding a single file, the first parameter must contain the name you would -like given to the file and the second must contain the file contents:

      -
      $name = 'mydata1.txt';
-$data = 'A Data String!';
-$this->zip->add_data($name, $data);
-
-$name = 'mydata2.txt';
-$data = 'Another Data String!';
-$this->zip->add_data($name, $data);
-
      -
      -

      When adding multiple files, the first parameter must contain file => contents pairs -and the second parameter is ignored:

      -
      $data = array(
-        'mydata1.txt' => 'A Data String!',
-        'mydata2.txt' => 'Another Data String!'
-);
-
-$this->zip->add_data($data);
-
      -
      -

      If you would like your compressed data organized into sub-directories, simply include -the path as part of the filename(s):

      -
      $name = 'personal/my_bio.txt';
-$data = 'I was born in an elevator...';
-
-$this->zip->add_data($name, $data);
-
      -
      -

      The above example will place my_bio.txt inside a folder called personal.

      -
      - -
      -
      -add_dir($directory)
      -
      --- - - - - - -
      Parameters:
        -
      • $directory (mixed) – Directory name string or an array of multiple directories
        • -
      -
      Return type:

      void

      -
      -

      Permits you to add a directory. Usually this method is unnecessary since you can place -your data into directories when using $this->zip->add_data(), but if you would like -to create an empty directory you can do so:

      -
      $this->zip->add_dir('myfolder'); // Creates a directory called "myfolder"
-
      -
      -
      - -
      -
      -read_file($path[, $archive_filepath = FALSE])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Path to file
        • -
      • $archive_filepath (mixed) – New file name/path (string) or (boolean) whether to maintain the original filepath
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Permits you to compress a file that already exists somewhere on your server. -Supply a file path and the zip class will read it and add it to the archive:

      -
      $path = '/path/to/photo.jpg';
-
-$this->zip->read_file($path);
-
-// Download the file to your desktop. Name it "my_backup.zip"
-$this->zip->download('my_backup.zip');
-
      -
      -

      If you would like the Zip archive to maintain the directory structure of -the file in it, pass TRUE (boolean) in the second parameter. Example:

      -
      $path = '/path/to/photo.jpg';
-
-$this->zip->read_file($path, TRUE);
-
-// Download the file to your desktop. Name it "my_backup.zip"
-$this->zip->download('my_backup.zip');
-
      -
      -

      In the above example, photo.jpg will be placed into the path/to/ directory.

      -

      You can also specify a new name (path included) for the added file on the fly:

      -
      $path = '/path/to/photo.jpg';
-$new_path = '/new/path/some_photo.jpg';
-
-$this->zip->read_file($path, $new_path);
-
-// Download ZIP archive containing /new/path/some_photo.jpg
-$this->zip->download('my_archive.zip');
-
      -
      -
      - -
      -
      -read_dir($path[, $preserve_filepath = TRUE[, $root_path = NULL]])
      -
      --- - - - - - - - -
      Parameters:
        -
      • $path (string) – Path to directory
        • -
      • $preserve_filepath (bool) – Whether to maintain the original path
        • -
      • $root_path (string) – Part of the path to exclude from the archive directory
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Permits you to compress a directory (and its contents) that already exists somewhere on your server. -Supply a path to the directory and the zip class will recursively read and recreate it as a Zip archive. -All files contained within the supplied path will be encoded, as will any sub-directories contained within it. Example:

      -
      $path = '/path/to/your/directory/';
-
-$this->zip->read_dir($path);
-
-// Download the file to your desktop. Name it "my_backup.zip"
-$this->zip->download('my_backup.zip');
-
      -
      -

      By default the Zip archive will place all directories listed in the first parameter -inside the zip. If you want the tree preceding the target directory to be ignored, -you can pass FALSE (boolean) in the second parameter. Example:

      -
      $path = '/path/to/your/directory/';
-
-$this->zip->read_dir($path, FALSE);
-
      -
      -

      This will create a ZIP with a directory named “directory” inside, then all sub-directories -stored correctly inside that, but will not include the /path/to/your part of the path.

      -
      - -
      -
      -archive($filepath)
      -
      --- - - - - - - - -
      Parameters:
        -
      • $filepath (string) – Path to target zip archive
        • -
      -
      Returns:

      TRUE on success, FALSE on failure

      -
      Return type:

      bool

      -
      -

      Writes the Zip-encoded file to a directory on your server. Submit a valid server path -ending in the file name. Make sure the directory is writable (755 is usually OK). -Example:

      -
      $this->zip->archive('/path/to/folder/myarchive.zip'); // Creates a file named myarchive.zip
-
      -
      -
      - -
      -
      -download($filename = 'backup.zip')
      -
      --- - - - - - -
      Parameters:
        -
      • $filename (string) – Archive file name
        • -
      -
      Return type:

      void

      -
      -

      Causes the Zip file to be downloaded from your server. -You must pass the name you would like the zip file called. Example:

      -
      $this->zip->download('latest_stuff.zip'); // File will be named "latest_stuff.zip"
-
      -
      -
      -

      Note

      -

      Do not display any data in the controller in which you call -this method since it sends various server headers that cause the -download to happen and the file to be treated as binary.

      -
      -
      - -
      -
      -get_zip()
      -
      --- - - - - - -
      Returns:Zip file content
      Return type:string
      -

      Returns the Zip-compressed file data. Generally you will not need this method unless you -want to do something unique with the data. Example:

      -
      $name = 'my_bio.txt';
-$data = 'I was born in an elevator...';
-
-$this->zip->add_data($name, $data);
-
-$zip_file = $this->zip->get_zip();
-
      -
      -
      - -
      -
      -clear_data()
      -
      --- - - - -
      Return type:void
      -

      The Zip class caches your zip data so that it doesn’t need to recompile the Zip archive -for each method you use above. If, however, you need to create multiple Zip archives, -each with different data, you can clear the cache between calls. Example:

      -
      $name = 'my_bio.txt';
-$data = 'I was born in an elevator...';
-
-$this->zip->add_data($name, $data);
-$zip_file = $this->zip->get_zip();
-
-$this->zip->clear_data();
-
-$name = 'photo.jpg';
-$this->zip->read_file("/path/to/photo.jpg"); // Read the file's contents
-
-$this->zip->download('myphotos.zip');
-
      -
      -
      - -
      - -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/license.html b/user_guide/license.html deleted file mode 100755 index f2ae401..0000000 --- a/user_guide/license.html +++ /dev/null @@ -1,510 +0,0 @@ - - - - - - - - - - The MIT License (MIT) — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • The MIT License (MIT)
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      The MIT License (MIT)

      -

      Copyright (c) 2014 - 2015, British Columbia Institute of Technology

      -

      Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the “Software”), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions:

      -

      The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software.

      -

      THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/objects.inv b/user_guide/objects.inv deleted file mode 100755 index 6e828fe..0000000 Binary files a/user_guide/objects.inv and /dev/null differ diff --git a/user_guide/overview/appflow.html b/user_guide/overview/appflow.html deleted file mode 100755 index 255f33f..0000000 --- a/user_guide/overview/appflow.html +++ /dev/null @@ -1,514 +0,0 @@ - - - - - - - - - - Application Flow Chart — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Application Flow Chart

      -

      The following graphic illustrates how data flows throughout the system:

      -

      CodeIgniter application flow

      -
        -
      1. The index.php serves as the front controller, initializing the base -resources needed to run CodeIgniter.
        2. -
      2. The Router examines the HTTP request to determine what should be done -with it.
        3. -
      3. If a cache file exists, it is sent directly to the browser, bypassing -the normal system execution.
        4. -
      4. Security. Before the application controller is loaded, the HTTP -request and any user submitted data is filtered for security.
        5. -
      5. The Controller loads the model, core libraries, helpers, and any -other resources needed to process the specific request.
        6. -
      6. The finalized View is rendered then sent to the web browser to be -seen. If caching is enabled, the view is cached first so that on -subsequent requests it can be served.
        7. -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/overview/at_a_glance.html b/user_guide/overview/at_a_glance.html deleted file mode 100755 index df7d534..0000000 --- a/user_guide/overview/at_a_glance.html +++ /dev/null @@ -1,597 +0,0 @@ - - - - - - - - - - CodeIgniter at a Glance — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      CodeIgniter at a Glance

      -
      -

      CodeIgniter is an Application Framework

      -

      CodeIgniter is a toolkit for people who build web applications using -PHP. Its goal is to enable you to develop projects much faster than you -could if you were writing code from scratch, by providing a rich set of -libraries for commonly needed tasks, as well as a simple interface and -logical structure to access these libraries. CodeIgniter lets you -creatively focus on your project by minimizing the amount of code needed -for a given task.

      -
      -
      -

      CodeIgniter is Free

      -

      CodeIgniter is licensed under the MIT license so you can use it however -you please. For more information please read the -license agreement.

      -
      -
      -

      CodeIgniter is Light Weight

      -

      Truly light weight. The core system requires only a few very small -libraries. This is in stark contrast to many frameworks that require -significantly more resources. Additional libraries are loaded -dynamically upon request, based on your needs for a given process, so -the base system is very lean and quite fast.

      -
      -
      -

      CodeIgniter is Fast

      -

      Really fast. We challenge you to find a framework that has better -performance than CodeIgniter.

      -
      -
      -

      CodeIgniter Uses M-V-C

      -

      CodeIgniter uses the Model-View-Controller approach, which allows great -separation between logic and presentation. This is particularly good for -projects in which designers are working with your template files, as the -code these files contain will be minimized. We describe MVC in more -detail on its own page.

      -
      -
      -

      CodeIgniter Generates Clean URLs

      -

      The URLs generated by CodeIgniter are clean and search-engine friendly. -Rather than using the standard “query string” approach to URLs that is -synonymous with dynamic systems, CodeIgniter uses a segment-based -approach:

      -
      example.com/news/article/345
-
      -
      -

      Note: By default the index.php file is included in the URL but it can be -removed using a simple .htaccess file.

      -
      -
      -

      CodeIgniter Packs a Punch

      -

      CodeIgniter comes with full-range of libraries that enable the most -commonly needed web development tasks, like accessing a database, -sending email, validating form data, maintaining sessions, manipulating -images, working with XML-RPC data and much more.

      -
      -
      -

      CodeIgniter is Extensible

      -

      The system can be easily extended through the use of your own libraries, -helpers, or through class extensions or system hooks.

      -
      -
      -

      CodeIgniter Does Not Require a Template Engine

      -

      Although CodeIgniter does come with a simple template parser that can -be optionally used, it does not force you to use one. Template engines -simply can not match the performance of native PHP, and the syntax that -must be learned to use a template engine is usually only marginally -easier than learning the basics of PHP. Consider this block of PHP code:

      -
      <ul>
-<?php foreach ($addressbook as $name):?>
-        <li><?=$name?></li>
-<?php endforeach; ?>
-</ul>
-
      -
      -

      Contrast this with the pseudo-code used by a template engine:

      -
      <ul>
-{foreach from=$addressbook item="name"}
-        <li>{$name}</li>
-{/foreach}
-</ul>
-
      -
      -

      Yes, the template engine example is a bit cleaner, but it comes at the -price of performance, as the pseudo-code must be converted back into PHP -to run. Since one of our goals is maximum performance, we opted to not -require the use of a template engine.

      -
      -
      -

      CodeIgniter is Thoroughly Documented

      -

      Programmers love to code and hate to write documentation. We’re no -different, of course, but since documentation is as important as the -code itself, we are committed to doing it. Our source code is extremely -clean and well commented as well.

      -
      -
      -

      CodeIgniter has a Friendly Community of Users

      -

      Our growing community of users can be seen actively participating in our -Community Forums.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/overview/features.html b/user_guide/overview/features.html deleted file mode 100755 index 380308a..0000000 --- a/user_guide/overview/features.html +++ /dev/null @@ -1,539 +0,0 @@ - - - - - - - - - - CodeIgniter Features — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      CodeIgniter Features

      -

      Features in and of themselves are a very poor way to judge an -application since they tell you nothing about the user experience, or -how intuitively or intelligently it is designed. Features don’t reveal -anything about the quality of the code, or the performance, or the -attention to detail, or security practices. The only way to really judge -an app is to try it and get to know the code. -Installing CodeIgniter is child’s play so -we encourage you to do just that. In the mean time here’s a list of -CodeIgniter’s main features.

      -
        -
      • Model-View-Controller Based System
        • -
      • Extremely Light Weight
        • -
      • Full Featured database classes with support for several platforms.
        • -
      • Query Builder Database Support
        • -
      • Form and Data Validation
        • -
      • Security and XSS Filtering
        • -
      • Session Management
        • -
      • Email Sending Class. Supports Attachments, HTML/Text email, multiple -protocols (sendmail, SMTP, and Mail) and more.
        • -
      • Image Manipulation Library (cropping, resizing, rotating, etc.). -Supports GD, ImageMagick, and NetPBM
        • -
      • File Uploading Class
        • -
      • FTP Class
        • -
      • Localization
        • -
      • Pagination
        • -
      • Data Encryption
        • -
      • Benchmarking
        • -
      • Full Page Caching
        • -
      • Error Logging
        • -
      • Application Profiling
        • -
      • Calendaring Class
        • -
      • User Agent Class
        • -
      • Zip Encoding Class
        • -
      • Template Engine Class
        • -
      • Trackback Class
        • -
      • XML-RPC Library
        • -
      • Unit Testing Class
        • -
      • Search-engine Friendly URLs
        • -
      • Flexible URI Routing
        • -
      • Support for Hooks and Class Extensions
        • -
      • Large library of “helper” functions
        • -
      -
      - - -
      -
      - - - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/overview/getting_started.html b/user_guide/overview/getting_started.html deleted file mode 100755 index bf3faf2..0000000 --- a/user_guide/overview/getting_started.html +++ /dev/null @@ -1,513 +0,0 @@ - - - - - - - - - - Getting Started With CodeIgniter — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Getting Started With CodeIgniter

      -

      Any software application requires some effort to learn. We’ve done our -best to minimize the learning curve while making the process as -enjoyable as possible.

      -

      The first step is to install -CodeIgniter, then read all the topics in the Introduction section of -the Table of Contents.

      -

      Next, read each of the General Topics pages in order. Each topic -builds on the previous one, and includes code examples that you are -encouraged to try.

      -

      Once you understand the basics you’ll be ready to explore the Class -Reference and Helper Reference pages to learn to utilize the -native libraries and helper files.

      -

      Feel free to take advantage of our Community -Forums if you have questions or -problems, and our Wiki to see code -examples posted by other users.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/overview/goals.html b/user_guide/overview/goals.html deleted file mode 100755 index 5677933..0000000 --- a/user_guide/overview/goals.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - - - - - - Design and Architectural Goals — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Design and Architectural Goals

      -

      Our goal for CodeIgniter is maximum performance, capability, and -flexibility in the smallest, lightest possible package.

      -

      To meet this goal we are committed to benchmarking, re-factoring, and -simplifying at every step of the development process, rejecting anything -that doesn’t further the stated objective.

      -

      From a technical and architectural standpoint, CodeIgniter was created -with the following objectives:

      -
        -
      • Dynamic Instantiation. In CodeIgniter, components are loaded and -routines executed only when requested, rather than globally. No -assumptions are made by the system regarding what may be needed -beyond the minimal core resources, so the system is very light-weight -by default. The events, as triggered by the HTTP request, and the -controllers and views you design will determine what is invoked.
        • -
      • Loose Coupling. Coupling is the degree to which components of a -system rely on each other. The less components depend on each other -the more reusable and flexible the system becomes. Our goal was a -very loosely coupled system.
        • -
      • Component Singularity. Singularity is the degree to which -components have a narrowly focused purpose. In CodeIgniter, each -class and its functions are highly autonomous in order to allow -maximum usefulness.
        • -
      -

      CodeIgniter is a dynamically instantiated, loosely coupled system with -high component singularity. It strives for simplicity, flexibility, and -high performance in a small footprint package.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/overview/index.html b/user_guide/overview/index.html deleted file mode 100755 index 3c42d01..0000000 --- a/user_guide/overview/index.html +++ /dev/null @@ -1,507 +0,0 @@ - - - - - - - - - - CodeIgniter Overview — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • CodeIgniter Overview
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      CodeIgniter Overview

      -

      The following pages describe the broad concepts behind CodeIgniter:

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/overview/mvc.html b/user_guide/overview/mvc.html deleted file mode 100755 index ed781a2..0000000 --- a/user_guide/overview/mvc.html +++ /dev/null @@ -1,520 +0,0 @@ - - - - - - - - - - Model-View-Controller — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Model-View-Controller

      -

      CodeIgniter is based on the Model-View-Controller development pattern. -MVC is a software approach that separates application logic from -presentation. In practice, it permits your web pages to contain minimal -scripting since the presentation is separate from the PHP scripting.

      -
        -
      • The Model represents your data structures. Typically your model -classes will contain functions that help you retrieve, insert, and -update information in your database.
        • -
      • The View is the information that is being presented to a user. A -View will normally be a web page, but in CodeIgniter, a view can also -be a page fragment like a header or footer. It can also be an RSS -page, or any other type of “page”.
        • -
      • The Controller serves as an intermediary between the Model, the -View, and any other resources needed to process the HTTP request and -generate a web page.
        • -
      -

      CodeIgniter has a fairly loose approach to MVC since Models are not -required. If you don’t need the added separation, or find that -maintaining models requires more complexity than you want, you can -ignore them and build your application minimally using Controllers and -Views. CodeIgniter also enables you to incorporate your own existing -scripts, or even develop core libraries for the system, enabling you to -work in a way that makes the most sense to you.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/search.html b/user_guide/search.html deleted file mode 100755 index 6d56399..0000000 --- a/user_guide/search.html +++ /dev/null @@ -1,500 +0,0 @@ - - - - - - - - - - Search — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - - - - -
      - -
      - -
      -
      - - -
      - -
      -

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/searchindex.js b/user_guide/searchindex.js deleted file mode 100755 index c286754..0000000 --- a/user_guide/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({envversion:42,terms:{represent:[25,115,13,79],mybackup:75,yellow:[6,129],poorli:91,four:[149,87,53,135,54,125,121,130,124],prefix:[87,94,2,29],oldest:130,hate:131,optimize_databas:75,forget:[50,103],whose:29,accur:[0,29,114,151,41,93],aug:91,emailaddress:50,my_control:[101,110],site_url:[81,96,21,7,29],illustr:[133,96,149],swap:[41,87,94,110,29],up8:91,under:[142,27,94,33,149,10,0,97,32,29,34,79,109,139,103,131,66,105,106],up6:91,lord:91,up4:91,up5:91,up2:91,spec:96,myselect:92,up1:91,merchant:77,digit:[125,28,55,29],kudo:29,everi:[62,52,136,19,146,53,44,79,149,8,139,140,122,110,103,141,42,106],risk:[103,128,29],"void":[137,87,45,7,90,130,93,96,53,97,55,103,105,106,143,144,112,29,115,81,121,41],internet:[33,96,29],http_host:[30,33],mime_typ:97,del_dir:114,stripslash:[135,29],upstream:29,start_cach:[149,29],applicationconfig:125,set_templ:[143,124],rename_t:[76,29],total_seg:[150,29],ci_db_query_build:149,fopen_write_cr:113,email_attachment_unred:29,preg_match:29,csrf_hash:99,encrypt_nam:[128,29],cmd:49,upload:[92,51,101,54,29],previou:[10,55,33,51,29],sri:91,vector:[79,29],red:[142,145,150,130,6,129,9,50,124],wednesdai:124,enjoy:138,mysqli_driv:35,zlib:29,up35:91,abil:[27,29,125,79,122,106],direct:[28,149,29,54,80,81,9,139],str_repeat:[6,135,33,29],enjoi:[63,54],dowload:16,second:[137,0,2,5,98,45,7,87,92,90,48,91,9,50,11,96,134,135,13,55,136,101,6,103,140,78,143,19,144,107,66,21,108,145,148,109,149,112,146,147,23,75,76,29,114,97,33,81,150,82,152,115,106],aggreg:87,clear_var:[108,29],kaliningrad:91,eldoc:80,even:[87,125,7,9,92,50,132,12,53,97,56,139,93,141,65,110,146,27,29,79,48,150,151],hide:29,date_rss:91,item2:[103,33],neg:[125,5,103,29],get_extens:29,item1:103,exit_unknown_fil:[113,45],calcul:[53,41,87,29],poison:29,yoursit:96,blur:43,num_tag_open:62,"new":[0,3,5,125,7,139,128,141,48,91,74,9,50,131,93,51,95,96,134,53,54,148,99,100,101,102,56,57,103,15,16,17,106,62,19,120,72,66,28,109,110,149,112,71,27,73,23,75,76,29,30,115,33,34,81,150,35,36,37,119,39,67,154,123,153,147,155],net:[29,66,109,139,58,105],ever:[30,92,130,33,139],groupid:125,metadata:89,blog_model:78,med:92,elimin:[115,151,29],kilobyt:128,behavior:[0,29],get_month_nam:19,form_button:[92,29],never:[0,134,29,30,115,33,125,109,110,103,139],last_row:55,here:[0,1,79,5,125,98,92,128,129,48,49,50,11,96,134,53,13,55,136,148,101,6,103,105,78,62,143,19,141,144,147,21,22,108,68,145,74,139,71,27,23,149,29,114,97,33,80,81,151,121,43,41,106,153,124],met:[25,103,66,79],directory_map:[11,29],smtp_timeout:[23,29],ci_calendar:19,path:[11,75,144,29,114,44,78,45,34,88,87,145,90,129,49,94,146,105,132],up45:91,sess_table_nam:[103,33],interpret:29,get_smiley_link:13,forum:[131,141,138,8],row_start:124,anymor:29,characterss:121,loos:[27,52,143,65,125,6],precis:[41,152,34,29],datetim:[96,55,91,29],"_output":[0,29],niue:91,permit:[0,2,3,44,45,92,128,129,9,50,10,94,69,97,98,6,57,103,105,106,130,65,107,149,148,109,96,112,23,75,76,77,29,79,34,150,82,40,41,124],"_fetch_from_arrai":29,blog_config:7,heading_title_cel:19,"_cooki":[106,33,139,29],portabl:[92,2,81],http_x_client_ip:[106,29],message_kei:137,myanmar:91,get_cooki:[106,90,33,29],another_mark_start:41,releas:[42,105,29],unix:[19,29,125,66,91,103,106],cell_start:124,strai:29,mysqli:[29,94,146,87,33,35,70,78],newspac:29,cont:23,txt:[75,144,29,107,140,112,105],unit:[51,116,141,91,29],highli:[52,34,105],set_profiler_sect:[83,97],describ:[5,79,125,45,7,128,9,50,131,151,53,13,14,139,141,21,74,111,26,23,149,78,29,34,83,54,124],would:[137,0,28,43,125,7,9,128,92,122,48,91,74,49,50,93,151,94,12,53,135,54,98,14,6,57,103,132,104,62,143,19,147,108,38,110,25,112,27,136,23,149,29,97,78,81,150,37,115,41,139,124],information_about_someth:125,afterward:[128,79,29],get_filenam:[114,29],dnt:29,program:[79,70],call:[141,34,29],asset:[5,139],typo:[3,29],recommend:[147,23,12,29,125,64,108,79,8,151,128,148,139,141,153,105,70],old_nam:76,protect_braced_quot:20,care:[113,0,148,87,66,79,22,25,9,103,146,106],type:[85,5,1,87,125,44,45,34,47,92,90,122,48,91,9,126,11,12,134,135,13,55,100,102,98,139,16,6,119,142,144,107,94,145,149,25,69,152,71,147,38,75,76,29,114,78,80,46,81,82,118,105,40],until:[62,97,29,33,34,90,103,50,41,141],uniqid:29,set_tempdata:[103,29],error_php:71,unescap:29,product_id_rul:130,inflect:29,notif:29,error_messag:137,notic:[43,13,125,45,128,129,9,50,96,134,53,97,103,143,19,21,22,149,77,29,115,79,151,121,41,124],unbuffered_row:[55,29],warn:[53,103,125,57,29],glass:130,start_dai:19,exce:50,stdclass:55,wm_opac:53,up7:91,last_tag_clos:62,hold:[79,141,109,29],max_filename_incr:[128,29],must:[137,0,86,2,3,43,125,98,45,79,92,128,129,91,9,50,131,94,96,78,134,53,54,55,83,148,101,57,103,58,18,143,130,19,66,108,153,13,28,109,110,25,149,112,146,113,145,23,75,76,29,114,97,33,80,81,37,121,41,141,139],composer_autoload:[44,29],sha256:79,join:[125,103,149,29],some_t:[47,55,48],setup:[25,125,58,141],work:[10,141,29],up3:91,krasnoyarsk:91,form_open:[29,22,130,102,92,50,140],sharp:43,undeliv:23,show_other_dai:19,slash:[136,29,125,135,33,98,7,150,148,129,139],abridg:91,root:[71,0,94,75,141,114,54,98,21,128,103,132,106],newfoundland:91,overrid:[113,0,11,29,110,98,99,83,129,27,146],csv_from_result:[75,29],segment_on:87,create_databas:[76,29],num_row:[111,55,29],give:[29,27,79,149,76,63,125,13,45,81,139,90,6,103,143,50,111,141],send_request:96,greater_than_equal_to:50,smtp:[68,23,29],pg_escape_str:29,indic:[142,43,10,53,98,29,45,7,125,128,91,130,50,104,146],captcha:29,somefil:114,encypt:79,caution:[79,29],unavail:29,want:[137,0,2,43,44,45,7,34,129,92,50,93,94,12,134,53,135,136,55,148,98,103,132,104,105,78,62,143,141,144,65,108,38,109,149,112,79,23,75,76,29,114,115,33,46,81,39,121,122,41,106,84],array_column:[25,29],fieldset:92,mysql_:2,unsign:[103,145,28,76,121],bag:125,read_fil:[114,29],save_queri:[82,83,29],manipul:[89,51,125,29],quot:[142,1,75,87,125,135,20,29,48,92],up575:91,march:29,how:[141,29],enforc:29,hor:53,disappear:43,show_error:[113,80,28,45,29],answer:[135,34],verifi:[94,148,29,145,103,50,16],"_escape_identifi":29,config:[0,13,5,44,45,92,90,129,48,91,9,132,51,11,147,12,54,98,14,6,105,141,64,94,110,25,149,146,113,27,75,29,114,78,34,81,151,83,122],updat:[87,29,34,48,82,141],lao:91,recogn:[25,29],tablenam:[149,48],some_field_nam:128,after:[29,0,149,76,64,98,54,55,34,151,83,129,135,92,122],altogeth:33,diagram:129,befor:[0,149,29,110,98,48,47,129,18,27,146,141],wrong:[103,128,139,81,29],mark_as_temp:[103,29],offlin:[117,99,100,101,102,56,57,58,59,17,61,120,15,71,72,73,74,119,30,31,32,33,16,35,36,37,118,60,39,67,123,153,154,155],random_str:[135,29],mailpath:23,post_imag:6,dbprefix:[71,94,149,78,87,29,48,146],averag:149,allowed_fil:29,util:[89,149,94,12,29],attempt:[0,29,66,81,110,139,106,140,105,93],third:[5,7,92,50,11,134,135,6,103,78,142,19,144,21,22,108,149,147,23,75,29,114,115,33,80,81,82,121],fewer:[94,149,29],username_cal:50,bootstrap:29,greet:96,imposs:[79,109,29],alias:[87,98,29],maintain:[10,86,147,29,53,115,33,65,127,109,9,103,131,112,141],environ:[94,34,29],localdomain:29,reloc:29,enter:[142,143,29],exclus:[114,29],expected_result:143,order:[87,76,29],dblclick:43,wine:129,oper:[113,27,149,29,34,47,105,141],form_submit:[92,130],composit:29,feedback:103,shorten:[125,121],offici:[127,103,33,29],failur:[137,87,125,7,128,91,130,50,12,53,55,148,103,140,142,149,66,108,23,25,96,112,28,75,76,29,114,79,80,48,150,121,124],becaus:[0,33,7,8,92,130,50,12,98,18,103,140,105,106,21,109,25,70,113,149,79,81,121],jpeg:[128,97],field_exist:[47,87],privileg:75,affect:[43,12,29,125,33,98,14,87,82,18,149],highlight_phras:[147,29],japan:91,flexibl:[5,52,74,134,29,33,68],vari:[125,29],myfil:[148,108,134],suffix:29,code_to_run:43,cli:29,img:[6,145,23,29],inflector:[88,29],fwrite:29,add_data:112,not_group_start:149,reduce_multipl:[135,29],inadvert:29,better:[27,29,125,79,122,110,9,131,141],or_group_start:149,persist:[142,94,23,87,29,109,103],comprehens:[50,8],hidden:[43,11,0,125,29,22,130,83,92,140],img_url:145,increment_str:[135,29],them:[137,0,28,87,125,44,119,79,155,106,128,122,91,74,9,50,93,94,95,12,58,53,136,13,55,83,148,99,100,101,102,56,57,153,98,103,15,16,17,60,62,113,130,120,149,72,65,140,121,21,108,123,38,110,25,96,115,71,27,73,23,141,76,29,30,31,32,33,34,59,35,36,37,118,54,39,40,154,61,139,117,67],row_end:124,thei:[43,1,79,0,125,98,7,34,87,9,92,49,50,147,12,78,134,53,135,54,55,14,99,100,102,57,103,18,19,141,20,21,68,28,25,96,27,136,23,149,76,29,115,33,80,46,81,41,106],fragment:[28,134],safe:[147,79,69,29,33,46,81,130,103,92,12,140],compress_output:[56,29],"break":[149,29],sqlite3:[33,70,29],db_name:76,get_mim:[113,105,29],"_remove_invisible_charact":29,request_uri:[106,64,29],drop_tabl:[76,29],choic:[79,135,33,7,6,103,50],grammat:29,mytabl:[149,111,75,34,124],f4v:29,my_mark_start:41,odbc:[94,33,70,29],bonu:9,timeout:[66,23,96,146,87],each:[137,0,136,3,43,125,44,7,87,130,143,129,91,52,92,50,93,11,12,135,54,55,151,138,103,132,142,63,19,121,21,22,108,94,28,25,96,111,112,146,27,23,149,29,115,79,34,83,40,122,41,124],debug:[45,83,12,48,29],went:21,european:91,oblig:7,side:[62,43,136,96,29,125,33,128,149],mean:[43,79,12,91,87,125,129,33,136,22,68,102,56,7,109,130,103,111,141],monolith:84,list:[94,87,29],wm_vrt_offset:53,saturdai:[19,124],flock:29,ommit:25,extract:[25,23,108,106],tgz:29,depress:6,network:29,goe:[127,33,79,109,29],open:[0,149,10,29,44,78,49,110,27,9,141,132],dst:91,dsn:[94,23,146,29],rewrit:[37,151,29],sprintf:[50,33],got:29,force_download:[75,144,29],forth:147,"_reindex_seg":29,database2_nam:146,is_:29,linear:109,navig:[49,62,140],written:[62,0,94,29,53,33,45,21,22,151,81,143,121,18,27,127,103,114],smtp_host:23,somesit:126,situat:[94,79,149,34,29],given:[137,130,19,29,53,33,103,108,114,50,121,91,40,25,12,131,150,112,84],quoted_printable_encod:[25,105,29],standard:29,add_drop:75,element:[85,27,136,75,134,108,29,115,33,21,22,43,92,128,142,25,50,124],"_truncat":29,error_url_miss:137,blog_descript:[28,76],memory_usag:[41,97,83],md5:[79,69,29,135,33,139],anchor_class:29,angl:53,isp:103,openssl:[33,79],"001_add_blog":28,filter:[98,29],link_tag:[6,29],att:81,mvc:[63,134,78,65,136,131],pagin:[51,11,34,29],isn:[137,142,75,76,29,98,79,45,149,50,106],iphon:93,codeignit:29,confus:[115,29],bite:43,rand:[149,29],rang:[147,53,79,91,131,112],render:[62,0,136,33,29,97,13,80,14,22,21,82,83,133,129,18,115,43,139,140],fetch_directori:29,accent:[147,29],clariti:[125,56,21,91,29],hellip:147,exit_unknown_method:113,restrict:[77,114,128,105,139,84,57],hook:[110,80,29],instruct:[125,44,51,29],autoinit:29,messag:[75,87,29,48,151,49,12,105,141],wasn:[21,29],daylight_sav:91,agre:10,primari:[94,96,76,149,29,87,21,7,47,145,121,103],hood:[27,79],form_label:[92,29],nomin:100,top:[62,43,11,136,29,53,115,54,45,14,50],reverse_nam:55,result_arrai:[149,29,115,55,21,111],downsid:103,cumul:[149,76],master:[53,91,7,141],too:[94,23,29,125,33,139],similarli:[92,103,90,33,137],my_view:29,gilbert:91,john:[96,53,115,92,49,141,124],ci_rout:33,rempath:148,prep_url:[50,81,29],library_src:43,is_doubl:143,namespac:29,tool:29,notice_area:43,albert:142,took:141,user_ag:[35,37,101,29],alpha_numeric_spac:[50,29],sha1:[135,139,69,29],western:91,somewhat:79,local_tim:19,error_:137,crawl:29,technic:[52,136,80,103,139,50],fileperm:114,target:[43,149,87,53,29,81,121,92,112,141],keyword:[125,6,149,29],consequ:101,provid:[137,43,79,87,125,126,45,7,47,128,129,91,130,50,131,93,10,94,69,55,14,100,6,103,140,106,19,20,22,38,109,139,25,27,23,149,76,77,29,115,33,80,81,150,39,121,84,124],previous_url:19,set_error:[121,29],older:[103,33,147,109,29],tree:112,told:[0,50],returned_valu:114,project:[10,94,127,49,131,84,141],matter:[103,41,64],solomon:91,rfc2616:29,entri:[29,96,78,66,33,98,81,6,121],date_rfc1123:91,minut:[103,66,18,91],beginn:79,explicitli:[114,146,81,29],file_exceeds_limit:29,week_dai:19,ran:[142,22,124],ram:79,mind:[62,142,79,48,109,139,103],auto_clear:23,raw:[143,23,75,76,29,53,97,66,79,80,103,121,25,50],seed:[79,149,21,29],rar:29,manner:[29,97,79,125,33,2,103,28,141],increment:[19,29,135,66,79,128,109],super_class:125,seen:[133,131,33,121],seem:[125,142,3,18,29],incompat:29,encode_php_tag:[50,69],translate_uri_dash:[98,29],result_object:55,cal_cell_end_oth:19,is_php:[113,105,29],captal:29,is_nul:143,myusernam:[146,78],latter:[125,22],encode_from_legaci:[101,109,29],common_funct:25,thorough:[121,84,29],week_day_cel:19,point2:41,contact:[139,81],transmit:29,data1:115,moscow:91,simplifi:[82,111,87,34,29],set_rul:[50,22,29],endfor:151,trans_complet:[12,87],though:[43,79,29,53,33,7,125,103],option_nam:130,scripto:43,my_arrai:92,legibl:125,unknowingli:139,next_link:[62,29],mario:142,regular:[87,76,29],letter:[29,0,136,109,78,125,135,33,137,91],herebi:77,svg10:6,mdate:91,"_set_uri_str":29,cap:[145,29],everyth:[142,5,79,96,29,33,22,148,130,103],prematur:56,yourdomain:90,tradit:[89,27,78],cal_cell_end:19,simplic:[52,149,78],don:[86,79,87,125,7,91,50,97,98,136,103,140,141,142,19,65,66,68,109,139,146,27,23,29,33,34,48,121],mailtyp:[23,108],doc:29,tempdata:29,clean_file_nam:29,trans_start:[87,12,29],blog_author:76,max_width:128,doe:[141,29],dblib:29,dummi:33,declar:[0,76,29,114,143,55,7,25,125,6,129,110,9,103],probabl:[103,79,34,22],wildcard:[87,149,48,29],no_file_select:29,detriment:34,left:[62,0,147,75,149,43,53,115,136,21,150,125,153,96,140],sum:[149,29],dot:29,class_nam:[38,55,104],reactor:[127,29],visitor:[29,33,56,139,106,93],whitelist:[140,29],random:[142,79,149,29,135,33,145,128,109,49,140],"__ci_var":103,endwhil:151,radiu:142,use_page_numb:[62,29],advisori:[103,33],radio:[92,50,29],earth:29,form_error:[92,50],autoload:[44,27,78,146,29],fennec:29,maxlength:[92,130,29],involv:[10,19,143,53,128,96,104],absolut:[94,148,29,53,107,79,128,92,103],arcfour:79,layout:[86,75,124],acquir:[114,103,127],libari:29,field2:[149,106],menu:[92,50,134,91,29],explain:[63,19,33,103,108,139,128,96,9,50,141],configur:29,apach:[5,128,14,106],errantli:29,secretsmittypass:96,wm_pad:53,theme:43,explic:29,rich:[131,84],iconv_en:113,display_respons:96,folder:[0,13,44,49,11,95,54,56,57,15,16,17,18,72,94,145,71,27,73,74,29,114,80,34,35,36,37,39,123,153,154,155],changedir:148,set_head:[124,97,23,81,29],csrf_verifi:29,nasti:22,enable_profil:[83,97],stop:[29,23,149,87,97,41],compli:23,consecut:20,font_path:145,report:29,my_app_index:108,directory_nam:134,tge:29,bat:[125,80],bar:[62,148,125,98,66,97,80,108,122,18,103,9,50,132],first_url:[62,29],emb:[139,23],ietf:29,baz:125,form_hidden:[92,130,29],patch:[106,98,141,29],twice:[149,29],bad:[29,147,79,96,78,33],ruleset:29,local_to_gmt:91,septemb:29,steal:103,"_ci_view_fil":29,mssql_get_last_messag:29,guiana:91,odbc_field_:29,urldecod:50,rollback:[12,29],datatyp:[143,96,76],num:[135,6,98,152],mandatori:79,result:[87,2,34,146,29],auto_incr:[28,76,29,21,145,121],fail:[12,29,53,66,79,48,87,101,96,121,50,140,141],themselv:[68,125,38],"_call_hook":29,best:[10,48],subject:[143,23,77,29,126,141],brazil:91,awar:[80,29],set_userdata:103,said:[103,33,79],new_path:112,databas:29,wikipedia:49,source_dir:[114,11,29],figur:87,"_error_numb":29,mua:29,invalu:125,drawn:29,awai:53,irc:8,approach:141,attribut:[85,76,29,114,33,55,81,130,6,91,92,105],inabl:125,accord:[50,96],socket_typ:66,extend:[49,0,87,29],newnam:[23,29],column_to_drop:76,session_dummy_driv:103,boss:149,"_execut":29,"_get":[106,33,139,29],week_row_end:19,html4:6,html5:[6,33,147,29],recent:139,http_raw_post_data:29,natur:[50,149,29],advertis:29,subfold:29,unaffect:29,form_validation_lang:[137,50,29],unfound:29,cop:[96,134],protect:29,accident:29,expos:[103,29],trale:29,howev:[0,33,125,98,7,130,128,129,9,50,131,132,96,53,135,97,55,56,103,105,141,62,143,66,109,110,112,149,115,79,48,122,139],against:[28,149,29,108,121,69],compile_bind:[87,29],logic:[18,87,149,14,29],mydirectori:11,boldlist:6,login:[98,81],browser:[0,97,90,129,49,93,133,134,53,54,14,56,18,103,140,106,144,108,22,21,139,147,136,29,115,33,81,41],com:[0,136,5,125,6,92,90,49,50,131,96,134,135,13,98,102,126,103,106,62,19,145,148,71,23,29,33,34,81,150,82,37,121,43,141,128],col:[92,13],rehash:25,tough:141,debugg:29,log_path:29,set_checkbox:[92,50,29],standardize_newlin:29,loader:[43,11,75,76,29,44,66,116,35,36,51,110],ascii_to_ent:[147,29],wider:53,guid:[38,29,24,9,139,146,104,141],assum:[79,87,7,92,50,132,94,12,13,136,56,57,62,19,74,109,71,72,73,23,149,29,33,34,48,35,37],"_parse_query_str":29,user_data:[33,153,29],duplic:[97,135,121,29],reciev:126,welcome_messag:[110,108,29],"_request":139,chrome:29,unwant:125,three:[62,28,96,149,29,53,98,20,45,34,22,92,23,48,103,9,50,135,124,139,114],been:[137,43,87,45,129,91,50,69,134,97,55,99,100,101,102,103,105,106,21,108,109,71,28,149,76,29,31,33,34,118,119,141,124],legend:[53,92],formsuccess:50,plaintext:23,ar_cach:29,trigger:[29,43,52,5,80,33,45,139,128,129,107,50,140],interest:84,basic:29,clear_attach:23,mytext:144,openssl_random_pseudo_byt:[25,140],hesit:125,quickli:80,up65:91,life:140,rfc5321:29,html_entity_decod:[140,29],unset_userdata:[103,33,29],eastern:91,suppress:[62,125,7,29],magic_quotes_runtim:29,search:[62,5,149,64,135,33,29,81,150,68,48,25,131,106,71,93],anywher:[27,41,83,97,18],lift:146,child:[68,38],"catch":[125,98,29],suar:6,blog_control:78,ugli:[125,145],ident:[0,2,125,7,34,9,90,91,92,50,53,55,101,6,106,130,20,110,113,27,38,149,76,29,115,46,81,150,41],quantiti:[92,130,29],cache_set_path:87,mitig:[139,29],properti:[43,86,28,29,53,97,20,33,55,108,99,125,122,9,103,130,106],air:124,aim:[33,79],form_upload:92,weren:29,form_validation_:[33,29],get_compiled_upd:[149,29],publicli:[29,13,79,33,7,103,141],allow_get_arrai:106,aid:29,vagu:141,anchor:[29,43,27,33,81,128,50],redisexcept:29,opt:[103,131,33],template1:115,form_clos:92,printabl:29,set_delimit:115,somelibrari:125,tabl:[94,87,111,29],toolkit:[131,84],filename2:137,memcach:29,need:[137,0,2,3,43,125,44,7,8,87,49,90,92,5,48,91,9,50,122,128,131,93,133,52,147,12,134,53,13,98,136,99,100,101,102,18,103,132,16,78,62,143,130,141,144,64,65,66,94,21,22,108,145,28,149,109,110,96,112,79,27,23,75,146,29,30,97,33,80,34,81,150,83,118,121,115,129,41,106,139,84,124],marco:29,cond:149,conf:[3,29],wm_shadow_dist:53,tediou:50,master_dim:[53,29],sever:[63,74,96,76,29,87,55,149,68,143,91,110,130,50,153,132],log_date_format:29,disabl:[94,12,29,87,45,34,14,82,151,129,149,105],invalid_dimens:29,harmoni:29,incorrectli:29,perform:29,suggest:[27,33,108,29],make:[10,141,76,146,29],db_result:29,camellia:79,"ros\u00e9n":29,complex:[149,65,136,6,121,50,84],strip_quot:[135,29],split:[63,147,87],chatroom:8,"__set":[103,55,29],complet:[143,23,12,149,29,53,33,45,108,8,87,147,6,150,121,103,111,124,93],elli:127,prev_link:[62,29],evid:98,http_x_forwarded_for:[106,29],blue:[50,6,129,148,124],rail:127,cache_overrid:129,evil:29,hand:[92,0,28,50],fairli:[65,103,128,139],rais:[48,29],upload_lang:29,bia:103,techniqu:[139,79,140],dhaka:29,charlim:147,kept:[43,13,29,115,33,109,126,130,103,141,140,106],undesir:139,scenario:50,java:105,post_dat:91,linkifi:81,flush_cach:[149,29],min:[149,29],fatal:[125,66,98,29],taint:139,inherit:[0,86,19,29],stop_cach:[149,29],client:[29,43,94,23,87,30,33,128],shortli:50,thi:[10,141,29],endif:[130,151],gzip:[75,56,29],programm:[125,131,8],next_row:[55,29],url_suffix:[62,71,81,29],identifi:[87,141,29],just:[142,1,79,87,44,9,92,49,50,12,53,135,102,103,140,106,62,21,22,108,68,28,139,149,27,23,75,76,29,33,80,81],safe_mod:29,wm_font_siz:53,photo:[53,112,144],ordin:81,array_replac:[25,29],up55:91,via:[149,76,29,48,75,141],stringenc:125,human:[71,5,29,80,81,91,40,50],yet:[12,21,22,121,50,105],languag:[11,29,125,44,88,91,110,49,84],previous:[58,29],shoud:7,group_bi:[149,29],xmlhttprequest:29,greenwich:91,easi:[62,5,29,79,108,137,101,103,106],explictli:62,declin:141,had:[101,33,29],"_end":41,ci_vers:[113,29],is_float:143,x_axi:53,ak_my_design:147,"0123456789abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz":145,date_iso8601:[91,29],swap_pr:[94,29],els:[0,125,126,45,128,50,93,12,139,105,106,22,96,149,29,30,33,80,48,150,114,151,121],ffffff:53,save:[0,23,149,91,134,29,125,98,66,79,45,34,7,130,128,18,109,49],hat:127,transit:[101,6,29],gave:[121,29,8],sanit:[69,29,21,22,139,50,140,105],applic:[0,86,149,110,29,44,87,45,14,34,49,94,24,18,27,9,129,105,146],csprng:25,get_compiled_select:[149,29],measur:[53,54,57],preserv:[53,103,121,140,29],disposit:[23,29],regard:[52,19,149,53,45,108,125,139,50,153],credit:141,lightbox:6,distanc:53,or_where_in:[149,29],rewrite_short_tag:[37,29],background:[103,145,33,147,29],field_nam:[87,29,55,34,47,128,50],cape:91,database_nam:[94,75],apart:122,hmac_kei:79,"_parse_request_uri":29,handpick:127,"_csrf_set_hash":29,specif:[94,87,146,29],"_displai":[97,129,29],insert_id:[82,29],arbitrari:[41,96,94,48,29],manual:[94,34,29],certificat:94,get_client_info:2,varieti:[80,84,29],multiselect:92,night:6,funcion:29,unnecessari:[139,112],underli:[103,94,80,87],www:[23,96,29,13,98,81,6,54,121,103,105],right:[62,43,136,96,10,77,0,53,115,29,21,150,130,129,49,149,41,147,84,141],old:[62,145,79,29,97,33,81,139,148,109,103,50,153,70],deal:[137,27,69,77,29,79,87,50],negat:[66,29],interv:91,excerpt:121,user_model:78,dead:29,fetchabl:48,born:112,intern:[137,79,29,125,33,55,81,100,37,139,130,103],printer:6,elaps:[41,83,91,87],interf:29,successfulli:[148,29,126,33,45,22,128,121,130,50],password_needs_rehash:25,transmiss:79,less_than_equal_to:50,thu:[50,139,98,96,29],total:[83,87,55,111,29],ico:6,bottom:[71,43,136,29,53,97,83,91],file_get_cont:[114,97,33,29],subclass:[86,29],not_lik:[149,29],raw_nam:128,pmachin:29,equal:[43,149,143,29,50,105,124],word_length:[145,29],rdfa:6,overcom:98,condit:[29,149,77,87,125,33,22,48,103],foo:[143,1,148,29,125,98,66,97,80,108,92,101,122,18,9,103,132],my_tabl:[82,111,55,149,124],localhost:[43,94,96,78,29,103,146],core:[149,29],plu:[92,143,6,81,7],who:[10,78,125,98,110,139],cal_cell_start_todai:19,passwordconfirm:50,name_of_last_city_us:125,someclass:[9,134],insecur:[33,7,29],pose:14,cellpad:[130,143,19,124],add_dir:112,set_alt_messag:23,scrollabl:29,repositori:[137,80,141],post:[142,0,78,29,98,81,83,92,139],"super":[96,29,125,136,108,122,109,9],shuck:147,unsaf:[103,33],um4:91,um7:91,first_tag_clos:62,um1:91,troubl:[33,141],um3:91,um2:91,get_flash_kei:103,invoice_id:149,is_ajax_request:[106,29],um9:91,um8:91,surround:62,reduce_double_slash:[135,29],distinct:[43,149,29],dinner:135,form_validation_rul:33,enable_query_str:[62,5,71,29],algo:25,span:[92,147,121,29],commit:[52,141,12,131,29],ci_db_util:[75,108],my_mark_end:41,produc:[62,143,79,12,76,29,33,55,34,81,108,82,101,6,48,91,92,149,111,150,147],match:[0,130,79,149,29,125,136,33,98,108,92,87,25,143,103,9,50,131,78],set_insert_batch:149,email_filed_smtp_login:29,"float":[147,152],encod:[51,29,125,79,81,139,101,116,109,121,25,50,105,106],active_group:[94,33,123],down:[38,53,55,22,125,28,91,92,139],creativ:[131,84],count_al:[82,87,149,29],captcha_id:145,formerli:[149,69,29],wrap:[147,13,29],make_column:[13,124],set_test_item:[143,29],storag:[87,29],east:91,cipher:[94,109],git:[42,141],invalid_filetyp:29,wai:[137,0,79,7,47,128,122,91,49,50,69,134,55,151,18,103,140,105,106,143,65,21,108,68,109,139,96,146,27,28,149,29,114,33,46,83,41,141],"_prep_quoted_print":29,array1:25,post_get:[106,33,29],transform:[48,81,29],happi:[6,141],avail:[34,29],width:[43,130,145,29,53,81,125,128,6,92],reli:[52,75,76,29,30,33,125,103],request_method:[106,29],editor:[0,96,134,125,54,7,128,49,50],db_active_rec:[35,29],add_column:[76,29],wav:29,srednekolymsk:91,get_random_byt:[140,29],fork:141,sess_destroi:[103,29],head:29,medium:[92,124],is_cli:[49,106,33,105,29],form:[5,134,29,80,55,126,145,91,27,139,104,141],offer:[25,50,33,89,79],forc:[94,144,64,114,29,81,128,139,131,84],ucfirst:[125,86,33,136,29],hackeron:141,forg:29,fore:46,aren:[50,31,29],sess_driv:[103,33,108,29],upload_path:128,renam:[94,29],nonexistent_librari:108,stand:139,"true":[27,94,55,12,76,29,44,78,45,149,48,47,83,129,80,25,75,105,87,146],something_els:80,table_open:[19,124],reset:29,absent:[41,21],input:[29,78,87,48,110,25,105],function_us:[113,105,29],validation_lang:29,new_nam:76,exact_length:[50,29],heading_row_end:[19,124],filename_bad_char:29,maximum:[147,52,23,149,29,53,115,79,47,128,18,109,25,50,131],tell:[137,27,94,28,75,76,149,78,53,108,150,68,143,103],independ:[2,149,87,108,130,12],toggl:[19,29],my_articl:5,field3:149,emit:29,trim:[50,135,33,29],up11:91,e_warn:29,featur:[137,0,33,5,125,44,89,129,9,50,51,53,97,55,57,103,146,141,19,66,74,139,149,70,23,75,29,79,34,150,151,153],p7r:29,delete_cach:[18,29],stronger:79,"abstract":[12,29,125,21,89,70],mirror:148,myotherclass:129,futur:[103,33,79,29],some_data:106,uri:[18,87,34,29],input_stream:[106,33,29],cal_row_start:19,exist:[87,76,141,34,29],p7c:29,"_ci_load":29,p7a:29,request:[0,23,149,29,30,97,33,55,108,83,5,18,98,139,141,105,106],umark_temp:103,stanleyxu:29,p7m:29,check:[75,29,125,107,45,92,126,49,101,129,40,25,139,82,105,141],assembl:149,site_nam:7,mp4:29,is_load:[113,108,7,29],"7zip":29,higher:[53,98,79,45,25,103],download_help:[35,29],when:[0,94,12,76,29,44,80,55,34,48,87,82,18,25,149,146,105,141],refactor:29,active_record:[123,33,29],"_set_head":29,test:[94,87,141,29],presum:[6,79],uri_protocol:[3,29],roll:[28,12,87],realiti:142,is_http:[113,105,29],relat:[69,76,29,125,135,33,22,128,6,103,3],intend:[62,0,23,149,91,29,53,135,63,33,103,87,143,121,54,109,27,130,50,132],phoenix:91,benefici:34,get_output:[97,129],image_properti:6,min_height:[128,29],query_toggle_count:[83,29],insensit:[140,97,98,29],intent:[125,103,33],consid:[0,79,19,146,29,44,33,80,46,48,150,87,149,143,103,92,50,41,124,131,115],sql:[94,75,87,29,149,48,82,12,111,70],iso8601:[96,29],idenitif:97,shortnam:29,outdat:139,bitbucket:29,receiv:[0,23,29,108,103,50],known_str:25,longer:[43,79,29,125,33,55,108,101,18,109,103,50,141],furthermor:[125,33,79],function_nam:105,htdoc:[114,139],pseudo:[143,79,19,29,115,97,41,131],withhold:29,dohash:[101,69,29],vietnam:91,ignor:[62,1,28,75,149,29,65,115,20,33,46,79,103,112],cal_novemb:29,time:[87,44,9,81,91,92,78,135,6,18,139,104,105,141,142,145,110,75,29,33,34,48,83],reply_to:23,backward:[0,28,29,126,13,55,130,101,33,109,43,103,106],stick:[79,141],"_data_seek":29,recipi:[126,23,29],concept:[9,103,21,26,143],session_destroi:103,flac:29,chain:[87,76,29],whoever:141,skip:[75,76,29,114,45,55,149,101,92,103],global:[137,27,52,3,146,29,44,33,45,34,7,108,139,94,129,103,9,50,106,105,78],focus:52,invent:139,cyril:29,function_trigg:[71,5],unit_test:143,superglob:[103,33,29],seriou:[139,101],set_valu:[92,50,29],archive_filepath:112,blog_titl:[115,28,76],"_insert_batch":29,insert_entri:78,menubar:29,hierarch:0,form_textarea:[92,29],middl:[53,147,29],depend:[94,87,34,48,29],zone:[91,29],pem:[94,29],decim:[50,41,87,29],readabl:[144,29,114,80,125,91,103,141],worth:[103,79],deject:6,certainli:[33,79],decis:[23,109,29],text:[0,149,76,29,80,45,34,49,27,25,139,105],get_the_file_properties_from_the_fil:125,oversight:29,query_str:[3,29],update_str:[82,87,29],sourc:[10,11,148,29,53,79,6,25,131,146,141],string:[94,87,146,29],could:[43,2,125,45,79,49,50,131,132,96,136,56,103,105,141,21,28,76,29,97,33,81,84],wm_font_color:[53,29],unfamiliar:22,revalid:97,lru:66,url_encod:105,octob:29,word:[71,5,94,147,29,125,98,33,55,81,145,40,130,41,146],brows:[130,27,103,93],cool:43,set_messag:[50,29],save_handl:103,level:[11,29,125,33,45,6,103,112],did:[0,149,134,29,53,136,45,22,8,125,121,49,141],die:[125,97],hawaii:91,iter:[125,115,66,135,25,124],item:[71,5,149,134,29,44,87,142,151,92,110,51,57,27,9,129,122,135,105],unsupport:29,public_html:148,team:[127,28,29],cooki:[27,139,29],div:[62,43,19,29,80,21,92,50],exit_databas:113,"15t16":91,round:[142,43,6,96],dir:11,prevent:[137,43,145,28,96,0,125,98,29,45,149,22,81,142,54,139,106,140,105,79],slower:103,secrion:79,user_str:25,"_file_mime_typ":29,sign:[10,29],shuffl:27,first_link:[62,29],product_name_saf:[130,29],last_activity_idx:100,myarchiv:112,afghanistan:91,appear:[71,43,79,19,5,53,20,29,98,46,145,18,91,96,50,147],repli:23,scaffold:[71,72,95,3,29,101,37,57],favour:29,current:[137,43,2,87,126,7,47,91,130,50,11,13,55,102,18,105,106,19,108,153,148,149,70,28,75,76,29,97,80,34,81,83,141,42],sinc:[0,87,9,92,50,131,93,12,53,97,56,18,103,106,130,65,108,68,109,25,149,112,113,27,75,76,29,115,33,34,81,150],ampersand:1,screenx:81,domain2:[30,33],domain1:[30,33],boost:34,file_path:128,or_not_group_start:149,if_exist:76,burn:142,image_mirror_gd:29,deriv:[25,79,22],dropdown:92,compos:[44,29],gener:[149,76,87,29,34,89,141],unauthor:[97,105],french:[137,91],check_exist:107,satisfi:[25,103],add_field:[28,76,29],slow:43,modif:[10,31,33,99,100,37,102,103],address:[29,126,14,81,6,92,141],myradio:92,along:[96,29,53,97,80,7,128,50],window_nam:81,userguid:29,latest_stuff:112,wait:96,box:[92,103,79,139],insan:57,error_suffix:[50,29],my_email:[9,33],ini_set:125,shift:[34,29],bot:[81,93],"_version":29,odbc_insert_id:29,a_filter_uri:29,membership:91,"_trans_depth":29,filename_help:101,valid_url:[50,29],commonli:[137,139,50,131,140,84,93],ourselv:33,some_act:128,semant:[125,46,29],regardless:[0,23,29,53,79,48,147,28,106],iana:23,extra:[62,43,79,0,29,21,22,103,92,50],activ:[5,149,29,33,143,82,101,91,130,103,41,131],modul:53,prefer:[76,149,34,146,29],ellislab:[127,33,29],instad:29,paramat:[23,29],ftp_unable_to_remam:29,createfromformat:55,visibl:[43,143,29],marker:[53,103,41,29],instal:[94,80,105,29],mobil:[93,29],eccentr:29,regex:[50,98,29],newslett:92,serpent:79,memori:[0,75,29,55,83,18],sake:[21,78],pref:[75,19],visit:[0,33,96,134,13,136,8,149,128,109,49,50,93],test_mod:87,perm:[114,148],subvers:29,permitted_uri_char:[33,57,29],live:[103,66,14,48],handler:[103,33,98,144,29],form_reset:[92,29],value2:23,value1:23,criteria:[50,98],msg:[109,121],scope:[45,29],australian:91,checkout:130,prep:[92,139,29],heading_previous_cel:19,um5:91,capit:[0,136,78,125,33,40,9],mcrypt_mode_ecb:[109,29],minim:[52,149,65,151,138,139,92,50,131,84],python:80,peopl:[23,98,121,130,139,131,153,84,146],claus:[125,82,149,76,29],array_item:103,enhanc:29,uniquid:29,visual:[53,29],um6:91,list_fil:148,prototyp:[137,94,96,146,78,98,7,150,145,128,129,91,121,9,50,124,123],omsk:91,postgresql:[94,29,33,48,82,103,70],effort:[33,42,138,121],easiest:125,is_imag:[140,128,69,29],fly:[23,29,37,151,101,112],orwher:[101,149,29],graphic:[133,6],auto_link:[81,29],prepar:[142,128,22],pretend:29,judg:68,uniqu:[135,149,29],image_arrai:13,cat:41,json_pretty_print:97,reappear:43,invalid_select:125,is_count:40,whatev:[142,28,87,125,29,108,48,148,81],purpos:[137,52,79,77,29,53,97,33,45,108,81,114,125,91,115,103,106],misc_kei:137,materi:[79,87],object_nam:108,problemat:[33,29],heart:0,validli:126,explor:[63,29,138,33,8],stream:[79,29],"_applic":[66,33,118,119],slightli:[125,147,149],backslash:98,agent:[29,51,23,116,33,100,128,119,139,106],choke:141,critic:[139,141],abort:[97,45,29],indefinit:10,uruguai:91,unfortun:[139,79,34,105],occur:[29,125,135,80,108,48,14,7],contribut:[10,29],pink:6,alwai:[0,33,43,125,7,92,49,93,11,9,98,99,103,106,66,139,25,76,29,114,79,80,48,150,30,41,141],differenti:[139,14,29],multipl:[94,141,29],keep_flashdata:[103,29],filename1:137,charset:[87,29,46,92,6,25],ping:146,write:[75,87,29,34,48,82,149,141],set_item:[43,7],purg:98,foreach:[27,23,75,134,125,115,151,55,21,150,47,128,91,130,149,111,131],pure:[30,115,33,55,151,9,41],familiar:[62,143,12,134,79,80,151,121,103],tild:139,xhtml:[6,23,29],tbodi:124,clean_str:29,map:[11,136,96,13,98,108],example_field:48,pg_escape_liter:29,http_refer:29,http_x_requested_with:106,max:[47,121,149,29],sql_mode:29,spot:40,usabl:[33,140,105,79],mac:[49,125,93,29],socket:[66,121,29],mymethod:129,query_string_seg:62,"_ci_class":29,mai:[85,0,79,43,125,45,7,34,130,129,52,92,50,93,10,11,96,134,53,87,98,14,137,101,103,132,140,105,21,108,109,139,149,147,136,28,75,76,29,115,33,46,121,122],end:[33,125,7,129,91,50,94,135,97,55,56,103,140,143,109,112,147,148,149,29,79,34,151,121,41],underscor:[0,29,125,98,81,40,139,141],validation_error:[92,50,22],data:[87,29,34,48,47,82,111,146],grow:131,man:29,statu:[43,97,75,29,155,33,45,149,81,87,82,48,103,105],practic:[27,14,48,78],conscious:127,foo_bar:108,stdin:[106,105,29],"_get_ip":29,inform:[10,94,29,34,146,141],"switch":[29,94,79,87,125,33,50,146],preced:[29,125,20,98,91,112],combin:[0,149,29,125,33,55,6,91,92,139,140,106],block:[29,125,115,80,151,83,103,131,141,124],"_clean_input_data":29,callabl:29,tbody_open:124,purifi:33,allowed_domain:[30,33],remove_invisible_charact:[113,105],pipe:[50,128,29],search_path:29,old_encrypted_str:109,approv:[137,140],show_prev_next:29,upload_form:128,increas:[125,103,135,54,29],nbsp:[124,6,33,19,29],or_where_not_in:[149,29],ttl:[103,66,29],get_magic_quotes_gpc:29,file_permiss:[53,29],still:[94,79,29,30,33,21,8,125,103,25,50,64],mark_as_flash:103,ttf:[53,145],dynam:[5,29,80,34,18,9],entiti:[147,1,69,29,135,20,33,46,6,121,50,140],smitti:96,conjunct:20,newprefix_tablenam:48,group:[94,87,146,29],thank:[103,29],polici:105,form_multiselect:[92,29],"_backup":29,users_model:50,mybutton:92,platform:[94,2,75,29,87,149,68,82,103,12,105,93],window:[141,29,125,66,81,49,106,140,105,93],new_table_nam:76,unset_tempdata:[103,29],intl:29,javascript_loc:43,mail:[23,29,126,33,81,68,92,103,141],main:[71,0,11,29,114,54,45,86,113,94,122,92,141,132],countabl:40,getfileproperti:125,explanatori:128,non:[147,97,76,29,125,98,20,33,55,139,101,6,107,25,103,124,105,106],halt:[103,29],jame:149,displai:[94,29,45,13,80,87,82,83,129,18,91,92,139],thumb_mark:53,initi:[94,87,34,29],alt_path:137,or_not_lik:[149,29],date_rfc822:[33,91],safari:[93,29],disappoint:50,ci_cart:130,now:[49,0,29],discuss:[139,136,38,149,104],nor:[135,33,149,48,79],havingor:29,pastebin:141,term:[62,27,2,79,108,137,9,103],argentina:91,name:[94,2,149,76,29,87,55,34,48,47,82,111,146],mysql_get_client_info:2,opera:29,cellspac:[130,143,19,124],drop:29,separ:[94,149,29,125,135,45,81,40,9,146],is_really_writ:[113,105,29],allman:[125,141],januari:[19,29],hijack:[139,140],pizza:6,compil:[96,87,53,29,48,83,149],failov:[94,29],domain:[29,30,33,80,90,103,106],"_get_mod_tim":29,img_path:145,cal_cell_no_content_todai:19,cookie_httponli:[103,29],replac:[75,29,48,47,151,25,149],stopped_by_extens:29,um95:91,continu:[96,134,29,125,98,22,109,121,50,41],ensur:[142,94,29,125,66,79,108,109,139],redistribut:10,backport:25,significantli:[131,110],viewpath:[113,29],year:[127,19,91,29],min_width:[128,29],happen:[23,134,29,79,34,33,129,103,41,112,141],set_realpath:[107,29],heading_row_start:[19,124],html_escap:[92,113,33,105,29],slide:43,shown:[62,27,136,79,19,149,29,53,115,33,128,81,151,145,83,130,50,41,137,147,155],accomplish:[96,76],referenc:[115,91,29],"3rd":29,space:[139,29],old_fil:148,mysql_escape_str:29,data_to_cach:66,"_remap":[49,0],trans_commit:[12,29],profil:[24,29],mess:110,get_file_properti:125,danijelb:29,tb_data:121,is_int:143,correct:[29,143,148,149,87,125,79,46,82,128,139,50],image_lib:[35,53,11,29],group_two:146,get_head:[97,29],ci_typographi:[46,20],migrat:[51,116,153,29],ibas:[70,29],xhtml1:6,tmpf:103,cart:[51,29],"_error_messag":29,cut:[55,29],ajax:[43,106,140,103,29],mime:[144,29,114,57,39,105],set_update_batch:[149,29],org:[6,23,29],"byte":[29,125,79,83,152,140],card:[130,79,109],error_str:[50,28],insert_str:[82,145,87,121],reusabl:52,time_refer:[91,29],suffici:103,global_xss_filt:29,nice_d:[91,29],yup:109,modest:29,british:[127,77],unavoid:101,turn:[62,33,12,134,29,13,34,81,150,82,128,148,149,92,139,105,106],place:[0,54,87,125,7,139,128,129,9,50,94,96,53,13,98,14,18,103,141,62,143,19,66,21,108,28,110,112,147,23,149,76,29,97,33,34,83,41,153],cal_days_in_month:[91,29],legacy_mod:109,log_messag:[113,45,12,29],okai:125,row_id:130,principl:[9,63],nicknam:96,think:[79,109,141],lambda:129,ci_benchmark:41,loki97:79,directli:[0,33,87,122,9,10,134,135,54,18,139,106,143,133,21,103,149,38,75,76,29,78],ci_lang:[85,137],onc:[137,43,45,130,128,122,9,93,96,53,29,18,138,103,104,106,143,19,20,21,108,145,109,139,111,112,27,148,75,76,78,115,79,34,121,124],arrai:[94,87,146,29],zab:125,housekeep:34,yourself:[137,0,43,125,130,103,141],tag_open:147,fast:[142,43,66,89,18,103],oppos:[33,79,29],additionali:103,fiji:91,ruri_to_assoc:[150,29],"__construct":[0,78,125,29,21,101,122,110,9,103,128],size:[142,145,130,96,29,53,79,150,114,128,6,152,139,92,50,124],truncate_t:29,file_exceeds_form_limit:29,twofish:79,silent:[33,29],convent:29,gif:[53,43,128],w43l:29,associ:[0,130,79,19,76,149,29,33,55,34,81,47,82,90,6,129,105,145,92,75,87],fmt:91,malform:29,assort:29,max_length:[47,50,147],utliz:149,circl:6,where_in:[149,29],white:[145,29],conveni:[43,28,30,44,33,114,140,106],my_foo:66,get_package_path:108,especi:103,programat:48,copi:[79,119,7,141,9,95,117,53,135,136,99,100,101,102,56,57,58,59,17,61,120,15,71,72,73,74,77,29,30,31,32,33,16,35,36,37,118,60,39,67,123,153,154,155],specifi:[137,0,97,5,98,7,130,128,129,48,91,92,50,93,94,96,134,53,135,87,55,6,142,57,103,105,78,62,19,147,66,108,145,148,109,25,149,112,146,27,23,75,76,29,114,79,81,82,106,124],oci_execut:29,cfb8:79,xhtml11:6,"short":[141,29],enclos:149,mostli:75,full_tag_open:62,necessarili:103,alnum:135,"_compile_queri":29,png:[53,114,128,81,29],imagecr:29,serv:[0,79,96,64,65,97,29,45,34,125,133,106,78],wide:[83,79,106],ciphertext:79,client_nam:128,instanc:[137,87,125,98,34,128,129,9,50,96,135,97,55,101,62,19,108,109,146,147,23,149,76,29,79,46,122,124],form_item_id:85,sha512:79,didn:[142,103,33,29],posix:29,param2:2,param1:2,were:[29,43,28,96,0,6,33,140,79,99,100,102,56,139,92,103,131,58,84],posit:[147,96,76,29,53,66,87,55,25],get_csrf_hash:[99,140],zsh:29,typographi:[88,29],seri:[113,43,29],pre:[96,29,20,97,46,130,50,106],lowest:[23,45],sai:[137,0,2,29,53,78,98,34,79,125,81,109,103,130,50,139,132],explode_nam:29,upload_success:128,xml_from_result:[75,29],"_prep_q_encod":29,delim:75,argument:[49,149,29],month_typ:19,dash:[1,29,98,81,40,139],db2:146,doctyp:[6,29],suhosin:[105,29],post_model:142,ssl_ca:94,num_field:[55,34],seppo:29,page1:149,"_env":29,caus:[43,23,12,29,125,98,33,45,14,87,92,128,129,107,9,103,112,147],"_create_databas":[101,29],engin:[71,5,76,64,115,33,29,81,151,48,103],squar:[50,6],advic:139,greek:29,destroi:[130,106,109,29],"_pi":29,note:[149,76,29,55,48,111,146,141],date_rfc2822:91,ideal:50,jefferson:142,take:[114,0,1,54,87,125,98,119,117,129,48,91,9,50,150,67,96,58,13,55,99,100,101,102,56,57,138,103,15,16,17,61,142,120,121,108,22,123,145,109,146,71,72,73,74,76,29,30,31,32,33,34,81,59,35,36,37,118,60,39,40,106,153,154,155,124],advis:[103,79,48,81,70],interior:125,green:[50,6,148,124],bcrypt:139,noth:[62,137,23,147,21,68,56,103,50],getwher:[101,149,29],error_messages_lang:137,realpath:29,begin:[63,54,149,29,125,135,13,18,50,42],sure:[0,12,5,125,78,55,149,99,56,110,9,139,141],incorpor:[65,137],trace:29,normal:[0,54,43,98,7,9,122,91,49,50,133,53,135,97,55,136,18,106,62,143,65,110,147,23,149,29,150,151],"_update_batch":29,mydata2:112,price:[130,131],group_on:146,compress:[112,75,94,56,29],clearer:141,default_domain:[30,33],"_assign_to_config":29,abus:29,sublicens:77,pair:[62,19,29,33,55,87,149,41],seeksegmenttim:29,henc:33,hotfix:141,get_total_dai:[19,29],fetch_class:29,icon:[6,81],exact:[50,33,147],image_res:53,view_fil:29,synonym:[5,131],textarea:[92,13,22,29],view_fold:[54,29],later:[136,28,149,33,21,22,100,103],option_valu:130,escape_like_str:[87,48,29],rotation_angl:53,runtim:125,pattern:[149,29,65,136,98,8,89,139,111],addit:[85,5,33,43,125,98,45,130,92,50,131,93,96,53,13,55,14,137,100,103,142,19,23,76,29,97,79,54,41],mb_strpo:25,axi:53,salt:[25,79],sess_expir:[103,33],gracefulli:146,shop:51,shot:[130,106],signoff:141,uncondit:29,show:[0,149,29,107,13,45,48,91,92,41,111],german:137,pconnect:[94,78,146,29],hmac:29,crime_is_up:150,concurr:33,shoe:[71,0,150,5],permiss:[148,77,53,128,114,37,18,49,103],hack:[82,129,106,69,29],threshold:[37,45,29],pull:[6,141,134,91,29],line:[94,75,29,149,151,12,146,141],fifth:130,help:[43,54,125,45,34,47,48,91,50,93,147,96,13,136,101,6,139,140,141,62,20,65,28,113,27,23,75,76,29,80,46,81,150,83,152],exit_user_input:113,userdata:[103,33,29],onli:[137,0,13,43,125,98,45,7,87,92,90,129,48,91,52,9,50,131,128,93,11,96,53,135,54,55,142,6,56,57,126,103,132,140,105,18,62,143,130,141,20,66,94,21,22,68,145,148,79,109,139,25,149,70,147,23,75,76,146,29,114,97,33,80,34,81,121,115,122,41,106,64,124],snack:129,ratio:53,favor:[142,69,84,29],romanian:29,transact:[89,87,29],ini_get:[125,29],xma:130,next_tag_clos:62,black:145,datestr:91,mydata1:112,filectim:29,first:[137,0,2,5,125,98,45,119,7,87,92,90,122,91,74,9,50,95,12,78,58,135,130,13,55,83,148,99,100,101,102,56,57,105,82,123,141,15,16,17,18,106,19,120,144,64,6,147,108,145,28,139,25,149,72,146,71,27,73,23,75,76,29,30,31,32,33,34,81,59,35,36,37,118,60,39,67,154,41,61,153,117,155],overwritten:[128,33,29],query2:55,over:[43,19,63,53,29,98,21,81,87,125,6,91,92,96,105],mypic:[53,128],nearli:[53,81,130,110,9,84],variou:[27,19,29,128,39,50,112,93],get:[0,79,87,98,45,89,90,129,130,50,51,54,55,101,56,57,139,78,66,111,23,149,29,33,34,48,83],sst:29,imagecreatetruecolor:29,sss:80,secondari:48,ssl:[23,148,105,29],cannot:[113,27,94,76,29,107,79,103,42,141],mypic_thumb:53,neither:[53,79],requir:[94,12,76,29,55,82,149,111,146,141],truli:131,reveal:[68,43],item_nam:7,output_compress:29,outperform:103,borrow:127,email:[11,29,55,82,9,111,104],todo_list:[96,134],twelv:124,euro:91,default_control:[0,98,29],ini:[147,29,125,107,151,128,103],ci_cach:66,ent_compat:140,where:[0,87,125,129,91,9,94,134,55,14,18,104,105,141,147,145,25,146,71,27,38,149,29,78,34,48,82],summari:[9,43],wiki:[138,8],msdownload:29,a_long_link_that_should_not_be_wrap:23,smiley_j:[13,29],marquesa:91,password_get_info:25,send_email:[126,33,29],smiley_t:13,"_display_cach":[129,29],my_input:110,calendar:[51,101,29],another_method:38,element_path:43,concern:[130,103,33,140],infinit:29,detect:[28,3,29,30,97,33,79,87,53,128,81,25,140,93],"_base_class":29,controller_trigg:[71,5],review:33,auto_head:29,ubiquit:103,label:[85,50,76,92,29],db_pconnect:[87,29],enough:[142,50,79,139],between:[2,125,9,50,131,94,12,53,135,98,14,18,139,105,65,112,23,149,29,115,40,41],my_app:108,"import":[79,8,151,56,109,139,9,103,131],paramet:[2,141,34,29],across:[33,14,79],dir_read_mod:113,assumpt:52,"_clean_input_kei":29,aleutian:91,august:29,parent:[0,38,78,29,110,9],sku_567zyx:130,cycl:[135,23,18],reorgan:29,set_content_typ:[97,29],blog_nam:[76,121],come:[137,43,136,29,44,66,33,98,14,7,89,139,128,115,103,131,140,106],sess_upd:29,repertoir:43,fit:77,rsa:29,file_read_mod:113,controller_info:83,pertain:34,groupbi:[101,149,29],contract:77,inconsist:29,open_basedir:114,improv:29,log_threshold:29,create_link:[62,29],cal_cell_end_todai:19,undocu:33,item3:103,frameset:6,color:[142,145,130,147,29,53,33,150,92,6,9,50,124],colspan:[130,19,124],list_field:[47,87,55,29],period:[96,29,20,128,91,130,139,106],pop:81,photo2:23,photo3:23,exploit:[140,29],up13:91,colon:[94,29,151,139,130,103],example_t:48,exclud:[112,5,23,97,114],cancel:[149,96],up14:91,consider:[53,29],returned_email:23,damag:[79,77],needlessli:29,"_remove_url_suffix":29,semicolon:[151,140,29],coupl:[52,96,64,29,110,9,50],dynamic_output:53,west:91,rebuild:29,fopen_read:113,mari:124,mark:[29,147,64,33,48,100,83,92,103,41,105],locpath:148,individu:[75,76,29,66,34,111],certifi:[10,141],trig:29,thead:124,ci_sha:29,short_open_tag:125,repons:[105,121],decrypt:[139,109],thousand:29,georgia:91,rubi:127,get_id:121,proven:[139,33,79],"_drop_databas":[101,29],thing:[97,125,8,49,50,136,14,139,140,141,19,66,108,22,21,103,149,76,29,33,80,81],repres:[62,5,29,53,98,33,55,21,65,121,25],former:29,those:[137,5,33,125,7,139,130,50,93,96,53,135,97,98,136,99,103,78,62,20,110,76,29,79,34,141,124],sound:141,blowfish:79,firstnam:[115,96],amend:29,rtype:80,singleton:108,wm_shadow_color:[53,29],cast:[125,79,29],netpbm:[53,68,29],is_robot:[93,29],base64:[50,79,96,139],outcom:149,send_success:121,bufferedtext:125,margin:[92,131],show_next_prev:19,assoc_to_uri:150,glanc:51,advantag:[76,125,8,92,109,138,9,103,105,106],protect_identifi:[87,48,29],cache_item_id:66,up9:91,destin:[53,128,148,98],prev_tag_open:62,or_hav:[149,29],list_databas:[75,29],my_dog_spot:40,eras:103,img_width:145,hash:29,blog_id:[28,76],ascii:[147,148,29,145,121,105],ship:130,subtot:130,par:29,ci_image_lib:[53,29],xml_encod:125,author:[94,77,29,125,48,130],obfusc:81,alphabet:50,intermediari:65,same:[0,2,149,10,146,29,55,49,27,9,141,76],jsmith:96,binari:[148,29,112,79,25,140],html:[5,11,134,29,80,45,91,92,139,105],pad:[53,79,29],file_4:135,raw_output:25,pai:29,document:29,form_fieldset:[92,29],week:[19,91],php_sapi_nam:29,screenshot:141,utf8:[94,123,76,146,110],nest:[149,78,12,108,29],assist:[85,27,1,147,145,29,114,45,80,11,81,135,90,6,142,126,92,139],driver:[94,2,34,146,29],someon:[23,79,145,57,109,130,50],modify_column:[76,29],companion:147,driven:141,capabl:[5,52,29],my_sess:108,mani:[94,12,76,135,34,48,127,6,49,139,141],extern:[125,103,140,29],encrypt:[51,94,69,29,135,54,139],rewriterul:5,disallow:[147,140,57,29],return_object:87,sanitize_filenam:[140,69,29],"_ci":29,appropri:[62,10,136,96,29,125,79,45,149,87,82,152,103],new_entri:96,mcrypt_blowfish:109,markup:[43,128,6],page:[149,29,34,111,146,141],custom_row_object:55,without:[137,0,2,43,125,45,7,9,128,92,129,48,91,49,50,12,53,97,55,103,58,106,107,66,21,108,145,109,139,27,38,149,76,77,29,79,81,83,121,122,41,141],compression_level:112,titl:[13,128,81,50,96,134,135,136,55,6,140,142,21,22,111,149,29,115,78,80,48,121,124],index_kei:25,model:[29,44,49,24,9,122,141,132],get_content_typ:[97,29],dimension:[94,134,29,115,6,129,130,124],insert_batch:[149,29],keyup:43,execut:[87,76,29],among:[130,103,93,29],rule3:50,rule2:50,rule1:50,allowed_typ:[128,29],directory_separ:29,gd_load:29,"_post":[29,142,78,125,33,145,83,92,139],"_get_config":29,kill:29,cambodia:91,aspect:[53,19,29],touch:103,monei:142,less_than:[50,29],speed:[43,18,103,29],filter_var:[126,33,29],product_lookup_by_id:98,versu:125,is_cal:[50,29],fh4kdkkkaoe30njgoe92rkdkkobec333:130,except:[5,125,55,7,9,90,91,92,50,53,135,98,101,103,20,66,110,149,76,29,115,33,46,81,150,35,151,41,84,124],param:[29,0,79,75,43,125,33,80,103,108,129,96,9,50,62,124],desktop:[112,96,75,144],non_existent_fil:107,my_shap:142,blob:[103,33],versa:53,constant:[105,29],mb_convert_encod:29,process_:0,word_censor:[147,29],earli:129,gd2:53,hover:43,around:[29,87,125,66,13,48,92,50],code:[141,146,29],read:[136,87,125,8,50,131,78,134,54,101,138,103,104,105,106,63,144,108,22,148,4,139,111,112,27,38,149,29,114,33,34,48,83,41,153],escape_str:[87,48,29],messsag:23,"_convert_text":125,is_allowed_filetyp:29,grid:[145,29],darn:147,mom:[96,134],world:29,js_insert_smilei:[33,29],"_write_cach":0,blackberri:29,whitespac:29,some_funct:[92,2],changelog:[141,29],preg_replace_ev:29,integ:[143,11,149,76,29,53,55,82,125,103,50],server:[94,75,29,87,45,34,14,151,18,146,105,132],set_status_head:[113,97,105,29],benefit:[38,12,125,149,48,91,92,50],photo1:23,either:[43,79,125,128,2,91,50,92,102,96,53,98,101,6,103,140,78,62,143,20,109,149,146,23,75,29,33,34,81,141],cascad:29,output:[75,76,29,48,49,18,25,82],tower:141,nice:[50,22,147],json_unescaped_slash:97,yyyi:91,what:[94,141,34,48,29],affected_row:[82,111,149,29],method_exist:0,juli:29,blog_label:76,http_header:83,authent:29,word_wrap:[147,29],error_db:[71,87],set_new:22,first_row:55,form_help:35,slice:6,caribbean:91,mood:6,easili:[5,97,149,79,21,101,122,109,131],deliveri:[124,29],kml:29,definit:[76,29,33,80,92,122,9],token:[125,97,140,29],protocol:[23,3,64,135,29,81,68,148,103,106],ac3:29,exit:[28,29,125,97,45,9],inject:[128,29],xtea:79,"_parse_cli_arg":29,apostroph:20,complic:103,overli:[125,34,29],exp_pre_email_address:125,refer:29,get_last_ten_entri:78,mailto:81,total_item:[130,29],shadow:53,power:[43,136,22],pdo_sqlit:29,garbag:103,inspect:130,ci_load:[108,29],max_height:128,broken:[139,23,38,29],apantbyigi1bpvxztjgcsag8gzl8pdwwa84:109,fopen_read_write_cr:113,found:[137,0,79,44,45,7,90,129,91,135,97,98,136,23,103,105,106,66,108,38,139,25,28,75,29,33,150,152,121,141,155],mime_content_typ:29,thailand:91,referr:93,appli:[29,141,87,53,33,98,125,90,103,50,124,139,106],isset:[29,125,55,14,103,106],earlier:[136,149,134,121,21,22,103,50],callback_:50,src:[6,145,23,29],central:91,greatli:12,discern:[128,29],island:91,previous_row:55,request_filenam:5,exit__auto_max:[113,45],greater:[1,74,125,91,50,105],mcrypt_dev_urandom:[25,79],is_numer:[139,143,29],degre:[53,115,52],intens:[114,46,34],phpdomain:80,reset_queri:[149,29],table_nam:[75,76,87,33,55,48,47,82,111],slash_rseg:150,luck:142,backup:29,processor:46,routin:[27,52,75,29,34,128,139,50],effici:[93,29],max_siz:128,status_cod:45,coupon:130,lastli:[80,150,3,34,96],image_width:128,date_rang:[91,29],quietli:125,super_class_vers:125,strip:[147,23,69,29,135,22,139,121,50],your:[141,29],clipperton:91,call_user_func_arrai:0,unit_test_lang:35,wm_font_path:53,"_detect_uri":29,area:[53,13,98],met_win_open:81,odbc_num_row:29,"_explode_seg":29,overwrit:[128,7,29],xw82g9q3r495893iajdh473990rikw23:130,ci_unit_test:143,strict:[94,87,29],pre_system:129,interfac:[149,29,53,45,49,103,131,84,106],low:[125,147,33,79,29],mbstring:[25,29],ipv6:[50,106,118,29],submiss:[125,145,91,139,50,140],strictli:114,filter_uri:29,lang:[85,113,137,29,125,33,108,7,50,93],up10:91,programmat:[27,28,33,29],str_replac:125,bsc:115,conclud:103,bundl:[103,80],designfellow:29,"_session":[103,33,29],mb_strlen:[25,29],procedur:[50,27,129,45,29],cubrid_affected_row:29,cryptograph:[33,140,109,79],openxml:29,conclus:51,sess_expire_on_clos:[103,33,29],orlik:[101,149,29],notat:[53,114,29],mathml:6,possibl:[79,125,122,130,132,52,53,97,98,136,101,57,138,139,141,62,108,21,109,110,149,38,75,29,115,33,34,54,153],"default":[94,12,76,29,55,149,82,75,146,141],error_prefix:[50,29],delete_fil:[114,148,29],lowercas:[29,78,125,33,81,22,109,106],eschew:84,grasp:80,my_calendar:108,embed:[134,29],deadlock:[103,29],remove_spac:128,up12:91,expect:[63,75,29,125,115,136,45,103,143,8,139,128,102,121,9,96,150,140,141],cbc:[79,29],creat:[10,141,34,146,29],multibyt:29,certain:[71,0,94,33,149,43,44,29,80,34,5,25,139,141],tahiti:91,site_id:76,valid_usernam:50,mode:[94,87,29],strongli:[33,57,70],undergon:29,print_debugg:[23,29],file:[10,141,29],next_url:19,fill:[50,29],incorrect:[92,125,79,108,29],again:[43,79,136,108,50,103,141],image_typ:128,googl:[143,29],hex:[53,79,69,29],collector:103,bhutan:91,conn_id:[2,34,29],prepend:[149,29,79,108,48,150,90,50,106],field:[94,87,29],valid:[0,94,12,29,98,25,104],collis:[137,29,66,33,108,7,106],rdbm:29,is_unix:91,no_file_typ:29,writabl:[29,114,45,34,145,37,18,128,112,105],you:[0,2,3,4,5,6,7,8,9,11,12,13,14,15,16,17,18,19,20,21,22,23,25,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,43,44,45,46,47,49,50,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,78,79,80,81,82,83,84,137,87,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,48,117,118,119,120,121,122,123,124,125,128,129,130,131,132,134,135,136,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155],mcrypt_create_iv:[25,140],architectur:[51,86],poor:68,create_kei:79,sequenc:[94,28,29,79,82,6],symbol:[114,107,29],pear:[84,29],multidimension:[92,50,6],track:[45,28,12,103,29],dropbox:141,rsegment:[33,150,29],localhost1:94,typecast:29,regex_match:50,deliber:109,ci_zip:112,segment_two:87,redud:33,cookie_domain:[103,3],wm_use_drop_shadow:29,descript:[94,141],session_id:[103,33,29],smtp_user:23,mimic:20,mass:101,potenti:[139,1,38,70,29],up115:91,escap:[82,111,87,29],w3c:[6,91,29],newli:[50,109],unset:[103,33,139,29],is_uniqu:[50,29],disp:23,file_upload:11,all:[10,141,29],db_backup_filenam:75,new_field:33,filename_pi:101,lack:[103,33],dollar:[98,29],month:[125,91,29],new_list:124,atlant:91,correl:[129,18],mp3:29,microtim:145,wm_type:53,follow:[0,1,3,5,7,9,11,12,13,18,20,21,22,38,25,26,27,28,29,33,34,39,40,41,43,44,45,46,47,49,50,52,53,55,23,56,57,62,63,66,69,71,72,73,74,75,76,77,78,79,80,81,83,85,90,91,92,93,94,95,96,97,98,100,101,6,103,104,106,107,108,110,111,113,114,48,121,122,123,125,126,128,129,133,134,135,136,137,139,140,142,143,144,145,146,147,149,152],alt:[6,23,29],disk:[53,66,79],children:29,abid:54,library_path:53,content:29,iconv:[25,29],number:[87,125,55,88,90,91,94,98,83,6,18,139,105,142,145,25,38,149,76,29,82,151],get_file_info:[114,29],script_nam:29,sess_regenerate_destroi:103,wmv:29,spirit:29,mistakenli:29,init:[71,72,73,74,3,29,95,57],use_sect:[108,7],spearhead:127,queri:[2,34,29],read_dir:[112,29],wma:29,cgi:29,db_backup:29,adapt:[66,149,87],"case":[137,0,86,79,5,125,98,9,128,122,92,50,94,12,53,54,55,126,103,140,104,105,106,130,149,147,66,108,22,109,110,96,115,27,148,75,76,29,30,97,33,81,114,40,139,155],liter:[92,139,143,98,29],straightforward:103,ingredi:79,fals:[27,94,105,12,76,29,55,78,45,149,48,47,83,80,98,25,75,87,146],passconf:50,keydown:43,get_new:21,verb:29,mechan:[143,79,76,29,33,129,109,103],verd:91,fall:[25,30,66,33],veri:[142,125,89,90,129,48,9,50,131,93,52,12,53,136,148,56,103,62,19,108,68,28,149,71,23,75,115,34,81,41],get_clickable_smilei:13,condition:[53,23,96],subsubsubsubsect:80,mysql_set_charset:29,norfolk:91,"_filter_uri":29,my_array_help:27,tag_clos:147,last_nam:96,e_strict:29,emul:[0,103],small:[63,52,23,29,125,79,82,92,131,84,124],require_onc:71,e_notic:29,dimens:53,trans_strict:[12,87],getimages:29,samoa:91,ten:124,"__get":[103,55,29],my_blog:96,product_lookup:98,sync:29,past:[33,91,79],zero:[135,79,45,34,150,37,128,103,130,50,84,106],postgr:[82,94,70,29],db_conn:108,pass:[87,141,146,29],overlin:80,further:[0,52,97,63,29,34,6,121,25,103,146],nba:50,return_path:[23,29],directory_depth:11,trick:[103,139,29],server_path:114,sub:[80,34,29],trans_rollback:[12,29],sun:[19,91],section:29,abl:[43,29,125,98,79,55,8,126,83,121,9,50,105],brief:[128,79],ci_encrypt:[79,109],delet:[76,87,29,34,48,82],abbrevi:[53,137,19],last_login:55,primary_kei:47,intersect:29,is_bool:143,some_method:[0,38,75,76,80,9],ci_migr:[28,29],"public":[0,79,125,9,128,122,49,50,10,94,96,134,13,55,136,6,103,78,21,22,110,28,149,29,33,54,141,42],contrast:[131,12],millisecond:43,full:[137,0,54,43,125,8,89,128,9,131,93,94,69,53,97,101,6,139,132,105,62,143,149,68,96,111,75,29,114,115,34,81,150,41,124],iran:91,agent_str:93,pacif:91,variat:[55,29],where_not_in:[149,29],misspel:29,decid:[106,79,96,29],behaviour:[23,33,29],coco:91,shouldn:[103,33,7],username_check:50,imap_8bit:29,is_allowed_typ:29,is_object:[143,29],ci_pagin:62,method:[87,141,76,146,29],strong:[147,79,29,33,130,139,124],modifi:[10,87,29],preserve_filepath:112,valu:[141,29],leav:[143,23,69,29,53,79,22,81,125,102,129,57,139,50],min_length:50,valid_ip:[50,106,29],ahead:55,server_info:29,popen:29,observ:29,prior:[28,29,128,74,129,109],amount:[12,53,97,149,83,18,130,50,41,131,84],pick:125,action:[43,130,149,77,0,53,98,29,80,47,92,128,102,129,49,50,140],another_t:34,narrow:139,detectifi:29,diamet:142,hash_algo:69,display_error:[87,29],gost:79,intermedi:8,screeni:81,africa:91,example_librari:9,hash_hmac:79,remap:29,deprec:[94,69,76,29,114,126,13,81,100,101,6,91,135,92,153,70],href:[19,29,115,21,81,6],famili:79,um45:91,demonstr:[147,23,13,22,128,6,112],decrement:[66,19,29],"_start":41,establish:[146,87],trans_off:[12,87],select:[87,29,34,48,47,82,111],metaweblog:96,test_nam:143,ci_env:[14,29],hexadecim:[25,79],helper:29,internation:29,faint:53,two:[0,79,98,45,7,34,47,9,92,50,132,12,135,55,139,141,130,145,109,110,146,71,27,23,149,29,33,46,83,41],page_titl:134,fopen_read_writ:113,autonom:[52,87],res_datatyp:143,taken:[28,42,29],select_max:[149,29],"_object_to_arrai":29,minor:29,more:[85,0,79,5,125,98,45,119,8,92,129,91,49,50,131,52,12,78,134,53,135,54,55,14,100,101,102,153,126,103,6,34,142,63,130,19,147,65,66,94,22,108,68,96,25,69,146,27,136,23,149,29,30,97,33,46,81,37,118,105,121,41,139],emoticon:13,flaw:[139,29],desir:[85,137,28,149,146,29,125,20,13,55,14,128,148,139,132,84,124],create_thumb:53,hundr:[93,29],mozilla:93,relative_path:140,photoblog:96,flag:[143,149,76,87,29,139,141],driver_name_subclass_2:86,driver_name_subclass_3:86,broke:[141,29],driver_name_subclass_1:86,known:[149,29,33,139,110,25,103,93],mathml1:6,mathml2:6,trans_statu:[87,12,29],cach:29,fopen_write_create_strict:113,"_stringify_attribut":113,town:76,none:[23,19,29,53,87,139,128,28,103,25,75],endpoint:140,suitabl:[125,135,33,69],hour:[103,91,145],hous:[96,134],list_tabl:[47,87,29],der:29,outlin:109,dev:[25,125,33,140,79],detect_mim:128,orderbi:[101,149,29],remain:[18,145,34,22,29],paragraph:[50,1,29],nine:124,caveat:103,learn:[12,54,98,108,7,138,103,131,84],group_end:149,male:150,explod:125,typograph:46,subclass_prefix:[9,27,37,110],scan:29,up875:91,challeng:131,server_protocol:106,share:[94,19,29,34,103,3,132],"404_overrid":[98,29],templat:[71,51,87,29,45,151,84],sphere:6,minimum:[62,50,128,149],unreli:[105,29],set_row:55,phrase:147,blog_head:115,ci_upload:[128,29],unlucki:139,cours:[79,33,98,109,103,92,50,131],newlin:[23,75,29,125,135,20,46,6,50,106],first_nam:[50,96],secur:29,rather:[137,5,87,9,92,50,131,52,12,134,98,100,141,143,94,108,146,76,29,115,33,48,106],anoth:[0,23,12,76,149,29,33,103,7,108,151,139,128,122,75,96,50,93,112,79],smtp_port:23,perhap:[9,27,110,103,50],fame:103,narrowli:52,some_cooki:106,url_titl:[81,29],unabl:[114,121],"_unseri":29,reject:52,iso:[23,91],csv:29,simpl:[0,79,5,45,89,92,49,50,131,94,96,134,6,103,62,143,19,147,28,109,27,23,149,29,115,33,80,81,121,43,84],needl:[25,27],css:[43,97,147,33,81,6,91,139],"_thumb":53,convert_accented_charact:[147,29],regener:[103,140,29],plant:96,sandwich:91,resourc:[94,12,87,29,55,34,48,122,149],indian:91,whats_wrong_with_css:81,smiley_view:13,show_404:[113,0,29,45,136,98,21,155],variant:137,invok:[71,5,52,38,129,110,50,41,104,106],reflect:[41,29],catalog:98,buffer:[125,23,56,29],mutat:29,subdriv:29,unlink:29,lanka:91,circumst:[97,29],github:141,product_typ:98,system_path:54,footer:[65,136,21,22,134],ani:[85,0,2,5,125,155,45,47,92,129,48,91,9,95,12,105,135,13,98,83,56,57,139,15,16,17,18,142,113,141,72,145,74,110,146,71,27,73,38,149,29,114,80,34,81,35,36,37,54,39,122,123,153,154,87],onto:97,overnight:124,in_particular:125,callback:29,image_height:128,yyyymmddhhiiss:28,hash_equ:[25,29],media:6,stricton:[94,29],set_hash:29,cal_cell_start_oth:19,checkbox:[92,50,141,29],rotat:[53,68,29],no_result:150,migration_vers:28,azerbaijan:91,file_s:128,cook:91,through:[0,38,19,29,135,63,33,55,21,108,90,103,92,96,131,124,140,105,106],reconnect:29,hierarchi:[80,134],fff:53,helo:29,password_hash:25,orig_path_info:29,style:29,config_item:[113,33,105,29],ip_address:[29,33,145,118,121,103,106],border:[143,19,29,145,130,124],end_char:[147,121],dbname:[94,146,29],resort:103,bypass:133,number_lang:152,delici:3,might:[137,0,79,5,98,45,8,90,129,50,94,96,134,53,13,55,136,18,103,105,78,143,141,64,21,22,108,145,147,23,75,29,114,33,151,106,153,124],alter:[28,76,29,153,33,100,148,118,110,103,140],wouldn:29,ci_db_result:[149,55,87],"return":[0,86,87,98,45,47,9,122,49,55,105,25,149,111,146,27,75,76,29,78,80,48,82],prev_tag_clos:62,than:[85,0,1,79,5,125,98,45,9,129,48,92,132,94,12,134,55,100,139,105,141,130,147,109,146,27,149,76,29,33,34,81,84],accept_charset:[93,29],file_5:135,sentenc:20,pollut:29,file_1:135,sess_use_databas:33,ff0:[147,33],ssss:80,framework:[9,127,110,29],cer:29,compound:[149,29],timezone_menu:[91,29],custom_result_object:55,bigger:145,"_helper":108,redesign:29,table_data:124,set_mod:109,cubrid:[33,70,29],troubleshoot:51,my_cach:66,userid:96,gmt_to_loc:91,refresh:[18,81,29],micro:145,achiev:[0,33,55,18,103],alreadi:[137,43,79,47,50,97,55,103,141,143,108,28,149,112,115,23,75,76,29,31,33,121],innodb:[12,76],sha384:79,is_fals:143,fulli:[11,29,125,54,129,18,57],intervent:[97,109],backtrac:29,errata:29,truncat:[147,149,29],do_upload:[128,29],weight:103,needless:29,korea:91,hard:[53,92,79,103,29],addressbook:131,ci_session_dummy_driv:103,crontab:29,realli:[79,12,29,33,34,81,68,48,139,103,131,105,141],playstat:29,finish:[130,148,108],next_tag_open:62,connect:[94,2,29],fist:29,todd:149,attachment_cid:[23,29],http:[0,83,45,105,29],db_forg:29,beyond:[52,149],todo:[151,134],orient:27,some_valu:103,ftp:[125,51,29],vladivostok:91,safeti:103,or_lik:[149,29],miss:[94,29,125,81,145,70],nepal:91,form_fieldset_clos:[92,29],publish:[96,77],thirdparamet:91,send_error:121,health:45,add_kei:[28,76,29],print:[147,23,149,29,107,81,151,6,40,49],dir_write_mod:[113,29],bui:130,subsubsect:80,occurr:135,w3school:81,file_nam:[50,128,108,134,29],textil:80,asp:81,proxi:[96,29],mylibrari:33,advanc:[125,63,33,29],create_captcha:145,samara:91,differ:[137,2,125,7,91,130,50,131,93,10,96,53,98,14,103,132,78,62,143,19,21,22,108,148,112,79,23,149,146,29,31,33,81,41,153,124],asc:149,quick:141,reason:[62,0,94,79,96,149,29,125,135,33,34,48,108,130,56,121,49,103,139,141],base:[5,2,87,49,129,91,92,10,12,135,54,14,6,141,127,144,33,110,149,111,71,75,76,29,30,78,34,81,114,152,42],believ:103,sku_123abc:130,ask:[141,29],teach:63,phd:115,basi:[18,29],thrown:[66,29],"_blank":81,english:[137,147,3,29,35,50,93],omit:[75,149,29,125,33,103,121,130,19],success:[23,12,76,29,114,80,66,87,55,149,7,48,130,75],caption:[124,29],golli:147,get_config:[113,29],csr:29,threat:140,"_error_handl":[113,29],cache_query_str:29,undergo:29,file_writ:29,assign:[137,27,136,23,75,76,134,29,78,55,21,7,108,149,128,122,48,9,103,41,79],update_batch:[149,29],feed:[6,48,29],major:[53,149,80],notifi:23,obviou:[49,141],row_arrai:[111,55,21],feel:[115,101,138],articl:[5,19,87,21,81,49,103,131],lastnam:[115,96],ci_db:108,mod_mim:128,sometim:[47,50,75,96],footprint:[52,84],cell_end:124,done:[137,0,136,54,96,29,30,97,33,80,21,79,83,133,129,138,27,115,103,141,78],least:[29,79,103,139,50,105],directory_trigg:29,form_open_multipart:[92,128,29],stabl:[42,141],init_unit_test:72,file_parti:29,guess:[125,29],error_arrai:[50,29],script:[43,87,125,45,9,129,49,50,69,53,97,55,56,103,140,105,106,143,65,139,28,149,29,114,33,81,30,121],column_kei:25,interact:[49,79],gpg:29,yekaterinburg:91,construct:[62,63,29,130,122,9],tradition:12,header2:23,stori:103,underlin:80,order_bi:[149,29],accept:[43,79,87,125,55,91,92,50,93,94,96,135,136,98,102,103,140,105,106,19,145,139,23,149,76,29,115,33,81,121,6,141,124],cfg:29,dbdriver:[94,146,78],is_arrai:[125,27,143],scheme:[28,136,29],store:29,schema:[121,94,28,21,29],free:[125,103,55,77],adher:[125,84],statement:[149,76,87,29,48,151,75],ctype_digit:[139,29],behind:[53,26],compens:29,php_sapi:105,johndo:[92,50,103],count_all_result:[149,29],php_error:[45,29],apppath:[113,114,29],pars:[125,97,13,81,29],logged_in:[103,81],myclass:[62,85,149,125,129,9],grace:29,fred:[135,148,124],king:76,kind:[147,77,135,33,45,103],cookie_secur:[103,29],aac:29,abr:19,remot:[148,96,29],orhav:[101,29],remov:[149,76,29,14,18,139,105],migration_en:28,dtd:6,jqueri:29,reus:[103,149,21],pragma:[97,29],str:[1,87,125,92,50,69,135,13,140,105,143,20,40,25,147,23,29,46,81,150,82,121],consumpt:55,stale:101,toward:[53,103],beij:91,"_sanitize_glob":29,fixat:103,randomli:[139,145],cleaner:[131,29],comput:[49,149,96],mpeg3:29,deleg:136,strengthen:29,sssss:80,beforehand:29,favicon:6,packag:[125,100,54,29],is_support:[66,29],sport:50,expir:[29,97,34,145,90,18,103,106],mod_rewrit:5,reset_valid:[50,29],"null":[149,76,87,29,55,25,105],format_numb:130,query_build:[11,33,94,108],option:[137,0,79,3,5,125,98,45,7,92,128,129,91,74,9,50,131,93,151,94,12,134,53,87,55,14,148,6,18,107,103,140,78,62,143,130,19,149,83,66,108,123,28,109,110,25,96,146,71,147,23,75,76,29,114,97,33,80,81,150,37,152,43,106,153,84,124],sell:77,mountain:91,reset_data:149,nozero:135,"_prep_filenam":29,relationship:98,lib:29,remote_addr:103,replyto:23,self:[113,128,29],violat:29,troublesom:29,port:[94,23,96,29,66,148,103],undeclar:147,also:[114,0,28,5,125,98,45,119,79,87,49,90,92,129,48,91,74,9,50,93,151,94,95,12,134,105,135,13,55,14,137,148,141,140,56,57,136,103,15,16,17,106,62,130,120,149,65,83,66,67,21,108,38,139,25,96,112,71,72,73,23,75,76,29,30,97,33,80,34,81,150,35,36,37,54,39,121,43,123,42,128,124],"_is_ascii":29,elapsed_tim:[41,97,87],brace:[125,115,151,20],signup:50,vnd:29,file_typ:128,distribut:[94,77,29,108,103,42],backtrack_limit:29,victim:139,choos:[43,28,12,149,29,53,79,46,81,109,103,50,146],reach:21,chart:51,font_siz:[145,29],most:[79,3,45,139,128,91,9,50,131,93,147,12,53,55,18,103,146,104,143,19,20,65,66,148,109,110,96,112,70,27,23,29,115,33,48,121,124],plai:68,protect_al:1,whether:[137,43,1,97,87,125,45,7,34,47,130,90,91,92,50,93,10,11,12,53,135,13,14,6,56,103,140,105,106,142,143,19,144,107,66,94,22,108,149,148,109,139,25,69,112,146,136,23,75,77,29,114,115,79,80,46,81,121,141,128],plan:141,myisam:12,last_act:[100,33,103,29],selector:43,my_const:125,charg:77,xlarg:92,tonga:91,x11r6:53,clear:[23,29,53,79,34,108,89,33,103,112,84,124],bdb:12,cover:[10,96,8],ci_db_forg:[76,108],roughli:109,"2nd":29,ext:[71,29],part:[137,10,1,23,96,27,53,63,29,98,149,114,125,109,110,25,103,141,112,147,124],clean:[96,134,29,66,33,69,141,140,106],enctyp:128,latest:[28,141,136,29],awesom:136,s_c_ver:125,mcrypt_mode_cfb:109,pdo_mysql:29,carefulli:[79,153,34,109],alphanumer:29,phooei:147,top_level_onli:[114,101],row_object:55,appver:29,session:[51,94,29,54,83,122,9,16,123],particularli:[12,29,136,98,46,108,131,140],worri:[79,45,91,141],exit_error:[113,45],font:[53,145,29],fine:[49,81],find:[137,0,44,45,7,128,131,93,12,98,56,103,78,142,64,65,96,27,29,115,79,34,151,121,141,153],impact:[101,79],access:[0,2,5,125,98,7,122,9,94,13,55,99,139,105,78,66,109,149,111,79,38,75,76,29,114,33,34,81,83,54,42,84],pretti:[33,106],url_help:[27,21],myutil:75,unattend:103,ruin:29,mypassword:[50,146,78],solut:[79,115,33,126,25,103,84],is_referr:[93,29],validate_url:[121,29],couldn:29,cursor:29,factor:[52,33,149,34],"_server":[29,30,33,14,103,106],i_respond:96,charcter:79,unus:[103,29],albeit:142,ssl_verifi:94,amount_paid:149,express:[149,29],ffield_nam:29,blank:[23,75,29,53,129,108,81,125,56,57,50,106],nativ:[94,2,12,87,29,55,48,122,110,25,105],ci_log:29,mainten:29,quotes_to_ent:[135,29],xss_clean:[90,69,101,29],liabl:77,post_controller_constructor:[129,29],restart:29,set_capt:124,callback_foo:50,builder:29,repair_t:75,uri_seg:[62,29],date_cooki:91,crt:29,set_dbprefix:[149,48,29],whenev:[125,33,45,34,29],full_tag_clos:62,rfc:[23,91,79,29],common:[12,29],newest_first:130,greater_than:[50,29],empty_t:[149,29],delete_dir:[148,29],uri_to_assoc:[150,29],crl:29,arr:125,set:[94,12,76,29,87,55,34,48,82,149,111,146,141],blog_templ:115,php_eol:[49,106],backtrack:29,cookie_prefix:[103,90,3,106],vinc:142,utf8_en:[113,29],seg:150,simpler:[129,29],see:[43,79,0,125,98,110,7,34,9,128,5,91,49,50,94,12,134,97,55,14,101,57,138,126,103,58,105,106,19,147,66,21,22,108,145,96,69,111,146,27,136,149,76,29,114,33,80,46,81,37,122,139],sec:80,arg:[135,124],transpar:[53,97,29],reserv:29,horizont:53,flavor:[3,108],php:29,chose:[103,79,109],legend_text:92,simultan:146,mt_rand:135,inconveni:[13,33],someth:[0,54,130,128,129,91,9,50,93,94,96,134,97,98,14,56,103,106,62,108,145,112,71,148,149,115,80,81,121,141],strtolow:[98,29],particip:131,debat:29,imagejpeg:29,inner:[149,129,29],won:[23,149,79,97,33,55,34,81,83,122,98,103],migration_t:28,source_imag:53,mismatch:29,ssl_cipher:94,experi:[68,103],nope:109,compliment:111,altern:29,stored_procedur:29,prefix_singl:87,latin:[139,29],imagemagick:[53,68,29],numer:[11,28,19,29,114,135,33,98,149,130,152,91,139,25,50,106],all_userdata:29,this_string_is_entirely_too_long_and_might_break_my_design:147,javascript:[51,29,13,80,101,81,90,92,139,105],output_paramet:96,isol:29,call_hook:29,some_par:38,incident:33,"_create_t":29,raw_input_stream:[106,29],distinguish:125,slash_item:[33,7],date_lang:91,classnam:[43,37],struct:96,verbos:[125,14],water:96,last:[29,19,87,97,55,108,48,82,151,106],delimit:[23,75,29,33,98,81,128],is_write_typ:[87,29],hyperlink:81,is_natural_no_zero:50,event:[29,34,81,128,7,92,50,106],pg_exec:48,imageid:145,pdo:[94,29,55,82,146,70],add_suffix:137,context:[103,79],forgotten:139,mb_enabl:[25,113,29],pdf:[23,80,29],author_id:82,prng:29,whole:[10,33,55,79,29],wm_y_transp:53,load:[75,76,29,55,80,34,122,111,146],xspf:29,markdown:80,simpli:[137,0,79,43,126,45,7,130,128,129,48,9,50,131,132,12,134,53,135,136,100,103,106,62,143,149,108,148,110,96,112,71,27,23,75,29,115,33,34,81,37,121,122,41,141,124],cast5:79,point:[141,149,34,105,29],instanti:[0,52,96,87,29,55,129,103,122,146],schedul:33,any_in_arrai:27,arbitrarili:50,header:[0,144,134,29,125,81,83,105],fashion:[63,79],littl:[115,143,153,34,121],total_rseg:150,linux:[49,103,93],mistak:[33,29],db_connect:[87,29],csrf_exclude_uri:[140,29],file_exist:136,backend:[66,3,29],expressionengin:[53,127,33],identif:29,unsuccess:12,user_id:149,devic:[125,93,29],create_t:[28,76,29],empti:[0,75,76,29,125,6,55,81,102,91,92,149],implicit:29,whom:77,secret:[139,79,109],comment_textarea_alia:13,wm_hor_align:53,your_lang:[152,91],cell_alt_start:124,devis:29,nonexist:29,invis:43,save_path:103,load_class:[113,29],valid_email:[126,50,33,29],imag:[51,23,69,29,13,128,7,145,101,6,81,139,50,153,154,155,146],array_replace_recurs:[25,29],restrictor:149,unnecessarili:29,gap:28,phpdocument:29,coordin:53,understand:[10,12,57,138,96,103],file_write_mod:[113,29],func:[50,29],demand:[33,12],other_db:[75,76],vulner:[33,141,29],weekdai:19,include_bas:108,foreign_char:[147,101],ignit:29,look:[47,141,48,29],localhost2:94,bill:135,histor:[135,33,79],cluster:[34,109],"_has_oper":29,"while":[79,125,98,45,130,50,11,96,53,55,14,138,103,106,94,28,146,147,23,149,29,114,33,80,151,42],unifi:29,smart:12,abov:[0,54,5,98,7,92,128,129,48,91,9,50,94,147,96,134,53,135,13,55,151,6,142,18,103,146,78,62,143,130,19,141,20,66,21,22,108,123,79,109,110,149,111,112,70,27,23,75,76,77,29,114,115,33,81,82,83,121,43,122,41,106,124],checksum:29,anonym:[50,29],ci_output:97,loop:[125,55,29],javascript_ajax_img:43,subsect:80,real:[23,96,134,29,80,127,41],pound:147,uri_str:[83,150,81,29],nl2br_except_pr:[46,20],readi:[29,53,13,108,138,111],member_ag:149,"3g2":29,pakistan:91,last_link:[62,29],jpg:[147,23,144,53,97,145,128,6,112],password_default:25,itself:[149,29,125,45,79,55,103,50,131,155,141],rid:101,saferplu:79,recompil:112,row_alt_start:124,form_checkbox:[92,29],shirt:[92,130,98],grant:77,limit_charact:121,msexcel:29,belong:33,myconst:125,up95:91,shorter:[50,33],redisplai:50,decod:[29,79,46,101,109,139,140],onclick:92,octal:[53,114,148],date_rfc1036:91,blogview:134,conflict:[28,7,29],bom:125,parse_templ:19,archiv:[33,112,21,29],imagin:136,optim:[34,29],"3gp":29,defeat:6,ssl_kei:94,piec:[96,66,79,21,109,121,103],moment:[41,12],strength:101,mousedown:43,user:[125,98,45,48,91,9,94,13,55,18,139,104,142,145,110,25,38,75,76,29,114,80,34,81,151],"_exception_handl":[113,29],extrem:[68,101,131],repopul:[50,29],robust:[126,23],wherev:18,new_data:109,transitori:109,cilex:80,recreat:[148,112],subpackag:125,travers:[140,11,69],task:[49,27,131,84,103],unicod:[125,29],discourag:[125,33],eleg:38,somet:82,exit__auto_min:[113,45],parenthes:149,honor:29,person:[10,23,77,140,108,128,112],tb_id:121,gambier:91,elev:112,traffic:[96,134],table_exist:[47,87],result_id:[2,34],anybodi:103,full_path:128,predetermin:50,add_package_path:108,ci_secur:[140,69,46,29],ceo:127,"_file":29,rule:[0,29],obscur:[53,79],vietnames:29,shape:[142,6,96],unix_to_tim:91,mysql:[94,75,76,29,87,149,48,82,91,12,146,153,70],love:[131,6],question:[29,135,64,34,48,8,6,138,141],sidebar:134,failsaf:106,move:[54,55,132,29],sandal:0,errand:134,point1:41,restructuredtext:80,theoret:79,m4u:29,mydatabas:[146,78],num_link:[62,29],label_text:92,tweak:29,xml_rpc_respons:96,unlik:[27,96,125,66,33,45,81,130,106],subsequ:[29,133,43,87,108,18],app:[68,41],myothermethod:129,useless:[82,83,33,29],bin:53,australia:91,varchar:[28,76,145,21,100,118,121,103],format:[27,86,75,29,55,80,94,82,151,25,139,141],improperli:29,is_writ:105,file_ext_tolow:[128,29],get_post:29,intuit:68,corner_styl:43,nginx:14,game:142,backtick:[48,29],insert:[87,34,29],is_resourc:[143,29],bit:[29,79,87,33,80,109,103,131,141],characterist:79,array_pop:27,intel:93,table2:[149,75],table3:149,table1:[149,75],captcha_tim:145,heading_cell_start:124,post_system:129,userfil:128,alpha_numer:50,resolv:[107,141,29],enable_hook:[129,57],collect:[27,21,34],"boolean":[79,87,125,47,130,128,48,91,92,50,93,11,96,134,53,98,6,57,103,140,105,78,62,143,19,144,94,108,148,112,146,71,23,75,29,114,115,33,81,37,121,106],mycustomclass:92,highlight_str:147,password_verifi:25,popular:[103,66,79,12],smtp_crypto:23,word_limit:[147,29],xmlrpc_client:96,encount:[29,33,45,108,151,140,106],mylist:6,often:[94,2,20,125,79,14,8,33,136,103],mcrypt_rijndael_256:109,sess_match_ip:103,fcpath:113,creation:[53,29],some:[137,0,2,43,125,126,45,79,8,47,92,143,5,91,9,50,122,93,10,94,96,134,53,13,98,14,101,56,138,103,140,105,106,62,63,144,147,66,21,22,108,28,110,25,149,146,113,27,136,23,75,29,114,115,33,80,34,81,129,41,139,87],back:[62,28,12,29,30,66,33,98,21,22,34,87,75,96,25,50,131,140,79],if_not_exist:76,sampl:[86,76],get_zip:112,error_gener:[71,45],redi:29,phpredi:[103,66],scale:84,chocol:108,culprit:29,sku_965qr:130,exect:29,exec:[105,29],per:[98,75,18,29],foreign:[75,29],usernam:[137,94,23,96,78,55,149,151,148,103,92,50,146],substitut:115,larg:[0,23,75,29,125,33,55,150,68,92,9,96,84,124],error_views_path:29,unsanit:48,reproduc:141,newdata:103,machin:28,id_:98,object:[87,2,34,146,29],run:[89,94,2,149,76,29,87,55,34,48,47,82],field_id:13,irkutsk:91,raspberri:29,agreement:[51,131],cal_cell_content_todai:19,step:[27,64,54,34,139,141],form_dropdown:[92,29],news_item:21,db_driver:29,prep_for_form:[50,29],concoct:109,victoria:91,mssql:[87,70,29],cautious:109,reduce_linebreak:46,sess_encrypt_cooki:[33,108,29],constraint:[139,28,76,29],row:[82,111,87,149,29],extract_url:121,prove:[125,126],highlight_cod:[147,29],manag:29,rowcount:29,idl:[87,146,29],microsecond:[87,29],add_row:124,product_opt:130,mcrypt:[33,29,79,101,109,58],update_entri:[96,78],uncach:149,cookie_path:[103,3],reduct:29,upload_data:128,primarili:63,init_pagin:29,within:[0,2,76,29,80,122,18],pdostat:29,upgrad:[51,139,29],product_edit:98,ci_except:29,jimmi:135,todai:19,alpha:[29,135,139,130,50,106],contributor:127,announc:127,total_queri:87,pcre:29,websit:[30,103,33,29],inclus:29,institut:[127,77],bangladesh:91,next_prev_url:[19,29],spam:[81,121],fledg:8,proprietari:29,sock:66,stylesheet:[147,6,81,7],submit:[137,92,90,91,50,130,102,10,9,53,135,55,6,57,139,141,19,133,22,145,149,112,146,75,29,34,48,82,128,124],custom:29,optimize_t:[75,29],flashdata:[33,109,29],forward:[28,98,33,55,7,150,92,140],update_post:96,cur_tag_open:62,files:114,zealand:91,properli:[0,79,149,29,115,33,80,21,48,139,103,155],repeatedli:79,great:[131,6,141,29],twenti:62,current_url:[81,29],add_insert:75,perman:[125,103,101,109],link:[27,3,29,125,107,13,80,81,6],translat:[114,98,75,76,29],newer:[25,125,70,141,29],atom:[66,91,29],azor:91,ci_form_valid:50,ci_:[9,27,101,110,29],angri:6,info:[69,29,114,45,98,46,81,105],bevel:43,utf:[23,29,125,6,97,108,102,39,121,92,93],consist:[71,10,147,29,143,137,101,103],cid:23,myfield:92,seven:[96,19,124],mod_mime_fix:[128,29],cal_cell_cont:19,highlight:[147,19,29,125,33,80,124],similar:87,curv:138,ci_input:[69,29,33,90,110,106],enlarg:118,exit_success:113,rowid:130,bind:[87,29],flow:[125,51,129,141],parser:[51,116,125,29,84,141],hash_pbkdf:139,mouseup:43,doesn:[52,54,149,29,126,33,55,136,79,25,151,92,105,139,9,103,41,112,64],dog:[43,41,40],convert_text:125,incomplet:[121,29],oof:125,guarante:[103,140,42],apache_request_head:106,rewritecond:5,gecko:93,bracket:[129,29],another_mark_end:41,anyth:[94,79,29,33,98,81,130,109,92,139,41,141,132],crypt:25,sequenti:[28,29],form_valid:[104,29],invalid:[19,96,29,53,125,91,103,50,140],id_123:98,smtp_pass:23,setenv:14,bad_filenam:29,librari:[0,86,149,29,44,80,122,110,146,105,141],trans_begin:[12,29],ellipsi:[147,20],xss_filter:33,particular:[137,87,7,47,129,130,50,132,12,134,135,55,103,93,147,149,96,146,27,75,77,78,34,81,82,121,41],is_mobil:[93,29],ctr:79,draw:145,rijndael:79,introduc:[63,125,21,8,153,105],drop_column:[76,29],elsewher:[130,103],js_library_driv:43,wrongli:29,eval:[151,105,29],less:[147,1,29,125,45,52,81,50],curtail:121,cal_cell_no_cont:19,smilei:[88,29],um35:91,index_pag:[6,64,81,29],curl:49,algorithm:[69,29,101,109,25,139],vice:53,svg:6,callback_username_check:50,sftp:148,parse_smilei:13,depth:[124,11,79,29],xmlrpc_server:96,get_userdata:[137,103],image_librari:53,far:[50,96,103,87],fresh:[149,33,99,100,101,102],script_head:43,slash_seg:150,scroll:43,set_output:97,oop:[9,137,29],fopen_read_write_create_destruct:113,basic11:6,partial:[124,29],examin:[130,133,96,149],scratch:[131,84],mysql_to_unix:91,rewriteengin:5,ellips:[147,6,29],last_upd:97,urandom:[25,33,140,79],do_hash:[101,69,29],router:[35,133,110,33,29],compact:125,ci_session_driv:103,privat:[94,29],current_us:34,get_mime_by_extens:[114,29],you_said:96,friendli:[71,5,64,79,80,29,81],send:[142,0,75,144,134,29,114,126,33,81,87,125,90,129,92,139,41,146,141],code_start:41,lower:[94,29,135,79,98,81,128,9,105,106],blaze:103,opposit:[43,91],aris:77,function_exist:[105,29],bcc_batch_siz:23,sent:[0,87,126,45,129,50,133,96,97,56,18,103,141,142,144,108,23,76,29,115,121,41],passiv:148,unzip:54,convert_ascii:121,whichev:149,"_plugin":29,disclos:141,vlc:29,plain_text:79,account:[0,106,91,84,29],blog_id_site_id:76,ofb8:79,spoof:29,syntax:[89,146,149,48,29],smtp_keepal:[23,29],relev:[94,46],tri:[29,64,30,33,7,57,140],db_debug:[94,78,146,29],byte_format:[152,29],magic:[103,29],succeed:87,http_client_ip:[106,29],notabl:[33,55,29],non_existent_directori:107,ci_config:[33,81,7,29],lombardi:142,kmz:29,"try":[94,149,48,29],last_queri:[82,83,87,29],noninfring:77,mysubmit:92,pleas:[114,0,54,3,4,43,119,7,34,92,141,91,147,9,50,131,151,95,69,78,58,53,135,13,83,99,100,101,102,56,57,103,146,15,16,17,61,130,120,72,66,97,108,153,123,139,74,104,109,110,25,111,79,71,27,73,38,149,29,30,31,32,33,46,81,59,35,36,37,118,60,39,67,154,41,106,42,117,155],malici:[139,140],impli:77,constrain_by_prefix:[87,29],use_t:29,set_radio:[92,50,29],myuser:54,anoym:129,cfb:79,encourag:[79,138,29,33,98,7,68,81,57,109,121,9,139,153,100],crop:[53,68,29],date_atom:[33,91],cron:[49,149],video:29,ci_db_driv:[87,29],download:[75,29],odd:150,click:[27,43,125,13,81,92],show_debug_backtrac:113,compat:29,index:[113,0,29,55,110,45,34,14,129,80,98,49,139,111,132],phpdoc:141,sapi:106,compar:[149,29],use_global_url_suffix:[62,29],page2:149,slight:33,"_set_overrid":29,cal_cel_oth:19,xor_encod:29,experiment:[43,33],helper3:27,helper2:27,helper1:27,text_watermark:29,this_string_is_:147,bird:41,can:[0,2,5,7,8,9,11,12,13,14,19,20,21,22,23,25,27,28,29,30,33,34,37,38,41,43,44,45,46,47,49,50,53,54,55,56,18,62,63,65,66,71,75,76,78,79,80,81,82,83,137,87,90,91,92,93,94,96,97,98,100,6,103,104,105,106,108,109,110,111,112,114,115,48,121,122,124,125,128,129,130,131,132,133,134,135,136,139,140,141,142,143,144,145,146,147,148,149,150,151],ci_sessions_timestamp:103,sybas:[33,29],imagepng:29,preg_quot:29,is_cli_request:29,elips:6,len:135,sqlsrv_cursor_stat:29,closur:[129,29],hkk:29,logout:103,blog_name_blog_label:76,session_write_clos:103,safer:[82,149,48],vertic:53,encryption_kei:109,crypt_blowfish:25,design:[5,79,19,29,115,13,48,68,109,130,139,131,124,78],select_avg:[149,29],ineffect:33,metro:150,larger:[53,101,45,29],technolog:[127,77],alaska:91,mb_substr:25,migration_typ:[28,29],cert:29,ci_pars:115,another_field:[33,76],heading_cell_end:124,"_fetch_uri_str":29,typic:[62,0,11,96,91,134,27,53,98,78,55,34,48,108,65,109,139,130,103,93],set_ciph:109,wm_hor_offset:53,chanc:[142,103,33],subsubsubsect:80,field1:[149,106],firefox:29,danger:[105,29],foreign_key_check:[75,29],new_fil:148,approxim:109,base_url:[9,102,122,81,29],bad_dat:91,standpoint:52,api:[43,96,29,79,14,140],blog:[0,28,149,134,27,115,13,98,34,81,108,148,121,78],oval:6,apc:29,file_ext:128,day_typ:19,blog_set:7,heading_next_cel:19,sorri:103,tailor:[53,62,23,79],cache_expir:0,zip:[51,116,75,29],commun:[94,96,29,127,103,141],ci_control:[113,0,136,28,96,134,78,13,21,101,122,49,50,128],doubl:[1,75,149,29,125,135,20,98,46,92,96],seamless:109,my_arch:112,"throw":29,implic:[30,33,110],eleven:[147,124],usr:[53,23],clear_data:112,expiri:[103,141],start:[87,29],rick:[127,82,48],sort:[130,103,96,150],comparison:[125,143,149,29],wincach:29,error_lang:137,benchmark:[0,110,129,29],about:[87,141,29],balanc:149,wm_text:53,prefetch:[55,29],trail:[148,29,135,33,98,7,150,129],from:[2,87,29,34,111,146,141],extens:[27,94,144,134,29,114,44,87,80,145,25,37,9,105],actual:[62,43,136,79,144,29,98,33,45,115,137,126,145,107,25,103,105,70],getter:103,harvest:[19,81,29],focu:[43,131,80,84,63],firebird:[70,75,29],signific:50,retriev:[111,87,34,29],alia:[33,19,149,29,97,13,55,46,81,108,87,135,90,91,103,92,69,141,105,106],crazi:149,cumbersom:12,annoi:6,smart_escape_str:29,obvious:2,collat:[94,76,29],meet:[52,125,79,139,50,141],valid_base64:[50,29],has_userdata:[103,29],aliv:29,control:[141,149,34,29],distrubut:103,sqlite:[94,70,29],weaker:79,tap:[129,29],pre_control:129,chosen:[54,12,79,66,33,100,103],process:[12,29,55,82,18,146],lock:[114,103,33,29],tax:34,high:[147,52,29,79,139,109,121,103],tag:29,entry_id:121,tab:[75,29,125,80,81,140],epallerol:29,sought:149,onlin:12,serial:[34,29],image_size_str:128,everywher:103,surfac:29,is_str:143,filepath:[129,148,112,108],soon:[33,153],tamper:29,six:124,database_exist:[75,29],xml_convert:1,build_str:125,crlf:[23,29],copyright:[53,77],subdirectori:[38,108,29],instead:[0,1,125,55,47,49,129,91,92,69,9,135,13,98,6,139,141,144,110,149,146,27,75,76,29,114,34,151,40,122],reestablish:[87,29],zip_fil:112,convers:[29,14,108,20],stock:[100,37],docblock:[125,29],loui:142,likewis:53,prolif:125,overridden:[0,109,29],singular:[52,40,29],interchang:[79,108],fran:29,table_clos:[19,124],act:[136,96,134,29,33,108,90,140,105,106],sundai:[19,91],pasteur:142,my_cached_item:66,server_addr:29,attent:[68,29],discard:[108,29],redund:29,dbutil:[75,108],exit_config:113,trim_slash:[135,29],chown:103,some_var:45,ssl_cert:94,"20121031100537_add_blog":28,friendlier:90,light:109,m4a:29,robot:[6,93,29],suppress_debug:148,issu:29,webroot:139,days_in_month:[19,91,29],wordwrap:[23,29],allow:[114,0,79,125,98,7,92,128,91,9,50,131,52,12,53,135,13,55,151,57,103,140,106,62,143,130,19,149,66,94,108,74,110,96,71,28,75,29,30,115,33,34,81,150,82,37,152,121,139,124],append_output:[97,29],fallback:[125,33,141,29],per_pag:62,furnish:77,json_encod:97,y_axi:53,include_path:[114,29],screensend:87,cryptographi:79,sess_regener:103,insight:8,optgroup:[92,29],product_id:150,passion:6,comma:[23,75,29,103,121,50,141],gender:150,is_dir:148,georg:142,bunch:33,get_csrf_token_nam:[99,140],enclosur:75,cubird:76,outer:149,reilli:135,pecl:103,wget:49,adjust_d:19,maxlifetim:103,fetch_:33,form_password:92,button:[92,50,29],apache2:107,therefor:[86,29,30,33,34,103,130,50],pixel:[53,128],img_height:145,double_encod:29,docx:29,fourth:[92,147,23,75,91],handl:29,auto:[146,12,29],remove_package_path:108,overal:29,camino:93,auth:[98,29],p10:29,mention:[103,79,29],p12:29,password_bcrypt:25,overkil:[9,27,110],tbody_clos:124,front:[114,133,29],profiler_no_memori:29,csrf_protect:[140,29],escape_identifi:[87,29],strive:52,models_info:114,another_nam:103,somewher:112,"_remove_evil_attribut":29,xml:29,edit:[98,81,29],unlimit:76,wm_x_transp:53,tran:6,json_unescaped_unicod:97,ping_url:121,scrollbar:81,myfold:[148,112],mystyl:6,batch:[23,149,29],disregard:74,mycheck:92,error_report:45,register_glob:29,pygment:80,few:[79,19,29,30,33,98,22,8,125,57,121,25,103,131,141,105,106],yakutsk:91,better_d:91,due:[43,79,75,29,33,149,143,101,103],intellig:[134,29,81,68,7,146],chunk:115,einstein:142,product:[71,0,94,28,29,33,98,14,7,150,5,54,139,130,103,79],consum:[41,83,29],sha224:79,meta:[47,6,55,29],"static":[119,51,117,99,100,101,102,56,57,58,59,60,61,63,120,21,18,15,71,72,73,74,29,30,31,32,33,16,35,36,37,118,17,39,67,123,153,154,155],driver_nam:[86,29],connor:135,password:[94,146,29],our:[52,79,149,108,136,103,33,21,22,8,139,138,121,49,50,131,141],meth:[23,80],hiddenemail:92,"_after":76,special:[38,96,76,29,103,139,121,92,50,106],out:[113,142,28,96,77,29,53,54,34,22,8,87,125,151,23,139,92,103,141,105,79],variabl:[0,94,75,29,55,151,45,14,48,83,122,27,9,149,146,105,132],set_flashdata:103,reload:50,influenc:79,parse_str:[115,29],hmac_digest:79,some_librari:125,categori:[125,27],thoma:142,clockwis:53,rel:[11,23,78,53,107,29,108,114,128,6,129,139],inaccess:49,inspir:127,rec:6,plural:[40,29],char_set:[94,123,76,146,29],math:6,random_el:[142,27],default_templ:19,ecb:79,insid:[137,38,3,29,115,33,80,149,22,129,110,103,122,112,132],sendmail:[68,23,29],frank:149,msssql:29,sess_cookie_nam:103,umark_flash:103,readm:[103,80],get_var:[108,29],get_wher:[149,21,29],transliter:147,invas:29,csrf_regener:[140,29],group_id:125,chatham:91,bleed:127,greedi:[125,29],prefix_tablenam:48,marginleft:43,get_day_nam:19,select_sum:[149,29],nowher:107,indent:141,should_do_someth:80,tripled:79,migration_add_blog:28,unnam:29,lexer:80,put:[0,33,55,49,128,92,50,132,12,134,53,13,98,18,103,106,62,143,64,21,145,139,96,23,149,29,79,34,48,121,41,124],email_lang:137,timer:[0,41,97,48],keep:[34,29],profiler_no_memory_usag:29,length:[147,87,135,29,47,18,25,139],unidentifi:93,wrote:[21,141],outsid:[43,5,79,147,29],url:[0,29,98,49,24,27,9,122,82,105],retain:[103,109,29],do_xss_clean:[101,29],timezon:29,south:91,softwar:[143,77,65,79,45,138],cache_info:66,delete_cooki:[90,29],diplay_error:53,blown:[115,143],blogger:96,ci_ftp:148,qualiti:[53,68,141],echo:[75,76,55,48,47,82,149,111],whoop:136,date:[149,111,78,75,29],proxy_ip:[106,29],oci8:[70,29],pgp:29,quick_refer:29,owner:[103,139],child_on:38,shortcut:6,facil:141,b99ccdf16028f015540f341130b6d8ec:130,utc:91,prioriti:[23,29,79,45,108,103],forgeri:[139,29],"long":[27,23,19,76,29,125,79,145,139,25,103,132,106],fair:12,timestamp:[28,19,29,33,145,91,103],newus:103,unknown:[151,33],licens:[10,51,29],perfectli:0,mkdir:[103,148],system:[94,12,29,44,34,48,149,141],wrapper:[66,55,87],attach:[68,143,23,29],attack:[29,79,22,128,139,103,140,106],physic:23,which:[0,2,3,43,125,98,79,8,92,143,5,48,91,74,9,50,131,132,52,12,134,106,53,135,54,55,14,100,57,153,103,146,140,105,18,62,63,130,19,141,144,147,66,94,108,145,23,109,96,25,69,112,115,27,136,38,149,29,30,97,33,34,81,150,82,83,39,121,28,139,124],termin:[49,121,105,81,29],erron:29,"final":[0,147,129,29],ssl_capath:94,ipv4:[50,106],find_migr:28,haystack:[25,27],lot:[55,46,22,110,103,140],big:29,methodolog:129,fetch_method:29,col_arrai:13,third_parti:29,shall:77,accompani:33,essenti:141,ogg:29,exactli:[149,76,29,53,98,55,115,109,103,9,50,106],haven:[50,79,108,22,103],kamchatka:91,rss:[65,6,91],prune:49,detail:[43,79,96,29,53,66,33,45,14,7,108,68,125,90,57,139,9,103,111,101,131],jsref:81,structur:[89,29],charact:[1,79,87,125,91,92,50,93,94,53,135,97,98,6,57,103,140,105,106,20,22,109,139,25,147,23,75,76,29,114,33,80,46,81,118,39,121],claim:77,your_str:62,htaccess:[5,29,114,54,14,139,131],session_data:[103,83],sens:[65,27,33,29],becom:[62,5,52,23,19,27,53,79,108,81,125,136,140,124],sensit:[103,86,75,139,29],foobarbaz:66,signifi:145,stricter:140,pgsql:94,accept_lang:[93,29],send_error_messag:96,"function":[141,29],counter:53,codeignitor:29,faster:[115,79,81,56,103,131,84],terribl:[50,91],falsi:92,explicit:[125,29],basepath:[71,113,28,19,29,108,9],respons:[28,134,29,97,45,34,81,121],clearli:125,correspond:[137,3,125,44,7,128,50,96,134,53,135,13,98,103,104,19,21,22,4,115,34,150,83],sufix:62,corrupt:29,have:[0,3,5,6,7,8,9,10,12,13,14,15,16,17,123,19,21,22,23,25,28,29,30,31,32,33,34,35,36,37,38,39,43,45,46,47,50,52,53,55,56,57,58,59,60,61,62,121,71,72,73,74,75,76,78,79,80,81,83,87,90,91,92,94,95,96,97,98,99,100,101,102,103,106,108,109,110,115,48,117,118,119,120,67,122,125,128,129,130,132,134,136,138,139,141,142,143,145,146,148,149,150,18,153,154,155],close:[141,29],get_metadata:[66,29],member_nam:87,superobject:[129,29],pg_version:29,tb_date:121,migration_auto_latest:28,admin:[33,75],in_arrai:[30,27,33],rout:[49,0,129,24,29],fileproperti:125,accuraci:29,tighten:29,mix:[137,142,87,98,45,7,90,91,92,50,96,135,97,55,6,103,140,105,106,62,143,144,66,21,108,23,25,112,147,28,149,80,128,81,150,152,124],discret:[27,38,29,90,50,124,106],cheatsheet:29,hkdf:79,codeigniter_profil:29,anchor_popup:[81,29],listen:[103,96],mit:29,singl:[94,87,141,34,29],uppercas:[0,29,125,135,109,106],address_info:92,unless:[79,125,90,130,10,134,53,97,55,57,103,142,143,20,108,109,25,112,149,76,29,33,46,128],post_control:129,ci_cor:29,oracl:[94,70,149,29],galleri:53,textmat:80,row_alt_end:124,header1:23,get_request_head:[106,33,29],eight:124,max_filenam:[128,29],deploi:[28,29],segment:[87,141,34,29],"class":[141,29],page_query_str:62,newprefix:48,placement:29,expert:79,child_two:38,gather:[47,93],upset:6,set_error_delimit:[50,29],character_limit:[147,29],face:20,inde:[125,29],my_log:33,determin:[82,87,34,29],built:[92,128,136,81,106],constrain:29,stark:131,plaintext_str:109,fact:[103,33,134,109,79],my_bio:112,ci_user_ag:93,cal_cell_start:19,extension_load:109,send_respons:96,ci_sess:[100,33,118,153,103],model_nam:[108,78],watch:[45,21],bring:[127,101],new_imag:53,format_charact:[29,20],trivial:[103,141],anywai:[79,29],texb:[53,145],redirect:[5,23,96,29,98,81,122,9],dbcollat:[94,123,76,146,29],textual:19,locat:[137,0,54,43,45,7,129,91,9,50,93,94,53,13,136,103,132,104,78,66,108,71,27,29,33,81,150,121],strip_image_tag:[50,69,29],blog_entri:115,holder:77,illus:142,calendar_lang:3,mug:130,should:[0,3,5,6,8,9,13,15,16,17,18,19,21,23,25,28,29,30,31,32,33,34,35,36,37,39,43,44,45,49,50,53,54,55,56,57,58,59,60,61,70,71,72,73,74,75,76,79,80,81,137,91,92,94,96,98,99,100,101,102,103,106,108,109,114,48,117,118,119,120,67,123,124,125,128,129,130,133,134,136,139,141,143,146,147,153,154,155],jan:19,lightest:52,smallest:52,suppor:29,intrigu:6,elseif:[125,151,93],local:[113,0,87,29,80,110,9],hope:8,mb_mime_encodehead:29,meant:[137,103],um10:91,strip_slash:135,invalid_files:29,gettyp:29,server_url:96,sess_match_userag:[33,29],convert:[147,1,69,29,135,46,81,91,92],error_404:[71,98,45,155,29],wordi:125,made:[43,52,136,149,134,29,31,33,21,22,99,100,102,56,42,141],csrf:29,orig_data:109,db1:146,target_vers:28,in_list:[50,29],edg:[53,127,29],cur_tag_clos:62,endless:[25,29],application_config:125,getuserinfo:96,dishearten:6,enabl:29,organ:[34,29],nl2br:[46,20],upper:[53,106],or_wher:[149,29],bounc:43,htmlspecialchar:[50,124,105,29],sha:79,csrf_token_nam:[99,140],image_url:13,integr:[49,147,79],contain:[85,0,1,5,125,98,45,34,47,90,129,48,91,92,11,69,135,13,55,100,102,139,6,141,142,147,107,94,145,25,149,111,152,146,71,27,38,75,76,29,114,78,80,46,81,118,119,40,87],menuitem:115,grab:136,view:[87,149,34,29],conform:139,legaci:[0,33,103,109,29],avg:[149,29],cal_cell_blank:19,parse_exec_var:[97,29],frame:6,knowledg:[10,103],exit_unknown_class:113,group_nam:146,qty:[130,29],popup:81,rc2:79,equip:40,form_input:[92,130,29],my_uri:29,sphinxcontrib:80,entitl:7,thead_open:124,unexist:29,log_file_extens:29,error:[94,87,141,29],segment_arrai:150,adodb:12,correctli:[147,136,29,126,20,79,45,82,112,141],record:[10,149,29,33,21,22,101,103,140],mimes_typ:29,pointer:[63,55,29],boundari:29,last_visit:29,var_dump:[125,66],state:[43,52,23,149,0,29,143,18,91,92,103],stacktrac:141,ci_trackback:121,progress:43,multiplelanguag:137,equiv:6,thumbnail:53,get_compiled_insert:[149,29],get_dir_file_info:[114,29],perfect:[53,22],core_class:37,sole:106,bed:142,kei:[94,87,29],vrt:53,weak:139,matic:96,simple_queri:[87,48,29],salli:151,fopen_write_create_destruct:113,job:[49,136],entir:[62,27,148,75,29,125,115,63,54,55,34,14,110,103,9,50,41,66],joe:[148,149,135,98,150,151,92],has_rul:50,poof:29,parenthesi:[125,149,29],thumb:53,proxy_port:96,date_rfc850:91,quote_identifi:29,plugin:[71,123,95,39,29],wrapchar:23,goal:[51,131,84],mpg:29,cell_alt_end:124,foobaz:125,etc:[43,2,87,125,47,9,122,49,50,93,11,96,134,97,103,140,141,19,147,107,40,94,68,139,146,27,23,149,76,29,79,80,34,82,121],cachedir:[37,146,94,29],grain:81,mysecretkei:108,tld:[30,33],db_set_charset:[87,29],gmdate:97,fopen_read_write_create_strict:113,messagebodi:50,onchang:92,comment:[0,29,149,34,27],shirts_on_sal:92,unmark:103,sqlsrv_cursor_client_buff:29,ci_db_pdo_driv:29,img_id:[145,29],hyphen:29,heavi:[103,34,146],print_r:[125,75,148,19,96],chmod:[103,148,29],walk:55,image_reproport:29,rpc:[51,116,139,29],"0script":105,respect:[94,75,29,135,33,98,92,101,25,50],tuesdai:19,mcrypt_mode_cbc:[109,29],append:[62,94,23,134,29,135,97,81,128,7,92],utf8_general_ci:[94,146,76,123],april:29,quit:[27,96,143,125,80,6,18,121,131],foofoo:125,tort:77,addition:[76,29,125,44,33,108,7,6,104,106],endforeach:[134,128,21,151,130,131],get_inst:29,form_prep:[92,29],watermark:29,compon:[52,19,29,130,103,141],json:97,write_fil:[114,75],treat:[5,12,87,29,6,112],date_w3c:91,popul:[19,29],xlsx:29,curli:[29,20],both:[79,89,122,130,50,96,53,13,103,105,141,109,149,112,75,76,29,30,33,80,81,150,54,106],censor:147,overlay_watermark:29,interbas:[82,70,75,29],togeth:[62,149,134,136,48,145,50],raw_data:79,user_guid:37,fail_gracefulli:[108,7],mouseov:43,present:[94,29],opac:53,request_head:[106,29],replic:103,multi:[94,134,29,115,6,129,130,103,124],cypher:109,"14t16":91,plain:[13,69,29,97,33,79,109,115,25,139],align:[53,130],some_photo:112,harder:142,log_file_permiss:29,harden:[105,29],defin:[55,76,105,29],filename_secur:29,suport:91,encrypted_str:109,hex2bin:[25,79,29],decept:6,wild:29,get_compiled_delet:[149,29],sess_time_to_upd:[103,123],"8bit":25,mydogspot:40,layer:[25,139,70,21,29],purchas:130,customiz:[62,94],cell:29,almost:[103,11,79,150],field_data:[47,87,55,34,29],site:29,langfil:137,some_class:[80,110],ruri_str:[150,29],svg11:6,bigint:[103,145],substanti:[110,77,29],lightweight:137,sting:93,incom:[96,121],unneed:29,symbolic_permiss:[114,29],test_datatyp:143,free_result:[55,34,29],uniti:29,human_to_unix:[91,29],let:[94,2,149,87,29,34,48,47,18],welcom:[98,134,110],ciper:79,parti:[80,21],cross:[69,29,31,6,139,105,106],ci_tabl:124,member:[149,87,34,127,50,106],code_end:41,data_seek:[55,29],pingomat:96,android:29,fubar:108,difficult:53,prais:8,immedi:[129,18,29],columbia:[127,77],hostnam:[29,94,148,78,30,33,87,146],equival:[125,147,13,136],keepal:29,db_select:[87,146,29],upon:[10,29,53,87,8,50,131,106],effect:[34,29],coffe:130,dai:[124,29,19,91,8],column_nam:76,retriv:106,raboof:125,having_or:29,sooner:[100,33],build:[0,94,54,96,5,53,80,33,45,34,81,65,138,98,149,97,132,140,131,84,114],set_:92,alpha_dash:50,expand:[29,22,8],andretti:142,ofb:79,orig_nam:128,set_empti:124,off:[62,0,148,12,10,29,34,82,128,92,139,141],center:[53,136],reuse_query_str:[62,29],epub:80,unl:33,colour:29,well:[137,43,125,91,49,50,131,93,11,98,6,103,105,62,143,70,23,149,29,114,33,151,84],set_cooki:[90,106,29],weblog:[96,121],exampl:[94,2,87,29,34,146,141],command:[149,146,75,29],filesystem:28,undefin:[143,29],audio:29,loss:103,sibl:38,usual:[5,79,96,43,53,33,98,108,81,147,90,148,103,50,131,112,128,106],next:[33,149,29,135,13,55,34,14,141],taller:53,display_overrid:129,newest:[130,28],camel:40,drop_databas:[76,29],half:103,obtain:[137,77],tcp:[103,66],jar:29,settabl:29,ci_xmlrpc:[96,29],some_cookie2:106,rest:[98,94,78,80,8],glue:136,new_post:96,sku:130,web:34,"50off":130,filter_validate_email:126,fopen:[114,29],idiom:137,disagre:141,multipart:[92,128,29],arandom:25,smith:[49,96],my_backup:112,myprefix_:106,add:[0,5,44,9,48,92,94,147,134,135,55,6,56,57,98,141,64,145,110,149,146,71,27,75,76,29,80,81,37,152,40],wm_vrt_align:53,error_email_miss:137,foobar:[125,142,78],display_pag:62,logger:29,suit:[53,143],warrant:101,old_table_nam:76,gmt:[97,91],exot:106,set_mim:144,xmlrpc:[125,96,29],agnost:87,vanuatu:91,http_x_cluster_client_ip:[106,29],foreign_charact:29,camelcas:125,five:[130,135,124],know:[0,79,75,76,33,98,136,22,47,139,141,109,110,49,103,106,68,70],fscommand:29,convert_xml:121,octal_permiss:[114,29],set_select:[92,50,29],height:[142,43,29,53,81,145,128,6],recurs:[11,148,29,101,25,112],get_item:[130,29],desc:149,xss:[105,29],resid:3,like:[0,1,2,3,5,125,98,7,47,49,128,92,129,48,91,74,9,50,131,93,151,94,147,12,134,53,13,55,14,148,87,101,142,57,103,132,140,105,78,62,143,130,19,115,20,65,108,22,153,145,28,109,110,25,96,112,79,71,27,136,23,149,146,29,97,33,80,34,81,150,82,37,54,121,43,122,41,106,139,84,124],lost:[103,29],safe_mailto:81,um11:91,up105:91,sessionhandlerinterfac:103,num_tag_clos:62,interfer:103,session_regenerate_id:103,unord:[6,29],necessari:[0,149,87,125,29,92,16],active_r:[71,123,29],messi:50,lose:[125,142,79],resiz:[53,43,68,81,29],get_temp_kei:103,xsl:29,path_info:3,cdr:29,exceed:[23,146,87],revers:29,"_html_entity_decode_callback":29,migration_path:[28,29],suppli:[2,87,126,45,47,128,92,50,94,53,13,140,105,106,143,19,108,145,25,111,112,148,149,29,114,33,81,141],stat:[0,29],kdb:29,daylight:91,"export":29,superclass:125,proper:[29,79,149,87,125,33,45,128,50,140],home:[136,93],use_strict:143,form_item:50,transport:96,auto_typographi:[29,46,20],week_row_start:19,trust:[94,29],lead:[125,135,150,98,29],broad:[84,26],avoid:[137,23,29,125,66,33,7,150,128,103,92,50,106],lean:[115,131],februari:29,leap:91,log_error:[137,37,45,29],default_method:0,speak:76,myfunct:129,um12:91,congratul:[103,22],liabil:77,acronym:29,journal:98,"10px":92,usag:[89,149,76,29,55,34,47],values_pars:29,facilit:29,maintain_ratio:[53,29],host:[94,87,66,29,6,103,84,146],hash_pbkdf2:[25,139,29],nutshel:[49,0],cal_cell_oth:19,although:[62,27,79,29,33,48,18,50,131,84],offset:[62,149,29,53,66,55,150,91,25],product_name_rul:130,parserequest:29,slug:[135,21,22],stage:129,rsegment_arrai:150,sbin:23,rare:[103,101,79,48],interven:97,last_citi:125,column:[87,29],prop:53,sqlsrv:[94,33,70,29],error_username_miss:137,entity_decod:[140,46,29],includ:[5,2,43,125,44,87,130,128,91,9,50,131,10,11,96,134,54,136,148,101,138,103,140,105,78,141,147,21,22,108,33,139,149,112,27,23,75,76,77,29,114,115,79,80,81,150,83,106,153,154,155],member_id:[92,96,34,87],constructor:[146,122,29],cal_row_end:19,repercuss:57,powerpoint:29,is_tru:143,creating_librari:37,set_data:[50,29],own:[0,12,29,34,48,122,25,149,141],delete_al:29,payment:149,inlin:[23,6,13,29],"_ci_autoload":29,easy_instal:80,automat:[2,141,34,29],first_tag_open:62,warranti:77,guard:[79,109,121],wm_overlay_path:53,awhil:29,col_limit:124,relicens:29,hang:8,mere:[142,141],merg:[149,77,29,108,7,141],is_brows:[93,29],beep:147,myform:[92,50],ctype_alpha:29,unix_start:91,val:[149,125,97,108,145,50,124],pictur:[6,23],myforg:76,transfer:[106,79,148,29],howland:91,support:29,db_query_build:[149,29],beer:129,language_kei:[85,137],macintosh:93,standard_d:[91,29],much:[28,29,33,108,91,25,103,131,84,106],pool:[145,29],filemtim:29,"var":[29,125,66,108,103,105],venezuelan:91,"_lang":137,application_fold:[54,132],reduc:[135,66,139,46,34],total_row:62,unexpect:103,unwrap:23,bcc_batch_mod:[23,29],brand:93,my_model:123,multical:29,"_util":0,is_natur:50,bodi:[23,149,134,29,115,13,55,136,128,126,50],gain:[100,66,79,34,109],select_min:[149,29],dbforg:[108,28,76,33,29],eas:29,highest:[23,112],eat:6,count:[87,29],group_start:149,cleanup:29,temp:115,rc4:79,wish:[137,43,125,45,7,130,129,92,11,96,134,53,54,98,18,103,106,143,19,147,108,109,149,27,148,75,76,79,81,150,41],unload:43,writeabl:114,flip:53,ci_model:[101,21,78],asynchron:140,directori:[94,87,44,29,34,18],below:[5,79,43,45,7,92,128,129,91,9,50,12,134,53,13,55,103,130,19,147,21,108,145,110,96,111,146,27,23,149,76,29,78,80,34,83,139,155,124],item_valu:7,limit:[111,2,29],tini:6,fetch:[142,149,134,29,66,33,55,47,25],view_cascad:108,otherwis:[137,0,79,126,92,90,130,53,98,14,103,105,106,108,139,25,113,23,75,77,29,33,41,141],problem:[147,29,33,45,138,103,50,141],weblogupd:96,reliabl:[147,29,30,33,81,103,93],evalu:[125,143,29],timespan:[91,29],"int":[87,45,90,91,130,11,96,135,97,55,148,6,103,140,105,106,19,66,21,145,28,109,25,147,23,149,76,114,79,80,150,152,121,41,124],dure:[137,27,78,29,139,83,129,103,25,50],filenam:[137,27,28,69,144,29,53,140,33,125,128,7,114,37,23,129,110,9,75,112],novemb:29,implement:[137,79,12,149,29,33,103,87,25,121,9,50],some_nam:103,userag:23,path_cach:125,mistaken:125,ing:29,up1275:91,httponli:[103,90,106],inc:127,spell:29,my_:[9,27,37,66,110],last_tag_open:62,percent:[139,91],front_control:71,virtual:103,plular:40,other:[5,79,3,87,125,45,47,9,90,92,129,91,49,10,12,134,135,54,14,6,139,105,123,130,19,109,146,71,27,149,29,33,80,128,81,141],bool:[137,43,1,97,87,126,45,7,130,90,91,92,50,93,11,69,53,135,13,55,6,103,140,105,106,142,143,144,107,66,40,108,149,148,25,96,112,23,75,76,114,115,80,46,81,121,128,124],bin2hex:79,rememb:[134,30,33,34,48,108,49,50],unix_to_human:91,php4:0,php5:107,php7:29,myphoto:112,key_prefix:[66,29],repeat:[135,6,29],misc_model:33,my_db:76,repeat_password:92,oci_fetch:29,june:[19,29],ci_email:[9,23],"_parse_argv":29,news_model:[21,22],theother:135,is_ascii:29,sess_save_path:[103,33,29],mondai:[19,124],has_opt:130,throughout:[29,27,78,44,79,45,137,133,140,146],trackback:[51,116,29],clean_email:29,malsup:43,basketbal:50,stai:[130,142],experienc:[53,103,125,79],thead_clos:124,sphinx:80,amp:1,strpo:125,came:139,baker:91,root_path:112,extran:29,bcc:[23,29],form_radio:[92,29],"_protect_identifi":29,portion:[25,149,45,77],emerg:141,ci_uri:[150,29]},objtypes:{"0":"php:method","1":"php:function","2":"php:class"},objnames:{"0":["php","method","PHP method"],"1":["php","function","PHP function"],"2":["php","class","PHP class"]},filenames:["general/controllers","helpers/xml_helper","database/call_function","installation/upgrade_b11","installation/upgrading","general/urls","helpers/html_helper","libraries/config","tutorial/conclusion","general/creating_libraries","DCO","helpers/directory_helper","database/transactions","helpers/smiley_helper","general/environments","installation/upgrade_163","installation/upgrade_162","installation/upgrade_161","general/caching","libraries/calendar","libraries/typography","tutorial/news_section","tutorial/create_news_items","libraries/email","general/index","general/compatibility_functions","overview/index","general/helpers","libraries/migration","changelog","installation/upgrade_303","installation/upgrade_302","installation/upgrade_301","installation/upgrade_300","database/caching","installation/upgrade_152","installation/upgrade_153","installation/upgrade_150","general/drivers","installation/upgrade_154","helpers/inflector_helper","libraries/benchmark","installation/downloads","libraries/javascript","general/autoloader","general/errors","helpers/typography_helper","database/metadata","database/queries","general/cli","libraries/form_validation","index","overview/goals","libraries/image_lib","installation/index","database/results","installation/upgrade_141","installation/upgrade_140","installation/upgrade_220","installation/upgrade_221","installation/upgrade_222","installation/upgrade_223","libraries/pagination","tutorial/index","installation/troubleshooting","overview/mvc","libraries/caching","installation/upgrade_212","overview/features","helpers/security_helper","general/requirements","installation/upgrade_130","installation/upgrade_131","installation/upgrade_132","installation/upgrade_133","database/utilities","database/forge","license","general/models","libraries/encryption","documentation/index","helpers/url_helper","database/helpers","general/profiling","general/welcome","helpers/language_helper","general/creating_drivers","database/db_driver_reference","helpers/index","database/index","helpers/cookie_helper","helpers/date_helper","helpers/form_helper","libraries/user_agent","database/configuration","installation/upgrade_120","libraries/xmlrpc","libraries/output","general/routing","installation/upgrade_202","installation/upgrade_203","installation/upgrade_200","installation/upgrade_201","libraries/sessions","general/libraries","general/common_functions","libraries/input","helpers/path_helper","libraries/loader","libraries/encrypt","general/core_classes","database/examples","libraries/zip","general/reserved_names","helpers/file_helper","libraries/parser","libraries/index","installation/upgrade_214","installation/upgrade_211","installation/upgrade_210","installation/upgrade_213","libraries/trackback","general/ancillary_classes","installation/upgrade_160","libraries/table","general/styleguide","helpers/email_helper","general/credits","libraries/file_uploading","general/hooks","libraries/cart","overview/at_a_glance","general/managing_apps","overview/appflow","general/views","helpers/string_helper","tutorial/static_pages","libraries/language","overview/getting_started","general/security","libraries/security","contributing/index","helpers/array_helper","libraries/unit_testing","helpers/download_helper","helpers/captcha_helper","database/connecting","helpers/text_helper","libraries/ftp","database/query_builder","libraries/uri","general/alternative_php","helpers/number_helper","installation/upgrade_170","installation/upgrade_171","installation/upgrade_172"],titles:["Controllers","XML Helper","Custom Function Calls","Upgrading From Beta 1.0 to Beta 1.1","Upgrading From a Previous Version","CodeIgniter URLs","HTML Helper","Config Class","Conclusion","Creating Libraries","Developer’s Certificate of Origin 1.1","Directory Helper","Transactions","Smiley Helper","Handling Multiple Environments","Upgrading from 1.6.2 to 1.6.3","Upgrading from 1.6.1 to 1.6.2","Upgrading from 1.6.0 to 1.6.1","Web Page Caching","Calendaring Class","Typography Class","News section","Create news items","Email Class","General Topics","Compatibility Functions","CodeIgniter Overview","Helper Functions","Migrations Class","Change Log","Upgrading from 3.0.2 to 3.0.3","Upgrading from 3.0.1 to 3.0.2","Upgrading from 3.0.0 to 3.0.1","Upgrading from 2.2.x to 3.0.x","Database Caching Class","Upgrading from 1.5.0 to 1.5.2","Upgrading from 1.5.2 to 1.5.3","Upgrading from 1.4.1 to 1.5.0","Using CodeIgniter Drivers","Upgrading from 1.5.3 to 1.5.4","Inflector Helper","Benchmarking Class","Downloading CodeIgniter","Javascript Class","Auto-loading Resources","Error Handling","Typography Helper","Database Metadata","Queries","Running via the CLI","Form Validation","CodeIgniter User Guide","Design and Architectural Goals","Image Manipulation Class","Installation Instructions","Generating Query Results","Upgrading from 1.4.0 to 1.4.1","Upgrading from 1.3.3 to 1.4.0","Upgrading from 2.1.4 to 2.2.x","Upgrading from 2.2.0 to 2.2.1","Upgrading from 2.2.1 to 2.2.2","Upgrading from 2.2.2 to 2.2.3","Pagination Class","Tutorial","Troubleshooting","Model-View-Controller","Caching Driver","Upgrading from 2.1.1 to 2.1.2","CodeIgniter Features","Security Helper","Server Requirements","Upgrading from 1.2 to 1.3","Upgrading from 1.3 to 1.3.1","Upgrading from 1.3.1 to 1.3.2","Upgrading from 1.3.2 to 1.3.3","Database Utility Class","Database Forge Class","The MIT License (MIT)","Models","Encryption Library","Writing CodeIgniter Documentation","URL Helper","Query Helper Methods","Profiling Your Application","Welcome to CodeIgniter","Language Helper","Creating Drivers","DB Driver Reference","Helpers","Database Reference","Cookie Helper","Date Helper","Form Helper","User Agent Class","Database Configuration","Upgrading From Beta 1.0 to Final 1.2","XML-RPC and XML-RPC Server Classes","Output Class","URI Routing","Upgrading from 2.0.1 to 2.0.2","Upgrading from 2.0.2 to 2.0.3","Upgrading from 1.7.2 to 2.0.0","Upgrading from 2.0.0 to 2.0.1","Session Library","Using CodeIgniter Libraries","Common Functions","Input Class","Path Helper","Loader Class","Encrypt Class","Creating Core System Classes","Database Quick Start: Example Code","Zip Encoding Class","Reserved Names","File Helper","Template Parser Class","Libraries","Upgrading from 2.1.3 to 2.1.4","Upgrading from 2.1.0 to 2.1.1","Upgrading from 2.0.3 to 2.1.0","Upgrading from 2.1.2 to 2.1.3","Trackback Class","Creating Ancillary Classes","Upgrading from 1.5.4 to 1.6.0","HTML Table Class","PHP Style Guide","Email Helper","Credits","File Uploading Class","Hooks - Extending the Framework Core","Shopping Cart Class","CodeIgniter at a Glance","Managing your Applications","Application Flow Chart","Views","String Helper","Static pages","Language Class","Getting Started With CodeIgniter","Security","Security Class","Contributing to CodeIgniter","Array Helper","Unit Testing Class","Download Helper","CAPTCHA Helper","Connecting to your Database","Text Helper","FTP Class","Query Builder Class","URI Class","Alternate PHP Syntax for View Files","Number Helper","Upgrading from 1.6.3 to 1.7.0","Upgrading from 1.7.0 to 1.7.1","Upgrading from 1.7.1 to 1.7.2"],objects:{"":{"CI_DB_driver::platform":[87,0,1,""],"CI_DB_forge::add_field":[76,0,1,""],mysql_to_unix:[91,1,1,""],"CI_DB_query_builder::or_where_in":[149,0,1,""],"CI_Input::get_request_header":[106,0,1,""],"CI_Calendar::get_total_days":[19,0,1,""],"CI_URI::segment":[150,0,1,""],"CI_FTP::delete_dir":[148,0,1,""],auto_link:[81,1,1,""],form_textarea:[92,1,1,""],"CI_Session::keep_flashdata":[103,0,1,""],"CI_DB_utility::repair_table":[75,0,1,""],"CI_DB_driver::update_string":[87,0,1,""],get_file_info:[114,1,1,""],base_url:[81,1,1,""],site_url:[81,1,1,""],"CI_DB_forge::add_column":[76,0,1,""],"CI_Output::set_output":[97,0,1,""],CI_Security:[140,2,1,""],"CI_DB_result::last_row":[55,0,1,""],form_prep:[92,1,1,""],"CI_DB_query_builder::not_like":[149,0,1,""],"CI_DB_driver::cache_delete_all":[87,0,1,""],"CI_Encrypt::encode":[109,0,1,""],date_range:[91,1,1,""],underscore:[40,1,1,""],"CI_DB_query_builder::get_compiled_delete":[149,0,1,""],"CI_DB_driver::simple_query":[87,0,1,""],force_download:[144,1,1,""],"CI_Calendar::get_day_names":[19,0,1,""],"CI_Cache::is_supported":[66,0,1,""],byte_format:[152,1,1,""],"CI_Migration::latest":[28,0,1,""],"CI_DB_driver::trans_complete":[87,0,1,""],"CI_DB_driver::reconnect":[87,0,1,""],"CI_DB_utility::database_exists":[75,0,1,""],heading:[6,1,1,""],"CI_FTP::mirror":[148,0,1,""],CI_DB_query_builder:[149,2,1,""],CI_Loader:[108,2,1,""],nbs:[6,1,1,""],doctype:[6,1,1,""],word_limiter:[147,1,1,""],write_file:[114,1,1,""],"CI_DB_driver::db_select":[87,0,1,""],"CI_Unit_test::set_test_items":[143,0,1,""],sanitize_filename:[69,1,1,""],"CI_Image_lib::rotate":[53,0,1,""],standard_date:[91,1,1,""],mdate:[91,1,1,""],"CI_Calendar::get_month_name":[19,0,1,""],"CI_DB_query_builder::limit":[149,0,1,""],"CI_Input::server":[106,0,1,""],"CI_Output::_display":[97,0,1,""],"CI_DB_query_builder::where":[149,0,1,""],xss_clean:[69,1,1,""],"CI_Input::get_post":[106,0,1,""],"CI_DB_forge::drop_database":[76,0,1,""],"CI_Form_validation::error_string":[50,0,1,""],"CI_DB_driver::trans_strict":[87,0,1,""],"CI_Trackback::send":[121,0,1,""],camelize:[40,1,1,""],form_button:[92,1,1,""],"CI_User_agent::version":[93,0,1,""],"CI_URI::uri_string":[150,0,1,""],directory_map:[11,1,1,""],strip_image_tags:[69,1,1,""],"CI_Upload::do_upload":[128,0,1,""],gmt_to_local:[91,1,1,""],"CI_DB_query_builder::get":[149,0,1,""],"CI_DB_driver::list_tables":[87,0,1,""],current_url:[81,1,1,""],"CI_Lang::line":[137,0,1,""],mb_substr:[25,1,1,""],"CI_Input::input_stream":[106,0,1,""],"CI_Cart::contents":[130,0,1,""],"CI_Xmlrpc::send_error_message":[96,0,1,""],"CI_DB_result::first_row":[55,0,1,""],"CI_DB_query_builder::or_where":[149,0,1,""],"CI_DB_query_builder::having":[149,0,1,""],"CI_Config::slash_item":[7,0,1,""],"CI_Table::clear":[124,0,1,""],"CI_DB_driver::trans_start":[87,0,1,""],"CI_Cart::remove":[130,0,1,""],"CI_Upload::data":[128,0,1,""],CI_Benchmark:[41,2,1,""],"CI_Output::cache":[97,0,1,""],"CI_Zip::get_zip":[112,0,1,""],CI_DB_driver:[87,2,1,""],Some_class:[80,2,1,""],form_reset:[92,1,1,""],"CI_DB_query_builder::select_min":[149,0,1,""],"CI_FTP::rename":[148,0,1,""],"CI_Trackback::receive":[121,0,1,""],"CI_Loader::helper":[108,0,1,""],form_fieldset_close:[92,1,1,""],"CI_DB_result::free_result":[55,0,1,""],"CI_DB_utility::backup":[75,0,1,""],"CI_DB_result::unbuffered_row":[55,0,1,""],"CI_Session::set_userdata":[103,0,1,""],"CI_Trackback::convert_ascii":[121,0,1,""],"CI_Security::xss_clean":[140,0,1,""],set_select:[92,1,1,""],quotes_to_entities:[135,1,1,""],form_open:[92,1,1,""],"CI_URI::slash_segment":[150,0,1,""],"Some_class::should_do_something":[80,0,1,""],"CI_FTP::connect":[148,0,1,""],"CI_Loader::view":[108,0,1,""],"CI_Image_lib::display_errors":[53,0,1,""],"CI_DB_driver::trans_status":[87,0,1,""],"CI_Encryption::encrypt":[79,0,1,""],"CI_DB_query_builder::or_not_group_start":[149,0,1,""],"CI_Migration::version":[28,0,1,""],CI_DB_result:[55,2,1,""],"CI_DB_query_builder::replace":[149,0,1,""],"CI_DB_driver::cache_delete":[87,0,1,""],"CI_Trackback::extract_urls":[121,0,1,""],"CI_Form_validation::set_message":[50,0,1,""],array_column:[25,1,1,""],url_title:[81,1,1,""],get_instance:[122,1,1,""],CI_Lang:[137,2,1,""],trim_slashes:[135,1,1,""],xml_convert:[1,1,1,""],"CI_DB_query_builder::or_having":[149,0,1,""],"CI_DB_query_builder::from":[149,0,1,""],show_error:[45,1,1,""],"CI_DB_query_builder::offset":[149,0,1,""],singular:[40,1,1,""],"CI_DB_result::field_data":[55,0,1,""],show_404:[45,1,1,""],array_replace_recursive:[25,1,1,""],random_element:[142,1,1,""],"CI_Security::sanitize_filename":[140,0,1,""],form_checkbox:[92,1,1,""],"CI_Trackback::validate_url":[121,0,1,""],"CI_User_agent::is_robot":[93,0,1,""],"CI_Email::message":[23,0,1,""],"CI_FTP::close":[148,0,1,""],create_captcha:[145,1,1,""],"CI_Config::item":[7,0,1,""],"CI_DB_driver::db_pconnect":[87,0,1,""],"CI_Cart::destroy":[130,0,1,""],"CI_Input::user_agent":[106,0,1,""],element:[142,1,1,""],"CI_Encryption::create_key":[79,0,1,""],days_in_month:[91,1,1,""],"CI_Session::unset_userdata":[103,0,1,""],"CI_Encrypt::set_mode":[109,0,1,""],"CI_DB_utility::csv_from_result":[75,0,1,""],"CI_Cache::decrement":[66,0,1,""],"CI_DB_query_builder::get_compiled_update":[149,0,1,""],"CI_Form_validation::error":[50,0,1,""],form_submit:[92,1,1,""],"CI_DB_driver::count_all":[87,0,1,""],"CI_DB_result::num_rows":[55,0,1,""],"CI_DB_driver::field_exists":[87,0,1,""],"CI_Trackback::limit_characters":[121,0,1,""],CI_Output:[97,2,1,""],password_hash:[25,1,1,""],CI_Encrypt:[109,2,1,""],"CI_Table::set_caption":[124,0,1,""],CI_Image_lib:[53,2,1,""],config_item:[105,1,1,""],"CI_Migration::find_migrations":[28,0,1,""],get_clickable_smileys:[13,1,1,""],form_password:[92,1,1,""],"CI_DB_query_builder::truncate":[149,0,1,""],"CI_Email::from":[23,0,1,""],"CI_FTP::delete_file":[148,0,1,""],ellipsize:[147,1,1,""],CI_Config:[7,2,1,""],"CI_Typography::nl2br_except_pre":[20,0,1,""],"CI_Zip::clear_data":[112,0,1,""],timezone_menu:[91,1,1,""],now:[91,1,1,""],"CI_DB_query_builder::count_all_results":[149,0,1,""],set_value:[92,1,1,""],strip_slashes:[135,1,1,""],"CI_DB_query_builder::or_where_not_in":[149,0,1,""],"CI_User_agent::accept_lang":[93,0,1,""],"CI_DB_query_builder::where_not_in":[149,0,1,""],highlight_phrase:[147,1,1,""],CI_Encryption:[79,2,1,""],"CI_Input::ip_address":[106,0,1,""],smiley_js:[13,1,1,""],"CI_URI::slash_rsegment":[150,0,1,""],"CI_DB_driver::db_set_charset":[87,0,1,""],"CI_Encrypt::set_cipher":[109,0,1,""],"CI_DB_driver::version":[87,0,1,""],"CI_Xmlrpc::timeout":[96,0,1,""],is_really_writable:[105,1,1,""],"CI_DB_driver::elapsed_time":[87,0,1,""],set_realpath:[107,1,1,""],"CI_Benchmark::elapsed_time":[41,0,1,""],nice_date:[91,1,1,""],"CI_DB_query_builder::update":[149,0,1,""],"CI_URI::segment_array":[150,0,1,""],CI_Cache:[66,2,1,""],"CI_DB_query_builder::reset_query":[149,0,1,""],"CI_Session::umark_flash":[103,0,1,""],"CI_DB_query_builder::not_group_start":[149,0,1,""],plural:[40,1,1,""],remove_invisible_characters:[105,1,1,""],"CI_Calendar::adjust_date":[19,0,1,""],"CI_DB_driver::call_function":[87,0,1,""],hash_equals:[25,1,1,""],CI_Pagination:[62,2,1,""],is_countable:[40,1,1,""],"CI_DB_result::list_fields":[55,0,1,""],"CI_Input::post_get":[106,0,1,""],"CI_Security::get_csrf_hash":[140,0,1,""],"CI_Table::set_template":[124,0,1,""],"CI_Image_lib::resize":[53,0,1,""],"CI_Config::load":[7,0,1,""],"CI_DB_driver::table_exists":[87,0,1,""],link_tag:[6,1,1,""],"CI_User_agent::mobile":[93,0,1,""],"CI_DB_query_builder::start_cache":[149,0,1,""],"CI_Email::bcc":[23,0,1,""],"CI_DB_driver::list_fields":[87,0,1,""],"CI_Encrypt::encode_from_legacy":[109,0,1,""],"CI_DB_driver::db_connect":[87,0,1,""],"CI_DB_query_builder::insert":[149,0,1,""],increment_string:[135,1,1,""],"CI_Email::reply_to":[23,0,1,""],"CI_Cache::cache_info":[66,0,1,""],"CI_DB_query_builder::select":[149,0,1,""],"CI_DB_query_builder::flush_cache":[149,0,1,""],"CI_Cart::product_options":[130,0,1,""],"CI_Loader::database":[108,0,1,""],"CI_Benchmark::memory_usage":[41,0,1,""],prep_url:[81,1,1,""],"CI_URI::uri_to_assoc":[150,0,1,""],encode_php_tags:[69,1,1,""],"CI_DB_query_builder::empty_table":[149,0,1,""],"CI_DB_query_builder::get_where":[149,0,1,""],"CI_Calendar::initialize":[19,0,1,""],"CI_DB_query_builder::group_end":[149,0,1,""],"CI_Parser::set_delimiters":[115,0,1,""],"CI_DB_query_builder::select_sum":[149,0,1,""],"CI_DB_forge::add_key":[76,0,1,""],"CI_Config::site_url":[7,0,1,""],"CI_Form_validation::has_rule":[50,0,1,""],"CI_URI::total_segments":[150,0,1,""],"CI_Email::attach":[23,0,1,""],"CI_Session::__set":[103,0,1,""],"CI_DB_forge::drop_column":[76,0,1,""],"CI_DB_utility::list_databases":[75,0,1,""],reduce_double_slashes:[135,1,1,""],"CI_Loader::dbforge":[108,0,1,""],"CI_Table::add_row":[124,0,1,""],"CI_Upload::initialize":[128,0,1,""],valid_email:[126,1,1,""],"CI_DB_result::next_row":[55,0,1,""],CI_Unit_test:[143,2,1,""],"CI_Cache::increment":[66,0,1,""],"CI_Session::sess_regenerate":[103,0,1,""],index_page:[81,1,1,""],delete_files:[114,1,1,""],is_php:[105,1,1,""],"CI_Email::set_alt_message":[23,0,1,""],"CI_Output::append_output":[97,0,1,""],"CI_Encryption::decrypt":[79,0,1,""],"CI_Table::set_heading":[124,0,1,""],humanize:[40,1,1,""],"CI_Session::__get":[103,0,1,""],anchor_popup:[81,1,1,""],"CI_DB_query_builder::get_compiled_select":[149,0,1,""],"CI_DB_result::data_seek":[55,0,1,""],"CI_Session::sess_destroy":[103,0,1,""],"CI_Trackback::data":[121,0,1,""],"CI_DB_utility::xml_from_result":[75,0,1,""],"CI_Session::flashdata":[103,0,1,""],"CI_DB_driver::cache_off":[87,0,1,""],"CI_Loader::model":[108,0,1,""],"CI_Unit_test::active":[143,0,1,""],"CI_Session::has_userdata":[103,0,1,""],"CI_Cache::save":[66,0,1,""],"CI_Xmlrpc::server":[96,0,1,""],"CI_DB_query_builder::set_update_batch":[149,0,1,""],"CI_Session::userdata":[103,0,1,""],CI_Email:[23,2,1,""],"CI_Session::umark_temp":[103,0,1,""],set_status_header:[105,1,1,""],convert_accented_characters:[147,1,1,""],CI_Cart:[130,2,1,""],alternator:[135,1,1,""],"CI_Session::set_tempdata":[103,0,1,""],"CI_Unit_test::run":[143,0,1,""],"CI_Migration::current":[28,0,1,""],"CI_Loader::config":[108,0,1,""],"CI_Output::set_status_header":[97,0,1,""],CI_Zip:[112,2,1,""],"CI_Loader::driver":[108,0,1,""],nl2br_except_pre:[46,1,1,""],random_string:[135,1,1,""],"CI_Cart::total_items":[130,0,1,""],CI_FTP:[148,2,1,""],"CI_Unit_test::report":[143,0,1,""],"CI_Cart::total":[130,0,1,""],redirect:[81,1,1,""],strip_quotes:[135,1,1,""],"CI_Email::print_debugger":[23,0,1,""],"CI_User_agent::is_mobile":[93,0,1,""],mb_strpos:[25,1,1,""],"CI_Security::get_random_bytes":[140,0,1,""],CI_Parser:[115,2,1,""],"CI_DB_result::set_row":[55,0,1,""],"CI_DB_query_builder::stop_cache":[149,0,1,""],"CI_DB_driver::last_query":[87,0,1,""],ascii_to_entities:[147,1,1,""],CI_DB_forge:[76,2,1,""],"CI_Xmlrpc::display_error":[96,0,1,""],"CI_User_agent::agent_string":[93,0,1,""],octal_permissions:[114,1,1,""],"CI_DB_forge::modify_column":[76,0,1,""],form_error:[92,1,1,""],"CI_DB_query_builder::update_batch":[149,0,1,""],"CI_Calendar::parse_template":[19,0,1,""],form_multiselect:[92,1,1,""],"CI_User_agent::charsets":[93,0,1,""],"CI_DB_result::result_object":[55,0,1,""],highlight_code:[147,1,1,""],"CI_Email::cc":[23,0,1,""],"CI_Cart::has_options":[130,0,1,""],"CI_Session::set_flashdata":[103,0,1,""],"CI_Input::post":[106,0,1,""],local_to_gmt:[91,1,1,""],"CI_Image_lib::watermark":[53,0,1,""],"CI_Session::get_flash_keys":[103,0,1,""],"CI_Form_validation::error_array":[50,0,1,""],"CI_Xmlrpc::display_response":[96,0,1,""],timezones:[91,1,1,""],"CI_User_agent::is_referral":[93,0,1,""],password_get_info:[25,1,1,""],"CI_DB_driver::primary":[87,0,1,""],send_email:[126,1,1,""],"CI_DB_driver::close":[87,0,1,""],"CI_Form_validation::reset_validation":[50,0,1,""],validation_errors:[92,1,1,""],"CI_Table::make_columns":[124,0,1,""],"CI_Loader::get_vars":[108,0,1,""],"CI_DB_query_builder::delete":[149,0,1,""],form_close:[92,1,1,""],"CI_DB_driver::initialize":[87,0,1,""],"CI_URI::ruri_string":[150,0,1,""],"CI_Xmlrpc::send_request":[96,0,1,""],"CI_Loader::add_package_path":[108,0,1,""],"CI_DB_query_builder::set_insert_batch":[149,0,1,""],"CI_Session::mark_as_temp":[103,0,1,""],"CI_Calendar::default_template":[19,0,1,""],"CI_Xmlrpc::request":[96,0,1,""],"CI_Form_validation::set_rules":[50,0,1,""],"CI_URI::total_rsegments":[150,0,1,""],"CI_Encryption::hkdf":[79,0,1,""],"CI_Output::enable_profiler":[97,0,1,""],"CI_Cache::delete":[66,0,1,""],"CI_DB_query_builder::or_like":[149,0,1,""],"CI_DB_result::row":[55,0,1,""],"CI_Cart::get_item":[130,0,1,""],"CI_Config::base_url":[7,0,1,""],"CI_Encryption::initialize":[79,0,1,""],img:[6,1,1,""],CI_Trackback:[121,2,1,""],"CI_User_agent::browser":[93,0,1,""],CI_Session:[103,2,1,""],"CI_DB_result::custom_result_object":[55,0,1,""],set_radio:[92,1,1,""],"CI_Security::get_csrf_token_name":[140,0,1,""],"CI_DB_forge::create_table":[76,0,1,""],"CI_DB_utility::optimize_database":[75,0,1,""],"CI_Cart::update":[130,0,1,""],"CI_Lang::load":[137,0,1,""],"CI_Loader::vars":[108,0,1,""],"CI_DB_forge::drop_table":[76,0,1,""],"CI_Table::set_empty":[124,0,1,""],"CI_Migration::error_string":[28,0,1,""],mailto:[81,1,1,""],hash_pbkdf2:[25,1,1,""],"CI_DB_query_builder::set_dbprefix":[149,0,1,""],reduce_multiples:[135,1,1,""],"CI_Form_validation::set_error_delimiters":[50,0,1,""],"CI_Email::subject":[23,0,1,""],"CI_FTP::upload":[148,0,1,""],"CI_Output::set_profiler_sections":[97,0,1,""],"CI_Zip::add_dir":[112,0,1,""],get_filenames:[114,1,1,""],"CI_Typography::format_characters":[20,0,1,""],unix_to_human:[91,1,1,""],array_replace:[25,1,1,""],"CI_DB_query_builder::like":[149,0,1,""],CI_Form_validation:[50,2,1,""],"CI_DB_query_builder::distinct":[149,0,1,""],"CI_Unit_test::use_strict":[143,0,1,""],CI_Upload:[128,2,1,""],"CI_DB_driver::trans_off":[87,0,1,""],form_upload:[92,1,1,""],hex2bin:[25,1,1,""],CI_Calendar:[19,2,1,""],parse_smileys:[13,1,1,""],"CI_DB_query_builder::select_avg":[149,0,1,""],anchor:[81,1,1,""],uri_string:[81,1,1,""],"CI_Form_validation::run":[50,0,1,""],"CI_DB_driver::cache_on":[87,0,1,""],"CI_Output::get_output":[97,0,1,""],"CI_DB_driver::escape_str":[87,0,1,""],"CI_DB_query_builder::or_group_start":[149,0,1,""],human_to_unix:[91,1,1,""],"CI_Output::set_header":[97,0,1,""],"CI_Input::request_headers":[106,0,1,""],"CI_Loader::file":[108,0,1,""],word_censor:[147,1,1,""],"CI_DB_driver::escape_identifiers":[87,0,1,""],CI_Xmlrpc:[96,2,1,""],form_fieldset:[92,1,1,""],"CI_Email::set_header":[23,0,1,""],"CI_Cart::insert":[130,0,1,""],"CI_Loader::remove_package_path":[108,0,1,""],"CI_Security::entity_decode":[140,0,1,""],"CI_Session::get_temp_keys":[103,0,1,""],"CI_DB_driver::escape":[87,0,1,""],"CI_FTP::move":[148,0,1,""],form_label:[92,1,1,""],"CI_DB_driver::protect_identifiers":[87,0,1,""],"CI_Cache::get":[66,0,1,""],"CI_DB_result::previous_row":[55,0,1,""],"CI_DB_query_builder::group_start":[149,0,1,""],"CI_Zip::download":[112,0,1,""],"CI_Config::system_url":[7,0,1,""],"CI_Loader::get_var":[108,0,1,""],"CI_User_agent::parse":[93,0,1,""],"CI_Encrypt::decode":[109,0,1,""],"CI_Cache::clean":[66,0,1,""],html_escape:[105,1,1,""],symbolic_permissions:[114,1,1,""],form_hidden:[92,1,1,""],log_message:[45,1,1,""],"CI_DB_driver::cache_set_path":[87,0,1,""],"CI_Unit_test::set_template":[143,0,1,""],"CI_DB_driver::field_data":[87,0,1,""],"CI_URI::rsegment":[150,0,1,""],"CI_Loader::language":[108,0,1,""],get_dir_file_info:[114,1,1,""],set_checkbox:[92,1,1,""],"CI_Input::cookie":[106,0,1,""],"CI_Cache::get_metadata":[66,0,1,""],"CI_URI::assoc_to_uri":[150,0,1,""],"CI_Benchmark::mark":[41,0,1,""],"CI_FTP::changedir":[148,0,1,""],"CI_Parser::parse":[115,0,1,""],"CI_Output::get_content_type":[97,0,1,""],entity_decode:[46,1,1,""],"CI_FTP::chmod":[148,0,1,""],do_hash:[69,1,1,""],password_verify:[25,1,1,""],safe_mailto:[81,1,1,""],"Some_class::some_method":[80,0,1,""],"CI_Image_lib::clear":[53,0,1,""],character_limiter:[147,1,1,""],"CI_DB_result::result":[55,0,1,""],"CI_DB_query_builder::or_not_like":[149,0,1,""],"CI_FTP::download":[148,0,1,""],"CI_Zip::read_file":[112,0,1,""],"CI_Unit_test::result":[143,0,1,""],"CI_Zip::archive":[112,0,1,""],"CI_DB_driver::is_write_type":[87,0,1,""],"CI_Calendar::generate":[19,0,1,""],"CI_Form_validation::set_data":[50,0,1,""],read_file:[114,1,1,""],word_wrap:[147,1,1,""],"CI_DB_driver::compile_binds":[87,0,1,""],password_needs_rehash:[25,1,1,""],"CI_DB_result::row_object":[55,0,1,""],"CI_Xmlrpc::initialize":[96,0,1,""],"CI_Upload::display_errors":[128,0,1,""],auto_typography:[46,1,1,""],CI_Table:[124,2,1,""],CI_Input:[106,2,1,""],"CI_Trackback::set_error":[121,0,1,""],"CI_Image_lib::initialize":[53,0,1,""],"CI_DB_forge::rename_table":[76,0,1,""],"CI_DB_result::custom_row_object":[55,0,1,""],CI_URI:[150,2,1,""],form_dropdown:[92,1,1,""],br:[6,1,1,""],"CI_DB_utility::optimize_table":[75,0,1,""],"CI_Input::valid_ip":[106,0,1,""],"CI_URI::ruri_to_assoc":[150,0,1,""],"CI_DB_query_builder::where_in":[149,0,1,""],ol:[6,1,1,""],"CI_Output::set_content_type":[97,0,1,""],"CI_User_agent::referrer":[93,0,1,""],"CI_Input::is_ajax_request":[106,0,1,""],quoted_printable_encode:[25,1,1,""],"CI_DB_driver::insert_string":[87,0,1,""],"CI_DB_query_builder::set":[149,0,1,""],"CI_Email::attachment_cid":[23,0,1,""],"CI_DB_driver::display_error":[87,0,1,""],"CI_DB_query_builder::order_by":[149,0,1,""],"CI_Input::method":[106,0,1,""],"CI_Xmlrpc::method":[96,0,1,""],"CI_Input::is_cli_request":[106,0,1,""],"CI_DB_result::row_array":[55,0,1,""],CI_User_agent:[93,2,1,""],"CI_Session::all_userdata":[103,0,1,""],"CI_Session::tempdata":[103,0,1,""],"CI_DB_query_builder::insert_batch":[149,0,1,""],"CI_Trackback::convert_xml":[121,0,1,""],"CI_Pagination::initialize":[62,0,1,""],"CI_Zip::read_dir":[112,0,1,""],"CI_DB_driver::escape_like_str":[87,0,1,""],"CI_Zip::add_data":[112,0,1,""],"CI_Email::send":[23,0,1,""],"CI_Loader::is_loaded":[108,0,1,""],repeater:[135,1,1,""],is_cli:[105,1,1,""],"CI_DB_query_builder::select_max":[149,0,1,""],"CI_Output::get_header":[97,0,1,""],get_mime_by_extension:[114,1,1,""],"CI_Trackback::get_id":[121,0,1,""],mb_strlen:[25,1,1,""],"CI_User_agent::accept_charset":[93,0,1,""],"CI_DB_query_builder::get_compiled_insert":[149,0,1,""],"CI_Email::clear":[23,0,1,""],"CI_DB_query_builder::group_by":[149,0,1,""],"CI_FTP::mkdir":[148,0,1,""],is_https:[105,1,1,""],ul:[6,1,1,""],"CI_Input::get":[106,0,1,""],meta:[6,1,1,""],"CI_DB_forge::create_database":[76,0,1,""],"CI_User_agent::robot":[93,0,1,""],get_mimes:[105,1,1,""],"CI_Pagination::create_links":[62,0,1,""],"CI_URI::rsegment_array":[150,0,1,""],timespan:[91,1,1,""],"CI_Loader::dbutil":[108,0,1,""],"CI_DB_driver::total_queries":[87,0,1,""],"CI_DB_query_builder::dbprefix":[149,0,1,""],"CI_Email::to":[23,0,1,""],"CI_Trackback::display_errors":[121,0,1,""],"CI_DB_result::num_fields":[55,0,1,""],"CI_Loader::get_package_paths":[108,0,1,""],"CI_Table::generate":[124,0,1,""],"CI_Config::set_item":[7,0,1,""],"CI_User_agent::platform":[93,0,1,""],"CI_DB_result::result_array":[55,0,1,""],"CI_Loader::library":[108,0,1,""],elements:[142,1,1,""],"CI_User_agent::languages":[93,0,1,""],"CI_Input::set_cookie":[106,0,1,""],CI_Typography:[20,2,1,""],"CI_Image_lib::crop":[53,0,1,""],function_usable:[105,1,1,""],lang:[85,1,1,""],"CI_Trackback::process":[121,0,1,""],"CI_Session::mark_as_flash":[103,0,1,""],"CI_Loader::clear_vars":[108,0,1,""],CI_DB_utility:[75,2,1,""],"CI_DB_query_builder::join":[149,0,1,""],CI_Migration:[28,2,1,""],form_radio:[92,1,1,""],"CI_FTP::list_files":[148,0,1,""],"CI_User_agent::is_browser":[93,0,1,""],"CI_Trackback::send_success":[121,0,1,""],"CI_Parser::parse_string":[115,0,1,""]}},titleterms:{all:[139,34],code:[125,111],chain:149,queri:[5,94,75,125,55,48,82,149,111],month:19,prefix:[9,27,48,110],row:[130,55],content:[0,76,78,125,49,50],privat:[125,0],specif:[50,79,149],depend:25,friendli:131,send:[23,96,121],form_prep:33,digit:62,string:[5,76,125,135,33,25],fals:[125,33],util:[9,75],verb:98,my_secur:99,word:23,fadeout:43,list:[47,75,110],upload:128,"try":[49,0,128,96,50],item:[43,33,22,56,7,130],adjust:101,quick:111,sign:141,design:52,cache_on:34,pass:[9,0,19,76],download:[42,144],slidetoggl:43,compat:[25,125,101,141],index:[71,5,37,3,100],what:[0,96,78,130,27,49,103],hide:[62,43,139],sub:[9,0,134],compar:125,section:[83,80,21],current:62,delet:[149,18],version:[9,111,4,29],xss_clean:33,method:[0,149,53,80,33,55,82,125,50],metadata:[47,103],hash:25,gener:[51,131,55,24,143],is_cli_request:33,punch:131,directory_map:33,let:[49,0],cart:[130,33],address:118,path:[43,107],modifi:76,encryption_kei:79,valu:[30,92,94,33,125],convert:101,memcach:[103,66],bbedit:125,credit:127,chang:[124,50,33,100,29],portabl:79,overrid:[23,33],via:49,display_error:139,prefer:[62,23,19,53,128,28,103,75],base_url:[30,33],deprec:33,instal:[51,54,132],redi:[103,66],total:41,select:149,from:[3,117,95,82,99,100,101,102,56,57,58,59,17,61,120,4,15,71,72,73,74,76,119,30,31,32,33,16,35,36,37,118,60,39,67,123,153,154,155],zip:112,memori:41,internation:137,upgrad:[3,95,117,99,100,101,102,56,57,58,59,17,61,120,4,15,71,72,73,74,119,30,31,32,33,16,35,36,37,118,60,39,67,123,153,154,155],next:[62,19],call:[0,2,99,101,129,50],type:[53,33,96],prep:50,toggl:43,form_valid:33,claus:33,benchmark:[41,83],agent:93,xss:[139,33,140,106],cach:[66,149,34,18],retriev:[47,103,75],setup:43,work:[148,79,34,48,7,103,18],uniqu:33,fetch:[137,7],aliv:146,control:[113,0,136,65,13,151,128,102,50],sqlite:33,stream:106,process:[53,0,128,96,121],time_to_upd:123,wincach:66,"404_overrid":33,templat:[143,19,115,32,33,131,155],topic:[51,24],captcha:145,tag:[125,151],system_url:33,read_fil:33,multipl:[137,27,134,33,14,129,130,111,146,132],goal:52,secur:[69,33,99,139,141,140,106],charset:39,ping:121,write:80,how:[50,79,34,103,18],url_titl:33,instead:33,csv:75,config:[43,3,7,128,50,53,100,101,102,56,57,123,62,71,23,30,31,33,37,118,119,39],updat:[130,117,99,100,101,102,56,57,58,59,17,61,120,15,71,72,73,74,149,119,30,31,32,33,16,35,36,37,118,60,39,67,123,153,154,155],remap:0,cache_delete_al:34,resourc:[9,44],after:33,global_xss_filt:33,random_str:33,date:[33,91],underscor:33,associ:[50,96],trim_slash:33,"short":[125,151],practic:139,light:131,issu:[33,141],alias:13,"switch":137,environ:[14,7],reloc:[3,132],callabl:50,order:149,origin:10,cache_delet:34,move:[99,101,33],autoload:[100,33,56,39,123],reconnect:146,system_path:155,digest:25,paramet:[9,79,96,146],style:[125,141],group:[50,149],cli:[49,32],fix:29,clickabl:13,main:[100,37],easier:82,good:141,"return":[125,33,134],handl:[137,139,45,14,48],auto:[137,27,78,7,44],initi:[43,9,128,130,93,96,53,103,143,19,20,109,111,112,148,75,76,115,79,83,121,124],"break":125,framework:[131,129,14],now:[27,33],introduct:51,drop_tabl:33,name:[113,0,28,75,125,33,9,50],anyth:50,edit:3,troubleshoot:64,drop:76,authent:79,separ:33,mode:[143,79,12],debug:125,register_glob:139,reset:149,weight:131,replac:[3,33,100,102,118,119,110,9],individu:50,"static":136,connect:[146,78],event:43,variabl:[113,43,125,115],ftp:148,typecast:125,space:125,miss:33,profil:[41,83],rel:62,determin:[47,75],watermark:53,migrat:28,manipul:53,free:131,standard:[25,111],cooki:[90,106],base:66,mime:[102,33,118,16],dblib:33,anchor_class:33,indent:125,befor:139,keep:146,filter:[139,33,140,106],length:[79,109],pagin:[62,33],codeignit:[5,155,141,9,131,132,51,12,117,99,100,101,102,56,57,138,58,59,17,61,120,153,68,74,104,26,15,71,72,73,38,119,30,31,32,33,80,16,35,36,37,118,60,39,67,123,42,154,84],timezon:91,first:62,oper:125,suffix:5,fetch_directori:33,arrai:[142,50,111,55,96],number:152,system:110,hook:129,instruct:[101,54],open:125,forgeri:140,convent:9,strict:[143,12],data:[19,134,79,149,139,101,96,103,50,106],licens:77,cache_off:34,messag:[25,50,79,109],statement:125,"final":95,slidedown:43,tool:80,fetch_method:33,user_ag:[100,119],third_parti:100,apppath:100,enclos:62,than:50,remov:[5,33,99,100,101,103,155],structur:[86,151],jqueri:43,store:[101,34,134],bind:48,consumpt:41,typographi:[46,20],ani:[101,33],dash:33,packag:108,reserv:[113,0,98],"null":[125,33],engin:131,callback:[50,98],ancillari:122,destroi:103,rout:[136,33,98,21,22],note:[62,96,115,121,101,103,75],exampl:[62,137,28,75,66,98,148,149,111,124,112,93],thoroughli:131,mit:77,singl:111,anatomi:[96,7,78],simplifi:48,sure:[30,33],who:84,chart:133,textmat:125,beta:[95,3,29],regular:[98,48],pair:115,segment:[0,5],why:49,fetch_class:33,avail:[85,1,126,90,91,92,11,69,135,13,6,142,144,107,145,146,147,114,46,81,152,40],renam:[56,76,132],url:[5,131,33,81,121],tempdata:103,request:[140,96],uri:[0,5,33,98,150,139],doe:[131,34,18],dummi:66,ext:[100,33],bracket:125,clean:131,pars:115,hmac:79,shop:130,show:[43,19,50],text:[53,125,33,137,147],concurr:103,syntax:[151,153],session:[100,33,153,103],corner:43,xml:[96,1,75],cell:19,transact:12,configur:[43,94,79,14],folder:[101,3],local:125,info:51,contribut:[51,141],get:[138,106],express:98,nativ:9,fadein:43,csrf:[139,140],"new":[21,22],report:[143,14,141],requir:[131,80,70],enabl:[5,12,143,34,83,129,18],organ:0,common:105,default_control:33,contain:33,where:101,view:[43,134,65,115,108,151],certif:10,set:[62,27,23,19,43,53,33,98,21,7,83,75,109,110,9,50,128,79],tablesort:43,mysql:33,highlight_phras:33,result:[75,111,55,149],respons:96,close:[125,146],calendar:[19,3,43],best:139,kei:[16,109,76],databas:[71,51,94,75,76,78,33,34,48,47,82,37,145,139,103,111,146,100,89,123],label:137,dynam:134,approach:12,email:[126,23,33],attribut:62,altern:[66,151],call_funct:2,extend:[9,27,129,110],all_userdata:33,javascript:[43,33],extens:[101,33,131],popul:50,protect:[139,48],last:62,delimit:50,plugin:[43,101],pdo:33,tutori:[50,63,13,51],logic:[125,136],improv:34,load:[85,137,1,126,7,9,90,91,92,11,69,134,135,13,99,101,6,44,142,144,147,107,145,27,78,114,46,81,152,40],point:[41,129,83],overview:[50,13,26],loader:108,header:155,rpc:96,guid:[125,128,51,101,56,57,15,16,17,123,39,71,72,73,74,35,36,37,119,120,67,153,154,155],empti:[30,33],github:42,basic:[51,48],magic_quotes_runtim:139,argument:125,present:47,look:[149,124],defin:[0,129],behavior:[79,14],error:[71,12,125,32,33,45,14,48,96,50,155],anchor:62,loop:134,pack:131,file:[114,5,86,58,3,125,7,128,74,9,50,151,117,53,14,137,99,100,101,102,56,57,103,15,16,17,61,62,120,66,108,28,139,71,72,73,23,75,119,30,31,32,33,34,59,35,36,37,118,60,39,67,123,153,154,155],helper:[85,1,126,88,90,91,92,50,51,11,69,135,13,55,101,6,142,144,147,107,145,27,114,33,46,81,82,152,40],slideup:43,tabl:[75,76,125,47,100,118,121,153,124],site:[140,34],inform:82,parent:101,inflector:40,develop:10,welcom:[51,84],get_post:33,perform:34,make:[30,82,33],cross:140,same:129,fragment:115,html:[6,33,124],document:[80,131,75,141],http:98,optim:75,driver:[86,38,87,66,33,79,103],effect:[43,14],user:[131,93,51,101,56,57,15,16,17,123,39,71,72,73,74,35,36,37,119,120,67,153,154,155],mani:33,php:[71,5,141,119,125,31,66,33,151,100,37,102,56,57,39,118,123,106],sha1:33,builder:[94,149,111],object:[111,55],anim:43,client:96,command:49,thi:[85,1,2,126,34,90,91,92,11,69,135,13,6,142,144,107,145,147,114,46,81,152,40],model:[74,78,65,21,22,123],explan:[50,94,96],comment:125,identifi:48,execut:[82,41],tip:[103,141],"_post":50,toggleclass:43,languag:[85,137,33,3,39],previous:33,web:18,get_dir_file_info:101,add:[3,39,123],valid:[50,33,153,139],guidelin:141,input:[139,33,106],save:50,applic:[133,31,101,108,83,131,132],format:[125,96],world:[49,0],password:[25,139],insert:[139,111,149],do_hash:33,success:[50,128],whitespac:125,manual:[12,48,7,146],server:[106,96,70],necessari:101,cascad:50,output:[0,97],manag:[12,34,132],subhead:80,parenthet:125,"export":75,bonu:103,apc:66,librari:[51,23,43,33,79,99,143,109,116,9,103,104],confirm:155,definit:93,per:125,unit:143,overlai:53,refer:[137,87,7,89,128,91,130,50,93,51,96,53,97,55,148,100,103,140,106,62,143,19,20,66,108,28,109,25,149,112,23,75,76,115,79,34,150,121,41,124],core:[101,33,129,110],previou:[62,19,4],run:[49,143,12,132],usag:[28,75,115,66,33,148,112],step:[3,117,99,100,101,102,56,57,58,59,17,61,120,15,71,72,73,74,119,30,31,32,33,16,35,36,37,118,60,39,67,123,153,154,155],post:[102,106],mssql:33,about:[82,103],column:76,commun:131,page:[62,0,78,136,80,128,18,49,50],cipher:79,modal:43,constructor:[0,101],backup:75,disabl:[62,143,83],repair:75,own:[27,38,96,98,110,9,50,104],within:[9,134],encod:112,automat:[151,146],two:53,wrap:23,storag:9,your:[0,58,3,43,119,79,47,9,50,132,96,82,98,83,99,100,101,102,56,57,139,15,16,17,61,19,120,72,67,21,74,104,109,110,146,71,27,73,38,75,78,30,31,32,33,34,59,35,36,37,118,60,39,121,154,41,123,153,117,155,124],log:[33,29],support:[151,79,141],fast:131,custom:[62,143,2,79,55,103],standard_d:33,start:[111,138],flashdata:103,add_column:33,"function":[85,1,2,125,126,34,90,91,92,11,69,135,13,6,105,142,144,147,107,145,25,113,27,114,33,46,81,152,40],head:80,form:[137,33,22,128,102,92,50,106],forg:[33,76],link:[62,19],translat:50,line:[49,125,33,137],"true":125,bug:29,conclus:8,count:149,"default":[125,0,79,14,102],bugfix:29,access:[103,106],displai:[130,143,41,19,21],limit:149,sampl:137,similar:149,featur:68,constant:[113,125,31,33,14,100,25,16],creat:[137,143,86,38,19,76,134,110,22,128,28,96,121,9,50,122,104],get_inst:122,multibyt:25,flow:133,parser:115,decrypt:79,exist:[47,75],glanc:131,check:[102,33],echo:151,encrypt:[101,33,16,109,79],when:9,field:[47,50,13,76,92],other:50,branch:141,test:[143,12],imag:53,architectur:52,repeat:33,wildcard:98,"class":[137,0,79,43,125,7,130,128,122,9,50,93,96,53,97,55,148,101,103,140,106,62,143,19,20,66,108,28,109,110,149,111,112,23,75,76,115,33,34,150,83,121,41,124],sql:125,trackback:121,smilei:[13,33],markup:62,receiv:121,algorithm:79,directori:[0,11,3,134,33,86,128,132],descript:75,rule:[50,33,98],potenti:33,time:41,escap:[92,139,48],hello:[49,0]}}) \ No newline at end of file diff --git a/user_guide/tutorial/conclusion.html b/user_guide/tutorial/conclusion.html deleted file mode 100755 index 1d553ff..0000000 --- a/user_guide/tutorial/conclusion.html +++ /dev/null @@ -1,516 +0,0 @@ - - - - - - - - - - Conclusion — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Conclusion

      -

      This tutorial did not cover all of the things you might expect of a -full-fledged content management system, but it introduced you to the -more important topics of routing, writing controllers, and models. We -hope this tutorial gave you an insight into some of CodeIgniter’s basic -design patterns, which you can expand upon.

      -

      Now that you’ve completed this tutorial, we recommend you check out the -rest of the documentation. CodeIgniter is often praised because of its -comprehensive documentation. Use this to your advantage and read the -“Introduction” and “General Topics” sections thoroughly. You should read -the class and helper references when needed.

      -

      Every intermediate PHP programmer should be able to get the hang of -CodeIgniter within a few days.

      -

      If you still have questions about the framework or your own CodeIgniter -code, you can:

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/tutorial/create_news_items.html b/user_guide/tutorial/create_news_items.html deleted file mode 100755 index 1791789..0000000 --- a/user_guide/tutorial/create_news_items.html +++ /dev/null @@ -1,630 +0,0 @@ - - - - - - - - - - Create news items — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Tutorial »
        • - -
      • Create news items
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Create news items

      -

      You now know how you can read data from a database using CodeIgniter, but -you haven’t written any information to the database yet. In this section -you’ll expand your news controller and model created earlier to include -this functionality.

      -
      -

      Create a form

      -

      To input data into the database you need to create a form where you can -input the information to be stored. This means you’ll be needing a form -with two fields, one for the title and one for the text. You’ll derive -the slug from our title in the model. Create the new view at -application/views/news/create.php.

      -
      <h2><?php echo $title; ?></h2>
-
-<?php echo validation_errors(); ?>
-
-<?php echo form_open('news/create'); ?>
-
-    <label for="title">Title</label>
-    <input type="input" name="title" /><br />
-
-    <label for="text">Text</label>
-    <textarea name="text"></textarea><br />
-
-    <input type="submit" name="submit" value="Create news item" />
-
-</form>
-
      -
      -

      There are only two things here that probably look unfamiliar to you: the -form_open() function and the validation_errors() function.

      -

      The first function is provided by the form -helper and renders the form element and -adds extra functionality, like adding a hidden CSRF prevention -field. The latter is used to report -errors related to form validation.

      -

      Go back to your news controller. You’re going to do two things here, -check whether the form was submitted and whether the submitted data -passed the validation rules. You’ll use the form -validation library to do this.

      -
      public function create()
-{
-    $this->load->helper('form');
-    $this->load->library('form_validation');
-
-    $data['title'] = 'Create a news item';
-
-    $this->form_validation->set_rules('title', 'Title', 'required');
-    $this->form_validation->set_rules('text', 'Text', 'required');
-
-    if ($this->form_validation->run() === FALSE)
-    {
-        $this->load->view('templates/header', $data);
-        $this->load->view('news/create');
-        $this->load->view('templates/footer');
-
-    }
-    else
-    {
-        $this->news_model->set_news();
-        $this->load->view('news/success');
-    }
-}
-
      -
      -

      The code above adds a lot of functionality. The first few lines load the -form helper and the form validation library. After that, rules for the -form validation are set. The set_rules() method takes three arguments; -the name of the input field, the name to be used in error messages, and -the rule. In this case the title and text fields are required.

      -

      CodeIgniter has a powerful form validation library as demonstrated -above. You can read more about this library -here.

      -

      Continuing down, you can see a condition that checks whether the form -validation ran successfully. If it did not, the form is displayed, if it -was submitted and passed all the rules, the model is called. After -this, a view is loaded to display a success message. Create a view at -application/views/news/success.php and write a success message.

      -
      -
      -

      Model

      -

      The only thing that remains is writing a method that writes the data to -the database. You’ll use the Query Builder class to insert the -information and use the input library to get the posted data. Open up -the model created earlier and add the following:

      -
      public function set_news()
-{
-    $this->load->helper('url');
-
-    $slug = url_title($this->input->post('title'), 'dash', TRUE);
-
-    $data = array(
-        'title' => $this->input->post('title'),
-        'slug' => $slug,
-        'text' => $this->input->post('text')
-    );
-
-    return $this->db->insert('news', $data);
-}
-
      -
      -

      This new method takes care of inserting the news item into the database. -The third line contains a new function, url_title(). This function - -provided by the URL helper - strips down -the string you pass it, replacing all spaces by dashes (-) and makes -sure everything is in lowercase characters. This leaves you with a nice -slug, perfect for creating URIs.

      -

      Let’s continue with preparing the record that is going to be inserted -later, inside the $data array. Each element corresponds with a column in -the database table created earlier. You might notice a new method here, -namely the post() method from the input -library. This method makes sure the data is -sanitized, protecting you from nasty attacks from others. The input -library is loaded by default. At last, you insert our $data array into -our database.

      -
      -
      -

      Routing

      -

      Before you can start adding news items into your CodeIgniter application -you have to add an extra rule to config/routes.php file. Make sure your -file contains the following. This makes sure CodeIgniter sees ‘create’ -as a method instead of a news item’s slug.

      -
      $route['news/create'] = 'news/create';
-$route['news/(:any)'] = 'news/view/$1';
-$route['news'] = 'news';
-$route['(:any)'] = 'pages/view/$1';
-$route['default_controller'] = 'pages/view';
-
      -
      -

      Now point your browser to your local development environment where you -installed CodeIgniter and add index.php/news/create to the URL. -Congratulations, you just created your first CodeIgniter application! -Add some news and check out the different pages you made.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/tutorial/index.html b/user_guide/tutorial/index.html deleted file mode 100755 index 4c44266..0000000 --- a/user_guide/tutorial/index.html +++ /dev/null @@ -1,526 +0,0 @@ - - - - - - - - - - Tutorial — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      -
        -
      • Docs »
        • - -
      • Tutorial
        • -
      • - -
        • -
        - classic layout -
        -
      -
      -
      -
      - -
      -

      Tutorial

      -

      This tutorial is intended to introduce you to the CodeIgniter framework -and the basic principles of MVC architecture. It will show you how a -basic CodeIgniter application is constructed in step-by-step fashion.

      -

      In this tutorial, you will be creating a basic news application. You -will begin by writing the code that can load static pages. Next, you -will create a news section that reads news items from a database. -Finally, you’ll add a form to create news items in the database.

      -

      This tutorial will primarily focus on:

      -
        -
      • Model-View-Controller basics
        • -
      • Routing basics
        • -
      • Form validation
        • -
      • Performing basic database queries using “Query Builder”
        • -
      -

      The entire tutorial is split up over several pages, each explaining a -small part of the functionality of the CodeIgniter framework. You’ll go -through the following pages:

      -
        -
      • Introduction, this page, which gives you an overview of what to -expect.
        • -
      • Static pages, which will teach you the basics -of controllers, views and routing.
        • -
      • News section, where you’ll start using models -and will be doing some basic database operations.
        • -
      • Create news items, which will introduce -more advanced database operations and form validation.
        • -
      • Conclusion, which will give you some pointers on -further reading and other resources.
        • -
      -

      Enjoy your exploration of the CodeIgniter framework.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/tutorial/news_section.html b/user_guide/tutorial/news_section.html deleted file mode 100755 index 1d3b03d..0000000 --- a/user_guide/tutorial/news_section.html +++ /dev/null @@ -1,686 +0,0 @@ - - - - - - - - - - News section — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      News section

      -

      In the last section, we went over some basic concepts of the framework -by writing a class that includes static pages. We cleaned up the URI by -adding custom routing rules. Now it’s time to introduce dynamic content -and start using a database.

      -
      -

      Setting up your model

      -

      Instead of writing database operations right in the controller, queries -should be placed in a model, so they can easily be reused later. Models -are the place where you retrieve, insert, and update information in your -database or other data stores. They represent your data.

      -

      Open up the application/models/ directory and create a new file called -News_model.php and add the following code. Make sure you’ve configured -your database properly as described here.

      -
      <?php
-class News_model extends CI_Model {
-
-        public function __construct()
-        {
-                $this->load->database();
-        }
-}
-
      -
      -

      This code looks similar to the controller code that was used earlier. It -creates a new model by extending CI_Model and loads the database -library. This will make the database class available through the -$this->db object.

      -

      Before querying the database, a database schema has to be created. -Connect to your database and run the SQL command below (MySQL). -Also add some seed records.

      -
      CREATE TABLE news (
-        id int(11) NOT NULL AUTO_INCREMENT,
-        title varchar(128) NOT NULL,
-        slug varchar(128) NOT NULL,
-        text text NOT NULL,
-        PRIMARY KEY (id),
-        KEY slug (slug)
-);
-
      -
      -

      Now that the database and a model have been set up, you’ll need a method -to get all of our posts from our database. To do this, the database -abstraction layer that is included with CodeIgniter — -Query Builder — is used. This makes it -possible to write your ‘queries’ once and make them work on all -supported database systems. Add the -following code to your model.

      -
      public function get_news($slug = FALSE)
-{
-        if ($slug === FALSE)
-        {
-                $query = $this->db->get('news');
-                return $query->result_array();
-        }
-
-        $query = $this->db->get_where('news', array('slug' => $slug));
-        return $query->row_array();
-}
-
      -
      -

      With this code you can perform two different queries. You can get all -news records, or get a news item by its slug. You might have -noticed that the $slug variable wasn’t sanitized before running the -query; Query Builder does this for you.

      -
      -
      -

      Display the news

      -

      Now that the queries are written, the model should be tied to the views -that are going to display the news items to the user. This could be done -in our Pages controller created earlier, but for the sake of clarity, -a new News controller is defined. Create the new controller at -application/controllers/News.php.

      -
      <?php
-class News extends CI_Controller {
-
-        public function __construct()
-        {
-                parent::__construct();
-                $this->load->model('news_model');
-                $this->load->helper('url_helper');
-        }
-
-        public function index()
-        {
-                $data['news'] = $this->news_model->get_news();
-        }
-
-        public function view($slug = NULL)
-        {
-                $data['news_item'] = $this->news_model->get_news($slug);
-        }
-}
-
      -
      -

      Looking at the code, you may see some similarity with the files we -created earlier. First, the __construct() method: it calls the -constructor of its parent class (CI_Controller) and loads the model, -so it can be used in all other methods in this controller. -It also loads a collection of URL Helper -functions, because we’ll use one of them in a view later.

      -

      Next, there are two methods to view all news items and one for a specific -news item. You can see that the $slug variable is passed to the model’s -method in the second method. The model is using this slug to identify the -news item to be returned.

      -

      Now the data is retrieved by the controller through our model, but -nothing is displayed yet. The next thing to do is passing this data to -the views.

      -
      public function index()
-{
-        $data['news'] = $this->news_model->get_news();
-        $data['title'] = 'News archive';
-
-        $this->load->view('templates/header', $data);
-        $this->load->view('news/index', $data);
-        $this->load->view('templates/footer');
-}
-
      -
      -

      The code above gets all news records from the model and assigns it to a -variable. The value for the title is also assigned to the $data['title'] -element and all data is passed to the views. You now need to create a -view to render the news items. Create application/views/news/index.php -and add the next piece of code.

      -
      <h2><?php echo $title; ?></h2>
-
-<?php foreach ($news as $news_item): ?>
-
-        <h3><?php echo $news_item['title']; ?></h3>
-        <div class="main">
-                <?php echo $news_item['text']; ?>
-        </div>
-        <p><a href="<?php echo site_url('news/'.$news_item['slug']); ?>">View article</a></p>
-
-<?php endforeach; ?>
-
      -
      -

      Here, each news item is looped and displayed to the user. You can see we -wrote our template in PHP mixed with HTML. If you prefer to use a template -language, you can use CodeIgniter’s Template -Parser class or a third party parser.

      -

      The news overview page is now done, but a page to display individual -news items is still absent. The model created earlier is made in such -way that it can easily be used for this functionality. You only need to -add some code to the controller and create a new view. Go back to the -News controller and update view() with the following:

      -
      public function view($slug = NULL)
-{
-        $data['news_item'] = $this->news_model->get_news($slug);
-
-        if (empty($data['news_item']))
-        {
-                show_404();
-        }
-
-        $data['title'] = $data['news_item']['title'];
-
-        $this->load->view('templates/header', $data);
-        $this->load->view('news/view', $data);
-        $this->load->view('templates/footer');
-}
-
      -
      -

      Instead of calling the get_news() method without a parameter, the -$slug variable is passed, so it will return the specific news item. -The only things left to do is create the corresponding view at -application/views/news/view.php. Put the following code in this file.

      -
      <?php
-echo '<h2>'.$news_item['title'].'</h2>';
-echo $news_item['text'];
-
      -
      -
      -
      -

      Routing

      -

      Because of the wildcard routing rule created earlier, you need an extra -route to view the controller that you just made. Modify your routing file -(application/config/routes.php) so it looks as follows. -This makes sure the requests reaches the News controller instead of -going directly to the Pages controller. The first line routes URI’s -with a slug to the view() method in the News controller.

      -
      $route['news/(:any)'] = 'news/view/$1';
-$route['news'] = 'news';
-$route['(:any)'] = 'pages/view/$1';
-$route['default_controller'] = 'pages/view';
-
      -
      -

      Point your browser to your document root, followed by index.php/news and -watch your news page.

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/user_guide/tutorial/static_pages.html b/user_guide/tutorial/static_pages.html deleted file mode 100755 index b30c213..0000000 --- a/user_guide/tutorial/static_pages.html +++ /dev/null @@ -1,634 +0,0 @@ - - - - - - - - - - Static pages — CodeIgniter 3.0.3 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - -
      -
      -
      - -
      -
      -
      - -
      -

      Static pages

      -

      Note: This tutorial assumes you’ve downloaded CodeIgniter and -installed the framework in your -development environment.

      -

      The first thing you’re going to do is set up a controller to handle -static pages. A controller is simply a class that helps delegate work. -It is the glue of your web application.

      -

      For example, when a call is made to:

      -
      -
      -

      We might imagine that there is a controller named “news”. The method -being called on news would be “latest”. The news method’s job could be to -grab 10 news items, and render them on the page. Very often in MVC, -you’ll see URL patterns that match:

      -
      -
      -

      As URL schemes become more complex, this may change. But for now, this -is all we will need to know.

      -

      Create a file at application/controllers/Pages.php with the following -code.

      -
      <?php
-class Pages extends CI_Controller {
-
-        public function view($page = 'home')
-        {
-        }
-}
-
      -
      -

      You have created a class named Pages, with a view method that accepts -one argument named $page. The Pages class is extending the -CI_Controller class. This means that the new pages class can access the -methods and variables defined in the CI_Controller class -(system/core/Controller.php).

      -

      The controller is what will become the center of every request to -your web application. In very technical CodeIgniter discussions, it may -be referred to as the super object. Like any php class, you refer to -it within your controllers as $this. Referring to $this is how -you will load libraries, views, and generally command the framework.

      -

      Now you’ve created your first method, it’s time to make some basic page -templates. We will be creating two “views” (page templates) that act as -our page footer and header.

      -

      Create the header at application/views/templates/header.php and add -the following code:

      -
      <html>
-        <head>
-                <title>CodeIgniter Tutorial</title>
-        </head>
-        <body>
-
-                <h1><?php echo $title; ?></h1>
-
      -
      -

      The header contains the basic HTML code that you’ll want to display -before loading the main view, together with a heading. It will also -output the $title variable, which we’ll define later in the controller. -Now, create a footer at application/views/templates/footer.php that -includes the following code:

      -
                      <em>&copy; 2015</em>
-        </body>
-</html>
-
      -
      -
      -

      Adding logic to the controller

      -

      Earlier you set up a controller with a view() method. The method -accepts one parameter, which is the name of the page to be loaded. The -static page templates will be located in the application/views/pages/ -directory.

      -

      In that directory, create two files named home.php and about.php. -Within those files, type some text − anything you’d like − and save them. -If you like to be particularly un-original, try “Hello World!”.

      -

      In order to load those pages, you’ll have to check whether the requested -page actually exists:

      -
      public function view($page = 'home')
-{
-        if ( ! file_exists(APPPATH.'/views/pages/'.$page.'.php'))
-        {
-                // Whoops, we don't have a page for that!
-                show_404();
-        }
-
-        $data['title'] = ucfirst($page); // Capitalize the first letter
-
-        $this->load->view('templates/header', $data);
-        $this->load->view('pages/'.$page, $data);
-        $this->load->view('templates/footer', $data);
-}
-
      -
      -

      Now, when the page does exist, it is loaded, including the header and -footer, and displayed to the user. If the page doesn’t exist, a “404 -Page not found” error is shown.

      -

      The first line in this method checks whether the page actually exists. -PHP’s native file_exists() function is used to check whether the file -is where it’s expected to be. show_404() is a built-in CodeIgniter -function that renders the default error page.

      -

      In the header template, the $title variable was used to customize the -page title. The value of title is defined in this method, but instead of -assigning the value to a variable, it is assigned to the title element -in the $data array.

      -

      The last thing that has to be done is loading the views in the order -they should be displayed. The second parameter in the view() method is -used to pass values to the view. Each value in the $data array is -assigned to a variable with the name of its key. So the value of -$data['title'] in the controller is equivalent to $title in the -view.

      -
      -
      -

      Routing

      -

      The controller is now functioning! Point your browser to -[your-site-url]index.php/pages/view to see your page. When you visit -index.php/pages/view/about you’ll see the about page, again including -the header and footer.

      -

      Using custom routing rules, you have the power to map any URI to any -controller and method, and break free from the normal convention: -http://example.com/[controller-class]/[controller-method]/[arguments]

      -

      Let’s do that. Open the routing file located at -application/config/routes.php and add the following two lines. -Remove all other code that sets any element in the $route array.

      -
      $route['default_controller'] = 'pages/view';
-$route['(:any)'] = 'pages/view/$1';
-
      -
      -

      CodeIgniter reads its routing rules from top to bottom and routes the -request to the first matching rule. Each rule is a regular expression -(left-side) mapped to a controller and method name separated by slashes -(right-side). When a request comes in, CodeIgniter looks for the first -match, and calls the appropriate controller and method, possibly with -arguments.

      -

      More information about routing can be found in the URI Routing -documentation.

      -

      Here, the second rule in the $routes array matches any request -using the wildcard string (:any). and passes the parameter to the -view() method of the Pages class.

      -

      Now visit index.php/about. Did it get routed correctly to the view() -method in the pages controller? Awesome!

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

      - © Copyright 2014 - 2015, British Columbia Institute of Technology. - Last updated on Oct 31, 2015. -

      -
      - - Built with Sphinx using a theme provided by Read the Docs. - -
      -
      -
      - -
      - -
      - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file