solophp / storage

v1.2.0 2025-08-03 10:19 UTC

Requires

• php: >=8.1

Requires (Dev)

• phpunit/phpunit: ^9.0
• squizlabs/php_codesniffer: ^3.0

MIT

• Vitaliy Olos

• php
• storage
• file storage
• key-value
• data storage
• simple storage

Published on Packagist.org on 2025-08-03 10:20 UTC

README

Warning

Abandoned. This package is no longer maintained and gets no fixes. It has no successor and stays on Packagist for the projects that use it. The current Solo packages are listed at solophp.github.io.

A lightweight, file-based storage system for PHP applications that provides simple key-value pair storage functionality.

Features

• Simple key-value storage interface
• File-based persistence
• Thread-safe file operations
• Directory traversal protection
• Minimal dependencies
• Type-safe implementation (strict types)

Requirements

• PHP 8.1 or higher

Installation

composer require solophp/storage

Usage

Basic Setup

use Solo\Storage;

// Initialize with default storage location (current directory)
$storage = new Storage();

// Or specify a custom storage directory
$storage = new Storage('/path/to/storage/directory');

Store Data

// Store a string value
$storage->set('user.name', 'John Doe');
$storage->set('user.email', '[e-mail]');

Retrieve Data

// Get a stored value
$name = $storage->get('user.name'); // Returns 'John Doe'

// Handle non-existent keys
$value = $storage->get('non.existent.key'); // Returns null

Check Data Existence

// Check if a key exists
if ($storage->has('user.name')) {
    // Key exists
}

Delete Data

// Delete a stored value
$storage->delete('user.name');

Error Handling

All methods are designed to fail gracefully:

• set() returns bool indicating success/failure
• get() returns null if key doesn't exist or on error
• has() returns bool indicating key existence
• delete() returns bool indicating success/failure

Security

The storage system includes protection against directory traversal attacks by sanitizing storage keys.

Thread Safety

File operations use exclusive locks (LOCK_EX) to ensure thread safety when writing data.

License

MIT