InstagramBlockBlock.php in Instagram Block 8.3

Namespace

Drupal\instagram_block\Plugin\Block

File

src/Plugin/Block/InstagramBlockBlock.php

<?php

namespace Drupal\instagram_block\Plugin\Block;

use Drupal\Core\Block\BlockBase;
use Drupal\Core\Config\ConfigFactory;
use Drupal\Core\Link;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\Core\Form\FormStateInterface;
use GuzzleHttp\Client;
use Symfony\Component\DependencyInjection\ContainerInterface;
use GuzzleHttp\Exception\RequestException;
use Drupal\Core\Url;
use Drupal\Component\Serialization\Json;

/**
 * Provides an Instagram block.
 *
 * @Block(
 *   id = "instagram_block_block",
 *   admin_label = @Translation("Instagram block"),
 *   category = @Translation("Social")
 * )
 */
class InstagramBlockBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The HTTP client to fetch the feed data with.
   *
   * @var \GuzzleHttp\Client
   */
  protected $httpClient;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactory
   */
  protected $configFactory;

  /**
   * The logger factory.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $loggerFactory;

  /**
   * Constructs a InstagramBlockBlock object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \GuzzleHttp\Client $http_client
   *   The Guzzle HTTP client.
   * @param \Drupal\Core\Config\ConfigFactory $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   The factory for logger.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, Client $http_client, ConfigFactory $config_factory, LoggerChannelFactoryInterface $logger_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->httpClient = $http_client;
    $this->configFactory = $config_factory;
    $this->loggerFactory = $logger_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('http_client'), $container
      ->get('config.factory'), $container
      ->get('logger.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'access_token' => '',
      'count' => 4,
      'width' => 150,
      'height' => 150,
      'img_resolution' => 'thumbnail',
      'cache_time_minutes' => 1440,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['authorise'] = [
      '#markup' => $this
        ->t('Instagram Block requires connecting to a specific Instagram account. You need to be able to log into that account when asked to. The @help page helps with the setup.', [
        '@help' => Link::fromTextAndUrl($this
          ->t('Authenticate with Instagram'), Url::fromUri('https://www.drupal.org/node/2746185'))
          ->toString(),
      ]),
    ];
    $form['access_token'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Access Token'),
      '#description' => $this
        ->t('Your Instagram access token. Eg. 460786509.ab103e5.a54b6834494643588d4217ee986384a8'),
      '#default_value' => $this->configuration['access_token'],
    ];
    $form['count'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Number of images to display'),
      '#default_value' => $this->configuration['count'],
    ];
    $form['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Image width in pixels'),
      '#default_value' => $this->configuration['width'],
    ];
    $form['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Image height in pixels'),
      '#default_value' => $this->configuration['height'],
    ];
    $image_options = [
      'thumbnail' => $this
        ->t('Thumbnail (150x150)'),
      'low_resolution' => $this
        ->t('Low (320x320)'),
      'standard_resolution' => $this
        ->t('Standard (640x640)'),
    ];
    $form['img_resolution'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Image resolution'),
      '#description' => $this
        ->t('Choose the quality of the images you would like to display.'),
      '#default_value' => $this->configuration['img_resolution'],
      '#options' => $image_options,
    ];
    $form['cache_time_minutes'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Cache time in minutes'),
      '#description' => $this
        ->t("Default is 1440 - 24 hours. This is important for performance reasons and so the Instagram API limits isn't reached on busy sites."),
      '#default_value' => $this->configuration['cache_time_minutes'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    if ($form_state
      ->hasAnyErrors()) {
      return;
    }
    else {
      $this->configuration['count'] = $form_state
        ->getValue('count');
      $this->configuration['width'] = $form_state
        ->getValue('width');
      $this->configuration['height'] = $form_state
        ->getValue('height');
      $this->configuration['img_resolution'] = $form_state
        ->getValue('img_resolution');
      $this->configuration['cache_time_minutes'] = $form_state
        ->getValue('cache_time_minutes');
      $this->configuration['access_token'] = $form_state
        ->getValue('access_token');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function build() {

    // Build a render array to return the Instagram Images.
    $build = [];

    // If no configuration was saved, don't attempt to build block.
    if (empty($this->configuration['access_token'])) {
      $this->loggerFactory
        ->get('instagram_block')
        ->error($this
        ->t('No access_token set'));
      return $build;
    }

    // Build url for http request.
    $uri = "https://api.instagram.com/v1/users/self/media/recent/";
    $options = [
      'query' => [
        'access_token' => $this->configuration['access_token'],
        'count' => $this->configuration['count'],
      ],
    ];
    $url = Url::fromUri($uri, $options)
      ->toString();

    // Get the instagram images and decode.
    $result = $this
      ->fetchData($url);
    if (!$result) {
      return $build;
    }
    foreach ($result['data'] as $post) {
      $build['children'][$post['id']] = [
        '#theme' => 'instagram_block_image',
        '#data' => $post,
        '#href' => $post['link'],
        '#src' => $post['images'][$this->configuration['img_resolution']]['url'],
        '#width' => $this->configuration['width'],
        '#height' => $this->configuration['height'],
      ];
    }

    // Add css.
    if (!empty($build)) {
      $build['#attached']['library'][] = 'instagram_block/instagram_block';
    }

    // Cache for a day.
    $build['#cache']['keys'] = [
      'block',
      'instagram_block',
      $this->configuration['id'],
      $this->configuration['access_token'],
    ];
    $build['#cache']['context'][] = 'languages:language_content';
    $build['#cache']['max-age'] = $this->configuration['cache_time_minutes'] * 60;
    return $build;
  }

  /**
   * Sends a http request to the Instagram API Server.
   *
   * @param string $url
   *   URL for http request.
   *
   * @return bool|mixed
   *   The encoded response containing the instagram images or FALSE.
   */
  protected function fetchData($url) {
    try {
      $response = $this->httpClient
        ->get($url, [
        'headers' => [
          'Accept' => 'application/json',
        ],
      ]);
      $data = Json::decode($response
        ->getBody());
      if (empty($data)) {
        $this->loggerFactory
          ->get('instagram_block')
          ->error($this
          ->t('Invalid JSON or empty body returned by Instagram'));
        return FALSE;
      }
      return $data;
    } catch (RequestException $e) {
      $this->loggerFactory
        ->get('instagram_block')
        ->error($e
        ->getMessage());
      return FALSE;
    }
  }

}

Classes

Name	Description
InstagramBlockBlock	Provides an Instagram block.