class LegacyThumbnailMigrationHelper (View source)

deprecated 1.12.0 Will be removed without equivalent functionality to replace it

Service to migrate legacy format thumbnails, to avoid regenerating them on demand.

Related to SilverStripe\AssetAdmin\Helper\ImageThumbnailHelper, which proactively generates the (new) thumbnails required for asset-admin previews.

Migrates thumbnails regardless whether their original file still exists, since they might still be hot-linked. Relies on the legacy file format redirections introduced in 4.3.3 and 4.4.0 for those hot-links to continue resolving.

Example file format: Before (3.x): assets/my-folder/_resampled/PadWzYwLDYwLCJGRkZGRkYiLDBd/FillWzYwLDMwXQ/my-image.jpg After (4.x): assets/my-folder/0ec62bd1c4/my-image__PadWzYwLDYwLCJGRkZGRkYiLDBd_CropHeightWzMwXQ.jpg

Limitations:

  • Does not migrate legacy thumbnails where the original file or folder has been renamed since an earlier 4.x migration run
  • Does not filter out unused CMS thumbnails (they're using a new size now)
  • Does not move legacy thumbnails to the protected store if the original file has been unpublished or protected since an earlier 4.x migration run

Traits

A class that can be instantiated or replaced via DI

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

Config options

dependencies

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

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

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

public
__construct()

No description

public
array
run(FlysystemAssetStore $store)

Perform migration

public
setLogger(LoggerInterface $logger)

No description

protected
array
migrateFolder(FlysystemAssetStore $store, Folder $folder)

Migrate a folder

protected
getFolderQuery()

Get list of Folder dataobjects to inspect for

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

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

__construct()

No description

array run(FlysystemAssetStore $store)

Perform migration

Parameters

FlysystemAssetStore $store

Return Value

array

Map of old to new moved paths

setLogger(LoggerInterface $logger)

No description

Parameters

LoggerInterface $logger

protected array migrateFolder(FlysystemAssetStore $store, Folder $folder)

Migrate a folder

Parameters

FlysystemAssetStore $store
Folder $folder

Return Value

array

Map of old to new file paths (relative to store root)

protected DataList getFolderQuery()

Get list of Folder dataobjects to inspect for

Return Value

DataList