class FileNameFilter (View source)

Filter certain characters from file name, for nicer (more SEO-friendly) URLs as well as better filesystem compatibility.

Caution: Does not take care of full filename sanitization in regards to directory traversal etc., please use PHP's built-in basename() for this purpose.

For file name filtering see {@link FileNameFilter}.

The default sanitizer is quite conservative regarding non-ASCII characters, in order to achieve maximum filesystem compatibility. In case your filesystem supports a wider character set, or is case sensitive, you might want to relax these rules via overriding {@link FileNameFilter_DefaultFilter::$default_replacements}.

To leave uploaded filenames as they are (being aware of filesystem restrictions), add the following code to your YAML config: FileNameFilter: default_use_transliterator: false default_replacements:

See {@link URLSegmentFilter} for a more generic implementation.

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
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)

Depending on the applied replacement rules, this method might result in an empty string. In this case, {@link getDefaultName()} will be used to return a randomly generated file name, while retaining its extension.

setReplacements(array $replacements)

Take care not to add replacements which might invalidate the file structure, e.g. removing dots will remove file extension information.

array
getReplacements()

No description

setTransliterator(Transliterator|false $transliterator)

No description

string
getDefaultName()

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)

Depending on the applied replacement rules, this method might result in an empty string. In this case, {@link getDefaultName()} will be used to return a randomly generated file name, while retaining its extension.

Parameters

string $name

including extension (not path).

Return Value

string

A filtered filename

setReplacements(array $replacements)

Take care not to add replacements which might invalidate the file structure, e.g. removing dots will remove file extension information.

Parameters

array $replacements

Map of find/replace used for preg_replace().

array getReplacements()

Return Value

array

Transliterator getTransliterator()

Return Value

Transliterator

setTransliterator(Transliterator|false $transliterator)

Parameters

Transliterator|false $transliterator

string getDefaultName()

Return Value

string

File name without extension