class ImageThumbnailHelper (View source)

Traits

A class that can be instantiated or replaced via DI

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
$this
setLogger(LoggerInterface $logger)

No description

public
__construct($maxImageFileSize = '9M')

No description

public
int
getMaxImageFileSize()

Get the maximum file size for which thumbnails will be generated. Set to 0 to disable the limit.

public
$this
setMaxImageFileSize(int|string $size)

Set the maximum file size for which thumbnails will be generated. Set to 0 to disable the limit.

public
int
run()

No description

protected
AssetContainer[]
generateThumbnails(File $file)

Similar to AssetAdmin->generateThumbnails(), but with the ability to tell if a file actually required to be generated.

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

$this setLogger(LoggerInterface $logger)

No description

Parameters

LoggerInterface $logger

Return Value

$this

__construct($maxImageFileSize = '9M')

No description

Parameters

$maxImageFileSize

int getMaxImageFileSize()

Get the maximum file size for which thumbnails will be generated. Set to 0 to disable the limit.

Return Value

int

$this setMaxImageFileSize(int|string $size)

Set the maximum file size for which thumbnails will be generated. Set to 0 to disable the limit.

Parameters

int|string $size

Return Value

$this

int run()

No description

Return Value

int

Number of thumbnails processed

protected AssetContainer[] generateThumbnails(File $file)

Similar to AssetAdmin->generateThumbnails(), but with the ability to tell if a file actually required to be generated.

This speeds up the process, and removes some noise when thumbnails have already been generated.

Parameters

File $file

Return Value

AssetContainer[]

All generated files