URLSegmentFilter
class URLSegmentFilter implements FilterInterface (View source)
Filter certain characters from "URL segments" (also called "slugs"), for nicer (more SEO-friendly) URLs.
Uses Transliterator to convert non-ASCII characters to meaningful ASCII representations. Use $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 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
Config options
| default_use_transliterator | bool | ||
| default_replacements | array | ||
| default_allow_multibyte | bool | Doesn't try to replace or transliterate non-ASCII filters. |
Properties
| public | array | $replacements | ||
| protected | Transliterator | $transliterator | ||
| protected | bool | $allowMultibyte |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Note: Depending on the applied replacement rules, this method might result in an empty string.
Details
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
static Injectable
create(mixed ...$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::class); $list = SiteTree::get();
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).
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
Transliterator|null
getTransliterator()
No description
$this
setTransliterator(Transliterator $transliterator)
No description
setAllowMultibyte(bool $bool)
No description
bool
getAllowMultibyte()
No description