You are here

Home » API reference » Facebook Page Plugin 8.2 » FBLikeboxBlock.php

class FBLikeboxBlock in Facebook Page Plugin 8.2

Same name and namespace in other branches
  1. 8 src/Plugin/Block/FBLikeboxBlock.php \Drupal\fb_likebox\Plugin\Block\FBLikeboxBlock

Provides a configurable block with Facebook Likebox's plugin.

Plugin annotation


@Block(
  id = "fb_likebox_block",
  admin_label = @Translation("FB Likebox"),
  category = @Translation("FB Likebox")
)

Hierarchy

Expanded class hierarchy of FBLikeboxBlock

File

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

Namespace

Drupal\fb_likebox\Plugin\Block
View source 
class FBLikeboxBlock extends BlockBase {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $config = $this
      ->getConfiguration();

    // Facebook Widget settings.
    $form['fb_likebox_display_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Display options'),
      '#open' => TRUE,
    ];
    $form['fb_likebox_display_settings']['url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('Facebook Page URL'),
      '#default_value' => $config['url'],
      '#description' => $this
        ->t('Enter the Facebook Page URL. I.e.: https://www.facebook.com/FacebookDevelopers'),
      '#required' => TRUE,
    ];
    $form['fb_likebox_display_settings']['app_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Facebook App ID'),
      '#default_value' => $config['app_id'],
    ];
    $form['fb_likebox_display_settings']['hide_header'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide cover photo in the header'),
      '#default_value' => $config['hide_header'],
    ];
    $form['fb_likebox_display_settings']['stream'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Show posts from the Page's timeline"),
      '#default_value' => $config['stream'],
    ];
    $form['fb_likebox_display_settings']['events'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show posts from the Page'),
      '#default_value' => $config['events'],
    ];
    $form['fb_likebox_display_settings']['messages'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show messages from the Page'),
      '#default_value' => $config['messages'],
    ];
    $form['fb_likebox_display_settings']['show_faces'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show profile photos when friends like this'),
      '#default_value' => $config['show_faces'],
    ];
    $form['fb_likebox_display_settings']['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('iFrame title attribute'),
      '#default_value' => $config['title'],
      '#description' => $this
        ->t('The value of the title attribute.'),
      '#required' => TRUE,
    ];
    $form['fb_likebox_display_settings']['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $config['width'],
      '#min' => 180,
      '#max' => 500,
      '#description' => $this
        ->t('The width of the Facebook likebox. Must be a number between 180 and 500, limits included.'),
      '#required' => TRUE,
    ];
    $form['fb_likebox_display_settings']['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $config['height'],
      '#min' => 70,
      '#description' => $this
        ->t('The height of the plugin in pixels. Must be a number bigger than 70.'),
      '#required' => TRUE,
    ];
    $form['fb_likebox_display_settings']['hide_cta'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide the custom call to action button (if available)'),
      '#default_value' => $config['hide_cta'],
    ];
    $form['fb_likebox_display_settings']['small_header'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use the small header instead'),
      '#default_value' => $config['small_header'],
    ];
    $form['fb_likebox_display_settings']['adapt_container_width'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Try to fit inside the container width'),
      '#default_value' => $config['adapt_container_width'],
    ];
    $form['fb_likebox_display_settings']['language'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Choose your language'),
      '#options' => $this
        ->likeboxLanguages(),
      '#default_value' => $config['language'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $display_settings = $form_state
      ->getValue('fb_likebox_display_settings');
    foreach ($display_settings as $key => $value) {
      $this
        ->setConfigurationValue($key, $value);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $config = $this
      ->getConfiguration();
    $fb_tabs = [];
    if ($config['stream'] == 1) {
      $fb_tabs[] = 'timeline';
    }
    if ($config['events'] == 1) {
      $fb_tabs[] = 'events';
    }
    if ($config['messages'] == 1) {
      $fb_tabs[] = 'messages';
    }
    $render['root-div'] = [
      '#type' => 'container',
      '#attributes' => [
        'id' => [
          'fb-root',
        ],
      ],
    ];
    $render['block'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'fb-page',
        ],
        'data-href' => $config['url'],
        'data-width' => $config['width'],
        'data-height' => $config['height'],
        'data-tabs' => implode(',', $fb_tabs),
        'data-hide-cover' => $config['hide_header'],
        'data-show-facepile' => $config['show_faces'],
        'data-hide-cta' => $config['hide_cta'],
        'data-small-header' => $config['small_header'],
        'data-adapt-container-width' => $config['adapt_container_width'],
      ],
    ];
    $render['block']['blockquote'] = [
      '#type' => 'link',
      '#title' => $config['title'],
      '#href' => $config['url'],
      '#prefix' => '<blockquote cite="' . $config['url'] . '" class = "fb-xfbml-parse-ignore">',
      '#suffix' => '</blockquote>',
    ];
    $render['#attached']['library'][] = 'fb_likebox/drupal.fb_likebox';
    $render['#attached']['drupalSettings']['fbLikeboxAppId'] = $config['app_id'];
    $render['#attached']['drupalSettings']['fbLikeboxLanguage'] = $config['language'];
    return $render;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'url' => '',
      'app_id' => '',
      'hide_header' => '',
      'stream' => '',
      'events' => '',
      'messages' => '',
      'show_faces' => '',
      'title' => '',
      'width' => '',
      'height' => '',
      'hide_cta' => '',
      'small_header' => '',
      'adapt_container_width' => '',
      'language' => [],
    ];
  }

  /**
   * Returns a list of all available facebook likebox languages.
   *
   * @return array
   *   Returns a list of all available facebook likebox languages.
   */
  protected function likeboxLanguages() {
    $languages = [
      'af_ZA' => $this
        ->t('Afrikaans'),
      'ak_GH' => $this
        ->t('Akan'),
      'am_ET' => $this
        ->t('Amharic'),
      'ar_AR' => $this
        ->t('Arabic'),
      'as_IN' => $this
        ->t('Assamese'),
      'ay_BO' => $this
        ->t('Aymara'),
      'az_AZ' => $this
        ->t('Azerbaijani'),
      'be_BY' => $this
        ->t('Belarusian'),
      'bg_BG' => $this
        ->t('Bulgarian'),
      'bn_IN' => $this
        ->t('Bengali'),
      'br_FR' => $this
        ->t('Breton'),
      'bs_BA' => $this
        ->t('Bosnian'),
      'ca_ES' => $this
        ->t('Catalan'),
      'cb_IQ' => $this
        ->t('Sorani Kurdish'),
      'ck_US' => $this
        ->t('Cherokee'),
      'co_FR' => $this
        ->t('Corsican'),
      'cs_CZ' => $this
        ->t('Czech'),
      'cx_PH' => $this
        ->t('Cebuano'),
      'cy_GB' => $this
        ->t('Welsh'),
      'da_DK' => $this
        ->t('Danish'),
      'de_DE' => $this
        ->t('German'),
      'el_GR' => $this
        ->t('Greek'),
      'en_EN' => $this
        ->t('English'),
      'en_GB' => $this
        ->t('English (UK)'),
      'en_IN' => $this
        ->t('English (India)'),
      'en_PI' => $this
        ->t('English (Pirate)'),
      'en_UD' => $this
        ->t('English (Upside Down)'),
      'en_US' => $this
        ->t('English (US)'),
      'eo_EO' => $this
        ->t('Esperanto'),
      'es_CL' => $this
        ->t('Spanish (Chile)'),
      'es_CO' => $this
        ->t('Spanish (Colombia)'),
      'es_ES' => $this
        ->t('Spanish (Spain)'),
      'es_LA' => $this
        ->t('Spanish'),
      'es_MX' => $this
        ->t('Spanish (Mexico)'),
      'es_VE' => $this
        ->t('Spanish (Venezuela)'),
      'et_EE' => $this
        ->t('Estonian'),
      'eu_ES' => $this
        ->t('Basque'),
      'fa_IR' => $this
        ->t('Persian'),
      'fb_LT' => $this
        ->t('Leet Speak'),
      'ff_NG' => $this
        ->t('Fulah'),
      'fi_FI' => $this
        ->t('Finnish'),
      'fo_FO' => $this
        ->t('Faroese'),
      'fr_CA' => $this
        ->t('French (Canada)'),
      'fr_FR' => $this
        ->t('French (France)'),
      'fy_NL' => $this
        ->t('Frisian'),
      'ga_IE' => $this
        ->t('Irish'),
      'gl_ES' => $this
        ->t('Galician'),
      'gn_PY' => $this
        ->t('Guarani'),
      'gu_IN' => $this
        ->t('Gujarati'),
      'gx_GR' => $this
        ->t('Classical Greek'),
      'ha_NG' => $this
        ->t('Hausa'),
      'he_IL' => $this
        ->t('Hebrew'),
      'hi_IN' => $this
        ->t('Hindi'),
      'hr_HR' => $this
        ->t('Croatian'),
      'hu_HU' => $this
        ->t('Hungarian'),
      'hy_AM' => $this
        ->t('Armenian'),
      'id_ID' => $this
        ->t('Indonesian'),
      'ig_NG' => $this
        ->t('Igbo'),
      'is_IS' => $this
        ->t('Icelandic'),
      'it_IT' => $this
        ->t('Italian'),
      'ja_JP' => $this
        ->t('Japanese'),
      'ja_KS' => $this
        ->t('Japanese (Kansai)'),
      'jv_ID' => $this
        ->t('Javanese'),
      'ka_GE' => $this
        ->t('Georgian'),
      'kk_KZ' => $this
        ->t('Kazakh'),
      'km_KH' => $this
        ->t('Khmer'),
      'kn_IN' => $this
        ->t('Kannada'),
      'ko_KR' => $this
        ->t('Korean'),
      'ku_TR' => $this
        ->t('Kurdish (Kurmanji)'),
      'la_VA' => $this
        ->t('Latin'),
      'lg_UG' => $this
        ->t('Ganda'),
      'li_NL' => $this
        ->t('Limburgish'),
      'ln_CD' => $this
        ->t('Lingala'),
      'lo_LA' => $this
        ->t('Lao'),
      'lt_LT' => $this
        ->t('Lithuanian'),
      'lv_LV' => $this
        ->t('Latvian'),
      'mg_MG' => $this
        ->t('Malagasy'),
      'mk_MK' => $this
        ->t('Macedonian'),
      'ml_IN' => $this
        ->t('Malayalam'),
      'mn_MN' => $this
        ->t('Mongolian'),
      'mr_IN' => $this
        ->t('Marathi'),
      'ms_MY' => $this
        ->t('Malay'),
      'mt_MT' => $this
        ->t('Maltese'),
      'my_MM' => $this
        ->t('Burmese'),
      'nb_NO' => $this
        ->t('Norwegian (bokmal)'),
      'nd_ZW' => $this
        ->t('Ndebele'),
      'ne_NP' => $this
        ->t('Nepali'),
      'nl_BE' => $this
        ->t('Dutch (Belgium)'),
      'nl_NL' => $this
        ->t('Dutch'),
      'nn_NO' => $this
        ->t('Norwegian (nynorsk)'),
      'ny_MW' => $this
        ->t('Chewa'),
      'or_IN' => $this
        ->t('Oriya'),
      'pa_IN' => $this
        ->t('Punjabi'),
      'pl_PL' => $this
        ->t('Polish'),
      'ps_AF' => $this
        ->t('Pashto'),
      'pt_BR' => $this
        ->t('Portuguese (Brazil)'),
      'pt_PT' => $this
        ->t('Portuguese (Portugal)'),
      'qu_PE' => $this
        ->t('Quechua'),
      'rm_CH' => $this
        ->t('Romansh'),
      'ro_RO' => $this
        ->t('Romanian'),
      'ru_RU' => $this
        ->t('Russian'),
      'rw_RW' => $this
        ->t('Kinyarwanda'),
      'sa_IN' => $this
        ->t('Sanskrit'),
      'sc_IT' => $this
        ->t('Sardinian'),
      'se_NO' => $this
        ->t('Northern Sámi'),
      'si_LK' => $this
        ->t('Sinhala'),
      'sk_SK' => $this
        ->t('Slovak'),
      'sl_SI' => $this
        ->t('Slovenian'),
      'sn_ZW' => $this
        ->t('Shona'),
      'so_SO' => $this
        ->t('Somali'),
      'sq_AL' => $this
        ->t('Albanian'),
      'sr_RS' => $this
        ->t('Serbian'),
      'sv_SE' => $this
        ->t('Swedish'),
      'sw_KE' => $this
        ->t('Swahili'),
      'sy_SY' => $this
        ->t('Syriac'),
      'sz_PL' => $this
        ->t('Silesian'),
      'ta_IN' => $this
        ->t('Tamil'),
      'te_IN' => $this
        ->t('Telugu'),
      'tg_TJ' => $this
        ->t('Tajik'),
      'th_TH' => $this
        ->t('Thai'),
      'tk_TM' => $this
        ->t('Turkmen'),
      'tl_PH' => $this
        ->t('Filipino'),
      'tl_ST' => $this
        ->t('Klingon'),
      'tr_TR' => $this
        ->t('Turkish'),
      'tt_RU' => $this
        ->t('Tatar'),
      'tz_MA' => $this
        ->t('Tamazight'),
      'uk_UA' => $this
        ->t('Ukrainian'),
      'ur_PK' => $this
        ->t('Urdu'),
      'uz_UZ' => $this
        ->t('Uzbek'),
      'vi_VN' => $this
        ->t('Vietnamese'),
      'wo_SN' => $this
        ->t('Wolof'),
      'xh_ZA' => $this
        ->t('Xhosa'),
      'yi_DE' => $this
        ->t('Yiddish'),
      'yo_NG' => $this
        ->t('Yoruba'),
      'zh_CN' => $this
        ->t('Simplified Chinese (China)'),
      'zh_HK' => $this
        ->t('Traditional Chinese (Hong Kong)'),
      'zh_TW' => $this
        ->t('Traditional Chinese (Taiwan)'),
      'zu_ZA' => $this
        ->t('Zulu'),
      'zz_TR' => $this
        ->t('Zazaki'),
    ];
    asort($languages);
    return $languages;
  }

}

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::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
FBLikeboxBlock::blockForm public function Overrides BlockPluginTrait::blockForm
FBLikeboxBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
FBLikeboxBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
FBLikeboxBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
FBLikeboxBlock::likeboxLanguages protected function Returns a list of all available facebook likebox languages.
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