The mystery of ThinkPHP application mode extension

ThinkPHP application mode provides the opportunity to transform the core framework, allowing your application to adapt to more environments and different needs. Each application mode has its own mode definition file. Compared with the ThinkPHP3.1 version, the ThinkPHP3.2 version has a clearer and clearer extension of the application mode. In the ThinkPHP3.1 version, Cli, Lite, Thin, AMF, and PHPRPC are defined. , REST mode, its definition method is similar to that of ThinkPHP version 3.2. If necessary, you can refer to the modification. The Cli mode is built into the ThinkPHP framework. It can be used normally without defining the Cli mode separately. If you need more detailed adjustments, please refer to 3.1 Cli run mode extension written in . ThinkPHP also provides a convenient mode switching method between development environment and formal environment. Let us follow the running process of ThinkPHP to analyze the mystery of its application mode expansion.

1. Use of application mode

Before exploring application mode extensions, let’s take a look at how to use application mode. Generally, the constant APP_MODE is defined as the application mode name in the entry file. However, when analyzing the ThinkPHP framework entry file, we learned that the default mode of the framework is common mode (common) and can automatically identify the sae environment. Of course, the premise is that the APP_MODE constant is not defined. Of course, ThinkPHP can automatically identify CLI and CGI modes, and when running in CLI and CGI environments, the ThinkPHP framework will automatically make subtle adjustments to these two environments in the default mode. Of course, you can also expand these two application modes yourself.

if(function_exists(&#39;saeAutoLoader&#39;)){// 自动识别SAE环境
    defined(&#39;APP_MODE&#39;)     or define(&#39;APP_MODE&#39;,      &#39;sae&#39;);
    defined(&#39;STORAGE_TYPE&#39;) or define(&#39;STORAGE_TYPE&#39;,  &#39;Sae&#39;);
}else{
    defined(&#39;APP_MODE&#39;)     or define(&#39;APP_MODE&#39;,       &#39;common&#39;); // 应用模式 默认为普通模式   
    defined(&#39;STORAGE_TYPE&#39;) or define(&#39;STORAGE_TYPE&#39;,   &#39;File&#39;); // 存储类型 默认为File   
}

Copy after login

2. Application mode definition

In the ThinkPHP framework, except for the ThinkPHP framework entry and framework boot classes, basically all other functions can be changed and extended through the application mode. If we want to add an application mode, we only need to define a mode definition file under the ThinkPHPMode directory. That’s it, we can learn by analyzing the common mode.

//文件路径：ThinkPHP/Mode/common.php
/**
 * ThinkPHP 普通模式定义
 * 定义一个模式文件，只需要返回一个模式包含文件的数组即可
 * 在数组中主要包含4种扩展文件列表：
 *     config 为默认加载配置文件列表
 *     alias  为核心类库别名配置列表
 *     core 需要加载的核心函数和类文件列表
 *     tags 行为配置列表
 *
 * 如果在应用模式定义中加载一个自定类，那个自定义类的命名空间必须是Think
 */
return array(
    // 配置文件
    &#39;config&#39;    =>  array(
        THINK_PATH.&#39;Conf/convention.php&#39;,   // 系统惯例配置
        CONF_PATH.&#39;config.php&#39;,      // 应用公共配置
    ),
 
    // 别名定义
    &#39;alias&#39;     =>  array(
        &#39;Think\Log&#39;               => CORE_PATH . &#39;Log&#39;.EXT,
        &#39;Think\Log\Driver\File&#39;   => CORE_PATH . &#39;Log/Driver/File&#39;.EXT,
        &#39;Think\Exception&#39;         => CORE_PATH . &#39;Exception&#39;.EXT,
        &#39;Think\Model&#39;             => CORE_PATH . &#39;Model&#39;.EXT,
        &#39;Think\Db&#39;                => CORE_PATH . &#39;Db&#39;.EXT,
        &#39;Think\Template&#39;          => CORE_PATH . &#39;Template&#39;.EXT,
        &#39;Think\Cache&#39;             => CORE_PATH . &#39;Cache&#39;.EXT,
        &#39;Think\Cache\Driver\File&#39; => CORE_PATH . &#39;Cache/Driver/File&#39;.EXT,
        &#39;Think\Storage&#39;           => CORE_PATH . &#39;Storage&#39;.EXT,
    ),
 
    // 函数和类文件
    &#39;core&#39;      =>  array(
        THINK_PATH.&#39;Common/functions.php&#39;,
        COMMON_PATH.&#39;Common/function.php&#39;,
        CORE_PATH . &#39;Hook&#39;.EXT,
        CORE_PATH . &#39;App&#39;.EXT,
        CORE_PATH . &#39;Dispatcher&#39;.EXT,
        //CORE_PATH . &#39;Log&#39;.EXT,
        CORE_PATH . &#39;Route&#39;.EXT,
        CORE_PATH . &#39;Controller&#39;.EXT,
        CORE_PATH . &#39;View&#39;.EXT,
        BEHAVIOR_PATH . &#39;BuildLiteBehavior&#39;.EXT,
        BEHAVIOR_PATH . &#39;ParseTemplateBehavior&#39;.EXT,
        BEHAVIOR_PATH . &#39;ContentReplaceBehavior&#39;.EXT,
    ),
    // 行为扩展定义
    &#39;tags&#39;  =>  array(
        &#39;app_init&#39;     =>  array(
            &#39;Behavior\BuildLiteBehavior&#39;, // 生成运行Lite文件
        ),       
        &#39;app_begin&#39;     =>  array(
            &#39;Behavior\ReadHtmlCacheBehavior&#39;, // 读取静态缓存
        ),
        &#39;app_end&#39;       =>  array(
            &#39;Behavior\ShowPageTraceBehavior&#39;, // 页面Trace显示
        ),
        &#39;view_parse&#39;    =>  array(
            &#39;Behavior\ParseTemplateBehavior&#39;, // 模板解析 支持PHP、内置模板引擎和第三方模板引擎
        ),
        &#39;template_filter&#39;=> array(
            &#39;Behavior\ContentReplaceBehavior&#39;, // 模板输出替换
        ),
        &#39;view_filter&#39;   =>  array(
            &#39;Behavior\WriteHtmlCacheBehavior&#39;, // 写入静态缓存
        ),
    ),
);

