1. Documentation
  2. API
  3. Library
  4. Parse
  5. Yaml

October\Rain\Parse\Yaml

Overview

Yaml helper class

Public Methods

public parse()

public parse(string $contents): array

parse supplied YAML contents in to a PHP array.

public parseFile()

public parseFile(string $fileName): array

parseFile parses YAML file contents in to a PHP array.

public parseFileCached()

public parseFileCached(string $fileName): array

parseFileCached parses YAML file contents in to a PHP array, with cache.

public render()

public render(array $vars = [], array $options = []): string

render a PHP array to YAML format.

Supported options:

  • inline: The level where you switch to inline YAML.
  • exceptionOnInvalidType: if an exception must be thrown on invalid types.
  • objectSupport: if object support is enabled.