class DefaultSummary
Same name in other branches
- 9 core/modules/views/src/Plugin/views/style/DefaultSummary.php \Drupal\views\Plugin\views\style\DefaultSummary
- 8.9.x core/modules/views/src/Plugin/views/style/DefaultSummary.php \Drupal\views\Plugin\views\style\DefaultSummary
- 10 core/modules/views/src/Plugin/views/style/DefaultSummary.php \Drupal\views\Plugin\views\style\DefaultSummary
The default style plugin for summaries.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\style\DefaultSummary extends \Drupal\views\Plugin\views\style\StylePluginBase
- class \Drupal\views\Plugin\views\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of DefaultSummary
Related topics
1 file declares its use of DefaultSummary
- Result.php in core/
modules/ views/ src/ Plugin/ views/ area/ Result.php
1 string reference to 'DefaultSummary'
- ArgumentPluginBase::defaultActions in core/
modules/ views/ src/ Plugin/ views/ argument/ ArgumentPluginBase.php - Default actions.
File
-
core/
modules/ views/ src/ Plugin/ views/ style/ DefaultSummary.php, line 14
Namespace
Drupal\views\Plugin\views\styleView source
class DefaultSummary extends StylePluginBase {
protected function defineOptions() {
$options = parent::defineOptions();
$options['base_path'] = [
'default' => '',
];
$options['count'] = [
'default' => TRUE,
];
$options['override'] = [
'default' => FALSE,
];
$options['items_per_page'] = [
'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, FormStateInterface $form_state) {
$form['base_path'] = [
'#type' => 'textfield',
'#title' => $this->t('Base path'),
'#default_value' => $this->options['base_path'],
'#description' => $this->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'] = [
'#type' => 'checkbox',
'#default_value' => !empty($this->options['count']),
'#title' => $this->t('Display record count with link'),
];
$form['override'] = [
'#type' => 'checkbox',
'#default_value' => !empty($this->options['override']),
'#title' => $this->t('Override number of items to display'),
];
$form['items_per_page'] = [
'#type' => 'textfield',
'#title' => $this->t('Items to display'),
'#default_value' => $this->options['items_per_page'],
'#states' => [
'visible' => [
':input[name="options[summary][options][' . $this->definition['id'] . '][override]"]' => [
'checked' => TRUE,
],
],
],
];
}
public function render() {
$rows = [];
foreach ($this->view->result as $row) {
// @todo Include separator as an option.
$rows[] = $row;
}
return [
'#theme' => $this->themeFunctions(),
'#view' => $this->view,
'#options' => $this->options,
'#rows' => $rows,
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DefaultSummary::buildOptionsForm | public | function | Provide a form to edit options for this plugin. | Overrides StylePluginBase::buildOptionsForm | 1 |
DefaultSummary::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides StylePluginBase::defineOptions | 1 |
DefaultSummary::query | public | function | Add anything to the query that we might need to. | Overrides StylePluginBase::query | |
DefaultSummary::render | public | function | Render the display in this style. | Overrides StylePluginBase::render | |
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | |
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | |
PluginBase::$definition | public | property | Plugins' 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::$position | public | property | The handler position. | ||
PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | |
PluginBase::$view | public | property | The top object of a view. | 1 | |
PluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 14 |
PluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 61 |
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | ||
PluginBase::filterByDefinedOptions | public | function | Filter out stored options depending on the defined options. | Overrides ViewsPluginInterface::filterByDefinedOptions | |
PluginBase::getAvailableGlobalTokens | public | function | Returns an array of available token replacements. | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |
PluginBase::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | |
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | |
PluginBase::globalTokenForm | public | function | Adds elements for available core tokens to a form. | Overrides ViewsPluginInterface::globalTokenForm | |
PluginBase::globalTokenReplace | public | function | Returns a string with any core tokens replaced. | Overrides ViewsPluginInterface::globalTokenReplace | |
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | |||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | |||
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | ||
PluginBase::pluginTitle | public | function | Return the human readable name of the display. | Overrides ViewsPluginInterface::pluginTitle | |
PluginBase::preRenderAddFieldsetMarkup | public static | function | Moves form elements into fieldsets for presentation purposes. | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |
PluginBase::preRenderFlattenData | public static | function | Flattens the structure of form elements. | Overrides ViewsPluginInterface::preRenderFlattenData | |
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | ||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | ||
PluginBase::submitOptionsForm | public | function | Handle any special handling on the validate form. | Overrides ViewsPluginInterface::submitOptionsForm | 16 |
PluginBase::summaryTitle | public | function | Returns the summary of the settings in the display. | Overrides ViewsPluginInterface::summaryTitle | 6 |
PluginBase::themeFunctions | public | function | Provide a full list of possible theme templates used by this style. | Overrides ViewsPluginInterface::themeFunctions | 1 |
PluginBase::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | |
PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | |
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | |||
PluginBase::__construct | public | function | Constructs a PluginBase object. | 19 | |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | |
StylePluginBase::$defaultFieldLabels | protected | property | Should field labels be enabled by default. | 1 | |
StylePluginBase::$groupingTheme | protected | property | The theme function used to render the grouping set. | ||
StylePluginBase::$rendered_fields | protected | property | |||
StylePluginBase::$render_tokens | public | property | |||
StylePluginBase::$rowTokens | protected | property | Store all available tokens row rows. | ||
StylePluginBase::$usesFields | protected | property | Does the style plugin for itself support to add fields to its output. | 3 | |
StylePluginBase::$usesGrouping | protected | property | Does the style plugin support grouping of rows. | 3 | |
StylePluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | Overrides PluginBase::$usesOptions | |
StylePluginBase::$usesRowClass | protected | property | Does the style plugin support custom css class for the rows. | 3 | |
StylePluginBase::$usesRowPlugin | protected | property | Whether or not this style uses a row plugin. | 11 | |
StylePluginBase::buildSort | public | function | Determines if the style handler should interfere with sorts. | 1 | |
StylePluginBase::buildSortPost | public | function | Allows the view builder to build a second set of sorts. | 1 | |
StylePluginBase::defaultFieldLabels | public | function | Return TRUE if this style enables field labels by default. | 1 | |
StylePluginBase::destroy | public | function | Clears a plugin. | Overrides PluginBase::destroy | |
StylePluginBase::elementPreRenderRow | public | function | #pre_render callback for view row field rendering. | ||
StylePluginBase::evenEmpty | public | function | Determines if the style plugin is rendered even if the view is empty. | 2 | |
StylePluginBase::getField | public | function | Gets a rendered field. | ||
StylePluginBase::getFieldValue | public | function | Get the raw field value. | ||
StylePluginBase::getRowClass | public | function | Return the token replaced row class for the specified row. | ||
StylePluginBase::init | public | function | Overrides \Drupal\views\Plugin\views\PluginBase::init(). | Overrides PluginBase::init | |
StylePluginBase::preRender | public | function | Allow the style to do stuff before each row is rendered. | ||
StylePluginBase::renderFields | protected | function | Renders all of the fields for a given style and store them on the object. | ||
StylePluginBase::renderGrouping | public | function | Group records as needed for rendering. | ||
StylePluginBase::renderGroupingSets | public | function | Render the grouping sets. | ||
StylePluginBase::renderRowGroup | protected | function | Renders a group of rows of the grouped view. | ||
StylePluginBase::tokenizeValue | public | function | Take a value and apply token replacement logic to it. | ||
StylePluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | |
StylePluginBase::usesFields | public | function | Return TRUE if this style also uses fields. | 3 | |
StylePluginBase::usesGrouping | public | function | Returns the usesGrouping property. | 3 | |
StylePluginBase::usesRowClass | public | function | Returns the usesRowClass property. | 3 | |
StylePluginBase::usesRowPlugin | public | function | Returns the usesRowPlugin property. | 11 | |
StylePluginBase::usesTokens | public | function | Return TRUE if this style uses tokens. | ||
StylePluginBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides PluginBase::validate | |
StylePluginBase::validateOptionsForm | public | function | Validate the options form. | Overrides PluginBase::validateOptionsForm | |
StylePluginBase::wizardSubmit | public | function | Alter the options of a display before they are added to the view. | 1 | |
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.