You are here

Home » API reference » Social Feed 8 » FacebookPostBlock.php

class FacebookPostBlock in Social Feed 8

Provides a 'FacebookPostBlock' block.

Plugin annotation


@Block(
 id = "facebook_post",
 admin_label = @Translation("Facebook Block"),
)

Hierarchy

Expanded class hierarchy of FacebookPostBlock

File

src/Plugin/Block/FacebookPostBlock.php, line 22

Namespace

Drupal\socialfeed\Plugin\Block
View source 
class FacebookPostBlock extends SocialBlockBase implements ContainerFactoryPluginInterface, BlockPluginInterface {

  /**
   * The facebook service.
   *
   * @var \Drupal\socialfeed\Services\FacebookPostCollectorFactory
   */
  protected $facebook;

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

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The logger service.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  private $logger;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, FacebookPostCollectorFactory $facebook, ConfigFactoryInterface $config, AccountInterface $currentUser, LoggerChannelFactoryInterface $logger_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->facebook = $facebook;
    $this->config = $config
      ->get('socialfeed.facebooksettings');
    $this->currentUser = $currentUser;
    $this->logger = $logger_factory
      ->get('socialfeed');
  }

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

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $post_type_options = [
      'permalink_url',
      'status',
      'photo',
      'video',
    ];
    $form['overrides']['page_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Facebook Page Name'),
      '#default_value' => $this
        ->defaultSettingValue('page_name'),
      '#description' => $this
        ->t('eg. If your Facebook page URL is this @facebook, then use YOUR_PAGE_NAME above.', [
        '@facebook' => 'http://www.facebook.com/YOUR_PAGE_NAME',
      ]),
      '#size' => 60,
      '#maxlength' => 100,
      '#required' => TRUE,
    ];
    $form['overrides']['app_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Facebook App ID'),
      '#default_value' => $this
        ->defaultSettingValue('app_id'),
      '#size' => 60,
      '#maxlength' => 100,
      '#required' => TRUE,
    ];
    $form['overrides']['secret_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Facebook Secret Key'),
      '#default_value' => $this
        ->defaultSettingValue('secret_key'),
      '#size' => 60,
      '#maxlength' => 100,
      '#required' => TRUE,
    ];
    $form['overrides']['user_token'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Facebook User Token'),
      '#default_value' => $this
        ->defaultSettingValue('user_token'),
      '#description' => $this
        ->t('This is available at @facebook', [
        '@facebook' => 'https://developers.facebook.com/tools/explorer/',
      ]),
      '#size' => 60,
      '#maxlength' => 255,
      '#required' => TRUE,
    ];
    $form['overrides']['user_token'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Facebook User Token'),
      '#default_value' => $this
        ->defaultSettingValue('user_token'),
      '#size' => 60,
      '#maxlength' => 255,
      '#required' => TRUE,
    ];
    $form['overrides']['no_feeds'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Number of Feeds'),
      '#default_value' => $this
        ->defaultSettingValue('no_feeds'),
      '#size' => 60,
      '#maxlength' => 60,
      '#max' => 100,
      '#min' => 1,
    ];
    $form['overrides']['all_types'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show all post types'),
      '#default_value' => $this
        ->defaultSettingValue('all_types'),
      '#states' => [
        'required' => [],
      ],
    ];
    $form['overrides']['post_type'] = [
      '#type' => 'select',
      '#title' => 'Select your post type(s) to show',
      '#default_value' => $this
        ->defaultSettingValue('post_type'),
      '#options' => array_combine($post_type_options, $post_type_options),
      '#empty_option' => $this
        ->t('- Select -'),
      '#states' => [
        'visible' => [
          ':input[name="settings[overrides][all_types]"]' => [
            'checked' => FALSE,
          ],
        ],
        'required' => [
          ':input[name="settings[overrides][all_types]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $this
      ->blockFormElementStates($form);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $items = [];
    $block_settings = $this
      ->getConfiguration();
    try {
      if ($block_settings['override']) {
        $facebook = $this->facebook
          ->createInstance($block_settings['app_id'], $block_settings['secret_key'], $block_settings['user_token'], $this->config
          ->get('page_name'));
      }
      else {
        $facebook = $this->facebook
          ->createInstance($this->config
          ->get('app_id'), $this->config
          ->get('secret_key'), $this->config
          ->get('user_token'), $this->config
          ->get('page_name'));
      }
      $post_types = $this
        ->getSetting('all_types');
      if (!$post_types) {
        $post_types = $this
          ->getSetting('post_type');
      }
      $posts = $facebook
        ->getPosts($this
        ->getSetting('page_name'), $post_types, $this
        ->getSetting('no_feeds'));
      foreach ($posts as $post) {
        if ($post['status_type'] = !NULL) {
          $items[] = [
            '#theme' => [
              'socialfeed_facebook_post__' . $post['status_type'],
              'socialfeed_facebook_post',
            ],
            '#post' => $post,
            '#cache' => [
              // Cache for 1 hour.
              'max-age' => 60 * 60,
              'cache tags' => $this->config
                ->getCacheTags(),
              'context' => $this->config
                ->getCacheContexts(),
            ],
          ];
        }
      }
    } catch (Exception $exception) {
      $this->logger
        ->error($this
        ->t('Exception: @exception', [
        '@exception' => $exception
          ->getMessage(),
      ]));
    }
    $build['posts'] = [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
    return $build;
  }

}

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::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::defaultConfiguration public function 19
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
FacebookPostBlock::$config protected property The config factory.
FacebookPostBlock::$currentUser protected property The current user. Overrides SocialBlockBase::$currentUser
FacebookPostBlock::$facebook protected property The facebook service.
FacebookPostBlock::$logger private property The logger service.
FacebookPostBlock::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides SocialBlockBase::blockForm
FacebookPostBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
FacebookPostBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FacebookPostBlock::__construct public function Overrides BlockPluginTrait::__construct
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
SocialBlockBase::blockFormElementStates protected function Apply state based on the override field.
SocialBlockBase::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
SocialBlockBase::defaultSettingValue protected function Defines the default settings.
SocialBlockBase::getInvalidConfigurationWarning public function Returns a message.
SocialBlockBase::getSetting public function Returns the value of a given storage setting.
SocialBlockBase::invalidConfigurationValidator public function Validation handler for social blocks with invalid configuration.
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