archived-doc-ru/reference/stream/streamwrapper/url-stat.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c79b9928aa114777d864b9c70feb1436d7344b4d Maintainer: tmn 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>Получение информации о файле</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>
   Этот метод вызывается в процессе выполнения любой из
   <function>stat</function> функций, таких как:
   <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>
       Путь к файлу или его URL. Помните, что URL должен быть отделен символами
       :// , другие формы URL не поддерживаются.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Хранит дополнительные флаги, установленные API потоков. Может хранить одно
       или несколько приведённых ниже значений, объединённых операцией ИЛИ.
       <informaltable>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Флаг</entry>
           <entry>Описание</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>STREAM_URL_STAT_LINK</entry>
           <entry>
            Для ресурсов, которые могут ссылаться на другие ресурсы
            (как например HTTP Location: forward, или символические ссылки
            файловой системы). Этот флаг указывает, что возвращаемая
            информация относится к самой ссылке, а не к ресурсу, на который
            она указывает. Этот используется при вызове функций
            <function>lstat</function>, <function>is_link</function>
            или <function>filetype</function>.
           </entry>
          </row>
          <row>
           <entry>STREAM_URL_STAT_QUIET</entry>
           <entry>
            Если флаг установлен, обёртка не должна вызывать никаких
            ошибок. Если нет, можно вызывать сообщения об ошибках с
            помощью функции <function>trigger_error</function>.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </informaltable>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Должен возвращаться массив (&array;) с теми же элементами, что и в <function>stat</function>. Неизвестные или недоступные значения
   необходимо приводить к разумным значениям
   (обычно к <constant>0</constant>). Обратите особое внимание на <literal>mode</literal>, как описано в разделе <function>stat</function>.
   В случае возникновения ошибки возвращает &false;.
  </para>
 </refsect1>

 <refsect1 role="errors"><!-- {{{ -->
  &reftitle.errors;
  &userstream.not.implemented.warning;
 </refsect1><!-- }}} -->

 <!-- {{{
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>streamWrapper::url_stat</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
...
]]>
    </screen>
   </example>
  </para>
 </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
-->