-
Notifications
You must be signed in to change notification settings - Fork 146
/
stream-open.xml
163 lines (154 loc) · 4.88 KB
/
stream-open.xml
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a6afc9550480ad7aba8ab72d0286bd1b9ff41b04 Maintainer: dams Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="streamwrapper.stream-open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>streamWrapper::stream_open</refname>
<refpurpose>Opens file or URL</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_open</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam><type>int</type><parameter>options</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter role="reference">opened_path</parameter></methodparam>
</methodsynopsis>
<para>
Cette méthode est appelée immédiatement après l'initialisation
du gestionnaire (par exemple, par
<function>fopen</function> et <function>file_get_contents</function>).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
L'URL qui est passée à la fonction originale.
</para>
<note>
<para>
L'URL peut être découpée à l'aide de <function>parse_url</function>.
Noter que seules les URLs délimitées par :// sont supportées. : et :/,
bien que techniquement valides, ne sont pas supportés.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Le mode utilisée pour ouvrir le fichier, tel que documenté pour
<function>fopen</function>.
</para>
<note>
<para>
N'oubliez pas de vérifier si <parameter>mode</parameter> est valide
pour le chemin <parameter>path</parameter> demandé.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Contient les options supplémentaires pour le flux. Il peut contenir
une ou plusieurs constantes parmi les suivantes, combinées
par des OR.
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Option</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>STREAM_USE_PATH</constant></entry>
<entry>
Si <parameter>path</parameter> est relatif
recherche la ressource en incluant l'include_path.
</entry>
</row>
<row>
<entry><constant>STREAM_REPORT_ERRORS</constant></entry>
<entry>
Si cette option est active, vous êtes responsable
pour émettre une erreur, avec <function>trigger_error</function>
durant l'ouverture du flux. Si cette option n'est pas
activée, vous ne devez pas émettre d'erreur.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>opened_path</parameter></term>
<listitem>
<para>
Si le chemin <parameter>path</parameter> est ouvert correctement,
et que la constante <constant>STREAM_USE_PATH</constant> est configurée via
<parameter>options</parameter>, alors <parameter>opened_path</parameter>
doit contenir le chemin complet qui a été réellement ouvert.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
&userstream.not.implemented.warning;
</refsect1><!-- }}} -->
<refsect1 role="notes"><!-- {{{ -->
&reftitle.notes;
&userstream.updates.context;
</refsect1><!-- }}} -->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fopen</function></member>
<member><function>parse_url</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
-->