class Display in Zircon Profile 8

Same name and namespace in other branches

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

Provides a form for editing the Views display.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\views_ui\Form\Ajax\ViewsFormBase implements ViewsFormInterface
  - class \Drupal\views_ui\Form\Ajax\Display

Expanded class hierarchy of Display

5 string references to 'Display'

ReorderDisplays::buildForm in core/modules/views_ui/src/Form/Ajax/ReorderDisplays.php: Form constructor.
Result::buildOptionsForm in core/modules/views/src/Plugin/views/area/Result.php: Provide a form to edit options for this plugin.
template_preprocess_file_widget_multiple in core/modules/file/file.field.inc: Prepares variables for multi file form widget templates.
ViewListBuilderTest::testBuildRowEntityList in core/modules/views_ui/tests/src/Unit/ViewListBuilderTest.php: Tests the listing of displays on a views list builder.
views.display.schema.yml in core/modules/views/config/schema/views.display.schema.yml: core/modules/views/config/schema/views.display.schema.yml

File

core/modules/views_ui/src/Form/Ajax/Display.php, line 16: Contains \Drupal\views_ui\Form\Ajax\Display.

Namespace

Drupal\views_ui\Form\Ajax

View source

class Display extends ViewsFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function getFormKey() {
    return 'display';
  }

  /**
   * {@inheritdoc}
   *
   * @todo Remove this and switch all usage of $form_state->get('section') to
   *   $form_state->get('type').
   */
  public function getFormState(ViewEntityInterface $view, $display_id, $js) {
    $form_state = parent::getFormState($view, $display_id, $js);
    $form_state
      ->set('section', $this->type);
    return $form_state;
  }

  /**
   * {@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_edit_display_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $view = $form_state
      ->get('view');
    $display_id = $form_state
      ->get('display_id');
    $executable = $view
      ->getExecutable();
    if (!$executable
      ->setDisplay($display_id)) {
      $form['markup'] = array(
        '#markup' => $this
          ->t('Invalid display id @display', array(
          '@display' => $display_id,
        )),
      );
      return $form;
    }

    // Get form from the handler.
    $form['options'] = array(
      '#theme_wrappers' => array(
        'container',
      ),
      '#attributes' => array(
        'class' => array(
          'scroll',
        ),
        'data-drupal-views-scroll' => TRUE,
      ),
    );
    $executable->display_handler
      ->buildOptionsForm($form['options'], $form_state);

    // The handler options form sets $form['#title'], which we need on the entire
    // $form instead of just the ['options'] section.
    $form['#title'] = $form['options']['#title'];
    unset($form['options']['#title']);

    // Move the override dropdown out of the scrollable section of the form.
    if (isset($form['options']['override'])) {
      $form['override'] = $form['options']['override'];
      unset($form['options']['override']);
    }
    $name = $form_state
      ->get('update_name');
    $view
      ->getStandardButtons($form, $form_state, 'views_ui_edit_display_form', $name);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $view = $form_state
      ->get('view');
    $display_id = $form_state
      ->get('display_id');
    $view
      ->getExecutable()->displayHandlers
      ->get($display_id)
      ->validateOptionsForm($form['options'], $form_state);
    if ($form_state
      ->getErrors()) {
      $form_state
        ->set('rerender', TRUE);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $view = $form_state
      ->get('view');
    $display_id = $form_state
      ->get('display_id');
    $view
      ->getExecutable()->displayHandlers
      ->get($display_id)
      ->submitOptionsForm($form['options'], $form_state);
    $view
      ->cacheSet();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
Display::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
Display::getForm	public	function	Creates a new instance of this form. Overrides ViewsFormBase::getForm
Display::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
Display::getFormKey	public	function	Returns the key that represents this form. Overrides ViewsFormInterface::getFormKey
Display::getFormState	public	function	@todo Remove this and switch all usage of $form_state->get('section') to $form_state->get('type'). Overrides ViewsFormBase::getFormState
Display::submitForm	public	function	Form submission handler. Overrides ViewsFormBase::submitForm
Display::validateForm	public	function	Form validation handler. Overrides ViewsFormBase::validateForm
Display::__construct	public	function	Constructs a new Display object.
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::setID	protected	function	Sets the ID for this form.
ViewsFormBase::setType	protected	function	Sets the type for this form.

You are here

class Display in Zircon Profile 8

Hierarchy

File

Namespace

Members

API Navigation