class LegacyFileIDHelper implements FileIDHelper (View source)

deprecated 1.12.0 Legacy file names will not be supported in Silverstripe CMS 5

Parsed SS3 style legacy asset URLs. e.g.: Uploads/_resampled/ResizedImageWzYwLDgwXQ/sam.jpg

SS3 legacy paths are no longer used in SilverStripe 4, but a way to parse them is needed for redirecting old SS3 urls.

Traits

A class that can be instantiated or replaced via DI

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

Config options

ss3_image_variant_methods

List of SilverStripe 3 image method names that can appear in variants. Prior to SilverStripe 3.3, variants were encoded in the filename with dashes. e.g.: _resampled/FitW10-sam.jpg rather than _resampled/FitW10/sam.jpg.

Properties

Methods

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public static 
config()

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

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

public
__construct(bool $failNewerVariant = true)

No description

public
string
buildFileID(string|ParsedFileID $filename, string $hash = null, string $variant = null, bool $cleanfilename = true)

Map file tuple (hash, name, variant) to a filename to be used by flysystem

public
string
cleanFilename(string $filename)

Clean up filename to remove constructs that might clash with the underlying path format of this FileIDHelper.

public
parseFileID(string $fileID)

No description

public
bool
isVariantOf(string $fileID, ParsedFileID $original)

Determine if the provided fileID is a variant of $parsedFileID.

public
string
lookForVariantIn(ParsedFileID $parsedFileID)

Compute the relative path where variants of the provided parsed file ID are expected to be stored.

public
bool
lookForVariantRecursive()

Specify if this File ID Helper stores variants in subfolders and require a recursive look up to find all variants.

Details

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

Parameters

mixed ...$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

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

__construct(bool $failNewerVariant = true)

No description

Parameters

bool $failNewerVariant

Whether FileID mapping to newer SS4 formats should be parsed.

string buildFileID(string|ParsedFileID $filename, string $hash = null, string $variant = null, bool $cleanfilename = true)

Map file tuple (hash, name, variant) to a filename to be used by flysystem

Parameters

string|ParsedFileID $filename

Name of file or ParsedFileID object

string $hash

Hash of original file

string $variant

(if given)

bool $cleanfilename

Whether the filename should be cleaned before building the file ID. Defaults to true.

Return Value

string

Adapter specific identifier for this file/version

string cleanFilename(string $filename)

Clean up filename to remove constructs that might clash with the underlying path format of this FileIDHelper.

Parameters

string $filename

Return Value

string

ParsedFileID|null parseFileID(string $fileID)

No description

Parameters

string $fileID

Return Value

ParsedFileID|null

bool isVariantOf(string $fileID, ParsedFileID $original)

Determine if the provided fileID is a variant of $parsedFileID.

Parameters

string $fileID
ParsedFileID $original

Return Value

bool

string lookForVariantIn(ParsedFileID $parsedFileID)

Compute the relative path where variants of the provided parsed file ID are expected to be stored.

Parameters

ParsedFileID $parsedFileID

Return Value

string

bool lookForVariantRecursive()

Specify if this File ID Helper stores variants in subfolders and require a recursive look up to find all variants.

Return Value

bool