Package Data | |
---|---|
Maintainer Username: | ytubes |
Maintainer Contact: | sergey@makinen.ru (Sergey Makinen) |
Package Create Date: | 2017-07-04 |
Package Last Update: | 2017-07-04 |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-11-08 03:05:06 |
Package Statistics | |
---|---|
Total Downloads: | 4 |
Monthly Downloads: | 0 |
Daily Downloads: | 0 |
Total Stars: | 0 |
Total Watchers: | 1 |
Total Forks: | 0 |
Total Open Issues: | 0 |
Laravel like facades support for Yii 2 application components. Just what you want: simple, extensive and with an IDE auto completion support via PHPDoc so you won't be disappointed.
The preferred way to install this extension is through composer.
Either run
composer require "ytubes/facades:>=0.0.1"
or add
"ytubes/facades": ">=0.0.1"
to the require section of your composer.json
file.
Basically you install the extension and start using it like you do with all normal Yii 2 application components but with a shorter simpler syntax, let's take a look (in case you wonder, all default facades, including an abstract base Facade
reside under a sergeymakinen\facades
namespace):
Before:
$random = Yii::$app->security->generateRandomString(128);
After:
$random = Security::generateRandomString(128);
Before:
$users = Yii::$app->db->createCommand('SELECT * FROM users;')->queryAll();
After:
$users = Db::createCommand('SELECT * FROM users;')->queryAll();
Before:
$price = Yii::$app->formatter->asCurrency(123456.78, 'USD');
After:
$price = Formatter::asCurrency(123456.78, 'USD');
Any class public property $foo
can be got via an accessor:
$value = YourFacadeName::getFoo()
And set:
YourFacadeName::setFoo($value)
Some facades also contain useful helpers to make a development more quick and elegant.
public static function cache($key, $default, $duration = 0, $dependency = null)
Retrieves a value using the provided key or the specified default value if the value is not cached. If the value is not in the cache, it will be cached. The default value can also be a closure:
$users = Cache::cache('users', function () {
return app\models\Users::findAll();
}, 3600);
public static function get($key, $default = false)
Retrieves a value using the provided key and returns it or the specified default value which can also be a closure:
$options = Cache::get('options', function () {
return [
'option1' => false,
'option2' => true
];
});
public static function bare($statusCode = 204, array $headers = [])
Returns an empty response with optional headers:
public function actionCreate()
{
// ...
return Response::bare(201);
}
public static function html($data, array $headers = [])
Returns a HTML response with optional headers:
public function actionIndex()
{
// ...
return Response::html($this->render('index'), [
'Cache-Control' => 'no-cache'
]);
}
public static function json($data, array $headers = [])
Returns a JSON response with optional headers:
public function actionList()
{
// ...
return Response::json(Db::createCommand('SELECT * FROM users')->all());
}
public static function jsonp($data, $callback = 'callback', array $headers = [])
Returns a JSONP response with optional headers:
public function actionApi($callback)
{
// ...
return Response::jsonp([
'success' => true,
'response' => $data
], $callback);
}
public static function raw($data, array $headers = [])
Returns a response with data "as is" with optional headers:
public function actionCreate()
{
// ...
return Response::raw($binary, [
'Content-Type' => 'application/octet-stream'
]);
}
public static function xml($data, array $headers = [])
Returns a XML response with optional headers:
public function actionCreate()
{
// ...
return Response::xml([
'success' => true,
'response' => $data
]);
}
If you want a new facade, it's fast and easy, imagine you want to bring a YourFacadeName
facade:
class YourFacadeName extends Facade
{
/**
* @inheritdoc
*/
public static function getFacadeComponentId()
{
return 'yourFacadeComponentName'; // Yii::$app->yourFacadeComponentName
}
}
Then whenever you call
YourFacadeName::hello('world');
it will be executed as
Yii::$app->get('yourFacadeComponentName')->hello('world');