Class Horde_Yaml_Dumper

Description

Dump PHP data structures to YAML.

Located in /Yaml/lib/Horde/Yaml/Dumper.php (line 23)


	
			
Variable Summary
 mixed $_options
Method Summary
 string dump ( $value, [integer $options = array()], array|Traversable $array)
 string _doLiteralBlock (string $value, integer $indent)
 string _dumpNode (string $key, string $value, integer $indent)
 string _fold ($value $value,  $indent)
 string _yamlize (string $key, string|array $value, integer $indent)
 string _yamlizeArray (array $array, integer $indent)
Variables
mixed $_options = array() (line 25)
  • access: protected
Methods
dump (line 43)

Dump PHP array to YAML

The dump method, when supplied with an array, will do its best to convert the array into valid YAML.

Options: `indent`: number of spaces to indent children (default 2) `wordwrap`: wordwrap column number (default 40)

  • return: YAML representation of $value
  • access: public
string dump ( $value, [integer $options = array()], array|Traversable $array)
  • array|Traversable $array: PHP array or traversable object
  • integer $options: Options for dumping
  • $value
_doLiteralBlock (line 174)

Creates a literal block for dumping

  • access: protected
string _doLiteralBlock (string $value, integer $indent)
  • string $value
  • integer $indent: The value of the indent.
_dumpNode (line 131)

Returns YAML from a key and a value

  • access: protected
string _dumpNode (string $key, string $value, integer $indent)
  • string $key: The name of the key
  • string $value: The value of the item
  • integer $indent: The indent of the current node
_fold (line 192)

Folds a string of text, if necessary

  • access: protected
string _fold ($value $value,  $indent)
  • $value $value: The string you wish to fold
  • $indent
_yamlize (line 80)

Attempts to convert a key / value array item to YAML

  • access: protected
string _yamlize (string $key, string|array $value, integer $indent)
  • string $key: The name of the key
  • string|array $value: The value of the item
  • integer $indent: The indent of the current node
_yamlizeArray (line 110)

Attempts to convert an array to YAML

  • access: protected
string _yamlizeArray (array $array, integer $indent)
  • array $array: The array you want to convert
  • integer $indent: The indent of the current level

Documentation generated on Sun, 30 Jan 2011 05:16:58 +0000 by phpDocumentor 1.4.3