Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference spl directoryiterator #373

Merged
merged 4 commits into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions reference/spl/directoryiterator/getbasename.xml
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: KinnCoelhoJulião Status: ready -->
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: KinnCoelhoJulião -->
<refentry xml:id="directoryiterator.getbasename" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DirectoryIterator::getBasename</refname>
<refpurpose>Retorna o nome do item corrente do DirectoryIterator.</refpurpose>
<refpurpose>Retorna o nome do item corrente do DirectoryIterator</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DirectoryIterator">
<modifier>public</modifier>
<type>string</type>
<methodname>DirectoryIterator::getBasename</methodname>
<methodparam choice="opt">
<type>string</type>
<parameter>sufixo</parameter>
</methodparam>
<modifier>public</modifier> <type>string</type><methodname>DirectoryIterator::getBasename</methodname>
<methodparam choice="opt"><type>string</type><parameter>suffix</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Retorna o nome do item corrente do <classname>DirectoryIterator</classname>.
Expand Down
76 changes: 44 additions & 32 deletions reference/spl/directoryiterator/getextension.xml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 8b6d169424ff189bb563ef4c3f35f8adff3f42c5 Maintainer: KinnCoelhoJuliãoStatus: ready -->
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: KinnCoelhoJulião -->
<refentry xml:id="directoryiterator.getextension" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DirectoryIterator::getExtension</refname>
<refpurpose>Retorna a extensão do arquivo do item corrente do DirectoryIterator</refpurpose>
<refpurpose>Obtém a extensão do arquivo</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -12,14 +12,12 @@
<modifier>public</modifier>
<type>string</type>
<methodname>DirectoryIterator::getExtension</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Retorna a extensão do arquivo do item corrente do <classname>DirectoryIterator</classname>.
Recupera a extensão do arquivo.
</para>

&warn.undocumented.func;

</refsect1>

<refsect1 role="parameters">
Expand All @@ -30,55 +28,69 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A extensão do arquivo do item corrente do <classname>DirectoryIterator</classname>.
Retorna uma <type>string</type> contendo a extensão do arquivo, ou uma
<type>string</type> vazia se o arquivo não tiver extensão.
</para>
</refsect1>

<refsect1 role="examples">
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo do <methodname>DirectoryIterator::getExtension</methodname></title>
<para>
Esse exemplo irá listar as extensões dos arquivos do diretório o qual o script irá rodar.
</para>
<programlisting role="php">
<example>
<title><function>DirectoryIterator::getExtension</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dir = new DirectoryIterator(dirname(__FILE__));
foreach ($dir as $fileinfo) {
$directory = new DirectoryIterator(__DIR__);
foreach ($directory as $fileinfo) {
if ($fileinfo->isFile()) {
echo $fileinfo->getExtension() . "\n";
}
}

?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
jpg
jpg
php
php
txt
jpg
gz
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>

<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Another way of getting the extension is to use the
<function>pathinfo</function> function.
</para>
<example>
<programlisting role="php">
<![CDATA[
<?php
$extension = pathinfo($fileinfo->getFilename(), PATHINFO_EXTENSION);
?>
]]>
</programlisting>
</example>
</note>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pathinfo</function></member>
</simplelist>
</para>
<simplelist>
<member><methodname>DirectoryIterator::getFilename</methodname></member>
<member><methodname>DirectoryIterator::getBasename</methodname></member>
<member><function>pathinfo</function></member>
</simplelist>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
11 changes: 4 additions & 7 deletions reference/spl/directoryiterator/seek.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: KinnCoelhoJulião Status: ready -->
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: KinnCoelhoJulião -->
<refentry xml:id="directoryiterator.seek" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DirectoryIterator::seek</refname>
Expand All @@ -8,10 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DirectoryIterator">
<modifier>public</modifier>
<type>void</type>
<methodname>DirectoryIterator::seek</methodname>
<methodparam><type>int</type><parameter>posicao</parameter></methodparam>
<modifier>public</modifier> <type>void</type><methodname>DirectoryIterator::seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>

<para>
Expand All @@ -24,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>posicao</parameter></term>
<term><parameter>offset</parameter></term>
<listitem>
<para>
Posição de base zero para procurar.
Expand Down Expand Up @@ -80,7 +78,6 @@ if ($iterator->valid()) {
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
6 changes: 2 additions & 4 deletions reference/spl/directoryiterator/tostring.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: KinnCoelhoJulião Status: ready -->
<!-- EN-Revision: bfef87dc15cdab5c438e716cd939b75e6ee5d4f5 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: KinnCoelhoJulião -->
<refentry xml:id="directoryiterator.tostring" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DirectoryIterator::__toString</refname>
Expand All @@ -9,9 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DirectoryIterator">
<modifier>public</modifier>
<type>string</type>
<methodname>DirectoryIterator::__toString</methodname>
<modifier>public</modifier> <type>string</type><methodname>DirectoryIterator::__toString</methodname>
<void/>
</methodsynopsis>

Expand Down