События

Однако, также вы можете вручную регистрировать события на основе замыканий в методе PHPboot() вашего EventServiceProvider:

/**
 * Регистрация своих событий в приложении.
 *
 * @return void
 */
public function boot()
{
  parent::boot();

  Event::listen('event.name', function ($foo, $bar) {
    //
  });
}

Однако, также вы можете регистрировать события вручную с обработчиком событий, используя либо фасад Event, либо реализацию контракта Illuminate\Contracts\Events\Dispatcher

/**
 * Регистрация своих событий в приложении.
 *
 * @param  \Illuminate\Contracts\Events\Dispatcher  $events
 * @return void
 */
public function boot(DispatcherContract $events)
{
  parent::boot($events);

  $events->listen('event.name', function ($foo, $bar) {
    //
  });
}

Например, предположим, что наше сгенерированное событие OrderShipped принимает объект Eloquent ORM:

<?php

namespace App\Events;

use App\Order;
use Illuminate\Queue\SerializesModels;

class OrderShipped
{
  use SerializesModels;

  public $order;

  /**
   * Создание нового экземпляра события.
   *
   * @param  Order  $order
   * @return void
   */
  public function __construct(Order $order)
  {
    $this->order = $order;
  }
}

Как видите, этот класс события не содержит никакой логики. Это просто контейнер для объекта Order. Типаж SerializesModels, используемый событием, корректно сериализирует любые Eloquent модели, если объект события будет сериализирован php-функцией PHPserialize().

Например, предположим, что наше сгенерированное событие PodcastWasPurchased принимает объект Eloquent ORM:

<?php

namespace App\Events;

use App\Podcast;
use App\Events\Event;
use Illuminate\Queue\SerializesModels;

class PodcastWasPurchased extends Event
{
  use SerializesModels;

  public $podcast;

  /**
   * Создание нового экземпляра события.
   *
   * @param  Podcast  $podcast
   * @return void
   */
  public function __construct(Podcast $podcast)
  {
    $this->podcast = $podcast;
  }
}

Как видите, этот класс события не содержит никакой логики. Это просто контейнер для объекта Podcast. Типаж SerializesModels, используемый событием, корректно сериализирует любые Eloquent модели, если объект события будет сериализирован php-функцией PHPserialize().

<?php

namespace App\Listeners;

use App\Events\OrderShipped;

class SendShipmentNotification
{
  /**
   * Создание слушателя события.
   *
   * @return void
   */
  public function __construct()
  {
    //
  }

  /**
   * Обработка события.
   *
   * @param  OrderShipped  $event
   * @return void
   */
  public function handle(OrderShipped $event)
  {
    // Доступ к order, используя $event->order...
  }
}

Ваши слушатели события могут также указывать тип любых зависимостей, которые необходимы для их конструкторов. Все слушатели события доступны через сервис-контейнер Laravel, поэтому зависимости будут инъецированы автоматически.

<?php

namespace App\Listeners;

use App\Events\PodcastWasPurchased;
// для версии 5.1 и ранее:
// use Illuminate\Queue\InteractsWithQueue;
// use Illuminate\Contracts\Queue\ShouldQueue;

class EmailPurchaseConfirmation
{
  /**
   * Создание слушателя события.
   *
   * @return void
   */
  public function __construct()
  {
    //
  }

  /**
   * Обработка события.
   *
   * @param  PodcastWasPurchased  $event
   * @return void
   */
  public function handle(PodcastWasPurchased $event)
  {
    // Доступ к podcast, используя $event->podcast...
  }
}

Ваши слушатели события могут также указывать тип любых зависимостей, которые необходимы для их конструкторов. Все слушатели события доступны через сервис-контейнер Laravel, поэтому зависимости будут инъецированы автоматически:

use Illuminate\Contracts\Mail\Mailer;

public function __construct(Mailer $mailer)
{
  $this->mailer = $mailer;
}

Чтобы запустить событие, вы можете передать экземпляр события во вспомогательный метод PHPevent(). Этот метод распространит событие для всех его зарегистрированных слушателей. Поскольку метод PHPevent() доступен глобально, вы можете вызвать его из любого места вашего приложения:

<?php

namespace App\Http\Controllers;

use App\Order;
use App\Events\OrderShipped;
use App\Http\Controllers\Controller;

class OrderController extends Controller
{
  /**
   * Доставка данного заказа.
   *
   * @param  int  $orderId
   * @return Response
   */
  public function ship($orderId)
  {
    $order = Order::findOrFail($orderId);

    // Логика доставки заказа...

    event(new OrderShipped($order));
  }
}

При тестировании может быть полезным проверка запуска некоторых событий без уведомления их слушателей. в этом вам помогут встроенные вспомогательные функции для тестирования Laravel.

Чтобы запустить событие, вы можете использовать фасад Event, передав экземпляр события методу PHPfire(). Метод PHPfire() распространит событие для всех его зарегистрированных слушателей:

<?php

namespace App\Http\Controllers;

use Event;
use App\Podcast;
use App\Events\PodcastWasPurchased;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
  /**
   * Показать профиль заданного пользователя.
   *
   * @param  int  $userId
   * @param  int  $podcastId
   * @return Response
   */
  public function purchasePodcast($userId, $podcastId)
  {
    $podcast = Podcast::findOrFail($podcastId);

    // Логика покупки podcast...

    Event::fire(new PodcastWasPurchased($podcast));
  }
}

Также вы можете использовать глобальную вспомогательную функцию PHPevent() для запуска события:

event(new PodcastWasPurchased($podcast));

Широковещательные события

Во многих современных веб-приложениях используются веб-сокеты, чтобы реализовать быстро обновляющиеся пользовательские интерфейсы реального времени. Когда некоторые данные обновлены на сервере, сообщение обычно отправляется по websocket соединению, которое будет обработано клиентом.

Чтобы помочь вам в создании этих типов приложений, Laravel упрощает «передачу» ваших событий по websocket соединению. Широковещательные события Laravel позволяют вам совместно использовать те же имена событий между серверным кодом и клиентской платформой JavaScript.

Конфигурация

Все параметры широковещательных событий находятся в конфигурационном файле config/broadcasting.php. Laravel поддерживает несколько широковещательных драйверов из коробки: Pusher, Redis и драйвер log для локальной разработки и отладки. Пример конфигурации включен для каждого из этих драйверов.

Требования к широковещательным событиям

Следующие зависимости будут необходимы:

• Pusher: pusher/pusher-php-server ~2.0
• Redis: predis/predis ~1.0

Требования к очереди

Перед использованием широковещательных событий также вам будет необходимо сконфигурировать и запустить слушателя очереди. Все широковещательные события используют очереди, чтобы не уменьшать время отклика вашего приложения.

Помечаем широковещательные события

Чтобы проинформировать Laravel о том, что заданное событие должно быть широковещательным, реализуйте интерфейс Illuminate\Contracts\Broadcasting\ShouldBroadcast в классе события. Интерфейс ShouldBroadcast требует реализации одного метода: PHPbroadcastOn(). Метод PHPbroadcastOn() должен возвращать массив «channel» имён, для которого событие должно быть широковещательным:

<?php

namespace App\Events;

use App\User;
use App\Events\Event;
use Illuminate\Queue\SerializesModels;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;

class ServerCreated extends Event implements ShouldBroadcast
{
  use SerializesModels;

  public $user;

  /**
   * Создание нового экземпляра события.
   *
   * @return void
   */
  public function __construct(User $user)
  {
    $this->user = $user;
  }

  /**
   * Получение каналов, для которых событие должно быть широковещательным.
   *
   * @return array
   */
  public function broadcastOn()
  {
    return ['user.'.$this->user->id];
  }
}

