class ExcelExport in Excel Serialization 8

Provides an Excel export display plugin.

This overrides the REST Export display to make labeling clearer on the admin UI, and add specific Excel-related functionality.

Plugin annotation

@ViewsDisplay(
  id = "excel_export",
  title = @Translation("Excel export"),
  help = @Translation("Export the view results to an Excel file."),
  uses_route = TRUE,
  admin = @Translation("Excel export"),
  returns_response = TRUE
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
      • class \Drupal\views\Plugin\views\display\DisplayPluginBase implements DependentPluginInterface, DisplayPluginInterface uses PluginDependencyTrait
        • class \Drupal\views\Plugin\views\display\PathPluginBase implements DisplayMenuInterface, DisplayRouterInterface uses UrlGeneratorTrait
          • class \Drupal\rest\Plugin\views\display\RestExport implements ResponseDisplayPluginInterface
            • class \Drupal\xls_serialization\Plugin\views\display\ExcelExport

File

src/Plugin/views/display/ExcelExport.php, line 27

Namespace

Drupal\xls_serialization\Plugin\views\display

class ExcelExport extends RestExport {

  /**
   * Overrides the content type of the data response, if needed.
   *
   * @var string
   */
  protected $contentType = 'xlsx';

  /**
   * {@inheritdoc}
   */
  public static function buildResponse($view_id, $display_id, array $args = []) {

    // Do not call the parent method, as it makes the response harder to alter.
    // @see https://www.drupal.org/node/2779807
    $build = static::buildBasicRenderable($view_id, $display_id, $args);

    // Setup an empty response, so for example, the Content-Disposition header
    // can be set.
    $response = new CacheableResponse('', 200);
    $build['#response'] = $response;

    /** @var \Drupal\Core\Render\RendererInterface $renderer */
    $renderer = \Drupal::service('renderer');
    $output = (string) $renderer
      ->renderRoot($build);
    $response
      ->setContent($output);
    $cache_metadata = CacheableMetadata::createFromRenderArray($build);
    $response
      ->addCacheableDependency($cache_metadata);
    $response->headers
      ->set('Content-type', $build['#content_type']);
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {

    // Add the content disposition header if a custom filename has been used.
    if (($response = $this->view
      ->getResponse()) && $this
      ->getOption('filename')) {
      $response->headers
        ->set('Content-Disposition', 'attachment; filename="' . $this
        ->generateFilename($this
        ->getOption('filename')) . '"');
    }
    return parent::render();
  }

  /**
   * Given a filename and a view, generate a filename.
   *
   * @param string $filename_pattern
   *   The filename, which may contain replacement tokens.
   *
   * @return string
   *   The filename with any tokens replaced.
   */
  protected function generateFilename($filename_pattern) {
    return $this
      ->globalTokenReplace($filename_pattern);
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['displays'] = [
      'default' => [],
    ];

    // Set the default style plugin, and default to fields.
    $options['style']['contains']['type']['default'] = 'excel_export';
    $options['row']['contains']['type']['default'] = 'data_field';
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function optionsSummary(&$categories, &$options) {
    parent::optionsSummary($categories, $options);

    // Excel sheet header formatting.
    $header_bold = $this
      ->getOption('header_bold') ? $this
      ->t('Bold') : $this
      ->t('Non-Bold');
    $header_italic = $this
      ->getOption('header_italic') ? $this
      ->t('Italic') : $this
      ->t('Non-Italic');
    $header_background_color = $this
      ->getOption('header_background_color') ? $this
      ->t('RGB code background color: @rgb_code', [
      '@rgb_code' => $this
        ->getOption('header_background_color'),
    ]) : $this
      ->t('No background color (white)');
    $format_header_value = implode(', ', [
      $header_bold,
      $header_italic,
      $header_background_color,
    ]);

    // Add category for Excel sheet header formatting.
    $categories['excel_sheet_header'] = [
      'title' => $this
        ->t('Excel sheet header'),
      'column' => 'second',
      'build' => [
        '#weight' => -1,
      ],
    ];

    // Add option for Excel sheet header formatting.
    $options['format_header'] = [
      'category' => 'excel_sheet_header',
      'title' => $this
        ->t('Format header'),
      'value' => $format_header_value,
    ];

    // Excel conditional formatting.
    $field_names = $this->view
      ->getDisplay()
      ->getFieldLabels();
    $operator_options = [
      0 => '=',
      1 => '<>',
    ];
    for ($i = 0; $i <= 4; $i++) {
      $current_conditional_formatting_base_field = $this
        ->getOption('conditional_formatting_base_field_' . $i);
      if ($current_conditional_formatting_base_field === 'Select a field' || $current_conditional_formatting_base_field === '' || $current_conditional_formatting_base_field === NULL) {
        $conditional_formatting_value[$i] = 'None';
      }
      else {
        $conditional_formatting_base_field[$i] = $this
          ->t('If Field @base_field', [
          '@base_field' => $field_names[$this
            ->getOption('conditional_formatting_base_field_' . $i)],
        ]);
        $conditional_formatting_operator[$i] = $operator_options[$this
          ->getOption('conditional_formatting_operator_' . $i)];
        $conditional_formatting_compare_to[$i] = '"' . $this
          ->getOption('conditional_formatting_compare_to_' . $i) . '"';
        $conditional_formatting_background_color[$i] = $this
          ->getOption('conditional_formatting_background_color_' . $i) ? $this
          ->t('then apply RGB code row background color: @rgb_code', [
          '@rgb_code' => $this
            ->getOption('conditional_formatting_background_color_' . $i),
        ]) : $this
          ->t('No background color');
        $conditional_formatting_value[$i] = implode(' ', [
          $conditional_formatting_base_field[$i],
          $conditional_formatting_operator[$i],
          $conditional_formatting_compare_to[$i],
          $conditional_formatting_background_color[$i],
        ]);
      }
    }

    // Add category for Excel conditional formatting.
    $categories['excel_conditional_formatting'] = [
      'title' => $this
        ->t('Excel conditional formatting'),
      'column' => 'second',
      'build' => [
        '#weight' => -1,
      ],
    ];

    // Add options for Excel conditional formatting.
    for ($i = 0; $i <= 4; $i++) {
      $options['excel_conditional_formatting_rules_' . $i] = [
        'category' => 'excel_conditional_formatting',
        'title' => $this
          ->t('Rule'),
        'value' => $conditional_formatting_value[$i],
      ];
    }

    // Add filename to the summary if set.
    if ($this
      ->getOption('filename')) {
      $options['path']['value'] .= $this
        ->t(': (@filename)', [
        '@filename' => $this
          ->getOption('filename'),
      ]);
    }

    // Display the selected format from the style plugin if available.
    $style_options = $this
      ->getOption('style')['options'];
    if (!empty($style_options['formats'])) {
      $options['style']['value'] .= $this
        ->t(': (@export_format)', [
        '@export_format' => reset($style_options['formats']),
      ]);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    switch ($form_state
      ->get('section')) {
      case 'style':

        // Remove the 'serializer' and 'data_export'
        // (if available) options to avoid confusion.
        unset($form['style']['type']['#options']['serializer']);
        unset($form['style']['type']['#options']['data_export']);
        break;
      case 'path':
        $form['filename'] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Filename'),
          '#default_value' => $this
            ->getOption('filename'),
          '#description' => $this
            ->t('The filename that will be suggested to the browser for downloading purposes. You may include replacement patterns from the list below.'),
        ];

        // Support tokens.
        $this
          ->globalTokenForm($form, $form_state);
        break;
      case 'format_header':
        $form['#title'] .= $this
          ->t('Format header');
        $form['header_bold'] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('Header Bold'),
          '#default_value' => $this
            ->getOption('header_bold'),
          '#description' => $this
            ->t('Do you want to make the header (first row) of the worksheet bold?'),
        ];
        $form['header_italic'] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('Header Italic'),
          '#default_value' => $this
            ->getOption('header_italic'),
          '#description' => $this
            ->t('Do you want to make the header (first row) of the worksheet italic?'),
        ];
        $form['header_background_color'] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Header Background Color'),
          '#default_value' => $this
            ->getOption('header_background_color'),
          '#description' => $this
            ->t("Give the RGB code for the background color of the worksheet's header. Leave empty for default color."),
          '#size' => 6,
          '#maxlength' => 6,
        ];
        break;
    }
    $field_names = $this->view
      ->getDisplay()
      ->getFieldLabels();
    $form['#title'] .= $this
      ->t('Conditional formatting rules');
    for ($i = 0; $i <= 4; $i++) {
      if ($form_state
        ->get('section') === 'excel_conditional_formatting_rules_' . $i) {
        $form['conditional_formatting_base_field_' . $i] = [
          '#type' => 'select',
          '#options' => $field_names,
          '#empty_value' => 'Select a field',
          '#title' => $this
            ->t('Field used to compare to text'),
          '#default_value' => $this
            ->getOption('conditional_formatting_base_field_' . $i),
        ];
        $form['conditional_formatting_operator_' . $i] = [
          '#type' => 'select',
          '#options' => [
            '=',
            '<>',
          ],
          '#empty_value' => 'Select an operator',
          '#title' => $this
            ->t('Operator'),
          '#default_value' => $this
            ->getOption('conditional_formatting_operator_' . $i),
        ];
        $form['conditional_formatting_compare_to_' . $i] = [
          '#type' => 'textfield',
          '#empty_value' => 'Select an operator',
          '#title' => $this
            ->t('Text to compare to'),
          '#default_value' => $this
            ->getOption('conditional_formatting_compare_to_' . $i),
        ];
        $form['conditional_formatting_background_color_' . $i] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Row Background Color'),
          '#default_value' => $this
            ->getOption('conditional_formatting_background_color_' . $i),
          '#description' => $this
            ->t("Give the RGB code for the background color of the row. Leave empty for default color."),
          '#size' => 6,
          '#maxlength' => 6,
        ];
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function validateOptionsForm(&$form, FormStateInterface $form_state) {
    parent::validateOptionsForm($form, $form_state);

    // Validate Excel sheet header formatting functionality fields.
    if ($form_state
      ->get('section') == 'format_header') {
      $errors = $this
        ->validateRgbValue($form_state
        ->getValue('header_background_color'));
      foreach ($errors as $error) {
        $form_state
          ->setError($form['header_background_color'], $error);
      }
    }

    // Validate Excel conditional formatting functionality fields.
    for ($i = 0; $i <= 4; $i++) {
      if ($form_state
        ->get('section') === 'excel_conditional_formatting_rules_' . $i) {

        // If one of conditional_formatting_base_field,
        // conditional_formatting_operator or conditional_formatting_compare_to
        // is set, all of them have to be set.
        $conditional_formatting_base_field_value[$i] = $form_state
          ->getValue('conditional_formatting_base_field_' . $i);
        $conditional_formatting_operator_value[$i] = $form_state
          ->getValue('conditional_formatting_operator_' . $i);
        $conditional_formatting_compare_to_value[$i] = $form_state
          ->getValue('conditional_formatting_compare_to_' . $i);
        if ($conditional_formatting_base_field_value[$i] !== 'Select a field') {
          if ($conditional_formatting_operator_value[$i] === 'Select an operator' || $conditional_formatting_compare_to_value[$i] === '') {
            $form_state
              ->setError($form['conditional_formatting_base_field'], $this
              ->t('Either all or none of the following three inputs must be set: "Field used to compare to text", "Operator" and "Text to compare to".'));
          }
        }
        if ($conditional_formatting_operator_value[$i] !== 'Select an operator') {
          if ($conditional_formatting_base_field_value[$i] === 'Select a field' || $conditional_formatting_compare_to_value[$i] === '') {
            $form_state
              ->setError($form['conditional_formatting_operator'], $this
              ->t('Either all or none of the following three inputs must be set: "Field used to compare to text", "Operator" and "Text to compare to".'));
          }
        }
        if ($conditional_formatting_compare_to_value[$i] !== '') {
          if ($conditional_formatting_base_field_value[$i] === 'Select a field' || $conditional_formatting_operator_value[$i] === 'Select an operator') {
            $form_state
              ->setError($form['conditional_formatting_compare_to'], $this
              ->t('Either all or none of the following three inputs must be set: "Field used to compare to text", "Operator" and "Text to compare to".'));
          }
        }
        $form_state
          ->setValue('conditional_formatting_background_color_' . $i, strtoupper($form_state
          ->getValue('conditional_formatting_background_color_' . $i)));
        $errors = $this
          ->validateRgbValue($form_state
          ->getValue('conditional_formatting_background_color_' . $i));
        foreach ($errors as $error) {
          $form_state
            ->setError($form['conditional_formatting_background_color_' . $i], $error);
        }
      }
    }

    // Uppercase the background color RGB values.
    $form_state
      ->setValue('header_background_color', strtoupper($form_state
      ->getValue('header_background_color')));
  }

  /**
   * Validates the header background color field of the display.
   *
   * @param string $rgb_value
   *   The rgb value to validate.
   *
   * @return array
   *   A list of error strings.
   */
  protected function validateRgbValue($rgb_value) {
    $errors = [];
    if ($rgb_value !== '' && !preg_match('/^([a-f0-9]{6})$/iD', strtolower($rgb_value))) {
      $errors[] = $this
        ->t('Background color must be a 6-digit hexadecimal value.');
    }
    return $errors;
  }

  /**
   * {@inheritdoc}
   */
  public function submitOptionsForm(&$form, FormStateInterface $form_state) {
    parent::submitOptionsForm($form, $form_state);
    $section = $form_state
      ->get('section');
    switch ($section) {
      case 'path':
        $this
          ->setOption('filename', $form_state
          ->getValue('filename'));
        break;
      case 'format_header':
        $this
          ->setOption('header_bold', $form_state
          ->getValue('header_bold'));
        $this
          ->setOption('header_italic', $form_state
          ->getValue('header_italic'));
        $this
          ->setOption('header_background_color', $form_state
          ->getValue('header_background_color'));
        break;
    }
    for ($i = 0; $i <= 4; $i++) {
      if ($section === 'excel_conditional_formatting_rules_' . $i) {
        $this
          ->setOption('conditional_formatting_base_field_' . $i, $form_state
          ->getValue('conditional_formatting_base_field_' . $i));
        $this
          ->setOption('conditional_formatting_operator_' . $i, $form_state
          ->getValue('conditional_formatting_operator_' . $i));
        $this
          ->setOption('conditional_formatting_compare_to_' . $i, $form_state
          ->getValue('conditional_formatting_compare_to_' . $i));
        $this
          ->setOption('conditional_formatting_background_color_' . $i, $form_state
          ->getValue('conditional_formatting_background_color_' . $i));
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DisplayPluginBase::$display	public	property	The display information coming directly from the view entity.
DisplayPluginBase::$extenders	protected	property	Stores all available display extenders.
DisplayPluginBase::$handlers	public	property	An array of instantiated handlers used in this display.
DisplayPluginBase::$output	public	property	Stores the rendered output of the display.
DisplayPluginBase::$plugins	protected	property	An array of instantiated plugins used in this display.
DisplayPluginBase::$unpackOptions	protected static	property	Static cache for unpackOptions, but not if we are in the UI.
DisplayPluginBase::$usesAttachments	protected	property	Whether the display allows attachments.	6
DisplayPluginBase::$view	public	property	The top object of a view. Overrides PluginBase::$view
DisplayPluginBase::acceptAttachments	public	function	Determines whether this display can use attachments. Overrides DisplayPluginInterface::acceptAttachments
DisplayPluginBase::access	public	function	Determines if the user has access to this display of the view. Overrides DisplayPluginInterface::access
DisplayPluginBase::ajaxEnabled	public	function	Whether the display is actually using AJAX or not. Overrides DisplayPluginInterface::ajaxEnabled
DisplayPluginBase::applyDisplayCachablityMetadata Deprecated	protected	function	Applies the cacheability of the current display to the given render array.
DisplayPluginBase::applyDisplayCacheabilityMetadata	protected	function	Applies the cacheability of the current display to the given render array.
DisplayPluginBase::attachTo	public	function	Allows displays to attach to other views. Overrides DisplayPluginInterface::attachTo	2
DisplayPluginBase::buildBasicRenderable	public static	function	Builds a basic render array which can be properly render cached. Overrides DisplayPluginInterface::buildBasicRenderable	1
DisplayPluginBase::buildRenderable	public	function	Builds a renderable array of the view. Overrides DisplayPluginInterface::buildRenderable	1
DisplayPluginBase::buildRenderingLanguageOptions	protected	function	Returns the available rendering strategies for language-aware entities.
DisplayPluginBase::calculateCacheMetadata	public	function	Calculates the display's cache metadata by inspecting each handler/plugin. Overrides DisplayPluginInterface::calculateCacheMetadata
DisplayPluginBase::defaultableSections	public	function	Lists the 'defaultable' sections and what items each section contains. Overrides DisplayPluginInterface::defaultableSections	1
DisplayPluginBase::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
DisplayPluginBase::elementPreRender	public	function	#pre_render callback for view display rendering. Overrides DisplayPluginInterface::elementPreRender
DisplayPluginBase::getAllHandlers	protected	function	Gets all the handlers used by the display.
DisplayPluginBase::getAllPlugins	protected	function	Gets all the plugins used by the display.
DisplayPluginBase::getArgumentsTokens	public	function	Returns to tokens for arguments. Overrides DisplayPluginInterface::getArgumentsTokens
DisplayPluginBase::getArgumentText	public	function	Provides help text for the arguments. Overrides DisplayPluginInterface::getArgumentText	1
DisplayPluginBase::getAttachedDisplays	public	function	Find out all displays which are attached to this display. Overrides DisplayPluginInterface::getAttachedDisplays
DisplayPluginBase::getCacheMetadata	public	function	Gets the cache metadata. Overrides DisplayPluginInterface::getCacheMetadata
DisplayPluginBase::getExtenders	public	function	Gets the display extenders. Overrides DisplayPluginInterface::getExtenders
DisplayPluginBase::getFieldLabels	public	function	Retrieves a list of fields for the current display. Overrides DisplayPluginInterface::getFieldLabels
DisplayPluginBase::getHandler	public	function	Get the handler object for a single handler. Overrides DisplayPluginInterface::getHandler
DisplayPluginBase::getHandlers	public	function	Get a full array of handlers for $type. This caches them. Overrides DisplayPluginInterface::getHandlers
DisplayPluginBase::getLinkDisplay	public	function	Returns the ID of the display to use when making links. Overrides DisplayPluginInterface::getLinkDisplay
DisplayPluginBase::getMoreUrl	protected	function	Get the more URL for this view.
DisplayPluginBase::getOption	public	function	Gets an option, from this display or the default display. Overrides DisplayPluginInterface::getOption
DisplayPluginBase::getPagerText	public	function	Provides help text for pagers. Overrides DisplayPluginInterface::getPagerText	1
DisplayPluginBase::getPlugin	public	function	Get the instance of a plugin, for example style or row. Overrides DisplayPluginInterface::getPlugin
DisplayPluginBase::getRoutedDisplay	public	function	Points to the display which can be linked by this display. Overrides DisplayPluginInterface::getRoutedDisplay
DisplayPluginBase::getSpecialBlocks	public	function	Provides the block system with any exposed widget blocks for this display. Overrides DisplayPluginInterface::getSpecialBlocks
DisplayPluginBase::getUrl	public	function	Returns a URL to $this display or its configured linked display. Overrides DisplayPluginInterface::getUrl
DisplayPluginBase::isBaseTableTranslatable	protected	function	Returns whether the base table is of a translatable entity type.
DisplayPluginBase::isDefaultDisplay	public	function	Determines if this display is the 'default' display. Overrides DisplayPluginInterface::isDefaultDisplay	1
DisplayPluginBase::isDefaulted	public	function	Determines if an option is set to use the default or current display. Overrides DisplayPluginInterface::isDefaulted
DisplayPluginBase::isEnabled	public	function	Whether the display is enabled. Overrides DisplayPluginInterface::isEnabled
DisplayPluginBase::isIdentifierUnique	public	function	Checks if the provided identifier is unique. Overrides DisplayPluginInterface::isIdentifierUnique
DisplayPluginBase::isMoreEnabled	public	function	Whether the display is using the 'more' link or not. Overrides DisplayPluginInterface::isMoreEnabled
DisplayPluginBase::isPagerEnabled	public	function	Whether the display is using a pager or not. Overrides DisplayPluginInterface::isPagerEnabled
DisplayPluginBase::mergeDefaults	public	function	Merges default values for all plugin types. Overrides DisplayPluginInterface::mergeDefaults
DisplayPluginBase::mergeHandler	protected	function	Merges handlers default values.
DisplayPluginBase::mergePlugin	protected	function	Merges plugins default values.
DisplayPluginBase::newDisplay	public	function	Reacts on adding a display. Overrides DisplayPluginInterface::newDisplay	1
DisplayPluginBase::optionLink	public	function	Returns a link to a section of a form. Overrides DisplayPluginInterface::optionLink
DisplayPluginBase::optionsOverride	public	function	If override/revert was clicked, perform the proper toggle. Overrides DisplayPluginInterface::optionsOverride
DisplayPluginBase::outputIsEmpty	public	function	Is the output of the view empty. Overrides DisplayPluginInterface::outputIsEmpty
DisplayPluginBase::overrideOption	public	function	Set an option and force it to be an override. Overrides DisplayPluginInterface::overrideOption
DisplayPluginBase::preExecute	public	function	Sets up any variables on the view prior to execution. Overrides DisplayPluginInterface::preExecute
DisplayPluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	1
DisplayPluginBase::renderArea	public	function	Renders one of the available areas. Overrides DisplayPluginInterface::renderArea
DisplayPluginBase::renderFilters	public	function	Does nothing (obsolete function). Overrides DisplayPluginInterface::renderFilters
DisplayPluginBase::renderMoreLink	public	function	Renders the 'more' link. Overrides DisplayPluginInterface::renderMoreLink
DisplayPluginBase::renderPager	public	function	Checks to see if the display plugins support pager rendering. Overrides DisplayPluginInterface::renderPager	1
DisplayPluginBase::setOption	public	function	Sets an option, on this display or the default display. Overrides DisplayPluginInterface::setOption
DisplayPluginBase::setOverride	public	function	Flip the override setting for the given section. Overrides DisplayPluginInterface::setOverride
DisplayPluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
DisplayPluginBase::useGroupBy	public	function	Does the display have groupby enabled? Overrides DisplayPluginInterface::useGroupBy
DisplayPluginBase::useMoreAlways	public	function	Should the enabled display more link be shown when no more items? Overrides DisplayPluginInterface::useMoreAlways
DisplayPluginBase::useMoreText	public	function	Does the display have custom link text? Overrides DisplayPluginInterface::useMoreText
DisplayPluginBase::usesAJAX	public	function	Whether the display allows the use of AJAX or not. Overrides DisplayPluginInterface::usesAJAX	2
DisplayPluginBase::usesAreas	public	function	Returns whether the display can use areas. Overrides DisplayPluginInterface::usesAreas	2
DisplayPluginBase::usesAttachments	public	function	Returns whether the display can use attachments. Overrides DisplayPluginInterface::usesAttachments	6
DisplayPluginBase::usesExposedFormInBlock	public	function	Checks to see if the display can put the exposed form in a block. Overrides DisplayPluginInterface::usesExposedFormInBlock
DisplayPluginBase::usesFields	public	function	Determines if the display's style uses fields. Overrides DisplayPluginInterface::usesFields
DisplayPluginBase::usesLinkDisplay	public	function	Checks to see if the display has some need to link to another display. Overrides DisplayPluginInterface::usesLinkDisplay	1
DisplayPluginBase::usesMore	public	function	Whether the display allows the use of a 'more' link or not. Overrides DisplayPluginInterface::usesMore	1
DisplayPluginBase::usesPager	public	function	Whether the display allows the use of a pager or not. Overrides DisplayPluginInterface::usesPager	4
DisplayPluginBase::viewExposedFormBlocks	public	function	Renders the exposed form as block. Overrides DisplayPluginInterface::viewExposedFormBlocks
ExcelExport::$contentType	protected	property	Overrides the content type of the data response, if needed. Overrides RestExport::$contentType
ExcelExport::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides RestExport::buildOptionsForm
ExcelExport::buildResponse	public static	function	Builds up a response with the rendered view as content. Overrides RestExport::buildResponse
ExcelExport::defineOptions	protected	function	Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase:defineOptions(). Overrides RestExport::defineOptions
ExcelExport::generateFilename	protected	function	Given a filename and a view, generate a filename.
ExcelExport::optionsSummary	public	function	Provides the default summary for options in the views UI. Overrides RestExport::optionsSummary
ExcelExport::render	public	function	Renders this display. Overrides RestExport::render
ExcelExport::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides RestExport::submitOptionsForm
ExcelExport::validateOptionsForm	public	function	Validate the options form. Overrides PathPluginBase::validateOptionsForm
ExcelExport::validateRgbValue	protected	function	Validates the header background color field of the display.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PathPluginBase::$routeProvider	protected	property	The route provider.
PathPluginBase::$state	protected	property	The state key value store.
PathPluginBase::alterRoutes	public	function	Alters a collection of routes and replaces definitions to the view. Overrides DisplayRouterInterface::alterRoutes
PathPluginBase::getAlteredRouteNames	public	function	Returns the list of routes overridden by Views. Overrides DisplayRouterInterface::getAlteredRouteNames
PathPluginBase::getMenuLinks	public	function	Gets menu links, if this display provides some. Overrides DisplayMenuInterface::getMenuLinks
PathPluginBase::getPath	public	function	Returns the base path to use for this display. Overrides DisplayPluginBase::getPath
PathPluginBase::getRoute	protected	function	Generates a route entry for a given view and display.	1
PathPluginBase::getRouteName	public	function	Returns the route name for the display. Overrides DisplayRouterInterface::getRouteName
PathPluginBase::getUrlInfo	public	function	Generates a URL to this display. Overrides DisplayRouterInterface::getUrlInfo
PathPluginBase::hasPath	public	function	Checks to see if the display has a 'path' field. Overrides DisplayPluginBase::hasPath
PathPluginBase::isDefaultTabPath	protected	function	Determines if this display's path is a default tab.
PathPluginBase::overrideAppliesPathAndMethod	protected	function	Determines whether a override for the path and method should happen.
PathPluginBase::remove	public	function	Reacts on deleting a display. Overrides DisplayPluginBase::remove
PathPluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides DisplayPluginBase::validate	1
PathPluginBase::validatePath	protected	function	Validates the path of the display.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::init	public	function	Initialize the plugin. Overrides ViewsPluginInterface::init	8
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RestExport::$authenticationCollector	protected	property	The collector of authentication providers.
RestExport::$authenticationProviderIds	protected	property	The authentication providers, like 'cookie' and 'basic_auth'.
RestExport::$authenticationProviders Deprecated	protected	property	The authentication providers' modules, keyed by provider ID.
RestExport::$formatProviders	protected	property	The serialization format providers, keyed by format.
RestExport::$mimeType	protected	property	The mime type for the response.
RestExport::$renderer	protected	property	The renderer. Overrides PluginBase::$renderer
RestExport::$usesAJAX	protected	property	Whether the display allows the use of AJAX or not. Overrides DisplayPluginBase::$usesAJAX
RestExport::$usesAreas	protected	property	Whether the display allows area plugins. Overrides DisplayPluginBase::$usesAreas
RestExport::$usesMore	protected	property	Whether the display allows the use of a 'more' link or not. Overrides DisplayPluginBase::$usesMore
RestExport::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides DisplayPluginBase::$usesOptions
RestExport::$usesPager	protected	property	Whether the display allows the use of a pager or not. Overrides DisplayPluginBase::$usesPager
RestExport::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DisplayPluginBase::calculateDependencies
RestExport::collectRoutes	public	function	Adds the route entry of a view to the collection. Overrides PathPluginBase::collectRoutes
RestExport::create	public static	function	Creates an instance of the plugin. Overrides PathPluginBase::create
RestExport::displaysExposed	public	function	Determines if this display should display the exposed filters widgets. Overrides DisplayPluginBase::displaysExposed
RestExport::execute	public	function	Executes the view and returns data in the format required. Overrides PathPluginBase::execute
RestExport::getAuthOptions	public	function	Gets the auth options available.
RestExport::getContentType	public	function	Gets the content type.
RestExport::getFormatOptions	protected	function	Returns an array of format options.
RestExport::getMimeType	public	function	Gets the mime type.
RestExport::getType	public	function	Returns the display type that this display requires. Overrides DisplayPluginBase::getType
RestExport::initDisplay	public	function	Initializes the display plugin. Overrides DisplayPluginBase::initDisplay
RestExport::overrideApplies	protected	function	Determines whether the view overrides the given route. Overrides PathPluginBase::overrideApplies
RestExport::preview	public	function	The DisplayPluginBase preview method assumes we will be returning a render array. The data plugin will already return the serialized string. Overrides DisplayPluginBase::preview
RestExport::setContentType	public	function	Sets the content type.
RestExport::setMimeType	public	function	Sets the request content type.
RestExport::usesExposed	public	function	Determines if this display uses exposed filters. Overrides DisplayPluginBase::usesExposed
RestExport::__construct	public	function	Constructs a RestExport object. Overrides PathPluginBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::redirect Deprecated	protected	function	Returns a redirect response object for the specified route.	3
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.