GroupedSelection.php

<?php declare(strict_types=1);

https://github.com/**
 * This file is part of the Nette Framework (https://nette.org)
 * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
 */

namespace Nette\Database\Table;

use Nette;
use Nette\Database\Explorer;
use function array_keys, count, iterator_to_array, preg_match, reset;


https://github.com/**
 * Represents filtered table grouped by referencing table.
 * GroupedSelection is based on the great library NotORM http://www.notorm.com written by Jakub Vrana.
 * @template T of ActiveRow
 * @extends Selection<T>
 */
class GroupedSelection extends Selection
{
	/** current assigned referencing array */
	protected mixed $refCacheCurrent;

	/** primary key */
	protected int|string $active;


	/**
	 * Creates filtered and grouped table representation.
	 * @param Selection<ActiveRow> $refTable
	 */
	public function __construct(
		Explorer $explorer,
		string $tableName,
		/** grouping column name */
		protected readonly string $column,
		/** referenced table */
		protected readonly Selection $refTable,
	) {
		parent::__construct($explorer, $tableName);
	}


	/**
	 * Sets active group.
	 * @internal
	 * @param  int|string  $active  primary key of grouped rows
	 */
	public function setActive(int|string $active): static
	{
		$this->active = $active;
		return $this;
	}


	/**
	 * Adds a SELECT clause. Automatically prepends the grouping column if no select exists yet.
	 */
	public function select(string $columns, mixed ...$params): static
	{
		if (!$this->sqlBuilder->getSelect()) {
			$this->sqlBuilder->addSelect("$this->name.$this->column");
		}

		return parent::select($columns, ...$params);
	}


	/**
	 * Adds an ORDER BY clause. Automatically prepends the grouping column (matching direction) to improve index utilization.
	 */
	public function order(string $columns, mixed ...$params): static
	{
		if (!$this->sqlBuilder->getOrder()) {
			// improve index utilization
			$this->sqlBuilder->addOrder("$this->name.$this->column" . (preg_match('~\bDESC\z~i', $columns) ? ' DESC' : ''));
		}

		return parent::order($columns, ...$params);
	}


	/**
	 * Invalidates cached data and forces reload on next access.
	 */
	public function refreshData(): void
	{
		unset($this->refCache['referencing'][$this->getGeneralCacheKey()][$this->getSpecificCacheKey()]);
		$this->data = $this->rows = null;
	}


	/********************* aggregations ****************d*g**/


	/**
	 * Calculates aggregation for this group.
	 */
	public function aggregation(string $function, ?string $groupFunction = null): mixed
	{
		$aggregations = &$this->getRefTable($refPath)->aggregation;
		$key = $refPath . $function . $this->sqlBuilder->getSelectQueryHash($this->getPreviousAccessedColumns());
		$aggregation = &$aggregations[$key];

		if (!isset($aggregations[$key])) {
			$aggregation = [];

			$selection = $this->explorer->table($this->name);
			$selection->getSqlBuilder()->importConditions($this->getSqlBuilder());

			if ($groupFunction && $selection->getSqlBuilder()->importGroupConditions($this->getSqlBuilder())) {
				$selection->select("$function AS aggregate, $this->name.$this->column AS groupname");
				$selection->group($selection->getSqlBuilder()->getGroup() . ", $this->name.$this->column");
				$query = "SELECT $groupFunction(aggregate) AS groupaggregate, groupname FROM (" . $selection->getSql() . ') AS aggregates GROUP BY groupname';
				foreach ($this->explorer->query($query, ...$selection->getSqlBuilder()->getParameters()) as $row) {
					$aggregation[$row->groupname] = $row;
				}
			} else {
				$selection->select($function);
				$selection->select("$this->name.$this->column");
				$selection->group("$this->name.$this->column");
				foreach ($selection as $row) {
					$aggregation[$row[$this->column]] = $row;
				}
			}
		}

		if (isset($aggregation[$this->active])) {
			foreach ($aggregation[$this->active] as $val) {
				return $val;
			}
		}

		return 0;
	}


	public function count(?string $column = null): int
	{
		return parent::count($column);
	}


	/********************* internal ****************d*g**/


	protected function execute(): void
	{
		if ($this->rows !== null) {
			$this->observeCache = $this;
			return;
		}

		$accessedColumns = $this->accessedColumns;
		$this->loadRefCache();

		if (!isset($this->refCacheCurrent['data'])) {
			// we have not fetched any data yet => init accessedColumns by cached accessedColumns
			$this->accessedColumns = $accessedColumns;

			$limit = $this->sqlBuilder->getLimit();
			$rows = count($this->refTable->rows ?? []);
			if ($limit && $rows > 1) {
				$this->sqlBuilder->setLimit(null, null);
			}

			parent::execute();
			$this->sqlBuilder->setLimit($limit, null);
			$data = [];
			$offset = [];
			$this->accessColumn($this->column);
			foreach ((array) $this->rows as $key => $row) {
				$ref = &$data[$row[$this->column]];
				$skip = &$offset[$row[$this->column]];
				if (
					$limit === null
					|| $rows <= 1
					|| (count($ref ?? []) < $limit
						&& $skip >= $this->sqlBuilder->getOffset())
				) {
					$ref[$key] = $row;
				} else {
					unset($this->rows[$key]);
				}

				$skip++;
				unset($ref, $skip);
			}

			$this->refCacheCurrent['data'] = $data;
			$this->data = &$this->refCacheCurrent['data'][$this->active];
		}

		$this->observeCache = $this;
		if ($this->data === null) {
			$this->data = [];
		} else {
			foreach ($this->data as $row) {
				$row->setTable($this); // injects correct parent GroupedSelection
			}

			if ($this->data !== null) {
				reset($this->data);
			}
		}
	}


	/**
	 * @param-out string  $refPath
	 * @return Selection<ActiveRow>
	 */
	protected function getRefTable(mixed &$refPath): Selection
	{
		$refObj = $this->refTable;
		$refPath = $this->name . '.';
		while ($refObj instanceof self) {
			$refPath .= $refObj->name . '.';
			$refObj = $refObj->refTable;
		}

		return $refObj;
	}


	protected function loadRefCache(): void
	{
		$hash = $this->getSpecificCacheKey();
		$referencing = &$this->refCache['referencing'][$this->getGeneralCacheKey()];
		$this->observeCache = &$referencing['observeCache'];
		$this->refCacheCurrent = &$referencing[$hash];
		$this->accessedColumns = &$referencing[$hash]['accessed'];
		$this->rows = &$referencing[$hash]['rows'];

		if (isset($referencing[$hash]['data'][$this->active])) {
			$this->data = &$referencing[$hash]['data'][$this->active];
		}
	}


	protected function emptyResultSet(bool $clearCache = true, bool $deleteReferencedCache = true): void
	{
		parent::emptyResultSet($clearCache, deleteReferencedCache: false);
	}


	/********************* manipulation ****************d*g**/


	/**
	 * @param  iterable<mixed>|Selection<ActiveRow>  $data
	 */
	public function insert(iterable $data): ActiveRow|array|int
	{
		if ($data instanceof Selection) {
			return parent::insert($data);
		}

		$data = $data instanceof \Traversable ? iterator_to_array($data) : $data;
		if (array_is_list($data)) {
			foreach (array_keys($data) as $key) {
				$data[$key][$this->column] = $this->active;
			}
		} else {
			$data[$this->column] = $this->active;
		}

		return parent::insert($data);
	}


	public function update(iterable $data): int
	{
		$builder = $this->sqlBuilder;

		$this->sqlBuilder = clone $this->sqlBuilder;
		$this->where($this->column, $this->active);
		$return = parent::update($data);

		$this->sqlBuilder = $builder;
		return $return;
	}


	public function delete(): int
	{
		$builder = $this->sqlBuilder;

		$this->sqlBuilder = clone $this->sqlBuilder;
		$this->where($this->column, $this->active);
		$return = parent::delete();

		$this->sqlBuilder = $builder;
		return $return;
	}
}