A special handler to take the place of missing or broken handlers.
@PluginID("broken");
Expanded class hierarchy of Broken
class Broken extends FilterPluginBase {
/**
* Overrides \Drupal\views\Plugin\views\filter\FilterPluginBase::init().
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
}
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;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Broken:: |
public | function |
Return a string representing this handler's name in the UI. Overrides HandlerBase:: |
|
Broken:: |
public | function |
Determine if the handler is considered 'broken' Overrides HandlerBase:: |
|
Broken:: |
public | function |
Provide the basic form which calls through to subforms.
If overridden, it is best to call through to the parent,
or to at least make sure all of the functions in this form
are called. Overrides FilterPluginBase:: |
|
Broken:: |
public | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides FilterPluginBase:: |
|
Broken:: |
public | function |
Ensure the main table for this handler is in the query. This is used
a lot. Overrides HandlerBase:: |
|
Broken:: |
public | function |
Overrides \Drupal\views\Plugin\views\filter\FilterPluginBase::init(). Overrides FilterPluginBase:: |
|
Broken:: |
public | function |
Add this filter to the query. Overrides FilterPluginBase:: |
|
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
FilterPluginBase:: |
property | Disable the possibility to force a single value. | 6 | |
FilterPluginBase:: |
property | Disable the possibility to allow a exposed input to be optional. | ||
FilterPluginBase:: |
property | Contains the information of the selected item in a gruped filter. | ||
FilterPluginBase:: |
property | Disable the possibility to use operators. | 2 | |
FilterPluginBase:: |
property | Contains the operator which is used on the query. | ||
FilterPluginBase:: |
property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. | ||
FilterPluginBase:: |
public | function |
Check to see if input from the exposed filters should change
the behavior of this filter. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function | Add a new group to the exposed filter groups. | |
FilterPluginBase:: |
public | function |
Display the filter on the administrative summary Overrides HandlerBase:: |
7 |
FilterPluginBase:: |
protected static | function | Filter by no empty values, though allow to use "0". | |
FilterPluginBase:: |
protected | function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' | |
FilterPluginBase:: |
public | function |
Render our chunk of the exposed filter form when selecting Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Options form subform for exposed filter options. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function | Displays the Build Group form. | |
FilterPluginBase:: |
protected | function | Provide default options for exposed filters. | |
FilterPluginBase:: |
protected | function | Save new group items, re-enumerates and remove groups marked to delete. | |
FilterPluginBase:: |
protected | function | Validate the build group options form. | 1 |
FilterPluginBase:: |
protected | function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | |
FilterPluginBase:: |
public | function |
Determine if a filter can be exposed. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function | Can this filter be used in OR groups? | 1 |
FilterPluginBase:: |
public | function | ||
FilterPluginBase:: |
public | function |
Provide default options for exposed filters. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Make some translations to a form item to make it more suitable to exposing. | |
FilterPluginBase:: |
public | function | Build a form containing a group of operator | values to apply as a single filter. | |
FilterPluginBase:: |
public | function | Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected. | |
FilterPluginBase:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Options form subform for setting the operator. | 4 |
FilterPluginBase:: |
public | function | Provide a list of options for the default operator form. Should be overridden by classes that don't override operatorForm | 4 |
FilterPluginBase:: |
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. | |
FilterPluginBase:: |
protected | function | Validate the operator form. | |
FilterPluginBase:: |
protected | function | Sanitizes the HTML select element's options. | |
FilterPluginBase:: |
protected | function | Shortcut to display the build_group/hide button. | |
FilterPluginBase:: |
public | function | Shortcut to display the exposed options form. | |
FilterPluginBase:: |
public | function |
Shortcut to display the expose/hide button. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | Shortcut to display the operator form. | |
FilterPluginBase:: |
protected | function | Shortcut to display the value form. | |
FilterPluginBase:: |
public | function |
If set to remember exposed input in the session, store it there. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group. | |
FilterPluginBase:: |
public | function |
Simple submit handler Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Simple validate handler Overrides HandlerBase:: |
1 |
FilterPluginBase:: |
protected | function | Options form subform for setting options. | 7 |
FilterPluginBase:: |
protected | 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 |
FilterPluginBase:: |
protected | function | Validate the options form. | 3 |
HandlerBase:: |
public | property | When a field has been moved this property is set. | |
HandlerBase:: |
public | property | When a table has been moved this property is set. | |
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
public | property | Where the $query object will reside: | 1 |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
HandlerBase:: |
public | property | The table this handler is attached to. | |
HandlerBase:: |
public | property | The alias of the table of this handler which is used in the query. | |
HandlerBase:: |
public | function | Check whether current user has access to this handler. | 6 |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Numeric only. | |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Works for strings. | |
HandlerBase:: |
public | function | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Displays the Expose form. | |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | |
HandlerBase:: |
public | function | Determines the entity type used by this handler. | |
HandlerBase:: |
public | function | Shortcut to get a handler's raw field value. | |
HandlerBase:: |
public | function | Get the join object that should be used for this handler. | |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
HandlerBase:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function | Run after the view is executed, before the result is cached. | |
HandlerBase:: |
public | function | Run before the view is built. | 1 |
HandlerBase:: |
public | function | Sanitize the value for output. | |
HandlerBase:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
HandlerBase:: |
public | function | Shortcut to display the exposed options form. | |
HandlerBase:: |
public | function | Submit the exposed handler form | |
HandlerBase:: |
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:: |
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:: |
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:: |
public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. | |
HandlerBase:: |
public | function | Provides the handler some groupby. | 2 |
HandlerBase:: |
public | function |
Validates the handler against the complete View. Overrides PluginBase:: |
1 |
HandlerBase:: |
public | function | Validate the exposed handler form | 4 |
HandlerBase:: |
public | function | Validate the options form. | |
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
3 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |