1. trait
  2. A17
  3. \
  4. Twill
  5. \
  6. Models
  7. \
  8. Behaviors
  9. \
  10. HasSlug

HasSlug

trait HasSlug (View source)

Methods

static 
bootHasSlug()

No description

HasMany
slugs()

Defines the one-to-many relationship for slug objects.

object
getSlugClass()

Returns an instance of the slug class for this model.

string|null
getSlugModelClass()

Returns the fully qualified slug class name for this model.

getSlugClassName()

No description

Builder
scopeForSlug(Builder $query, string $slug)

No description

Builder
scopeForInactiveSlug(Builder $query, string $slug)

No description

Builder
scopeForFallbackLocaleSlug(Builder $query, string $slug)

No description

void
setSlugs(bool $restoring = false)

No description

void
updateOrNewSlug(array $slugParams, bool $restoring = false)

No description

object|null
getExistingSlug(array $slugParams)

No description

addOneSlug($slugParams)

No description

void
disableLocaleSlugs(string $locale, int $except_slug_id = 0)

No description

object|null
getActiveSlug(string|null $locale = null)

Returns the active slug object for this model.

object|null
getFallbackActiveSlug()

Returns the fallback active slug object for this model.

string
getSlug(string|null $locale = null)

Returns the active slug string for this model.

string
getSlugAttribute()

No description

array|null
getSlugParams(string|null $locale = null)

No description

array|null
getSingleSlugParams(string|null $locale = null)

No description

string
getSlugsTable()

Returns the database table name for this model's slugs.

string
getForeignKey()

Returns the database foreign key column name for this model.

getSuffixSlug()

No description

string
getUtf8Slug(string $str, array $options = [])

Generate a URL friendly slug from a UTF-8 string.

string
urlSlugShorter(string $string)

Generate a URL friendly slug from a given string.

string
getNamespace()

Returns the fully qualified namespace for this model.

Details

at line 12
static protected bootHasSlug()

No description

at line 32
HasMany slugs()

Defines the one-to-many relationship for slug objects.

Return Value

HasMany

at line 42
object getSlugClass()

Returns an instance of the slug class for this model.

Return Value

object

at line 52
string|null getSlugModelClass()

Returns the fully qualified slug class name for this model.

Return Value

string|null

at line 72
protected getSlugClassName()

No description

at line 82
Builder scopeForSlug(Builder $query, string $slug)

No description

Parameters

Builder $query
string $slug

Return Value

Builder

at line 96
Builder scopeForInactiveSlug(Builder $query, string $slug)

No description

Parameters

Builder $query
string $slug

Return Value

Builder

at line 109
Builder scopeForFallbackLocaleSlug(Builder $query, string $slug)

No description

Parameters

Builder $query
string $slug

Return Value

Builder

at line 122
void setSlugs(bool $restoring = false)

No description

Parameters

bool $restoring

Return Value

void

at line 134
void updateOrNewSlug(array $slugParams, bool $restoring = false)

No description

Parameters

array $slugParams
bool $restoring

Return Value

void

at line 160
object|null getExistingSlug(array $slugParams)

No description

Parameters

array $slugParams

Return Value

object|null

at line 184
protected addOneSlug($slugParams)

No description

Parameters

$slugParams

at line 205
void disableLocaleSlugs(string $locale, int $except_slug_id = 0)

No description

Parameters

string $locale
int $except_slug_id

Return Value

void

at line 244
object|null getActiveSlug(string|null $locale = null)

Returns the active slug object for this model.

Parameters

string|null $locale

Locale of the slug if your site has multiple languages.

Return Value

object|null

at line 256
object|null getFallbackActiveSlug()

Returns the fallback active slug object for this model.

Return Value

object|null

at line 269
string getSlug(string|null $locale = null)

Returns the active slug string for this model.

Parameters

string|null $locale

Locale of the slug if your site has multiple languages.

Return Value

string

at line 285
string getSlugAttribute()

No description

Return Value

string

at line 294
array|null getSlugParams(string|null $locale = null)

No description

Parameters

string|null $locale

Return Value

array|null

at line 344
array|null getSingleSlugParams(string|null $locale = null)

No description

Parameters

string|null $locale

Return Value

array|null

at line 386
string getSlugsTable()

Returns the database table name for this model's slugs.

Return Value

string

at line 396
string getForeignKey()

Returns the database foreign key column name for this model.

Return Value

string

at line 401
protected getSuffixSlug()

No description

at line 413
string getUtf8Slug(string $str, array $options = [])

Generate a URL friendly slug from a UTF-8 string.

Parameters

string $str
array $options

Return Value

string

at line 533
string urlSlugShorter(string $string)

Generate a URL friendly slug from a given string.

Parameters

string $string

Return Value

string

at line 543
string getNamespace()

Returns the fully qualified namespace for this model.

Return Value

string