class FileMigrationHelper (View source)

deprecated 1.12.0 Will be removed without equivalent functionality to replace it

Service to help migrate File dataobjects to the new APL.

This service does not alter these records in such a way that prevents downgrading back to 3.x

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
delete_invalid_files bool

If a file fails to validate during migration, delete it.

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

No description

public
int
run(string $base = null)

Perform migration

protected
ss3Migration($base)

No description

protected
bool
migrateFile(string $base, File $file, string $legacyFilename)

Migrate a single file

protected
int
normaliseAllFiles(string $stageString, bool $skipIdenticalStages = false)

Go through the list of files and make sure each one is at its default location

protected
bool
validateFileClassname(File $file, string $extension)

Check if a file's classname is compatible with it's extension

protected
getFileQuery()

Get list of File dataobjects to import

protected
getLegacyFileQuery()

No description

protected
array
getFilenameArray() deprecated

Get map of File IDs to legacy filenames

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

$this setLogger(LoggerInterface $logger)

No description

Parameters

LoggerInterface $logger

Return Value

$this

int run(string $base = null)

Perform migration

Parameters

string $base

Absolute base path (parent of assets folder). Will default to PUBLIC_PATH

Return Value

int

Number of files successfully migrated

protected ss3Migration($base)

No description

Parameters

$base

protected bool migrateFile(string $base, File $file, string $legacyFilename)

Migrate a single file

Parameters

string $base

Absolute base path (parent of assets folder)

File $file
string $legacyFilename

Return Value

bool

True if this file is imported successfully

protected int normaliseAllFiles(string $stageString, bool $skipIdenticalStages = false)

Go through the list of files and make sure each one is at its default location

Parameters

string $stageString

Complement of information to append to the confirmation message

bool $skipIdenticalStages

Whatever files that are already present on an other stage should be skipped

Return Value

int

protected bool validateFileClassname(File $file, string $extension)

Check if a file's classname is compatible with it's extension

Parameters

File $file
string $extension

Return Value

bool

protected DataList getFileQuery()

Get list of File dataobjects to import

Return Value

DataList

protected getLegacyFileQuery()

No description

protected array getFilenameArray() deprecated

deprecated 1.4.0 Will be removed without equivalent functionality to replace it

Get map of File IDs to legacy filenames

Return Value

array