You are here

Home » API reference » Form Block 2.0.x » UserRegisterBlock.php

class UserRegisterBlock in Form Block 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Block/UserRegisterBlock.php \Drupal\formblock\Plugin\Block\UserRegisterBlock

Provides a block for the user registration form.

@Block( id = "formblock_user_register", admin_label = @Translation("User registration form"), category = @Translation("Forms") )

Note that we set module to contact so that blocks will be disabled correctly when the module is disabled.

Hierarchy

Expanded class hierarchy of UserRegisterBlock

File

src/Plugin/Block/UserRegisterBlock.php, line 29

Namespace

Drupal\formblock\Plugin\Block
View source 
class UserRegisterBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity form builder.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityFormBuilder;

  /**
   * EntityDisplayRepository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a new UserRegisterBlock plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity manager.
   * @param \Drupal\Core\Entity\EntityFormBuilderInterface $entityFormBuilder
   *   The entity form builder.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entityDisplayRepository
   *   The entity display repository.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entityTypeManager, EntityFormBuilderInterface $entityFormBuilder, EntityDisplayRepositoryInterface $entityDisplayRepository, ConfigFactoryInterface $configFactory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entityTypeManager;
    $this->entityFormBuilder = $entityFormBuilder;
    $this->entityDisplayRepository = $entityDisplayRepository;
    $this->configFactory = $configFactory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('entity.form_builder'), $container
      ->get('entity_display.repository'), $container
      ->get('config.factory'));
  }

  /**
   * Implements \Drupal\block\BlockBase::build().
   */
  public function build() {
    $build = [];
    $account = $this->entityTypeManager
      ->getStorage('user')
      ->create([]);
    $build['form'] = $this->entityFormBuilder
      ->getForm($account, $this->configuration['form_mode']);
    return $build;
  }

  /**
   * Overrides \Drupal\block\BlockBase::settings().
   */
  public function defaultConfiguration() {
    return [
      'form_mode' => 'register',
    ];
  }

  /**
   * Overrides \Drupal\block\BlockBase::blockForm().
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['user_registration_settings_note'] = [
      '#markup' => $this
        ->t('<b>NOTE</b>: the display of this form is overriden by the option selected on ' . '<a href="/admin/config/people/accounts#edit-admin-role">Account Settings</a>.<br> If you have selected "Administrators Only" ' . 'this form will only show to Administrators regardless of other options selected on this block'),
    ];
    $form['formblock_user_form_mode'] = [
      '#title' => $this
        ->t('Form mode'),
      '#description' => $this
        ->t('Select the form mode that will be shown in the block.'),
      '#type' => 'select',
      '#required' => TRUE,
      '#options' => $this
        ->getFormModes(),
      '#default_value' => $this->configuration['form_mode'],
    ];
    return $form;
  }

  /**
   * Get an array of user form modes.
   *
   * @return array
   *   An array of form modes keyed by machine name.
   */
  protected function getFormModes() {
    $options = [
      'default' => $this
        ->t('Default'),
    ];
    foreach ($this->entityDisplayRepository
      ->getFormModes('user') as $index => $mode) {
      $options[$index] = $mode['label'];
    }
    return $options;
  }

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

  /**
   * The intention here is to fulfil the block settings and honour the site wide config
   * at /admin/config/people/accounts on who can register new accounts and not to enforce through
   * hard coded decisions.
   *
   * {@inheritdoc}
   */
  public function blockAccess(AccountInterface $account) {
    $evaluate = TRUE;
    if (!in_array('administrator', $account
      ->getRoles()) && $this->configFactory
      ->get('user.settings')
      ->get('register') === UserInterface::REGISTER_ADMINISTRATORS_ONLY) {
      $evaluate = FALSE;
    }
    return AccessResult::allowedIf($evaluate)
      ->addCacheContexts([
      'user.roles',
    ])
      ->addCacheTags($this->configFactory
      ->get('user.settings')
      ->getCacheTags());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
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. Aliased as: traitBuildConfigurationForm
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.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract protected function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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::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 Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
UserRegisterBlock::$configFactory protected property The config factory service.
UserRegisterBlock::$entityDisplayRepository protected property EntityDisplayRepository.
UserRegisterBlock::$entityFormBuilder protected property The entity form builder.
UserRegisterBlock::$entityTypeManager protected property The entity manager.
UserRegisterBlock::blockAccess public function The intention here is to fulfil the block settings and honour the site wide config at /admin/config/people/accounts on who can register new accounts and not to enforce through hard coded decisions. Overrides BlockPluginTrait::blockAccess
UserRegisterBlock::blockForm public function Overrides \Drupal\block\BlockBase::blockForm(). Overrides BlockPluginTrait::blockForm
UserRegisterBlock::blockSubmit public function Overrides \Drupal\block\BlockBase::blockSubmit(). Overrides BlockPluginTrait::blockSubmit
UserRegisterBlock::build public function Implements \Drupal\block\BlockBase::build(). Overrides BlockPluginInterface::build
UserRegisterBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UserRegisterBlock::defaultConfiguration public function Overrides \Drupal\block\BlockBase::settings(). Overrides BlockPluginTrait::defaultConfiguration
UserRegisterBlock::getFormModes protected function Get an array of user form modes.
UserRegisterBlock::__construct public function Constructs a new UserRegisterBlock plugin. Overrides BlockPluginTrait::__construct