Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Dumper.php

function Dumper::dump

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-mask-of<Yaml::DUMP_*> $flags A bit field of Yaml::DUMP_* constants to customize the dumped YAML string:

1 call to Dumper::dump()
Dumper::dumpTaggedValue in vendor/symfony/yaml/Dumper.php

File

vendor/symfony/yaml/Dumper.php, line 43

Class

Dumper
Dumper dumps PHP variables to YAML strings.

Namespace

Symfony\Component\Yaml

Code

public function dump(mixed $input, int $inline = 0, int $indent = 0, int $flags = 0) : string {
    $output = '';
    $prefix = $indent ? str_repeat(' ', $indent) : '';
    $dumpObjectAsInlineMap = true;
    if (Yaml::DUMP_OBJECT_AS_MAP & $flags && ($input instanceof \ArrayObject || $input instanceof \stdClass)) {
        $dumpObjectAsInlineMap = !(array) $input;
    }
    if ($inline <= 0 || !\is_array($input) && !$input instanceof TaggedValue && $dumpObjectAsInlineMap || !$input) {
        $output .= $prefix . Inline::dump($input, $flags);
    }
    elseif ($input instanceof TaggedValue) {
        $output .= $this->dumpTaggedValue($input, $inline, $indent, $flags, $prefix);
    }
    else {
        $dumpAsMap = Inline::isHash($input);
        foreach ($input as $key => $value) {
            if ('' !== $output && "\n" !== $output[-1]) {
                $output .= "\n";
            }
            if (\is_int($key) && Yaml::DUMP_NUMERIC_KEY_AS_STRING & $flags) {
                $key = (string) $key;
            }
            if (Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK & $flags && \is_string($value) && str_contains($value, "\n") && !str_contains($value, "\r")) {
                $blockIndentationIndicator = $this->getBlockIndentationIndicator($value);
                if (isset($value[-2]) && "\n" === $value[-2] && "\n" === $value[-1]) {
                    $blockChompingIndicator = '+';
                }
                elseif ("\n" === $value[-1]) {
                    $blockChompingIndicator = '';
                }
                else {
                    $blockChompingIndicator = '-';
                }
                $output .= \sprintf('%s%s%s |%s%s', $prefix, $dumpAsMap ? Inline::dump($key, $flags) . ':' : '-', '', $blockIndentationIndicator, $blockChompingIndicator);
                foreach (explode("\n", $value) as $row) {
                    if ('' === $row) {
                        $output .= "\n";
                    }
                    else {
                        $output .= \sprintf("\n%s%s%s", $prefix, str_repeat(' ', $this->indentation), $row);
                    }
                }
                continue;
            }
            if ($value instanceof TaggedValue) {
                $output .= \sprintf('%s%s !%s', $prefix, $dumpAsMap ? Inline::dump($key, $flags) . ':' : '-', $value->getTag());
                if (Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK & $flags && \is_string($value->getValue()) && str_contains($value->getValue(), "\n") && !str_contains($value->getValue(), "\r\n")) {
                    $blockIndentationIndicator = $this->getBlockIndentationIndicator($value->getValue());
                    $output .= \sprintf(' |%s', $blockIndentationIndicator);
                    foreach (explode("\n", $value->getValue()) as $row) {
                        $output .= \sprintf("\n%s%s%s", $prefix, str_repeat(' ', $this->indentation), $row);
                    }
                    continue;
                }
                if ($inline - 1 <= 0 || null === $value->getValue() || \is_scalar($value->getValue())) {
                    $output .= ' ' . $this->dump($value->getValue(), $inline - 1, 0, $flags) . "\n";
                }
                else {
                    $output .= "\n";
                    $output .= $this->dump($value->getValue(), $inline - 1, $dumpAsMap ? $indent + $this->indentation : $indent + 2, $flags);
                }
                continue;
            }
            $dumpObjectAsInlineMap = true;
            if (Yaml::DUMP_OBJECT_AS_MAP & $flags && ($value instanceof \ArrayObject || $value instanceof \stdClass)) {
                $dumpObjectAsInlineMap = !(array) $value;
            }
            $willBeInlined = $inline - 1 <= 0 || !\is_array($value) && $dumpObjectAsInlineMap || !$value;
            $output .= \sprintf('%s%s%s%s', $prefix, $dumpAsMap ? Inline::dump($key, $flags) . ':' : '-', $willBeInlined ? ' ' : "\n", $this->dump($value, $inline - 1, $willBeInlined ? 0 : $indent + $this->indentation, $flags)) . ($willBeInlined ? "\n" : '');
        }
    }
    return $output;
}

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal