You are here

Home » API reference » Accelerated Mobile Pages (AMP) 8.3 » AmpSocialShareBlock.php

class AmpSocialShareBlock in Accelerated Mobile Pages (AMP) 8.3

Provides an AMP Social Share block

Plugin annotation


@Block(
  id = "amp_social_share_block",
  admin_label = @Translation("AMP Social Share block"),
)

Hierarchy

Expanded class hierarchy of AmpSocialShareBlock

File

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

Namespace

Drupal\amp\Plugin\Block
View source 
class AmpSocialShareBlock extends BlockBase {
  use AmpFormTrait;

  /**
   * AMP libraries
   *
   * Expected by AmpFormTrait.
   *
   * @return array
   *   The names of the AMP libraries used by this block.
   */
  private function getLibraries() {
    return [
      'amp/amp.social-share',
    ];
  }

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

    // Retrieve existing configuration for this block.
    $config = $this
      ->getConfiguration();
    $build = [
      'amp_social_share' => [
        '#theme' => 'amp_social_share',
        '#providers' => $config['providers'],
        '#app_id' => $config['app_id'],
        '#attached' => [
          'library' => $this
            ->getLibraries(),
        ],
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);

    // Retrieve existing configuration for this block.
    $config = $this
      ->getConfiguration();
    $options = [
      'facebook' => $this
        ->t('Facebook'),
      'twitter' => $this
        ->t('Twitter'),
      'linkedin' => $this
        ->t('LinkedIn'),
      'pinterest' => $this
        ->t('Pinterest'),
      'gplus' => $this
        ->t('G+'),
      'whatsapp' => $this
        ->t('WhatsApp'),
      'tumblr' => $this
        ->t('Tumblr'),
      'email' => $this
        ->t('Email'),
    ];
    $form['providers'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Providers'),
      '#default_value' => isset($config['providers']) ? $config['providers'] : '',
      '#options' => $options,
      '#description' => $this
        ->t('Select the providers you want to allow users to share to.'),
    ];
    $form['app_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Facebook provider id'),
      '#description' => $this
        ->t('Required if Facebook is one of the selected items.'),
      '#default_value' => isset($config['app_id']) ? $config['app_id'] : '',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this
      ->setConfigurationValue('providers', array_filter($form_state
      ->getValue('providers')));
    $this
      ->setConfigurationValue('app_id', $form_state
      ->getValue('app_id'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AmpFormTrait::addToSummary public function Update the summary.
AmpFormTrait::allLayouts public function AMP Layouts.
AmpFormTrait::allSettings public function All settings.
AmpFormTrait::autoplayElement public function The autoplay form element.
AmpFormTrait::controlsElement public function The controls form element.
AmpFormTrait::heightElement public function The height form element.
AmpFormTrait::heightError public function See if selected height is invalid based on the selected layout.
AmpFormTrait::layoutElement public function The layout form element.
AmpFormTrait::layoutSelector public function The #states layout selector.
AmpFormTrait::libraryDescription public function LibraryDescription.
AmpFormTrait::loopElement public function The loop form element.
AmpFormTrait::validAutoplay public function The autoplay setting, taking into account user permissions.
AmpFormTrait::validHeight public function Limit the height based on the layout.
AmpFormTrait::validWidth public function Limit the width based on the layout.
AmpFormTrait::widthElement public function The width form element.
AmpFormTrait::widthError public function See if selected width is invalid based on the selected layout.
AmpSocialShareBlock::blockForm public function Overrides BlockPluginTrait::blockForm
AmpSocialShareBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
AmpSocialShareBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
AmpSocialShareBlock::getLibraries private function AMP libraries
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
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