class SubmitDriven

Same name in other branches
  1. 3.x modules/ajax_example/src/Form/SubmitDriven.php \Drupal\ajax_example\Form\SubmitDriven

Submit a form without a page reload.

Hierarchy

Expanded class hierarchy of SubmitDriven

1 string reference to 'SubmitDriven'
ajax_example.routing.yml in modules/ajax_example/ajax_example.routing.yml
modules/ajax_example/ajax_example.routing.yml

File

modules/ajax_example/src/Form/SubmitDriven.php, line 11

Namespace

Drupal\ajax_example\Form
View source
class SubmitDriven extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'ajax_example_autotextfields';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        // This container wil be replaced by AJAX.
        $form['container'] = [
            '#type' => 'container',
            '#attributes' => [
                'id' => 'box-container',
            ],
        ];
        // The box contains some markup that we can change on a submit request.
        $form['container']['box'] = [
            '#type' => 'markup',
            '#markup' => '<h1>Initial markup for box</h1>',
        ];
        $form['submit'] = [
            '#type' => 'submit',
            // The AJAX handler will call our callback, and will replace whatever page
            // element has id box-container.
'#ajax' => [
                'callback' => '::promptCallback',
                'wrapper' => 'box-container',
            ],
            '#value' => $this->t('Submit'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
    }
    
    /**
     * Callback for submit_driven example.
     *
     * Select the 'box' element, change the markup in it, and return it as a
     * renderable array.
     *
     * @return array
     *   Renderable array (the box element)
     */
    public function promptCallback(array &$form, FormStateInterface $form_state) {
        // In most cases, it is recommended that you put this logic in form
        // generation rather than the callback. Submit driven forms are an
        // exception, because you may not want to return the form at all.
        $element = $form['container'];
        $element['box']['#markup'] = "Clicked submit ({$form_state->getValue('op')}): " . date('c');
        return $element;
    }

}

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. 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.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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.
SubmitDriven::buildForm public function Form constructor. Overrides FormInterface::buildForm
SubmitDriven::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SubmitDriven::promptCallback public function Callback for submit_driven example.
SubmitDriven::submitForm public function Form submission handler. Overrides FormInterface::submitForm