Ini
Extends AbstractRegistryFormatINI format handler for Registry.
| since |
1.0 |
|---|---|
| package |
Joomla Framework |
Methods
getInstance
Returns a reference to a Format object, only creating it if it doesn't already exist.
getInstance(string type, array options = array()) : \Joomla\Registry\AbstractRegistryFormat
| deprecated |
2.0 Use Factory::getFormat() instead |
|---|---|
| since |
1.0 |
| throws |
|
Arguments
- type
stringThe format to load- options
arrayAdditional options to configure the object
Response
\Joomla\Registry\AbstractRegistryFormatRegistry format handler
getValueAsIni
Method to get a value in an INI format.
getValueAsIni(mixed value) : string
| since |
1.0 |
|---|
Arguments
- value
mixedThe value to convert to INI format.
Response
stringThe value in INI format.
objectToString
Converts an object into an INI formatted string
- Unfortunately, there is no way to have ini values nested further than two levels deep. Therefore we will only go through the first two levels of the object.
objectToString(object object, array options = array()) : string
| since |
1.0 |
|---|
Arguments
- object
objectData source object.- options
arrayOptions used by the formatter.
Response
stringINI formatted string.
stringToObject
Parse an INI formatted string and convert it into an object.
stringToObject(string data, array options = array()) : object
| since |
1.0 |
|---|
Arguments
- data
stringINI formatted string to convert.- options
arrayAn array of options used by the formatter, or a boolean setting to process sections.
Response
objectData object.
Properties
options
Default options array
| since |
1.3.0 |
|---|
Type(s)
array
cache
A cache used by stringToObject.
| since |
1.0 |
|---|
Type(s)
array
instances
Format instances container.
| since |
1.0 |
|---|---|
| deprecated |
2.0 Object caching will no longer be supported |
Type(s)
\Joomla\Registry\AbstractRegistryFormat[]