Slug definitions

Override slugOptions() to declare one or more slug columns. Each SlugDefinition is a fluent builder; any option you leave unset falls back to the config defaults:

use RoundlyConsulting\Sluggable\Definitions\SlugDefinition;
use RoundlyConsulting\Sluggable\Definitions\SlugOptions;
use RoundlyConsulting\Sluggable\Enums\UpdatePolicy;

public function slugOptions(): SlugOptions
{
    return SlugOptions::make(
        SlugDefinition::for('slug')
            ->from('name')
            ->uniqueWithin('clinic_id')
            ->onUpdate(UpdatePolicy::WhenSourceChanges)
            ->keepHistory()
            ->routeKey(),
        SlugDefinition::for('handle')
            ->from(['brand.name', 'name'])       // relation dot path + attribute
            ->separator('_')
            ->maxLength(40)
            ->immutable(),
        SlugDefinition::for('code')
            ->from(fn (Product $product, ?string $locale): string => $product->sku)
            ->lowercase(false)
            ->notUnique(),
    );
}

Definitions run in declaration order, so a later column may use an earlier slug as its source. At most one definition may be the routeKey(); duplicate columns or several route keys throw InvalidSlugDefinitionException.

Sources

from() accepts an attribute name, a list of attributes, dot paths through relations (loaded with loadMissing(), so preventLazyLoading() stays happy) or a closure fn (Model $m, ?string $locale): ?string. Scalar attributes are read through getAttribute(), so accessors and casts apply and enums use their value. A missing relation contributes nothing.

Every option

Closure setters are generic, so typed closures such as ->lockWhen(fn (Post $post): bool => $post->is_published) pass Larastan level 7 in your code.

The attribute form

For the closure-free subset, declare the columns as repeatable #[Slug] class attributes:

use RoundlyConsulting\Sluggable\Attributes\Slug;

#[Slug('slug', from: 'name', uniqueWithin: ['kind_id'], routeKey: true)]
#[Slug('short', from: ['kind.name', 'name'], maxLength: 40, onUpdate: UpdatePolicy::Never)]
final class Breed extends Model implements Sluggable
{
    use HasSlug;
}

The attribute accepts column, from, separator, maxLength, maxWords, language, unicode, lowercase, uniqueness, uniqueWithin, includeTrashed, localeUniqueness, onUpdate, manual, emptySource, suffix, suffixStart, randomLength, storage, locales, fallback, routeKey, bindByKeyFallback, keepHistory, redirectFromHistory and reserved. SuffixStrategy::Custom cannot be expressed as an attribute.

Precedence

• An overridden slugOptions() on the model — always wins.
• #[Slug] class attributes — inherited from a parent class when the child declares none.
• SlugOptions::defaults() — one definition: defaults.column generated from defaults.source.

Declaring attributes and overriding slugOptions() at the same time throws conflictingSources in the local and testing environments.