mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
bd4e76401d
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@294758 c90b9560-bf6c-de11-be94-00142212c4b1
110 lines
3.2 KiB
XML
110 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.yaml-parse-file" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>yaml_parse_file</refname>
|
|
<refpurpose>Parse a YAML stream from a file</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>yaml_parse_file</methodname>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>pos</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter role="reference">ndocs</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>callbacks</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Convert all or part of a YAML document stream read from a file to a PHP variable.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>filename</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Path to the file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pos</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Document to extract from stream (<literal>-1</literal> for all
|
|
documents, <literal>0</literal> for first document, ...).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>ndocs</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If <parameter>ndocs</parameter> is provided, then it is filled with the
|
|
number of documents found in stream.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>callbacks</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Content handlers for YAML nodes. Associative <type>array</type> of YAML
|
|
tag => <type>callback</type> mappings.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the value encoded in <parameter>input</parameter> in appropriate
|
|
PHP type. &null; is returned if the <parameter>input</parameter> cannot be
|
|
decoded. If <parameter>pos</parameter> is <literal>-1</literal> an
|
|
<type>array</type> will be returned with one entry for each document found
|
|
in the stream.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>yaml_parse</function></member>
|
|
<member><function>yaml_parse_url</function></member>
|
|
<member><function>yaml_emit</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|