class Client in Instagram API 8

Class Client.

@package Drupal\instagram_api\Service

Hierarchy

• class \Drupal\instagram_api\Service\Client uses StringTranslationTrait

1 string reference to 'Client'

instagram_api.services.yml in ./instagram_api.services.yml

instagram_api.services.yml

1 service uses Client

instagram_api.client in ./instagram_api.services.yml

Drupal\instagram_api\Service\Client

File

src/Service/Client.php, line 20

Namespace

Drupal\instagram_api\Service

class Client {
  use StringTranslationTrait;

  /**
   * Config.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * Logger Factory.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $loggerFactory;

  /**
   * Cache Backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheBackend;

  /**
   * Client constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactory $config
   *   Config.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cacheBackend
   *   Cache backend.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $stringTranslation
   *   String translation.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $loggerFactory
   *   LoggerChannelFactory.
   */
  public function __construct(ConfigFactory $config, CacheBackendInterface $cacheBackend, TranslationInterface $stringTranslation, LoggerChannelFactoryInterface $loggerFactory) {

    // Get the config.
    $this->config = $config
      ->get('instagram_api.settings');

    // Cache Backend.
    $this->cacheBackend = $cacheBackend;

    // String Translation.
    $this->stringTranslation = $stringTranslation;
    $this->api_base_uri = $this->config
      ->get('api_base_uri');
    $this->api_cache_maximum_age = $this->config
      ->get('api_cache_maximum_age');
    $this->access_token = $this->config
      ->get('access_token');
    $this->guzzleClient = new GuzzleClient([
      'base_uri' => $this->api_base_uri,
    ]);
    $this->loggerFactory = $loggerFactory;
  }

  /**
   * Instagram request.
   *
   * @param string $method
   *   Method to call.
   * @param array $args
   *   Args to request.
   * @param bool $cacheable
   *   Is it cachable.
   *
   * @return bool|array
   *   Either an array or false.
   */
  public function request($method, array $args, $cacheable = TRUE) {

    // Build the arg_hash.
    $args = $this
      ->buildArgs($args, $method);
    $argHash = $this
      ->buildArgHash($args);

    // $response = &drupal_static(__FUNCTION__);
    // // Can be replaced with the `__METHOD__`.
    $cid = 'instagram_api:' . md5($argHash);

    // Check cache.
    if ($cache = $this->cacheBackend
      ->get($cid)) {
      $response = $cache->data;

      // Return result from cache if found.
      return $response;
    }
    else {
      $response = $this
        ->doRequest($method, $args);
      if ($response) {

        // Cache the response if we got one.
        if ($this->api_cache_maximum_age != 0 && $cacheable == TRUE) {
          $this->cacheBackend
            ->set($cid, $response, time() + $this->api_cache_maximum_age);
        }

        // Return result from source if found.
        return $response;
      }
    }

    // Tough luck, no results mate.
    return FALSE;
  }

  /**
   * Build default args.
   *
   * @param array $args
   *   Args to request.
   * @param string $method
   *   Method to call.
   * @param string $format
   *   Format to request.
   *
   * @return array
   *   Return the args array.
   */
  private function buildArgs(array $args, $method, $format = 'json') {

    // Add in additional parameters then sort them for signing.
    $args['access_token'] = $this->access_token;
    ksort($args);
    return $args;
  }

  /**
   * Build Hash from Args array.
   *
   * @param array $args
   *   Args to request.
   *
   * @return string
   *   Return string.
   */
  private function buildArgHash(array $args) {

    // Build an argument hash API signing (we'll also use it for the cache id).
    $argHash = '';
    foreach ($args as $k => $v) {
      $argHash .= $k . $v;
    }
    return $argHash;
  }

  /**
   * Guzzle request for Instagram.
   *
   * @param string $url
   *   Url.
   * @param array $parameters
   *   Parameters.
   * @param string $requestMethod
   *   Request method.
   *
   * @return bool|array
   *   False or array.
   */
  private function doRequest($url, array $parameters = [], $requestMethod = 'GET') {
    if ($this->access_token == "") {
      $msg = $this
        ->t('Instagram API Access Token is not set. It can be set on the <a href=":config_page">configuration page</a>.', [
        ':config_page' => Url::fromRoute('instagram_api.settings'),
      ]);
      drupal_set_message($msg, 'error');
      return FALSE;
    }
    try {
      $response = $this->guzzleClient
        ->request($requestMethod, $url, [
        'query' => $parameters,
      ]);
      if ($response
        ->getStatusCode() == 200) {
        $contents = $response
          ->getBody()
          ->getContents();
        $json = Json::decode($contents);
        return $json['data'];
      }
    } catch (GuzzleException $e) {
      $this->loggerFactory
        ->get('instagram_api')
        ->error("@message", [
        '@message' => $e
          ->getMessage(),
      ]);
      return FALSE;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Client::$cacheBackend	protected	property	Cache Backend.
Client::$config	protected	property	Config.
Client::$loggerFactory	protected	property	Logger Factory.
Client::buildArgHash	private	function	Build Hash from Args array.
Client::buildArgs	private	function	Build default args.
Client::doRequest	private	function	Guzzle request for Instagram.
Client::request	public	function	Instagram request.
Client::__construct	public	function	Client constructor.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.