{"id":15177293,"url":"https://github.com/sergeymakinen/yii2-facades","last_synced_at":"2025-10-01T16:31:06.531Z","repository":{"id":62542452,"uuid":"64790875","full_name":"sergeymakinen/yii2-facades","owner":"sergeymakinen","description":"Facades for Yii 2","archived":true,"fork":false,"pushed_at":"2019-09-19T18:06:53.000Z","size":131,"stargazers_count":22,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-20T21:09:50.385Z","etag":null,"topics":["closure","facade","facades","laravel","php","php-library","yii","yii2","yii2-extension"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sergeymakinen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-02T20:37:00.000Z","updated_at":"2023-12-21T13:16:50.000Z","dependencies_parsed_at":"2022-11-02T15:46:24.249Z","dependency_job_id":null,"html_url":"https://github.com/sergeymakinen/yii2-facades","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeymakinen%2Fyii2-facades","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeymakinen%2Fyii2-facades/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeymakinen%2Fyii2-facades/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sergeymakinen%2Fyii2-facades/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sergeymakinen","download_url":"https://codeload.github.com/sergeymakinen/yii2-facades/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234882630,"owners_count":18901301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["closure","facade","facades","laravel","php","php-library","yii","yii2","yii2-extension"],"created_at":"2024-09-27T14:20:32.036Z","updated_at":"2025-10-01T16:31:06.113Z","avatar_url":"https://github.com/sergeymakinen.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Facades for Yii 2\n\nLaravel like facades support for Yii 2 application components. Just what you want: simple, extensive and with an IDE auto completion support via [PHPDoc](https://www.phpdoc.org) so you won't be disappointed.\n\n[![Code Quality](https://img.shields.io/scrutinizer/g/sergeymakinen/yii2-facades.svg?style=flat-square)](https://scrutinizer-ci.com/g/sergeymakinen/yii2-facades) [![Build Status](https://img.shields.io/travis/sergeymakinen/yii2-facades.svg?style=flat-square)](https://travis-ci.org/sergeymakinen/yii2-facades) [![Code Coverage](https://img.shields.io/codecov/c/github/sergeymakinen/yii2-facades.svg?style=flat-square)](https://codecov.io/gh/sergeymakinen/yii2-facades) [![SensioLabsInsight](https://img.shields.io/sensiolabs/i/3d6f8afa-4baf-40df-9923-2053ece59b7c.svg?style=flat-square)](https://insight.sensiolabs.com/projects/3d6f8afa-4baf-40df-9923-2053ece59b7c)\n\n[![Packagist Version](https://img.shields.io/packagist/v/sergeymakinen/yii2-facades.svg?style=flat-square)](https://packagist.org/packages/sergeymakinen/yii2-facades) [![Total Downloads](https://img.shields.io/packagist/dt/sergeymakinen/yii2-facades.svg?style=flat-square)](https://packagist.org/packages/sergeymakinen/yii2-facades) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)\n\n## Table of contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n  * [Generate random string](#generate-random-string)\n  * [Fetch all users (just an example!)](#fetch-all-users-just-an-example)\n  * [Format currency](#format-currency)\n- [Access properties](#access-properties)\n- [Available facades](#available-facades)\n- [Helpers](#helpers)\n  * [Cache](#cache)\n    + [cache](#cache)\n    + [get](#get)\n  * [Response](#response)\n    + [bare](#bare)\n    + [html](#html)\n    + [json](#json)\n    + [jsonp](#jsonp)\n    + [raw](#raw)\n    + [xml](#xml)\n- [Extending](#extending)\n\n## Installation\n\nThe preferred way to install this extension is through [composer](https://getcomposer.org/download/).\n\nEither run\n\n```bash\ncomposer require \"sergeymakinen/yii2-facades:^1.0\"\n```\n\nor add\n\n```json\n\"sergeymakinen/yii2-facades\": \"^1.0\"\n```\n\nto the require section of your `composer.json` file.\n\n## Usage\n\nBasically 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):\n\n### Generate random string\n\nBefore:\n\n```php\n$random = Yii::$app-\u003esecurity-\u003egenerateRandomString(128);\n```\n\nAfter:\n\n```php\n$random = Security::generateRandomString(128);\n```\n\n### Fetch all users (just an example!)\n\nBefore:\n\n```php\n$users = Yii::$app-\u003edb-\u003ecreateCommand('SELECT * FROM users;')-\u003equeryAll();\n```\n\nAfter:\n\n```php\n$users = Db::createCommand('SELECT * FROM users;')-\u003equeryAll();\n```\n\n### Format currency\n\nBefore:\n\n```php\n$price = Yii::$app-\u003eformatter-\u003easCurrency(123456.78, 'USD');\n```\n\nAfter:\n\n```php\n$price = Formatter::asCurrency(123456.78, 'USD');\n```\n\n## Access properties\n\nAny class public property `$foo` can be got via an accessor:\n\n```php\n$value = YourFacadeName::getFoo()\n```\nAnd set:\n\n```php\nYourFacadeName::setFoo($value)\n```\n## Available facades\n\n\u003ctable\u003e\n\u003cthead\u003e\n\u003cth\u003eName\u003c/th\u003e\n\u003cth\u003eFacaded component alias\u003c/th\u003e\n\u003cth\u003eComponent/interface\u003c/th\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eAsset\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003eassetManager\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\web\\AssetManager\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eAuth\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003eauth\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\rbac\\ManagerInterface\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eCache\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003ecache\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\caching\\Cache\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eDb\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003edb\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\db\\Connection\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd rowspan=\"2\"\u003e\u003ccode\u003eError\u003c/code\u003e\u003c/td\u003e\n\u003ctd rowspan=\"2\"\u003e\u003ccode\u003eYii::$app-\u003eerrorHandler\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\console\\ErrorHandler\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\web\\ErrorHandler\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eFormatter\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003eformatter\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\i18n\\Formatter\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eHttp\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003ehttpClient\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\httpclient\\Client\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eI18n\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003ei18n\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\i18n\\I18N\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eLog\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003elog\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\log\\Dispatcher\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eMailer\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003emailer\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\swiftmailer\\Mailer\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eRedis\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003eredis\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\redis\\Connection\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd rowspan=\"2\"\u003e\u003ccode\u003eRequest\u003c/code\u003e\u003c/td\u003e\n\u003ctd rowspan=\"2\"\u003e\u003ccode\u003eYii::$app-\u003erequest\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\console\\Request\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\web\\Request\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd rowspan=\"2\"\u003e\u003ccode\u003eResponse\u003c/code\u003e\u003c/td\u003e\n\u003ctd rowspan=\"2\"\u003e\u003ccode\u003eYii::$app-\u003eresponse\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\console\\Response\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\web\\Response\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eRouter\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003eurlManager\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\web\\UrlManager\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eSecurity\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003esecurity\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\base\\Security\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eSession\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003esession\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\web\\Session\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eUrl\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003eurlManager\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\web\\UrlManager\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eUser\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003euser\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\web\\User\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ccode\u003eView\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eYii::$app-\u003eview\u003c/code\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eyii\\web\\View\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\n## Helpers\n\nSome facades also contain useful helpers to make a development more quick and elegant.\n\n### Cache\n\n#### cache\n\n```php\npublic static function cache($key, $default, $duration = 0, $dependency = null)\n```\n\nRetrieves 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:\n\n```php\n$users = Cache::cache('users', function () {\n    return app\\models\\Users::findAll();\n}, 3600);\n```\n\n#### get\n\n```php\npublic static function get($key, $default = false)\n```\n\nRetrieves a value using the provided key and returns it or the specified default value which can also be a closure:\n\n```php\n$options = Cache::get('options', function () {\n    return [\n        'option1' =\u003e false,\n        'option2' =\u003e true\n    ];\n});\n```\n\n### Response\n\n#### bare\n\n```php\npublic static function bare($statusCode = 204, array $headers = [])\n```\n\nReturns an empty response with optional headers:\n\n```php\npublic function actionCreate()\n{\n    // ...\n    return Response::bare(201);\n}\n```\n\n#### html\n\n```php\npublic static function html($data, array $headers = [])\n```\n\nReturns a HTML response with optional headers:\n\n```php\npublic function actionIndex()\n{\n    // ...\n    return Response::html($this-\u003erender('index'), [\n        'Cache-Control' =\u003e 'no-cache'\n    ]);\n}\n```\n\n#### json\n\n```php\npublic static function json($data, array $headers = [])\n```\n\nReturns a JSON response with optional headers:\n\n```php\npublic function actionList()\n{\n    // ...\n    return Response::json(Db::createCommand('SELECT * FROM users')-\u003eall());\n}\n```\n\n#### jsonp\n\n```php\npublic static function jsonp($data, $callback = 'callback', array $headers = [])\n```\n\nReturns a JSONP response with optional headers:\n\n```php\npublic function actionApi($callback)\n{\n    // ...\n    return Response::jsonp([\n        'success' =\u003e true,\n        'response' =\u003e $data\n    ], $callback);\n}\n```\n\n#### raw\n\n```php\npublic static function raw($data, array $headers = [])\n```\n\nReturns a response with data \"as is\" with optional headers:\n\n```php\npublic function actionCreate()\n{\n    // ...\n    return Response::raw($binary, [\n        'Content-Type' =\u003e 'application/octet-stream'\n    ]);\n}\n```\n\n#### xml\n\n```php\npublic static function xml($data, array $headers = [])\n```\n\nReturns a XML response with optional headers:\n\n```php\npublic function actionCreate()\n{\n    // ...\n    return Response::xml([\n        'success' =\u003e true,\n        'response' =\u003e $data\n    ]);\n}\n```\n\n## Extending\n\nIf you want a new facade, it's fast and easy, imagine you want to bring a `YourFacadeName` facade:\n\n```php\nclass YourFacadeName extends Facade\n{\n    /**\n     * @inheritdoc\n     */\n    public static function getFacadeComponentId()\n    {\n        return 'yourFacadeComponentName'; // Yii::$app-\u003eyourFacadeComponentName\n    }\n}\n```\n\nThen whenever you call\n\n```php\nYourFacadeName::hello('world');\n```\n\nit will be executed as\n\n```php\nYii::$app-\u003eget('yourFacadeComponentName')-\u003ehello('world');\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsergeymakinen%2Fyii2-facades","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsergeymakinen%2Fyii2-facades","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsergeymakinen%2Fyii2-facades/lists"}