class OneForm

Same name in other branches
  1. 8.x-3.x tests/modules/ctools_wizard_test/src/Form/OneForm.php \Drupal\ctools_wizard_test\Form\OneForm

Simple wizard step form.

Hierarchy

Expanded class hierarchy of OneForm

File

tests/modules/ctools_wizard_test/src/Form/OneForm.php, line 11

Namespace

Drupal\ctools_wizard_test\Form
View source 
class OneForm extends FormBase {
    
    /**
     * Returns a unique string identifying the form.
     *
     * @return string
     *   The unique string identifying the form.
     */
    public function getFormId() {
        return 'ctools_wizard_test_one_form';
    }
    
    /**
     * Form constructor.
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     *
     * @return array
     *   The form structure.
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $cached_values = $form_state->getTemporaryValue('wizard');
        $form['one'] = [
            '#title' => $this->t('One'),
            '#type' => 'textfield',
            '#default_value' => !empty($cached_values['one']) ? $cached_values['one'] : '',
        ];
        $form['dynamic'] = [
            '#title' => $this->t('Dynamic value'),
            '#type' => 'item',
            '#markup' => !empty($cached_values['dynamic']) ? $cached_values['dynamic'] : '',
        ];
        return $form;
    }
    
    /**
     * Form submission handler.
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $keys = [
            'one',
        ];
        $cached_values = $form_state->getTemporaryValue('wizard');
        foreach ($keys as $key) {
            $cached_values[$key] = $form_state->getValue($key);
        }
        $form_state->setTemporaryValue('wizard', $cached_values);
        $this->messenger()
            ->addMessage($this->t('Dynamic value submitted: @value', [
            '@value' => $cached_values['dynamic'],
        ]));
    }

}

Members

Title 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. 3
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. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 111
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
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.
OneForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
OneForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
OneForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.