yaml_emit
(PECL yaml >= 0.5.0)
yaml_emit — Returns the YAML representation of a value
Description
$data
[, int $encoding
= YAML_ANY_ENCODING
[, int $linebreak
= YAML_ANY_BREAK
[, array $callbacks
= NULL
]]] ) : string
Generate a YAML representation of the provided data
.
Parameters
-
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
. -
linebreak
-
Output linebreak style chosen from
YAML_ANY_BREAK
,YAML_CR_BREAK
,YAML_LN_BREAK
,YAML_CRLN_BREAK
. -
callbacks
-
Content handlers for emitting YAML nodes. Associative array of classname => callable mappings. See emit callbacks for more details.
Examples
Example #1 yaml_emit() example
<?php
$addr = array(
"given" => "Chris",
"family"=> "Dumars",
"address"=> array(
"lines"=> "458 Walkman Dr.
Suite #292",
"city"=> "Royal Oak",
"state"=> "MI",
"postal"=> 48046,
),
);
$invoice = array (
"invoice"=> 34843,
"date"=> 980208000,
"bill-to"=> $addr,
"ship-to"=> $addr,
"product"=> array(
array(
"sku"=> "BL394D",
"quantity"=> 4,
"description"=> "Basketball",
"price"=> 450,
),
array(
"sku"=> "BL4438H",
"quantity"=> 1,
"description"=> "Super Hoop",
"price"=> 2392,
),
),
"tax"=> 251.42,
"total"=> 4443.52,
"comments"=> "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.",
);
var_dump(yaml_emit($invoice));
?>
The above example will output something similar to:
string(628) "--- invoice: 34843 date: 980208000 bill-to: given: Chris family: Dumars address: lines: |- 458 Walkman Dr. Suite #292 city: Royal Oak state: MI postal: 48046 ship-to: given: Chris family: Dumars address: lines: |- 458 Walkman Dr. Suite #292 city: Royal Oak state: MI postal: 48046 product: - sku: BL394D quantity: 4 description: Basketball price: 450 - sku: BL4438H quantity: 1 description: Super Hoop price: 2392 tax: 251.420000 total: 4443.520000 comments: Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338. ... "
See Also
- yaml_emit_file() - Send the YAML representation of a value to a file
- yaml_parse() - Parse a YAML stream
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-yaml-emit.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.