Home > PHP > Function > Yaml > yaml_emit()

yaml_emit()

yaml_emit - Returns the YAML representation of a value

Syntax

string yaml_emit (mixed $data, int $encoding, int $linebreak)

Arguments

  • data - The data being encoded. Can be any type except a resource.
  • encoding - Output character encoding chosen from YAML_ANY_ENCODING, YAML_UTF8_ENCODING, YAML_UTF16LE_ENCODING, YAML_UTF16BE_ENCODING. Defaults to YAML_ANY_ENCODING.
  • linebreak - Output linebreak style chosen from YAML_ANY_BREAK, YAML_CR_BREAK, YAML_LN_BREAK, YAML_CRLN_BREAK. Defaults to YAML_ANY_BREAK.

Description

Generate a YAML representation of the provided data.

Version

PHP PECL yaml >= 0.5.0

Return value

Returns a YAML encoded string on success.