Files
2025-12-19 16:27:35 -08:00

188 lines
3.4 KiB
PHP

<?php
/**
* @brief Union Iterator Pattern
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @package Invision Community
* @since 14 Nov 2014
*/
namespace IPS\Patterns;
/* To prevent PHP errors (extending class does not exist) revealing path */
use Countable;
use IPS\DateTime;
use Iterator;
use SplObjectStorage;
use Traversable;
use function count;
use function defined;
use function is_array;
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Union Iterator Pattern
*/
class UnionIterator implements Iterator, Countable
{
/**
* @brief Iterators
*/
protected SplObjectStorage $iterators;
/**
* @brief Current lowest value
*/
protected string $currentIteratorKey;
/**
* @brief Order Direction
*/
protected string $orderDirection;
/**
* @var mixed|null
*/
protected mixed $currentLowestValue = null;
/**
* Constructor
*
* @param string $orderDirection "asc" or "desc"
* @return void
*/
public function __construct( string $orderDirection )
{
$this->iterators = new SplObjectStorage;
$this->orderDirection = $orderDirection;
}
/**
* Attach Iterator
*
* @param Traversable $iterator Iterator
* @param mixed $key The name of the property which contains the value used to compare positions
* @return void
*/
public function attachIterator( Traversable $iterator, mixed $key ) : void
{
$this->iterators->attach( $iterator, $key );
}
/**
* Rewind
*
* @return void
*/
public function rewind() : void
{
foreach ( $this->iterators as $iterator )
{
$iterator->rewind();
}
$this->currentLowestValue = NULL;
$this->next();
}
/**
* Get current row
*
* @return array
*/
public function current(): array
{
foreach ( $this->iterators as $k => $iterator )
{
if ( $k === $this->currentIteratorKey )
{
$return = $iterator->current();
$iterator->next();
return $return;
}
}
return array();
}
/**
* Get current key
*
* @return mixed
*/
public function key(): mixed
{
return NULL;
}
/**
* Fetch next result
*
* @return void
*/
public function next() : void
{
$this->currentIteratorKey = NULL;
$currentLowestValue = NULL;
$values = array();
foreach ( $this->iterators as $k => $iterator )
{
if ( $iterator->valid() )
{
$col = $this->iterators->getInfo();
$current = $iterator->current();
if ( is_array( $current ) )
{
$value = $current[ $col ];
}
else
{
$value = $current->$col;
}
if ( $value instanceof DateTime )
{
$value = $value->getTimestamp();
}
if ( $currentLowestValue === NULL or ( $this->orderDirection === 'asc' and $value < $currentLowestValue ) or ( $this->orderDirection === 'desc' and $value > $currentLowestValue ) )
{
$currentLowestValue = $value;
$this->currentIteratorKey = $k;
}
}
}
}
/**
* Is the current row valid?
*
* @return bool
*/
public function valid(): bool
{
return $this->currentIteratorKey !== NULL;
}
/**
* Get count
*
* @return int
*/
public function count(): int
{
$count = 0;
foreach ( $this->iterators as $iterator )
{
$count += count( $iterator );
}
return $count;
}
}