class ThumbnailGenerator (View source)

Generate thumbnails and thumbnail links

Traits

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

Constants

INLINE

Thumbnails are inline

URL

Thumbnails are linked by url

Properties

static private int $max_thumbnail_bytes

Safely limit max inline thumbnail size to 200kb.

$thumbnail_links

Determine how thumbnails are serialised List of visibility to either 'inline' or 'url' form.

static private string $method

Methods

static Config_ForClass
config()

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

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

string|null
generateThumbnailLink(AssetContainer $file, int $width, int $height, bool $graceful = false)

Generate thumbnail and return the "src" property for this thumbnail

generateThumbnail(AssetContainer $file, int $width, int $height)

Generate thumbnail object

string
generateLink(AssetContainer $thumbnail = null)

Generate "src" property for this thumbnail.

bool
getGenerates()

No description

$this
setGenerates(bool $generates)

No description

Details

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

Generate thumbnail and return the "src" property for this thumbnail

Parameters

AssetContainer $file
int $width
int $height
bool $graceful

If true, null result will fallback on URL

Return Value

string|null

AssetContainer|DBFile|File generateThumbnail(AssetContainer $file, int $width, int $height)

Generate thumbnail object

Parameters

AssetContainer $file
int $width
int $height

Return Value

AssetContainer|DBFile|File

Generate "src" property for this thumbnail.

This can be either a url or base64 encoded data

Parameters

AssetContainer $thumbnail

Return Value

string

bool getGenerates()

Return Value

bool

$this setGenerates(bool $generates)

Parameters

bool $generates

Return Value

$this