Ini
Extends \Joomla\Registry\AbstractRegistryFormatINI format handler for Registry.
since |
1.0 |
---|
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
string
The format to load- $options
array
Additional options to configure the object
Response
\Joomla\Registry\AbstractRegistryFormat
Registry format handler
getValueAsIni
Method to get a value in an INI format.
getValueAsIni(mixed $value) : string
since |
1.0 |
---|
Arguments
- $value
mixed
The value to convert to INI format.
Response
string
The 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
object
Data source object.- $options
array
Options used by the formatter.
Response
string
INI 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
string
INI formatted string to convert.- $options
array
An array of options used by the formatter, or a boolean setting to process sections.
Response
object
Data 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)
array<mixed,\Joomla\Registry\AbstractRegistryFormat>