OptionsStorageInterface
in
Options interface
Table of Contents
Methods
- createOption() : bool
- Create option, if option exists return false
- getExtensionOptions() : mixed
- Get extension options
- hasOption() : bool
- Return true if option name exist
- loadOptions() : array<string|int, mixed>
- Load options
- read() : mixed
- Get option
- remove() : bool
- Remove option(s)
- saveOption() : bool
- Save option
- searchOptions() : array<string|int, mixed>
- Search for options
Methods
createOption()
Create option, if option exists return false
public
createOption(string $key, mixed $value[, bool $autoLoad = false ][, string|null $extension = null ]) : bool
Parameters
- $key : string
- $value : mixed
- $autoLoad : bool = false
- $extension : string|null = null
Return values
boolgetExtensionOptions()
Get extension options
public
getExtensionOptions(string $extensioName) : mixed
Parameters
- $extensioName : string
hasOption()
Return true if option name exist
public
hasOption(string $key) : bool
Parameters
- $key : string
Return values
boolloadOptions()
Load options
public
loadOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>read()
Get option
public
read(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
remove()
Remove option(s)
public
remove([string $key = null ][, string|null $extension = null ]) : bool
Parameters
- $key : string = null
- $extension : string|null = null
Return values
boolsaveOption()
Save option
public
saveOption(string $key, mixed $value[, string|null $extension = null ][, bool $autoLoad = false ]) : bool
Parameters
- $key : string
- $value : mixed
- $extension : string|null = null
- $autoLoad : bool = false
Return values
boolsearchOptions()
Search for options
public
searchOptions(string $searchKey[, bool $compactKeys = false ]) : array<string|int, mixed>
Parameters
- $searchKey : string
- $compactKeys : bool = false