Overview

Namespaces

  • Composer
    • Autoload
  • Guzzle
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Mock
    • Stream
  • Mockery
    • Adapter
      • Phpunit
    • CountValidator
    • Exception
    • Generator
      • StringManipulation
        • Pass
    • Loader
    • Matcher
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • Fatzebra
      • Message
  • PHP
  • Symfony
    • Component
      • EventDispatcher
        • Debug
        • DependencyInjection
        • Tests
          • Debug
          • DependencyInjection
      • HttpFoundation
        • File
          • Exception
          • MimeType
        • Session
          • Attribute
          • Flash
          • Storage
            • Handler
            • Proxy
        • Tests
          • File
            • MimeType
          • Session
            • Attribute
            • Flash
            • Storage
              • Handler
              • Proxy
      • Yaml
        • Exception
        • Tests

Classes

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

Class Yaml

Yaml offers convenience methods to load and dump YAML.

Namespace: Symfony\Component\Yaml
Author: Fabien Potencier fabien@symfony.com
Api
Located at Yaml.php
Methods summary
public static array
# parse( string $input, boolean $exceptionOnInvalidType = false, boolean $objectSupport = false )

Parses YAML into a PHP array.

Parses YAML into a PHP array.

The parse method, when supplied with a YAML stream (string or file), will do its best to convert YAML in a file into a PHP array. Usage:

$array = Yaml::parse('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.

Parameters

$input
Path to a YAML file or a string containing YAML
$exceptionOnInvalidType
True if an exception must be thrown on invalid types false otherwise
$objectSupport
True if object support is enabled, false otherwise

Returns

array
The YAML converted to a PHP array

Throws

Symfony\Component\Yaml\Exception\ParseException
If the YAML is not valid

Api

public static string
# dump( array $array, integer $inline = 2, integer $indent = 4, boolean $exceptionOnInvalidType = false, boolean $objectSupport = false )

Dumps a PHP array to a YAML string.

Dumps a PHP array to a YAML string.

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

Parameters

$array
PHP array
$inline
The level where you switch to inline YAML
$indent
The amount of spaces to use for indentation of nested nodes.
$exceptionOnInvalidType
true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
$objectSupport
true if object support is enabled, false otherwise

Returns

string
A YAML string representing the original PHP array

Api

Omnipay Fat Zebra / Paystream Gateway Module API Documentation API documentation generated by ApiGen