class MessageForm

Same name in this branch
  1. 11.x core/modules/contact/src/MessageForm.php \Drupal\contact\MessageForm
Same name in other branches
  1. 9 core/modules/contact/src/MessageForm.php \Drupal\contact\MessageForm
  2. 8.9.x core/modules/contact/src/MessageForm.php \Drupal\contact\MessageForm
  3. 10 core/modules/contact/src/MessageForm.php \Drupal\contact\MessageForm
  4. 10 core/modules/migrate/src/Form/MessageForm.php \Drupal\migrate\Form\MessageForm

Migrate messages form.

@internal

Hierarchy

Expanded class hierarchy of MessageForm

File

core/modules/migrate/src/Form/MessageForm.php, line 15

Namespace

Drupal\migrate\Form
View source
class MessageForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        $form = new static();
        $form->setStringTranslation($container->get('string_translation'));
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'migrate_messages_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $session_filters = $this->getRequest()
            ->getSession()
            ->get('migration_messages_overview_filter', []);
        $form['filters'] = [
            '#type' => 'details',
            '#open' => TRUE,
            '#title' => $this->t('Filter messages'),
            '#weight' => 0,
        ];
        $form['filters']['message'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Message'),
            '#default_value' => $session_filters['message']['value'] ?? '',
        ];
        $form['filters']['severity'] = [
            '#type' => 'select',
            '#title' => $this->t('Severity level'),
            '#default_value' => $session_filters['severity']['value'] ?? [],
            '#options' => [
                MigrationInterface::MESSAGE_ERROR => $this->t('Error'),
                MigrationInterface::MESSAGE_WARNING => $this->t('Warning'),
                MigrationInterface::MESSAGE_NOTICE => $this->t('Notice'),
                MigrationInterface::MESSAGE_INFORMATIONAL => $this->t('Info'),
            ],
            '#multiple' => TRUE,
            '#size' => 4,
        ];
        $form['filters']['actions'] = [
            '#type' => 'actions',
            '#attributes' => [
                'class' => [
                    'container-inline',
                ],
            ],
        ];
        $form['filters']['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Filter'),
        ];
        $form['filters']['actions']['reset'] = [
            '#type' => 'submit',
            '#value' => $this->t('Reset'),
            '#submit' => [
                '::resetForm',
            ],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $filters['message'] = [
            'title' => $this->t('message'),
            'where' => 'msg.message LIKE ?',
            'type' => 'string',
        ];
        $filters['severity'] = [
            'title' => $this->t('Severity'),
            'where' => 'msg.level = ?',
            'type' => 'array',
        ];
        $session_filters = $this->getRequest()
            ->getSession()
            ->get('migration_messages_overview_filter', []);
        foreach ($filters as $name => $filter) {
            if ($form_state->hasValue($name)) {
                $session_filters[$name] = [
                    'where' => $filter['where'],
                    'value' => $form_state->getValue($name),
                    'type' => $filter['type'],
                ];
            }
        }
        $this->getRequest()
            ->getSession()
            ->set('migration_messages_overview_filter', $session_filters);
    }
    
    /**
     * Resets the filter form.
     *
     * @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 resetForm(array $form, FormStateInterface $form_state) : void {
        $this->getRequest()
            ->getSession()
            ->remove('migration_messages_overview_filter');
    }

}

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::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 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.
MessageForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
MessageForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MessageForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MessageForm::resetForm public function Resets the filter form.
MessageForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.