百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
P

php-redis-om

> 编程语言
开源

一个用于 Redis 的 PHP 对象映射器

200 stars0 点赞1 次浏览
访问官网GitHub

工具介绍

一个用于 Redis 的 PHP 对象映射器

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
  • Symfony bundle integration
  • Easy integration with existing PHP applications
  • High performance and scalability with Redis®
  • Support for Redis JSON module
  • Automatic schema generation
  • Search and query capabilities with range filters
  • Auto-expiration of your objects
  • PHP enum support (backed enums)
  • Identity map and dirty tracking with partial updates
  • Atomic transactions (MULTI/EXEC)
  • Unique constraints (single-field and composite)
  • Pagination with total count
  • Memory-efficient streaming of large collections
  • Bulk delete and update without loading objects into memory
  • GEO queries (radius search)
  • Pipeline batch reads
  • API Platform support (beta)

Requirements ⚙️

  • PHP 8.2 or higher
  • Redis 4.0 or higher
  • Redisearch module (available by default with Redis >8 or in redis-stack distribution) (installation)
  • php-redis extension OR Predis library
  • Redis JSON module (optional, include in redis-stack)
  • Composer

Supported types ✅

  • scalar (string, int, float, bool, double)
  • PHP backed enums (string and int)
  • timestamp
  • json
  • null
  • DateTimeImmutable
  • DateTime
  • array and nested arrays
  • object and nested objects
  • stdClass

Installation

Install the library via Composer:

bash
composer require talleu/php-redis-om

Depending on your configuration, use phpredis or Predis

Symfony bundle

In a Symfony application, you may need to add this line to config/bundles.php

bash
    Talleu\RedisOm\Bundle\TalleuRedisOmBundle::class => ['all' => true],

And that's it, your installation is complete !

API Platform support ️

For API Platform users, a basic implementation is provided here: API Platfom X Redis

Basic Usage

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

php

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

For Symfony users, just inject the RedisObjectManagerInterface in the constructor:

php
name = 'Martin Eden';
        $this->redisObjectManager->persist($book);
        $this->redisObjectManager->flush();

       //..
    }
}

For others PHP applications:

php
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 repository provided by the Object Manager (or the object manager directly):

php
// Retrieve the object from redis 
$user = $this->redisObjectManager->find(User::class, 1);
$user = $this->redisObjectManager->getRepository(User::class)->find(1);
$user = $this->redisObjectManager->getRepository(User::class)->findOneBy(['name' => 'John Doe']);

// Retrieve a collection of objects
$users = $this->redisObjectManager->getRepository(User::class)->findAll();
$users = $this->redisObjectManager->getRepository(User::class)->findBy(['name' => 'John Doe'], ['createdAt' => 'DESC'], 10);

Enum Support ️

PHP backed enums are natively supported:

php
enum Status: string
{
    case ACTIVE = 'active';
    case INACTIVE = 'inactive';
}

#[RedisOm\Entity]
class Task
{
    #[RedisOm\Id]
    #[RedisOm\Property]
    public int $id;

    #[RedisOm\Property(index: true)]
    public Status $status;
}

Search by enum value:

php
$activeTasks = $repository->findBy(['status' => 'active']);

Range Queries

Use MongoDB-style operators for numeric range searches:

php
// Age between 18 and 65
$users = $repository->findBy(['age' => ['$gte' => 18, '$lte' => 65]]);

// Price greater than 100
$products = $repository->findBy(['price' => ['$gt' => 100]]);

// Score less than 50
$results = $repository->findBy(['score' => ['$lt' => 50]]);

// Combine with exact match
$results = $repository->findBy(['name' => 'John', 'age' => ['$gte' => 18]]);

Supported operators: $gte (>=), $gt (>), $lte ( Note: Range queries work automatically with HASH format (NUMERIC index is auto-generated for int/float).

For JSON format, you must explicitly declare a NUMERIC index: #[Property(index: ['age' => 'NUMERIC'])].

Pagination

php
$paginator = $repository->paginate(
    criteria: ['status' => 'active'],
    page: 2,
    itemsPerPage: 20,
    orderBy: ['createdAt' => 'DESC']
);

$paginator->getItems();        // Current page items
$paginator->getTotalItems();   // Total matching count
$paginator->getTotalPages();   // Total number of pages
$paginator->getCurrentPage();  // Current page number
$paginator->hasNextPage();     // bool
$paginator->hasPreviousPage(); // bool

// Iterable
foreach ($paginator as $item) {
    // ...
}

Partial Updates (Merge) ⚡

Instead of re-persisting the entire object, use merge() to only update changed fields:

php
$user = $objectManager->find(User::class, 1);
$user->name = 'New Name'; // Only this field changed

$objectManager->merge($user);  // Detects change, updates only 'name'
$objectManager->flush();

For new objects (not loaded via find()), merge() falls back to a full persist().

Batch Reads (Pipeline)

Load multiple objects by ID in a single Redis pipeline call:

php
$users = $repository->findMultiple([1, 2, 3, 4, 5]);

GEO Queries

Search objects within a geographic radius (requires a GEO-indexed property):

php
#[RedisOm\Property(index: ['location' => 'GEO'])]
public string $location; // Format: "longitude,latitude"

$nearby = $repository->findByGeoRadius('location', 2.3522, 48.8566, 10, 'km');

Unique Constraints

Enforce uniqueness on one or more fields using #[Unique].

Single field:

php
#[RedisOm\Entity]
class User
{
    #[RedisOm\Id]
    #[RedisOm\Property]
    public int $id;

    #[RedisOm\Property(index: true)]
    #[RedisOm\Unique]
    public string $email;
}

Composite (combination of fields must be unique):

php
#[RedisOm\Entity]
#[RedisOm\Unique(properties: ['username', 'tenantId'])]
class User
{
    #[RedisOm\Id]
    #[RedisOm\Property]
    public int $id;

    #[RedisOm\Property]
    public string $username;

    #[RedisOm\Property]
    public int $tenantId;
}

flush() throws UniqueConstraintViolationException on conflict. Violations within the same flush() call are detected before hitting Redis. Concurrent writes are protected via Redis WATCH/MULTI/EXEC.

php
use Talleu\RedisOm\Exception\UniqueConstraintViolationException;

try {
    $objectManager->persist($user);
    $objectManager->flush();
} catch (UniqueConstraintViolationException $e) {
    // $e->getMessage() describes the conflicting field(s) and value(s)
}

Bulk Operations ⚡

Delete or update large numbers of objects without loading them into PHP memory.

php
$repository = $objectManager->getRepository(User::class);

// Delete all inactive users — unique-constraint keys are cleaned up automatically
$deleted = $repository->bulkDelete(['status' => 'inactive']);

// Update a scalar field on many objects at once
$updated = $repository->bulkUpdate(['country' => 'FR'], ['currency' => 'EUR']);

bulkUpdate() throws BulkOperationException when $changes targets a #[Unique] field. Use stream() + merge() + flush() instead for those cases.

Streaming Large Collections

findAll() loads everything into memory. stream() fetches objects in batches and yields them one by one, keeping memory bounded regardless of collection size.

php
// Via repository — full control
foreach ($repository->stream(['status' => 'active'], batchSize: 500) as $user) {
    // process $user — break works normally
}

// Via object manager — identity map is cleared automatically between batches
foreach ($objectManager->stream(User::class, ['status' => 'active']) as $user) {
    // process $user
}

Advanced documentation

  • Installation
  • Configuration
  • Docker integration
  • Mapping
  • Advanced usage
  • Events
  • API Platform

Issues· 11 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

PHP

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月18日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言