SilverStripe Search

FileConfigStore
in package
implements ConfigStore

Class FileConfigStore Store the config in a file storage on the local file system, usually in project/.solr/indexname

Table of Contents

Interfaces

ConfigStore
Interface ConfigStore

Properties

$config  : array<string|int, mixed>

Methods

__construct()  : mixed
FileConfigStore constructor.
getConfig()  : array<string|int, mixed>
Get the config
getPath()  : mixed|string
Path to the store location
getTargetDir()  : string
Get the target dir for the file saving, create if it doesn't exist.
instanceDir()  : string
Location of the instance
setConfig()  : $this
Set the config
uploadFile()  : void|null
Upload a file to the configuration store. Usually located in .solr/conf
uploadString()  : void|null
Upload/load a file in to the storage

Properties

$config

protected array<string|int, mixed> $config

Configuration to use

Methods

__construct()

FileConfigStore constructor.

public __construct(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>

getConfig()

Get the config

public getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPath()

Path to the store location

public getPath() : mixed|string
Return values
mixed|string

getTargetDir()

Get the target dir for the file saving, create if it doesn't exist.

public getTargetDir( $index) : string
Parameters
$index :
Return values
string

instanceDir()

Location of the instance

public instanceDir(string|null $index) : string
Parameters
$index : string|null
Return values
string

setConfig()

Set the config

public setConfig(array<string|int, mixed> $config) : $this
Parameters
$config : array<string|int, mixed>
Return values
$this

uploadFile()

Upload a file to the configuration store. Usually located in .solr/conf

public uploadFile(string $index, string $file) : void|null
Parameters
$index : string
$file : string
Return values
void|null

uploadString()

Upload/load a file in to the storage

public uploadString(string $index, string $filename, string $string) : void|null
Parameters
$index : string
$filename : string
$string : string
Return values
void|null

        
On this page

Search results