Base sort handler that has no options and performs a simple sort.
Expanded class hierarchy of SortPluginBase
abstract class SortPluginBase extends HandlerBase {
/**
* Determine if a sort can be exposed.
*/
public function canExpose() {
return TRUE;
}
/**
* Called to add the sort to a query.
*/
public function query() {
$this
->ensureMyTable();
// Add the field.
$this->query
->add_orderby($this->tableAlias, $this->realField, $this->options['order']);
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['order'] = array(
'default' => 'ASC',
);
$options['exposed'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['expose'] = array(
'contains' => array(
'label' => array(
'default' => '',
'translatable' => TRUE,
),
),
);
return $options;
}
/**
* Display whether or not the sort order is ascending or descending
*/
public function adminSummary() {
if (!empty($this->options['exposed'])) {
return t('Exposed');
}
switch ($this->options['order']) {
case 'ASC':
case 'asc':
default:
return t('asc');
break;
case 'DESC':
case 'desc':
return t('desc');
break;
}
}
/**
* Basic options for all sort criteria
*/
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($form, $form_state);
if ($this
->canExpose()) {
$this
->showExposeButton($form, $form_state);
}
$form['op_val_start'] = array(
'#value' => '<div class="clearfix">',
);
$this
->show_sort_form($form, $form_state);
$form['op_val_end'] = array(
'#value' => '</div>',
);
if ($this
->canExpose()) {
$this
->showExposeForm($form, $form_state);
}
}
/**
* Shortcut to display the expose/hide button.
*/
public function showExposeButton(&$form, &$form_state) {
$form['expose_button'] = array(
'#prefix' => '<div class="views-expose clearfix">',
'#suffix' => '</div>',
// Should always come first
'#weight' => -1000,
);
// Add a checkbox for JS users, which will have behavior attached to it
// so it can replace the button.
$form['expose_button']['checkbox'] = array(
'#theme_wrappers' => array(
'container',
),
'#attributes' => array(
'class' => array(
'js-only',
),
),
);
$form['expose_button']['checkbox']['checkbox'] = array(
'#title' => t('Expose this sort to visitors, to allow them to change it'),
'#type' => 'checkbox',
);
// Then add the button itself.
if (empty($this->options['exposed'])) {
$form['expose_button']['markup'] = array(
'#markup' => '<div class="description exposed-description" style="float: left; margin-right:10px">' . t('This sort is not exposed. Expose it to allow the users to change it.') . '</div>',
);
$form['expose_button']['button'] = array(
'#limit_validation_errors' => array(),
'#type' => 'submit',
'#value' => t('Expose sort'),
'#submit' => array(
'views_ui_config_item_form_expose',
),
);
$form['expose_button']['checkbox']['checkbox']['#default_value'] = 0;
}
else {
$form['expose_button']['markup'] = array(
'#markup' => '<div class="description exposed-description">' . t('This sort is exposed. If you hide it, users will not be able to change it.') . '</div>',
);
$form['expose_button']['button'] = array(
'#limit_validation_errors' => array(),
'#type' => 'submit',
'#value' => t('Hide sort'),
'#submit' => array(
'views_ui_config_item_form_expose',
),
);
$form['expose_button']['checkbox']['checkbox']['#default_value'] = 1;
}
}
/**
* Simple validate handler
*/
public function validateOptionsForm(&$form, &$form_state) {
$this
->sort_validate($form, $form_state);
if (!empty($this->options['exposed'])) {
$this
->validateExposeForm($form, $form_state);
}
}
/**
* Simple submit handler
*/
public function submitOptionsForm(&$form, &$form_state) {
unset($form_state['values']['expose_button']);
// don't store this.
$this
->sort_submit($form, $form_state);
if (!empty($this->options['exposed'])) {
$this
->submitExposeForm($form, $form_state);
}
}
/**
* Shortcut to display the value form.
*/
function show_sort_form(&$form, &$form_state) {
$options = $this
->sort_options();
if (!empty($options)) {
$form['order'] = array(
'#type' => 'radios',
'#options' => $options,
'#default_value' => $this->options['order'],
);
}
}
function sort_validate(&$form, &$form_state) {
}
function sort_submit(&$form, &$form_state) {
}
/**
* Provide a list of options for the default sort form.
* Should be overridden by classes that don't override sort_form
*/
function sort_options() {
return array(
'ASC' => t('Sort ascending'),
'DESC' => t('Sort descending'),
);
}
public function buildExposeForm(&$form, &$form_state) {
// #flatten will move everything from $form['expose'][$key] to $form[$key]
// prior to rendering. That's why the pre_render for it needs to run first,
// so that when the next pre_render (the one for fieldsets) runs, it gets
// the flattened data.
array_unshift($form['#pre_render'], 'views_ui_pre_render_flatten_data');
$form['expose']['#flatten'] = TRUE;
$form['expose']['label'] = array(
'#type' => 'textfield',
'#default_value' => $this->options['expose']['label'],
'#title' => t('Label'),
'#required' => TRUE,
'#size' => 40,
'#weight' => -1,
);
}
/**
* Provide default options for exposed sorts.
*/
public function defaultExposeOptions() {
$this->options['expose'] = array(
'order' => $this->options['order'],
'label' => $this->definition['title'],
);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
HandlerBase:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
SortPluginBase:: |
public | function |
Called to add the sort to a query. Overrides PluginBase:: |
8 |
HandlerBase:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
HandlerBase:: |
public | function | Init the handler with necessary data. | 6 |
HandlerBase:: |
public | function | Check whether current user has access to this handler. | 6 |
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 |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
SortPluginBase:: |
public | function |
Basic options for all sort criteria Overrides HandlerBase:: |
4 |
HandlerBase:: |
public | function | Validate the exposed handler form | 4 |
SortPluginBase:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides HandlerBase:: |
3 |
HandlerBase:: |
public | function | Provides the handler some groupby. | 2 |
PluginBase:: |
public | function | Clears a plugin. | 2 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 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. | 1 |
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 | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
HandlerBase:: |
public | function | Render our chunk of the exposed handler form when selecting | 1 |
HandlerBase:: |
public | function | Validate the options form. | 1 |
HandlerBase:: |
public | function | Run before the view is built. | 1 |
HandlerBase:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
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:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
HandlerBase:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
HandlerBase:: |
public | function |
Validates the handler against the complete View. Overrides PluginBase:: |
1 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
HandlerBase:: |
public | property | Where the $query object will reside: | 1 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
SortPluginBase:: |
public | function |
Determine if a sort can be exposed. Overrides HandlerBase:: |
|
SortPluginBase:: |
public | function |
Display whether or not the sort order is ascending or descending Overrides HandlerBase:: |
|
SortPluginBase:: |
public | function |
Shortcut to display the expose/hide button. Overrides HandlerBase:: |
|
SortPluginBase:: |
public | function |
Simple validate handler Overrides HandlerBase:: |
|
SortPluginBase:: |
public | function |
Simple submit handler Overrides HandlerBase:: |
|
SortPluginBase:: |
function | Shortcut to display the value form. | ||
SortPluginBase:: |
function | |||
SortPluginBase:: |
function | |||
SortPluginBase:: |
function | Provide a list of options for the default sort form. Should be overridden by classes that don't override sort_form | ||
SortPluginBase:: |
public | function |
Form for exposed handler options. Overrides HandlerBase:: |
|
SortPluginBase:: |
public | function |
Provide default options for exposed sorts. Overrides HandlerBase:: |
|
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
|
HandlerBase:: |
public | function | Shortcut to get a handler's raw field value. | |
HandlerBase:: |
protected | function | Sanitize the value for output. | |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Validate the options form. | |
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 | 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 | Shortcut to display the exposed options form. | |
HandlerBase:: |
public | function | Run after the view is executed, before the result is cached. | |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
public | function | Get the join object that should be used for this handler. | |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | |
HandlerBase:: |
public static | function | Figure out what timezone we're in; needed for some date manipulations. | |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
HandlerBase:: |
public | function | Determines the entity type used by this handler. | |
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. | |
PluginBase:: |
protected | function | ||
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 | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
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 | property | When a table has been moved this property is set. | |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
public | property | When a field has been moved this property is set. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
protected | property | The plugin_id. |