class Dumper in Plug 7

Dumper dumps PHP variables to YAML strings.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\Yaml\Dumper

2 files declare their use of Dumper

DumperTest.php in lib/Symfony/yaml/Symfony/Component/Yaml/Tests/DumperTest.php

Yaml.php in lib/Drupal/Component/Serialization/Yaml.php

Contains \Drupal\Component\Serialization\Yaml.

File

lib/Symfony/yaml/Symfony/Component/Yaml/Dumper.php, line 19

Namespace

Symfony\Component\Yaml

class Dumper {

  /**
   * The amount of spaces to use for indentation of nested nodes.
   *
   * @var int
   */
  protected $indentation = 4;

  /**
   * Sets the indentation.
   *
   * @param int $num The amount of spaces to use for indentation of nested nodes.
   */
  public function setIndentation($num) {
    $this->indentation = (int) $num;
  }

  /**
   * Dumps a PHP value to YAML.
   *
   * @param mixed $input                  The PHP value
   * @param int   $inline                 The level where you switch to inline YAML
   * @param int   $indent                 The level of indentation (used internally)
   * @param bool  $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
   * @param bool  $objectSupport          true if object support is enabled, false otherwise
   *
   * @return string The YAML representation of the PHP value
   */
  public function dump($input, $inline = 0, $indent = 0, $exceptionOnInvalidType = false, $objectSupport = false) {
    $output = '';
    $prefix = $indent ? str_repeat(' ', $indent) : '';
    if ($inline <= 0 || !is_array($input) || empty($input)) {
      $output .= $prefix . Inline::dump($input, $exceptionOnInvalidType, $objectSupport);
    }
    else {
      $isAHash = array_keys($input) !== range(0, count($input) - 1);
      foreach ($input as $key => $value) {
        $willBeInlined = $inline - 1 <= 0 || !is_array($value) || empty($value);
        $output .= sprintf('%s%s%s%s', $prefix, $isAHash ? Inline::dump($key, $exceptionOnInvalidType, $objectSupport) . ':' : '-', $willBeInlined ? ' ' : "\n", $this
          ->dump($value, $inline - 1, $willBeInlined ? 0 : $indent + $this->indentation, $exceptionOnInvalidType, $objectSupport)) . ($willBeInlined ? "\n" : '');
      }
    }
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Dumper::$indentation	protected	property	The amount of spaces to use for indentation of nested nodes.
Dumper::dump	public	function	Dumps a PHP value to YAML.
Dumper::setIndentation	public	function	Sets the indentation.