class TwitterFeedBlock in Twitter_Feed 8

Provides a 'TwitterFeedBlock' block.

Plugin annotation


@Block(
 id = "twitter_feed_block",
 admin_label = @Translation("Twitter feed block"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\twitter_feed\Plugin\Block\TwitterFeedBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of TwitterFeedBlock

File

src/Plugin/Block/TwitterFeedBlock.php, line 20

Namespace

Drupal\twitter_feed\Plugin\Block

View source

class TwitterFeedBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * GuzzleHttp\Client definition.
   *
   * @var \GuzzleHttp\ClientInterface
   */
  protected $httpClient;

  /**
   * Construct.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param string $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Client $http_client) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->httpClient = $http_client;
  }

  /**
   * {@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'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $default = [
      'number_of_tweets' => 3,
      'username' => 'drupal',
      'display_images' => FALSE,
      'display_avatars' => FALSE,
    ];
    return $default;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['number_of_tweets'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Number of tweets'),
      '#description' => $this
        ->t('Fetch and display only this number of feeds'),
      '#default_value' => $this->configuration['number_of_tweets'],
    ];
    $form['username'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Username to display'),
      '#description' => $this
        ->t('User to fetch and display tweets'),
      '#default_value' => $this->configuration['username'],
    ];
    $form['display_images'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display images'),
      '#description' => $this
        ->t('If images embedded in the tweet should be expanded and embedded'),
      '#default_value' => $this->configuration['display_images'],
    ];
    $form['display_avatars'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display avatars'),
      '#description' => $this
        ->t("If tweeter's avatar should be displayed"),
      '#default_value' => $this->configuration['display_avatars'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['number_of_tweets'] = $form_state
      ->getValue('number_of_tweets');
    $this->configuration['username'] = $form_state
      ->getValue('username');
    $this->configuration['display_images'] = $form_state
      ->getValue('display_images');
    $this->configuration['display_avatars'] = $form_state
      ->getValue('display_avatars');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $config = \Drupal::config('twitter_feed.settings');

    // https://dev.twitter.com/oauth/application-only
    $api_key = rawurlencode($config
      ->get('twitter_feed_api_key'));
    $api_secret = rawurlencode($config
      ->get('twitter_feed_api_secret'));
    if (!$api_key || !$api_secret) {
      return [
        '#markup' => $this
          ->t('API Key or Secret missing for Twitter Feed.'),
      ];
    }
    $encoded_key = base64_encode("{$api_key}:{$api_secret}");
    $headers = [
      'Authorization' => "Basic {$encoded_key}",
      'Content-Type' => 'application/x-www-form-urlencoded',
    ];
    $options = [
      'headers' => $headers,
      'timeout' => 10,
      'form_params' => [
        'grant_type' => 'client_credentials',
      ],
      'referer' => TRUE,
      'allow_redirects' => TRUE,
      'decode_content' => 'gzip',
    ];
    try {

      // Get the access token first.
      // https://dev.twitter.com/oauth/reference/post/oauth2/token
      $res = $this->httpClient
        ->post('https://api.twitter.com/oauth2/token', $options);
      $body = json_decode($res
        ->getBody());
      $access_token = $body->access_token;

      // Now get the tweets.
      // https://dev.twitter.com/rest/reference/get/statuses/user_timeline
      $username = $this->configuration['username'];
      $num_tweets = $this->configuration['number_of_tweets'];
      $options['headers']['Authorization'] = "{$body->token_type} {$access_token}";
      unset($options['headers']['Content-Length']);
      unset($options['form_params']);
      $query = http_build_query([
        'screen_name' => $username,
        'count' => $num_tweets,
        'tweet_mode' => 'extended',
      ]);

      // Fetches the tweets.
      $res = $this->httpClient
        ->get("https://api.twitter.com/1.1/statuses/user_timeline.json?{$query}", $options);
    } catch (RequestException $e) {
      return [
        '#markup' => $this
          ->t('Error fetching tweets:') . $e
          ->getMessage(),
      ];
    }
    $renderable_tweets = [];
    foreach (json_decode($res
      ->getBody()) as $tweet_object) {
      $renderable_tweet = [
        '#theme' => 'twitter_feed_item',
        '#tweet' => $tweet_object,
      ];
      $language = \Drupal::config('twitter_feed.settings')
        ->get('twitter_feed_jquery_timeago_locale');
      $renderable_tweet['#attached']['library'][] = 'twitter_feed/timeago';
      if ($language) {
        $renderable_tweet['#attached']['library'][] = 'twitter_feed/timeago_' . $language;
      }
      $renderable_tweets[] = $renderable_tweet;
    }
    if (empty($renderable_tweets)) {
      return [
        '#markup' => $this
          ->t('Error fetching or rendering tweets.'),
      ];
    }
    $item_list = [
      '#items' => $renderable_tweets,
      '#type' => 'ul',
      '#theme' => 'item_list',
      '#attributes' => [
        'class' => 'twitter-feed',
      ],
    ];
    $build['twitter_feed_list'] = $item_list;
    $build['#cache']['keys'] = [
      'twitter_feed',
      $username,
      "count:{$num_tweets}",
    ];

    // Cache block for 1 hour by default.
    // TODO set per-block cache time.
    $build['#cache']['max-age'] = 3600;
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE		constant	Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration	protected	property	The transliteration service.
BlockPluginTrait::access	public	function
BlockPluginTrait::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess	protected	function	Indicates whether the block should be shown.	16
BlockPluginTrait::blockValidate	public	function		3
BlockPluginTrait::buildConfigurationForm	public	function	Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements.	2
BlockPluginTrait::calculateDependencies	public	function
BlockPluginTrait::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::getPreviewFallbackString	public	function		3
BlockPluginTrait::label	public	function
BlockPluginTrait::setConfiguration	public	function
BlockPluginTrait::setConfigurationValue	public	function
BlockPluginTrait::setTransliteration	public	function	Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration	protected	function	Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().	1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass	public	function
PluginWithFormsTrait::hasFormClass	public	function
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.
TwitterFeedBlock::$httpClient	protected	property	GuzzleHttp\Client definition.
TwitterFeedBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
TwitterFeedBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
TwitterFeedBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
TwitterFeedBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TwitterFeedBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
TwitterFeedBlock::__construct	public	function	Construct. Overrides BlockPluginTrait::__construct
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class TwitterFeedBlock in Twitter_Feed 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation