-
Notifications
You must be signed in to change notification settings - Fork 61
Expand file tree
/
Copy pathyaml-parse-url.xml
More file actions
127 lines (119 loc) · 4.39 KB
/
yaml-parse-url.xml
File metadata and controls
127 lines (119 loc) · 4.39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 7c1cbb3254ee96fe77b5bdf21dd3531680ef9f7b Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes Maintainer: Marqitos -->
<refentry xml:id="function.yaml-parse-url" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>yaml_parse_url</refname>
<refpurpose>Analiza una secuencia de texto Yaml desde una URL</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>yaml_parse_url</methodname>
<methodparam><type>string</type><parameter>url</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><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Convierte toda o parte de una secuencia de texto en YAML a una variable en PHP.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
La dirección <parameter>url</parameter> debe tener el formato "scheme://...". PHP
buscará el controlador de protocolos (también conocido como wrapper) para el
esquema especificado. Si no hay wrappers registrados para este protocolo, PHP lanzará
un aviso para ayudar a indentificar posibles problemas con el script y
continuar como si el nombre del fichero hiciera referencia a un fichero normal.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pos</parameter></term>
<listitem>
<para>
Documento YAML a extraer desde la secuencia de texto (<literal>-1</literal> para analizar todos
los documentos, <literal>0</literal> solo para el primer documento, etc).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ndocs</parameter></term>
<listitem>
<para>
Si se facilita <parameter>ndocs</parameter>, se completará con el
número de documentos encontrados en la secuencia de texto.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callbacks</parameter></term>
<listitem>
<para>
Controlador de contenido para los nodos YAML. Es un <type>array</type> asociativo de
etiquetas YAML => asociando sus <type>callable</type> correspondientes. Ver
<link linkend="yaml.callbacks.parse">Analizar callbacks</link> para más información
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve el valor codificado de <parameter>url</parameter> en el formato
apropiado de PHP&return.falseforfailure;. Si el valor de <parameter>pos</parameter> es <literal>-1</literal> devolverá un
<type>array</type> con una entrada por cada documento encontrado en el texto.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
El procesamiento de entradas de usuario no confiables con <function>yaml_parse_url</function>
es peligroso si el uso de <function>unserialize</function> está habilitado para
nodos que utilizan la etiqueta <literal>!php/object</literal>. Este comportamiento puede ser
deshabilitado utilizando la configuración ini <literal>yaml.decode_php</literal>.
</para>
</warning>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>yaml_parse</function></member>
<member><function>yaml_parse_file</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
-->