Welcome 微信登录

首页 / 网页编程 / PHP / CI框架学习笔记(二) -入口文件index.php

上一节(CI框架学习笔记(一) - 环境安装、基本术语和框架流程)中,我们提到了CI框架的基本流程,这里再次贴出流程图,以备参考:

作为CI框架的入口文件,源码阅读,自然由此开始。在源码阅读的过程中,我们并不会逐行进行解释,而只解释核心的功能和实现。
1. 设置应用程序环境
define("ENVIRONMENT", "development");
这里的development可以是任何你喜欢的环境名称(比如dev,再如test),相对应的,你要在下面的switch case代码块中,对设定的环境做相关的错误控制,否则,CI框架会认为你没有配置好相应的环境,从而退出进程并给出对应的错误信息:
default: exit("The application environment is not set correctly.");
为什么一开始就要配置ENVIRONMENT?这是因为,CI框架中很多组件都依赖于ENVIRONMENT的配置,我们看一下system中,引用ENVIRONMENT的地方:

可以看到,很多组件都依赖于ENVIRONMENT.例如,查看system/config/Common.php, 这其中有一段引入配置文件的代码,是这样实现的:
if ( ! defined("ENVIRONMENT") OR ! file_exists($file_path = APPPATH."config/".ENVIRONMENT."/config.php")){$file_path = APPPATH."config/config.php";}
在CI框架中,很多配置文件都是通过这种方式引入的,因此ENVRIONMENT对于CI框架的正确运行时必须的,所以需要在开始的时候配置好ENVIRONMENT。设置ENVIRONMENT的一个好处是:可以很方便的切换系统的配置而不必修改系统代码。例如,在系统进入测试阶段时,database配置为测试的数据库,而在系统测试完毕时,database切换到线上的数据库。这好比是用一个开关控制了系统的环境切换,自然是非常方便的。
2. 配置系统目录和应用程序目录
CI框架允许你将系统核心源码和应用程序代码分开放置,但是你必须设定好系统的system文件夹和application文件夹(同样,文件夹名字可以是任何合法的文件夹名称,而不一定使用"system"和"application"):
$system_path = "system";$application_folder = "application";
接下来,有这么一段代码:
if (defined("STDIN")){ chdir(dirname(__FILE__));}
这段代码是干嘛的呢?首先,STDIN、STDOUT、STDERR是PHP以 CLI(Command Line Interface)模式运行而定义的三个常量,这三个常量类似于Shell的stdin,stdout,stdout,分别是PHP CLI模式下的标准输入、标准输出和标准错误流。也就是说,这三行代码是为了保证命令行模式下,CI框架可以正常运行。关于PHP CLI的更多细节可以参考:http://www.php-cli.com/
3. system目录的正确性验证和application目录验证
(1). system目录的正确性验证
Realpath返回的是目录或文件的绝对目录名(没有最后的/)
if (realpath($system_path) !== FALSE){$system_path = realpath($system_path)."/";}$system_path = rtrim($system_path, "/")."/";if ( ! is_dir($system_path)){ exit("xxxxxxxx");}
几个定义的常量(PATH结尾的常量表示目录路径,DIR结尾的变量表示目录名):
a. SELF(这里指index.php文件)
b. EXT(deprecated,废弃的,不必关注)
c. BASEPATH(system文件夹的路径)
d. FCPATH(前端控制器的路径)
e. SYSDIR(系统system目录名)
f. APPPATH(应用程序路径)
查看所有定义的常量的方法:
Print_r(get_defined_constants());

(2)application的目录验证。
代码较简单,不做过多的解释:
if (is_dir($application_folder)){define("APPPATH", $application_folder."/");}else{if ( ! is_dir(BASEPATH.$application_folder."/")){exit("Your application folder path does not appear to be set correctly. Please open the following file and correct this: ".SELF);}define("APPPATH", BASEPATH.$application_folder."/");}
入口文件的最后一行,引入CodeIgniter.php(也是下一步阅读的关键)。CodeIgniter.php被称为bootstrap file,也就是它是一个引导文件,是CI框架执行流程的核心文件。
require_once BASEPATH."core/CodeIgniter.php";
总结一下,index.php并没有做太多复杂的工作,而是类似一个后勤,为CI框架的运行提供了一系列配置参数和正确性验证,而这些配置和验证,是CI框架能够正常运行的关键。
最后,按照惯例,贴一下整个文件的源码(简化注释版):
<?phpdefine("ENVIRONMENT", "development");if (defined("ENVIRONMENT")){switch (ENVIRONMENT){case "development":error_reporting(E_ALL);break;case "testing":case "production":error_reporting(0);break;default:exit("The application environment is not set correctly.");}}/* * SYSTEM FOLDER NAME */$system_path = "system";/* * APPLICATION FOLDER NAME */$application_folder = "application";/* * Resolve the system path for increased reliability */if (defined("STDIN")){chdir(dirname(__FILE__));}if (realpath($system_path) !== FALSE){$system_path = realpath($system_path)."/";}$system_path = rtrim($system_path, "/")."/";if ( ! is_dir($system_path)){exit("xxxxxxxx");}/* * set the main path constants */// The name of THIS filedefine("SELF", pathinfo(__FILE__, PATHINFO_BASENAME));// this global constant is deprecataaed.define("EXT", ".php");// Path to the system folderdefine("BASEPATH", str_replace("\", "/", $system_path));// Path to the front controller (this file)define("FCPATH", str_replace(SELF, "", __FILE__));// Name of the "system folder"define("SYSDIR", trim(strrchr(trim(BASEPATH, "/"), "/"), "/"));// The path to the "application" folderif (is_dir($application_folder)){define("APPPATH", $application_folder."/");}else{if ( ! is_dir(BASEPATH.$application_folder."/")){exit("Your application folder path does not appear to be set correctly. Please open the following file and correct this: ".SELF);}define("APPPATH", BASEPATH.$application_folder."/");}require_once BASEPATH."core/CodeIgniter.php";