class AddHandler

Same name in other branches

9 core/modules/views_ui/src/Form/Ajax/AddHandler.php \Drupal\views_ui\Form\Ajax\AddHandler
8.9.x core/modules/views_ui/src/Form/Ajax/AddHandler.php \Drupal\views_ui\Form\Ajax\AddHandler
10 core/modules/views_ui/src/Form/Ajax/AddHandler.php \Drupal\views_ui\Form\Ajax\AddHandler

Provides a form for adding an item in the Views UI.

@internal

Hierarchy

class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\views_ui\Form\Ajax\ViewsFormBase extends \Drupal\Core\Form\FormBase implements \Drupal\views_ui\Form\Ajax\ViewsFormInterface
  - class \Drupal\views_ui\Form\Ajax\AddHandler extends \Drupal\views_ui\Form\Ajax\ViewsFormBase

Expanded class hierarchy of AddHandler

2 string references to 'AddHandler'

TaggedHandlersPass::processServiceCollectorPass in core/lib/Drupal/Core/DependencyInjection/Compiler/TaggedHandlersPass.php: Processes a service collector service pass.
TaggedHandlersPassTest::testProcessNoConsumers in core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/TaggedHandlersPassTest.php: Tests without any consumers.

File

core/modules/views_ui/src/Form/Ajax/AddHandler.php, line 15

Namespace

Drupal\views_ui\Form\Ajax

View source

class AddHandler extends ViewsFormBase {
    
