class SecureAssetsMigrationHelper (View source)

deprecated 1.12.0 Will be removed without equivalent functionality to replace it

Removes stray .htaccess files created through the silverstripe/secureassets module on a 3.x-based site. The 4.x protections work differently: One central assets/.htaccess file routes non-existent paths through SilverStripe, which can choose to return a file from assets/.protected.

Any additional .htaccess files in folders can interfere with this logic.

Note that this task does not migrate file metadata added/managed through silverstripe/secureassets. The metadata fields are the same in 4.x (File.CanViewType etc).

See https://github.com/silverstripe/silverstripe-assets/issues/231

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

protected array $htaccessRegexes

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

No description

public
bool
htaccessMatch(string $content)

A "somewhat exact" match on file contents, to avoid deleting any customised files.

protected
migrateFolder(Filesystem $filesystem, string $path)

No description

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

Folders which needed migration

$this setLogger(LoggerInterface $logger)

No description

Parameters

LoggerInterface $logger

Return Value

$this

bool htaccessMatch(string $content)

A "somewhat exact" match on file contents, to avoid deleting any customised files.

Checks each line in a file, with some leeway for different base folders which are dynamically generated based on the context of a particular environment.

Parameters

string $content

Return Value

bool

protected migrateFolder(Filesystem $filesystem, string $path)

No description

Parameters

Filesystem $filesystem
string $path

return string|null The path of the migrated file (if successful)