You are here

Home » API reference » Facebook Boxes 8 » FacebookBoxesRecommendsBlock.php

class FacebookBoxesRecommendsBlock in Facebook Boxes 8

Provides the Facebook Recommends block.

Plugin annotation


@Block(
 id = "facebook_boxes_recommends_block",
 subject = @Translation("Facebook Recommends Block"),
 admin_label = @Translation("Facebook Recommends Block")
)

Hierarchy

Expanded class hierarchy of FacebookBoxesRecommendsBlock

File

src/Plugin/Block/FacebookBoxesRecommendsBlock.php, line 22
Contains \Drupal\facebook_boxes\Plugin\Block\FacebookBoxesRecommendsBlock

Namespace

Drupal\facebook_boxes\Plugin\Block
View source 
class FacebookBoxesRecommendsBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    global $base_root;
    return array(
      'fb_rec_domain' => parse_url($base_root, PHP_URL_HOST),
      'fb_rec_width' => 292,
      'fb_rec_height' => 300,
      'fb_rec_colorscheme' => 'light',
      'fb_rec_border' => '',
      'fb_rec_toggles' => array(
        'fb_blank',
        'fb_header',
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    global $base_root;

    /**
     * recommendations box documentation is at https://developers.facebook.com/docs/reference/plugins/recommendations/
     * It includes options that aren't included here, such as app id, actions, and font
     */
    $form['fb_rec_domain_text'] = array(
      '#type' => 'textfield',
      '#title' => t('Site Domain'),
      '#description' => t('The domain to track activity on, e.g. ' . parse_url($base_root, PHP_URL_HOST)),
      '#default_value' => $this->configuration['fb_rec_domain'],
    );
    $form['fb_rec_width_text'] = array(
      '#type' => 'textfield',
      '#size' => 6,
      '#maxlength' => 4,
      '#title' => t('Width'),
      '#description' => t('Width, in pixels, of the Facebook box iframe.'),
      '#default_value' => $this->configuration['fb_rec_width'],
    );
    $form['fb_rec_height_text'] = array(
      '#type' => 'textfield',
      '#size' => 6,
      '#maxlength' => 5,
      '#title' => t('Height'),
      '#description' => t('Height, in pixels, of the Facebook box iframe.'),
      '#default_value' => $this->configuration['fb_rec_height'],
    );
    $form['fb_rec_colorscheme_select'] = array(
      '#type' => 'select',
      '#options' => array(
        'light' => t('Light'),
        'dark' => t('Dark'),
      ),
      '#title' => t('Color scheme'),
      '#description' => t('The color scheme used by the plugin.'),
      '#default_value' => $this->configuration['fb_rec_colorscheme'],
    );
    $form['fb_rec_border_text'] = array(
      '#type' => 'textfield',
      '#size' => 10,
      '#maxlength' => 7,
      '#title' => t("Border color"),
      '#description' => t('Color of 1px border around iframe, including leading "#" such as #ff0000.'),
      '#default_value' => $this->configuration['fb_rec_border'],
    );
    $form['fb_rec_toggles_checks'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Configuration'),
      '#options' => array(
        'fb_blank' => 'Open links in new window/tab',
        'fb_header' => 'Show Facebook Header',
      ),
      '#default_value' => $this->configuration['fb_rec_toggles'],
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this->configuration['fb_rec_domain'] = $values['fb_rec_domain_text'];
    $this->configuration['fb_rec_width'] = $values['fb_rec_width_text'];
    $this->configuration['fb_rec_height'] = $values['fb_rec_height_text'];
    $this->configuration['fb_rec_colorscheme'] = $values['fb_rec_colorscheme_select'];
    $this->configuration['fb_rec_border'] = $values['fb_rec_border_text'];
    $toggles = array();
    foreach ($values['fb_rec_toggles_checks'] as $key => $val) {
      if ($val) {
        $toggles[] = $key;
      }
    }
    $this->configuration['fb_rec_toggles'] = $toggles;
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $height = $this->configuration['fb_rec_height'];
    $width = $this->configuration['fb_rec_width'];
    $opts = $this->configuration['fb_rec_toggles'];
    return array(
      '#type' => 'markup',
      '#markup' => sprintf('<iframe src="//www.facebook.com/plugins/recommendations.php?site=%s&amp;action&amp;width=%u&amp;height=%u&amp;colorscheme=%s&amp;&amp;border_color=%s&amp;header=%s&amp;font&amp;linktarget=%s" scrolling="no" frameborder="0" style="border:none; overflow:hidden; width:%upx; height:%upx;" allowTransparency="true"></iframe>', urlencode($this->configuration['fb_rec_domain']), $width, $height, urlencode($this->configuration['fb_rec_colorscheme']), urlencode($this->configuration['fb_rec_border']), in_array('fb_header', $opts) ? 'true' : 'false', in_array('fb_target', $opts) ? '_blank' : '_top', $width, $height),
    );
  }

}

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
FacebookBoxesRecommendsBlock::blockForm public function Overrides BlockPluginTrait::blockForm
FacebookBoxesRecommendsBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
FacebookBoxesRecommendsBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
FacebookBoxesRecommendsBlock::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