You are here

Home » API reference » Zircon Profile 8 » AddHandler.php

class AddHandler in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 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.

Hierarchy

Expanded class hierarchy of AddHandler

File

core/modules/views_ui/src/Form/Ajax/AddHandler.php, line 18
Contains \Drupal\views_ui\Form\Ajax\AddHandler.

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 = array(
      'options' => array(
        '#theme_wrappers' => array(
          'container',
        ),
        '#attributes' => array(
          'class' => array(
            'scroll',
          ),
          'data-drupal-views-scroll' => TRUE,
        ),
      ),
    );
    $executable = $view
      ->getExecutable();
    if (!$executable
      ->setDisplay($display_id)) {
      $form['markup'] = array(
        '#markup' => $this
          ->t('Invalid display id @display', array(
          '@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', array(
      '@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'] = array(
        '#theme_wrappers' => array(
          'container',
        ),
        '#id' => 'views-filterable-options-controls',
        '#attributes' => [
          'class' => [
            'form--inline',
            'views-filterable-options-controls',
          ],
        ],
      );
      $form['override']['controls']['options_search'] = array(
        '#type' => 'textfield',
        '#title' => $this
          ->t('Search'),
      );
      $groups = array(
        'all' => $this
          ->t('- All -'),
      );
      $form['override']['controls']['group'] = array(
        '#type' => 'select',
        '#title' => $this
          ->t('Type'),
        '#options' => array(),
      );
      $form['options']['name'] = array(
        '#prefix' => '<div class="views-radio-box form-checkboxes views-filterable-options">',
        '#suffix' => '</div>',
        '#type' => 'tableselect',
        '#header' => array(
          'title' => $this
            ->t('Title'),
          'group' => $this
            ->t('Category'),
          'help' => $this
            ->t('Description'),
        ),
        '#js_select' => FALSE,
      );
      $grouped_options = array();
      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] = array(
            '#attributes' => array(
              'class' => array(
                'filterable-option',
                $group,
              ),
            ),
            'title' => array(
              'data' => array(
                '#title' => $option['title'],
                '#plain_text' => $option['title'],
              ),
              'class' => array(
                'title',
              ),
            ),
            'group' => $option['group'],
            'help' => array(
              'data' => $option['help'],
              'class' => array(
                'description',
              ),
            ),
          );
        }
      }
      $form['override']['controls']['group']['#options'] = $groups;
    }
    else {
      $form['options']['markup'] = array(
        '#markup' => '<div class="js-form-item form-item">' . $this
          ->t('There are no @types available to add.', array(
          '@types' => $ltitle,
        )) . '</div>',
      );
    }

    // Add a div to show the selected items
    $form['selected'] = array(
      '#type' => 'item',
      '#markup' => '<span class="views-ui-view-title">' . $this
        ->t('Selected:') . '</span> ' . '<div class="views-selected-options"></div>',
      '#theme_wrappers' => array(
        'form_element',
        'views_ui_container',
      ),
      '#attributes' => array(
        'class' => array(
          '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', array(
      '@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'][] = array(
      $view,
      'submitItemAdd',
    );
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description 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::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$loggerFactory protected property The logger factory.
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 84
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::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.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
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.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator protected function Returns the URL generator service.
UrlGeneratorTrait::redirect protected function Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator public function Sets the URL generator service.
UrlGeneratorTrait::url protected function Generates a URL or path for a specific route based on the given parameters.
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