cviebrock/eloquent-sluggable
Eloquent Sluggable
This project is a slug generation and management tool for the Laravel Eloquent ORM. It provides a reusable trait that adds the ability to create unique, URL-friendly strings from model attributes, allowing database records to be retrieved using human-readable slugs instead of primary keys.
The system supports multilingual URL management by maintaining separate localized slugs for a single model instance. It ensures uniqueness through an automatic collision-avoidance mechanism that appends numeric suffixes to duplicate strings and prevents the use of reserved words that might overlap with system routing paths.
The toolkit includes capabilities for custom slug generation via engine overrides and formatting rules, as well as an event-driven pipeline to intercept or cancel the slugging process. Database resolution is handled through dedicated query scopes and helper methods for retrieving models based on their slug values.
Features
- Slug Generators - Creates human-readable, URL-safe slugs from model attributes for search engine optimization.
- Query Scopes - Wraps database queries in dedicated scopes to retrieve model instances based on slug values.
- Slug-Based Record Retrieval - Implements a dedicated query scope to limit database results to records matching a specific slug value.
- Slug History Trackers - Provides simplified helper methods to retrieve model instances from the database using their slug values.
- Slug Generation Extensions - Provides a specialized tool for creating unique, URL-friendly strings within the Laravel Eloquent ORM.
- Model Trait Extensions - Provides a reusable trait that extends Eloquent models with slugging capabilities and query scopes.
- Trait-Based Capability Injection - Uses a reusable PHP trait to inject slugging logic and persistence methods into Eloquent models.
- Slug-Based Model Resolution - Retrieves database records using unique text identifiers instead of primary keys to improve SEO and user experience.
- Multilingual Slugs - Generates and maintains unique slugs across different languages to support localized web addresses.
- Model - Maps specific model fields to slugging engines to transform human-readable text into URL-friendly strings.
- Unique Identifier Generators - Prevents URL collisions by automatically managing unique identifiers for slugs in the database.
- Unique String Suffixing - Implements an automatic collision-avoidance mechanism that appends numeric suffixes to duplicate slugs.
- Custom Slug Configurations - Allows implementing custom formatting rules and reserved word lists to control URL generation.
- Behavioral Overrides - Allows overriding default slugging behaviors through custom methods to implement complex uniqueness checks.
- Engine Overrides - Implements hooks and configuration settings to modify the slugging engine and character mappings for custom formatting.
- Multi-Slug Persistence - Generates and maintains several distinct slugs for a single model instance to support diverse URL requirements.
- Reserved Word Filters - Blocks the generation of slugs that match a predefined list of reserved words to avoid routing conflicts.
- Reserved Word Slug Blockers - Blocks the generation of slugs that match a predefined list of reserved names to avoid route collisions.
- Numeric Suffix Fallbacks - Prevents duplicate slugs by appending numeric suffixes to colliding strings using configurable indices.
- General Utilities - Generates URL slugs for database models.
- Application Helpers - Generates slugs for Eloquent models.
