PHP Класс Cocur\Slugify\Slugify

Автор: Florian Eckerstorfer ([email protected])
Автор: Ivo Bathke ([email protected])
Автор: Marchenko Alexandr
Наследование: implements Cocur\Slugify\SlugifyInterface
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$options mixed>\array
$provider Cocur\Slugify\RuleProvider\RuleProviderInterface
$rules string>\array

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

Метод Описание
__construct ( array $options = [], Cocur\Slugify\RuleProvider\RuleProviderInterface $provider = null )
activateRuleSet ( string $ruleSet ) : Slugify
addRule ( string $character, string $replacement ) : Slugify Adds a custom rule to Slugify.
addRules ( array $rules ) : Slugify Adds multiple rules to Slugify.
create ( array $options = [] ) : Slugify Static method to create new instance of {@see Slugify}.
slugify ( string $string, string | array | null $options = null ) : string Returns the slug-version of the string.

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

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

public __construct ( array $options = [], Cocur\Slugify\RuleProvider\RuleProviderInterface $provider = null )
$options array
$provider Cocur\Slugify\RuleProvider\RuleProviderInterface

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

public activateRuleSet ( string $ruleSet ) : Slugify
$ruleSet string
Результат Slugify

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

Adds a custom rule to Slugify.
public addRule ( string $character, string $replacement ) : Slugify
$character string Character
$replacement string Replacement character
Результат Slugify

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

Adds multiple rules to Slugify.
public addRules ( array $rules ) : Slugify
$rules array
Результат Slugify

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

Static method to create new instance of {@see Slugify}.
public static create ( array $options = [] ) : Slugify
$options array
Результат Slugify

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

Returns the slug-version of the string.
public slugify ( string $string, string | array | null $options = null ) : string
$string string String to slugify
$options string | array | null Options
Результат string Slugified version of the string

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

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

protected array $options
Результат mixed>\array

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

protected RuleProviderInterface,Cocur\Slugify\RuleProvider $provider
Результат Cocur\Slugify\RuleProvider\RuleProviderInterface

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

protected array $rules
Результат string>\array