TWeakCallableCollection::flattenPriorities() - Code Metrics - Inspection of "#984 TEventSubscription for temporary handler in a..." - pradosoft/prado - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 246025...18c029 )

by Fabio
created 2023-07-04 12:20 UTC
TWeakCallableCollection::flattenPriorities() A

↳ Parent: TWeakCallableCollection
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	1
b	0
f	0
<?php
/**
 * TWeakCallableCollection class
 *
 * @author Brad Anderson <[email protected]>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */

namespace Prado\Collections;

use Prado\Exceptions\TInvalidDataValueException;
use Prado\Exceptions\TInvalidDataTypeException;
use Prado\Exceptions\TInvalidOperationException;
use Prado\Prado;
use Prado\TEventHandler;
use Prado\TPropertyValue;

use Closure;
use Traversable;
use WeakReference;

/**
 * TWeakCallableCollection class
 *
 * TWeakCallableCollection implements a priority ordered list collection of callables.
 * This extends {@link TPriorityList}.  This holds the callables for object event handlers
 * and global event handlers by converting all callable objects into a WeakReference.
 * TWeakCallableCollection prevents circular references in global events that would
 * otherwise block object destruction, and thus removal of the callable in __destruct.
 * All data out has the callable objects converted back to the regular object reference
 * in a callable.
 *
 * Closure and {@link IWeakRetainable} are not converted into WeakReference as they
 * may be the only instance in the application.  This increments their PHP use counter
 * resulting in them being retained.
 *
 * When searching by a {@link TEventHandler} object, it will only find itself and
 * will not match on its {@link TEventHandler::getHandler}.  However, if searching
 * for a callable handler, it will first match direct callable handlers in the list,
 * and then search for matching TEventHandlers' Handler regardless of the data.
 * Put another way, searching for callable handlers will find TEventHandlers that
 * use the handler.
 *
 * This uses PHP 8 WeakMap to track any system changes to the weak references of
 * objects the list is using -when {@link getDiscardInvalid DiscardInvalid} is true.
 * By default, when the map is read only then the items are not scrubbed, but the
 * scrubbing behavior can be enabled for read only lists. In this instance, no new
 * items can be added but only a list of valid  callables is kept.
 *
 * By default, lists that are mutable (aka. not read only) will discard invalid callables
 * automatically, but the scrubbing behavior can be disabled for mutable lists if needed.
 *
 * @author Brad Anderson <[email protected]>
 * @since 4.2.0
 */
class TWeakCallableCollection extends TPriorityList implements IWeakCollection, ICollectionFilter
{
	use TWeakCollectionTrait;

	/** @var ?bool Should invalid WeakReferences automatically be deleted from the list */
	private ?bool $_discardInvalid = null;

	/** @var int The number of TEventHandlers in the list */
	private int $_eventHandlerCount = 0;

	/**
	 * Constructor.
	 * Initializes the list with an array or an iterable object.
	 * @param null|array|\Iterator|TPriorityList|TPriorityMap $data The initial data.
	 *   Default is null, meaning no initial data.
	 * @param ?bool $readOnly Whether the list is read-only
	 * @param ?numeric $defaultPriority The default priority of items without specified
filter:
    dependency_paths: ["lib/*"]
	 *   priorities. Default null for 10.
	 * @paraum ?int $precision The precision of the numeric priorities.  Default null
	 *   for 8.
	 * @param ?bool $discardInvalid Whether or not to discard invalid WeakReferences.
	 *   Default null for the opposite of Read-Only.  Mutable Lists expunge invalid
	 *   WeakReferences and Read only lists do not.  Set this bool to override the default
	 *   behavior.
	 * @param null|int $precision The numeric precision of the priority.
	 * @throws \Prado\Exceptions\TInvalidDataTypeException If data is not null and
	 *   is neither an array nor an iterator.
	 */
	public function __construct($data = null, $readOnly = null, $defaultPriority = null, $precision = null, $discardInvalid = null)
	{
		if ($set = ($discardInvalid === false || $discardInvalid === null && $readOnly === true)) {
			$this->setDiscardInvalid(false);
		}
		parent::__construct($data, $readOnly, $defaultPriority, $precision);
		parent::__construct(/** @scrutinizer ignore-type */ $data, $readOnly, $defaultPriority, $precision);
		if (!$set) {
			$this->setDiscardInvalid($discardInvalid);
		}
	}

	/**
	 * Cloning a TWeakCallableCollection requires cloning the WeakMap
	 * @since 4.2.3
	 */
	public function __clone()
	{
		$this->weakClone();
		parent::__clone();
	}

	/**
	 * Waking up a TWeakCallableCollection requires creating the WeakMap.  No items
	 * are saved in TWeakList so only initialization of the WeakMap is required.
	 * @since 4.2.3
	 */
	public function __wakeup()
	{
		if ($this->_discardInvalid) {
			$this->weakStart();
		}
		parent::__wakeup();
	}


	/**
	 * TWeakCallableCollection cannot auto listen to global events or there will be
	 * catastrophic recursion.
	 * @return bool returns false
	 */
	public function getAutoGlobalListen()
	{
		return false;
	}

	/**
	 * This is a custom function for adding objects to the weak map.  Specifically,
	 * if the object being added is a TEventHandler, we use the {@link TEventHandler::getHandlerObject}
	 * object instead of the TEventHandler itself.
	 * @param object $object The object to add to the managed weak map.
	 * @since 4.2.3
	 */
	protected function weakCustomAdd(object $object)
	{
		if($object instanceof TEventHandler) {
			$object = $object->getHandlerObject();
			if (!$object) {
				return;
			}
			$this->_eventHandlerCount++;
		}
		return $this->weakAdd($object);
	}

	/**
	 * This is a custom function for removing objects to the weak map.  Specifically,
	 * if the object being removed is a TEventHandler, we use the {@link TEventHandler::getHandlerObject}
	 * object instead of the TEventHandler itself.
	 * @param object $object The object to remove to the managed weak map.
	 * @since 4.2.3
	 */
	protected function weakCustomRemove(object $object)
	{
		if($object instanceof TEventHandler) {
			$object = $object->getHandlerObject();
			if (!$object) {
				return;
			}
			$this->_eventHandlerCount--;
		}
		return $this->weakRemove($object);
	}

	/**
	 * This converts the $items array of callable with WeakReferences back into the
	 * actual callable.
	 * @param array &$items an array of callable where objects are WeakReference
	 */
	protected function filterItemsForOutput(&$items)
	{
		if (!is_array($items)) {

			return;
		}
		for ($i = 0, $c = count($items); $i < $c; $i++) {
			$this->filterItemForOutput($items[$i]);
		}
	}


	/**
	 * This converts the $items array of callable with WeakReferences back into the
	 * actual callable.
	 * @param callable &$handler the $handler or $handler[0] may be a WeakReference
	 */
	public static function filterItemForOutput(&$handler): void
	{
		if (is_array($handler) && is_object($handler[0]) && ($handler[0] instanceof WeakReference)) {
			if ($obj = $handler[0]->get()) {
				$handler[0] = $obj;
			} else {
				$handler = null;
			}
		} elseif (is_object($handler)) {
			if($handler instanceof WeakReference) {
				$handler = $handler->get();
			} elseif (($handler instanceof TEventHandler) && !$handler->hasHandler()) {
				$handler = null;
			}
		}
	}


	/**
	 * Converts the $handler callable into a WeakReference version for storage
	 * @param callable &$handler callable to convert into a WeakReference version
	 * @param bool $validate whether or not to validate the input as a callable
	 */
	public static function filterItemForInput(&$handler, $validate = false): void
	{
		if ($validate && !is_callable($handler)) {
			throw new TInvalidDataValueException('weakcallablecollection_callable_required');
		}
		if (is_array($handler) && is_object($handler[0]) && !($handler[0] instanceof IWeakRetainable)) {
			$handler[0] = WeakReference::create($handler[0]);
		} elseif (is_object($handler) && !($handler instanceof Closure) && !($handler instanceof IWeakRetainable)) {
			$handler = WeakReference::create($handler);
		}
	}

	/**
	 * When a change in the WeakMap is detected, scrub the list of WeakReference that
	 * have lost their object.
	 * All invalid WeakReference[s] are optionally removed from the list when {@link
	 * getDiscardInvalid} is true.
	 * @since 4.2.3
	 */
	protected function scrubWeakReferences()
	{
		if (!$this->getDiscardInvalid() || !$this->weakChanged()) {
			return;
		}
		foreach (array_keys($this->_d) as $priority) {
			for ($c = $i = count($this->_d[$priority]), $i--; $i >= 0; $i--) {
				$a = is_array($this->_d[$priority][$i]);
				$isEventHandler = $weakRefInvalid = false;
				$arrayInvalid = $a && is_object($this->_d[$priority][$i][0]) && ($this->_d[$priority][$i][0] instanceof WeakReference) && $this->_d[$priority][$i][0]->get() === null;
				if (is_object($this->_d[$priority][$i])) {
					$object = $this->_d[$priority][$i];
					if ($isEventHandler = ($object instanceof TEventHandler)) {
						$object = $object->getHandlerObject(true);
					}
					$weakRefInvalid = ($object instanceof WeakReference) && $object->get() === null;
				}
				if ($arrayInvalid || $weakRefInvalid) {
					$c--;
					$this->_c--;
					if ($i === $c) {
						array_pop($this->_d[$priority]);
					} else {
						array_splice($this->_d[$priority], $i, 1);
					}
					if ($isEventHandler) {
						$this->_eventHandlerCount--;
					}
				}
			}
			if (!$c) {
				unset($this->_d[$priority]);
			}
		}
		$this->_fd = null;
		$this->weakResetCount();
	}

