Index | ramsey/collection

A

AbstractArray — Class in namespace Ramsey\Collection: This class provides a basic implementation of ArrayInterface, to minimize the effort required to implement this interface.
AbstractCollection — Class in namespace Ramsey\Collection: This class provides a basic implementation of CollectionInterface, to minimize the effort required to implement this interface
AbstractCollection::add() — Method in class AbstractCollection: Ensures that this collection contains the specified element.
AbstractSet — Class in namespace Ramsey\Collection: This class contains the basic implementation of a collection that does not allow duplicated values (a set), to minimize the effort required to implement this specific type of collection.
AbstractSet::add() — Method in class AbstractSet: Adds the specified element to this set, if it is not already present.
ArrayInterface — Class in namespace Ramsey\Collection: ArrayInterface provides traversable array functionality to data types.
CollectionInterface::add() — Method in class CollectionInterface: Ensures that this collection contains the specified element (optional operation).
DoubleEndedQueue::addFirst() — Method in class DoubleEndedQueue: Ensures that the specified element is inserted at the front of this queue.
DoubleEndedQueue::addLast() — Method in class DoubleEndedQueue: Ensures that the specified element in inserted at the end of this queue.
DoubleEndedQueueInterface::addFirst() — Method in class DoubleEndedQueueInterface: Inserts the specified element at the front of this queue if it is possible to do so immediately without violating capacity restrictions.
DoubleEndedQueueInterface::addLast() — Method in class DoubleEndedQueueInterface: Inserts the specified element at the end of this queue if it is possible to do so immediately without violating capacity restrictions.
AbstractMap — Class in namespace Ramsey\Collection\Map: This class provides a basic implementation of MapInterface, to minimize the effort required to implement this interface.
AbstractTypedMap — Class in namespace Ramsey\Collection\Map: This class provides a basic implementation of TypedMapInterface, to minimize the effort required to implement this interface.
AssociativeArrayMap — Class in namespace Ramsey\Collection\Map: AssociativeArrayMap represents a standard associative array object.
Queue::add() — Method in class Queue: Ensures that this queue contains the specified element.
QueueInterface::add() — Method in class QueueInterface: Ensures that this queue contains the specified element (optional operation).

C

AbstractArray::count() — Method in class AbstractArray: Returns the number of items in this array.
AbstractArray::clear() — Method in class AbstractArray: Removes all items from this array.
AbstractCollection::contains() — Method in class AbstractCollection: Returns true if this collection contains the specified element.
AbstractCollection::column() — Method in class AbstractCollection: Returns the values from given property or method.
ArrayInterface::clear() — Method in class ArrayInterface: Removes all items from this array.
Collection — Class in namespace Ramsey\Collection: A collection represents a group of objects.
CollectionInterface — Class in namespace Ramsey\Collection: A collection represents a group of objects, known as its elements.
CollectionInterface::contains() — Method in class CollectionInterface: Returns true if this collection contains the specified element.
CollectionInterface::column() — Method in class CollectionInterface: Returns the values from the given property or method.
CollectionMismatchException — Class in namespace Ramsey\Collection\Exception: Thrown when attempting to operate on collections of differing types.
AbstractMap::containsKey() — Method in class AbstractMap: Returns true if this map contains a mapping for the specified key.
AbstractMap::containsValue() — Method in class AbstractMap: Returns true if this map maps one or more keys to the specified value.
MapInterface::containsKey() — Method in class MapInterface: Returns true if this map contains a mapping for the specified key.
MapInterface::containsValue() — Method in class MapInterface: Returns true if this map maps one or more keys to the specified value.
TypeTrait::checkType() — Method in class TypeTrait: Returns true if value is of the specified type.

D

$AbstractArray#data — Property in class AbstractArray: The items of this array.
AbstractCollection::diff() — Method in class AbstractCollection: Create a new collection with divergent items between current and given collection.
CollectionInterface::diff() — Method in class CollectionInterface: Create a new collection with divergent items between current and given collection.
DoubleEndedQueue — Class in namespace Ramsey\Collection: This class provides a basic implementation of DoubleEndedQueueInterface, to minimize the effort required to implement this interface.
DoubleEndedQueueInterface — Class in namespace Ramsey\Collection: A linear collection that supports element insertion and removal at both ends.

E

Queue::element() — Method in class Queue: Retrieves, but does not remove, the head of this queue.
QueueInterface::element() — Method in class QueueInterface: Retrieves, but does not remove, the head of this queue.
ValueExtractorTrait::extractValue() — Method in class ValueExtractorTrait: Extracts the value of the given property or method from the object.

