class FormTestRedirectForm

Same name and namespace in other branches
  1. 9 core/modules/system/tests/modules/form_test/src/Form/FormTestRedirectForm.php \Drupal\form_test\Form\FormTestRedirectForm
  2. 8.9.x core/modules/system/tests/modules/form_test/src/Form/FormTestRedirectForm.php \Drupal\form_test\Form\FormTestRedirectForm
  3. 10 core/modules/system/tests/modules/form_test/src/Form/FormTestRedirectForm.php \Drupal\form_test\Form\FormTestRedirectForm

Form builder to detect form redirect.

@internal

Hierarchy

Expanded class hierarchy of FormTestRedirectForm

1 string reference to 'FormTestRedirectForm'
form_test.routing.yml in core/modules/system/tests/modules/form_test/form_test.routing.yml
core/modules/system/tests/modules/form_test/form_test.routing.yml

File

core/modules/system/tests/modules/form_test/src/Form/FormTestRedirectForm.php, line 14

Namespace

Drupal\form_test\Form
View source
class FormTestRedirectForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'form_test_redirect';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['redirection'] = [
            '#type' => 'checkbox',
            '#title' => t('Use redirection'),
        ];
        $form['destination'] = [
            '#type' => 'textfield',
            '#title' => t('Redirect destination'),
            '#states' => [
                'visible' => [
                    ':input[name="redirection"]' => [
                        'checked' => TRUE,
                    ],
                ],
            ],
        ];
        $form['ignore_destination'] = [
            '#type' => 'checkbox',
            '#title' => t('Ignore destination query parameter'),
            '#states' => [
                'visible' => [
                    ':input[name="redirection"]' => [
                        'checked' => TRUE,
                    ],
                ],
            ],
        ];
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => t('Submit'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        if (!$form_state->isValueEmpty('redirection')) {
            if (!$form_state->isValueEmpty('destination')) {
                // The destination is a random URL, so we can't use routed URLs.
                // @todo Revisit this in https://www.drupal.org/node/2418219.
                $form_state->setRedirectUrl(Url::fromUserInput('/' . $form_state->getValue('destination')));
            }
            $form_state->setIgnoreDestination((bool) $form_state->getValue('ignore_destination'));
        }
        else {
            $form_state->disableRedirect();
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 2
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. 2
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 109
FormBase::currentUser protected function Gets the current user. 2
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.
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 57
FormTestRedirectForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FormTestRedirectForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormTestRedirectForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.