	/**
	 * @return bool Does the TWeakList scrub invalid WeakReferences.
	 * @since 4.2.3
	 */
	public function getDiscardInvalid(): bool
	{
		$this->collapseDiscardInvalid();
		return (bool) $this->_discardInvalid;
	}

	/**
	 * Ensures that DiscardInvalid is set.
	 */
	protected function collapseDiscardInvalid()
	{
		if ($this->_discardInvalid === null) {
			$this->setDiscardInvalid(!$this->getReadOnly());
		}
	}

	/**
	 * All invalid WeakReference[s] are optionally removed from the list on $value
	 *  being "true".
	 * @param null|bool|string $value Sets the TWeakList scrubbing of invalid WeakReferences.
	 * @since 4.2.3
	 */
	public function setDiscardInvalid($value): void
	{
		if($value === $this->_discardInvalid) {
			return;
		}
		if ($this->_discardInvalid !== null && !Prado::isCallingSelf()) {
			throw new TInvalidOperationException('weak_no_set_discard_invalid', $this::class);
		}
		$value = TPropertyValue::ensureBoolean($value);
		if ($value && !$this->_discardInvalid) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
			$this->weakStart();
			foreach (array_keys($this->_d) as $priority) {
				for ($i = count($this->_d[$priority]) - 1; $i >= 0; $i--) {
					$a = is_array($this->_d[$priority][$i]);
					if ($a && is_object($this->_d[$priority][$i][0]) || !$a && is_object($this->_d[$priority][$i])) {

						$obj = $a ? $this->_d[$priority][$i][0] : $this->_d[$priority][$i];
						$isEventHandler = false;
						if (!$a && ($isEventHandler = ($obj instanceof TEventHandler))) {
							$obj = $obj->getHandlerObject(true);
						}
						if ($obj instanceof WeakReference) {
							if($obj = $obj->get()) {
								$this->weakAdd($obj);
							} else {
								parent::removeAtIndexInPriority($i, $priority);
							}
							if ($isEventHandler) {
								$this->_eventHandlerCount--;
							}
						} else { // Closure
							$this->weakAdd($obj);
						}
					}
				}
			}
		} elseif (!$value && $this->_discardInvalid) {
			$this->weakStop();
		}
		$this->_discardInvalid = $value;
	}


	/**
	 * This flattens the priority list into a flat array [0,...,n-1]. This is needed to
	 * filter the output.
	 * All invalid WeakReference[s] are optionally removed from the list before flattening.
	 */
	protected function flattenPriorities(): void
	{
		$this->scrubWeakReferences();
		parent::flattenPriorities();
	}

	/**
	 * This returns a list of the priorities within this list, ordered lowest (first)
	 * to highest (last).
	 * All invalid WeakReference[s] are optionally removed from the list before getting
	 * the priorities.
	 * @return array the array of priority numerics in increasing priority number
	 * @since 4.2.3
	 */
	public function getPriorities(): array
	{
		$this->scrubWeakReferences();
		return parent::getPriorities();
	}

	/**
	 * Gets the number of items at a priority within the list.
	 * All invalid WeakReference[s] are optionally removed from the list before counting.
	 * @param null|numeric $priority optional priority at which to count items.  if no
	 *    parameter, it will be set to the default {@link getDefaultPriority}
	 * @return int the number of items in the list at the specified priority
	 * @since 4.2.3
	 */
	public function getPriorityCount($priority = null)
	{
		$this->scrubWeakReferences();
		return parent::getPriorityCount($priority);
	}

	/**
	 * Returns an iterator for traversing the items in the list.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * This method is required by the interface \IteratorAggregate.
	 * @return \Iterator an iterator for traversing the items in the list.
	 * @since 4.2.3
	 */
	public function getIterator(): \Iterator
	{
		$this->flattenPriorities();
		$items = $this->_fd;
		$this->filterItemsForOutput($items);
		return new \ArrayIterator($items);
	}

	/**
	 * Returns the total number of items in the list
	 * All invalid WeakReference[s] are optionally removed from the list before counting.
	 * @return int the number of items in the list
	 * @since 4.2.3
	 */
	public function getCount(): int
	{
		$this->scrubWeakReferences();
		return parent::getCount();
	}

	/**
	 * Returns the item at the index of a flattened priority list. This is needed to
	 *  filter the output.  {@link offsetGet} calls this method.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param int $index the index of the item to get
	 * @throws TInvalidDataValueException Issued when the index is invalid
	 * @return mixed the element at the offset
	 */
	public function itemAt($index)
	{
		$this->scrubWeakReferences();
		if ($index >= 0 && $index < $this->_c) {
			parent::flattenPriorities();
			$item = $this->_fd[$index];
			$this->filterItemForOutput($item);
			return $item;
		} else {
			throw new TInvalidDataValueException('list_index_invalid', $index);
		}
	}

	/**
	 * Gets all the items at a specific priority. This is needed to filter the output.
	 * All invalid WeakReference[s] are optionally removed from the list before retrieving.
	 * @param null|numeric $priority priority of the items to get.  Defaults to null,
	 *    filled in with the default priority, if left blank.
	 * @return ?array all items at priority in index order, null if there are no items
	 *    at that priority
	 */
	public function itemsAtPriority($priority = null): ?array
	{
		$this->scrubWeakReferences();
		$items = parent::itemsAtPriority($priority);
		$this->filterItemsForOutput($items);
		return $items;
	}

	/**
	 * Returns the item at an index within a priority. This is needed to filter the
	 * output.
	 * All invalid WeakReference[s] are optionally removed from the list before retrieving.
	 * @param int $index the index into the list of items at priority
	 * @param null|numeric $priority the priority which to index.  no parameter or null
	 *   will result in the default priority
	 * @return mixed the element at the offset, false if no element is found at the offset
	 */
	public function itemAtIndexInPriority($index, $priority = null)
	{
		$this->scrubWeakReferences();
		$item = parent::itemAtIndexInPriority($index, $priority);
		$this->filterItemForOutput($item);
		return $item;
	}

	/**
	 * Inserts an item at an index.  It reads the priority of the item at index within the
	 * flattened list and then inserts the item at that priority-index.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param int $index the specified position in the flattened list.
	 * @param mixed $item new item to add
	 * @throws TInvalidDataValueException If the index specified exceeds the bound
	 * @throws TInvalidOperationException if the list is read-only
	 * @since 4.2.3
	 */
	public function insertAt($index, $item)
	{
		if ($this->getReadOnly()) {
			throw new TInvalidOperationException('list_readonly', $this::class);
		}

		if (($priority = $this->priorityAt($index, true)) !== false) {
			$this->internalInsertAtIndexInPriority($item, $priority[1], $priority[0]);
			return $priority[0];
		} else {
			throw new TInvalidDataValueException('list_index_invalid', $index);
		}
	}

	/**
	 * Inserts an item at the specified index within a priority.  This scrubs the list and
	 * calls {@link internalInsertAtIndexInPriority}.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param mixed $item item to add within the list.
	 * @param null|false|int $index index within the priority to add the item, defaults to null
	 *    which appends the item at the priority
	 * @param null|numeric $priority priority of the item.  defaults to null, which sets it
	 *   to the default priority
	 * @param bool $preserveCache preserveCache specifies if this is a special quick function
	 *   or not. This defaults to false.
	 * @throws \Prado\Exceptions\TInvalidDataValueException If the index specified exceeds
	 *   the bound
	 * @throws \Prado\Exceptions\TInvalidOperationException if the list is read-only
	 */
	public function insertAtIndexInPriority($item, $index = null, $priority = null, $preserveCache = false)
	{
		$this->scrubWeakReferences();
		return $this->internalInsertAtIndexInPriority($item, $index, $priority, $preserveCache);
	}

	/**
	 * Inserts an item at the specified index within a priority.  This does not scrub the
	 * list of WeakReference.  This converts the item into a WeakReference if it is an object
	 * or contains an object in its callable.  This does not convert Closure into WeakReference.
	 * @param mixed $items item or array of items to add within the list.
	 * @param null|false|int $index index within the priority to add the item, defaults to null
	 *    which appends the item at the priority
	 * @param null|numeric $priority priority of the item.  defaults to null, which sets it
	 *    to the default priority
	 * @param bool $preserveCache preserveCache specifies if this is a special quick function
	 *    or not. This defaults to false.
	 * @throws \Prado\Exceptions\TInvalidDataValueException If the index specified exceeds the
	 *    bound
	 * @throws \Prado\Exceptions\TInvalidOperationException if the list is read-only
	 * @since 4.2.3
	 */
	protected function internalInsertAtIndexInPriority($items, $index = null, $priority = null, $preserveCache = false)
	{
		$this->collapseDiscardInvalid();
		if (is_callable($items, true)) {
			$items = [$items];
		} elseif (!is_array($items)) {
			throw new TInvalidDataValueException('weakcallablecollection_callable_required');
		}
		$return = null;
		foreach($items as $item) {
			$itemPriority = null;
			if (($isPriorityItem = ($item instanceof IPriorityItem)) && ($priority === null || !is_numeric($priority))) {
				$itemPriority = $priority = $item->getPriority();
			}
			$priority = $this->ensurePriority($priority);
			if (($item instanceof IPriorityCapture) && (!$isPriorityItem || $itemPriority !== $priority)) {
				$item->setPriority($priority);
				$item->setPriority(/** @scrutinizer ignore-type */ $priority);
			}
			if (($isObj = is_object($item)) || is_array($item) && is_object($item[0])) {
				$this->weakCustomAdd($isObj ? $item : $item[0]);
			}
			$this->filterItemForInput($item, true);
			$this->filterItemForInput(/** @scrutinizer ignore-type */ $item, true);
			$result = parent::insertAtIndexInPriority($item, $index, $priority, $preserveCache);
			$result = parent::insertAtIndexInPriority($item, $index, /** @scrutinizer ignore-type */ $priority, $preserveCache);
			if ($return === null) {
				$return = $result;
			} elseif(!is_array($return)) {
				$return = [$return, $result];
			} else {
				$return[] = $result;
			}
			if (is_int($index)) {
				$index++;
			}
		}
		return $return;
	}

	/**
	 * Removes an item from the priority list.
	 * The list will search for the item.  The first matching item found will be removed from
	 * the list.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param mixed $item item the item to be removed.
	 * @param null|bool|float $priority priority of item to remove. without this parameter it
	 *   defaults to false.  A value of false means any priority. null will be filled in with
	 *   the default priority.
	 * @throws TInvalidDataValueException If the item does not exist
	 * @return int index within the flattened list at which the item is being removed
	 * @since 4.2.3
	 */
	public function remove($item, $priority = false)
	{
		if ($this->getReadOnly()) {
			throw new TInvalidOperationException('list_readonly', $this::class);
		}

		if ($priority !== false) {
			$this->filterItemForInput($item);
			$this->sortPriorities();

			$priority = $this->ensurePriority($priority);

			$absindex = 0;
			foreach (array_keys($this->_d) as $p) {
				if ($p < $priority) {
					$absindex += count($this->_d[$p]);
					continue;
				} elseif ($p == $priority) {
					if (($index = array_search($item, $this->_d[$p], true)) !== false) {
						$absindex += $index;
						$this->removeAtIndexInPriority($index, $p);
						$this->removeAtIndexInPriority(/** @scrutinizer ignore-type */ $index, $p);
						return $absindex;
					}
				}
				break;
			}
			throw new TInvalidDataValueException('list_item_inexistent');
		}

		if (($p = $this->priorityOf($item, true)) !== false) {
			$this->internalRemoveAtIndexInPriority($p[1], $p[0]);
			return $p[2];
		} else {
			throw new TInvalidDataValueException('list_item_inexistent');
		}
	}

	/**
	 * Removes an item at the specified index in the flattened list.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param int $index index of the item to be removed.
	 * @throws TInvalidDataValueException If the index specified exceeds the bound
	 * @throws TInvalidOperationException if the list is read-only
	 * @return mixed the removed item.
	 * @since 4.2.3
	 */
	public function removeAt($index)
	{
		if ($this->getReadOnly()) {
			throw new TInvalidOperationException('list_readonly', $this::class);
		}

		if (($priority = $this->priorityAt($index, true)) !== false) {
			return $this->internalRemoveAtIndexInPriority($priority[1], $priority[0]);
		}
		throw new TInvalidDataValueException('list_index_invalid', $index);
	}

	/**
	 * Removes the item at a specific index within a priority.  This is needed to filter
	 * the output.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param int $index index of item to remove within the priority.
	 * @param null|numeric $priority priority of the item to remove, defaults to null,
	 *    or left blank, it is then set to the default priority
	 * @throws TInvalidDataValueException If the item does not exist
	 * @return mixed the removed item.
	 */
	public function removeAtIndexInPriority($index, $priority = null)
	{
		$this->scrubWeakReferences();
		return $this->internalRemoveAtIndexInPriority($index, $priority);
	}

	/**
	 * Removes the item at a specific index within a priority.  This is needed to filter
	 * the output.
	 * @param int $index index of item to remove within the priority.
	 * @param null|numeric $priority priority of the item to remove, defaults to null, or
	 *    left blank, it is then set to the default priority
	 * @throws TInvalidDataValueException If the item does not exist
	 * @return mixed the removed item.
	 * @since 4.2.3
	 */
	protected function internalRemoveAtIndexInPriority($index, $priority = null)
	{
		$item = parent::removeAtIndexInPriority($index, $priority);
		$this->filterItemForOutput($item);
		if (($isObj = is_object($item)) || is_array($item) && is_object($item[0])) {
			$this->weakCustomRemove($obj = $isObj ? $item : $item[0]);
			$this->weakCustomRemove(/** @scrutinizer ignore-type */ $obj = $isObj ? $item : $item[0]);
		}
		return $item;
	}

	/**
	 * Removes all items in the priority list by calling removeAtIndexInPriority from the
	 * last item to the first.
	 * @since 4.2.3
	 */
	public function clear(): void
	{
		if ($this->getReadOnly()) {
			throw new TInvalidOperationException('list_readonly', get_class($this));
		}

		$c = $this->_c;
		foreach (array_keys($this->_d) as $priority) {
			for ($index = count($this->_d[$priority]) - 1; $index >= 0; $index--) {
				parent::removeAtIndexInPriority($index, $priority);
			}
		}

		if ($c) {
			$this->weakRestart();
		}
	}

	/**
	 * @param mixed $item the item
	 * @return bool whether the list contains the item
	 * @since 4.2.3
	 */
	public function contains($item): bool
	{
		return $this->indexOf($item) !== -1;
	}

	/**
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param mixed $item item being indexed.
	 * @param mixed $priority
	 * @return int the index of the item in the flattened list (0 based), -1 if not found.
	 */
	public function indexOf($item, $priority = false)
	{
		$this->filterItemForInput($item);
		if ($priority !== false) {
			$this->sortPriorities();

			$priority = $this->ensurePriority($priority);

			$absindex = 0;
			foreach (array_keys($this->_d) as $p) {
				if ($p < $priority) {
					$absindex += count($this->_d[$p]);
					continue;
				} elseif ($p == $priority) {
					$index = false;
					foreach($this->_d[$p] as $index => $pItem) {
						if ($item === $pItem || ($pItem instanceof TEventHandler) && $pItem->isSameHandler($item, true)) {
							break;
						}
						$index = false;
					}
					if ($index !== false) {
						$absindex += $index;
						return $absindex;
					}
				}
				return -1;
			}
			return -1;
		}
		$this->flattenPriorities();

		if (($index = array_search($item, $this->_fd, true)) === false && $this->_eventHandlerCount) {
		if (($index = array_search($item, /** @scrutinizer ignore-type */ $this->_fd, true)) === false && $this->_eventHandlerCount) {
			foreach($this->_fd as $index => $pItem) {
				if (($pItem instanceof TEventHandler) && $pItem->isSameHandler($item, true)) {
					break;
				}
				$index = false;
			}
		}
		if ($index === false) {
			return -1;
		} else {
			return $index;
		}
	}

	/**
	 * Returns the priority of a particular item.  This is needed to filter the input.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing
	 * when $withindex is "true" due to the more complex processing.
	 * @param mixed $item the item to look for within the list.
	 * @param bool $withindex this specifies if the full positional data of the item
	 *   within the list is returned.  This defaults to false, if no parameter is provided,
	 *   so only provides the priority number of the item by default.
	 * @return array|false|numeric the priority of the item in the list, false if not found.
	 *   if withindex is true, an array is returned of [0 => $priority, 1 => $priorityIndex,
	 *    2 => flattenedIndex, 'priority' => $priority, 'index' => $priorityIndex,
	 *   'absindex' => flattenedIndex]
	 */
	public function priorityOf($item, $withindex = false)
	{
		if ($withindex) {
			$this->scrubWeakReferences();
		}
		$this->filterItemForInput($item);
		$this->sortPriorities();

		$absindex = 0;
		foreach (array_keys($this->_d) as $priority) {
			if (($index = array_search($item, $this->_d[$priority], true)) !== false) {
				$absindex += $index;
				return $withindex ? [$priority, $index, $absindex,
						'priority' => $priority, 'index' => $index, 'absindex' => $absindex, ] : $priority;
			} else {
				$absindex += count($this->_d[$priority]);
			}
		}
		if (!$this->_eventHandlerCount) {
			return false;
		}

		$absindex = 0;
		foreach (array_keys($this->_d) as $priority) {
			$index = false;
			foreach($this->_d[$priority] as $index => $pItem) {
				if(($pItem instanceof TEventHandler) && $pItem->isSameHandler($item, true)) {
					break;
				}
				$index = false;
			}
			if ($index !== false) {
				$absindex += $index;
				return $withindex ? [$priority, $index, $absindex,
						'priority' => $priority, 'index' => $index, 'absindex' => $absindex, ] : $priority;
			} else {
				$absindex += count($this->_d[$priority]);
			}
		}

		return false;
	}

	/**
	 * Returns the priority of an item at a particular flattened index.  The index after
	 * the last item does not exist but receives a priority from the last item so that
	 * priority information about any new items being appended is available.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param int $index index of the item within the list
	 * @param bool $withindex this specifies if the full positional data of the item
	 *   within the list is returned.  This defaults to false, if no parameter is provided,
	 *   so only provides the priority number of the item by default.
	 * @return array|false|numeric the priority of the item in the list, false if not found.
	 *   if $withindex is true, an array is returned of [0 => $priority, 1 => $priorityIndex,
	 *   2 => flattenedIndex, 'priority' => $priority, 'index' => $priorityIndex, 'absindex'
	 *   => flattenedIndex]
	 * @since 4.2.3
	 */
	public function priorityAt($index, $withindex = false)
	{
		$this->scrubWeakReferences();
		return parent::priorityAt($index, $withindex);

	}

	/**
	 * This inserts an item before another item within the list.  It uses the same priority
	 * as the found index item and places the new item before it.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param mixed $indexitem the item to index
	 * @param mixed $item the item to add before indexitem
	 * @throws TInvalidDataValueException If the item does not exist
	 * @return int where the item has been inserted in the flattened list
	 * @since 4.2.3
	 */
	public function insertBefore($indexitem, $item)
	{
		if ($this->getReadOnly()) {
			throw new TInvalidOperationException('list_readonly', $this::class);
		}

		if (($priority = $this->priorityOf($indexitem, true)) === false) {
			throw new TInvalidDataValueException('list_item_inexistent');
		}

		$this->internalInsertAtIndexInPriority($item, $priority[1], $priority[0]);

		return $priority[2];
	}

	/**
	 * This inserts an item after another item within the list.  It uses the same priority
	 * as the found index item and places the new item after it.
	 * All invalid WeakReference[s] are optionally removed from the list before indexing.
	 * @param mixed $indexitem the item to index
	 * @param mixed $item the item to add after indexitem
	 * @throws TInvalidDataValueException If the item does not exist
	 * @return int where the item has been inserted in the flattened list
	 * @since 4.2.3
	 */
	public function insertAfter($indexitem, $item)
	{
		if ($this->getReadOnly()) {
			throw new TInvalidOperationException('list_readonly', $this::class);
		}

		if (($priority = $this->priorityOf($indexitem, true)) === false) {
			throw new TInvalidDataValueException('list_item_inexistent');
		}

		$this->internalInsertAtIndexInPriority($item, $priority[1] + 1, $priority[0]);

		return $priority[2] + 1;
	}

	/**
	 * All invalid WeakReference[s] are optionally removed from the list before returning.
	 * @return array the priority list of items in array
	 * @since 4.2.3
	 */
	public function toArray(): array
	{
		$this->flattenPriorities();
		$items = $this->_fd;
		$this->filterItemsForOutput($items);
		return $items;
	}


	/**
	 * All invalid WeakReference[s] are optionally removed from the list before returning.
	 * @return array the array of priorities keys with values of arrays of callables.
	 *   The priorities are sorted so important priorities, lower numerics, are first.
	 */
	public function toPriorityArray(): array
	{
		$this->scrubWeakReferences();
		$result = parent::toPriorityArray();
		foreach (array_keys($result) as $key) {
			$this->filterItemsForOutput($result[$key]);
		}
		return $result;
	}


	/**
	 * All invalid WeakReference[s] are optionally removed from the list before returning.
	 * @return array the array of priorities keys with values of arrays of callables with
	 *   WeakReference rather than objects.  The priorities are sorted so important priorities,
	 *   lower numerics, are first.
	 */
	public function toPriorityArrayWeak()
	{
		$this->scrubWeakReferences();
		return parent::toPriorityArray();
	}

	/**
	 * Combines the map elements which have a priority below the parameter value.  This
	 * is needed to filter the output.
	 * All invalid WeakReference[s] are optionally removed from the list before returning.
	 * @param numeric $priority the cut-off priority.  All items of priority less than
	 *   this are returned.
	 * @param bool $inclusive whether or not the input cut-off priority is inclusive.
	 *   Default: false, not inclusive.
	 * @return array the array of priorities keys with values of arrays of items that
	 *   are below a specified priority.  The priorities are sorted so important priorities,
	 *   lower numerics, are first.
	 * @since 4.2.3
	 */
	public function toArrayBelowPriority($priority, bool $inclusive = false): array
	{
		$this->scrubWeakReferences();
		$items = parent::toArrayBelowPriority($priority, $inclusive);
		$this->filterItemsForOutput($items);
		return $items;
	}

	/**
	 * Combines the map elements which have a priority above the parameter value. This
	 * is needed to filter the output.
	 * All invalid WeakReference[s] are optionally removed from the list before returning.
	 * @param numeric $priority the cut-off priority.  All items of priority greater
	 *   than this are returned.
	 * @param bool $inclusive whether or not the input cut-off priority is inclusive.
	 *   Default: true, inclusive.
	 * @return array the array of priorities keys with values of arrays of items that
	 *   are above a specified priority.  The priorities are sorted so important priorities,
	 *   lower numerics, are first.
	 * @since 4.2.3
	 */
	public function toArrayAbovePriority($priority, bool $inclusive = true): array
	{
		$this->scrubWeakReferences();
		$items = parent::toArrayAbovePriority($priority, $inclusive);
		$this->filterItemsForOutput($items);
		return $items;
	}

	/**
	 * Copies iterable data into the list.
	 * Note, existing data in the list will be cleared first.
	 * @param mixed $data the data to be copied from, must be an array or object implementing
	 *   Traversable
	 * @throws TInvalidDataTypeException If data is neither an array nor a Traversable.
	 * @since 4.2.3
	 */
	public function copyFrom($data): void
	{
		if ($data instanceof TPriorityList) {
			if ($this->_c > 0) {
				$this->clear();
			}
			$array = $data->toPriorityArray();
			foreach (array_keys($array) as $priority) {
				for ($i = 0, $c = count($array[$priority]); $i < $c; $i++) {
					$this->internalInsertAtIndexInPriority($array[$priority][$i], null, $priority);
				}
			}
		} elseif ($data instanceof TPriorityMap) {
			if ($this->_c > 0) {
				$this->clear();
			}
			$array = $data->toPriorityArray();
			foreach (array_keys($array) as $priority) {
				foreach ($array[$priority] as $item) {
					$this->internalInsertAtIndexInPriority($item, null, $priority);
				}
			}
		} elseif (is_array($data) || ($data instanceof Traversable)) {
			if ($this->_c > 0) {
				$this->clear();
			}
			foreach ($data as $item) {
				$this->internalInsertAtIndexInPriority($item);
			}
		} elseif ($data !== null) {
			throw new TInvalidDataTypeException('list_data_not_iterable');
		}
	}

	/**
	 * Merges iterable data into the priority list.
	 * New data will be appended to the end of the existing data.  If another TPriorityList
	 * is merged, the incoming parameter items will be appended at the priorities they are
	 * present.  These items will be added to the end of the existing items with equal
	 * priorities, if there are any.
	 * @param mixed $data the data to be merged with, must be an array or object implementing
	 *   Traversable
	 * @throws TInvalidDataTypeException If data is neither an array nor an iterator.
	 * @since 4.2.3
	 */
	public function mergeWith($data): void
	{
		if ($data instanceof TPriorityList) {
			$array = $data->toPriorityArray();
			foreach (array_keys($array) as $priority) {
				for ($i = 0, $c = count($array[$priority]); $i < $c; $i++) {
					$this->internalInsertAtIndexInPriority($array[$priority][$i], null, $priority);
				}
			}
		} elseif ($data instanceof TPriorityMap) {
			$array = $data->toPriorityArray();
			foreach (array_keys($array) as $priority) {
				foreach ($array[$priority] as $item) {
					$this->internalInsertAtIndexInPriority($item, null, $priority);
				}
			}
		} elseif (is_array($data) || ($data instanceof Traversable)) {
			foreach ($data as $item) {
				$this->internalInsertAtIndexInPriority($item);
			}
		} elseif ($data !== null) {
			throw new TInvalidDataTypeException('list_data_not_iterable');
		}
	}

	/**
	 * Sets the element at the specified offset. This method is required by the interface
	 * \ArrayAccess.  Setting elements in a priority list is not straight forword when
	 * appending and setting at the end boundary.  When appending without an offset (a
	 * null offset), the item will be added at the default priority.  The item may not be
	 * the last item in the list.  When appending with an offset equal to the count of the
	 * list, the item will get be appended with the last items priority.
	 *
	 * All together, when setting the location of an item, the item stays in that location,
	 * but appending an item into a priority list doesn't mean the item is at the end of
	 * the list.
	 *
	 * All invalid WeakReference[s] are optionally removed from the list when an $offset
	 * is given.
	 * @param int $offset the offset to set element
	 * @param mixed $item the element value
	 * @since 4.2.3
	 */
	public function offsetSet($offset, $item): void
	{
		if ($this->getReadOnly()) {
			throw new TInvalidOperationException('list_readonly', $this::class);
		}

		if ($offset === null) {

			$this->internalInsertAtIndexInPriority($item, null, null, true);
			return;
		}
		if (0 <= $offset && $offset <= ($count = $this->getCount())) {
			$priority = parent::priorityAt($offset, true);
			if ($offset !== $count) {
				$this->internalRemoveAtIndexInPriority($priority[1], $priority[0]);
			}
		} else {
			throw new TInvalidDataValueException('list_index_invalid', $offset);
		}
		$this->internalInsertAtIndexInPriority($item, $priority[1], $priority[0]);
	}

	/**
	 * Returns an array with the names of all variables of this object that should
	 * NOT be serialized because their value is the default one or useless to be cached
	 * for the next page loads.  Reimplement in derived classes to add new variables,
	 * but remember to  also to call the parent implementation first.
	 * @param array $exprops by reference
	 * @since 4.2.3
	 */
	protected function _getZappableSleepProps(&$exprops)
	{
		$c = $this->_c;
		$this->_c = 0;
		parent::_getZappableSleepProps($exprops);
		$this->_c = $c;

		$this->_weakZappableSleepProps($exprops);
		if ($this->_discardInvalid === null) {
			$exprops[] = "\0" . __CLASS__ . "\0_discardInvalid";
		}
	}
}

pradosoft / prado

Push — master ( 246025...18c029 )

TWeakCallableCollection::flattenPriorities() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
