Files
archived-doc-pt-br/reference/stream/streamwrapper.xml
2024-06-14 17:02:15 +01:00

135 lines
4.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ecaa2146429a7f88de40dfce14718afc896b74c5 Maintainer: leonardolara Status: ready -->
<reference xml:id="class.streamwrapper" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>A classe streamWrapper</title>
<titleabbrev>streamWrapper</titleabbrev>
<partintro>
<!-- {{{ streamWrapper intro -->
<section xml:id="streamwrapper.intro">
&reftitle.intro;
<para>
Permite que o usuário implemente seus próprios fluxos e manipuladores de protocolo para
uso com todas as outras funções de sistema de arquivos (como <function>fopen</function>,
<function>fread</function> etc.).
</para>
<note>
<para>
Esta <emphasis>NÃO É</emphasis> uma classe verdadeira, apenas um protótipo de como
uma classe que define seu próprio protocolo deve ser.
</para>
</note>
<note>
<para>
Implementar os métodos de forma diferente da descrita aqui pode levar a
comportamentos indefinidos.
</para>
</note>
<para>
Uma instância desta classe é inicializada assim que uma função de fluxo
tenta acessar o protocolo ao qual está associada.
</para>
</section>
<!-- }}} -->
<section xml:id="streamwrapper.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>streamWrapper</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname><replaceable>streamWrapper</replaceable></classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>resource</type>
<varname linkend="streamwrapper.props.context">context</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.streamwrapper')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.streamwrapper')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.streamwrapper')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ streamWrapper properties -->
<section xml:id="streamwrapper.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="streamwrapper.props.context">
<term>resource <varname>context</varname></term>
<listitem>
<para>
O <link linkend="context">contexto</link> atual, ou &null; se nenhum
contexto foi passado à função chamadora.
</para>
<para>
Use a função <function>stream_context_get_options</function> para analisar o
contexto.
</para>
<note>
<para>
Esta propriedade <emphasis>deve</emphasis> ser pública para que o PHP possa
preenchê-la com o recurso de contexto real.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<section role="seealso"><!-- {{{ -->
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="stream.streamwrapper.example-1" /></member>
<member><function>stream_wrapper_register</function></member>
<member><function>stream_wrapper_unregister</function></member>
<member><function>stream_wrapper_restore</function></member>
</simplelist>
</para>
</section><!-- }}} -->
</partintro>
&reference.stream.entities.streamwrapper;
</reference>
<!-- 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
-->