class LdapAuthenticationProfileUpdateForm in Lightweight Directory Access Protocol (LDAP) 8.4

Profile update form.

This form is meant to presented to the user if the LDAP account does not have an e-mail address associated with it and we need it for Drupal to function correctly, thus we ask the user.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\ldap_authentication\Form\LdapAuthenticationProfileUpdateForm

1 string reference to 'LdapAuthenticationProfileUpdateForm'

ldap_authentication.routing.yml in ldap_authentication/ldap_authentication.routing.yml

ldap_authentication/ldap_authentication.routing.yml

File

ldap_authentication/src/Form/LdapAuthenticationProfileUpdateForm.php, line 21

Namespace

Drupal\ldap_authentication\Form

class LdapAuthenticationProfileUpdateForm extends FormBase {

  /**
   * Current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'ldap_authentication_profile_update_form';
  }

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   Current user.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity type manager.
   */
  public function __construct(AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager) {
    $this->currentUser = $current_user;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : LdapAuthenticationProfileUpdateForm {
    return new static($container
      ->get('current_user'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) : array {
    if (EmailTemplateService::profileNeedsUpdate()) {
      $form['mail'] = [
        '#type' => 'textfield',
        '#required' => TRUE,
        '#title' => $this
          ->t('Email address'),
      ];
      $form['submit'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Update account'),
      ];
    }
    else {
      $form['submit'] = [
        '#markup' => '<h2>' . $this
          ->t('This form is only available to profiles which need an update.') . '</h2>',
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) : void {
    if (!filter_var($form_state
      ->getValue([
      'mail',
    ]), FILTER_VALIDATE_EMAIL)) {
      $form_state
        ->setErrorByName('mail', $this
        ->t('You must specify a valid email address.'));
    }
    $users = $this->entityTypeManager
      ->getStorage('user')
      ->loadByProperties([
      'mail' => $form_state
        ->getValue([
        'mail',
      ]),
    ]);
    if (count($users) > 0) {
      $form_state
        ->setErrorByName('mail', $this
        ->t('This email address is already in use.'));
    }
    $regex = sprintf('`%s`i', $this
      ->configFactory()
      ->get('ldap_authentication.settings')
      ->get('emailTemplateUsagePromptRegex'));
    if (preg_match($regex, $form_state
      ->getValue([
      'mail',
    ]))) {
      $form_state
        ->setErrorByName('mail', $this
        ->t('This email address still matches the invalid email template.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) : void {

    /** @var \Drupal\user\Entity\User $user */
    $user = $this->entityTypeManager
      ->getStorage('user')
      ->load($this->currentUser
      ->id());
    $user
      ->set('mail', $form_state
      ->getValue('mail'));
    $user
      ->save();
    $this
      ->messenger()
      ->addMessage($this
      ->t('Your profile has been updated.'));
    $form_state
      ->setRedirect('<front>');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
LdapAuthenticationProfileUpdateForm::$currentUser	protected	property	Current user.
LdapAuthenticationProfileUpdateForm::$entityTypeManager	protected	property	Entity type manager.
LdapAuthenticationProfileUpdateForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
LdapAuthenticationProfileUpdateForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
LdapAuthenticationProfileUpdateForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
LdapAuthenticationProfileUpdateForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
LdapAuthenticationProfileUpdateForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
LdapAuthenticationProfileUpdateForm::__construct	public	function	Constructor.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.