Фасады

Статистика: Символов — 7 140/6 212 без пробелов (5 697/4 966 без кода):, слов — 732
Разметка: Wiki
{{TOC}}

{{DOCVER 4.0=0da300f6445bec5a70d007f503834fce957b065b 16.10.2014 5:19:26, 4.1=efd541a0b218b1c6aafb73f0051c18ed150e3c24 25.05.2014 6:21:03, 4.2=d7b13440c003218ed79e9d508706eca01990122f 4.12.2014 5:01:15}}

== Введение ==
Фасады предоставляют "статический" интерфейс к классам, доступным в ((docs/v4/ioc контейнере IoC)). Laravel поставляется со множеством фасадов и вы, вероятно, использовали их, даже не подозревая об этом. "Фасады" Laravel служат "статическими прокси" для классов в IoC-контейнере, обеспечивая преимущества краткого выразительного синтаксиса, и поддерживая большую тестируемость и гибкость, чем традиционные статические методы.

Иногда вам может понадобиться создать собственные фасады для вашего приложения и ((docs/v4/packages пакетов)), поэтому давайте изучим идею, разработку и использование этих классов.

.(alert)
**Внимание:** перед погружением в фасады настоятельно рекомендуется как можно детальнее изучить ((docs/v4/ioc контейнер IoC)).

== Описание ==
В контексте приложения на Laravel, фасад - это класс, который предоставляет доступ к объекту в контейнере. Весь этот механизм реализован в классе %%Facade%%. Фасады как Laravel, так и ваши собственные, наследуют этот базовый класс.

Ваш фасад должен определить единственный метод: %%getFacadeAccessor()%%. Его задача - определить, что вы хотите получить из контейнера. Класс %%Facade%% использует ((phpdoc:language.oop5.overloading магический метод PHP)) **~__callStatic()** для перенаправления вызовов методов с вашего фасада на полученный объект.

Таким образом, когда вы делаете вызов фасада %%Cache::get%%, Laravel извлекает класс управления кэшем из IoC-контейнера и вызывает метод %%get%% на класс. С технической точки зрения, фасады Laravel - удобный синтаксис для использования IoC-контейнера Laravel в качестве локатора служб.

== Практическое использование ==
В примере ниже делается обращение к механизму кэширования Laravel. На первый взгляд может показаться, что метод %%get()%% принадлежит классу %%Cache%%:
%%
  $value = Cache::get('key');
%%

Однако, если вы посмотрите в исходный код класса %%Illuminate\Support\Facades\Cache%%, то увидите, что он не содержит метода %%get()%%:
%%
  class Cache extends Facade {

    /**
     * Получить зарегистрированное имя компонента.
     *
     * @return string
     */
    protected static function getFacadeAccessor() { return 'cache'; }

  }
%%

Класс %%Cache%% наследует класс %%Facade%% и определяет метод %%getFacadeAccessor()%%. Как вы помните, его задача - вернуть имя //привязки// (типа) в ((docs/v4/ioc контейнере IoC)).

Когда вы обращаетесь к любому статическому методу фасада %%Cache%%, Laravel получает объект %%(t)cache%% из IoC и вызывает на нём требуемый метод (в этом случае - %%get()%%).

Таким образом, вызов %%Cache::get()%% может быть записан так:
%%
  $value = $app->make('cache')->get('key');
%%

== Создание фасадов ==
Создать фасад в вашем приложении или ((docs/v4/packages пакете)) довольно просто. Вам нужны только три вещи:
  1. Связка в ((docs/v4/ioc IoC)).
  1. Класс-фасад.
  1. Настройка для псевдонима фасада.

Посмотрим на следующий пример. Здесь определён класс %%PaymentGateway\Payment%%.
%%
  namespace PaymentGateway;

  class Payment {

    public function process()
    {
      //
    }

  }
%%

Этот класс может находиться в вашем каталоге %%(t)app/models%% или в любом другом каталоге, который добавлен в автозагрузку Composer.

