Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de la classe Yaml

Fonctions membres publiques statiques

static parse ($input, $exceptionOnInvalidType=false, $objectSupport=false, $objectForMap=false)
 
static dump ($input, $inline=2, $indent=4, $exceptionOnInvalidType=false, $objectSupport=false)
 

Description détaillée

Yaml offers convenience methods to load and dump YAML.

Auteur
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des fonctions membres

◆ dump()

static dump (   $input,
  $inline = 2,
  $indent = 4,
  $exceptionOnInvalidType = false,
  $objectSupport = false 
)
static

Dumps a PHP value to a YAML string.

The dump method, when supplied with an array, will do its best to convert the array into friendly YAML.

Paramètres
mixed$inputThe PHP value
int$inlineThe level where you switch to inline YAML
int$indentThe amount of spaces to use for indentation of nested nodes
bool$exceptionOnInvalidTypeTrue if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
bool$objectSupportTrue if object support is enabled, false otherwise
Renvoie
string A YAML string representing the original PHP value

Références $input.

◆ parse()

static parse (   $input,
  $exceptionOnInvalidType = false,
  $objectSupport = false,
  $objectForMap = false 
)
static

Parses YAML into a PHP value.

Usage:

$array = Yaml::parse(file_get_contents('config.yml'));
print_r($array);

As this method accepts both plain strings and file names as an input, you must validate the input before calling this method. Passing a file as an input is a deprecated feature and will be removed in 3.0.

Note: the ability to pass file names to the Yaml::parse method is deprecated since Symfony 2.2 and will be removed in 3.0. Pass the YAML contents of the file instead.

Paramètres
string$inputPath to a YAML file or a string containing YAML
bool$exceptionOnInvalidTypeTrue if an exception must be thrown on invalid types false otherwise
bool$objectSupportTrue if object support is enabled, false otherwise
bool$objectForMapTrue if maps should return a stdClass instead of array()
Renvoie
mixed The YAML converted to a PHP value
Exceptions
ParseExceptionIf the YAML is not valid

Références $file, $input, et ParseException\setParsedFile().


La documentation de cette classe a été générée à partir du fichier suivant :