    /**
     * Constructs a new AddHandler object.
     */
    public function __construct($type = NULL) {
        $this->setType($type);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormKey() {
        return 'add-handler';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getForm(ViewEntityInterface $view, $display_id, $js, $type = NULL) {
        $this->setType($type);
        return parent::getForm($view, $display_id, $js);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'views_ui_add_handler_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $view = $form_state->get('view');
        $display_id = $form_state->get('display_id');
        $type = $form_state->get('type');
        $form = [
            'options' => [
                '#theme_wrappers' => [
                    'container',
                ],
                '#attributes' => [
                    'class' => [
                        'scroll',
                    ],
                    'data-drupal-views-scroll' => TRUE,
                ],
            ],
        ];
        $executable = $view->getExecutable();
        if (!$executable->setDisplay($display_id)) {
            $form['markup'] = [
                '#markup' => $this->t('Invalid display id @display', [
                    '@display' => $display_id,
                ]),
            ];
            return $form;
        }
        $display =& $executable->displayHandlers
            ->get($display_id);
        $types = ViewExecutable::getHandlerTypes();
        $ltitle = $types[$type]['ltitle'];
        $section = $types[$type]['plural'];
        if (!empty($types[$type]['type'])) {
            $type = $types[$type]['type'];
        }
        $form['#title'] = $this->t('Add @type', [
            '@type' => $ltitle,
        ]);
        $form['#section'] = $display_id . 'add-handler';
        // Add the display override dropdown.
        views_ui_standard_display_dropdown($form, $form_state, $section);
        // Figure out all the base tables allowed based upon what the relationships provide.
        $base_tables = $executable->getBaseTables();
        $options = Views::viewsDataHelper()->fetchFields(array_keys($base_tables), $type, $display->useGroupBy(), $form_state->get('type'));
        if (!empty($options)) {
            $form['override']['controls'] = [
                '#theme_wrappers' => [
                    'container',
                ],
                '#id' => 'views-filterable-options-controls',
                '#attributes' => [
                    'class' => [
                        'form--inline',
                        'views-filterable-options-controls',
                    ],
                ],
            ];
            $form['override']['controls']['options_search'] = [
                '#type' => 'textfield',
                '#title' => $this->t('Search'),
            ];
            $groups = [
                'all' => $this->t('- All -'),
            ];
            $form['override']['controls']['group'] = [
                '#type' => 'select',
                '#title' => $this->t('Category'),
                '#options' => [],
            ];
            $form['options']['name'] = [
                '#prefix' => '<div class="views-radio-box form-checkboxes views-filterable-options">',
                '#suffix' => '</div>',
                '#type' => 'tableselect',
                '#header' => [
                    'title' => $this->t('Title'),
                    'group' => $this->t('Category'),
                    'help' => $this->t('Description'),
                ],
                '#js_select' => FALSE,
            ];
            $grouped_options = [];
            foreach ($options as $key => $option) {
                $group = preg_replace('/[^a-z0-9]/', '-', strtolower($option['group']));
                $groups[$group] = $option['group'];
                $grouped_options[$group][$key] = $option;
                if (!empty($option['aliases']) && is_array($option['aliases'])) {
                    foreach ($option['aliases'] as $id => $alias) {
                        if (empty($alias['base']) || !empty($base_tables[$alias['base']])) {
                            $copy = $option;
                            $copy['group'] = $alias['group'];
                            $copy['title'] = $alias['title'];
                            if (isset($alias['help'])) {
                                $copy['help'] = $alias['help'];
                            }
                            $group = preg_replace('/[^a-z0-9]/', '-', strtolower($copy['group']));
                            $groups[$group] = $copy['group'];
                            $grouped_options[$group][$key . '$' . $id] = $copy;
                        }
                    }
                }
            }
            foreach ($grouped_options as $group => $group_options) {
                foreach ($group_options as $key => $option) {
                    $form['options']['name']['#options'][$key] = [
                        '#attributes' => [
                            'class' => [
                                'filterable-option',
                                $group,
                            ],
                        ],
                        'title' => [
                            'data' => [
                                '#title' => $option['title'],
                                '#plain_text' => $option['title'],
                            ],
                            'class' => [
                                'title',
                            ],
                        ],
                        'group' => $option['group'],
                        'help' => [
                            'data' => $option['help'],
                            'class' => [
                                'description',
                            ],
                        ],
                    ];
                }
            }
            $form['override']['controls']['group']['#options'] = $groups;
        }
        else {
            $form['options']['markup'] = [
                '#markup' => '<div class="js-form-item form-item">' . $this->t('There are no @types available to add.', [
                    '@types' => $ltitle,
                ]) . '</div>',
            ];
        }
        // Add a div to show the selected items
        $form['selected'] = [
            '#type' => 'item',
            '#markup' => '<span class="views-ui-view-title">' . $this->t('Selected:') . '</span> ' . '<div class="views-selected-options"></div>',
            '#theme_wrappers' => [
                'form_element',
                'views_ui_container',
            ],
            '#attributes' => [
                'class' => [
                    'container-inline',
                    'views-add-form-selected',
                    'views-offset-bottom',
                ],
                'data-drupal-views-offset' => 'bottom',
            ],
        ];
        $view->getStandardButtons($form, $form_state, 'views_ui_add_handler_form', $this->t('Add and configure @types', [
            '@types' => $ltitle,
        ]));
        // Remove the default submit function.
        $form['actions']['submit']['#submit'] = array_filter($form['actions']['submit']['#submit'], function ($var) {
            return !(is_array($var) && isset($var[1]) && $var[1] == 'standardSubmit');
        });
        $form['actions']['submit']['#submit'][] = [
            $view,
            'submitItemAdd',
        ];
        return $form;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
AddHandler::buildForm	public	function	Form constructor.	Overrides FormInterface::buildForm
AddHandler::getForm	public	function	Creates a new instance of this form.	Overrides ViewsFormBase::getForm
AddHandler::getFormId	public	function	Returns a unique string identifying the form.	Overrides FormInterface::getFormId
AddHandler::getFormKey	public	function	Returns the key that represents this form.	Overrides ViewsFormInterface::getFormKey
AddHandler::__construct	public	function	Constructs a new AddHandler object.
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.
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.
ViewsFormBase::$id	protected	property	The ID of the item this form is manipulating.
ViewsFormBase::$type	protected	property	The type of item this form is manipulating.
ViewsFormBase::ajaxFormWrapper	protected	function	Wrapper for handling AJAX forms.
ViewsFormBase::getFormState	public	function	Gets the form state for this form.	Overrides ViewsFormInterface::getFormState	1
ViewsFormBase::setID	protected	function	Sets the ID for this form.
ViewsFormBase::setType	protected	function	Sets the type for this form.
ViewsFormBase::submitForm	public	function	Form submission handler.	Overrides FormInterface::submitForm	9
ViewsFormBase::validateForm	public	function	Form validation handler.	Overrides FormBase::validateForm	3

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

class AddHandler

Hierarchy

File

Namespace

Members

Search drupal 11.x

API Navigation

Breadcrumb

class AddHandler

Hierarchy

File

Namespace

Members

Search drupal 11.x

API Navigation