Как создать пользовательские драйверы в CodeIgniter

Russian (Pусский) translation by Ilya Nikov (you can also view the original English article)

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

Аналогично, драйвер представляет собой особый вид библиотеки, который позволяет добавлять пользовательские функции, чтобы основной класс драйвера выполнял роль родительского класса, а адаптеры рассматривались как дочерние классы.

Лучший способ понять концепцию драйверов - посмотреть, как реализовано кэширование в CodeIgniter. Основной класс Cache действует как родительский класс и расширяет класс CI_Driver_Library. С другой стороны, вы в конечном итоге найдете дочерние классы для APC, Memcached, Redis и т.п., Реализованные в виде подключаемых адаптеров. Дочерние классы расширяют класс CI_Driver вместо основного класса драйвера.

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

Создание пользовательского драйвера в приложении CodeIgniter является целью сегодняшней статьи. В этом случае мы рассмотрим пример реального приложения, где мы создадим драйвер MediaRenderer, используемый для рендеринга мультимедиа из разных сервисов, таких как YouTube, Vimeo и т.д. Различные службы будут реализованы в виде классов адаптеров.

Настройка файлов

Имя драйвера, которое мы собираемся реализовать в этой статье, - MediaRenderer. Давайте быстро рассмотрим список файлов, необходимых для нужной настройки:

application/libraries/MediaRenderer/MediaRendererInterface.php: Это интерфейс, который необходимо реализовать адаптеру.
application/config/mediarenderer.php: Файл конфигурации, в котором содержатся наши настраиваемые параметры, связанные с драйвером.
application/libraries/MediaRenderer/MediaRenderer.php: Это класс, который расширяет CI_Driver_Library и используется для управления различными адаптерами, доступными в приложении.
application/libraries/MediaRenderer/drivers/ MediaRenderer_youtube.php: Это класс, который реализует адаптер YouTube.
application/libraries/MediaRenderer/drivers/MediaRenderer_vimeo.php: Это класс, который реализует адаптер Vimeo.
application/controllers/Media.php: Это класс контроллера, который мы реализуем, чтобы продемонстрировать использование нашего пользовательского драйвера.

Итак, это список файлов, которые мы собираемся реализовать в этой статье.

Создание драйверов

В этом разделе мы создадим базовые файлы нашего пользовательского драйвера.

Первое, что нам нужно сделать, это определить файл конфигурации нашего пользовательского драйвера. Давайте определим файл application/config/mediarenderer.php, как показано ниже.

1	<?php
2	$config['media_services'] = array('youtube', 'vimeo');
3	$config['media_default'] = 'youtube';

Это означает, что мы собираемся реализовать два адаптера - YouTube и Vimeo. Адаптер по умолчанию установлен на YouTube.

Далее создайте application/libraries/MediaRenderer/MediaRendererInterface.php со следующим содержимым.

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

/**
 * MediaRendererInterface
 */
interface MediaRendererInterface
{
    public function display($id);
}

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

Затем давайте посмотрим на файл драйвера MediaRenderer. Далее создайте application/libraries/MediaRenderer/MediaRenderer.php со следующим содержимым.

<?php
if ( ! defined('BASEPATH')) exit('No direct script access allowed');
interface_exists('MediaRendererInterface', FALSE) OR require_once(APPPATH.'/libraries/MediaRenderer/MediaRendererInterface.php');

/**
 * MediaRenderer Class
 */
class MediaRenderer extends CI_Driver_Library {
    
  public $valid_drivers;
  public $CI;
  protected $_adapter = 'youtube';

  /**
   * Class constructor
   */
  public function __construct()
  {
    $this->CI =& get_instance();
    $this->CI->config->load('mediarenderer');
    $this->valid_drivers = $this->CI->config->item('media_services');
    $this->_adapter = $this->CI->config->item('media_default');
  }

  /**
   * Overrided __get method to check if the adapter implements MediaRendererInterface interface
   * @see CI_Driver_Library::__get()
   */
  public function __get($child)
  {
      if (in_array($child, $this->valid_drivers))
      {
          $object = $this->load_driver($child);
          
          if ($object instanceof MediaRendererInterface)
          {
              return $object;
          }
          else
          {
              show_error("MediaRenderer: Adapter '".$child."' doesn't implement MediaRendererInterface. Aborting.");
              return;
          }
      }
      else
      {
                show_error('Unable to load the requested adapter: '.$child);
                return;
      }
  }

  /**
   * @param string $adapter Adapter name
   * @return MediaRenderer
   */
  public function setAdapter($adapter)
  {
      $this->_adapter = $adapter;
      return $this;
  }

  /**
   * @param string $id Media ID
   */
  public function display($id)
  {
      return $this->{$this->_adapter}->display($id);
  }

}

В начале файла мы добавляем интерфейс MediaRendererInterface, который мы уже определили ранее в этом разделе.

В соответствии со стандартами драйвера CodeIgniter наш класс MediaRenderer расширяет класс CI_Driver_Library, который позволяет легко получить доступ к адаптерам драйверов, используя метод load_driver, определенный в классе CI_Driver_Library.

Затем давайте посмотрим на конструктор.

public function __construct()
{
  $this->CI =& get_instance();
  $this->CI->config->load('mediarenderer');
  $this->valid_drivers = $this->CI->config->item('media_services');
  $this->_adapter = $this->CI->config->item('media_default');
}

Вспомните файл конфигурации mediarenderer, который мы определили ранее, и это точно загружено в конструкторе в первую очередь. Необходимо, чтобы вы установили список адаптеров, которые поддерживаются драйвером, в свойство valid_drivers, поэтому мы просто это и сделали. И, наконец, для удобства мы установили значение драйвера по умолчанию для свойства _adapter.

