You are here

Home » API reference » Sharerich 8 » SharerichBlock.php

class SharerichBlock in Sharerich 8

Provides a Sharerich block.

Plugin annotation


@Block(
  id = "sharerich",
  admin_label = @Translation("Sharerich"),
)

Hierarchy

Expanded class hierarchy of SharerichBlock

File

src/Plugin/Block/SharerichBlock.php, line 20
Contains \Drupal\sharerich\Plugin\Block\SharerichBlock.

Namespace

Drupal\sharerich\Plugin\Block
View source 
class SharerichBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, \Drupal\Core\Form\FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $configuration = $this->configuration;
    $options = array();
    $entity_storage = \Drupal::entityTypeManager()
      ->getStorage('sharerich');
    foreach ($entity_storage
      ->loadMultiple() as $entity) {
      $entity_id = $entity
        ->id();
      $options[$entity_id] = $entity
        ->label();
    }
    $form['sharerich_set'] = array(
      '#type' => 'select',
      '#title' => t('Sharerich Set'),
      '#options' => $options,
      '#default_value' => isset($configuration['sharerich_set']) ? $configuration['sharerich_set'] : array(),
    );
    $form['orientation'] = array(
      '#type' => 'select',
      '#title' => t('Orientation'),
      '#options' => array(
        'horizontal' => t('Horizontal'),
        'vertical' => t('Vertical'),
      ),
      '#default_value' => isset($configuration['orientation']) ? $configuration['orientation'] : array(),
      '#description' => t('If you set to vertical and place the block on the top of the main content area, it will float on the side.'),
    );
    $form['sticky'] = array(
      '#type' => 'checkbox',
      '#title' => t('Sticky'),
      '#default_value' => isset($configuration['sticky']) ? $configuration['sticky'] : 0,
      '#description' => t('Stick to the top when scrolling.'),
      '#states' => array(
        'visible' => array(
          ':input[name="settings[orientation]"]' => array(
            'value' => 'vertical',
          ),
        ),
      ),
    );
    return $form;
  }

  /**
   * Overrides \Drupal\block\BlockBase::blockSubmit().
   */
  public function blockSubmit($form, \Drupal\Core\Form\FormStateInterface $form_state) {
    $this->configuration['sharerich_set'] = $form_state
      ->getValue('sharerich_set');
    $this->configuration['orientation'] = $form_state
      ->getValue('orientation');
    $this->configuration['sticky'] = $form_state
      ->getValue('sticky');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $entity_storage = \Drupal::entityTypeManager()
      ->getStorage('sharerich');
    if ($sharerich_set = $entity_storage
      ->load($this->configuration['sharerich_set'])) {
      $buttons = array();
      foreach ($sharerich_set
        ->getServices() as $name => $service) {
        $buttons[$name] = [
          '#attributes' => [
            'class' => [
              'sharerich-buttons-wrapper',
              'rrssb-buttons-wrapper',
            ],
          ],
          '#wrapper_attributes' => [
            'class' => [
              'rrssb-' . $name,
            ],
          ],
          '#markup' => $service['markup'],
          '#allowed_tags' => sharerich_allowed_tags(),
        ];
      }

      // Allow other modules to alter the buttons before they are rendered.
      $context = _sharerich_get_token_data();
      \Drupal::moduleHandler()
        ->alter('sharerich_buttons', $buttons, $context);

      // Render tokens.
      foreach ($buttons as &$button) {
        $button['#markup'] = \Drupal::token()
          ->replace($button['#markup'], _sharerich_get_token_data());
      }
      $item_list = [
        '#theme' => 'item_list',
        '#items' => $buttons,
        '#type' => 'ul',
        '#wrapper_attributes' => [
          'class' => [
            'sharerich-wrapper',
            'share-container',
            'sharerich-' . $this->configuration['sharerich_set'],
            'sharerich-' . $this->configuration['orientation'],
            $this->configuration['sticky'] ? 'sharerich-sticky' : '',
          ],
        ],
        '#attributes' => [
          'class' => [
            'sharerich-buttons',
            'rrssb-buttons',
          ],
        ],
        '#attached' => [
          'library' => [
            'sharerich/rrssb',
            'sharerich/sharerich',
          ],
        ],
      ];
      $build['content'] = [
        '#theme' => 'sharerich',
        '#buttons' => $item_list,
        '#cache' => [
          'contexts' => [
            'url.path',
          ],
        ],
      ];
      return $build;
    }
  }

}

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