Yii源码阅读笔记(三)

时间:2023-01-20 20:15:03

接着上次的继续阅读BaseYii.php

vendor/yiisoft/yii2/BaseYii.php——

  public static function getRootAlias($alias)//获取根别名
     {  //查找别名中斜线的位置
         $pos = strpos($alias, '/');        //根据斜线的结果判断,如果不包含斜线,表示输入为根别名,否则截取斜线前面的部分作为根别名
         $root = $pos === false ? $alias : substr($alias, 0, $pos);
        //判断根别名是否存在
         if (isset(static::$aliases[$root])) {
             if (is_string(static::$aliases[$root])) {//判断根别名的值即路径是否为字符串,如果是,返回根别名
                 return $root;
             } else {//否则遍历别名数组,通过查找字符串函数找到根别名,返回
                 foreach (static::$aliases[$root] as $name => $path) {
                     if (strpos($alias . '/', $name . '/') === 0) {
                         return $name;
                     }
                 }
             }
         }

         return false;
     }

类自动加载方法:

public static function autoload($className)
    {
        if (isset(static::$classMap[$className])) {//判断传入的类是否在定义的$classMap数组常量中
            $classFile = static::$classMap[$className];//如果在,则类的路径为类名对应的路径即数组的值
            if ($classFile[0] === '@') {//取路径的第一个字符判断是否为@,如果是,则包含别名
                $classFile = static::getAlias($classFile);//解析别名作为类文件路径
            }
        } elseif (strpos($className, '\\') !== false) {//如果传入的类名不在$classMap数组中,且传入的类名为路径
            $classFile = static::getAlias('@' . str_replace('\\', '/', $className) . '.php', false);//拼接出类文件路径,支持别名
            if ($classFile === false || !is_file($classFile)) {//如果类文件不存在,则返回
                return;
            }
        } else {//路径不正确,返回
            return;
        }

        include($classFile);//包含类文件

        if (YII_DEBUG && !class_exists($className, false) && !interface_exists($className, false) && !trait_exists($className, false)) {
            throw new UnknownClassException("Unable to find '$className' in file: $classFile. Namespace missing?");//判断类是否存在,不存在抛出异常
        }
    }

创建对象方法:

public static function createObject($type, array $params = [])
    {
        if (is_string($type)) {//判断输入的参数$type是否为字符串
            return static::$container->get($type, $params);//如果是字符串,调用$container 的get方法获取对象并返回
        } elseif (is_array($type) && isset($type['class'])) {//判断参数$type是否为数组,并且数组中是否有类名称
            $class = $type['class'];//如果有,则类名为数组中class键的值
            unset($type['class']);//注销$type 中的类名称作为下面的配置参数--详见get方法
            return static::$container->get($class, $params, $type);//通过类名称获取对象
        } elseif (is_callable($type, true)) {//判断参数$type是否为可调用的函数
            return call_user_func($type, $params);//调用函数并返回
        } elseif (is_array($type)) {//参数$type是数组但不包含类名,抛出异常
            throw new InvalidConfigException('Object configuration must be an array containing a "class" element.');
        } else {//输入不合法,抛出异常
            throw new InvalidConfigException('Unsupported configuration type: ' . gettype($type));
        }
    }

获取日志记录方法:

 private static $_logger;//声明静态变量

     /**
      * @return Logger message logger
      */
     public static function getLogger()
     {
         if (self::$_logger !== null) {//如果当前的静态变量不为空,返回$_logger
             return self::$_logger;
         } else {
             return self::$_logger = static::createObject('yii\log\Logger');//否则,返回yii\log\Logger方法
         }
     }

设置日志记录方法:

 public static function setLogger($logger)
     {
         self::$_logger = $logger;//将传入的$logger赋值给静态变量$_logger
     }

日志记录trace信息方法:

 public static function trace($message, $category = 'application')//参数为trace信息和信息类型
     {
         if (YII_DEBUG) {//如果定义的YII_DEBUG
             static::getLogger()->log($message, Logger::LEVEL_TRACE, $category);//通过logger类中的log方法输出trace信息
         }
     }

日志记录error信息方法:

 public static function error($message, $category = 'application')//参数为错误信息和信息类型
     {
          }

操作信息日志:

 public static function info($message, $category = 'application')//参数为操作消息和消息类型
     {
         static::getLogger()->log($message, Logger::LEVEL_INFO, $category);//输出日志
     }

开始性能分析方法:

  public static function beginProfile($token, $category = 'application')
     {
         static::getLogger()->log($token, Logger::LEVEL_PROFILE_BEGIN, $category);//输出性能分析开始记录
     }

结束性能分析方法:

  public static function endProfile($token, $category = 'application')
     {
         static::getLogger()->log($token, Logger::LEVEL_PROFILE_END, $category);//输出性能分析结束记录
     }

输出power信息方法:

 public static function powered()
     {
         return \Yii::t('yii', 'Powered by {yii}', [
             'yii' => '<a href="http://www.yiiframework.com/" rel="external">' . \Yii::t('yii',
                     'Yii Framework') . '</a>'
         ]);//返回power by 信息
     }

短方法t(语言翻译方法):

 public static function t($category, $message, $params = [], $language = null)//\yii\i18n\I18N::translate()方法的短方法
     {
         if (static::$app !== null) {//如果 \yii\console\Application|yii\web\Application 实例为空
             return static::$app->getI18n()->translate($category, $message, $params, $language ?: static::$app->language);                 //调用translate()方法,用$params中的值替换$message中对应的值,$language为空,采用默认语言                                    
         } else {
             $p = [];
             foreach ((array) $params as $name => $value) {//否则,遍历$params
                 $p['{' . $name . '}'] = $value;//以$params 的名和值构建索引数组
             }

             return ($p === []) ? $message : strtr($message, $p);//如果构建的数组值为空,返回输入的信息,否则用构建的数组的值替换$message中的值然后返回
         }
     }

配置方法:

  public static function configure($object, $properties)
     {
         foreach ($properties as $name => $value) {
             $object->$name = $value;//将对象的属性按键值对的形式配置
         }

         return $object;
     }

返回对象中变量的方法:

public static function getObjectVars($object)
    {
        return get_object_vars($object);//返回某个对象中的公共属性
    }

BaseYii.php结束。