class SimpleInstagramBlock in Simple Instagram Feed Block 1.0.x

Same name and namespace in other branches

8.3 src/Plugin/Block/SimpleInstagramBlock.php \Drupal\simple_instagram_feed\Plugin\Block\SimpleInstagramBlock
8 src/Plugin/Block/SimpleInstagramBlock.php \Drupal\simple_instagram_feed\Plugin\Block\SimpleInstagramBlock
8.2 src/Plugin/Block/SimpleInstagramBlock.php \Drupal\simple_instagram_feed\Plugin\Block\SimpleInstagramBlock

Provides a block with a dynamic Instagram Feed.

Plugin annotation


@Block(
  id = "simple_instagram_block",
  admin_label = @Translation("Simple Instagram Feed"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, ContextAwarePluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait, ContextAwarePluginTrait
    class \Drupal\simple_instagram_feed\Plugin\Block\SimpleInstagramBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of SimpleInstagramBlock

File

src/Plugin/Block/SimpleInstagramBlock.php, line 19

Namespace

Drupal\simple_instagram_feed\Plugin\Block

View source

class SimpleInstagramBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritDoc}
   */
  public function defaultConfiguration() {
    return [
      'items' => 12,
      'styling' => 'true',
      'captions' => false,
      'instagram_username' => 'instagram',
      'display_profile' => true,
      'display_biography' => true,
      'items_per_row_type' => false,
      'items_per_row_default' => 5,
      'items_per_row_l_720' => 5,
      'items_per_row_l_960' => 5,
      'items_per_row_h_960' => 5,
      'lazy_load' => true,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['simple_instagram_username'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Instagram username'),
      '#description' => $this
        ->t('Insert the username of the instagram account in the field above.'),
      '#default_value' => isset($config['simple_instagram_username']) ? $config['simple_instagram_username'] : 'instagram',
      '#required' => TRUE,
    ];
    $form['simple_instagram_display_profile'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display profile?'),
      '#description' => $this
        ->t('Do you wish to display the Instagram profile on this Instagram Feed?'),
      '#default_value' => isset($config['simple_instagram_display_profile']) ? $config['simple_instagram_display_profile'] : 'true',
    ];
    $form['simple_instagram_display_biography'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display bio?'),
      '#description' => $this
        ->t('Do you wish to display the Instagram Bio on this Instagram Feed?'),
      '#default_value' => isset($config['simple_instagram_display_biography']) ? $config['simple_instagram_display_biography'] : 'true',
    ];
    $form['simple_instagram_captions'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display captions'),
      '#description' => $this
        ->t('Enables displaying captions for each post as overlay on hover.'),
      '#default_value' => isset($config['simple_instagram_captions']) ? $config['simple_instagram_captions'] : FALSE,
      '#attributes' => [
        'id' => 'simple_instagram_captions',
      ],
    ];
    $form['simple_instagram_items'] = [
      '#type' => 'textfield',
      '#size' => 3,
      '#maxlength' => 3,
      '#title' => $this
        ->t('Number of images'),
      '#description' => $this
        ->t('How many images do you wish to feature on this Instagram Feed?'),
      '#default_value' => isset($config['simple_instagram_items']) ? $config['simple_instagram_items'] : '12',
      '#required' => TRUE,
    ];
    $form['simple_instagram_items_per_row'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Items per row'),
    ];
    $form['simple_instagram_items_per_row']['simple_instagram_items_per_row_type'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Check it if you want to choose how many images to display depends on the window size.'),
      '#default_value' => isset($config['simple_instagram_items_per_row_type']) ? $config['simple_instagram_items_per_row_type'] : 0,
      '#attributes' => [
        'id' => 'simple_instagram_items_per_row_type',
      ],
    ];
    $simple_items_range = range(1, 12);
    $form['simple_instagram_items_per_row']['simple_instagram_items_per_row_default'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of images per row for all window size.'),
      '#description' => $this
        ->t('How many images do you wish to feature on each row of this Instagram Feed? You can produce a single row if you set the number of images to equal the number of images per row.'),
      '#options' => [
        $simple_items_range,
      ],
      '#default_value' => isset($config['simple_instagram_items_per_row_default']) ? $config['simple_instagram_items_per_row_default'] : '5',
      '#states' => [
        'visible' => [
          ':input[id="simple_instagram_items_per_row_type"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['simple_instagram_items_per_row']['simple_instagram_items_per_row_l_720'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of images per row if window size is <720px.'),
      '#description' => $this
        ->t('How many images do you wish on each row if the user window size is lower than 720px.'),
      '#options' => [
        $simple_items_range,
      ],
      '#default_value' => isset($config['simple_instagram_items_per_row_l_720']) ? $config['simple_instagram_items_per_row_l_720'] : '5',
      '#states' => [
        'visible' => [
          ':input[id="simple_instagram_items_per_row_type"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['simple_instagram_items_per_row']['simple_instagram_items_per_row_l_960'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of images per row if window size is >= 720px and < 960.'),
      '#description' => $this
        ->t('How many images do you wish on each row if the user window size is lower than 960px and higher than 720px.'),
      '#options' => [
        $simple_items_range,
      ],
      '#default_value' => isset($config['simple_instagram_items_per_row_l_960']) ? $config['simple_instagram_items_per_row_l_960'] : '5',
      '#states' => [
        'visible' => [
          ':input[id="simple_instagram_items_per_row_type"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['simple_instagram_items_per_row']['simple_instagram_items_per_row_h_960'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of images per row if window size is >=960px.'),
      '#description' => $this
        ->t('How many images do you wish on each row if the user window size is higher than 960px.'),
      '#options' => [
        $simple_items_range,
      ],
      '#default_value' => isset($config['simple_instagram_items_per_row_h_960']) ? $config['simple_instagram_items_per_row_h_960'] : '5',
      '#states' => [
        'visible' => [
          ':input[id="simple_instagram_items_per_row_type"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['simple_instagram_styling'] = [
      '#type' => 'select',
      '#options' => [
        'true' => 'True',
        'false' => 'False',
      ],
      '#title' => $this
        ->t('Styling'),
      '#description' => $this
        ->t('Uncheck to omit instagramFeed styles and provide your own in your CSS. Enabled by default when using capions.'),
      '#default_value' => isset($config['simple_instagram_styling']) ? $config['simple_instagram_styling'] : 'true',
      '#states' => [
        'disabled' => [
          ':input[id="simple_instagram_captions"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#default_value' => isset($config['simple_instagram_styling']) ?? 'true',
    ];
    $simple_image_sizes = [
      '640' => 640,
      '480' => 480,
      '320' => 320,
      '240' => 240,
      '150' => 150,
    ];
    $form['simple_instagram_image_size'] = [
      '#type' => 'select',
      '#options' => $simple_image_sizes,
      '#title' => $this
        ->t('Image Size'),
      '#description' => $this
        ->t('Scale of items to build gallery. Accepted values [150, 240, 320, 480, 640].'),
      '#default_value' => isset($config['simple_instagram_image_size']) ? $config['simple_instagram_image_size'] : '640',
    ];
    $form['simple_instagram_lazy_load'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Lazyload assets'),
      '#description' => $this
        ->t('Do you wish to Lazy-load on this Instagram Feed?'),
      '#default_value' => isset($config['simple_instagram_lazy_load']) ? $config['simple_instagram_lazy_load'] : 'true',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    parent::blockSubmit($form, $form_state);
    $values = $form_state
      ->getValues();
    $this->configuration['simple_instagram_username'] = $values['simple_instagram_username'];
    $this->configuration['simple_instagram_display_profile'] = $values['simple_instagram_display_profile'];
    $this->configuration['simple_instagram_display_biography'] = $values['simple_instagram_display_biography'];
    $this->configuration['simple_instagram_captions'] = $values['simple_instagram_captions'];
    $this->configuration['simple_instagram_items'] = $values['simple_instagram_items'];
    $this->configuration['simple_instagram_items_per_row_type'] = $values['simple_instagram_items_per_row']['simple_instagram_items_per_row_type'];
    $this->configuration['simple_instagram_items_per_row_default'] = $values['simple_instagram_items_per_row']['simple_instagram_items_per_row_default'];
    $this->configuration['simple_instagram_items_per_row_l_720'] = $values['simple_instagram_items_per_row']['simple_instagram_items_per_row_l_720'];
    $this->configuration['simple_instagram_items_per_row_l_960'] = $values['simple_instagram_items_per_row']['simple_instagram_items_per_row_l_960'];
    $this->configuration['simple_instagram_items_per_row_h_960'] = $values['simple_instagram_items_per_row']['simple_instagram_items_per_row_h_960'];
    $this->configuration['simple_instagram_styling'] = $values['simple_instagram_styling'];
    $this->configuration['simple_instagram_image_size'] = $values['simple_instagram_image_size'];
    $this->configuration['simple_instagram_lazy_load'] = $values['simple_instagram_lazy_load'];
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $unique_id = Html::getUniqueId($this
      ->getPluginId());

    // TODO: I'm pretty sure this is not being cached.
    // Acquire and cache json from Instagram.
    $instagram_feed_array = $this
      ->get_instagram_json($this->configuration['simple_instagram_username']);

    //Instagram Feed data.
    $instagram_username = $instagram_feed_array['entry_data']['ProfilePage'][0]['graphql']['user']['username'];
    $instagram_fullname = $instagram_feed_array['entry_data']['ProfilePage'][0]['graphql']['user']['full_name'];
    $instagram_bio = $instagram_feed_array['entry_data']['ProfilePage'][0]['graphql']['user']['biography'];
    $profile_pic_url = $instagram_feed_array['entry_data']['ProfilePage'][0]['graphql']['user']['profile_pic_url'];
    $profile_pic_url_hd = $instagram_feed_array['entry_data']['ProfilePage'][0]['graphql']['user']['profile_pic_url_hd'];

    // This contains the array with links to images, descriptive text & video.
    // TODO: Cache the images in the directory at ://public/simple_instagram_feed
    $instagram_media_array = $instagram_feed_array['entry_data']['ProfilePage'][0]['graphql']['user']['edge_owner_to_timeline_media']['edges'];
    $build = [
      '#unique_id' => $unique_id,
      '#theme' => 'simple_instagram_block',
      '#markup' => $this
        ->t('Simple Instagram Feed'),
      '#attached' => [
        'library' => [
          'simple_instagram_feed/simple_instagram_block',
        ],
        'drupalSettings' => [],
      ],
      '#instagram_username' => $instagram_username,
      '#instagram_fullname' => $instagram_fullname,
      '#instagram_bio' => $instagram_bio,
      '#profile_pic_url' => $profile_pic_url,
      '#cache' => [
        'max-age' => 43200,
      ],
    ];

    // TODO: Review and correct as necessary
    $build['#attached']['drupalSettings']['simple_instagram_feed'][$unique_id] = $this
      ->buildAttachedSettings();
    $build['#attached']['drupalSettings']['simple_instagram_feed'][$unique_id]['unique_id'] = $unique_id;
    return $build;
  }

  /**
   * Build instagram attached settings.
   *
   * @return array
   *   An array of the formatted settings.
   */
  protected function buildAttachedSettings() {
    $config = $this
      ->getConfiguration();

    // NOTE: Should we consume and cache the feed here?
    return [
      'items' => $config['simple_instagram_items'],
      'styling' => $config['simple_instagram_styling'],
      'captions' => $config['simple_instagram_captions'],
      'image_size' => $config['simple_instagram_image_size'],
      'instagram_username' => $config['simple_instagram_username'],
      'display_profile' => $config['simple_instagram_display_profile'],
      'display_biography' => $config['simple_instagram_display_biography'],
      'items_per_row_type' => $config['simple_instagram_items_per_row_type'],
      'items_per_row_default' => $config['simple_instagram_items_per_row_default'] + 1,
      'items_per_row_l_720' => $config['simple_instagram_items_per_row_l_720'] + 1,
      'items_per_row_l_960' => $config['simple_instagram_items_per_row_l_960'] + 1,
      'items_per_row_h_960' => $config['simple_instagram_items_per_row_h_960'] + 1,
      'lazy_load' => $config['simple_instagram_lazy_load'],
    ];
  }

  /**
   * Get Instagram data from non-private Instagram account page
   *
   * @return array
   *   returns decoded Instagram array.
   */
  protected function get_instagram_json($username) {
    $instagram_source = file_get_contents('https://instagram.com/' . $username);
    $shards = explode('window._sharedData = ', $instagram_source);
    $instagram_json = explode(';</script>', $shards[1]);
    $instagram_array = json_decode($instagram_json[0], TRUE);
    return $instagram_array;
  }

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
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. Aliased as: traitBuildConfigurationForm
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.
ContextAwarePluginTrait::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig	protected	property	Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts	public	function		9
ContextAwarePluginTrait::getCacheMaxAge	public	function		7
ContextAwarePluginTrait::getCacheTags	public	function		4
ContextAwarePluginTrait::getContext	public	function
ContextAwarePluginTrait::getContextDefinition	public	function
ContextAwarePluginTrait::getContextDefinitions	public	function
ContextAwarePluginTrait::getContextMapping	public	function
ContextAwarePluginTrait::getContexts	public	function
ContextAwarePluginTrait::getContextValue	public	function
ContextAwarePluginTrait::getContextValues	public	function
ContextAwarePluginTrait::getPluginDefinition	abstract protected	function		1
ContextAwarePluginTrait::setContext	public	function		1
ContextAwarePluginTrait::setContextMapping	public	function
ContextAwarePluginTrait::setContextValue	public	function
ContextAwarePluginTrait::validateContexts	public	function
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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::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	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass	public	function	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
SimpleInstagramBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
SimpleInstagramBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
SimpleInstagramBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
SimpleInstagramBlock::buildAttachedSettings	protected	function	Build instagram attached settings.
SimpleInstagramBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SimpleInstagramBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
SimpleInstagramBlock::get_instagram_json	protected	function	Get Instagram data from non-private Instagram account page
SimpleInstagramBlock::__construct	public	function	Overrides BlockPluginTrait::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.

You are here

class SimpleInstagramBlock in Simple Instagram Feed Block 1.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation