README

Laravel 类似的门面支持为 Yii 2 应用组件。正是您想要的：简单、全面，并支持通过 PHPDoc 的 IDE 自动完成，因此您不会失望。

目录

• 安装
• 使用
  • 生成随机字符串
  • 获取所有用户（仅示例！）
  • 货币格式化
• 访问属性
• 可用的门面
• 助手
  • 缓存
    • cache
    • get
  • 响应
    • bare
    • html
    • json
    • jsonp
    • raw
    • xml
• 扩展

安装

安装此扩展的首选方法是通过 composer。

运行

composer require "sergeymakinen/yii2-facades:^1.0"

或在您的 composer.json 文件的 require 部分中添加

"sergeymakinen/yii2-facades": "^1.0"

使用

基本上，您安装扩展并像使用所有正常的 Yii 2 应用组件一样使用它，但语法更简短、更简单。让我们看看（如果您好奇，所有默认门面，包括抽象基类 Facade，都位于 sergeymakinen\facades 命名空间下）

生成随机字符串

之前

$random = Yii::$app->security->generateRandomString(128);

之后

$random = Security::generateRandomString(128);

获取所有用户（仅示例！）

之前

$users = Yii::$app->db->createCommand('SELECT * FROM users;')->queryAll();

之后

$users = Db::createCommand('SELECT * FROM users;')->queryAll();

格式化货币

之前

$price = Yii::$app->formatter->asCurrency(123456.78, 'USD');

之后

$price = Formatter::asCurrency(123456.78, 'USD');

访问属性

任何类的公共属性 $foo 都可以通过访问器获取

$value = YourFacadeName::getFoo()

并设置

YourFacadeName::setFoo($value)

可用的门面

辅助工具

一些外观也包含有用的辅助工具，可以使得开发更加快速和优雅。

缓存

cache

public static function cache($key, $default, $duration = 0, $dependency = null)

使用提供的键获取值，如果值不在缓存中，将返回指定的默认值。如果值不在缓存中，它将被缓存。默认值也可以是一个闭包

$users = Cache::cache('users', function () {
    return app\models\Users::findAll();
}, 3600);

get

public static function get($key, $default = false)

使用提供的键获取值，并返回它或指定的默认值，该默认值也可以是一个闭包

$options = Cache::get('options', function () {
    return [
        'option1' => false,
        'option2' => true
    ];
});

响应

bare

public static function bare($statusCode = 204, array $headers = [])

返回一个包含可选头的空响应

public function actionCreate()
{
    // ...
    return Response::bare(201);
}

html

public static function html($data, array $headers = [])

返回一个包含可选头的HTML响应

public function actionIndex()
{
    // ...
    return Response::html($this->render('index'), [
        'Cache-Control' => 'no-cache'
    ]);
}

json

public static function json($data, array $headers = [])

返回一个包含可选头的JSON响应

public function actionList()
{
    // ...
    return Response::json(Db::createCommand('SELECT * FROM users')->all());
}

jsonp

public static function jsonp($data, $callback = 'callback', array $headers = [])

返回一个包含可选头的JSONP响应

public function actionApi($callback)
{
    // ...
    return Response::jsonp([
        'success' => true,
        'response' => $data
    ], $callback);
}

raw

public static function raw($data, array $headers = [])

返回一个包含数据“原样”和可选头的响应

public function actionCreate()
{
    // ...
    return Response::raw($binary, [
        'Content-Type' => 'application/octet-stream'
    ]);
}

xml

public static function xml($data, array $headers = [])

返回一个包含可选头的XML响应

public function actionCreate()
{
    // ...
    return Response::xml([
        'success' => true,
        'response' => $data
    ]);
}

扩展

如果您想创建一个新的外观，这很快也很容易，想象一下您想引入一个 YourFacadeName 外观

class YourFacadeName extends Facade
{
    /**
     * @inheritdoc
     */
    public static function getFacadeComponentId()
    {
        return 'yourFacadeComponentName'; // Yii::$app->yourFacadeComponentName
    }
}

然后每次您调用

YourFacadeName::hello('world');

它将按以下方式执行

Yii::$app->get('yourFacadeComponentName')->hello('world');