Download the PHP package webfiori/collections without Composer

WebFiori Collections

Basic data structures used by WebFiori framework.

Table of Contents

• Key Features
• Supported PHP Versions
• Installation
• Quick Start
• Usage
  • LinkedList
  • Stack
  • Queue
  • Vector
• Advanced Usage
• API Reference
• Testing
• Contributing
• License
• Support
• Changelog

Key Features

• LinkedList — Doubly-linked list with O(1) add/removeLast and full iterator support
• Stack — LIFO structure with O(1) push/pop
• Queue — FIFO structure with O(1) enqueue/dequeue
• Vector — Array-backed list with O(1) index access, ArrayAccess, and JsonSerializable
• All collections implement Countable
• Optional size limits on all collections
• Sorting support via Comparable interface

Supported PHP Versions

Build Status

Installation

Quick Start

Usage

LinkedList

The LinkedList class provides a doubly-linked list implementation with full iterator support.

LinkedList with Size Limit

Stack

The Stack class implements a Last-In-First-Out (LIFO) data structure.

Stack with Size Limit

Queue

The Queue class implements a First-In-First-Out (FIFO) data structure.

Queue with Size Limit

Vector

The Vector class provides an array-backed list with O(1) index access.

Advanced Usage

Custom Object Sorting

To sort custom objects in a LinkedList, implement the Comparable interface:

Working with References

All collections work with references, allowing you to modify objects after adding them:

API Reference

Common Methods (All Collections)

• add(&$element): bool - Add an element to the collection
• size(): int - Get the number of elements
• toArray(): array - Convert collection to array
• count(): int - Get element count (implements Countable)

LinkedList Specific Methods

• get($index): mixed - Get element at index
• getFirst(): mixed - Get first element
• getLast(): mixed - Get last element
• remove($index): mixed - Remove element at index
• removeFirst(): mixed - Remove first element
• removeLast(): mixed - Remove last element (O(1))
• removeElement(&$element): mixed - Remove specific element
• insert(&$element, $position): bool - Insert at position
• indexOf($element): int - Find element index
• contains(&$element): bool - Check if element exists
• countElement(&$element): int - Count occurrences
• replace(&$old, &$new): bool - Replace element
• insertionSort($ascending = true): bool - Sort elements
• clear(): void - Remove all elements
• max(): int - Get maximum capacity (-1 for unlimited)

Stack Specific Methods

• push($element): bool - Add element to top
• pop(): mixed - Remove and return top element (O(1))
• peek(): mixed - View top element without removing
• max(): int - Get maximum capacity (-1 for unlimited)

Queue Specific Methods

• enqueue($element): bool - Add element to rear
• dequeue(): mixed - Remove and return front element
• peek(): mixed - View front element without removing
• max(): int - Get maximum capacity (-1 for unlimited)

Vector Specific Methods

• get(int $index): mixed - Get element at index (O(1))
• set(int $index, mixed $element): void - Set element at index
• insert(mixed $element, int $index): void - Insert at position
• removeAt(int $index): mixed - Remove element at index
• remove(mixed $element): mixed - Remove first occurrence
• indexOf(mixed $element): int - Find element index (-1 if not found)
• replace(mixed $old, mixed $new): bool - Replace first occurrence
• clear(): void - Remove all elements
• jsonSerialize(): array - JSON serialization support
• Implements ArrayAccess: $vector[0], $vector[] = x, isset($vector[0]), unset($vector[0])

Node Methods

The Node class supports both singly and doubly linked usage:

• data(): mixed - Get the stored data
• next(): ?Node - Get the next node
• prev(): ?Node - Get the previous node
• setData(mixed &$data): void - Set the stored data
• setNext(?Node &$next): void - Set the next node
• setPrev(?Node &$prev): void - Set the previous node

All collections use doubly-linked nodes internally, enabling O(1) removeLast() on LinkedList and O(1) pop() on Stack.

Testing

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

This library is licensed under the MIT License. See the LICENSE file for more details.

Support

If you encounter any issues, please open an issue on GitHub.

Changelog

See CHANGELOG.md for a list of changes.