Base class for area handlers.
Expanded class hierarchy of AreaPluginBase
abstract class AreaPluginBase extends HandlerBase {
/**
* Overrides Drupal\views\Plugin\views\HandlerBase::init().
*
* Make sure that no result area handlers are set to be shown when the result
* is empty.
*/
public function init(ViewExecutable $view, &$options) {
$this
->setOptionDefaults($this->options, $this
->defineOptions());
parent::init($view, $options);
if (isset($this->handler_type) && $this->handler_type == 'empty') {
$this->options['empty'] = TRUE;
}
}
/**
* Get this area's label.
*/
public function label() {
if (!isset($this->options['label'])) {
return $this
->adminLabel();
}
return $this->options['label'];
}
protected function defineOptions() {
$options = parent::defineOptions();
$this->definition['field'] = !empty($this->definition['field']) ? $this->definition['field'] : '';
$label = !empty($this->definition['label']) ? $this->definition['label'] : $this->definition['field'];
$options['label'] = array(
'default' => $label,
'translatable' => TRUE,
);
$options['empty'] = array(
'default' => FALSE,
'bool' => TRUE,
);
return $options;
}
/**
* Provide extra data to the administration form
*/
public function adminSummary() {
return $this
->label();
}
/**
* Default options form that provides the label widget that all fields
* should have.
*/
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($form, $form_state);
$form['label'] = array(
'#type' => 'textfield',
'#title' => t('Label'),
'#default_value' => isset($this->options['label']) ? $this->options['label'] : '',
'#description' => t('The label for this area that will be displayed only administratively.'),
);
if ($form_state['type'] != 'empty') {
$form['empty'] = array(
'#type' => 'checkbox',
'#title' => t('Display even if view has no result'),
'#default_value' => isset($this->options['empty']) ? $this->options['empty'] : 0,
);
}
}
/**
* Form helper function to add tokenization form elements.
*/
public function tokenForm(&$form, &$form_state) {
$form['tokenize'] = array(
'#type' => 'checkbox',
'#title' => t('Use replacement tokens from the first row'),
'#default_value' => $this->options['tokenize'],
);
// Get a list of the available fields and arguments for token replacement.
$options = array();
foreach ($this->view->display_handler
->getHandlers('field') as $field => $handler) {
$options[t('Fields')]["[{$field}]"] = $handler
->adminLabel();
}
$count = 0;
// This lets us prepare the key as we want it printed.
foreach ($this->view->display_handler
->getHandlers('argument') as $arg => $handler) {
$options[t('Arguments')]['%' . ++$count] = t('@argument title', array(
'@argument' => $handler
->adminLabel(),
));
$options[t('Arguments')]['!' . $count] = t('@argument input', array(
'@argument' => $handler
->adminLabel(),
));
}
if (!empty($options)) {
$form['tokens'] = array(
'#type' => 'details',
'#title' => t('Replacement patterns'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#id' => 'edit-options-token-help',
'#states' => array(
'visible' => array(
':input[name="options[tokenize]"]' => array(
'checked' => TRUE,
),
),
),
);
$form['tokens']['help'] = array(
'#markup' => '<p>' . t('The following tokens are available. If you would like to have the characters \'[\' and \']\' please use the html entity codes \'%5B\' or \'%5D\' or they will get replaced with empty space.') . '</p>',
);
foreach (array_keys($options) as $type) {
if (!empty($options[$type])) {
$items = array();
foreach ($options[$type] as $key => $value) {
$items[] = $key . ' == ' . $value;
}
$form['tokens']['tokens'] = array(
'#theme' => 'item_list',
'#items' => $items,
);
}
}
}
$this
->globalTokenForm($form, $form_state);
}
/**
* Don't run a query
*/
public function query() {
}
/**
* Performs any operations needed before full rendering.
*
* @param array $results
* The results of the view.
*/
public function preRender(array $results) {
}
/**
* Render the area
*/
function render($empty = FALSE) {
return '';
}
/**
* Area handlers shouldn't have groupby.
*/
public function usesGroupBy() {
return FALSE;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AreaPluginBase:: |
public | function |
Provide extra data to the administration form Overrides HandlerBase:: |
|
AreaPluginBase:: |
public | function |
Default options form that provides the label widget that all fields
should have. Overrides HandlerBase:: |
7 |
AreaPluginBase:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides HandlerBase:: |
7 |
AreaPluginBase:: |
public | function |
Overrides Drupal\views\Plugin\views\HandlerBase::init(). Overrides HandlerBase:: |
|
AreaPluginBase:: |
public | function | Get this area's label. | |
AreaPluginBase:: |
public | function | Performs any operations needed before full rendering. | 1 |
AreaPluginBase:: |
public | function |
Don't run a query Overrides PluginBase:: |
1 |
AreaPluginBase:: |
function | Render the area | 6 | |
AreaPluginBase:: |
public | function | Form helper function to add tokenization form elements. | |
AreaPluginBase:: |
public | function |
Area handlers shouldn't have groupby. Overrides HandlerBase:: |
|
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 | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
HandlerBase:: |
public | function | Check whether current user has access to this handler. | 6 |
HandlerBase:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
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 | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 6 |
HandlerBase:: |
public | function | Render our chunk of the exposed handler form when selecting | 1 |
HandlerBase:: |
public | function | Form for exposed handler options. | 2 |
HandlerBase:: |
public | function | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
public | function | Determine if a handler can be exposed. | 2 |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
HandlerBase:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
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 | function | Creates cross-database SQL dates. | |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
HandlerBase:: |
public static | function | Figure out what timezone we're in; needed for some date manipulations. | |
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 | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
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:: |
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:: |
protected | 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 expose/hide button. | 2 |
HandlerBase:: |
public | function | Shortcut to display the exposed options form. | |
HandlerBase:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
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 |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides PluginBase:: |
7 |
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. | 1 |
HandlerBase:: |
public | function | Validate the options form. | |
HandlerBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |
4 |
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
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_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 | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). 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 | ||
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 |