Двигаясь дальше, давайте рассмотрим код метода __get.

public function __get($child)
{
    if (in_array($child, $this->valid_drivers))
    {
        $object = $this->load_driver($child);
        
        if ($object instanceof MediaRendererInterface)
        {
            return $object;
        }
        else
        {
            show_error("MediaRenderer: Adapter '".$child."' doesn't implement MediaRendererInterface. Aborting.");
            return;
        }
    }
    else
    {
            show_error('Unable to load the requested adapter: '.$child);
            return;
    }
}

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

Затем давайте посмотрим на метод setAdapter.

public function setAdapter($adapter)
{
    $this->_adapter = $adapter;
    return $this;
}

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

Наконец, есть метод display, который вызывает метод отображения соответствующего адаптера.

1	public function display($id)
2	{
3	return $this->{$this->_adapter}->display($id);
4	}

Опять же, я бы сказал, что вы можете пропустить реализацию этого метода, поскольку вы всегда можете вызвать метод отображения адаптера напрямую, как мы увидим далее в этой статье. Тем не менее, я хотел бы получить доступ к адаптерам с помощью метода отображения класса MediaRenderer, поскольку это место, где вы могли бы реорганизовать общий код, который может реализовать адаптер.

Таким образом, в вашем распоряжении был класс MediaRenderer.

Создаем адаптеры

Некоторое время мы обсуждали адаптеры драйверов, и теперь пришло время их реализовать.

Начнем с файла адаптера YouTube в приложении application/libraries/MediaRenderer/drivers/MediaRenderer_youtube.php.

<?php
if ( ! defined('BASEPATH')) exit('No direct script access allowed');

/**
 * MediaRenderer_youtube Class
 */
class MediaRenderer_youtube extends CI_Driver implements MediaRendererInterface {

  /**
   * @param string $id Media ID
   * @see MediaRendererInterface::display()
   */
  public function display($id)
  {
    if ($id)
    {
      return '<iframe width="420" height="315" src="//www.youtube.com/embed/'.$id.'" frameborder="0"
allowfullscreen></iframe>';
    }
  }

}

Важно отметить, что имя адаптера имеет префикс MediaRenderer_, а также расширяет класс CI_Driver. Кроме того, он реализует интерфейс MediaRendererInterface, чтобы убедиться, что мы придерживаемся стандартов, которые мы обсуждали ранее.

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

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

Класс адаптера Vimeo довольно похож на класс YouTube. Идем дальше и создаем его в application/libraries/MediaRenderer/drivers/MediaRenderer_vimeo.php.

<?php
if ( ! defined('BASEPATH')) exit('No direct script access allowed');

/**
 * MediaRenderer_vimeo Class
 */
class MediaRenderer_vimeo extends CI_Driver implements MediaRendererInterface {
    
    /**
     * @param string $id Media ID
     * @see MediaRendererInterface::display()
     */
  public function display($id)
  {
      if ($id)
      {
      return '<iframe width="420" height="247" src="//player.vimeo.com/video/'.$id.'"></iframe>';
      }
  }

}

И на этом заканчиваем обсуждение адаптеров.

Все вместе

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

Начнем с создания файла контроллера application/controllers/Media.php.

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

/**
 * Media Controller Class
 */
class Media extends CI_Controller {
  public function index()
  {
    // this will use default adapter as per the config file
    $this->load->driver('mediaRenderer');
    
    // IMP: it must be a lowercase drivername when you use it
    echo $this->mediarenderer->display("0GfCP5CWHO0");
    
    // override adapter settings by setting it explicitly
    echo $this->mediarenderer->setAdapter('vimeo')->display("225434434");
    
    // access the adapter directly
    echo $this->mediarenderer->vimeo->display("225434434");
    echo $this->mediarenderer->youtube->display("0GfCP5CWHO0");
  }
}

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

1	$this->load->driver('mediaRenderer');

Чтобы получить доступ к только что загруженному пользовательскому драйверу, вы должны использовать синтаксис $this->mediarenderer. Важно отметить, что имя драйвера указано в нижнем регистре, независимо от фактического имени драйвера.

Затем давайте рассмотрим, что делает следующий код.

1	echo $this->mediarenderer->display("0GfCP5CWHO0");

Он вызывает метод display класса MediaRenderer в первую очередь, поскольку он делегирует элемент управления методу display соответствующего адаптера, установленного в качестве адаптера по умолчанию в файле конфигурации медиаредактора. В конце концов, он делает вызов метода display адаптера YouTube, поскольку в нашем случае это адаптер по умолчанию.

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

1	echo $this->mediarenderer->setAdapter('vimeo')->display("225434434");

Как я уже упоминал ранее, вы также можете напрямую вызвать метод display любого конкретного адаптера, не пройдя метод отображения класса MediaRenderer.

1	echo $this->mediarenderer->vimeo->display("225434434");
2	echo $this->mediarenderer->youtube->display("0GfCP5CWHO0");

Таким образом, вы должны вызвать драйвер и его адаптеры рядом - благодаря структуре драйвера, которая позволяет вам подключать новые адаптеры «на лету» по мере необходимости.

И на этом все. Я надеюсь, что вам понравилась статья, и вы всегда можете попасть в раздел комментариев, чтобы выразить свои мысли и проблемы.

Заключение

Путешествие по драйверам фреймворка CodeIgniter было темой сегодняшней статьи.

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

Мне бы очень хотелось услышать, если бы вы могли придумать что-нибудь об этой захватывающей концепции!