当前位置：首页 > PHP教程 > php高级应用 > 列表

PHP的Yii框架中YiiBase入口类的扩展写法示例

发布:smiling　来源: PHP粉丝网 　添加日期：2019-11-17 18:27:40　浏览: 评论：0　

通过yiic.php自动创建一个应用后，入口文件初始代码如下：

  1. // change the following paths if necessary 
  2.  
  3. $yii=dirname(__FILE__).'/../yii/framework/yii.php'; 
  4.  
  5. $config=dirname(__FILE__).'/protected/config/main.php'; 
  6.  
  7. // remove the following lines when in production mode 
  8.  
  9. defined('YII_DEBUG') or define('YII_DEBUG',true); 
  10.  
  11. // specify how many levels of call stack should be shown in each log message 
  12.  
  13. defined('YII_TRACE_LEVEL') or define('YII_TRACE_LEVEL',3); 
  14.  
  15. require_once($yii); 
  16.  
  17. Yii::createWebApplication($config)->run(); 

其中第三行引入了一个yii.php的文件，这个可以在yii核心目录里的framework/下找到，这个文件中定义了一个Yii类，并且继承了YiiBase类。

代码如下:

  1. require(dirname(__FILE__).'/YiiBase.php'); 
  2.  
  3. /** 
  4.  
  5.  * Yii is a helper class serving common framework functionalities. 
  6.  
  7.  * 
  8.  
  9.  * It encapsulates {@link YiiBase} which provides the actual implementation. 
  10.  
  11.  * By writing your own Yii class, you can customize some functionalities of YiiBase. 
  12.  
  13.  * 
  14.  
  15.  * @author Qiang Xue <qiang.xue@gmail.com> 
  16.  
  17.  * @package system 
  18.  
  19.  * @since 1.0 
  20.  
  21.  */ 
  22.  
  23. class Yii extends YiiBase 
  24.  
  25. { 
  26.  
  27. } 
  28.  
  29. </qiang.xue@gmail.com> 

而:

Yii::createWebApplication

这个方法实际上是在YiiBase父类中定义的，所以，Yii为我们预留了扩展的可能。我们只需要在yii.php中添加我们想要扩展的方法即可，在项目中直接使用 Yii::方法名() 调用。

为了将项目代码和核心目录完全分离，我个人觉得在项目目录下使用另外一个yii.php来替代从核心目录中包含yii.php更加好。

这里我用了更加极端的方法，我直接将yii这个类定义在了入口文件，并扩展了一个全局工厂函数 instance()方法，请看代码：

  1. // change the following paths if necessary 
  2.  
  3. $yii=dirname(__FILE__).'/../yii/framework/YiiBase.php'; 
  4.  
  5. $config=dirname(__FILE__).'/protected/config/main.php'; 
  6.  
  7. // remove the following lines when in production mode 
  8.  
  9. defined('YII_DEBUG') or define('YII_DEBUG',true); 
  10.  
  11. // specify how many levels of call stack should be shown in each log message 
  12.  
  13. defined('YII_TRACE_LEVEL') or define('YII_TRACE_LEVEL',3); 
  14.  
  15. require_once($yii); 
  16.  
  17. //扩展基类 
  18.  
  19. class Yii extends YiiBase{ 
  20.  
  21.   /** 
  22.  
  23.    * 全局扩展方法：工厂函数 
  24.  
  25.    * @param type $alias 类库别名 
  26.  
  27.    */ 
  28.  
  29.   static function instance($alias){ 
  30.  
  31.     static $_class_ = array(); 
  32.  
  33.     $key = md5($alias); 
  34.  
  35.     if(!isset($_class_[$key])){ 
  36.  
  37.       $_class_[$key] = self::createComponent($alias); 
  38.  
  39.     } 
  40.  
  41.     return $_class_[$key]; 
  42.  
  43.   } 
  44.  
  45. } 
  46.  
  47. Yii::createWebApplication($config)->run(); 

这个类是在最后一行Yii::createWebApplication()之前定义的，以保证Yii类能正常使用(不要把这个类放在文件末尾，会出错。)

在项目中任何地方，使用$obj = Yii::instance($alias);去实例化一个类，并且是单例模式。

YiiBase中的两个比较重要的方法 （import，autoload）

