class URLSegmentFilter implements FilterInterface (View source)

Filter certain characters from "URL segments" (also called "slugs"), for nicer (more SEO-friendly) URLs.

Uses {@link Transliterator} to convert non-ASCII characters to meaningful ASCII representations. Use {@link $default_allow_multibyte} to allow a broader range of characters without transliteration.

Caution: Should not be used on full URIs with domains or query parameters. In order to retain forward slashes in a path, each individual segment needs to be filtered individually.

See {@link FileNameFilter} for similar implementation for filesystem-based URLs.

Traits

Provides extensions to this object to integrate it with standard config API methods.

A class that can be instantiated or replaced via DI

Properties

static private bool $default_use_transliterator
static private array $default_replacements
static private bool $default_allow_multibyte

Doesn't try to replace or transliterate non-ASCII filters.

array $replacements

Methods

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

string
filter(string $name)

Note: Depending on the applied replacement rules, this method might result in an empty string.

$this
setReplacements(string[] $replacements)

No description

string[]
getReplacements()

No description

getTransliterator()

No description

$this
setTransliterator(Transliterator $transliterator)

No description

setAllowMultibyte(bool $bool)

No description

bool
getAllowMultibyte()

No description

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

static Injectable create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

string filter(string $name)

Note: Depending on the applied replacement rules, this method might result in an empty string.

Parameters

string $name

URL path (without domain or query parameters), in utf8 encoding

Return Value

string

$this setReplacements(string[] $replacements)

Parameters

string[] $replacements

Map of find/replace used for preg_replace().

Return Value

$this

string[] getReplacements()

Return Value

string[]

Transliterator|null getTransliterator()

Return Value

Transliterator|null

$this setTransliterator(Transliterator $transliterator)

Parameters

Transliterator $transliterator

Return Value

$this

setAllowMultibyte(bool $bool)

Parameters

bool $bool

bool getAllowMultibyte()

Return Value

bool