Нам нужно, чтобы этот класс извлекался из контейнера IoC, так что давайте добавим для него привязку (//binding//):
%%
  App::bind('payment', function () {
    return new \PaymentGateway\Payment;
  });
%%

Самое лучшее место для регистрации этой связки - новый ((docs/v4/ioc#поставщики поставщик услуг)), который мы назовём %%PaymentServiceProvider%% и в котором мы создадим метод %%register()%%, содержащий код выше. После этого вы можете настроить Laravel для загрузки этого поставщика в файле %%(t)app/config/app.php%%.

Дальше мы можем написать класс нашего фасада:

%%
  use Illuminate\Support\Facades\Facade;

  class Payment extends Facade {

    protected static function getFacadeAccessor() { return 'payment'; }

  }
%%

Наконец, по желанию можно добавить псевдоним (//alias//) для этого фасада в массив **aliases** файла настроек %%(t)app/config/app.php%% - тогда мы сможем вызывать метод %%process()%% на классе %%Payment%%:
%%
  Payment::process();
%%

== Об автозагрузке псевдонимов ==
В некоторых случаях классы в массиве **aliases** не доступны из-за того, что ((https://bugs.php.net/bug.php?id=39003 PHP не загружает неизвестные классы в подсказках типов)). Если %%\ServiceWrapper\ApiTimeoutException%% имеет псевдоним %%ApiTimeoutException%%, то блок %%try ... catch (ApiTimeoutException $e)%%, помещённый в любое пространство имён, кроме %%ServiceWrapper%%, никогда не "поймает" это исключение, даже если оно было возбуждено внутри него. Аналогичная проблема возникает в моделях, которые содержат подсказки типов на неизвестные (неопределённые) классы. Единственное решение - не использовать псевдонимы и вместо них в начале каждого файла писать %%use ... as%% для классов, которые вы хотите использовать в подсказках типов.

== Фасады-заглушки ==
((docs/v4/testing Юнит-тесты)) играют важную роль в том, почему фасады делают именно то, что они делают. На самом деле возможность тестирования - основная причина, по которой фасады вообще существуют. Эта тема подробнее раскрыта в ((docs/v4/testing#фасады-заглушки соответствующем разделе документации)).

== Соответствие фасадов и классов ==
В таблице ниже перечислены все фасады и соответствующие им классы. Это полезный инструмент для быстрого начала работы с документацией по API данного корня фасадов. Также указаны ключи ((/docs/v4/ioc привязки IoC)), где это нужно.
%%(hvlraw)
  <table>
   <tr>
    <th>Фасад</th>
    <th>Класс</th>
    <th>Привязка IoC</th>
   </tr>
   <tr><td>App </td><td><a href=http://laravel.com/api/4.2/Illuminate/Foundation/Application.html>Illuminate\Foundation\Application</a></td><td>app</td></tr>
   <tr><td>Artisan </td><td><a href=http://laravel.com/api/4.2/Illuminate/Console/Application.html>Illuminate\Console\Application</a></td><td>artisan</td></tr>
   <tr><td>Auth</td><td><a href=http://laravel.com/api/4.2/Illuminate/Auth/AuthManager.html>Illuminate\Auth\AuthManager</a></td><td>auth</td></tr>
   <tr><td>Auth (экземпляр)</td><td><a href=http://laravel.com/api/4.2/Illuminate/Auth/Guard.html>Illuminate\Auth\Guard</a></td><td></td></tr>
   <tr><td>Blade</td><td><a href=http://laravel.com/api/4.2/Illuminate/View/Compilers/BladeCompiler.html>Illuminate\View\Compilers\BladeCompiler</a></td><td>blade.compiler</td></tr>
   <tr><td>Cache</td><td><a href=http://laravel.com/api/4.2/Illuminate/Cache/Repository.html>Illuminate\Cache\Repository</a></td><td>cache</td></tr>
   <tr><td>Config</td><td><a href=http://laravel.com/api/4.2/Illuminate/Config/Repository.html>Illuminate\Config\Repository</a></td><td>config</td></tr>
   <tr><td>Cookie</td><td><a href=http://laravel.com/api/4.2/Illuminate/Cookie/CookieJar.html>Illuminate\Cookie\CookieJar</a></td><td>cookie</td></tr>
   <tr><td>Crypt</td><td><a href=http://laravel.com/api/4.2/Illuminate/Encryption/Encrypter.html>Illuminate\Encryption\Encrypter</a></td><td>encrypter</td></tr>
   <tr><td>DB</td><td><a href=http://laravel.com/api/4.2/Illuminate/Database/DatabaseManager.html>Illuminate\Database\DatabaseManager</a></td><td>db</td></tr>
   <tr><td>DB (экземпляр)</td><td><a href=http://laravel.com/api/4.2/Illuminate/Database/Connection.html>Illuminate\Database\Connection</a></td><td></td></tr>
   <tr><td>Event</td><td><a href=http://laravel.com/api/4.2/Illuminate/Events/Dispatcher.html>Illuminate\Events\Dispatcher</a></td><td>events</td></tr>
   <tr><td>File</td><td><a href=http://laravel.com/api/4.2/Illuminate/Filesystem/Filesystem.html>Illuminate\Filesystem\Filesystem</a></td><td>files</td></tr>
   <tr><td>Form</td><td><a href=http://laravel.com/api/4.2/Illuminate/Html/FormBuilder.html>Illuminate\Html\FormBuilder</a></td><td>form</td></tr>
   <tr><td>Hash</td><td><a href=http://laravel.com/api/4.2/Illuminate/Hashing/HasherInterface.html>Illuminate\Hashing\HasherInterface</a></td><td>hash</td></tr>
   <tr><td>HTML</td><td><a href=http://laravel.com/api/4.2/Illuminate/Html/HtmlBuilder.html>Illuminate\Html\HtmlBuilder</a></td><td>html</td></tr>
   <tr><td>Input</td><td><a href=http://laravel.com/api/4.2/Illuminate/Http/Request.html>Illuminate\Http\Request</a></td><td>request</td></tr>
   <tr><td>Lang</td><td><a href=http://laravel.com/api/4.2/Illuminate/Translation/Translator.html>Illuminate\Translation\Translator</a></td><td>translator</td></tr>
   <tr><td>Log</td><td><a href=http://laravel.com/api/4.2/Illuminate/Log/Writer.html>Illuminate\Log\Writer</a></td><td>log</td></tr>
   <tr><td>Mail</td><td><a href=http://laravel.com/api/4.2/Illuminate/Mail/Mailer.html>Illuminate\Mail\Mailer</a></td><td>mailer</td></tr>
   <tr><td>Paginator</td><td><a href=http://laravel.com/api/4.2/Illuminate/Pagination/Environment.html>Illuminate\Pagination\Environment</a></td><td>paginator</td></tr>
   <tr><td>Paginator (экземпляр)</td><td><a href=http://laravel.com/api/4.2/Illuminate/Pagination/Paginator.html>Illuminate\Pagination\Paginator</a></td><td></td></tr>
   <tr><td>Password</td><td><a href=http://laravel.com/api/4.2/Illuminate/Auth/Reminders/PasswordBroker.html>Illuminate\Auth\Reminders\PasswordBroker</a></td><td>auth.reminder</td></tr>
   <tr><td>Queue</td><td><a href=http://laravel.com/api/4.2/Illuminate/Queue/QueueManager.html>Illuminate\Queue\QueueManager</a></td><td>queue</td></tr>
   <tr><td>Queue (экземпляр)</td><td><a href=http://laravel.com/api/4.2/Illuminate/Queue/QueueInterface.html>Illuminate\Queue\QueueInterface</a></td><td></td></tr>
   <tr><td>Queue (базовый класс)</td><td><a href=http://laravel.com/api/4.2/Illuminate/Queue/Queue.html>Illuminate\Queue\Queue</a></td><td></td></tr>
   <tr><td>Redirect</td><td><a href=http://laravel.com/api/4.2/Illuminate/Routing/Redirector.html>Illuminate\Routing\Redirector</a></td><td>redirect</td></tr>
   <tr><td>Redis</td><td><a href=http://laravel.com/api/4.2/Illuminate/Redis/Database.html>Illuminate\Redis\Database</a></td><td>redis</td></tr>
   <tr><td>Request</td><td><a href=http://laravel.com/api/4.2/Illuminate/Http/Request.html>Illuminate\Http\Request</a></td><td>request</td></tr>
   <tr><td>Response</td><td><a href=http://laravel.com/api/4.2/Illuminate/Support/Facades/Response.html>Illuminate\Support\Facades\Response</a></td><td></td></tr>
   <tr><td>Route</td><td><a href=http://laravel.com/api/4.2/Illuminate/Routing/Router.html>Illuminate\Routing\Router</a></td><td>router</td></tr>
   <tr><td>Schema</td><td><a href=http://laravel.com/api/4.2/Illuminate/Database/Schema/Blueprint.html>Illuminate\Database\Schema\Blueprint</a></td><td></td></tr>
   <tr><td>Session</td><td><a href=http://laravel.com/api/4.2/Illuminate/Session/SessionManager.html>Illuminate\Session\SessionManager</a></td><td>session</td></tr>
   <tr><td>Session (экземпляр)</td><td><a href=http://laravel.com/api/4.2/Illuminate/Session/Store.html>Illuminate\Session\Store</a></td><td></td></tr>
   <tr><td>SSH</td><td><a href=http://laravel.com/api/4.2/Illuminate/Remote/RemoteManager.html>Illuminate\Remote\RemoteManager</a></td><td>remote</td></tr>
   <tr><td>SSH (экземпляр)</td><td><a href=http://laravel.com/api/4.2/Illuminate/Remote/Connection.html>Illuminate\Remote\Connection</a></td><td></td></tr>
   <tr><td>URL</td><td><a href=http://laravel.com/api/4.2/Illuminate/Routing/UrlGenerator.html>Illuminate\Routing\UrlGenerator</a></td><td>url</td></tr>
   <tr><td>Validator</td><td><a href=http://laravel.com/api/4.2/Illuminate/Validation/Factory.html>Illuminate\Validation\Factory</a></td><td>validator</td></tr>
   <tr><td>Validator (экземпляр)</td><td><a href=http://laravel.com/api/4.2/Illuminate/Validation/Validator.html>Illuminate\Validation\Validator</a></td><td></td></tr>
   <tr><td>View</td><td><a href=http://laravel.com/api/4.2/Illuminate/View/Environment.html>Illuminate\View\Environment</a></td><td>view</td></tr>
   <tr><td>View (экземпляр)</td><td><a href=http://laravel.com/api/4.2/Illuminate/View/View.html>Illuminate\View\View</a></td><td></td></tr>
  </table>
%%