Files
doc-fr/reference/stream/streamwrapper/url-stat.xml

178 lines
6.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c79b9928aa114777d864b9c70feb1436d7344b4d Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="streamwrapper.url-stat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>streamWrapper::url_stat</refname>
<refpurpose>Lit les informations sur un fichier</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>streamWrapper::url_stat</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Cette méthode est appelée en réponse à toutes les fonctions
liées à <function>stat</function>, telles que :
<simplelist>
<member><function>copy</function></member>
<member><function>fileperms</function></member>
<member><function>fileinode</function></member>
<member><function>filesize</function></member>
<member><function>fileowner</function></member>
<member><function>filegroup</function></member>
<member><function>fileatime</function></member>
<member><function>filemtime</function></member>
<member><function>filectime</function></member>
<member><function>filetype</function></member>
<member><function>is_writable</function></member>
<member><function>is_readable</function></member>
<member><function>is_executable</function></member>
<member><function>is_file</function></member>
<member><function>is_dir</function></member>
<member><function>is_link</function></member>
<member><function>file_exists</function></member>
<member><function>lstat</function></member>
<member><function>stat</function></member>
<member><methodname>SplFileInfo::getPerms</methodname></member>
<member><methodname>SplFileInfo::getInode</methodname></member>
<member><methodname>SplFileInfo::getSize</methodname></member>
<member><methodname>SplFileInfo::getOwner</methodname></member>
<member><methodname>SplFileInfo::getGroup</methodname></member>
<member><methodname>SplFileInfo::getATime</methodname></member>
<member><methodname>SplFileInfo::getMTime</methodname></member>
<member><methodname>SplFileInfo::getCTime</methodname></member>
<member><methodname>SplFileInfo::getType</methodname></member>
<member><methodname>SplFileInfo::isWritable</methodname></member>
<member><methodname>SplFileInfo::isReadable</methodname></member>
<member><methodname>SplFileInfo::isExecutable</methodname></member>
<member><methodname>SplFileInfo::isFile</methodname></member>
<member><methodname>SplFileInfo::isDir</methodname></member>
<member><methodname>SplFileInfo::isLink</methodname></member>
<member><methodname>RecursiveDirectoryIterator::hasChildren</methodname></member>
</simplelist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
Le chemin du fichier ou l'URL à analyser. Noter que dans le cas des URLs,
elles doivent être délimitées par ://. Tout autre format n'est pas supporté.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Les options supplémentaires activées par l'API des flux.
Elle peut contenir une ou plusieurs constantes des constantes
suivantes, combinées par OR :
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Option</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>STREAM_URL_STAT_LINK</entry>
<entry>
Pour les ressources qui ont la capacité de se lier
à d'autres ressources (comme une redirection HTTP
ou bien un lien symbolique). Cette option indique
que les informations lues doivent concerner le lien
lui-même, et non pas la ressource pointée par le lien.
Cette option est activée en réponse à un appel à
<function>lstat</function>, <function>is_link</function>
ou <function>filetype</function>.
</entry>
</row>
<row>
<entry>STREAM_URL_STAT_QUIET</entry>
<entry>
Si cette option est activée, votre gestionnaire ne
doit pas émettre d'erreurs. Si cette option n'est pas
activée, vous êtes responsables du rapport d'erreur,
en appelant la fonction <function>trigger_error</function>
durant l'analyse du chemin.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Doit retourner un &array; avec autant d'éléments que <function>stat</function> retourne.
Les valeurs inconnues ou indisponibles doivent prendre une valeur
raisonnable (généralement, <constant>0</constant>). Portez une attention
particulière à <literal>mode</literal> comme documenté sous
<function>stat</function>.
Doit retourner &false; en cas d'échec.
</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>stat</function></member>
<member><methodname>streamwrapper::stream_stat</methodname></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
-->