public function Result::render in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/views/src/Plugin/views/area/Result.php \Drupal\views\Plugin\views\area\Result::render()
2. 9 core/modules/views/src/Plugin/views/area/Result.php \Drupal\views\Plugin\views\area\Result::render()

Render the area.

Parameters

bool $empty: (optional) Indicator if view result is empty or not. Defaults to FALSE.

Return value

array In any case we need a valid Drupal render array to return.

Overrides AreaPluginBase::render

File

core/modules/views/src/Plugin/views/area/Result.php, line 71

Class

Result

Views area handler to display some configurable result summary.

Namespace

Drupal\views\Plugin\views\area

Code

public function render($empty = FALSE) {

  // Must have options and does not work on summaries.
  if (!isset($this->options['content']) || $this->view->style_plugin instanceof DefaultSummary) {
    return [];
  }
  $output = '';
  $format = $this->options['content'];

  // Calculate the page totals.
  $current_page = (int) $this->view
    ->getCurrentPage() + 1;
  $per_page = (int) $this->view
    ->getItemsPerPage();

  // @TODO: Maybe use a possible is views empty functionality.
  // Not every view has total_rows set, use view->result instead.
  $total = $this->view->total_rows ?? count($this->view->result);
  $label = Html::escape($this->view->storage
    ->label());

  // If there is no result the "start" and "current_record_count" should be
  // equal to 0. To have the same calculation logic, we use a "start offset"
  // to handle all the cases.
  $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;

  // Get the search information.
  $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;

  // Send the output.
  if (!empty($total) || !empty($this->options['empty'])) {
    $output .= str_replace(array_keys($replacements), array_values($replacements), $format);

    // Return as render array.
    return [
      '#markup' => $output,
    ];
  }
  return [];
}