Copy after login

After we saw this common application mode code, we kind of understood what ThinkPHP's application mode extension was about, but we still knew it but didn't know why. How does defining a loaded file list and configuration change the core of the framework? The secret lies in the ThinkPHPK boot class, let’s review the following!

//判断是否存在core.php配置文件（这是开发环境临时定义的运行模式，我是这么理解的）
          //否者加载APP_MODE定义的模式文件
          $mode   =   include is_file(CONF_PATH.&#39;core.php&#39;)?CONF_PATH.&#39;core.php&#39;:MODE_PATH.APP_MODE.&#39;.php&#39;;
          //加载模式中core定义的核心文件列表
          foreach ($mode[&#39;core&#39;] as $file){
              if(is_file($file)) {
                include $file;
                if(!APP_DEBUG) $content   .= compile($file);
              }
          }
 
          //加载模式中定义的config配置文件列表
          foreach ($mode[&#39;config&#39;] as $key=>$file){
              is_numeric($key)?C(include $file):C($key,include $file);
          }
 
          // 读取当前应用模式对应的配置文件
          if(&#39;common&#39; != APP_MODE && is_file(CONF_PATH.&#39;config_&#39;.APP_MODE.&#39;.php&#39;))
              C(include CONF_PATH.&#39;config_&#39;.APP_MODE.&#39;.php&#39;); 
 
          // 加载模式中alias别名列表定义
          if(isset($mode[&#39;alias&#39;])){
              self::addMap(is_array($mode[&#39;alias&#39;])?$mode[&#39;alias&#39;]:include $mode[&#39;alias&#39;]);
          }
 
          // 加载应用别名定义文件
          if(is_file(CONF_PATH.&#39;alias.php&#39;))
              self::addMap(include CONF_PATH.&#39;alias.php&#39;);
 
          // 加载模式中tags行为定义
          if(isset($mode[&#39;tags&#39;])) {
              Hook::import(is_array($mode[&#39;tags&#39;])?$mode[&#39;tags&#39;]:include $mode[&#39;tags&#39;]);
          }
 
          // 加载应用行为定义
          if(is_file(CONF_PATH.&#39;tags.php&#39;))
              // 允许应用增加开发模式配置定义
              Hook::import(include CONF_PATH.&#39;tags.php&#39;);  
 
          // 加载框架底层语言包
          L(include THINK_PATH.&#39;Lang/&#39;.strtolower(C(&#39;DEFAULT_LANG&#39;)).&#39;.php&#39;);

Copy after login

Through this code in ThinkPHP::start(), the meaning and implementation method of the pattern definition file are perfectly and seamlessly related.

3. Define a simple operating mode

There is an example of mode extension in the manual. You can take it here to analyze and define a lite simple running mode. First, create a new lite.php file in the ThinkPHP/Mode directory and define the content as follows:

return array(   
// 配置文件  
&#39;config&#39;    =>  array(
               THINK_PATH.&#39;Conf/convention.php&#39;,     // 系统惯例配置
               CONF_PATH.&#39;config.php&#39;,      // 应用公共配置  
 ),
 
 // 别名定义   
 &#39;alias&#39;     =>  array(
              &#39;Think\Exception&#39;         => CORE_PATH . &#39;Exception&#39;.EXT,
              &#39;Think\Model&#39;             => CORE_PATH . &#39;Model&#39;.EXT, 
              &#39;Think\Db&#39;                => CORE_PATH . &#39;Db&#39;.EXT,
              &#39;Think\Cache&#39;             => CORE_PATH . &#39;Cache&#39;.EXT,
              &#39;Think\Cache\Driver\File&#39; => CORE_PATH . &#39;Cache/Driver/File&#39;.EXT,
              &#39;Think\Storage&#39;           => CORE_PATH . &#39;Storage&#39;.EXT,
 ),
 
 // 函数和类文件  
  &#39;core&#39;      =>  array(
             MODE_PATH.&#39;Lite/functions.php&#39;,  
             COMMON_PATH.&#39;Common/function.php&#39;,
             MODE_PATH . &#39;Lite/App&#39;.EXT, 
             MODE_PATH . &#39;Lite/Dispatcher&#39;.EXT, 
             MODE_PATH . &#39;Lite/Controller&#39;.EXT,
             MODE_PATH . &#39;Lite/View&#39;.EXT,
             CORE_PATH . &#39;Behavior&#39;.EXT,
 ),
 
 // 行为扩展定义   
 &#39;tags&#39;  =>  array(
              &#39;view_parse&#39;    =>  array(
                     &#39;Behavior\ParseTemplate&#39;, // 模板解析 支持PHP、内置模板引擎和第三方模板引擎
               ),
               &#39;template_filter&#39;=> array(
                     &#39;Behavior\ContentReplace&#39;, // 模板输出替换
               ),
 ),
);

Copy after login

From the above configuration, we found that most of the core files in the core have been replaced. Of course, these program functions that need to be replaced need to be implemented by ourselves. However, it is recommended that you directly copy the core files defined in the normal mode and modify them. . Next, we will implement the following core class library extension file App.class.php

in ThinkPHP application development

Create a Lite directory in the ThinkPHP/Mode directory and create the App.class.php file in the lite directory. The following is the implementation of the program file:

//模式扩展类库必须是Think命名空间
namespace Think;
 
/**
 * ThinkPHP 应用程序类 执行应用过程管理 Lite模式扩展类
 * 实现ThinkPHP核心类库扩展时，尽可能仿造原有类库实现（除非对ThinkPHP框架源码特别了解）
 * 因为在其他没有扩展的核心文件中可能会调用扩展的核心类文件中的某个方法，除非你打算全部扩展
 */
class App{
/**
 * 应用程序初始化
 * @access public
 * @return void
 */
static public function init() {
        //具体现实
}
 
/**
 * 执行应用程序
 * @access public
 * @return void
 */
static public function exec() {
        //具体实现
}
 
/**
 * 运行应用实例 入口文件使用的快捷方法
 * @access public
 * @return void
 */
static public function run() {
        //具体实现
}
 
static public function logo(){
        //具体实现
}
}

Copy after login

After all extension files of the file are implemented, the APP_MODE constant can be defined as lite in the framework entry file.

I am here to complain about the following official: In this section of the manual, the MODE_NAME constant must be defined to change the operating mode. For accuracy, I had no choice but to search for MODE_NAME in all the files of the ThinkPHP framework. I was relieved when the results were not found. This is the method of defining the operating mode in the previous version 3.1. The manual is updated with details (please state that the manual I am using now is version 3.2.1 on February 14, 2014).

The mystery of ThinkPHP application mode extension_PHP tutorial

The mystery of ThinkPHP application mode extension