Теперь вам нужно только запустить событие, как вы это обычно делали. Как только событие было запущено, обработчик очереди автоматически передаст широковещательное событие по вашему указанному широковещательному драйверу.

Переписываем имена широковещательных событий

По умолчанию широковещательное имя события будет полностью определенным именем класса события. Используя класс в качестве примера выше, широковещательное событие было бы App\Events\ServerCreated. Вы можете определить имя широковещательного события, как вам будет удобнее, используя метод PHPbroadcastAs():

/**
 * Получить имя широковещательного события.
 *
 * @return string
 */
public function broadcastAs()
{
    return 'app.server-created';
}

Широковещательные данные

Когда событие широковещательное, все его public свойства автоматически сериализированы и передаются вместе с событием, что позволяет вам получить доступ к любым из его общедоступных данных из JavaScript приложения. Например, если у вашего события есть единственное общедоступное свойство $user, которое содержит Eloquent модель, широковещательные данные будут выглядеть так:

{
  "user": {
    "id": 1,
    "name": "Jonathan Banks"
    ...
  }
}

Однако, если вы хотите иметь еще более тщательный контроль над своими широковещательными данными, вы можете добавить к своему событию метод PHPbroadcastWith(). Этот метод должен возвращать массив данных, которые вы хотите передать с событием:

/**
 * Получить данные для передачи.
 *
 * @return array
 */
public function broadcastWith()
{
    return ['user' => $this->user->id];
}

Настройка широковещательных событий

Настройка имени события

По умолчанию имя широковещательного события — это полное имя класса этого события. Например, если имя класса App\Events\ServerCreated, то событие будет App\Events\ServerCreated. Имя можно изменить, определив метод PHPbroadcastAs() в классе события:

/**
 * Получение имени широковещательного события.
 *
 * @return string
 */
public function broadcastAs()
{
  return 'app.server-created';
}

Настройка очереди

По умолчанию каждое широковещательное событие помещается в очередь по умолчанию для подключения по умолчанию в вашем файле настроек queue.php. Можно изменить очередь для вещания событий, добавив метод PHPonQueue() в класс события. Этот метод должен возвращать имя нужной очереди:

/**
 * Задание имени очереди для размещения событий.
 *
 * @return string
 */
public function onQueue()
{
  return 'your-queue-name';
}

Использование широковещательных событий

Pusher

Вы можете удобно использовать широковещательную передачу событий, используя драйвер Pusher, используя Pusher SDK JavaScript. Например, давайте используем событие App\Events\ServerCreated из наших предыдущих примеров:

this.pusher = new Pusher('pusher-key');

this.pusherChannel = this.pusher.subscribe('user.' + USER_ID);

this.pusherChannel.bind('App\\Events\\ServerCreated', function(message) {
  console.log(message.user);
});

Redis

Если вы будете использовать Redis, то вы должны будете написать свой собственный Redis потребитель типа издатель-подписчик, чтобы получать сообщения и широковещательно передавать их, используя websocket технологию на ваш выбор. Например, вы можете воспользоваться популярной библиотекой Socket.io, которая написана на Node.

Используя библиотеки Node socket.io и ioredis, вы можете быстро написать broadcaster событий, чтобы публиковать все события, которые широковещаются вашим приложением Laravel:

var app = require('http').createServer(handler);
var io = require('socket.io')(app);

var Redis = require('ioredis');
var redis = new Redis();

app.listen(6001, function() {
  console.log('Server is running!');
});

function handler(req, res) {
  res.writeHead(200);
  res.end('');
}

io.on('connection', function(socket) {
  //
});

redis.psubscribe('*', function(err, count) {
  //
});

redis.on('pmessage', function(subscribed, channel, message) {
  message = JSON.parse(message);
  io.emit(channel + ':' + message.event, message.data);
});

События фреймворка

Laravel предоставляет множество «базовых» событий для действий, выполняемых фреймворком. Вы можете подписаться на них таким же образом, как вы подписываетесь на свои собственные события: