Result.php in Drupal 9
File
core/modules/views/src/Plugin/views/area/Result.php
View source
<?php
namespace Drupal\views\Plugin\views\area;
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\Xss;
use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Plugin\views\style\DefaultSummary;
class Result extends AreaPluginBase {
protected function defineOptions() {
$options = parent::defineOptions();
$options['content'] = [
'default' => $this
->t('Displaying @start - @end of @total'),
];
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$item_list = [
'#theme' => 'item_list',
'#items' => [
'@start -- the initial record number in the set',
'@end -- the last record number in the set',
'@total -- the total records in the set',
'@label -- the human-readable name of the view',
'@per_page -- the number of items per page',
'@current_page -- the current page number',
'@current_record_count -- the current page record count',
'@page_count -- the total page count',
],
];
$list = \Drupal::service('renderer')
->render($item_list);
$form['content'] = [
'#title' => $this
->t('Display'),
'#type' => 'textarea',
'#rows' => 3,
'#default_value' => $this->options['content'],
'#description' => $this
->t('You may use HTML code in this field. The following tokens are supported:') . $list,
];
}
public function query() {
if (strpos($this->options['content'], '@total') !== FALSE) {
$this->view->get_total_rows = TRUE;
}
}
public function render($empty = FALSE) {
if (!isset($this->options['content']) || $this->view->style_plugin instanceof DefaultSummary) {
return [];
}
$output = '';
$format = $this->options['content'];
$current_page = (int) $this->view
->getCurrentPage() + 1;
$per_page = (int) $this->view
->getItemsPerPage();
$total = isset($this->view->total_rows) ? $this->view->total_rows : count($this->view->result);
$label = Html::escape($this->view->storage
->label());
$start_offset = empty($total) ? 0 : 1;
if ($per_page === 0) {
$page_count = 1;
$start = $start_offset;
$end = $total;
}
else {
$page_count = (int) ceil($total / $per_page);
$total_count = $current_page * $per_page;
if ($total_count > $total) {
$total_count = $total;
}
$start = ($current_page - 1) * $per_page + $start_offset;
$end = $total_count;
}
$current_record_count = $end - $start + $start_offset;
$replacements = [];
$replacements['@start'] = $start;
$replacements['@end'] = $end;
$replacements['@total'] = $total;
$replacements['@label'] = $label;
$replacements['@per_page'] = $per_page;
$replacements['@current_page'] = $current_page;
$replacements['@current_record_count'] = $current_record_count;
$replacements['@page_count'] = $page_count;
if (!empty($total) || !empty($this->options['empty'])) {
$output .= Xss::filterAdmin(str_replace(array_keys($replacements), array_values($replacements), $format));
return [
'#markup' => $output,
];
}
return [];
}
}
Classes
Name |
Description |
Result |
Views area handler to display some configurable result summary. |