1. class
  2. SilverStripe
  3. \
  4. Assets
  5. \
  6. FilenameParsing
  7. \
  8. ParsedFileID

ParsedFileID

class ParsedFileID (View source)

Immutable representation of a parsed fileID broken down into its sub-components.

Methods

__construct(string $filename, string $hash = '', string $variant = '', string $fileID = '')

ParsedFileID constructor.

string
getFileID()

The File ID associated with this ParsedFileID if known, or blank if unknown.

string
getFilename()

Filename component.

string
getVariant()

Variant component. Usually a string representing some resized version of an image.

string
getHash()

Hash build from the content of the file. Usually the first 10 characters of sha1 hash.

array
getTuple()

Convert this parsed file ID to an array representation.

ParsedFileID
setFileID(string $fileID)

No description

ParsedFileID
setFilename(string $filename)

No description

ParsedFileID
setVariant(string $variant)

No description

ParsedFileID
setHash(string $hash)

No description

Details

at line 30
__construct(string $filename, string $hash = '', string $variant = '', string $fileID = '')

ParsedFileID constructor.

Parameters

string $filename
string $hash
string $variant
string $fileID

Original FileID use to generate this ParsedFileID

at line 42
string getFileID()

The File ID associated with this ParsedFileID if known, or blank if unknown.

Return Value

string

at line 51
string getFilename()

Filename component.

Return Value

string

at line 60
string getVariant()

Variant component. Usually a string representing some resized version of an image.

Return Value

string

at line 69
string getHash()

Hash build from the content of the file. Usually the first 10 characters of sha1 hash.

Return Value

string

at line 78
array getTuple()

Convert this parsed file ID to an array representation.

Return Value

array

at line 91
ParsedFileID setFileID(string $fileID)

Parameters

string $fileID

Return Value

ParsedFileID

at line 100
ParsedFileID setFilename(string $filename)

Parameters

string $filename

Return Value

ParsedFileID

at line 109
ParsedFileID setVariant(string $variant)

Parameters

string $variant

Return Value

ParsedFileID

at line 118
ParsedFileID setHash(string $hash)

Parameters

string $hash

Return Value

ParsedFileID