You are here

Home » API reference » LoginToboggan 8 » LogintobogganLoginBlock.php

class LogintobogganLoginBlock in LoginToboggan 8

Provides a 'LoginToboggan login' block.

Plugin annotation


@Block(
  id = "logintoboggan_log_in",
  admin_label = @Translation("LoginToboggan log in block"),
  module = "logintoboggan"
)

Hierarchy

Expanded class hierarchy of LogintobogganLoginBlock

File

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

Namespace

Drupal\logintoboggan\Plugin\Block
View source 
class LogintobogganLoginBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * Class constructor.
   *
   * @param array $configuration
   *   Config service.
   * @param string $plugin_id
   *   Plugin ID.
   * @param mixed $plugin_definition
   *   Plugin definition.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, FormBuilderInterface $form_builder) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->formBuilder = $form_builder;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('form_builder'));
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['login_display_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Block display type'),
      '#options' => [
        $this
          ->t('Standard'),
        $this
          ->t('Link'),
        $this
          ->t('Collapsible form'),
      ],
      '#description' => $this
        ->t("'Standard' is a standard login block, \n      'Link' is a login link that returns the user to the original page after \n      logging in, 'Collapsible form' is a javascript collaspible login form."),
      '#default_value' => isset($config['login_display_type']) ? $config['login_display_type'] : '0',
    ];
    $form['login_block_message'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Message'),
      '#description' => $this
        ->t('Message to display at top of block'),
      '#default_value' => isset($config['login_block_message']) ? $config['login_block_message'] : '',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    parent::blockSubmit($form, $form_state);
    $values = $form_state
      ->getValues();
    $this->configuration['login_display_type'] = $values['login_display_type'];
    $this->configuration['login_block_message'] = Xss::filter($values['login_block_message']);
  }

  /**
   * Implements \Drupal\block\BlockBase::blockBuild().
   */
  public function build() {
    $config = $this
      ->getConfiguration();

    // Default type to zero.
    $block_type = $config['login_display_type'] ?? '0';

    // Build a login form. This copies mostly from core UserLoginBlock.
    if ($block_type == '0' || $block_type == '2') {
      $login_form = $this->formBuilder
        ->getForm('Drupal\\user\\Form\\UserLoginForm');
      unset($login_form['name']['#attributes']['autofocus']);

      // When unsetting field descriptions, unset aria-describedby attributes
      // to avoid introducing an accessibility bug.
      unset($login_form['name']['#description']);
      unset($login_form['name']['#attributes']['aria-describedby']);
      unset($login_form['pass']['#description']);
      unset($login_form['pass']['#attributes']['aria-describedby']);
      $login_form['name']['#size'] = 15;
      $login_form['pass']['#size'] = 15;
      $placeholder = 'form_action_p_4r8ITd22yaUvXM6SzwrF6huIvE248hz9k1Sxto3pBvE';
      $login_form['#attached']['placeholders'][$placeholder] = [
        '#lazy_builder' => [
          '\\Drupal\\logintoboggan\\Plugin\\Block\\LogintobogganLoginBlock::renderPlaceholderFormAction',
          [],
        ],
      ];
      $login_form['#action'] = $placeholder;
    }
    $link = [
      '#title' => $this
        ->t('Login in / register'),
      '#type' => 'link',
      '#url' => Url::fromRoute('user.login', [
        'query' => [
          'destination' => '/node/100',
        ],
      ]),
      '#attributes' => [
        'id' => 'toboggan-login-link',
      ],
    ];
    if ($block_type == '1') {
      $login_form = $link;
    }
    $message = !empty($config['login_block_message']) ? $config['login_block_message'] : '';
    $build = [];
    $build['#cache']['max-age'] = 0;
    $build['#theme'] = 'lt_login_block';
    $build['content'] = [
      'user_login_form' => $login_form,
      'message' => $message,
      'login_link' => $link,
      'block_type' => $block_type,
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    if (!$account
      ->isAnonymous()) {
      return AccessResult::forbidden();
    }
    else {
      return AccessResult::allowed();
    }
  }

  /**
   * Lazy_builder callback; renders a form action URL including destination.
   *
   * @return array
   *   A renderable array representing the form action.
   *
   * @see \Drupal\Core\Form\FormBuilder::renderPlaceholderFormAction()
   */
  public static function renderPlaceholderFormAction() {
    return [
      '#type' => 'markup',
      '#markup' => Url::fromRoute('<current>', [], [
        'query' => \Drupal::destination()
          ->getAsArray(),
        'external' => FALSE,
      ])
        ->toString(),
      '#cache' => [
        'contexts' => [
          'url.path',
          'url.query_args',
        ],
      ],
    ];
  }

}

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::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
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
LogintobogganLoginBlock::$formBuilder protected property The form builder.
LogintobogganLoginBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
LogintobogganLoginBlock::blockForm public function Overrides BlockPluginTrait::blockForm
LogintobogganLoginBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
LogintobogganLoginBlock::build public function Implements \Drupal\block\BlockBase::blockBuild(). Overrides BlockPluginInterface::build
LogintobogganLoginBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LogintobogganLoginBlock::renderPlaceholderFormAction public static function Lazy_builder callback; renders a form action URL including destination.
LogintobogganLoginBlock::__construct public function Class constructor. Overrides BlockPluginTrait::__construct
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