You are here

Home » API reference » Facebook Album 8 » FacebookAlbumBlock.php

class FacebookAlbumBlock in Facebook Album 8

Defines a facebook album block block type.

Plugin annotation


@Block(
  id = "facebook_album",
  admin_label = @Translation("Facebook Album"),
  category = @Translation("Facebook"),
)

Hierarchy

Expanded class hierarchy of FacebookAlbumBlock

File

src/Plugin/Block/FacebookAlbumBlock.php, line 21
Contains \Drupal\facebook_album\Plugin\Block\FacebookAlbumBlock.

Namespace

Drupal\facebook_album\Plugin\Block
View source 
class FacebookAlbumBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $config = $this
      ->getConfiguration();
    $form['page_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Facebook Page ID'),
      '#default_value' => $config['page_id'],
      '#required' => TRUE,
      '#description' => $this
        ->t('The page ID of the page you want to pull the albums from. For example, if your page is https://facebook.com/acromediainc, you would enter acromediainc.'),
    ];
    $form['display'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Display settings'),
    ];
    $form['display']['album_visibility'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Album Visibility'),
      '#default_value' => $config['album_visibility'],
      '#options' => [
        0 => $this
          ->t('Exclude the listed albums'),
        1 => $this
          ->t('Only show the specified albums'),
      ],
    ];
    $form['display']['albums'] = [
      '#type' => 'textarea',
      '#default_value' => implode("\n", $config['albums']),
      '#description' => $this
        ->t('Leave blank to show all albums. Specify albums by using their album IDs. Enter one ID per line.'),
    ];
    $form['display']['album_limit'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Album Limit'),
      '#default_value' => $config['album_limit'],
      '#description' => $this
        ->t('Leave blank or set to 0 if you want to load all albums'),
    ];
    $form['display']['show_title'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show Album Title'),
      '#default_value' => $config['show_title'],
    ];
    $form['display']['show_description'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show Album Description'),
      '#default_value' => $config['show_description'],
    ];
    $form['display']['show_location'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show Album Location'),
      '#default_value' => $config['show_location'],
    ];
    $form['display']['album_thumb_width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Album Thumbnail Width'),
      '#default_value' => $config['album_thumb_width'],
      '#required' => TRUE,
    ];
    $form['display']['album_thumb_height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Album Thumbnail Height'),
      '#default_value' => $config['album_thumb_height'],
      '#required' => TRUE,
    ];
    $form['display']['thumb_width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Photo Thumbnail Width'),
      '#default_value' => $config['thumb_width'],
      '#required' => TRUE,
    ];
    $form['display']['thumb_height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Photo Thumbnail Height'),
      '#default_value' => $config['thumb_height'],
      '#required' => TRUE,
    ];
    $form['display']['colorbox'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Colorbox Options'),
      '#default_value' => $config['colorbox'],
      '#description' => $this
        ->t('Specify any additional Colorbox options here. i.e. "transition:\'elastic\', speed:350"'),
    ];
    return $form;
  }

  /**
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public function blockValidate($form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();

    // Ensure numeric, non-zero values
    foreach ($values['display'] as $display_key => $display_values) {
      if (strpos($display_key, '_width') !== FALSE || strpos($display_key, '_height') !== FALSE) {
        if (!is_numeric($display_values) || $display_values <= 0) {
          $form_state
            ->setErrorByName('display][' . $display_key, $this
            ->t("Invalid value"));
        }
      }
    }
    parent::blockValidate($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this
      ->setConfigurationValue('page_id', $form_state
      ->getValue('page_id'));

    // Get the display values
    $fieldset_values = $form_state
      ->getValue('display');

    // Save Albums as an array
    $albums = explode("\r\n", $fieldset_values['albums']);
    $this
      ->setConfigurationValue('albums', $albums);

    // Save the rest
    foreach ($fieldset_values as $key => $value) {
      if ($key != 'albums') {
        $this
          ->setConfigurationValue($key, $value);
      }
    }
  }

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

    // Due to not having access to any entity info, we're storing settings via a hash
    // @TODO: Find a better way for this
    $config = $this
      ->getConfiguration();
    $hash = hash_hmac('md5', serialize($config), 'facebook_album');

    // Output the wrappers
    $content = [];
    $content['#attributes']['class'] = [
      'block',
      'block-facebook-album',
    ];
    $content[] = [
      '#theme_wrappers' => [
        'container' => [
          '#attributes' => [
            'id' => 'fba-' . $hash,
            'class' => [
              'facebook-album-container',
            ],
          ],
        ],
      ],
      'header' => [
        '#markup' => '<div class="fb-album-header"></div>',
      ],
      'albums' => [
        '#markup' => '<div class="facebook-album-images-container"></div>',
      ],
      'loading' => [
        '#markup' => '<div class="fb-loading-icon"></div>',
      ],
    ];

    // Add the library and settings
    $content['#attached'] = [
      'library' => [
        'facebook_album/facebook_album',
      ],
      'drupalSettings' => [
        'facebook_album' => [
          'fba-' . $hash => $config,
        ],
      ],
    ];
    return $content;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'page_id' => '',
      'album_visibility' => 0,
      'albums' => [],
      'album_limit' => 0,
      'show_title' => 1,
      'show_description' => 1,
      'show_location' => 1,
      'album_thumb_width' => 365,
      'album_thumb_height' => 250,
      'thumb_width' => 160,
      'thumb_height' => 120,
      'colorbox' => 'maxWidth: "95%", maxHeight: "95%"',
    ];
  }

}

Members

Namesort descending 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::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
BlockPluginTrait::__construct public function 22
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
FacebookAlbumBlock::blockForm public function Overrides BlockPluginTrait::blockForm
FacebookAlbumBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
FacebookAlbumBlock::blockValidate public function Overrides BlockPluginTrait::blockValidate
FacebookAlbumBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
FacebookAlbumBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
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.
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