class DisplayTest

Defines a Display test plugin.

Plugin annotation


@Plugin(
  id = "display_test",
  title = @Translation("Display test"),
  theme = "views_view",
  contextual_links_locations = {"view"}
)

Hierarchy

Expanded class hierarchy of DisplayTest

1 file declares its use of DisplayTest
DisplayTest.php in drupal/core/modules/views/lib/Drupal/views/Tests/Plugin/DisplayTest.php
Definition of Drupal\views\Tests\Plugin\DisplayTest.

File

drupal/core/modules/views/tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/display/DisplayTest.php, line 24
Definition of Drupal\views_test_data\Plugin\views\display\DisplayTest.

Namespace

Drupal\views_test_data\Plugin\views\display
View source
class DisplayTest extends DisplayPluginBase {

  /**
   * Whether the display allows attachments.
   *
   * @var bool
   */
  protected $usesAttachments = TRUE;

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::defineOptions().
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['test_option'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummaryv().
   */
  public function optionsSummary(&$categories, &$options) {
    parent::optionsSummary($categories, $options);
    $categories['display_test'] = array(
      'title' => t('Display test settings'),
      'column' => 'second',
      'build' => array(
        '#weight' => -100,
      ),
    );
    $test_option = $this
      ->getOption('test_option') ?: t('Empty');
    $options['test_option'] = array(
      'category' => 'display_test',
      'title' => t('Test option'),
      'value' => views_ui_truncate($test_option, 24),
    );
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    switch ($form_state['section']) {
      case 'test_option':
        $form['#title'] .= t('Test option');
        $form['test_option'] = array(
          '#type' => 'textfield',
          '#description' => t('This is a textfield for test_option.'),
          '#default_value' => $this
            ->getOption('test_option'),
        );
        break;
    }
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::validateOptionsForm().
   */
  public function validateOptionsForm(&$form, &$form_state) {
    parent::validateOptionsForm($form, $form_state);
    watchdog('views', $form_state['values']['test_option']);
    switch ($form_state['section']) {
      case 'test_option':
        if (!trim($form_state['values']['test_option'])) {
          form_error($form['test_option'], t('You cannot have an empty option.'));
        }
        break;
    }
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::submitOptionsForm().
   */
  public function submitOptionsForm(&$form, &$form_state) {
    parent::submitOptionsForm($form, $form_state);
    switch ($form_state['section']) {
      case 'test_option':
        $this
          ->setOption('test_option', $form_state['values']['test_option']);
        break;
    }
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::execute().
   */
  public function execute() {
    $this->view
      ->build();
    $render = $this->view
      ->render();

    // Render the test option as the title before the view output.
    $render['#prefix'] = '<h1>' . filter_xss_admin($this->options['test_option']) . '</h1>';
    return $render;
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::preview().
   *
   * Override so preview and execute are the same output.
   */
  public function preview() {
    $element = $this
      ->execute();
    return drupal_render($element);
  }

}

Members

Name Modifiers Typesort descending Description Overrides
DisplayTest::defineOptions protected function Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::defineOptions(). Overrides DisplayPluginBase::defineOptions
DisplayTest::optionsSummary public function Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummaryv(). Overrides DisplayPluginBase::optionsSummary
DisplayTest::buildOptionsForm public function Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::buildOptionsForm(). Overrides DisplayPluginBase::buildOptionsForm
DisplayTest::validateOptionsForm public function Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::validateOptionsForm(). Overrides DisplayPluginBase::validateOptionsForm
DisplayTest::submitOptionsForm public function Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::submitOptionsForm(). Overrides DisplayPluginBase::submitOptionsForm
DisplayTest::execute public function Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::execute(). Overrides DisplayPluginBase::execute
DisplayTest::preview public function Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::preview(). Overrides DisplayPluginBase::preview
DisplayPluginBase::init public function 1
DisplayPluginBase::destroy public function Clears a plugin. Overrides PluginBase::destroy
DisplayPluginBase::isDefaultDisplay public function Determine if this display is the 'default' display which contains fallback settings 1
DisplayPluginBase::usesExposed public function Determine if this display uses exposed filters, so the view will know whether or not to build them. 2
DisplayPluginBase::displaysExposed public function Determine if this display should display the exposed filters widgets, so the view will know whether or not to render them. 1
DisplayPluginBase::usesAJAX public function Whether the display allows the use of AJAX or not. 1
DisplayPluginBase::isAJAXEnabled public function Whether the display is actually using AJAX or not.
DisplayPluginBase::isEnabled public function Whether the display is enabled.
DisplayPluginBase::usesPager public function Whether the display allows the use of a pager or not. 2
DisplayPluginBase::isPagerEnabled public function Whether the display is using a pager or not.
DisplayPluginBase::usesMore public function Whether the display allows the use of a 'more' link or not.
DisplayPluginBase::isMoreEnabled public function Whether the display is using the 'more' link or not.
DisplayPluginBase::useGroupBy public function Does the display have groupby enabled?
DisplayPluginBase::useMoreAlways public function Should the enabled display more link be shown when no more items?
DisplayPluginBase::useMoreText public function Does the display have custom link text?
DisplayPluginBase::acceptAttachments public function Determines whether this display can use attachments.
DisplayPluginBase::usesAttachments public function Returns whether the display can use attachments. 4
DisplayPluginBase::usesAreas public function Returns whether the display can use areas. 1
DisplayPluginBase::attachTo public function Allow displays to attach to other views. 2
DisplayPluginBase::defaultableSections public function Static member function to list which sections are defaultable and what items each section contains. 1
DisplayPluginBase::hasPath public function Check to see if the display has a 'path' field. 1
DisplayPluginBase::usesLinkDisplay public function Check to see if the display has some need to link to another display. 1
DisplayPluginBase::usesExposedFormInBlock public function Check to see if the display can put the exposed formin a block.
DisplayPluginBase::getLinkDisplay public function Check to see which display to use when creating links within a view using this display.
DisplayPluginBase::getPath public function Return the base path to use for this display.
DisplayPluginBase::getUrl public function
DisplayPluginBase::usesBreadcrumb public function Check to see if the display needs a breadcrumb 1
DisplayPluginBase::isDefaulted public function Determine if a given option is set to use the default display or the current display
DisplayPluginBase::getOption public function Intelligently get an option either from this display or from the default display, if directed to do so.
DisplayPluginBase::usesFields public function Determine if the display's style uses fields.
DisplayPluginBase::getPlugin public function Get the instance of a plugin, for example style or row.
DisplayPluginBase::getHandler public function Get the handler object for a single handler.
DisplayPluginBase::getHandlers public function Get a full array of handlers for $type. This caches them.
DisplayPluginBase::getFieldLabels public function Retrieve a list of fields for the current display with the relationship associated if it exists.
DisplayPluginBase::setOption public function Intelligently set an option either from this display or from the default display, if directed to do so.
DisplayPluginBase::overrideOption public function Set an option and force it to be an override.
DisplayPluginBase::optionLink public function Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this.
DisplayPluginBase::getArgumentsTokens public function Returns to tokens for arguments.
DisplayPluginBase::formatThemes protected function Format a list of theme templates for output by the theme info helper.
DisplayPluginBase::optionsOverride public function If override/revert was clicked, perform the proper toggle.
DisplayPluginBase::setOverride public function Flip the override setting for the given section.
DisplayPluginBase::query public function Inject anything into the query that the display handler needs. Overrides PluginBase::query
DisplayPluginBase::renderFilters public function Not all display plugins will support filtering
DisplayPluginBase::renderPager public function Not all display plugins will suppert pager rendering. 1
DisplayPluginBase::renderMoreLink public function Render the 'more' link
DisplayPluginBase::renderHeader public function Render the header of the view.
DisplayPluginBase::renderFooter public function Render the footer of the view.
DisplayPluginBase::renderEmpty public function
DisplayPluginBase::hookBlockList public function If this display creates a block, implement one of these.
DisplayPluginBase::hookMenu public function If this display creates a page with a menu item, implement it here.
DisplayPluginBase::render public function Render this display. 1
DisplayPluginBase::renderArea public function
DisplayPluginBase::access public function Determine if the user has access to this display of the view.
DisplayPluginBase::preExecute public function Set up any variables on the view prior to execution. These are separated from execute because they are extremely common and unlikely to be overridden on an individual display.
DisplayPluginBase::getStyleType protected function Displays can require a certain type of style plugin. By default, they will be 'normal'. 1
DisplayPluginBase::validate public function Make sure the display and all associated handlers are valid. Overrides PluginBase::validate 1
DisplayPluginBase::isIdentifierUnique public function Check if the provided identifier is unique.
DisplayPluginBase::getSpecialBlocks public function Provide the block system with any exposed widget blocks for this display.
DisplayPluginBase::viewSpecialBlocks public function Render any special blocks provided for this display.
DisplayPluginBase::getArgumentText public function Provide some helpful text for the arguments. The result should contain of an array with 1
DisplayPluginBase::getPagerText public function Provide some helpful text for pagers. 1
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct
PluginBase::setOptionDefaults protected function
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
DisplayTest::$usesAttachments protected property Whether the display allows attachments. Overrides DisplayPluginBase::$usesAttachments
DisplayPluginBase::$view property The top object of a view. Overrides PluginBase::$view
DisplayPluginBase::$handlers property
DisplayPluginBase::$plugins protected property An array of instantiated plugins used in this display.
DisplayPluginBase::$extender property Stores all available display extenders.
DisplayPluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
DisplayPluginBase::$output public property Stores the rendered output of the display.
DisplayPluginBase::$usesAJAX protected property Whether the display allows the use of AJAX or not. 1
DisplayPluginBase::$usesPager protected property Whether the display allows the use of a pager or not. 2
DisplayPluginBase::$usesMore protected property Whether the display allows the use of a 'more' link or not.
DisplayPluginBase::$usesAreas protected property Whether the display allows area plugins. 1
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1