然后看看YiiBase中的import方法就知道这些静态变量是干嘛用的了：

  1. /* Yii::import() 
  2.  
  3. * $alias: 要导入的类名或路径 
  4.  
  5. * $forceInclude false：只导入不include类文件，true则导入并include类文件 
  6.  
  7. */ 
  8.  
  9.  public static function import($alias, $forceInclude = false){   
  10.  
  11.  //Yii把所有的依赖放入到这个全局的$_imports数组中,名字不能重复 
  12.  
  13.  //如果当前依赖已经被引入过了，那么直接返回 
  14.  
  15.  if (isset(self::$_imports[$alias])) {     
  16.  
  17.     return self::$_imports[$alias];   
  18.  
  19.   }   
  20.  
  21.  //class_exists和interface_exists方法的第二个参数的值为false表示不autoload  
  22.  
  23.  if (class_exists($alias, false) || interface_exists($alias, false)) {     
  24.  
  25.    return self::$_imports[$alias] = $alias;   
  26.  
  27.  }   
  28.  
  29.  //如果传进来的是一个php5.3版本的命名空间格式的类（例如：a\b\c.php） 
  30.  
  31.  if (($pos = strrpos($alias, '\\')) !== false) {     
  32.  
  33.   //$namespace = a.b 
  34.  
  35.   $namespace = str_replace('\\', '.', ltrim(substr($alias, 0, $pos), '\\'));  
  36.  
  37.   //判断a.b这个路径是否存在，或者a.b只是alias里面的一个键，调用该方法返回这个键对应的值，比如'email' => realpath(__DIR__ . '/../vendor/cornernote/yii-email-module/email') 
  38.  
  39.   if (($path = self::getPathOfAlias($namespace)) !== false) {    
  40.  
  41.     $classFile = $path . DIRECTORY_SEPARATOR . substr($alias, $pos + 1) . '.php';        
  42.  
  43.     if ($forceInclude) {         
  44.  
  45.      if (is_file($classFile)) {           
  46.  
  47.        require($classFile);         
  48.  
  49.       } else {           
  50.  
  51.       throw new CException(Yii::t('yii', 'Alias "{alias}" is invalid. Make sure it points to an existing PHP file and the file is readable.', array('{alias}' => $alias)));         
  52.  
  53.      }         
  54.  
  55.      self::$_imports[$alias] = $alias;       
  56.  
  57.      } else {         
  58.  
  59.      self::$classMap[$alias] = $classFile;       
  60.  
  61.     }       
  62.  
  63.     return $alias;     
  64.  
  65.   } else {       
  66.  
  67. // try to autoload the class with an autoloader       
  68.  
  69.   if (class_exists($alias, true)) {         
  70.  
  71.     return self::$_imports[$alias] = $alias;       
  72.  
  73.   } else {         
  74.  
  75.     throw new CException(Yii::t('yii', 'Alias "{alias}" is invalid. Make sure it points to an existing directory or file.',          array('{alias}' => $namespace)));       
  76.  
  77.   }     
  78.  
  79.   }   
  80.  
  81.  }   
  82.  
  83. if (($pos = strrpos($alias, '.')) === false) // a simple class name  
  84.  
  85.  {     
  86.  
  87.   // try to autoload the class with an autoloader if $forceInclude is true     
  88.  
  89.   if ($forceInclude && (Yii::autoload($alias, true) || class_exists($alias, true))) {       
  90.  
  91.    self::$_imports[$alias] = $alias;     
  92.  
  93.    }     
  94.  
  95.   return $alias;   
  96.  
  97.  }   
  98.  
  99.  $className = (string)substr($alias, $pos + 1);   
  100.  
  101.  
  102.  
  103.  $isClass = $className !== '*';   
  104.  
  105.  if ($isClass && (class_exists($className, false) || interface_exists($className, false))) {     
  106.  
  107.   return self::$_imports[$alias] = $className;   
  108.  
  109.  }   
  110.  
  111.  if (($path = self::getPathOfAlias($alias)) !== false) {     
  112.  
  113.    if ($isClass) {       
  114.  
  115.       if ($forceInclude) {         
  116.  
  117.          if (is_file($path . '.php')) {           
  118.  
  119.              require($path . '.php');         
  120.  
  121.          } else {           
  122.  
  123.              throw new CException(Yii::t('yii', 'Alias "{alias}" is invalid. Make sure it points to an existing PHP file and the file is readable.', array('{alias}' => $alias)));         
  124.  
  125.              }         
  126.  
  127.         self::$_imports[$alias] = $className;       
  128.  
  129.      } else {         
  130.  
  131.         self::$classMap[$className] = $path . '.php';       
  132.  
  133.      }       
  134.  
  135.       return $className;     
  136.  
  137.     }  
  138.  
  139.     // $alias是'system.web.*'这样的已*结尾的路径，将路径加到include_path中 
  140.  
  141.     else // a directory     
  142.  
  143.      {       
  144.  
  145.        if (self::$_includePaths === null) {     
  146.  
  147.           self::$_includePaths = array_unique(explode(PATH_SEPARATOR, get_include_path()));   
  148.  
  149.            if (($pos = array_search('.', self::$_includePaths, true)) !== false) {           
  150.  
  151.         unset(self::$_includePaths[$pos]);         
  152.  
  153.       }       
  154.  
  155.     }       
  156.  
  157.     array_unshift(self::$_includePaths, $path);       
  158.  
  159.     if (self::$enableIncludePath && set_include_path('.' . PATH_SEPARATOR . implode(PATH_SEPARATOR, self::$_includePaths)) === false) {         
  160.  
  161.      self::$enableIncludePath = false;       
  162.  
  163.      }       
  164.  
  165.      return self::$_imports[$alias] = $path;     
  166. //phpfensi.com 
  167.     }   
  168.  
  169.   } else {     
  170.  
  171.     throw new CException(Yii::t('yii', 'Alias "{alias}" is invalid. Make sure it points to an existing directory or file.',      array('{alias}' => $alias)));   
  172.  
  173.     } 
  174.  
  175.  } 

