class RegistryImportFeed (View source)

Traits

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

A class that can be instantiated or replaced via DI

Config options

storage_path string

The path format to store imported record files in (inside the assets directory)

storage_filename string

The filename to use for storing imported record files. Used by RegistryImportFeedController to save files to.

Properties

protected $modelClass
protected GeneratedAssetHandler $assetHandler

The class used to manipulate imported feed files on the filesystem

protected string $assetsDir

The "assets" folder name

Methods

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 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
setModelClass($class)

No description

public
getLatest()

No description

public
$this
setAssetHandler(GeneratedAssetHandler $handler)

Set the handler used to manipulate the filesystem, and add the ListFiles plugin from Flysystem to inspect the contents of a directory

public
getAssetHandler()

Get the handler used to manipulate the filesystem

public
string
getStoragePath(string $modelClass = null)

Get the path that import files will be stored for this model

public
getImportFiles()

Loop import files in the storage path and push them into an ArrayList

public
string
getImportFilename()

Returns a relatively unique filename to storage imported data feeds as

public
$this
setAssetsDir(string $assetsDir)

Set the assets directory name

public
string
getAssetsDir()

Get the assets directory name

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

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

setModelClass($class)

No description

Parameters

$class

getLatest()

No description

$this setAssetHandler(GeneratedAssetHandler $handler)

Set the handler used to manipulate the filesystem, and add the ListFiles plugin from Flysystem to inspect the contents of a directory

Parameters

GeneratedAssetHandler $handler

Return Value

$this

GeneratedAssetHandler getAssetHandler()

Get the handler used to manipulate the filesystem

Return Value

GeneratedAssetHandler

string getStoragePath(string $modelClass = null)

Get the path that import files will be stored for this model

Parameters

string $modelClass

If null, the current model class will be used

Return Value

string

ArrayList getImportFiles()

Loop import files in the storage path and push them into an ArrayList

Return Value

ArrayList

string getImportFilename()

Returns a relatively unique filename to storage imported data feeds as

Return Value

string

$this setAssetsDir(string $assetsDir)

Set the assets directory name

Parameters

string $assetsDir

Return Value

$this

string getAssetsDir()

Get the assets directory name

Return Value

string

protected string sanitiseClassName(string $class)

Parameters

string $class

Return Value

string