You are here

Home » API reference » Social simple 8 » SocialSimpleBlock.php

class SocialSimpleBlock in Social simple 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/Block/SocialSimpleBlock.php \Drupal\social_simple\Plugin\Block\SocialSimpleBlock

Provides a 'SocialSimpleBlock' block.

Plugin annotation


@Block(
 id = "social_simple_block",
 admin_label = @Translation("Social simple block"),
)

Hierarchy

Expanded class hierarchy of SocialSimpleBlock

File

src/Plugin/Block/SocialSimpleBlock.php, line 24

Namespace

Drupal\social_simple\Plugin\Block
View source 
class SocialSimpleBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Drupal\Core\Controller\TitleResolver definition.
   *
   * @var \Drupal\Core\Controller\TitleResolver
   */
  protected $titleResolver;

  /**
   * Symfony\Component\HttpFoundation\RequestStack definition.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * Drupal\Core\Routing\CurrentRouteMatch definition.
   *
   * @var \Drupal\Core\Routing\CurrentRouteMatch
   */
  protected $currentRouteMatch;

  /**
   * The Social Simple Generator.
   *
   * @var \Drupal\social_simple\SocialSimpleGenerator
   */
  protected $socialSimpleGenerator;

  /**
   * Constructs a new SocialSimpleBlock object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param string $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Controller\TitleResolver $title_resolver
   *   The title resolver service.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Routing\CurrentRouteMatch $current_route_match
   *   The current route match.
   * @param \Drupal\social_simple\SocialSimpleGenerator $social_simple_generator
   *   The social simple generator service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, TitleResolver $title_resolver, RequestStack $request_stack, CurrentRouteMatch $current_route_match, SocialSimpleGenerator $social_simple_generator) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->titleResolver = $title_resolver;
    $this->requestStack = $request_stack;
    $this->currentRouteMatch = $current_route_match;
    $this->socialSimpleGenerator = $social_simple_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('title_resolver'), $container
      ->get('request_stack'), $container
      ->get('current_route_match'), $container
      ->get('social_simple.generator'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'social_networks' => [],
      'social_share_title' => $this
        ->t('Share on'),
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['social_share_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Social share title'),
      '#description' => $this
        ->t('Set the title to use before the social links displayed'),
      '#default_value' => $this->configuration['social_share_title'],
      '#maxlength' => 255,
      '#size' => 64,
      '#weight' => 1,
    ];
    $options = $this->socialSimpleGenerator
      ->getNetworks();
    $form['social_networks'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Social networks'),
      '#description' => $this
        ->t('Select the social network share link to display'),
      '#options' => $options,
      '#default_value' => $this->configuration['social_networks'],
      '#weight' => 2,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['social_networks'] = $form_state
      ->getValue('social_networks');
    $this->configuration['social_share_title'] = $form_state
      ->getValue('social_share_title');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $title = $this->configuration['social_share_title'];
    $networks = array_filter($this->configuration['social_networks']);
    if (empty($networks)) {
      return $build;
    }

    /* @TODO Find a generic way to fetch from the route the entity its belongs.
     * If the entity is an instance of ContentEntityInterface.
     */
    $entity = NULL;
    if ($node = $this->currentRouteMatch
      ->getParameter('node')) {
      $entity = $node;
    }
    elseif ($taxonomy_term = $this->currentRouteMatch
      ->getParameter('taxonomy_term')) {
      $entity = $taxonomy_term;
    }
    if (!$entity) {
      $keys = $this->currentRouteMatch
        ->getParameters()
        ->keys();
      $entity_type_id = isset($keys[0]) ? $keys[0] : '';
      if (!empty($entity_type_id)) {
        $current_entity = $this->currentRouteMatch
          ->getParameter($entity_type_id);
        if ($current_entity instanceof ContentEntityInterface) {
          $entity = $current_entity;
        }
      }
    }
    $build = $this->socialSimpleGenerator
      ->buildSocialLinks($networks, $title, $entity);
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {

    /** @var \Drupal\node\NodeInterface $node */
    if ($node = $this->currentRouteMatch
      ->getParameter('node')) {
      return Cache::mergeTags(parent::getCacheTags(), $node
        ->getCacheTags());
    }
    elseif ($taxonomy_term = $this->currentRouteMatch
      ->getParameter('taxonomy_term')) {
      return Cache::mergeTags(parent::getCacheTags(), $taxonomy_term
        ->getCacheTags());
    }
    else {
      return parent::getCacheTags();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), [
      'url.path',
    ]);
  }

}

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
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::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
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
SocialSimpleBlock::$currentRouteMatch protected property Drupal\Core\Routing\CurrentRouteMatch definition.
SocialSimpleBlock::$requestStack protected property Symfony\Component\HttpFoundation\RequestStack definition.
SocialSimpleBlock::$socialSimpleGenerator protected property The Social Simple Generator.
SocialSimpleBlock::$titleResolver protected property Drupal\Core\Controller\TitleResolver definition.
SocialSimpleBlock::blockForm public function Overrides BlockPluginTrait::blockForm
SocialSimpleBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
SocialSimpleBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
SocialSimpleBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SocialSimpleBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
SocialSimpleBlock::getCacheContexts public function The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
SocialSimpleBlock::getCacheTags public function The cache tags associated with this object. Overrides ContextAwarePluginBase::getCacheTags
SocialSimpleBlock::__construct public function Constructs a new SocialSimpleBlock object. Overrides BlockPluginTrait::__construct
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