class FacebookBoxesFollowBlock in Facebook Boxes 8

Provides the Facebook Follow block.

Plugin annotation


@Block(
 id = "facebook_boxes_follow_block",
 subject = @Translation("Facebook Follow Block"),
 admin_label = @Translation("Facebook Follow Block")
)

View source

class FacebookBoxesFollowBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return array(
      'fb_follow_url' => 'http://www.facebook.com/mediacurrent',
      'fb_follow_layout' => 'standard',
      'fb_follow_showface' => 1,
      'fb_follow_color' => 'light',
      'fb_follow_font' => 'arial',
      'fb_follow_width' => 450,
    );
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['fb_follow_url_text'] = array(
      '#type' => 'textfield',
      '#title' => t('Facebook Page URL'),
      '#description' => t('The full URL of your Facebook page, e.g. http://www.facebook.com/newsignature'),
      '#default_value' => $this->configuration['fb_follow_url'],
    );
    $form['fb_follow_layout_select'] = array(
      '#type' => 'select',
      '#title' => t('Layout'),
      '#options' => array(
        'standard' => 'standard',
        'box_count' => 'box_count',
        'button_count' => 'button_count',
        'button' => 'button',
      ),
      '#default_value' => $this->configuration['fb_follow_layout'],
    );
    $form['fb_follow_showface_checkbox'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show faces'),
      '#description' => t('Specifies whether to display profile photos below the button (standard layout only)'),
      '#return_value' => 1,
      '#default_value' => $this->configuration['fb_follow_showface'],
    );
    $form['fb_follow_colorscheme_select'] = array(
      '#type' => 'select',
      '#title' => t('Color Scheme'),
      '#options' => array(
        'light' => 'light',
        'dark' => 'dark',
      ),
      '#default_value' => $this->configuration['fb_follow_color'],
    );
    $form['fb_follow_font_select'] = array(
      '#type' => 'select',
      '#title' => t('Font'),
      '#options' => array(
        'arial' => 'arial',
        'lucida grande' => 'lucida grande',
        'segoe ui' => 'segoe ui',
        'tahoma' => 'tahoma',
        'trebuchet ms' => 'trebuchet ms',
        'verdana' => 'verdana',
      ),
      '#default_value' => $this->configuration['fb_follow_font'],
    );
    $form['fb_follow_width_text'] = array(
      '#type' => 'textfield',
      '#size' => 10,
      '#maxlength' => 7,
      '#title' => t('Width'),
      '#description' => t('Width of the plugin'),
      '#default_value' => $this->configuration['fb_follow_width'],
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this->configuration['fb_follow_url'] = $values['fb_follow_url_text'];
    $this->configuration['fb_follow_layout'] = $values['fb_follow_layout_select'];
    $this->configuration['fb_follow_showface'] = $values['fb_follow_showface_checkbox'];
    $this->configuration['fb_follow_color'] = $values['fb_follow_colorscheme_select'];
    $this->configuration['fb_follow_font'] = $values['fb_follow_font_select'];
    $this->configuration['fb_follow_width'] = $values['fb_follow_width_text'];
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $url = $this->configuration['fb_follow_url'];
    $layout = $this->configuration['fb_follow_layout'];
    $showfaces = $this->configuration['fb_follow_showface'] ? 'TRUE' : 'FALSE';
    $width = preg_replace('/[^\\d\\s]/', '', $this->configuration['fb_follow_width']);
    $out = array();
    $out[] = '<iframe src="http://www.facebook.com/plugins/follow.php?href=' . $url;
    $out[] = '&amp;layout=' . $layout;
    if ($layout == 'standard') {
      $out[] = '&amp;show_faces=' . $showfaces;
    }
    $out[] = '&amp;colorscheme=' . $this->configuration['fb_follow_color'];
    $out[] = '&amp;font=' . $this->configuration['fb_follow_font'];
    $out[] = '&amp;width=' . $width;
    $out[] = '&amp;height=80" scrolling="no" frameborder="0" ';
    $out[] = 'style="border:none; overflow:hidden; width:' . $width;
    $out[] = ';height:80px; "allowTransparency="true"></iframe>';
    return array(
      '#type' => 'markup',
      '#markup' => implode('', $out),
    );
  }

}

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

You are here

class FacebookBoxesFollowBlock in Facebook Boxes 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation