class ImageThumbnailHelper (View source)

Traits

A class that can be instantiated or replaced via DI

Methods

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.

$this
setLogger(LoggerInterface $logger)

No description

__construct($maxImageFileSize = '9M')

No description

int
getMaxImageFileSize()

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

$this
setMaxImageFileSize(int|string $size)

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

int
run()

No description

Details

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::class); $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

$this setLogger(LoggerInterface $logger)

Parameters

LoggerInterface $logger

Return Value

$this

__construct($maxImageFileSize = '9M')

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

Return Value

int

Number of thumbnails processed