php-doc-en/reference/ftp/functions/ftp-mlsd.xml
Máté Kocsis 18680fd168 Generate FTP methodsynopses based on stubs
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-305.
2021-01-01 23:20:38 +01:00

204 lines
4.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ftp-mlsd" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ftp_mlsd</refname>
<refpurpose>Returns a list of files in the given directory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>ftp_mlsd</methodname>
<methodparam><type>resource</type><parameter>ftp</parameter></methodparam>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ftp</parameter></term>
<listitem>
<para>
The link identifier of the FTP connection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>directory</parameter></term>
<listitem>
<para>
The directory to be listed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of arrays with file infos from the specified directory on success or
&false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ftp_mlsd</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// set up basic connection
$conn_id = ftp_connect($ftp_server);
// login with username and password
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
// get contents of the current directory
$contents = ftp_mlsd($conn_id, ".");
// output $contents
var_dump($contents);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
array(5) {
[0]=>
array(8) {
["name"]=>
string(1) "."
["modify"]=>
string(14) "20171212154511"
["perm"]=>
string(7) "flcdmpe"
["type"]=>
string(4) "cdir"
["unique"]=>
string(11) "811U5740002"
["UNIX.group"]=>
string(2) "33"
["UNIX.mode"]=>
string(4) "0755"
["UNIX.owner"]=>
string(2) "33"
}
[1]=>
array(8) {
["name"]=>
string(2) ".."
["modify"]=>
string(14) "20171212154511"
["perm"]=>
string(7) "flcdmpe"
["type"]=>
string(4) "pdir"
["unique"]=>
string(11) "811U5740002"
["UNIX.group"]=>
string(2) "33"
["UNIX.mode"]=>
string(4) "0755"
["UNIX.owner"]=>
string(2) "33"
}
[2]=>
array(8) {
["name"]=>
string(11) "public_html"
["modify"]=>
string(14) "20171211171525"
["perm"]=>
string(7) "flcdmpe"
["type"]=>
string(3) "dir"
["unique"]=>
string(11) "811U5740525"
["UNIX.group"]=>
string(2) "33"
["UNIX.mode"]=>
string(4) "0755"
["UNIX.owner"]=>
string(2) "33"
}
[3]=>
array(8) {
["name"]=>
string(10) "public_ftp"
["modify"]=>
string(14) "20171211174536"
["perm"]=>
string(7) "flcdmpe"
["type"]=>
string(3) "dir"
["unique"]=>
string(11) "811U57405EE"
["UNIX.group"]=>
string(2) "33"
["UNIX.mode"]=>
string(4) "0755"
["UNIX.owner"]=>
string(2) "33"
}
[4]=>
array(8) {
["name"]=>
string(3) "www"
["modify"]=>
string(14) "www"
["perm"]=>
string(7) "flcdmpe"
["type"]=>
string(3) "dir"
["unique"]=>
string(11) "811U5740780"
["UNIX.group"]=>
string(2) "33"
["UNIX.mode"]=>
string(4) "0755"
["UNIX.owner"]=>
string(2) "33"
}
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ftp_rawlist</function></member>
<member><function>ftp_nlist</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
-->