Options
extends Collection
in package
implements
OptionsInterface
Options base class
Table of Contents
Interfaces
- OptionsInterface
- Options interface
Properties
- $cacheSaveTime : int
- Save cache time
- $adapter : OptionsStorageInterface
- Storage adapter
- $cache : CacheInterface
- Cache
- $data : array<string|int, mixed>
- Collection items data
- $needReload : bool
- Should reload options array
Methods
- __construct() : mixed
- Constructor
- __get() : mixed
- Get value
- __set() : mixed
- Set value
- add() : void
- Add item to collection
- addField() : bool
- Add value
- clear() : void
- Clear collection data
- copy() : self
- Clone object
- count() : int
- Return collection items count.
- create() : Collection
- Create colleciton
- createFromFile() : Collection
- Create colection form json file
- createOption() : bool
- Create option, if option exists return false
- get() : mixed
- Get option
- getArray() : array<string|int, mixed>
- Return array values
- getBool() : bool
- Get boolean value
- getByPath() : mixed
- Get value by path
- getCollection() : Collection
- Get collection item
- getExtensionOptions() : mixed
- Get extension options
- getFloat() : float|null
- Get float value
- getInt() : int|null
- Get int value
- getItems() : array<string|int, mixed>
- Get collection items
- getIterator() : ArrayIterator
- Return iterator
- getString() : string
- Get text value
- has() : bool
- Return true if option name exist
- isEmpty() : bool
- Return true if key exists and value not empty in collection
- load() : void
- Store options in collection
- merge() : void
- Merge collection items
- mergeItems() : void
- Merge all collection items
- offsetExists() : bool
- Return true if key exists in collection
- offsetGet() : mixed
- Get item
- offsetSet() : void
- Set item
- offsetUnset() : void
- Remove item
- prepend() : bool
- Add value to begining of collection array
- push() : bool
- Push value to collection
- read() : mixed
- Force load option
- remove() : Collection
- Remove item
- removeEmptyItems() : void
- Remove empy items
- removeOptions() : bool
- Remove option(s)
- replace() : Collection
- Replace array
- searchOptions() : array<string|int, mixed>
- Search options
- set() : bool
- Save option
- setArrayValue() : array<string|int, mixed>
- Set array value
- setBooleanValue() : void
- Set bool value
- setStorageAdapter() : void
- Set storage adapter
- setValue() : void
- Set item value by path
- slice() : array<string|int, mixed>
- Slice collecion by keys
- toArray() : array<string|int, mixed>
- Return collection array
- union() : Collection
- Union arrays
- withData() : Collection
- Set collection data
- resolveOptions() : array<string|int, mixed>
- Resolve options
- resolveOptionType() : mixed
- Resolve option type
Properties
$cacheSaveTime
Save cache time
public
static int
$cacheSaveTime
= 10
$adapter
Storage adapter
protected
OptionsStorageInterface
$adapter
$cache
Cache
protected
CacheInterface
$cache
$data
Collection items data
protected
array<string|int, mixed>
$data
= []
$needReload
Should reload options array
protected
bool
$needReload
Methods
__construct()
Constructor
public
__construct(CacheInterface $cache, OptionsStorageInterface $adapter) : mixed
Parameters
- $cache : CacheInterface
- $adapter : OptionsStorageInterface
__get()
Get value
public
__get(string $key) : mixed
Parameters
- $key : string
__set()
Set value
public
__set(string $key, mixed $value) : mixed
Parameters
- $key : string
- $value : mixed
add()
Add item to collection
public
add(string $key, mixed $value) : void
Parameters
- $key : string
-
key name
- $value : mixed
addField()
Add value
public
addField(string $path, mixed $value) : bool
Parameters
- $path : string
- $value : mixed
Return values
boolclear()
Clear collection data
public
clear() : void
copy()
Clone object
public
copy() : self
Return values
selfcount()
Return collection items count.
public
count() : int
Return values
intcreate()
Create colleciton
public
static create(array<string|int, mixed> $data) : Collection
Parameters
- $data : array<string|int, mixed>
Return values
CollectioncreateFromFile()
Create colection form json file
public
static createFromFile(string $fileName[, string|null $root = null ][, array<string|int, mixed>|null $vars = null ]) : Collection
Parameters
- $fileName : string
- $root : string|null = null
- $vars : array<string|int, mixed>|null = null
Return values
CollectioncreateOption()
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
getArray()
Return array values
public
getArray(string $key[, mixed $default = null ]) : array<string|int, mixed>
Parameters
- $key : string
- $default : mixed = null
Return values
array<string|int, mixed>getBool()
Get boolean value
public
getBool(string $key[, bool|null $default = null ]) : bool
Parameters
- $key : string
- $default : bool|null = null
Return values
boolgetByPath()
Get value by path
public
getByPath(string $path[, mixed $default = null ]) : mixed
Parameters
- $path : string
- $default : mixed = null
getCollection()
Get collection item
public
getCollection(string $key) : Collection
Parameters
- $key : string
Return values
CollectiongetExtensionOptions()
Get extension options
public
getExtensionOptions(string $extensioName) : mixed
Parameters
- $extensioName : string
getFloat()
Get float value
public
getFloat(string $key[, float|null $default = null ]) : float|null
Parameters
- $key : string
- $default : float|null = null
Return values
float|nullgetInt()
Get int value
public
getInt(string $key[, int|null $default = null ]) : int|null
Parameters
- $key : string
- $default : int|null = null
Return values
int|nullgetItems()
Get collection items
public
getItems() : array<string|int, mixed>
Return values
array<string|int, mixed>getIterator()
Return iterator
public
getIterator() : ArrayIterator
Return values
ArrayIteratorgetString()
Get text value
public
getString(string $key[, string|null $default = null ]) : string
Parameters
- $key : string
- $default : string|null = null
Return values
stringhas()
Return true if option name exist
public
has(string $key) : bool
Parameters
- $key : string
Return values
boolisEmpty()
Return true if key exists and value not empty in collection
public
isEmpty(string $key) : bool
Parameters
- $key : string
-
Name
Return values
boolload()
Store options in collection
public
load() : void
merge()
Merge collection items
public
merge(string $key, array<string|int, mixed> $data[, bool $recursive = false ]) : void
Parameters
- $key : string
- $data : array<string|int, mixed>
- $recursive : bool = false
mergeItems()
Merge all collection items
public
mergeItems(array<string|int, mixed> $data[, bool $recursive = false ]) : void
Parameters
- $data : array<string|int, mixed>
- $recursive : bool = false
offsetExists()
Return true if key exists in collection
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
Get item
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
offsetSet()
Set item
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
Remove item
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
prepend()
Add value to begining of collection array
public
prepend(string $key, mixed $value[, string|null $subKey = null ]) : bool
Parameters
- $key : string
- $value : mixed
- $subKey : string|null = null
Return values
boolpush()
Push value to collection
public
push(string $key, mixed $value[, string|null $subKey = null ]) : bool
Parameters
- $key : string
- $value : mixed
- $subKey : string|null = null
Return values
boolread()
Force load option
public
read(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
remove()
Remove item
public
remove(string $key) : Collection
Parameters
- $key : string
Return values
CollectionremoveEmptyItems()
Remove empy items
public
removeEmptyItems() : void
removeOptions()
Remove option(s)
public
removeOptions([string $key = null ][, string|null $extension = null ]) : bool
Parameters
- $key : string = null
- $extension : string|null = null
Return values
boolreplace()
Replace array
public
replace(array<string|int, mixed> $replacement) : Collection
Parameters
- $replacement : array<string|int, mixed>
Return values
CollectionsearchOptions()
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
boolsetArrayValue()
Set array value
public
static setArrayValue(array<string|int, mixed> $array, string $path, mixed $value[, string $separator = '/' ]) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $path : string
- $value : mixed
- $separator : string = '/'
Return values
array<string|int, mixed>setBooleanValue()
Set bool value
public
setBooleanValue(string $path, int|string $value) : void
Parameters
- $path : string
- $value : int|string
setStorageAdapter()
Set storage adapter
public
setStorageAdapter(OptionsStorageInterface $adapter) : void
Parameters
- $adapter : OptionsStorageInterface
setValue()
Set item value by path
public
setValue(string $path, mixed $value) : void
Parameters
- $path : string
- $value : mixed
slice()
Slice collecion by keys
public
slice(array<string|int, mixed>|string $keys) : array<string|int, mixed>
Parameters
- $keys : array<string|int, mixed>|string
Return values
array<string|int, mixed>toArray()
Return collection array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>union()
Union arrays
public
union(array<string|int, mixed> $data) : Collection
Parameters
- $data : array<string|int, mixed>
Return values
CollectionwithData()
Set collection data
public
withData(array<string|int, mixed> $data) : Collection
Parameters
- $data : array<string|int, mixed>
Return values
CollectionresolveOptions()
Resolve options
protected
resolveOptions(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed>
Return values
array<string|int, mixed>resolveOptionType()
Resolve option type
protected
resolveOptionType(mixed $value) : mixed
Parameters
- $value : mixed