class ConfigHandlerGroup in Drupal 9

Same name and namespace in other branches

8 core/modules/views_ui/src/Form/Ajax/ConfigHandlerGroup.php \Drupal\views_ui\Form\Ajax\ConfigHandlerGroup

Provides a form for configuring grouping information for a Views UI handler.

@internal

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\views_ui\Form\Ajax\ViewsFormBase implements ViewsFormInterface
  - class \Drupal\views_ui\Form\Ajax\ConfigHandlerGroup

Expanded class hierarchy of ConfigHandlerGroup

File

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

Namespace

Drupal\views_ui\Form\Ajax

View source

class ConfigHandlerGroup extends ViewsFormBase {

  /**
   * Constructs a new ConfigHandlerGroup object.
   */
  public function __construct($type = NULL, $id = NULL) {
    $this
      ->setType($type);
    $this
      ->setID($id);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormKey() {
    return 'handler-group';
  }

  /**
   * {@inheritdoc}
   */
  public function getForm(ViewEntityInterface $view, $display_id, $js, $type = NULL, $id = NULL) {
    $this
      ->setType($type);
    $this
      ->setID($id);
    return parent::getForm($view, $display_id, $js);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'views_ui_config_item_group_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');
    $id = $form_state
      ->get('id');
    $form = [
      'options' => [
        '#tree' => TRUE,
        '#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;
    }
    $executable
      ->initQuery();
    $item = $executable
      ->getHandler($display_id, $type, $id);
    if ($item) {
      $handler = $executable->display_handler
        ->getHandler($type, $id);
      if (empty($handler)) {
        $form['markup'] = [
          '#markup' => $this
            ->t("Error: handler for @table > @field doesn't exist!", [
            '@table' => $item['table'],
            '@field' => $item['field'],
          ]),
        ];
      }
      else {
        $handler
          ->init($executable, $executable->display_handler, $item);
        $types = ViewExecutable::getHandlerTypes();
        $form['#title'] = $this
          ->t('Configure aggregation settings for @type %item', [
          '@type' => $types[$type]['lstitle'],
          '%item' => $handler
            ->adminLabel(),
        ]);
        $handler
          ->buildGroupByForm($form['options'], $form_state);
        $form_state
          ->set('handler', $handler);
      }
      $view
        ->getStandardButtons($form, $form_state, 'views_ui_config_item_group_form');
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $view = $form_state
      ->get('view');
    $item =& $form_state
      ->get('handler')->options;
    $type = $form_state
      ->get('type');
    $handler = Views::handlerManager($type)
      ->getHandler($item);
    $executable = $view
      ->getExecutable();
    $handler
      ->init($executable, $executable->display_handler, $item);
    $handler
      ->submitGroupByForm($form, $form_state);

    // Store the item back on the view
    $executable
      ->setHandler($form_state
      ->get('display_id'), $form_state
      ->get('type'), $form_state
      ->get('id'), $item);

    // Write to cache
    $view
      ->cacheSet();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigHandlerGroup::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ConfigHandlerGroup::getForm	public	function	Creates a new instance of this form. Overrides ViewsFormBase::getForm
ConfigHandlerGroup::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigHandlerGroup::getFormKey	public	function	Returns the key that represents this form. Overrides ViewsFormInterface::getFormKey
ConfigHandlerGroup::submitForm	public	function	Form submission handler. Overrides ViewsFormBase::submitForm
ConfigHandlerGroup::__construct	public	function	Constructs a new ConfigHandlerGroup object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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	105
FormBase::currentUser	protected	function	Gets the current user.
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
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.	4
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::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm	3

You are here

class ConfigHandlerGroup in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation