class FblikebuttonBlock in Facebook Like Button 8

Provides a Facebook Like Button Block

Plugin annotation


@Block(
  id = "fblikebutton_block",
  admin_label = @Translation("Facebook Like Button"),
)

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\fblikebutton\Plugin\Block\FblikebuttonBlock

Expanded class hierarchy of FblikebuttonBlock

File

src/Plugin/Block/FblikebuttonBlock.php, line 19

Namespace

Drupal\fblikebutton\Plugin\Block

View source

class FblikebuttonBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    $block = array(
      '#theme' => 'fblikebutton',
      '#layout' => $this->configuration['layout'],
      '#show_faces' => $this->configuration['show_faces'],
      '#action' => $this->configuration['action'],
      '#font' => $this->configuration['font'],
      '#color_scheme' => $this->configuration['color_scheme'],
      '#language' => $this->configuration['language'],
    );

    // If it's not for the current page
    if ($this->configuration['block_url'] != '<current>') {
      $block['#url'] = $this->configuration['block_url'];
    }
    else {

      // Avoid this block to be cached
      $block['#cache'] = array(
        'max-age' => 0,
      );

      /**
       * Drupal uses the /node path to refers to the frontpage. That's why facebook
       * could point to www.example.com/node instead of wwww.example.com.
       *
       * To avoid this, we check if the current path is the frontpage
       */

      // Check if the path is pointing home
      if (\Drupal::routeMatch()
        ->getRouteName() == 'view.frontpage.page_1') {
        global $base_url;
        $block['#url'] = $base_url;
      }
      else {
        $block['#url'] = Url::fromRoute('<current>', array(), array(
          'absolute' => true,
        ))
          ->toString();
      }
    }
    return $block;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    global $base_url;
    return array(
      'block_url' => $base_url,
      'layout' => 'standard',
      'show_faces' => TRUE,
      'action' => 'like',
      'font' => 'arial',
      'color_scheme' => 'light',
      'language' => 'en_US',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['settings'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Button settings'),
      '#open' => TRUE,
    );
    $form['settings']['block_url'] = array(
      '#type' => 'textfield',
      '#default_value' => $config['block_url'],
      '#description' => $this
        ->t('URL of the page to like (could be your homepage or a facebook page e.g.)<br> You can also specify &lt;current&gt; to establish the url for the current viewed page in your site'),
    );
    $form['appearance'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Button appearance'),
      '#open' => FALSE,
    );
    $form['appearance']['layout'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Layout style'),
      '#options' => array(
        'standard' => $this
          ->t('Standard'),
        'box_count' => $this
          ->t('Box Count'),
        'button_count' => $this
          ->t('Button Count'),
        'button' => $this
          ->t('Button'),
      ),
      '#default_value' => $config['layout'],
      '#description' => $this
        ->t('Determines the size and amount of social context next to the button'),
    );

    // The actial values passed in from the options will be converted to a boolean
    // in the validation function, so it doesn't really matter what we use.
    $form['appearance']['show_faces'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Display faces in the box'),
      '#options' => array(
        TRUE => $this
          ->t('Show faces'),
        FALSE => $this
          ->t('Do not show faces'),
      ),
      '#default_value' => $config['show_faces'],
      '#description' => $this
        ->t('Show profile pictures below the button. Only works with Standard layout'),
    );
    $form['appearance']['action'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Verb to display'),
      '#options' => array(
        'like' => $this
          ->t('Like'),
        'recommend' => $this
          ->t('Recommend'),
      ),
      '#default_value' => $config['action'],
      '#description' => $this
        ->t('The verb to display in the button.'),
    );
    $form['appearance']['font'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Font'),
      '#options' => array(
        'arial' => 'Arial',
        'lucida+grande' => 'Lucida Grande',
        'segoe+ui' => 'Segoe UI',
        'tahoma' => 'Tahoma',
        'trebuchet+ms' => 'Trebuchet MS',
        'verdana' => 'Verdana',
      ),
      '#default_value' => $config['font'],
      '#description' => $this
        ->t('The font to display in the button'),
    );
    $form['appearance']['color_scheme'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Color scheme'),
      '#options' => array(
        'light' => $this
          ->t('Light'),
        'dark' => $this
          ->t('Dark'),
      ),
      '#default_value' => $config['color_scheme'],
      '#description' => $this
        ->t('The color scheme of box environtment'),
    );
    $form['appearance']['language'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Language'),
      '#default_value' => $config['language'],
      '#description' => $this
        ->t('Specific language to use. Default is English. Examples:<br />French (France): <em>fr_FR</em><br />French (Canada): <em>fr_CA</em><br />More information can be found at http://developers.facebook.com/docs/internationalization/ and a full XML list can be found at http://www.facebook.com/translations/FacebookLocales.xml'),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $block_url = $values['settings']['block_url'];
    $layout = $values['appearance']['layout'];
    $show_faces = $values['appearance']['show_faces'];
    $action = $values['appearance']['action'];
    $font = $values['appearance']['font'];
    $color_scheme = $values['appearance']['color_scheme'];
    $language = $values['appearance']['language'];
    $this->configuration['block_url'] = $block_url;
    $this->configuration['layout'] = $layout;
    $this->configuration['show_faces'] = $show_faces;
    $this->configuration['block_url'] = $block_url;
    $this->configuration['action'] = $action;
    $this->configuration['font'] = $font;
    $this->configuration['color_scheme'] = $color_scheme;
    $this->configuration['language'] = $language;
  }

}

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

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation