• Home
• Prado
• Collections
• TPriorityList

PHP Class Prado\Collections\TPriorityList

TPriorityList implements a priority ordered list collection class. It allows you to specify any numeric for priorities down to a specific precision. The lower the numeric, the high the priority of the item in the list. Thus -10 has a higher priority than -5, 0, 10 (the default), 18, 10005, etc. Per {@link round}, precision may be negative and thus rounding can go by 10, 100, 1000, etc, instead of just .1, .01, .001, etc. The default precision allows for 8 decimal places. There is also a default priority of 10, if no different default priority is specified or no item specific priority is indicated. If you replace TList with this class it will work exactly the same with items inserted set to the default priority, until you start using different priorities than the default priority. As you access the PHP array features of this class, it flattens and caches the results. If at all possible, this will keep the cache fresh even when manipulated. If this is not possible the cache is cleared. When an array of items are needed and the cache is outdated, the cache is recreated from the items and their priorities You can access, append, insert, remove an item by using {@link itemAt}, {@link add}, {@link insertAt}, and {@link remove}. To get the number of the items in the list, use {@link getCount}. TPriorityList can also be used like a regular array as follows, $list[]=$item; // append with the default priority. It may not be the last item if other items in the list are prioritized after the default priority $list[$index]=$item; // $index must be between 0 and $list->Count-1. This sets the element regardless of priority. Priority stays the same. $list[$index]=$item; // $index is $list->Count. This appends the item to the end of the list with the same priority as the last item in the list. unset($list[$index]); // remove the item at $index if(isset($list[$index])) // if the list has an item at $index foreach($list as $index=>$item) // traverse each item in the list in proper priority order and add/insert order $n=count($list); // returns the number of items in the list To extend TPriorityList for doing your own operations with each addition or removal, override {@link insertAtIndexInPriority()} and {@link removeAtIndexInPriority()} and then call the parent. Datei anzeigen Open project: pradosoft/prado Class Usage Examples

Public Methods

Method	Description
__construct ( $data = null, $readOnly = false, $defaultPriority = 10, $precision = 8 )	Constructor.
add ( $item, $priority = null ) : integer	Appends an item into the list at the end of the specified priority. The position of the added item may not be at the end of the list.
clear ( )	Removes all items in the priority list by calling removeAtIndexInPriority from the last item to the first.
contains ( $item ) : boolean
copyFrom ( $data )	Copies iterable data into the priority list.
count ( ) : integer	Returns the number of items in the list.
getCount ( ) : integer	Returns the total number of items in the list
getDefaultPriority ( ) : numeric
getIterator ( ) : Iterator	Returns an iterator for traversing the items in the list.
getPrecision ( ) : integer
getPriorities ( ) : array	This returns a list of the priorities within this list, ordered lowest to highest.
getPriorityCount ( $priority = null ) : integer	Gets the number of items at a priority within the list
indexOf ( $item ) : integer
insertAfter ( $indexitem, $item ) : integer	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.
insertAt ( $index, $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.
insertAtIndexInPriority ( $item, $index = false, $priority = null, $preserveCache = false )	Inserts an item at the specified index within a priority. Override and call this method to insert your own functionality.
insertBefore ( $indexitem, $item ) : integer	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.
itemAt ( $index ) : mixed	Returns the item at the index of a flattened priority list.
itemAtIndexInPriority ( $index, $priority = null ) : mixed	Returns the item at an index within a priority
itemsAtPriority ( $priority = null ) : array	Gets all the items at a specific priority.
mergeWith ( $data )	Merges iterable data into the priority list.
offsetExists ( $offset ) : boolean	Returns whether there is an element at the specified offset.
offsetGet ( $offset ) : mixed	Returns the element at the specified offset.
offsetSet ( $offset, $item )	Sets the element at the specified offset. This method is required by the interface \ArrayAccess.
offsetUnset ( $offset )	Unsets the element at the specified offset.
priorityAt ( $index, $withindex = false ) : numeric | array	Retutrns the priority of an item at a particular flattened index.
priorityOf ( $item, $withindex = false ) : numeric | array	Returns the priority of a particular item
remove ( $item, $priority = false ) : integer	Removes an item from the priority list.
removeAt ( $index ) : mixed	Removes an item at the specified index in the flattened list.
removeAtIndexInPriority ( $index, $priority = null ) : mixed	Removes the item at a specific index within a priority. Override and call this method to insert your own functionality.
toArray ( ) : array
toArrayAbovePriority ( $priority, $inclusive = true ) : array	Combines the map elements which have a priority above the parameter value
toArrayBelowPriority ( $priority, $inclusive = false ) : array	Combines the map elements which have a priority below the parameter value
toPriorityArray ( ) : array

Protected Methods

Method	Description
flattenPriorities ( ) : array	This flattens the priority list into a flat array [0,.
setDefaultPriority ( $value )	This must be called internally or when instantiated.
setPrecision ( $value )	This must be called internally or when instantiated.
sortPriorities ( )	This orders the priority list internally.

Method Details