是的，上面这个方法最后就把要加载的东西都放到$_imports,$_includePaths中去了。这就是Yii的import方法，好的，接下来我们看看autoload方法：

  1. public static function autoload($className, $classMapOnly = false){  // use include so that the error PHP file may appear   
  2.  
  3. if (isset(self::$classMap[$className])) {        
  4.  
  5.   include(self::$classMap[$className]);   
  6.  
  7. } elseif (isset(self::$_coreClasses[$className])) {     
  8.  
  9.   include(YII_PATH . self::$_coreClasses[$className]);   
  10.  
  11. } elseif ($classMapOnly) {     
  12.  
  13.   return false;   
  14.  
  15. } else {     
  16.  
  17.  // include class file relying on include_path     
  18.  
  19.     if (strpos($className, '\\') === false)  
  20.  
  21.     // class without namespace     
  22.  
  23.     {       
  24.  
  25.       if (self::$enableIncludePath === false) {         
  26.  
  27.          foreach (self::$_includePaths as $path) {               
  28.  
  29.             $classFile = $path . DIRECTORY_SEPARATOR . $className . '.php';           
  30.  
  31.             if (is_file($classFile)) {        
  32.  
  33.                include($classFile);             
  34.  
  35.               if (YII_DEBUG && basename(realpath($classFile)) !== $className . '.php') {               
  36.  
  37.                 throw new CException(Yii::t('yii', 'Class name "{class}" does not match class file "{file}".', array(                '{class}' => $className,                '{file}' => $classFile,              )));             
  38.  
  39.               }             
  40.  
  41.               break;           
  42.  
  43.            }         
  44.  
  45.        }       
  46.  
  47.    } else {         
  48.  
  49.       include($className . '.php');       
  50.  
  51.        }     
  52.  
  53.  } else // class name with namespace in PHP 5.3     
  54.  
  55.    {       
  56.  
  57.      $namespace = str_replace('\\', '.', ltrim($className, '\\'));     
  58.  
  59.      if (($path = self::getPathOfAlias($namespace)) !== false) {   
  60.  
  61.       include($path . '.php');       
  62.  
  63.      } else {         
  64.  
  65.       return false;       
  66.  
  67.      }     
  68.  
  69.    }     
  70.  
  71. return class_exists($className, false) || interface_exists($className, false); } return true;} 

config文件中的 import 项里的类或路径在脚本启动中会被自动导入。用户应用里个别类需要引入的类可以在类定义前加入 Yii::import() 语句。

Tags: Yii框架 YiiBase入口类

分享到：

相关文章

推荐文章

热门文章

最新评论文章