1. interface
  2. SilverStripe
  3. \
  4. Assets
  5. \
  6. Storage
  7. \
  8. GeneratedAssetHandler

GeneratedAssetHandler

interface GeneratedAssetHandler (View source)

Interface to define a handler for persistent generated files

Methods

public
string
getContentURL(string $filename, callable $callback = null)

Returns a URL to a generated asset, if one is available.

public
string
getContent(string $filename, callable $callback = null)

Returns the content for a generated asset, if one is available.

public
setContent(string $filename, string $content)

Update content with new value

public
removeContent(string $filename)

Remove any content under the given file.

Details

at line 22
string getContentURL(string $filename, callable $callback = null)

Returns a URL to a generated asset, if one is available.

Given a filename, determine if a file is available. If the file is unavailable, and a callback is supplied, invoke it to regenerate the content.

Parameters

string $filename
callable $callback

To generate content. If none provided, url will only be returned if there is valid content.

Return Value

string

URL to generated file

at line 35
string getContent(string $filename, callable $callback = null)

Returns the content for a generated asset, if one is available.

Given a filename, determine if a file is available. If the file is unavailable, and a callback is supplied, invoke it to regenerate the content.

Parameters

string $filename
callable $callback

To generate content. If none provided, content will only be returned if there is valid content.

Return Value

string

Content for this generated file

at line 43
setContent(string $filename, string $content)

Update content with new value

Parameters

string $filename
string $content

Content to write to the backend

at line 52
removeContent(string $filename)

Remove any content under the given file.

If $filename is a folder, it should delete all files underneath it also.

Parameters

string $filename