class CustomDataForm in Shibboleth Authentication 8

Class CustomEmailForm.

@package Drupal\shib_auth\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\shib_auth\Form\CustomDataForm

Expanded class hierarchy of CustomDataForm

1 string reference to 'CustomDataForm'

shib_auth.routing.yml in ./shib_auth.routing.yml: shib_auth.routing.yml

File

src/Form/CustomDataForm.php, line 21

Namespace

Drupal\shib_auth\Form

View source

class CustomDataForm extends FormBase {

  /**
   * Symfony\Component\ClassLoader\ApcClassLoader definition.
   *
   * @var \Symfony\Component\ClassLoader\ApcClassLoader
   */
  protected $shib_session;

  /**
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $temp_store_factory;

  /**
   * @var \Drupal\Core\Session\SessionManagerInterface
   */
  protected $session_manager;

  /**
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $current_user;

  /**
   * @var \Drupal\Core\TempStore\PrivateTempStore
   */
  protected $custom_data_store;

  /**
   * CustomDataForm constructor.
   *
   * @param \Drupal\shib_auth\Login\ShibSessionVars $shib_session
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   * @param \Drupal\Core\Session\SessionManagerInterface $session_manager
   * @param \Drupal\Core\Session\AccountInterface $current_user
   */
  public function __construct(ShibSessionVars $shib_session, PrivateTempStoreFactory $temp_store_factory, SessionManagerInterface $session_manager, AccountInterface $current_user) {
    $this->shib_session = $shib_session;
    $this->temp_store_factory = $temp_store_factory;
    $this->session_manager = $session_manager;
    $this->current_user = $current_user;
    $this->custom_data_store = $this->temp_store_factory
      ->get('shib_auth');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('shib_auth.shib_session_vars'), $container
      ->get('tempstore.private'), $container
      ->get('session_manager'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'custom_data_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#cache'] = [
      'max-age' => 0,
    ];
    $form['email'] = [
      '#type' => 'email',
      '#title' => $this
        ->t('Email'),
      '#default_value' => !empty($this->shib_session
        ->getEmail()) ? $this->shib_session
        ->getEmail() : '',
      '#description' => 'Please enter a valid email address.',
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

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

    // Start Session if it does not exist yet.
    if ($this->current_user
      ->isAnonymous() && !isset($_SESSION['session_started'])) {
      $_SESSION['session_started'] = TRUE;
      $this->session_manager
        ->start();
    }

    // Add custom Email to the session.
    $this->custom_data_store
      ->set('custom_email', $form_state
      ->getValue('email'));

    // Redirect.
    $form_state
      ->setRedirectUrl(Url::fromUri(\Drupal::request()
      ->getSchemeAndHttpHost() . $this->custom_data_store
      ->get('return_url')));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CustomDataForm::$current_user	protected	property
CustomDataForm::$custom_data_store	protected	property
CustomDataForm::$session_manager	protected	property
CustomDataForm::$shib_session	protected	property	Symfony\Component\ClassLoader\ApcClassLoader definition.
CustomDataForm::$temp_store_factory	protected	property
CustomDataForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
CustomDataForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
CustomDataForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CustomDataForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
CustomDataForm::__construct	public	function	CustomDataForm constructor.
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.

You are here

class CustomDataForm in Shibboleth Authentication 8

Hierarchy

File

Namespace

Members

API Navigation