Symfony\Component\Yaml\Dumper Class Reference

Dumper dumps PHP variables to YAML strings. More...

Collaboration diagram for Symfony\Component\Yaml\Dumper:

Public Member Functions
	__construct ($indentation=4)
	setIndentation ($num)
	Sets the indentation. More...
	dump ($input, $inline=0, $indent=0, $flags=0)
	Dumps a PHP value to YAML. More...

Protected Attributes
	$indentation

Detailed Description

Dumper dumps PHP variables to YAML strings.

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 19 of file Dumper.php.

Constructor & Destructor Documentation

__construct()

Symfony\Component\Yaml\Dumper::__construct

(

$indentation = 4

)

Parameters

int

$indentation

Definition at line 31 of file Dumper.php.

References Symfony\Component\Yaml\Dumper\$indentation.

    {
        if ($indentation < 1) {
            throw new \InvalidArgumentException('The indentation must be greater than zero.');
        }

        $this->indentation = $indentation;
    }

Member Function Documentation

dump()

Symfony\Component\Yaml\Dumper::dump	(		$input,
			$inline = 0,
			$indent = 0,
			$flags = 0
	)

Dumps a PHP value to YAML.

Parameters

mixed	$input	The PHP value
int	$inline	The level where you switch to inline YAML
int	$indent	The level of indentation (used internally)
int	$flags	A bit field of Yaml::DUMP_* constants to customize the dumped YAML string

Returns

string The YAML representation of the PHP value

Definition at line 62 of file Dumper.php.

References $output, $row, Symfony\Component\Yaml\Inline\dump(), Symfony\Component\Yaml\Yaml\DUMP_EXCEPTION_ON_INVALID_TYPE, Symfony\Component\Yaml\Yaml\DUMP_MULTI_LINE_LITERAL_BLOCK, Symfony\Component\Yaml\Yaml\DUMP_OBJECT, and Symfony\Component\Yaml\Inline\isHash().

    {
        if (is_bool($flags)) {
            @trigger_error('Passing a boolean flag to toggle exception handling is deprecated since version 3.1 and will be removed in 4.0. Use the Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE flag instead.', E_USER_DEPRECATED);

            if ($flags) {
                $flags = Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE;
            } else {
                $flags = 0;
            }
        }

        if (func_num_args() >= 5) {
            @trigger_error('Passing a boolean flag to toggle object support is deprecated since version 3.1 and will be removed in 4.0. Use the Yaml::DUMP_OBJECT flag instead.', E_USER_DEPRECATED);

            if (func_get_arg(4)) {
                $flags |= Yaml::DUMP_OBJECT;
            }
        }

        $output = '';
        $prefix = $indent ? str_repeat(' ', $indent) : '';

        if ($inline <= 0 || !is_array($input) || empty($input)) {
            $output .= $prefix.Inline::dump($input, $flags);
        } else {
            $isAHash = Inline::isHash($input);

            foreach ($input as $key => $value) {
                if ($inline > 1 && Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK & $flags && is_string($value) && false !== strpos($value, "\n")) {
                    $output .= sprintf("%s%s%s |\n", $prefix, $isAHash ? Inline::dump($key, $flags).':' : '-', '');

                    foreach (preg_split('/\n|\r\n/', $value) as $row) {
                        $output .= sprintf("%s%s%s\n", $prefix, str_repeat(' ', $this->indentation), $row);
                    }

                    continue;
                }

                $willBeInlined = $inline - 1 <= 0 || !is_array($value) || empty($value);

                $output .= sprintf('%s%s%s%s',
                    $prefix,
                    $isAHash ? Inline::dump($key, $flags).':' : '-',
                    $willBeInlined ? ' ' : "\n",
                    $this->dump($value, $inline - 1, $willBeInlined ? 0 : $indent + $this->indentation, $flags)
                ).($willBeInlined ? "\n" : '');
            }
        }

        return $output;
    }

Here is the call graph for this function:

setIndentation()

Symfony\Component\Yaml\Dumper::setIndentation

(

$num

)

Sets the indentation.

Parameters

int

$num

The amount of spaces to use for indentation of nested nodes

Definition at line 45 of file Dumper.php.

    {
        @trigger_error('The '.__METHOD__.' method is deprecated since version 3.1 and will be removed in 4.0. Pass the indentation to the constructor instead.', E_USER_DEPRECATED);

        $this->indentation = (int) $num;
    }

Field Documentation

$indentation

Symfony\Component\Yaml\Dumper::$indentation

protected

Definition at line 26 of file Dumper.php.

Referenced by Symfony\Component\Yaml\Dumper\__construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/symfony/yaml/Dumper.php