[WIP] BETA VERSION IN PROGRESS

php-redis-om

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.

Features

• Doctrine-like methods and architecture
• Easy integration with existing PHP applications
• High performance and scalability with Redis

Requirements

• PHP 8.0 or higher
• Redis 4.0 or higher
• php-redis extension
• Redis JSON and Redisearch modules (optional)
• Composer

Installation

Install the library via Composer:

composer require talleu/php-redis-om

Basic Usage

Add the RedisOm attribute to your class to map it to a Redis schema:

<?php 

use Talleu\RedisOm\Om\Mapping as RedisOm;
use Talleu\RedisOm\Om\RedisObjectManager;

#[RedisOm\Entity]
class User
{
    #[RedisOm\Id]
    #[RedisOm\Property]
    public int $id;
    
    #[RedisOm\Property]
    public string $name;
    
    #[RedisOm\Property]
    public \DateTime $createdAt;
}

After add the RedisOm attribute to your class, you have to run the following command to create the Redis schema for the given source directory:

vendor/bin/redisMigration src

Then you can use the ObjectManager to persist your objects from Redis:

$user = new User()
$user->id = 1;
$user->name = 'John Doe';

// Persist the object in redis
$objectManager = new ObjectManager();
$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);

Docker

The package provide a docker-compose configuration to run a Redis server with the required modules (RedisJSON and Redisearch) for testing purposes.

docker compose up -d

Running tests

docker compose exec php vendor/bin/phpunit tests