A PHP object mapper for Redis.
An Object Mapper for Redis, designed to providing an intuitive and familiar interface for PHP developers to interact with Redis.
- Doctrine-like methods and architecture
- Easy integration with existing PHP applications
- High performance and scalability with Redis
- Support for Redis JSON module
- Automatic schema generation
- Search and query capabilities
- PHP 8.2 or higher
- Redis 4.0 or higher
- Redisearch module (installation)
- php-redis extension (or your favorite Redis client)
- Redis JSON module (optional)
- Composer
- scalar (string, int, float, bool)
- DateTimeImmutable
- DateTime
- array and nested arrays
- object and nested objects
- stdClass
Install the library via Composer:
composer require talleu/php-redis-omAdd the RedisOm attribute to your class to map it to a Redis schema:
<?php
use Talleu\RedisOm\Om\Mapping as RedisOm;
#[RedisOm\Entity]
class User
{
#[RedisOm\Id]
#[RedisOm\Property]
public int $id;
#[RedisOm\Property]
public string $name;
#[RedisOm\Property]
public \DateTimeImmutable $createdAt;
}After add the RedisOm attribute to your class,
you have to run the following command to create the Redis schema for your classes (default path is ./src):
vendor/bin/redisMigration <YOUR DIRECTORY PATH>Then you can use the ObjectManager to persist your objects from Redis:
<?php
use Talleu\RedisOm\Om\RedisObjectManager;
$user = new User()
$user->id = 1;
$user->name = 'John Doe';
// Persist the object in redis
$objectManager = new RedisObjectManager();
$objectManager->persist($user);
$objectManager->flush();🥳 Congratulations, your PHP object is now registered in Redis !
You can now retrieve your user wherever you like using the ObjectManager:
// Retrieve the object from redis
$user = $objectManager->find(User::class, 1);
$user = $objectManager->getRepository(User::class)->find(1);
$user = $objectManager->getRepository(User::class)->findOneBy(['name' => 'John Doe']);
// Retrieve a collection of objects
$users = $objectManager->getRepository(User::class)->findAll();
$users = $objectManager->getRepository(User::class)->findBy(['name' => 'John Doe'], ['createdAt' => 'DESC'], 10);
