W3cubDocs

/Symfony 2.8

Symfony\Component\Yaml\Escaper

class Escaper

Escaper encapsulates escaping rules for single and double-quoted YAML strings.

Constants

REGEX_CHARACTER_TO_ESCAPE

Methods

static bool requiresDoubleQuoting(string $value)

Determines if a PHP value would require double quoting in YAML.

static string escapeWithDoubleQuotes(string $value)

Escapes and surrounds a PHP value with double quotes.

static bool requiresSingleQuoting(string $value)

Determines if a PHP value would require single quoting in YAML.

static string escapeWithSingleQuotes(string $value)

Escapes and surrounds a PHP value with single quotes.

Details

static public bool requiresDoubleQuoting(string $value)

Determines if a PHP value would require double quoting in YAML.

Parameters

string $value A PHP value

Return Value

bool True if the value would require double quotes.

static public string escapeWithDoubleQuotes(string $value)

Escapes and surrounds a PHP value with double quotes.

Parameters

string $value A PHP value

Return Value

string The quoted, escaped string

static public bool requiresSingleQuoting(string $value)

Determines if a PHP value would require single quoting in YAML.

Parameters

string $value A PHP value

Return Value

bool True if the value would require single quotes.

static public string escapeWithSingleQuotes(string $value)

Escapes and surrounds a PHP value with single quotes.

Parameters

string $value A PHP value

Return Value

string The quoted, escaped string

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Yaml/Escaper.html