class DisplayNoAreaTest

Defines a Display test plugin with areas disabled.

Plugin annotation

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

Hierarchy

Expanded class hierarchy of DisplayNoAreaTest

File

drupal/core/modules/views/tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/display/DisplayNoAreaTest.php, line 23

Definition of Drupal\views_test_data\Plugin\views\display\DisplayNoAreaTest.

Namespace

class DisplayNoAreaTest extends DisplayTest {

  /**
   * Whether the display allows area plugins.
   *
   * @var bool
   *   TRUE if the display can use areas, or FALSE otherwise.
   */
  protected $usesAreas = FALSE;

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
DisplayNoAreaTest::$usesAreas	protected	property	Whether the display allows area plugins. Overrides DisplayPluginBase::$usesAreas
DisplayPluginBase::$extender		property	Stores all available display extenders.
DisplayPluginBase::$handlers		property
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::$usesAJAX	protected	property	Whether the display allows the use of AJAX or not.	1
DisplayPluginBase::$usesMore	protected	property	Whether the display allows the use of a 'more' link or not.
DisplayPluginBase::$usesOptions	protected	property	Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
DisplayPluginBase::$usesPager	protected	property	Whether the display allows the use of a pager or not.	2
DisplayPluginBase::$view		property	The top object of a view. Overrides PluginBase::$view
DisplayPluginBase::acceptAttachments	public	function	Determines whether this display can use attachments.
DisplayPluginBase::access	public	function	Determine if the user has access to this display of the view.
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::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
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::formatThemes	protected	function	Format a list of theme templates for output by the theme info helper.
DisplayPluginBase::getArgumentsTokens	public	function	Returns to tokens for arguments.
DisplayPluginBase::getArgumentText	public	function	Provide some helpful text for the arguments. The result should contain of an array with	1
DisplayPluginBase::getFieldLabels	public	function	Retrieve a list of fields for the current display with the relationship associated if it exists.
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::getLinkDisplay	public	function	Check to see which display to use when creating links within a view using this display.
DisplayPluginBase::getOption	public	function	Intelligently get an option either from this display or from the default display, if directed to do so.
DisplayPluginBase::getPagerText	public	function	Provide some helpful text for pagers.	1
DisplayPluginBase::getPath	public	function	Return the base path to use for this display.
DisplayPluginBase::getPlugin	public	function	Get the instance of a plugin, for example style or row.
DisplayPluginBase::getSpecialBlocks	public	function	Provide the block system with any exposed widget blocks for this display.
DisplayPluginBase::getStyleType	protected	function	Displays can require a certain type of style plugin. By default, they will be 'normal'.	1
DisplayPluginBase::getUrl	public	function
DisplayPluginBase::hasPath	public	function	Check to see if the display has a 'path' field.	1
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::init	public	function		1
DisplayPluginBase::isAJAXEnabled	public	function	Whether the display is actually using AJAX or not.
DisplayPluginBase::isDefaultDisplay	public	function	Determine if this display is the 'default' display which contains fallback settings	1
DisplayPluginBase::isDefaulted	public	function	Determine if a given option is set to use the default display or the current display
DisplayPluginBase::isEnabled	public	function	Whether the display is enabled.
DisplayPluginBase::isIdentifierUnique	public	function	Check if the provided identifier is unique.
DisplayPluginBase::isMoreEnabled	public	function	Whether the display is using the 'more' link or not.
DisplayPluginBase::isPagerEnabled	public	function	Whether the display is using a pager or not.
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::optionsOverride	public	function	If override/revert was clicked, perform the proper toggle.
DisplayPluginBase::overrideOption	public	function	Set an option and force it to be an override.
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::query	public	function	Inject anything into the query that the display handler needs. Overrides PluginBase::query
DisplayPluginBase::render	public	function	Render this display.	1
DisplayPluginBase::renderArea	public	function
DisplayPluginBase::renderEmpty	public	function
DisplayPluginBase::renderFilters	public	function	Not all display plugins will support filtering
DisplayPluginBase::renderFooter	public	function	Render the footer of the view.
DisplayPluginBase::renderHeader	public	function	Render the header of the view.
DisplayPluginBase::renderMoreLink	public	function	Render the 'more' link
DisplayPluginBase::renderPager	public	function	Not all display plugins will suppert pager rendering.	1
DisplayPluginBase::setOption	public	function	Intelligently set an option either from this display or from the default display, if directed to do so.
DisplayPluginBase::setOverride	public	function	Flip the override setting for the given section.
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::usesAJAX	public	function	Whether the display allows the use of AJAX or not.	1
DisplayPluginBase::usesAreas	public	function	Returns whether the display can use areas.	1
DisplayPluginBase::usesAttachments	public	function	Returns whether the display can use attachments.	4
DisplayPluginBase::usesBreadcrumb	public	function	Check to see if the display needs a breadcrumb	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::usesExposedFormInBlock	public	function	Check to see if the display can put the exposed formin a block.
DisplayPluginBase::usesFields	public	function	Determine if the display's style uses fields.
DisplayPluginBase::usesLinkDisplay	public	function	Check to see if the display has some need to link to another display.	1
DisplayPluginBase::usesMore	public	function	Whether the display allows the use of a 'more' link or not.
DisplayPluginBase::usesPager	public	function	Whether the display allows the use of a pager or not.	2
DisplayPluginBase::validate	public	function	Make sure the display and all associated handlers are valid. Overrides PluginBase::validate	1
DisplayPluginBase::viewSpecialBlocks	public	function	Render any special blocks provided for this display.
DisplayTest::$usesAttachments	protected	property	Whether the display allows attachments. Overrides DisplayPluginBase::$usesAttachments
DisplayTest::buildOptionsForm	public	function	Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::buildOptionsForm(). Overrides DisplayPluginBase::buildOptionsForm
DisplayTest::defineOptions	protected	function	Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::defineOptions(). Overrides DisplayPluginBase::defineOptions
DisplayTest::execute	public	function	Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::execute(). Overrides DisplayPluginBase::execute
DisplayTest::optionsSummary	public	function	Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummaryv(). Overrides DisplayPluginBase::optionsSummary
DisplayTest::preview	public	function	Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::preview(). Overrides DisplayPluginBase::preview
DisplayTest::submitOptionsForm	public	function	Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::submitOptionsForm(). Overrides DisplayPluginBase::submitOptionsForm
DisplayTest::validateOptionsForm	public	function	Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::validateOptionsForm(). Overrides DisplayPluginBase::validateOptionsForm
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition
PluginBase::$discovery	protected	property	The discovery object.
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$plugin_id	protected	property	The plugin_id.
PluginBase::additionalThemeFunctions	public	function	Provide a list of additional theme functions for the theme information page
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements.
PluginBase::getDefinition	public	function	Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId	public	function	Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced.
PluginBase::pluginTitle	public	function	Return the human readable name of the display.
PluginBase::setOptionDefaults	protected	function
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display.	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style.	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions	public	function	Returns the usesOptions property.	8
PluginBase::__construct	public	function	Constructs a Plugin object. Overrides PluginBase::__construct