class Broken in Views (for Drupal 7) 8.3

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

Plugin annotation

@Plugin(
  id = "broken"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\views\Plugin\views\PluginBase
    • class \Drupal\views\Plugin\views\HandlerBase
      • class \Drupal\views\Plugin\views\sort\SortPluginBase
        • class \Drupal\views\Plugin\views\sort\Broken

Related topics

Views sort handlers

Handlers to tell Views how to sort queries.

1 string reference to 'Broken'

ViewStorage::addDisplay in lib/Drupal/views/ViewStorage.php

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

File

lib/Drupal/views/Plugin/views/sort/Broken.php, line 21

Definition of Drupal\views\Plugin\views\sort\Broken.

Namespace

Drupal\views\Plugin\views\sort

class Broken extends SortPluginBase {
  public function adminLabel($short = FALSE) {
    return t('Broken/missing handler');
  }
  public function defineOptions() {
    return array();
  }
  public function ensureMyTable() {

    /* No table to ensure! */
  }
  public function query($group_by = FALSE) {

    /* No query to run */
  }
  public function buildOptionsForm(&$form, &$form_state) {
    $form['markup'] = array(
      '#markup' => '<div class="form-item description">' . t('The handler for this item is broken or missing and cannot be used. If a module provided the handler and was disabled, re-enabling the module may restore it. Otherwise, you should probably delete this item.') . '</div>',
    );
  }

  /**
   * Determine if the handler is considered 'broken'
   */
  public function broken() {
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Broken::adminLabel	public	function	Return a string representing this handler's name in the UI. Overrides HandlerBase::adminLabel
Broken::broken	public	function	Determine if the handler is considered 'broken' Overrides HandlerBase::broken
Broken::buildOptionsForm	public	function	Basic options for all sort criteria Overrides SortPluginBase::buildOptionsForm
Broken::defineOptions	public	function	Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides SortPluginBase::defineOptions
Broken::ensureMyTable	public	function	Ensure the main table for this handler is in the query. This is used a lot. Overrides HandlerBase::ensureMyTable
Broken::query	public	function	Called to add the sort to a query. Overrides SortPluginBase::query
HandlerBase::$actualField	public	property	When a field has been moved this property is set.
HandlerBase::$actualTable	public	property	When a table has been moved this property is set.
HandlerBase::$field	public	property	With field you can override the realField if the real field is not set.
HandlerBase::$query	public	property	Where the $query object will reside:	1
HandlerBase::$realField	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$relationship	public	property	The relationship used for this field.
HandlerBase::$table	public	property	The table this handler is attached to.
HandlerBase::$tableAlias	public	property	The alias of the table of this handler which is used in the query.
HandlerBase::acceptExposedInput	public	function	Take input from exposed handlers and assign to this handler, if necessary.	1
HandlerBase::access	public	function	Check whether current user has access to this handler.	7
HandlerBase::breakPhrase	public static	function	Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString	public static	function	Breaks x,y,z and x+y+z into an array. Works for strings.
HandlerBase::buildExposedForm	public	function	Render our chunk of the exposed handler form when selecting	1
HandlerBase::buildExtraOptionsForm	public	function	Provide a form for setting options.	1
HandlerBase::buildGroupByForm	public	function	Provide a form for aggregation settings.	1
HandlerBase::caseTransform	protected	function	Transform a string by a certain method.
HandlerBase::defineExtraOptions	public	function	Provide defaults for the handler.
HandlerBase::exposedInfo	public	function	Get information about the exposed form for the form renderer.	1
HandlerBase::getField	public	function	Shortcut to get a handler's raw field value.
HandlerBase::getJoin	public	function	Get the join object that should be used for this handler.
HandlerBase::getSQLDateField	public	function	Creates cross-database SQL dates.
HandlerBase::getSQLFormat	public	function	Creates cross-database SQL date formatting.
HandlerBase::getTableJoin	public static	function	Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getTimezone	public static	function	Figure out what timezone we're in; needed for some date manipulations.
HandlerBase::hasExtraOptions	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
HandlerBase::init	public	function	Init the handler with necessary data.	6
HandlerBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter.	1
HandlerBase::isExposed	public	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput	public	function	Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.	1
HandlerBase::placeholder	protected	function	Provides a unique placeholders for handlers.
HandlerBase::postExecute	public	function	Run after the view is executed, before the result is cached.
HandlerBase::preQuery	public	function	Run before the view is built.	1
HandlerBase::sanitizeValue	protected	function	Sanitize the value for output.
HandlerBase::setRelationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::showExposeForm	public	function	Shortcut to display the exposed options form.
HandlerBase::storeExposedInput	public	function	If set to remember exposed input in the session, store it there.	1
HandlerBase::submitExposed	public	function	Submit the exposed handler form
HandlerBase::submitExposeForm	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitExtraOptionsForm	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitGroupByForm	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.	1
HandlerBase::usesGroupBy	public	function	Provides the handler some groupby.	2
HandlerBase::validate	public	function	Validates the handler against the complete View. Overrides PluginBase::validate	1
HandlerBase::validateExposed	public	function	Validate the exposed handler form	4
HandlerBase::validateExposeForm	public	function	Validate the options form.	1
HandlerBase::validateExtraOptionsForm	public	function	Validate the options form.
HandlerBase::__construct	public	function	Constructs a Handler object. Overrides PluginBase::__construct
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::$usesOptions	protected	property	Denotes whether the plugin has an additional options form.	8
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::additionalThemeFunctions	public	function	Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function	Clears a plugin.	2
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::isConfigurable	public	function	Determines if the plugin is configurable.
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
SortPluginBase::adminSummary	public	function	Display whether or not the sort order is ascending or descending Overrides HandlerBase::adminSummary
SortPluginBase::buildExposeForm	public	function	Form for exposed handler options. Overrides HandlerBase::buildExposeForm
SortPluginBase::canExpose	public	function	Determine if a sort can be exposed. Overrides HandlerBase::canExpose
SortPluginBase::defaultExposeOptions	public	function	Provide default options for exposed sorts. Overrides HandlerBase::defaultExposeOptions
SortPluginBase::showExposeButton	public	function	Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
SortPluginBase::show_sort_form		function	Shortcut to display the value form.
SortPluginBase::sort_options		function	Provide a list of options for the default sort form. Should be overridden by classes that don't override sort_form
SortPluginBase::sort_submit		function
SortPluginBase::sort_validate		function
SortPluginBase::submitOptionsForm	public	function	Simple submit handler Overrides HandlerBase::submitOptionsForm
SortPluginBase::validateOptionsForm	public	function	Simple validate handler Overrides HandlerBase::validateOptionsForm