You are here

Home » API reference » Responsive Share Buttons 8 » ResponsiveShareButtonsBlock.php

class ResponsiveShareButtonsBlock in Responsive Share Buttons 8

Provides a 'Responsive Share buttons' block.

Plugin annotation


@Block(
  id = "responsive_sharing_buttons",
  admin_label = @Translation("Responsive Share buttons block")
)

Hierarchy

Expanded class hierarchy of ResponsiveShareButtonsBlock

File

src/Plugin/Block/ResponsiveShareButtonsBlock.php, line 17

Namespace

Drupal\responsive_share_buttons\Plugin\Block
View source 
class ResponsiveShareButtonsBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    $request = \Drupal::request();
    $route_match = \Drupal::routeMatch();
    $title = \Drupal::service('title_resolver')
      ->getTitle($request, $route_match
      ->getRouteObject());
    if (is_array($title) && isset($title['#markup'])) {
      $title = $title['#markup'];
    }
    elseif (!is_string($title)) {
      $title = \Drupal::config('system.site')
        ->get('name');
    }
    $title = urlencode($title);
    $url = urlencode($request
      ->getUri());
    $links = [];
    $networks = $this
      ->getActiveNetworks();
    foreach ($networks as $network) {
      $links[] = $this
        ->prepareShareLink($network, $url, $title);
    }
    $render_array = [
      '#theme' => 'item_list',
      '#cache' => [
        'contexts' => [
          'url',
        ],
      ],
      '#wrapper_attributes' => [
        'class' => [
          'share-inner-wrp',
        ],
      ],
      '#items' => $links,
      '#attached' => [
        'library' => [
          'responsive_share_buttons/share',
        ],
      ],
    ];
    return $render_array;
  }

  /**
   * Get active social networks.
   */
  protected function getActiveNetworks() {
    $config = \Drupal::config('responsive_share_buttons.settings');
    $networks = $config
      ->get('networks');
    $network_list = [];
    foreach ($networks as $name => $network) {
      if (!empty($network['active'])) {
        $network_list[] = $name;
      }
    }
    return $network_list;
  }

  /**
   * Prepare a sharing link.
   *
   * @param string $network
   *   The name of the social network to use.
   * @param string $url
   *   The URL to share.
   * @param string $title
   *   The title to use.
   *
   * @return string
   *   The link for sharing.
   */
  protected function prepareShareLink($network, $url, $title) {
    $link = '';
    $link_options = [
      'attributes' => [
        'class' => [
          'button-wrap',
          $network,
        ],
      ],
    ];
    switch ($network) {
      case 'delicious':
        $full_url = Url::fromUri('http://del.icio.us/post?url=' . $url . '&title=' . $title);
        $full_url
          ->setOptions($link_options);
        $link = Link::fromTextAndUrl(t('Delicious'), $full_url);
        break;
      case 'digg':
        $full_url = Url::fromUri('http://www.digg.com/submit?phase=2&url=' . $url . '&title=' . $title);
        $full_url
          ->setOptions($link_options);
        $link = Link::fromTextAndUrl(t('Digg it'), $full_url);
        break;
      case 'facebook':
        $full_url = Url::fromUri('https://www.facebook.com/sharer/sharer.php?u=' . $url . '&title=' . $title);
        $full_url
          ->setOptions($link_options);
        $link = Link::fromTextAndUrl(t('Facebook'), $full_url);
        break;
      case 'google':
        $full_url = Url::fromUri('https://plus.google.com/share?url=' . $url . '&title=' . $title);
        $full_url
          ->setOptions($link_options);
        $link = Link::fromTextAndUrl(t('Plus Share'), $full_url);
        break;
      case 'linkedin':
        $full_url = Url::fromUri('http://www.linkedin.com/shareArticle?mini=true&url=' . $url . '&title=' . $title);
        $full_url
          ->setOptions($link_options);
        $link = Link::fromTextAndUrl(t('LinkedIn'), $full_url);
        break;
      case 'pinterest':
        $full_url = Url::fromUri('https://www.pinterest.com/pin/create/button/?url=' . $url . '&description=' . $title);
        $full_url
          ->setOptions($link_options);
        $link = Link::fromTextAndUrl(t('Pinterest'), $full_url);
        break;
      case 'stumbleupon':
        $full_url = Url::fromUri('http://www.stumbleupon.com/submit?url=' . $url . '&title=' . $title);
        $full_url
          ->setOptions($link_options);
        $link = Link::fromTextAndUrl(t('Stumbleupon'), $full_url);
        break;
      case 'twitter':
        $config = \Drupal::config('responsive_share_buttons.settings');
        $twitter_name = $config
          ->get('twitter_name');
        if (!empty($twitter_name)) {
          $title .= ' ' . t('via @@twitter_name', [
            '@twitter_name' => $twitter_name,
          ]);
        }
        $full_url = Url::fromUri('http://twitter.com/home?status=' . $title . ' ' . $url);
        $full_url
          ->setOptions($link_options);
        $link = Link::fromTextAndUrl(t('Tweet'), $full_url, [
          'attributes' => [
            'class' => [
              'button-wrap',
              $network,
            ],
          ],
        ]);
        break;
    }
    return $link;
  }

}

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::blockForm public function 16
BlockPluginTrait::blockSubmit public function 13
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
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
ResponsiveShareButtonsBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
ResponsiveShareButtonsBlock::getActiveNetworks protected function Get active social networks.
ResponsiveShareButtonsBlock::prepareShareLink protected function Prepare a sharing link.
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