PHP Класс Cviebrock\EloquentSluggable\Services\SlugService

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$model Illuminate\Database\Eloquent\Model;

Открытые методы

Метод Описание
buildSlug ( string $attribute, array $config, boolean $force = null ) : null | string Build the slug for the given attribute of the current model.
createSlug ( Model | string $model, string $attribute, string $fromString, array $config = null ) : string Generate a unique slug for a given string.
getConfiguration ( array $overrides = [] ) : array Get the sluggable configuration for the current model, including default values where not specified.
setModel ( Model $model )
slug ( Model $model, boolean $force = false ) : boolean Slug the current model.

Защищенные методы

Метод Описание
generateSlug ( string $source, array $config, string $attribute ) : string Generate a slug from the given source string.
generateSuffix ( string $slug, string $separator, Collection $list ) : string Generate a unique suffix for the given slug (and list of existing, "similar" slugs.
getExistingSlugs ( string $slug, string $attribute, array $config ) : Collection Get all existing slugs that are similar to the given slug.
getSlugEngine ( string $attribute ) : Slugify Return a class that has a slugify() method, used to convert strings into slugs.
getSlugSource ( mixed $from ) : string Get the source string for the slug.
makeSlugUnique ( string $slug, array $config, string $attribute ) : string Checks if the slug should be unique, and makes it so if needed.
needsSlugging ( string $attribute, array $config ) : boolean Determines whether the model needs slugging.
usesSoftDeleting ( ) : boolean Does this model use softDeleting?
validateSlug ( string $slug, array $config, string $attribute ) : string Checks that the given slug is not a reserved word.

Описание методов

buildSlug() публичный Метод

Build the slug for the given attribute of the current model.
public buildSlug ( string $attribute, array $config, boolean $force = null ) : null | string
$attribute string
$config array
$force boolean
Результат null | string

createSlug() публичный статический Метод

Generate a unique slug for a given string.
public static createSlug ( Model | string $model, string $attribute, string $fromString, array $config = null ) : string
$model Illuminate\Database\Eloquent\Model | string
$attribute string
$fromString string
$config array
Результат string

generateSlug() защищенный Метод

Generate a slug from the given source string.
protected generateSlug ( string $source, array $config, string $attribute ) : string
$source string
$config array
$attribute string
Результат string

generateSuffix() защищенный Метод

Generate a unique suffix for the given slug (and list of existing, "similar" slugs.
protected generateSuffix ( string $slug, string $separator, Collection $list ) : string
$slug string
$separator string
$list Illuminate\Support\Collection
Результат string

getConfiguration() публичный Метод

Get the sluggable configuration for the current model, including default values where not specified.
public getConfiguration ( array $overrides = [] ) : array
$overrides array
Результат array

getExistingSlugs() защищенный Метод

Get all existing slugs that are similar to the given slug.
protected getExistingSlugs ( string $slug, string $attribute, array $config ) : Collection
$slug string
$attribute string
$config array
Результат Illuminate\Support\Collection

getSlugEngine() защищенный Метод

Return a class that has a slugify() method, used to convert strings into slugs.
protected getSlugEngine ( string $attribute ) : Slugify
$attribute string
Результат Cocur\Slugify\Slugify

getSlugSource() защищенный Метод

Get the source string for the slug.
protected getSlugSource ( mixed $from ) : string
$from mixed
Результат string

makeSlugUnique() защищенный Метод

Checks if the slug should be unique, and makes it so if needed.
protected makeSlugUnique ( string $slug, array $config, string $attribute ) : string
$slug string
$config array
$attribute string
Результат string

needsSlugging() защищенный Метод

Determines whether the model needs slugging.
protected needsSlugging ( string $attribute, array $config ) : boolean
$attribute string
$config array
Результат boolean

setModel() публичный Метод

public setModel ( Model $model )
$model Illuminate\Database\Eloquent\Model

slug() публичный Метод

Slug the current model.
public slug ( Model $model, boolean $force = false ) : boolean
$model Illuminate\Database\Eloquent\Model
$force boolean
Результат boolean

usesSoftDeleting() защищенный Метод

Does this model use softDeleting?
protected usesSoftDeleting ( ) : boolean
Результат boolean

validateSlug() защищенный Метод

Checks that the given slug is not a reserved word.
protected validateSlug ( string $slug, array $config, string $attribute ) : string
$slug string
$config array
$attribute string
Результат string

Описание свойств

$model защищенное свойство

protected Model;,Illuminate\Database\Eloquent $model
Результат Illuminate\Database\Eloquent\Model;