class ConfigHandlerExtra in Zircon Profile 8

Same name and namespace in other branches

8.0 core/modules/views_ui/src/Form/Ajax/ConfigHandlerExtra.php \Drupal\views_ui\Form\Ajax\ConfigHandlerExtra

Provides a form for configuring extra information for a Views UI item.

View source

class ConfigHandlerExtra extends ViewsFormBase {

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

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

  /**
   * {@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_extra_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 = array(
      'options' => array(
        '#tree' => true,
        '#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;
    }
    $item = $executable
      ->getHandler($display_id, $type, $id);
    if ($item) {
      $handler = $executable->display_handler
        ->getHandler($type, $id);
      if (empty($handler)) {
        $form['markup'] = array(
          '#markup' => $this
            ->t("Error: handler for @table > @field doesn't exist!", array(
            '@table' => $item['table'],
            '@field' => $item['field'],
          )),
        );
      }
      else {
        $handler
          ->init($executable, $executable->display_handler, $item);
        $types = ViewExecutable::getHandlerTypes();
        $form['#title'] = $this
          ->t('Configure extra settings for @type %item', array(
          '@type' => $types[$type]['lstitle'],
          '%item' => $handler
            ->adminLabel(),
        ));
        $form['#section'] = $display_id . '-' . $type . '-' . $id;

        // Get form from the handler.
        $handler
          ->buildExtraOptionsForm($form['options'], $form_state);
        $form_state
          ->set('handler', $handler);
      }
      $view
        ->getStandardButtons($form, $form_state, 'views_ui_config_item_extra_form');
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->get('handler')
      ->validateExtraOptionsForm($form['options'], $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $view = $form_state
      ->get('view');
    $handler = $form_state
      ->get('handler');

    // Run it through the handler's submit function.
    $handler
      ->submitExtraOptionsForm($form['options'], $form_state);
    $item = $handler->options;

    // Store the data we're given.
    foreach ($form_state
      ->getValue('options') as $key => $value) {
      $item[$key] = $value;
    }

    // Store the item back on the view
    $view
      ->getExecutable()
      ->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
ConfigHandlerExtra::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ConfigHandlerExtra::getForm	public	function	Creates a new instance of this form. Overrides ViewsFormBase::getForm
ConfigHandlerExtra::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigHandlerExtra::getFormKey	public	function	Returns the key that represents this form. Overrides ViewsFormInterface::getFormKey
ConfigHandlerExtra::submitForm	public	function	Form submission handler. Overrides ViewsFormBase::submitForm
ConfigHandlerExtra::validateForm	public	function	Form validation handler. Overrides ViewsFormBase::validateForm
ConfigHandlerExtra::__construct	public	function	Constructs a new ConfigHandlerExtra 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.

You are here

class ConfigHandlerExtra in Zircon Profile 8

Hierarchy

File

Namespace

Members

API Navigation