F

AbstractCollection::first() — Method in class AbstractCollection: Returns the first item of the collection.
AbstractCollection::filter() — Method in class AbstractCollection: Returns a filtered collection.
CollectionInterface::first() — Method in class CollectionInterface: Returns the first item of the collection.
CollectionInterface::filter() — Method in class CollectionInterface: Filter out items of the collection which don't match the criteria of given callback.
DoubleEndedQueue::firstElement() — Method in class DoubleEndedQueue: Retrieves, but does not remove, the head of this queue.
DoubleEndedQueueInterface::firstElement() — Method in class DoubleEndedQueueInterface: Retrieves, but does not remove, the head of this queue.
NamedParameterMap::filterNamedParameters() — Method in class NamedParameterMap: Given an array of named parameters, constructs a proper mapping of named parameters to types.

G

AbstractArray::getIterator() — Method in class AbstractArray: Returns an iterator for this array.
Collection::getType() — Method in class Collection: Returns the type associated with this collection.
CollectionInterface::getType() — Method in class CollectionInterface: Returns the type associated with this collection.
GenericArray — Class in namespace Ramsey\Collection: GenericArray represents a standard array object.
AbstractMap::get() — Method in class AbstractMap: Returns the value to which the specified key is mapped, null if this map contains no mapping for the key, or (optionally) $defaultValue if this map contains no mapping for the key.
MapInterface::get() — Method in class MapInterface: Returns the value to which the specified key is mapped, null if this map contains no mapping for the key, or (optionally) $defaultValue if this map contains no mapping for the key.
NamedParameterMap::getNamedParameters() — Method in class NamedParameterMap: Returns named parameters set for this NamedParameterMap.
TypedMap::getKeyType() — Method in class TypedMap: Return the type used on the key.
TypedMap::getValueType() — Method in class TypedMap: Return the type forced on the values.
TypedMapInterface::getKeyType() — Method in class TypedMapInterface: Return the type used on the key.
TypedMapInterface::getValueType() — Method in class TypedMapInterface: Return the type forced on the values.
Queue::getType() — Method in class Queue: Returns the type associated with this queue.
QueueInterface::getType() — Method in class QueueInterface: Returns the type associated with this queue.
Set::getType() — Method in class Set: Returns the type associated with this set.

I

AbstractArray::isEmpty() — Method in class AbstractArray: Returns true if this array is empty.
AbstractCollection::intersect() — Method in class AbstractCollection: Create a new collection with intersecting item between current and given collection.
ArrayInterface::isEmpty() — Method in class ArrayInterface: Returns true if this array is empty.
CollectionInterface::intersect() — Method in class CollectionInterface: Create a new collection with intersecting item between current and given collection.
InvalidArgumentException — Class in namespace Ramsey\Collection\Exception: Thrown to indicate an argument is not of the expected type.
InvalidSortOrderException — Class in namespace Ramsey\Collection\Exception: Thrown when attempting to use a sort order that is not recognized.
$Queue#index — Property in class Queue: The index of the head of the queue.

K

AbstractMap::keys() — Method in class AbstractMap: Return an array of the keys contained in this map.
MapInterface::keys() — Method in class MapInterface: Return an array of the keys contained in this map.

L

AbstractCollection::last() — Method in class AbstractCollection: Returns the last item of the collection.
CollectionInterface::last() — Method in class CollectionInterface: Returns the last item of the collection.
DoubleEndedQueue::lastElement() — Method in class DoubleEndedQueue: Retrieves, but does not remove, the tail of this queue.
DoubleEndedQueueInterface::lastElement() — Method in class DoubleEndedQueueInterface: Retrieves, but does not remove, the tail of this queue.

M

AbstractCollection::map() — Method in class AbstractCollection: Applies a callback to each item of the collection.
AbstractCollection::merge() — Method in class AbstractCollection: Merge current items and items of given collections into a new one.
CollectionInterface::map() — Method in class CollectionInterface: Apply a given callback method on each item of the collection.
CollectionInterface::merge() — Method in class CollectionInterface: Merge current items and items of given collections into a new one.
MapInterface — Class in namespace Ramsey\Collection\Map: An object that maps keys to values.

N

NoSuchElementException — Class in namespace Ramsey\Collection\Exception: Thrown when attempting to access an element that does not exist.
NamedParameterMap — Class in namespace Ramsey\Collection\Map: NamedParameterMap represents a mapping of values to a set of named keys that may optionally be typed
$NamedParameterMap#namedParameters — Property in class NamedParameterMap: Named parameters defined for this map.

