class Broken in Drupal 10

A special handler to take the place of missing or broken handlers.

Plugin annotation

@ViewsArea("broken");

Hierarchy

• class \Drupal\views\Plugin\views\area\AreaPluginBase extends \Drupal\views\Plugin\views\HandlerBase
  • class \Drupal\views\Plugin\views\area\Broken uses BrokenHandlerTrait

Related topics

Views area handler plugins

Plugins governing areas of views, such as header, footer, and empty text.

1 file declares its use of Broken

ModuleTest.php in core/modules/views/tests/src/Kernel/ModuleTest.php

6 string references to 'Broken'

View::addDisplay in core/modules/views/src/Entity/View.php

Adds a new display handler to the view, automatically creating an ID.

views.argument.schema.yml in core/modules/views/config/schema/views.argument.schema.yml

core/modules/views/config/schema/views.argument.schema.yml

views.field.schema.yml in core/modules/views/config/schema/views.field.schema.yml

core/modules/views/config/schema/views.field.schema.yml

views.filter.schema.yml in core/modules/views/config/schema/views.filter.schema.yml

core/modules/views/config/schema/views.filter.schema.yml

views.relationship.schema.yml in core/modules/views/config/schema/views.relationship.schema.yml

core/modules/views/config/schema/views.relationship.schema.yml

... See full list

File

core/modules/views/src/Plugin/views/area/Broken.php, line 14

Namespace

Drupal\views\Plugin\views\area

class Broken extends AreaPluginBase {
  use BrokenHandlerTrait;

  /**
   * {@inheritdoc}
   */
  public function render($empty = FALSE) {

    // Simply render nothing by returning an empty render array.
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AreaPluginBase::$areaType	public	property	The type of this area handler, i.e. 'header', 'footer', or 'empty'.
AreaPluginBase::adminSummary	public	function
AreaPluginBase::init	public	function	Overrides Drupal\views\Plugin\views\HandlerBase::init().	1
AreaPluginBase::isEmpty	public	function	Does that area have nothing to show.	1
AreaPluginBase::preRender	public	function	Performs any operations needed before full rendering.	1
AreaPluginBase::usesGroupBy	public	function
Broken::render	public	function	Render the area. Overrides AreaPluginBase::render
BrokenHandlerTrait::adminLabel	public	function	Returns this handlers name in the UI.
BrokenHandlerTrait::broken	public	function	Determines if the handler is considered 'broken'.
BrokenHandlerTrait::buildOptionsForm	public	function	Provides a form to edit options for this plugin.
BrokenHandlerTrait::calculateDependencies	public	function	Gets dependencies for a broken handler.
BrokenHandlerTrait::defineOptions	public	function	The option definition for this handler.
BrokenHandlerTrait::ensureMyTable	public	function	Ensure the main table for this handler is in the query. This is used a lot.
BrokenHandlerTrait::query	public	function	Modify the views query.