Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • Dumper
  • Escaper
  • Inline
  • Parser
  • Unescaper
  • Yaml
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class Escaper

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

Namespace: Symfony\Component\Yaml
Author: Matthew Lewinski <matthew@lewinski.org>
Located at yaml/Symfony/Component/Yaml/Escaper.php
Methods summary
public static Boolean
# requiresDoubleQuoting( string $value )

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

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

Parameters

$value
string
$value A PHP value

Returns

Boolean
True if the value would require double quotes.
public static string
# escapeWithDoubleQuotes( string $value )

Escapes and surrounds a PHP value with double quotes.

Escapes and surrounds a PHP value with double quotes.

Parameters

$value
string
$value A PHP value

Returns

string
The quoted, escaped string
public static Boolean
# requiresSingleQuoting( string $value )

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

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

Parameters

$value
string
$value A PHP value

Returns

Boolean
True if the value would require single quotes.
public static string
# escapeWithSingleQuotes( string $value )

Escapes and surrounds a PHP value with single quotes.

Escapes and surrounds a PHP value with single quotes.

Parameters

$value
string
$value A PHP value

Returns

string
The quoted, escaped string
Constants summary
string REGEX_CHARACTER_TO_ESCAPE "[\\x00-\\x1f]|\xc2\x85|\xc2\xa0|\xe2\x80\xa8|\xe2\x80\xa9"
#
php-coveralls API documentation generated by ApiGen 2.8.0