O

AbstractArray::offsetExists() — Method in class AbstractArray: Returns true if the given offset exists in this array.
AbstractArray::offsetGet() — Method in class AbstractArray: Returns the value at the specified offset.
AbstractArray::offsetSet() — Method in class AbstractArray: Sets the given value to the given offset in the array.
AbstractArray::offsetUnset() — Method in class AbstractArray: Removes the given offset and its value from the array.
AbstractCollection::offsetSet() — Method in class AbstractCollection: Sets the given value to the given offset in the array.
AbstractSet::offsetSet() — Method in class AbstractSet: Sets the given value to the given offset in this set, if it is not already present.
DoubleEndedQueue::offsetSet() — Method in class DoubleEndedQueue: Sets the given value to the given offset in the queue.
DoubleEndedQueue::offerFirst() — Method in class DoubleEndedQueue: Inserts the specified element at the front this queue.
DoubleEndedQueue::offerLast() — Method in class DoubleEndedQueue: Inserts the specified element at the end this queue.
DoubleEndedQueueInterface::offerFirst() — Method in class DoubleEndedQueueInterface: Inserts the specified element at the front of this queue if it is possible to do so immediately without violating capacity restrictions.
DoubleEndedQueueInterface::offerLast() — Method in class DoubleEndedQueueInterface: Inserts the specified element at the end of this queue if it is possible to do so immediately without violating capacity restrictions.
OutOfBoundsException — Class in namespace Ramsey\Collection\Exception: Thrown when attempting to access an element out of the range of the collection.
AbstractMap::offsetSet() — Method in class AbstractMap: Sets the given value to the given offset in the map.
AbstractTypedMap::offsetSet() — Method in class AbstractTypedMap: Sets the given value to the given offset in the map.
NamedParameterMap::offsetSet() — Method in class NamedParameterMap: Sets the given value to the given offset in the map.
Queue::offsetSet() — Method in class Queue: Sets the given value to the given offset in the queue.
Queue::offer() — Method in class Queue: Inserts the specified element into this queue.
QueueInterface::offer() — Method in class QueueInterface: Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions.

P

DoubleEndedQueue::pollFirst() — Method in class DoubleEndedQueue: Retrieves and removes the head of this queue, or returns null if this queue is empty.
DoubleEndedQueue::pollLast() — Method in class DoubleEndedQueue: Retrieves and removes the tail of this queue, or returns null if this queue is empty.
DoubleEndedQueue::peekFirst() — Method in class DoubleEndedQueue: Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.
DoubleEndedQueue::peekLast() — Method in class DoubleEndedQueue: Retrieves, but does not remove, the tail of this queue, or returns null if this queue is empty.
DoubleEndedQueueInterface::pollFirst() — Method in class DoubleEndedQueueInterface: Retrieves and removes the head of this queue, or returns null if this queue is empty.
DoubleEndedQueueInterface::pollLast() — Method in class DoubleEndedQueueInterface: Retrieves and removes the tail of this queue, or returns null if this queue is empty.
DoubleEndedQueueInterface::peekFirst() — Method in class DoubleEndedQueueInterface: Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.
DoubleEndedQueueInterface::peekLast() — Method in class DoubleEndedQueueInterface: Retrieves, but does not remove, the tail of this queue, or returns null if this queue is empty.
AbstractMap::put() — Method in class AbstractMap: Associates the specified value with the specified key in this map.
AbstractMap::putIfAbsent() — Method in class AbstractMap: Associates the specified value with the specified key in this map only if it is not already set.
MapInterface::put() — Method in class MapInterface: Associates the specified value with the specified key in this map.
MapInterface::putIfAbsent() — Method in class MapInterface: Associates the specified value with the specified key in this map only if it is not already set.
Queue::peek() — Method in class Queue: Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.
Queue::poll() — Method in class Queue: Retrieves and removes the head of this queue, or returns null if this queue is empty.
QueueInterface::peek() — Method in class QueueInterface: Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.
QueueInterface::poll() — Method in class QueueInterface: Retrieves and removes the head of this queue, or returns null if this queue is empty.

Q

Queue — Class in namespace Ramsey\Collection: This class provides a basic implementation of QueueInterface, to minimize the effort required to implement this interface.
QueueInterface — Class in namespace Ramsey\Collection: A queue is a collection in which the entities in the collection are kept in order.

R

