Download the PHP package julienlinard/php-cache without Composer

PHP Cache

🇬🇧 Read in English

💝 Support the project

If this package is useful to you, consider becoming a sponsor to support the development and maintenance of this open source project.

A modern and secure caching system for PHP 8+ with support for multiple drivers (File, Redis, Memcached, Array), tags, TTL, and invalidation.

🚀 Installation

Requirements: PHP 8.0 or higher

⚡ Quick Start

Basic Configuration

📋 Features

• ✅ Multiple Drivers: Array, File, Redis
• ✅ TTL (Time To Live): Automatic entry expiration
• ✅ Tags: Tag system for grouped invalidation
• ✅ Security: Key validation, protection against injections
• ✅ Secure Serialization: JSON usage with validation
• ✅ Multiple Operations: getMultiple, setMultiple, deleteMultiple
• ✅ Increment/Decrement: Support for numeric values
• ✅ Fluid Interface: Simple and intuitive API

📖 Documentation

Available Drivers

Array Driver (Memory)

The Array driver stores data in memory. Useful for testing and development.

File Driver (Disk)

The File driver stores data in files on the filesystem.

Redis Driver

The Redis driver requires the PHP Redis extension.

Basic Operations

Store a Value

Retrieve a Value

Check Existence

Delete a Value

Clear All Cache

Multiple Operations

Retrieve Multiple Values

Store Multiple Values

Delete Multiple Keys

Increment and Decrement

Pull (Retrieve and Delete)

Using a Specific Driver

Tag System

Tags allow grouping cache entries and invalidating them together.

Advanced Usage with CacheManager

Key Validation

The system automatically validates keys for security:

• ✅ Allowed characters: letters, numbers, _, -, .
• ✅ Maximum length: 250 characters
• ✅ Protection against path injections (.., /, \)

Error Handling

🔒 Security

Implemented Security Measures

1. Key Validation: Protection against path injections
2. Secure Serialization: JSON usage with strict validation
3. File Permissions: Permission control for File driver
4. Atomic Writing: File driver uses temporary files to prevent corruption
5. Input Validation: All entries are validated before storage

Best Practices

🧪 Tests

📝 Usage Examples

Database Query Caching

Cache with Tag Invalidation

View/Template Caching

Counter with Expiration

🤝 Integration with Other Packages

With doctrine-php

📚 API Reference

Cache (Facade)

• Cache::init(array $config) : Initialize the manager
• Cache::get(string $key, mixed $default = null, ?string $driver = null) : Retrieve a value
• Cache::set(string $key, mixed $value, ?int $ttl = null, ?string $driver = null) : Store a value
• Cache::has(string $key, ?string $driver = null) : Check existence
• Cache::delete(string $key, ?string $driver = null) : Delete a value
• Cache::clear(?string $driver = null) : Clear cache
• Cache::increment(string $key, int $value = 1, ?string $driver = null) : Increment
• Cache::decrement(string $key, int $value = 1, ?string $driver = null) : Decrement
• Cache::pull(string $key, mixed $default = null, ?string $driver = null) : Retrieve and delete
• Cache::tags(string|array $tags, ?string $driver = null) : Create tagged cache
• Cache::driver(?string $driver = null) : Get a driver

CacheInterface

All drivers implement CacheInterface with the following methods:

• get(string $key, mixed $default = null): mixed
• set(string $key, mixed $value, ?int $ttl = null): bool
• delete(string $key): bool
• has(string $key): bool
• clear(): bool
• getMultiple(array $keys, mixed $default = null): array
• setMultiple(array $values, ?int $ttl = null): bool
• deleteMultiple(array $keys): int
• increment(string $key, int $value = 1): int|false
• decrement(string $key, int $value = 1): int|false
• pull(string $key, mixed $default = null): mixed

🐛 Troubleshooting

File Driver Not Working

Check that the cache directory exists and is writable:

Redis Driver Not Connecting

1. Check that Redis extension is installed: php -m | grep redis
2. Check that Redis is running: redis-cli ping
3. Check connection parameters in configuration

"Invalid Key" Error

Keys must follow this format:

• Allowed characters: a-z, A-Z, 0-9, _, -, .
• Maximum length: 250 characters
• No relative paths (.., /, \)

📝 License

MIT License - See the LICENSE file for more details.

🤝 Contributing

Contributions are welcome! Feel free to open an issue or a pull request.

📧 Support

For any questions or issues, please open an issue on GitHub.

💝 Support the project

If this package is useful to you, consider becoming a sponsor to support the development and maintenance of this open source project.

Developed with ❤️ by Julien Linard