How do I set up a count cache with Eloquence in Laravel?

Add the HasCounts trait to your child model and use the #[CountedBy] attribute on the BelongsTo relationship method. For example, on a Post model with an author relationship, this automatically updates a post_count field on the Author model. Ensure you wrap saves in transactions to maintain cache consistency.

Eloquence vs spatie/laravel-sluggable for generating slugs?

Eloquence includes sluggable behavior as part of a broader ORM enhancement package, ideal if you also need camel-casing or caching. Spatie/laravel-sluggable is a dedicated slug package with more advanced features like custom slug engines; choose based on whether you want an all-in-one solution or specialized functionality.

Does Eloquence work with Laravel 10?

Yes, Eloquence v10.0.0 and above support Laravel 10, as noted in the changelog. For newer Laravel versions, check compatibility—v11.0.0 supports Laravel 11, and v12.0.0 supports Laravel 12. Always verify via the package's composer.json or README.

What happens if a transaction fails with Eloquence caches?

If a transaction fails, the cache updates are rolled back along with the model changes, preventing data inconsistency. This is why Eloquence strongly recommends using transactions; without them, partial failures can leave caches out of sync and difficult to debug.

Can I disable camel casing for specific models in Eloquence?

Yes, simply omit the HasCamelCasing trait from models where you don't want automatic camel-casing. Eloquence is trait-based, so you have fine-grained control over which models use this feature, allowing for mixed coding styles if needed.

How to upgrade Eloquence from v10 to v11?

Upgrading requires refactoring: rename traits (e.g., Camelcasing to HasCamelCasing), migrate cache configurations from array methods to PHP attributes like #[CountedBy], and ensure PHP 8.1+. The README provides a migration guide, but test thoroughly due to breaking changes.

Eloquence — Laravel Eloquent Extension Package

What is Eloquence?

Eloquence is a Laravel package that extends the Eloquent ORM with additional database utilities and behaviors. It solves common development needs like automatic camel-casing of attributes, caching aggregated values (counts and sums), generating slugs, and protecting models as readonly. It integrates seamlessly as a drop-in library without altering core Laravel functionality.

Target Audience

Laravel developers building applications that require enhanced Eloquent model capabilities, such as consistent coding styles, performance optimizations via caching, or data integrity through readonly models.

Value Proposition

Developers choose Eloquence for its focused, non-intrusive enhancements to Eloquent, offering features like count/sum caching for performance, camel-casing for API consistency, and behaviors that respect domain-specific relationships—all without modifying Laravel's core.

A drop-in library for certain database functionality in Laravel, that allows for extra features that may never make it into the main project.

Use Cases

Best For

Ensuring camelCase attribute access in JSON APIs while keeping database columns snake_case
Caching aggregated values like post counts per author to optimize database queries
Generating SEO-friendly slugs from model attributes automatically
Protecting critical data with readonly models to prevent accidental writes
Maintaining coding style consistency across Laravel applications
Handling model relationships with fine-grained cache configurations

Not Ideal For

Projects with real-time data requirements where even slight cache update delays are unacceptable
Teams migrating from Eloquence v10 or earlier due to breaking changes and required code refactoring
Applications that manage database transactions externally or at a higher architectural level, making ORM-level transaction wrapping impractical
Projects using PHP versions below 8.1, as Eloquence v11+ relies on PHP 8.1 attributes for configuration

Pros & Cons

Pros

Consistent API Formatting

Automatically transforms snake_case database columns to camelCase for attribute access and JSON responses, ensuring a unified coding style without altering schema migrations, as highlighted in the CamelCased traits section.

Performance Optimization via Caching

Provides count and sum caching to reduce database queries for aggregated values, such as caching post counts per author, which improves efficiency for ordering and filtering operations.

Data Integrity with Readonly Models

Allows models to be marked as readonly using the HasReadOnly trait, preventing accidental writes and ensuring data protection across domain boundaries without additional configuration.

Modern PHP 8.1 Integration

Leverages PHP 8.1 attributes for behavior configuration, offering a clean, declarative way to set up caches and other features directly on relationship methods, as seen in the CountedBy and SummedBy examples.

Cons

Breaking Changes in Major Updates

Version 11 is a complete rebuild with non-backwards-compatible changes, requiring significant code updates for upgrades, such as renaming traits and migrating cache configurations to attributes.

Transaction Dependency for Caches

The cache system strongly recommends wrapping model saves in database transactions to prevent inconsistency, adding complexity and potential points of failure if transactions are not properly managed, as warned in the cache recommendations.

Limited to PHP 8.1+ and Laravel

Requires PHP 8.1 or higher for attribute support and is tightly coupled with Laravel's Eloquent ORM, excluding projects with older PHP versions or alternative database abstractions.

Frequently Asked Questions

What is Eloquence?

Target Audience

Value Proposition

Use Cases

Best For

Ensuring camelCase attribute access in JSON APIs while keeping database columns snake_case
Caching aggregated values like post counts per author to optimize database queries
Generating SEO-friendly slugs from model attributes automatically
Protecting critical data with readonly models to prevent accidental writes
Maintaining coding style consistency across Laravel applications
Handling model relationships with fine-grained cache configurations

Not Ideal For

Projects with real-time data requirements where even slight cache update delays are unacceptable
Teams migrating from Eloquence v10 or earlier due to breaking changes and required code refactoring
Applications that manage database transactions externally or at a higher architectural level, making ORM-level transaction wrapping impractical
Projects using PHP versions below 8.1, as Eloquence v11+ relies on PHP 8.1 attributes for configuration

Pros & Cons

Pros

Consistent API Formatting

Performance Optimization via Caching

Provides count and sum caching to reduce database queries for aggregated values, such as caching post counts per author, which improves efficiency for ordering and filtering operations.

Data Integrity with Readonly Models

Allows models to be marked as readonly using the HasReadOnly trait, preventing accidental writes and ensuring data protection across domain boundaries without additional configuration.

Modern PHP 8.1 Integration

Cons

Breaking Changes in Major Updates

Version 11 is a complete rebuild with non-backwards-compatible changes, requiring significant code updates for upgrades, such as renaming traits and migrating cache configurations to attributes.

Transaction Dependency for Caches

Limited to PHP 8.1+ and Laravel

Requires PHP 8.1 or higher for attribute support and is tightly coupled with Laravel's Eloquent ORM, excluding projects with older PHP versions or alternative database abstractions.

Frequently Asked Questions

Eloquence

What is Eloquence?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Eloquence

What is Eloquence?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?