From 02a0518e1c56ba3506f370362ac5ebdb8a138312 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Sat, 13 Jan 2018 13:57:11 +0200 Subject: [ci skip] 3.1.7 release --- user_guide/overview/appflow.html | 513 ++++++++++++++++++++++++++ user_guide/overview/at_a_glance.html | 599 +++++++++++++++++++++++++++++++ user_guide/overview/features.html | 538 +++++++++++++++++++++++++++ user_guide/overview/getting_started.html | 512 ++++++++++++++++++++++++++ user_guide/overview/goals.html | 522 +++++++++++++++++++++++++++ user_guide/overview/index.html | 504 ++++++++++++++++++++++++++ user_guide/overview/mvc.html | 519 ++++++++++++++++++++++++++ 7 files changed, 3707 insertions(+) create mode 100644 user_guide/overview/appflow.html create mode 100644 user_guide/overview/at_a_glance.html create mode 100644 user_guide/overview/features.html create mode 100644 user_guide/overview/getting_started.html create mode 100644 user_guide/overview/goals.html create mode 100644 user_guide/overview/index.html create mode 100644 user_guide/overview/mvc.html (limited to 'user_guide/overview') diff --git a/user_guide/overview/appflow.html b/user_guide/overview/appflow.html new file mode 100644 index 000000000..99de72a61 --- /dev/null +++ b/user_guide/overview/appflow.html @@ -0,0 +1,513 @@ + + + + + + + + + + Application Flow Chart — CodeIgniter 3.1.7 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 - 2018, British Columbia Institute of Technology. + Last updated on Jan 13, 2018. +

+
+ + 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 new file mode 100644 index 000000000..bcf077758 --- /dev/null +++ b/user_guide/overview/at_a_glance.html @@ -0,0 +1,599 @@ + + + + + + + + + + CodeIgniter at a Glance — CodeIgniter 3.1.7 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 - 2018, British Columbia Institute of Technology. + Last updated on Jan 13, 2018. +

+
+ + 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 new file mode 100644 index 000000000..84398ce81 --- /dev/null +++ b/user_guide/overview/features.html @@ -0,0 +1,538 @@ + + + + + + + + + + CodeIgniter Features — CodeIgniter 3.1.7 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 - 2018, British Columbia Institute of Technology. + Last updated on Jan 13, 2018. +

+
+ + 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 new file mode 100644 index 000000000..8241a9245 --- /dev/null +++ b/user_guide/overview/getting_started.html @@ -0,0 +1,512 @@ + + + + + + + + + + Getting Started With CodeIgniter — CodeIgniter 3.1.7 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 - 2018, British Columbia Institute of Technology. + Last updated on Jan 13, 2018. +

+
+ + 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 new file mode 100644 index 000000000..7079f1241 --- /dev/null +++ b/user_guide/overview/goals.html @@ -0,0 +1,522 @@ + + + + + + + + + + Design and Architectural Goals — CodeIgniter 3.1.7 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 - 2018, British Columbia Institute of Technology. + Last updated on Jan 13, 2018. +

+
+ + 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 new file mode 100644 index 000000000..2a1e1c625 --- /dev/null +++ b/user_guide/overview/index.html @@ -0,0 +1,504 @@ + + + + + + + + + + CodeIgniter Overview — CodeIgniter 3.1.7 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • CodeIgniter Overview
    • +
  • + +
    • +
    + classic layout +
    +
+
+
+
+ +
+

CodeIgniter Overview

+

The following pages describe the broad concepts behind CodeIgniter:

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

+ © Copyright 2014 - 2018, British Columbia Institute of Technology. + Last updated on Jan 13, 2018. +

+
+ + 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 new file mode 100644 index 000000000..7c86e3df8 --- /dev/null +++ b/user_guide/overview/mvc.html @@ -0,0 +1,519 @@ + + + + + + + + + + Model-View-Controller — CodeIgniter 3.1.7 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 - 2018, British Columbia Institute of Technology. + Last updated on Jan 13, 2018. +

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