Joomla 代码解读.docx

Joomla 代码解读我们从安装程序入口文件 /installation/index.php 开始。 1. 常量定义 index.php 文件起始处定义了若干常量： define( _JEXEC, 1 );define( JPATH_BASE, dirname( _FILE_ ) );define( DS, DIRECTORY_SEPARATOR ); _JEXEC 是一个标志量，表示程序正常启动(通过合法入口 /index.php 访问)。Joomla! 在其他所有的 .php 程序起始处，均通过执行以下代码，阻止直接访问非入口程序的请求，这是出于安全的考虑： / no direct accessdefined( _JEXEC ) or die( Restricted access ); JPATH_BASE 顾名思义，是指安装程序的根目录，注意它与 PHP 预定义变量 $_SERVERDOCUMENT_ROOT 的区别，后者是当前的 www 虚拟主机在文件系统中的根目录，它是前者的上级目录。_FILE_ 是 PHP 的魔术常量之一： 名称 说明 _LINE_ 文件中的当前行号。 _FILE_ 文件的完整路径和文件名。如果用在包含文件中，则返回包含文件名。自 PHP 4.0.2 起，_FILE_ 总是包含一个绝对路径，而在此之前的版本有时会包含一个相对路径。 _FUNCTION_ 函数名称（PHP 4.3.0 新加）。自 PHP 5 起本常量返回该函数被定义时的名字（区分大小写）。在 PHP 4 中该值总是小写字母的。 _CLASS_ 类的名称（PHP 4.3.0 新加）。自 PHP 5 起本常量返回该类被定义时的名字（区分大小写）。在 PHP 4 中该值总是小写字母的。 _METHOD_ 类的方法名（PHP 5.0.0 新加）。返回该方法被定义时的名字（区分大小写）。 定义 DS 则完全是为了方便程序书写和阅读，DIRECTORY_SEPARATOR 是 PHP 的预定义常量之一，指目录分隔符，在 Windows 中是反斜杠(backslash) ，在 Linux 中是斜杠(slash) /。 2. 引入框架定义 在常量定义之后，通过两个包含文件引入了 Joomla! 安装程序的框架定义： require_once ( JPATH_BASE .DS.includes.DS.defines.php );require_once ( JPATH_BASE .DS.includes.DS.framework.php ); 这两个文件的实际位置在 /installation/includes/ 目录中。打开 /installation/includes/defines.php 文件，这里定义了若干与路径有关的常量，包括： JPATH_ROOT Joomla! 根目录，当 Joomla! 被配置为独立的虚拟主机程序是地，此变量相当于 $_SERVERDOCUMENT_ROOT JPATH_SITE Joomla! 站点目录，JPATH_ROOT 的别名 JPATH_CONFIGURATION 配置文件保存目录 JPATH_ADMINISTRATOR 后 台管理程序根目录 JPATH_XMLRPC XMLRPC 目录 JPATH_LIBRARIES 库 程序目录 JPATH_PLUGINS 插件目录 JPATH_INSTALLATION 安 装程序目录 JPATH_THEMES 外观模板目录 JPATH_CACHE 缓存 目录 好了，我们可以关闭 defines.php 文件了。再来看看 /installation/includes/framework.php 文件中有些什么，首先是 PHP 配置调整： error_reporting( E_ALL );set_magic_quotes_runtime( 0 ); ini_set(zend.ze1_compatibility_mode, 0); 此处做了这么几件事： 打开 PHP 报错，要求回显从错误(Error)到提醒(Notice)的全部异常信息； 关 闭运行时魔术引号(magic_quotes_runtime)功能。此功能将对所有来自外部(包括数据库或 文本文件)的字符串中的引号进行转义，即在其 前面加上反斜杠 或使用两个连续单引号替换所有的单引号(当打开 magic_quotes_sybase 开关时)。PHP 不鼓励使用此功能，从 PHP 6.0.0 开始它将被废除； 关闭 Zend 引擎 1(PHP 4) 兼容模式。PHP 官方文档中提到：这影响到了对象的复制、构造（无属性的对象会产生 FALSE 或 0）及比较。此模式下，对象将以值传递，而不是默认的引用传递。 Joomla! 的程序设计完全遵循面向对象思想，且书写非常规范，在这种前提下，这些兼容功能只会造成困扰，不如舍弃之。 接着检查 Joomla! 安装状态： if (file_exists( JPATH_CONFIGURATION . DS . configuration.php ) & (filesize( JPATH_CONFIGURATION . DS . configuration.php ) 10) & !file_exists( JPATH_INSTALLATION . DS . index.php ) header( Location: ./index.php ); exit(); 如果配置文件/configuration.php 已经存在且包括配置信息，并且安装程序已被移除，则自动转向首页。这段语句似乎没有实际意义，针对谁呢？至少不是针对安装程序本身的。 然后载入库程序装载器： require_once( JPATH_LIBRARIES . DS . loader.php ); 通过这个装载程序，可以模拟类似 JAVA import 的程序导入方式。我们看紧接着的两行代码： jimport( joomla.base.object );jimport( joomla.environment.request ); 实际完成的功能是引入了 /libraries/joomla/base/object.php 和 /libraries/joomla/environment/request.php 两个文件。当然，事实上 jimport 和 JAVA 中的 import 语句还是有区别的，因为 PHP 尚不支持 OO 中非常重要的命名空间(namespace)功能。 object.php 和 request.php 文件分别定义了 JObject 类和 JRequest 类。JObject 类在 Joomla! 中这所有子类的基类，即所有非基类都必须直接或间接地继承 JObject 类。JObject 定义中值得玩味的是它对构造函数的处理： function JObject() $args = func_get_args(); call_user_func_array(array(&$this, _construct), $args); function _construct() PHP 4 中将与类同名的成员函数作为其构造函数，这与 JAVA 和 C+ 类似。而 PHP 5 支持固定名称的构造函数 _construct() 和析构函数 _destruct()。JObject 中同时定义两种形式的构造函数 JObject() 和 _contruc()，而所有子类一律按 PHP 5 的规范以 _construct 命名构造函数。这样，当 Joomla! 运行在 PHP 5 上时，JObject() 方法将被忽略；而运行在 PHP 4 上时，解释器找不到与子类同名的成员函数，认为子类中未定义构造函数，因此在创建子类对象时，将调用父类 JObject 的构造函数 JObject()，而 JObject() 的功能即是调用对象自身的 _contruct() 方法，并将所有参数传递给它，也即实现了将子类定义中的 _contruct() 方法作为其构造函数的目的。这样，子类作者在编写构造函数时，不必再考虑 PHP 的版本差异，但是需要注意子类定义中不得再出现与类名相同的成员函数，否则会导致混乱。 JRequest 类是大部分 IO 操作都需要使用的类，在定义了这个类之后，Joomla! 立刻使用它完成了一步非常谨慎的操作： JRequest:clean(); clean() 方法检查所有当前已经存在的全局变量($GLOBALS 数组)及超全局变量(超全局变量包括 $_FILES, $_ENV, $_GET, $_POST, $_COOKIE, $_SERVER, $_SESSION, $_REQUEST)，清除了所有非超全局变量以及超全局变量中可能存在的不安全的数据。经过这一步，之前在程序中定义的任何变量都将被释放。 然后又定义了一个常量 JPATH_INCLUDES，说实话我非常不理解为什么不把这个定义放在 /installation/includes/defines.php 中？ / Installation file includesdefine( JPATH_INCLUDES, dirname(_FILE_) ); 接下来进入 framework.php 的正题，即载入 Joomla! 的 API 框架定义： /* * Joomla! framework loading */ / Include object abstract classjimport( pat ); / Joomla! library importsjimport( joomla.environment.response );jimport( joomla.database.table );jimport( joomla.user.user);jimport( joomla.environment.uri );jimport( joomla.user.user);jimport( joomla.factory );jimport( joomla.methods );jimport( joomla.filesystem.* );jimport( joomla.html.parameter );jimport( joomla.utilities.array );jimport( joomla.utilities.error );jimport( joomla.utilities.utility );jimport( joomla.version ); 我们来看看这些文件的用途： pat 当 PHP 版本低于5时，自动载入补丁程序，以支持 file_put_contents() 和 clone() 函数 joomla.environment.response 定 义 JResponse 类，用于访问响应变量(response variables)，包括消息头(header)和消息主体(body) joomla.database.table 定 义抽象类 JTable, 所有数据表的映射类都继承自此类 joomla.user.user 定义 JUser 类，处理所有与用户信息有关的交互 joomla.environment.uri 定义 JURI (注意全部是大写)类，用于解析、处理和生成 URI，它的另一个功能是提供当前执行脚本的 URI joomla.user.user 又 定义一遍 JUser 类，不是他晕了，就是我太肤浅 joomla.factory 定义静态类 JFactory，用于按工厂模式生成对象实例 joomla.methods 定义 JRoute 和 JText 类，分别用于输出可读的 URI 和本地化文本，实际上它们只是简单封装了 JRouter (注意区别)类和 JLanguage 类 joomla.filesystem.* 定 义文件系统包，内含 JArchive (文件压缩)、JFile (文件访问和控制)、JFolder (文件夹访问和控制)、JPath (文件路径处理)类 joomla.html.parameter 定义 JParameter 类 joomla.utilities.array 定 义 JArrayHelper 类 joomla.utilities.error 定义 JError 类 joomla.utilities.utility 定 义 JUtility 类 joomla.version 定义 JVersion 类 joomla.utilities.string 定 义 JString 类 最后，framework.php 读取了 task 参数，以决定是否引用 JString 类，这是一个专门用于处理 utf-8 编码字符串的静态类： / JString should only be loaded after pre-install checks$task = JRequest:getCmd( task );if (!($ta