Yaml
Extends \Joomla\Registry\AbstractRegistryFormatYAML format handler for Registry.
| since |
1.0 |
|---|
Methods
__construct
Construct to set up the parser and dumper
__construct()
| since |
1.0 |
|---|
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
objectToString
Converts an object into a YAML formatted string.
objectToString(object $object, array $options = array()) : string
We use json_* to convert the passed object to an array.
| since |
1.0 |
|---|
Arguments
- $object
objectData source object.- $options
arrayOptions used by the formatter.
Response
stringYAML formatted string.
stringToObject
Parse a YAML formatted string and convert it into an object.
stringToObject(string $data, array $options = array()) : object
We use the json_* methods to convert the parsed YAML array to an object.
| since |
1.0 |
|---|
Arguments
- $data
stringYAML formatted string to convert.- $options
arrayOptions used by the formatter.
Response
objectData object.
Properties
parser
The YAML parser class.
| since |
1.0 |
|---|
Type(s)
\Symfony\Component\Yaml\Parser
dumper
The YAML dumper class.
| since |
1.0 |
|---|
Type(s)
\Symfony\Component\Yaml\Dumper
instances
Format instances container.
| since |
1.0 |
|---|---|
| deprecated |
2.0 Object caching will no longer be supported |
Type(s)
array<mixed,\Joomla\Registry\AbstractRegistryFormat>