Référence de la classe Yaml

Fonctions membres publiques statiques
static	parseFile (string $filename, int $flags=0)
static	parse (string $input, int $flags=0)
static	dump ($input, int $inline=2, int $indent=4, int $flags=0)

Champs de données
const	DUMP_OBJECT = 1
const	PARSE_EXCEPTION_ON_INVALID_TYPE = 2
const	PARSE_OBJECT = 4
const	PARSE_OBJECT_FOR_MAP = 8
const	DUMP_EXCEPTION_ON_INVALID_TYPE = 16
const	PARSE_DATETIME = 32
const	DUMP_OBJECT_AS_MAP = 64
const	DUMP_MULTI_LINE_LITERAL_BLOCK = 128
const	PARSE_CONSTANT = 256
const	PARSE_CUSTOM_TAGS = 512
const	DUMP_EMPTY_ARRAY_AS_SEQUENCE = 1024
const	DUMP_NULL_AS_TILDE = 2048

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, int  $inline = 2, int  $indent = 4, int  $flags = 0  )

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	$input	The PHP value
int	$inline	The level where you switch to inline YAML
int	$indent	The amount of spaces to use for indentation of nested nodes
int	$flags	A bit field of DUMP_* constants to customize the dumped YAML string

Références $input.

parse()

static parse ( string  $input, int  $flags = 0  )

static

Parses YAML into a PHP value.

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

Paramètres

string	$input	A string containing YAML
int	$flags	A bit field of PARSE_* constants to customize the YAML parser behavior

Renvoie

mixed

Exceptions

ParseException

If the YAML is not valid

Références $input.

parseFile()

static parseFile ( string  $filename, int  $flags = 0  )

static

Parses a YAML file into a PHP value.

Usage:

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

Paramètres

string	$filename	The path to the YAML file to be parsed
int	$flags	A bit field of PARSE_* constants to customize the YAML parser behavior

Renvoie

mixed

Exceptions

ParseException

If the file could not be read or the YAML is not valid

Documentation des champs

DUMP_EMPTY_ARRAY_AS_SEQUENCE

const DUMP_EMPTY_ARRAY_AS_SEQUENCE = 1024

Référencé par Inline\dumpArray().

DUMP_EXCEPTION_ON_INVALID_TYPE

const DUMP_EXCEPTION_ON_INVALID_TYPE = 16

Référencé par Inline\dump().

DUMP_MULTI_LINE_LITERAL_BLOCK

const DUMP_MULTI_LINE_LITERAL_BLOCK = 128

Référencé par Dumper\dump().

DUMP_NULL_AS_TILDE

const DUMP_NULL_AS_TILDE = 2048

Référencé par Inline\dumpNull().

DUMP_OBJECT

const DUMP_OBJECT = 1

Référencé par Inline\dump().

DUMP_OBJECT_AS_MAP

const DUMP_OBJECT_AS_MAP = 64

Référencé par Dumper\dump(), et Inline\dump().

PARSE_CONSTANT

const PARSE_CONSTANT = 256

Référencé par Inline\initialize(), et LintCommand\validate().

PARSE_CUSTOM_TAGS

const PARSE_CUSTOM_TAGS = 512

Référencé par LintCommand\execute(), Parser\getLineTag(), et Inline\parseTag().

PARSE_DATETIME

const PARSE_DATETIME = 32

Référencé par Inline\evaluateScalar().

PARSE_EXCEPTION_ON_INVALID_TYPE

const PARSE_EXCEPTION_ON_INVALID_TYPE = 2

Référencé par Inline\initialize().

PARSE_OBJECT

const PARSE_OBJECT = 4

Référencé par Inline\initialize().

PARSE_OBJECT_FOR_MAP

const PARSE_OBJECT_FOR_MAP = 8

Référencé par Parser\doParse(), et Inline\initialize().

---

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

• symfony/yaml/Yaml.php