OptionsInterface
in
Options interface
Table of Contents
Methods
- createOption() : bool
- Create option, if option exists return false
- get() : mixed
- Get option
- getExtensionOptions() : mixed
- Get extension options
- has() : bool
- Return true if option name exist
- read() : mixed
- Force load option
- removeOptions() : bool
- Remove option(s)
- searchOptions() : array<string|int, mixed>
- Search options
- set() : bool
- Save option
- setStorageAdapter() : void
- Set storage adapter
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
boolget()
Get option
public
get(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
getExtensionOptions()
Get extension options
public
getExtensionOptions(string $extensioName) : mixed
Parameters
- $extensioName : string
has()
Return true if option name exist
public
has(string $key) : bool
Parameters
- $key : string
Return values
boolread()
Force load option
public
read(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
removeOptions()
Remove option(s)
public
removeOptions([string $key = null ][, string|null $extension = null ]) : bool
Parameters
- $key : string = null
- $extension : string|null = null
Return values
boolsearchOptions()
Search options
public
searchOptions(string $searchKey[, bool $compactKeys = false ]) : array<string|int, mixed>
Parameters
- $searchKey : string
- $compactKeys : bool = false
Return values
array<string|int, mixed>set()
Save option
public
set(string $key, mixed $value[, string|null $extension = null ]) : bool
Parameters
- $key : string
- $value : mixed
- $extension : string|null = null
Return values
boolsetStorageAdapter()
Set storage adapter
public
setStorageAdapter(OptionsStorageInterface $adapter) : void
Parameters
- $adapter : OptionsStorageInterface