Files
2025-06-02 16:50:51 -03:00

138 lines
4.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: fernandowobeto -->
<refentry xml:id="splfileobject.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileObject::__construct</refname>
<refpurpose>Constrói um novo objeto de arquivo</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="SplFileObject">
<modifier>public</modifier> <methodname>SplFileObject::__construct</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>mode</parameter><initializer>"r"</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>useIncludePath</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
</constructorsynopsis>
<para>
Constrói um novo objeto de arquivo.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
O arquivo para ler.
</para>
&tip.fopen-wrapper;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
O modo no qual abrir o arquivo. Consulte <function>fopen</function> para obter uma lista de modos permitidos.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>useIncludePath</parameter></term>
<listitem>
<para>
Se deve procurar no <link linkend="ini.include-path">include_path</link> pelo <parameter>filename</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
Um recurso de contexto válido criado com <function>stream_context_create</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Lança uma <classname>RuntimeException</classname> se o <parameter>filename</parameter> não puder ser aberto.
</para>
<para>
Lança uma <classname>LogicException</classname> se o <parameter>filename</parameter> for um diretório.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo de <methodname>SplFileObject::__construct</methodname></title>
<para>
Este exemplo abre o arquivo atual e itera sobre seu conteúdo linha por linha.
</para>
<programlisting role="php">
<![CDATA[
<?php
$file = new SplFileObject(__FILE__);
foreach ($file as $line_num => $line) {
echo "Linha $line_num é $line";
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Linha 0 é <?php
Linha 1 é $file = new SplFileObject(__FILE__);
Linha 2 é foreach ($file as $line_num => $line) {
Linha 3 é echo "Linha $line_num é $line";
Linha 4 é }
Linha 5 é ?>
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SplFileInfo::openFile</methodname></member>
<member><function>fopen</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
-->