Yaf_Config_Ini

class Yaf_Config_Ini extends Yaf_Config_Abstract implements Iterator, ArrayAccess, Countable (View source)

Yaf_Config_Ini enables developers to store configuration data in a familiar INI format and read them in the application by using nested object property syntax. The INI format is specialized to provide both the ability to have a hierarchy of configuration data keys and inheritance between configuration data sections. Configuration data hierarchies are supported by separating the keys with the dot or period character ("."). A section may extend or inherit from another section by following the section name with a colon character (":") and the name of the section from which data are to be inherited.


Note:

Yaf_Config_Ini utilizes the ยป parse_ini_file() PHP function. Please review this documentation to be aware of its specific behaviors, which propagate to Yaf_Config_Ini, such as how the special values of "TRUE", "FALSE", "yes", "no", and "NULL" are handled.

Properties

protected array $_config from  Yaf_Config_Abstract
protected bool $_readonly from  Yaf_Config_Abstract

Methods

mixed
get(string|null $name = null)

No description

bool
set(string $name, mixed $value)

No description

int<0, max>
count()

No description

void
rewind()

No description

TValue
current()

No description

TKey|null
key()

No description

void
next()

No description

bool
valid()

No description

bool
readonly()

No description

array
toArray()

No description

void
offsetSet(TKey $offset, TValue $value)

No description

void
offsetUnset(mixed $name) deprecated

No description

bool
offsetExists(mixed $name)

No description

TValue
offsetGet(mixed $name)

No description

mixed
__get(string $name = null)

No description

bool
__isset(string $name)

No description

__construct(array|string $config_file, string|null $section = null)

No description

__set(mixed $name, mixed $value)

No description

Details

at line 2336
mixed get(string|null $name = null)

No description

Parameters

string|null $name

Return Value

mixed

See also

Yaf_Config_Abstract::get

at line 2343
bool set(string $name, mixed $value)

No description

Parameters

string $name
mixed $value

Return Value

bool

See also

Yaf_Config_Abstract::set

at line 2368
int<0, max> count()

No description

Return Value

int<0, max>

The custom count as an integer.

The return value is cast to an integer.

See also

Yaf_Config_Abstract::count

at line 2374
void rewind()

No description

Return Value

void

Any returned value is ignored.

See also

Yaf_Config_Abstract::rewind

at line 2380
TValue current()

No description

Return Value

TValue

Can return any type.

See also

Yaf_Config_Abstract::current

at line 2398
TKey|null key()

No description

Return Value

TKey|null

TKey on success, or null on failure.

See also

Yaf_Config_Abstract::key

at line 2386
void next()

No description

Return Value

void

Any returned value is ignored.

See also

Yaf_Config_Abstract::next

at line 2392
bool valid()

No description

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

See also

Yaf_Config_Abstract::valid

at line 2355
bool readonly()

No description

Return Value

bool

See also

Yaf_Config_Abstract::readonly

at line 2349
array toArray()

No description

Return Value

array

See also

Yaf_Config_Abstract::toArray

at line 2428
void offsetSet(TKey $offset, TValue $value)

No description

Parameters

TKey $offset

The offset to assign the value to.

TValue $value

The value to set.

Return Value

void

See also

Yaf_Config_Abstract::offsetSet

at line 2406
void offsetUnset(mixed $name) deprecated

deprecated not_implemented

No description

Parameters

mixed $name

Return Value

void

See also

Yaf_Config_Abstract::offsetUnset

at line 2420
bool offsetExists(mixed $name)

No description

Parameters

mixed $name

Return Value

bool

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

See also

Yaf_Config_Abstract::offsetExists

at line 2413
TValue offsetGet(mixed $name)

No description

Parameters

mixed $name

Return Value

TValue

Can return all value types.

See also

Yaf_Config_Abstract::offsetGet

at line 2322
mixed __get(string $name = null)

No description

Parameters

string $name

Return Value

mixed

See also

Yaf_Config_Abstract::__get

at line 2362
bool __isset(string $name)

No description

Parameters

string $name

Return Value

bool

See also

Yaf_Config_Abstract::__isset

at line 2315
__construct(array|string $config_file, string|null $section = null)

No description

Parameters

array|string $config_file
string|null $section

Exceptions

Yaf_Exception_TypeError

at line 2329
__set(mixed $name, mixed $value)

No description

Parameters

mixed $name
mixed $value

See also

Yaf_Config_Abstract::__set