ftp-nlist.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: Avenger Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.ftp-nlist" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_nlist</refname>
  <refpurpose>返回给定目录的文件列表</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>ftp_nlist</methodname>
   <methodparam><type>FTP\Connection</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>
       &ftp.parameter.ftp;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>directory</parameter></term>
     <listitem>
      <para>
       指定要列表的目录。本参数接受带参数的形式，例如：<literal>ftp_nlist($ftp,
       "-la /your/dir");</literal>；注意此参数不对传入值做处理，在目录或者文件名包括空格或特殊的情况下，可能会存在问题。
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect1>
  <refsect1 role="returnvalues">
  &reftitle.returnvalues;
    <para>
     如果成功则返回给定目录下的文件名组成的数组，否则返回 &false;。
    </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &ftp.changelog.ftp-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
   &reftitle.examples;
   <para>
    <example>
     <title><function>ftp_nlist</function> 示例</title>
     <programlisting role="php">
<![CDATA[
<?php

// set up basic connection
$ftp = ftp_connect($ftp_server);
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

// check connection
if ((!$ftp) || (!$login_result)) {
    die("FTP connection has failed !");
}
 
// get contents of the root directory
$contents = ftp_nlist($ftp, "/");

// output $contents
var_dump($contents);

?>
]]>
     </programlisting>
     &example.outputs.similar;
    <screen>
<![CDATA[
array(3) {
  [0]=>
  string(11) "public_html"
  [1]=>
  string(10) "public_ftp"
  [2]=>
  string(3) "www"
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ftp_rawlist</function></member>
    <member><function>ftp_mlsd</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
-->