From b0dd10f8171945e0c1f3527dd1e9d18b043e01a7 Mon Sep 17 00:00:00 2001 From: admin Date: Fri, 25 Aug 2006 17:25:49 +0000 Subject: Initial Import --- user_guide/overview/appflow.html | 101 +++++++++++++++++++++ user_guide/overview/at_a_glance.html | 168 +++++++++++++++++++++++++++++++++++ user_guide/overview/features.html | 122 +++++++++++++++++++++++++ user_guide/overview/goals.html | 103 +++++++++++++++++++++ user_guide/overview/index.html | 89 +++++++++++++++++++ user_guide/overview/mvc.html | 105 ++++++++++++++++++++++ 6 files changed, 688 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/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..0322a043e --- /dev/null +++ b/user_guide/overview/appflow.html @@ -0,0 +1,101 @@ + + + + +Code Igniter User Guide + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

Code Igniter User Guide Version 1.4.0

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

Application Flow Chart

+ +

The following graphic illustrates how data flows throughout the system:

+ +
+ + +
    +
  1. The index.php serves as the front controller, initializing the base resources needed to run Code Igniter.
    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, plugins, 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. +
+ + + + +
+ + + + + + + \ 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..188ced259 --- /dev/null +++ b/user_guide/overview/at_a_glance.html @@ -0,0 +1,168 @@ + + + + +Code Igniter User Guide + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

Code Igniter User Guide Version 1.4.0

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

Code Igniter at a Glance

+ + +

Code Igniter is an Application Framework

+ +

Code Igniter is a toolkit for people who build web application using PHP. Its goal is to enable you to develop projects must 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. Code Igniter lets you creatively focus on your project by +minimizing the amount of code needed for a given task.

+ +

Code Igniter is Free

+

Code Igniter is licensed under an Apache/BSD-style open source license so you can use it however you please. +For more information please read the license agreement.

+ + +

Code Igniter Runs on PHP 4

+

Code Igniter is written to be compatible with PHP 4. Although we would have loved to take advantage of the better object handling +in PHP 5 since it would have simplified some things we had to find creative solutions for (looking your way, multiple inheritance), +at the time of this writing PHP 5 is not in widespread use, which means we would be alienating most of our +potential audience. Major OS vendors like RedHat have yet to support PHP 5, and they are unlikely to do so until 2007, so +we felt that it did not serve the best interests of the PHP community to write Code Igniter in PHP 5.

+ +

Note: Code Igniter will run on PHP 5. It simply does not take advantage of any native features that are only available in that version.

+ +

Code Igniter 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. +

+ +

Code Igniter Uses M-V-C

+

Code Igniter 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 file contain will be minimized. We describe MVC in more detail on its own page.

+ +

Code Igniter Generates Clean URLs

+

The URLs generated by Code Igniter are clean and search-engine friendly. Rather than using the standard "query string" +approach to URLs that is synonymous with dynamic systems, Code Igniter uses a segment-based approach:

+ +www.your-site.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.

+ +

Code Igniter Packs a Punch

+

Code Igniter comes with a very nice set of libraries that enable the most commonly needed web development tasks, +like connecting to a database, sending email, validating form data, maintaining sessions, manipulating images, and more.

+ +

Code Igniter is Extensible

+

The system can be easily extended through the use of plugins and helper files, or even through class extensions or standard includes.

+ +

Code Igniter Does Not Require a Template Engine

+

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.

+ +

That said, Code Igniter does come with a simple template engine class which you can optionally use. Or, if you +prefer using a full-blown template engine such as Smarty, there's no reason why you can't use it with Code Igniter. +Just include your template engine script when you write your controllers, and continue working as you normally do.

+ +

Code Igniter 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.

+ + +
+ + + + + + + \ 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..3cb1ba1f8 --- /dev/null +++ b/user_guide/overview/features.html @@ -0,0 +1,122 @@ + + + + +Code Igniter User Guide + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

Code Igniter User Guide Version 1.4.0

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

Code Igniter 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 +Code Igniter is child's play so we encourage you to do just that. In the mean time here's a list of Code Igniter's main features.

+ + + + + + +
+ + + + + + + \ 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..0fdd4d1a9 --- /dev/null +++ b/user_guide/overview/goals.html @@ -0,0 +1,103 @@ + + + + +Code Igniter User Guide + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

Code Igniter User Guide Version 1.4.0

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

Design and Architectural Goals

+ +

Our goal for Code Igniter 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 an technical and architectural standpoint, Code Igniter was created with the following objectives:

+ + + +

Code Igniter is a dynamically instantiated, loosely coupled system with high component singularity. It strives for simplicity, flexibility, and high performance in a small footprint package.

+ + + + + + +
+ + + + + + + \ 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..8ddbdad36 --- /dev/null +++ b/user_guide/overview/index.html @@ -0,0 +1,89 @@ + + + + +Code Igniter User Guide + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

Code Igniter User Guide Version 1.4.0

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

Code Igniter Overview

+ +

The following pages describe the broad concepts behind Code Igniter:

+ + + + + + +
+ + + + + + + \ 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..4f251e4d2 --- /dev/null +++ b/user_guide/overview/mvc.html @@ -0,0 +1,105 @@ + + + + +Code Igniter User Guide + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

Code Igniter User Guide Version 1.4.0

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

Model-View-Controller

+ +

Code Igniter 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.

+ + + +

Code Igniter 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. Code Igniter 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.

+ + + + +
+ + + + + + + \ No newline at end of file -- cgit v1.2.3-24-g4f1b