CI框架学习笔记(二) -入口文件index.php


Posted in PHP onOctober 27, 2014

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

CI框架学习笔记(二) -入口文件index.php

作为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的地方:

CI框架学习笔记(二) -入口文件index.php

可以看到,很多组件都依赖于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());

CI框架学习笔记(二) -入口文件index.php

(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框架能够正常运行的关键。

最后,按照惯例,贴一下整个文件的源码(简化注释版):

<?php

define('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 file
define('SELF', pathinfo(__FILE__, PATHINFO_BASENAME));

// this global constant is deprecataaed.
define('EXT', '.php');

// Path to the system folder
define('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" folder
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.'/');
}

require_once BASEPATH.'core/CodeIgniter.php';
PHP 相关文章推荐
phpMyAdmin下载、安装和使用入门教程
May 31 PHP
PHP教程 预定义变量
Oct 23 PHP
PHP正则的Unknown Modifier错误解决方法
Mar 02 PHP
批量修改RAR文件注释的php代码
Nov 20 PHP
php下将多个数组合并成一个数组的方法与实例代码
Feb 03 PHP
PHP生成sitemap.xml地图函数
Nov 13 PHP
destoon安全设置中需要设置可写权限的目录及文件
Jun 21 PHP
php实现短信发送代码
Jul 05 PHP
php中实现用数组妩媚地生成要执行的sql语句
Jul 10 PHP
PHP实现数据分页显示的简单实例
May 26 PHP
PHP数据库编程之MySQL优化策略概述
Aug 16 PHP
Laravel中GraphQL接口请求频率实战记录
Sep 01 PHP
PHP改进计算字符串相似度的函数similar_text()、levenshtein()
Oct 27 #PHP
CI框架学习笔记(一) - 环境安装、基本术语和框架流程
Oct 26 #PHP
Linux下PHP加速器APC的安装与配置笔记
Oct 24 #PHP
Linux下安装PHP MSSQL扩展教程
Oct 24 #PHP
Windows下的PHP安装pear教程
Oct 24 #PHP
Windows下安装PHP单元测试环境PHPUnit图文教程
Oct 24 #PHP
自己写的兼容低于PHP 5.5版本的array_column()函数
Oct 24 #PHP
You might like
短波的认识
2021/03/01 无线电
php基础知识:类与对象(1)
2006/12/13 PHP
hessian 在PHP中的使用介绍
2010/12/13 PHP
PHP缓存技术的使用说明
2011/08/06 PHP
探讨GDFONTPATH能否被winxp下的php支持
2013/06/21 PHP
关于Zend Studio 配色方案插件的介绍
2013/06/24 PHP
javascript mouseover、mouseout停止事件冒泡的解决方案
2009/04/07 Javascript
原生JS实现表单checkbook获取已选择的值
2013/07/21 Javascript
jQuery实现菜单式图片滑动切换
2015/03/14 Javascript
Javascript设计模式之装饰者模式详解篇
2017/01/17 Javascript
Angular1.x复杂指令实例详解
2017/03/01 Javascript
jQuery操作css样式
2017/05/15 jQuery
基于vue2.0实现的级联选择器
2017/06/09 Javascript
JS设计模式之惰性模式(二)
2017/09/29 Javascript
Router解决跨模块下的页面跳转示例
2018/01/11 Javascript
vue动画之点击按钮往上渐渐显示出来的实例
2018/09/29 Javascript
JS设置自定义快捷键并实现图片上下左右移动
2019/10/17 Javascript
详解vue中多个有顺序要求的异步操作处理
2019/10/29 Javascript
微信小程序实现自定义底部导航
2020/11/18 Javascript
[01:05]DOTA2完美大师赛趣味视频之选手教你打职业
2017/11/23 DOTA
[48:12]Secret vs Optic Supermajor 胜者组 BO3 第三场 6.4
2018/06/05 DOTA
python正则表达式re模块详细介绍
2014/05/29 Python
Python 3实战爬虫之爬取京东图书的图片详解
2017/10/09 Python
django2.0扩展用户字段示例
2019/02/13 Python
python3 property装饰器实现原理与用法示例
2019/05/15 Python
Python多线程threading模块用法实例分析
2019/05/22 Python
Flask配置Cors跨域的实现
2019/07/12 Python
python mqtt 客户端的实现代码实例
2019/09/25 Python
英语简历自我评价
2014/01/26 职场文书
《四季》教学反思
2014/04/08 职场文书
小学绿色学校申报材料
2014/08/23 职场文书
2015年医院创卫工作总结
2015/04/22 职场文书
2015年街道办事处工作总结
2015/05/22 职场文书
复兴之路纪录片观后感
2015/06/02 职场文书
PyTorch 实现L2正则化以及Dropout的操作
2021/05/27 Python
P站美图推荐——变身女主角特辑
2022/03/20 日漫