AbstractCollection::remove() — Method in class AbstractCollection: Removes a single instance of the specified element from this collection, if it is present.
CollectionInterface::remove() — Method in class CollectionInterface: Removes a single instance of the specified element from this collection, if it is present.
DoubleEndedQueue::removeFirst() — Method in class DoubleEndedQueue: Retrieves and removes the head of this queue.
DoubleEndedQueue::removeLast() — Method in class DoubleEndedQueue: Retrieves and removes the tail of this queue.
DoubleEndedQueueInterface::removeFirst() — Method in class DoubleEndedQueueInterface: Retrieves and removes the head of this queue.
DoubleEndedQueueInterface::removeLast() — Method in class DoubleEndedQueueInterface: Retrieves and removes the tail of this queue.
AbstractMap::remove() — Method in class AbstractMap: Removes the mapping for a key from this map if it is present.
AbstractMap::removeIf() — Method in class AbstractMap: Removes the entry for the specified key only if it is currently mapped to the specified value.
AbstractMap::replace() — Method in class AbstractMap: Replaces the entry for the specified key only if it is currently mapped to some value.
AbstractMap::replaceIf() — Method in class AbstractMap: Replaces the entry for the specified key only if currently mapped to the specified value.
MapInterface::remove() — Method in class MapInterface: Removes the mapping for a key from this map if it is present.
MapInterface::removeIf() — Method in class MapInterface: Removes the entry for the specified key only if it is currently mapped to the specified value.
MapInterface::replace() — Method in class MapInterface: Replaces the entry for the specified key only if it is currently mapped to some value.
MapInterface::replaceIf() — Method in class MapInterface: Replaces the entry for the specified key only if currently mapped to the specified value.
Queue::remove() — Method in class Queue: Retrieves and removes the head of this queue.
QueueInterface::remove() — Method in class QueueInterface: Retrieves and removes the head of this queue.

S

AbstractArray::serialize() — Method in class AbstractArray: Returns a serialized string representation of this array object.
AbstractCollection::sort() — Method in class AbstractCollection: Returns a sorted collection.
CollectionInterface::sort() — Method in class CollectionInterface: Sort the collection by a property or method with the given sort order.
Set — Class in namespace Ramsey\Collection: A set is a collection that contains no duplicate elements.

T

AbstractArray::toArray() — Method in class AbstractArray: Returns a native PHP array representation of this array object.
ArrayInterface::toArray() — Method in class ArrayInterface: Returns a native PHP array representation of this array object.
TypedMap — Class in namespace Ramsey\Collection\Map: A TypedMap represents a map of elements where key and value are typed.
TypedMapInterface — Class in namespace Ramsey\Collection\Map: A TypedMapInterface represents a map of elements where key and value are typed.
TypeTrait — Class in namespace Ramsey\Collection\Tool: Provides functionality to check values for specific types.
ValueToStringTrait::toolValueToString() — Method in class ValueToStringTrait: Returns a string representation of the value.

U

AbstractArray::unserialize() — Method in class AbstractArray: Converts a serialized string representation into an instance object.
AbstractCollection::unserialize() — Method in class AbstractCollection: Converts a serialized string representation into an instance object.
UnsupportedOperationException — Class in namespace Ramsey\Collection\Exception: Thrown to indicate that the requested operation is not supported.

V

ValueExtractionException — Class in namespace Ramsey\Collection\Exception: Thrown when attempting to extract a value for a method or property that does not exist.
ValueExtractorTrait — Class in namespace Ramsey\Collection\Tool: Provides functionality to extract the value of a property or method from an object.
ValueToStringTrait — Class in namespace Ramsey\Collection\Tool: Provides functionality to express a value as string

W

AbstractCollection::where() — Method in class AbstractCollection: Returns a collection of matching items.
CollectionInterface::where() — Method in class CollectionInterface: Create a new collection where items match the criteria of given callback.

_

AbstractArray::__construct() — Method in class AbstractArray: Constructs a new array object.
Collection::__construct() — Method in class Collection: Constructs a collection object of the specified type, optionally with the specified data.
NamedParameterMap::__construct() — Method in class NamedParameterMap: Constructs a new NamedParameterMap.
TypedMap::__construct() — Method in class TypedMap: Constructs a map object of the specified key and value types, optionally with the specified data.
Queue::__construct() — Method in class Queue: Constructs a queue object of the specified type, optionally with the specified data.
Set::__construct() — Method in class Set: Constructs a set object of the specified type, optionally with the specified data.