class ApplyForRoleConfirmActionForm in Apply for role 8

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
  - class \Drupal\apply_for_role\Form\ApplyForRoleConfirmActionForm

Expanded class hierarchy of ApplyForRoleConfirmActionForm

1 string reference to 'ApplyForRoleConfirmActionForm'

apply_for_role.routing.yml in ./apply_for_role.routing.yml: apply_for_role.routing.yml

File

src/Form/ApplyForRoleConfirmActionForm.php, line 15

Namespace

Drupal\apply_for_role\Form

View source

class ApplyForRoleConfirmActionForm extends ConfirmFormBase {
  private $application_manager;
  private $form_action;
  private $application;
  private $roles;
  private $username;

  /**
   * Constructor. Loads application manager and Determines if this is an approval or denial confirmation.
   */
  public function __construct() {
    $this->application_manager = new application_manager();
    $current_uri = \Drupal::request()
      ->getRequestUri();

    // Determine whether this is for approval or denial.
    if (strpos($current_uri, '/admin/people/role-applications/approve') !== FALSE) {
      $this->form_action = 'approve';
    }
    elseif (strpos($current_uri, '/admin/people/role-applications/deny') !== FALSE) {
      $this->form_action = 'deny';
    }
  }

  // Returns the form ID.
  public function getFormId() {
    return 'apply_for_role_confirm_action_form';
  }

  /**
   * Returns what the confirmation button will say.
   */
  public function getConfirmText() {
    if ($this->form_action == 'approve') {
      return $this
        ->t('Approve Application');
    }
    else {
      return $this
        ->t('Deny Application');
    }
  }

  /**
   * Creates the question for the form. Essentially page title.
   */
  public function getQuestion() {
    if ($this->form_action == 'approve') {
      return $this
        ->t('Approve Application');
    }
    else {
      return $this
        ->t('Deny Application');
    }
  }

  /**
   * Creates the description for the cancelation form.
   */
  public function getDescription() {
    if ($this->form_action == 'approve') {
      return $this
        ->t('By approving this application, the user %username above will receive the role(s) %role.', array(
        '%role' => $this->roles,
        '%username' => $this->username,
      ));
    }
    else {
      return $this
        ->t('By denying this application, the user %username will NOT receive the role(s) %role and their application will be marked as denied.', array(
        '%role' => $this->roles,
        '%username' => $this->username,
      ));
    }
  }

  /**
   * Provides the URL to go to if the user cancels this action.
   */
  public function getCancelUrl() {

    //this needs to be a valid route otherwise the cancel link won't appear
    return new Url('apply_for_role.applications_listing');
  }

  /**
   * Form builder. Takes AID, populates some base values.
   */
  public function buildForm(array $form, FormStateInterface $form_state, $aid = NULL) {
    if (!($this->application = $this->application_manager
      ->get_application($aid))) {

      // Some one is passing invalid application ID's.
      return $this
        ->redirect('apply_for_role.applications_listing');
    }
    if ($this->application
      ->get('status') != 0) {

      // Some one is passing already active application ID's.
      return $this
        ->redirect('apply_for_role.applications_listing');
    }
    $this->roles = $this->application_manager
      ->rids_to_text($this->application
      ->get('rids'));
    $this->username = $this->application_manager
      ->display_username_for_application($this->application);
    return parent::buildForm($form, $form_state);
  }

  // Determines what the cancellation text should be on the form.
  public function getCancelText() {
    return $this
      ->t('Cancel');
  }

  /**
   * Form submission handler
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // If the form is valid and submitted, either approve or deny the application based on where the form came from.
    if ($this->form_action == 'approve') {
      $this->application_manager
        ->approve_application($this->application);
      $form_state
        ->setRedirect('apply_for_role.applications_listing');
    }
    else {
      $this->application_manager
        ->deny_application($this->application);
      $form_state
        ->setRedirect('apply_for_role.applications_listing');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ApplyForRoleConfirmActionForm::$application	private	property
ApplyForRoleConfirmActionForm::$application_manager	private	property
ApplyForRoleConfirmActionForm::$form_action	private	property
ApplyForRoleConfirmActionForm::$roles	private	property
ApplyForRoleConfirmActionForm::$username	private	property
ApplyForRoleConfirmActionForm::buildForm	public	function	Form builder. Takes AID, populates some base values. Overrides ConfirmFormBase::buildForm
ApplyForRoleConfirmActionForm::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormBase::getCancelText
ApplyForRoleConfirmActionForm::getCancelUrl	public	function	Provides the URL to go to if the user cancels this action. Overrides ConfirmFormInterface::getCancelUrl
ApplyForRoleConfirmActionForm::getConfirmText	public	function	Returns what the confirmation button will say. Overrides ConfirmFormBase::getConfirmText
ApplyForRoleConfirmActionForm::getDescription	public	function	Creates the description for the cancelation form. Overrides ConfirmFormBase::getDescription
ApplyForRoleConfirmActionForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ApplyForRoleConfirmActionForm::getQuestion	public	function	Creates the question for the form. Essentially page title. Overrides ConfirmFormInterface::getQuestion
ApplyForRoleConfirmActionForm::submitForm	public	function	Form submission handler Overrides FormInterface::submitForm
ApplyForRoleConfirmActionForm::__construct	public	function	Constructor. Loads application manager and Determines if this is an approval or denial confirmation.
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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 ApplyForRoleConfirmActionForm in Apply for role 8

Hierarchy

File

Namespace

Members

API Navigation