jimchen / yii2-facades
为 Yii 2 应用组件提供类似 Laravel 的 facade 支持
v2.0.0
2021-06-08 06:43 UTC
Requires
- php: >=5.4
- yiisoft/yii2: ~2.0
Requires (Dev)
- sergeymakinen/yii2-tests: ^2.2
This package is auto-updated.
Last update: 2024-09-08 13:42:56 UTC
README
为 Yii 2 应用组件提供类似 Laravel 的 facade 支持。这正是你所需要的:简单、全面,并支持通过 PHPDoc 的 IDE 自动完成,所以你不会失望。
目录
安装
安装此扩展的最佳方式是通过 composer。
运行
composer require jimchen/yii2-facades
使用
基本上,您安装扩展并开始像使用所有正常的 Yii 2 应用组件一样使用它,但语法更简短、更简单,让我们看看(如果您想知道,所有默认 facade,包括抽象基类 Facade
,都位于 jimchen\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)
可用的 facade
辅助工具
一些 facade 也包含有用的辅助工具,可以让开发更快速、更优雅。
缓存
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 = [])
返回一个带数据 "as is" 和可选头部的响应
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 ]); }
扩展
如果您想要一个新的 facade,它既快又简单,想象一下您想要引入一个 YourFacadeName
facade
class YourFacadeName extends Facade { /** * @inheritdoc */ public static function getFacadeComponentId() { return 'yourFacadeComponentName'; // Yii::$app->yourFacadeComponentName } }
那么,每次您调用
YourFacadeName::hello('world');
它将按以下方式执行
Yii::$app->get('yourFacadeComponentName')->hello('world');