README

A lightweight PHP library for managing data collections with a persistent storage system using SQLite.

Features

Lightweight Collection: Implements Countable, ArrayAccess, and IteratorAggregate interfaces
SQLite Storage: Data persistence in memory or on disk
Two Operating Modes:
- MODE_NORMAL: Uses auto-incremented keys (0, 1, 2...)
- MODE_ASSOCIATIVE: Uses a custom primary key
Simple Interface: Manipulate data like a standard PHP array

Installation

composer require korriganmaster/lite-collection

Usage

Basic Example

use Korriganmaster\LiteCollection\LiteCollection;
use Korriganmaster\LiteCollection\Storage\SqliteStorage;

// Create in-memory storage
$storage = new SqliteStorage();
$collection = new LiteCollection($storage);

// Add items
$collection[] = ['id' => 1, 'name' => 'Item 1'];
$collection[] = ['id' => 2, 'name' => 'Item 2'];

// Access items
echo $collection[0]['name']; // "Item 1"

// Count items
echo count($collection); // 2

// Iterate over the collection
foreach ($collection as $item) {
    echo $item['name'];
}

Associative Mode with Custom Key

use Korriganmaster\LiteCollection\Storage\SqliteStorage;
use Korriganmaster\LiteCollection\Storage\StorageInterface;

// Create storage with a custom primary key
$storage = new SqliteStorage(
    StorageInterface::MODE_ASSOCIATIVE, 
    'custom_id'
);

$storage->insert(['custom_id' => 100, 'name' => 'Item 100']);

// Access by custom key
$item = $storage->findById(100);

Persistent Disk Storage

// Create disk storage
$storage = new SqliteStorage(
    StorageInterface::MODE_NORMAL,
    'id',
    'path/to/database.sqlite'
);

API

LiteCollection

The LiteCollection class provides a collection interface:

count(): int: Returns the number of items
offsetGet($offset): mixed: Retrieves an item by its index
offsetSet($offset, $value): void: Sets or updates an item
offsetUnset($offset): void: Removes an item
offsetExists($offset): bool: Checks if an item exists
getIterator(): Traversable: Returns an iterator to traverse the collection

SqliteStorage

The SqliteStorage class implements StorageInterface:

insert(mixed $item): void: Inserts a new item
findById(int $id): mixed: Finds an item by its ID
exists(int $id): bool: Checks if an item exists
update(int $id, mixed $item): void: Updates an existing item
delete(int $id): void: Deletes an item
count(): int: Returns the number of items
Implements Iterator to traverse items

StorageInterface

The StorageInterface interface defines the contract for storage systems:

Storage Modes:

StorageInterface::MODE_NORMAL: Normal mode with auto-incremented keys
StorageInterface::MODE_ASSOCIATIVE: Associative mode with custom primary key

Testing

The project includes unit tests using PHPUnit:

composer test

Tests cover:

LiteCollectionTest: Collection tests
SqliteStorageTest: SQLite storage tests

Development

Requirements

PHP 8.0 or higher
SQLite3 extension
Composer

Development Tools

# Run tests
vendor/bin/phpunit

# Static analysis
vendor/bin/phpstan analyse

# Code style fixing
vendor/bin/php-cs-fixer fix

Architecture

The project follows a simple architecture:

LiteCollection: Main collection class
AbstractStorage: Abstract class for storage systems
SqliteStorage: SQLite storage implementation
StorageInterface: Interface defining the storage contract

License

This project is licensed under the MIT License.

korriganmaster / lite-collection

Maintainers

Package info

Statistics

Security