archived-doc-pt-br/reference/stream/streamwrapper/url-stat.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f80105b4fc1196bd8d5fecb98d686b580b1ff65d Maintainer: leonardolara Status: ready -->

<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>Obtém informação sobre um arquivo</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>
   Este método é chamado em resposta a todas as funções relacionadas a <function>stat</function>,
   como:
   <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>
       O caminho ou URL do arquivo a explorar. Note que no caso de uma URL, ela deve ser delimitada com ://.
       Outras formas de URL não são suportadas.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Contém opções adicionais configuradas pela API de fluxos. Pode conter uma ou mais
       dos valores a seguir somados (com a operação OR).
       <informaltable>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Opção</entry>
           <entry>Descrição</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>STREAM_URL_STAT_LINK</entry>
           <entry>
            Para recursos com a habilidade de criar atalho a outro recurso
            (como um redirecionamento HTTP ou uma ligação simbólica do sistema
            de arquivos). Esta opção especifica que apenas informação sobre o
            atalho em si deve ser retornada, e não
            sobre o recurso apontado pelo atalho. Esta função é definida em resposta a
            chamadas a <function>lstat</function>,
            <function>is_link</function> ou <function>filetype</function>.
           </entry>
          </row>
          <row>
           <entry>STREAM_URL_STAT_QUIET</entry>
           <entry>Se esta opção for definida, o empacotador não deve emitir
            erros. Se a opção não for definida, o programador é responsável por
            reportar erros usando a função <function>trigger_error</function>
            durante a obtenção de informações sobre o arquivo.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </informaltable>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Deve retornar um &array; com os mesmos elementdos que <function>stat</function> retorna.
   Valores desconhecidos ou indisponíveis devem ser definidos para um valor racional
   (normalmente <literal>0</literal>). Atenção especial deve ser prestada ao
   <literal>mode</literal> como documentado na função <function>stat</function>.
   Deve retornar &false; em caso de falha.
  </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
-->