class FacebookCommentsBlock in Facebook Comments Social Plugin 8

Provides a Facebook Comments Block

Plugin annotation


@Block(
  id = "facebook_comments",
  admin_label = @Translation("Facebook comments"),
)

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\facebook_comments\Plugin\Block\FacebookCommentsBlock implements BlockPluginInterface

Expanded class hierarchy of FacebookCommentsBlock

File

src/Plugin/Block/FacebookCommentsBlock.php, line 18

Namespace

Drupal\facebook_comments\Plugin\Block

View source

class FacebookCommentsBlock extends BlockBase implements BlockPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function build() {
    $config = $this
      ->getConfiguration();
    $style = $config['facebook_comments_style'];
    $width = $config['facebook_comments_width'];
    $fluid = $config['facebook_comments_width_fluid'];
    $amount = $config['facebook_comments_amount'];
    $config = \Drupal::config('facebook_comments.settings');
    $appid = $config
      ->get('facebook_comments_appid');
    $admins = $config
      ->get('facebook_comments_admins');
    $ssl = $config
      ->get('facebook_comments_ssl');
    $options = array(
      'absolute' => TRUE,
    );
    $url = Url::fromRoute('<current>', array(), $options)
      ->toString();
    $lang = _facebook_comments_get_language_code();

    // If the path is non-SSL, rewrite it to SSL.
    if ($ssl && strpos($url, "http://") !== FALSE) {
      $url = str_ireplace("http://", "https://", $url);
    }
    if ($fluid) {
      $class = "fb-comments-fluid";
    }
    else {
      $class = "";
    }
    $output = array(
      '#theme' => 'facebook_comments_block',
      '#style' => $style,
      '#amount' => $amount,
      '#width' => $width,
      '#class' => $class,
      '#url' => $url,
      '#lang' => $lang,
    );

    // Display Facebook comments with fluid width
    if ($fluid) {
      $output['#attached']['library'][] = 'facebook_comments/fluid';
    }

    // Add the Facebook App ID if it exists
    if ($appid) {
      $a = array(
        '#tag' => 'meta',
        '#attributes' => array(
          'property' => 'fb:app_id',
          'content' => $appid,
        ),
      );
      $output['#attached']['html_head'][] = [
        $a,
        'facebook_comments',
      ];
    }
    elseif ($admins) {
      $admin = explode(",", $admins);
      foreach ($admin as $key => $value) {
        $a = array(
          '#tag' => 'meta',
          '#attributes' => array(
            'property' => 'fb:admins',
            'content' => trim($value),
          ),
        );
        $output['#attached']['html_head'][] = [
          $a,
          'facebook_comments_' . $key,
        ];
      }
    }
    return $output;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['facebook_comments_style'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Color Scheme'),
      '#default_value' => isset($config['facebook_comments_style']) ? $config['facebook_comments_style'] : 'light',
      '#options' => array(
        'light' => $this
          ->t('Light'),
        'dark' => $this
          ->t('Dark'),
      ),
    );
    $form['facebook_comments_width'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Facebook comment plugin width'),
      '#default_value' => isset($config['facebook_comments_width']) ? $config['facebook_comments_width'] : 208,
      '#description' => $this
        ->t('The width of the Facebook comment plugin for this block, in pixels. Example: 208'),
    );
    $form['facebook_comments_width_fluid'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Fluid Facebook comment plugin width'),
      '#default_value' => isset($config['facebook_comments_width_fluid']) ? $config['facebook_comments_width_fluid'] : 1,
      '#description' => $this
        ->t('Make the width of the Facebook comment plugin for this block fluid (100%). This overrules the block width setting above.'),
    );
    $form['facebook_comments_amount'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Amount of comments to display'),
      '#options' => array(
        1 => 1,
        2 => 2,
        3 => 3,
        5 => 5,
        7 => 7,
        10 => 10,
        15 => 15,
        20 => 20,
        30 => 30,
      ),
      '#default_value' => isset($config['facebook_comments_amount']) ? $config['facebook_comments_amount'] : 5,
    );
    return $form;
  }

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

}

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::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
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
FacebookCommentsBlock::blockForm	public	function	Returns the configuration form elements specific to this block plugin. Overrides BlockPluginTrait::blockForm
FacebookCommentsBlock::blockSubmit	public	function	Adds block type-specific submission handling for the block form. Overrides BlockPluginTrait::blockSubmit
FacebookCommentsBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
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

You are here

class FacebookCommentsBlock in Facebook Comments Social Plugin 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation