PHP Trait Spatie\Sluggable\HasSlug

Protected Properties

Property	Type	Description
$slugOptions	SlugOptions

Method	Description
generateSlug ( )	Handle setting slug on explicit request.
getSlugOptions ( ) : SlugOptions	Get the options for generating the slug.

Method	Description
addSlug ( )	Add the slug to the model.
bootHasSlug ( )	Boot the trait.
generateNonUniqueSlug ( ) : string	Generate a non unique slug for this record.
generateSlugOnCreate ( )	Handle adding slug on model creation.
generateSlugOnUpdate ( )	Handle adding slug on model update.
getSlugSourceString ( ) : string	Get the string that should be used as base for the slug.
guardAgainstInvalidSlugOptions ( )	This function will throw an exception when any of the options is missing or invalid.
hasCustomSlugBeenUsed ( ) : boolean	Determine if a custom slug has been saved.
makeSlugUnique ( string $slug ) : string	Make the given slug unique.
otherRecordExistsWithSlug ( string $slug ) : boolean	Determine if a record exists with the given slug.

Add the slug to the model.

protected addSlug ( )

Boot the trait.

protected static bootHasSlug ( )

Generate a non unique slug for this record.

protected generateNonUniqueSlug ( ) : string
return	string

Handle setting slug on explicit request.

public generateSlug ( )

Handle adding slug on model creation.

protected generateSlugOnCreate ( )

Handle adding slug on model update.

protected generateSlugOnUpdate ( )

Get the options for generating the slug.

abstract public getSlugOptions ( ) : SlugOptions
return	SlugOptions

Get the string that should be used as base for the slug.

protected getSlugSourceString ( ) : string
return	string

This function will throw an exception when any of the options is missing or invalid.

protected guardAgainstInvalidSlugOptions ( )

Determine if a custom slug has been saved.

protected hasCustomSlugBeenUsed ( ) : boolean
return	boolean

Make the given slug unique.

protected makeSlugUnique ( string $slug ) : string
$slug	string
return	string

Determine if a record exists with the given slug.

protected otherRecordExistsWithSlug ( string $slug ) : boolean
$slug	string
return	boolean

protected SlugOptions,Spatie\Sluggable $slugOptions
return	SlugOptions