The default style plugin for summaries.
@Plugin(
id = "default_summary",
title = @Translation("List"),
help = @Translation("Displays the default summary as a list."),
theme = "views_view_summary",
type = "summary"
)
Expanded class hierarchy of DefaultSummary
class DefaultSummary extends StylePluginBase {
protected function defineOptions() {
$options = parent::defineOptions();
$options['base_path'] = array(
'default' => '',
);
$options['count'] = array(
'default' => TRUE,
'bool' => TRUE,
);
$options['override'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['items_per_page'] = array(
'default' => 25,
);
return $options;
}
public function query() {
if (!empty($this->options['override'])) {
$this->view
->setItemsPerPage(intval($this->options['items_per_page']));
}
}
public function buildOptionsForm(&$form, &$form_state) {
$form['base_path'] = array(
'#type' => 'textfield',
'#title' => t('Base path'),
'#default_value' => $this->options['base_path'],
'#description' => t('Define the base path for links in this summary
view, i.e. http://example.com/<strong>your_view_path/archive</strong>.
Do not include beginning and ending forward slash. If this value
is empty, views will use the first path found as the base path,
in page displays, or / if no path could be found.'),
);
$form['count'] = array(
'#type' => 'checkbox',
'#default_value' => !empty($this->options['count']),
'#title' => t('Display record count with link'),
);
$form['override'] = array(
'#type' => 'checkbox',
'#default_value' => !empty($this->options['override']),
'#title' => t('Override number of items to display'),
);
$form['items_per_page'] = array(
'#type' => 'textfield',
'#title' => t('Items to display'),
'#default_value' => $this->options['items_per_page'],
'#states' => array(
'visible' => array(
':input[name="options[summary][options][' . $this->definition['id'] . '][override]"]' => array(
'checked' => TRUE,
),
),
),
);
}
function render() {
$rows = array();
foreach ($this->view->result as $row) {
// @todo: Include separator as an option.
$rows[] = $row;
}
return array(
'#theme' => $this
->themeFunctions(),
'#view' => $this->view,
'#options' => $this->options,
'#rows' => $rows,
);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DefaultSummary:: |
public | function |
Provide a form to edit options for this plugin. Overrides StylePluginBase:: |
1 |
DefaultSummary:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides StylePluginBase:: |
1 |
DefaultSummary:: |
public | function |
Add anything to the query that we might need to. Overrides StylePluginBase:: |
|
DefaultSummary:: |
function |
Render the display in this style. Overrides StylePluginBase:: |
||
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:: |
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 | 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 | Handle any special handling on the validate form. | 10 |
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 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
StylePluginBase:: |
property | Contains the row plugin, if it's initialized and the style itself supports it. | ||
StylePluginBase:: |
property | Store all available tokens row rows. | ||
StylePluginBase:: |
protected | property | Does the style plugin for itself support to add fields to it's output. | 2 |
StylePluginBase:: |
protected | property | Does the style plugin support grouping of rows. | 1 |
StylePluginBase:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
StylePluginBase:: |
protected | property | Does the style plugin support custom css class for the rows. | 4 |
StylePluginBase:: |
protected | property | Does the style plugin allows to use style plugins. | 6 |
StylePluginBase:: |
function | Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. | 1 | |
StylePluginBase:: |
function | Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. | 1 | |
StylePluginBase:: |
public | function |
Clears a plugin. Overrides PluginBase:: |
|
StylePluginBase:: |
function | Should the output of the style plugin be rendered even if it's a empty view. | 1 | |
StylePluginBase:: |
function | Get a rendered field. | ||
StylePluginBase:: |
function | Get the raw field value. | ||
StylePluginBase:: |
function | Return the token replaced row class for the specified row. | ||
StylePluginBase:: |
public | function | Initialize a style plugin. | |
StylePluginBase:: |
function | Allow the style to do stuff before each row is rendered. | ||
StylePluginBase:: |
function | Render all of the fields for a given style and store them on the object. | ||
StylePluginBase:: |
function | Group records as needed for rendering. | ||
StylePluginBase:: |
function | Render the grouping sets. | ||
StylePluginBase:: |
function | Take a value and apply token replacement logic to it. | ||
StylePluginBase:: |
function | Return TRUE if this style also uses fields. | 2 | |
StylePluginBase:: |
function | Returns the usesGrouping property. | 1 | |
StylePluginBase:: |
function | Returns the usesRowClass property. | 4 | |
StylePluginBase:: |
function | Returns the usesRowPlugin property. | 6 | |
StylePluginBase:: |
function | Return TRUE if this style uses tokens. | ||
StylePluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides PluginBase:: |
|
StylePluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |
|
StylePluginBase:: |
function | Provide a form in the views wizard if this style is selected. | ||
StylePluginBase:: |
function | Alter the options of a display before they are added to the view. | 1 |