Ref/dir-Phpdoc专题

相关函数，例如：dirname、 <span class="function">is_dir、 mkdir 和 rmdir， 请查看文件系统章节。

chdir

改变目录

说明

bool chdir ( string $directory )

将 PHP 的当前目录改为 directory。

参数

directory
新的当前目录

返回值

成功时返回 true， 或者在失败时返回 false。

错误／异常

Throws an error of level E_WARNING on failure.

范例

示例 #1 chdir 例子

<?php

// current directory
echo getcwd() . "\n";

chdir('public_html');

// current directory
echo getcwd() . "\n";

?>

以上例程的输出类似于：

/home/vincent
/home/vincent/public_html

注释

Caution

If the PHP interpreter has been built with ZTS (Zend Thread Safety) enabled, any changes to the current directory made through <span class="function">chdir will be invisible to the operating system. All built-in PHP functions will still respect the change in current directory; but external library functions called using FFI will not. You can tell whether your copy of PHP was built with ZTS enabled using php -i or the built-in constant PHP_ZTS.

参见

  • getcwd

chroot

改变根目录

说明

bool chroot ( string $directory )

将当前进程的根目录改变为 directory。

本函数仅在系统支持且运行于 CLI，CGI 或嵌入 SAPI 版本时才能正确工作。此外本函数还需要 root 权限。

参数

directory
新目录

返回值

成功时返回 true， 或者在失败时返回 false。

范例

示例 #1 chroot example

<?php
chroot("/path/to/your/chroot/");
echo getcwd();
?>

以上例程会输出：

/

注释

Note: 此函数未在 Windows 平台下实现。

closedir

关闭目录句柄

说明

void closedir ([ resource $dir_handle ] )

关闭由 dir_handle 指定的目录流。流必须之前被 <span class="function">opendir 所打开。

参数

dir_handle
目录句柄的 resource，之前由 <span class="function">opendir 所打开的。如果目录句柄没有指定，那么会假定为是<span class="function">opendir所打开的最后一个句柄。

范例

示例 #1 closedir 例子

<?php
$dir = "/etc/php5/";

// Open a known directory, read directory into variable and then close
if (is_dir($dir)) {
    if ($dh = opendir($dir)) {
        $directory = readdir($dh);
        closedir($dh);
    }
}
?>

dir

返回一个 Directory 类实例

说明

Directory dir ( string $directory [, <span class="type">resource $context ] )

以面向对象的方式访问目录。打开 directory 参数指定的目录。

参数

directory
被打开的目录

context

Note: 在 PHP 5.0.0 中增加了对上下文（Context）的支持。有关上下文（Context）的说明参见 Streams。

返回值

成功的话，返回一个 Directory 类实例, 参数错误的情况下返回 null ， 其它错误情况返回 false 。

范例

示例 #1 dir 示例

请特别注意下面示例中 Directory::read 函数返回值的判断方式。 我们严格测试（值相等，并且类型相同，请参考 比较运算符 ）返回值等于 false ，因为有些情况下，目录名可能"等于" false ，导致 跳出循环。

<?php
$d = dir("/etc/php5");
echo "Handle: " . $d->handle . "\n";
echo "Path: " . $d->path . "\n";
while (false !== ($entry = $d->read())) {
   echo $entry."\n";
}
$d->close();
?>

以上例程的输出类似于：

Handle: Resource id #2
Path: /etc/php5
.
..
apache
cgi
cli

注释

Note:

目录条目返回的顺序依赖于系统。

getcwd

取得当前工作目录

说明

string getcwd ( void )

取得当前工作目录。

返回值

成功则返回当前工作目录，失败返回 false。

在某些 Unix 的变种下，如果任何父目录没有设定可读或搜索模式，即使当前目录设定了，<span class="function">getcwd 还是会返回 false。有关模式与权限的更多信息见 <span class="function">chmod。

范例

示例 #1 getcwd 例子

<?php

// current directory
echo getcwd() . "\n";

chdir('cvs');

// current directory
echo getcwd() . "\n";

?>

以上例程的输出类似于：

/home/didou
/home/didou/cvs

参见

  • chdir
  • chmod

opendir

打开目录句柄

说明

resource <span class="methodname">opendir ( <span class="type">string $path [, <span class="methodparam">resource $context ] )

打开一个目录句柄，可用于之后的 <span class="function">closedir，readdir 和 rewinddir 调用中。

参数

path
要打开的目录路径

context
context 参数的说明见手册中的 Streams API 一章。

返回值

如果成功则返回目录句柄的 resource，失败则返回 false。

如果 path 不是一个合法的目录或者因为权限限制或文件系统错误而不能打开目录，<span class="function">opendir 返回 false 并产生一个 E_WARNING 级别的 PHP 错误信息。可以在 opendir 前面加上“@”符号来抑制错误信息的输出。

更新日志

版本 说明
5.0.0 path 支持 ftp:// URL wrapper
4.3.0 path 可以是任何支持目录列表的 URL，不过在 PHP 4 中只有 file:// URL wrapper 支持此功能

范例

示例 #1 opendir 例子

<?php
$dir = "/etc/php5/";

// Open a known directory, and proceed to read its contents
if (is_dir($dir)) {
    if ($dh = opendir($dir)) {
        while (($file = readdir($dh)) !== false) {
            echo "filename: $file : filetype: " . filetype($dir . $file) . "\n";
        }
        closedir($dh);
    }
}
?>

以上例程的输出类似于：

filename: . : filetype: dir
filename: .. : filetype: dir
filename: apache : filetype: dir
filename: cgi : filetype: dir
filename: cli : filetype: dir

参见

  • is_dir
  • readdir
  • dir

readdir

从目录句柄中读取条目

说明

string readdir ([ resource $dir_handle ] )

返回目录中下一个文件的文件名。文件名以在文件系统中的排序返回。

参数

dir_handle
目录句柄的 resource，之前由 <span class="function">opendir 打开

返回值

成功则返回文件名 或者在失败时返回 false

Warning

此函数可能返回布尔值 false，但也可能返回等同于 false 的非布尔值。请阅读 布尔类型章节以获取更多信息。应使用 === 运算符来测试此函数的返回值。

范例

示例 #1 列出目录中的所有文件

请留意下面例子中检查 readdir 返回值的风格。这里明确地测试返回值是否全等于（值和类型都相同——更多信息参见比较运算符）false，否则任何目录项的名称求值为 false 的都会导致循环停止（例如一个目录名为“0”）。

<?php
// 注意在 4.0.0-RC2 之前不存在 !== 运算符

if ($handle = opendir('/path/to/files')) {
    echo "Directory handle: $handle\n";
    echo "Files:\n";

    /* 这是正确地遍历目录方法 */
    while (false !== ($file = readdir($handle))) {
        echo "$file\n";
    }

    /* 这是错误地遍历目录的方法 */
    while ($file = readdir($handle)) {
        echo "$file\n";
    }

    closedir($handle);
}
?>

示例 #2 列出当前目录的所有文件并去掉 . 和 ..

<?php
if ($handle = opendir('.')) {
    while (false !== ($file = readdir($handle))) {
        if ($file != "." && $file != "..") {
            echo "$file\n";
        }
    }
    closedir($handle);
}
?>

参见

  • is_dir
  • glob
  • opendir
  • scandir

rewinddir

倒回目录句柄

说明

void rewinddir ( resource $dir_handle )

将 dir_handle 指定的目录流重置到目录的开头。

参数

dir_handle
目录句柄的 resource，之前由 <span class="function">opendir 打开

scandir

列出指定路径中的文件和目录

说明

array scandir ( string $directory [, <span class="type">int $sorting_order [, <span class="methodparam">resource $context ]] )

返回一个 array，包含有 directory 中的文件和目录。

参数

directory
要被浏览的目录

sorting_order
默认的排序顺序是按字母升序排列。如果使用了可选参数 sorting_order（设为 1），则排序顺序是按字母降序排列。

context
context 参数的说明见手册中的 Streams API 一章。

返回值

成功则返回包含有文件名的 array，如果失败则返回 false。如果 directory 不是个目录，则返回布尔值 false 并生成一条 E_WARNING 级的错误。

更新日志

版本 说明
5.4.0 sorting_order now accepts constants. Any nonzero value caused descending order in previous versions.

范例

示例 #1 一个简单的 scandir 例子

<?php
$dir    = '/tmp';
$files1 = scandir($dir);
$files2 = scandir($dir, 1);

print_r($files1);
print_r($files2);
?>

以上例程的输出类似于：

Array
(
    [0] => .
    [1] => ..
    [2] => bar.php
    [3] => foo.txt
    [4] => somedir
)
Array
(
    [0] => somedir
    [1] => foo.txt
    [2] => bar.php
    [3] => ..
    [4] => .
)

示例 #2 scandir 在 PHP 4 中的实现

<?php
$dir = "/tmp";
$dh  = opendir($dir);
while (false !== ($filename = readdir($dh))) {
    $files[] = $filename;
}

sort($files);

print_r($files);

rsort($files);

print_r($files);

?>

以上例程的输出类似于：

Array
(
    [0] => .
    [1] => ..
    [2] => bar.php
    [3] => foo.txt
    [4] => somedir
)
Array
(
    [0] => somedir
    [1] => foo.txt
    [2] => bar.php
    [3] => ..
    [4] => .
)

注释

小贴士

如已启用fopen 包装器，在此函数中， URL 可作为文件名。关于如何指定文件名详见 <span class="function">fopen。各种 wapper 的不同功能请参见 支持的协议和封装协议，注意其用法及其可提供的预定义变量。

参见

  • opendir
  • readdir
  • glob
  • is_dir
  • sort

目录

  • chdir — 改变目录
  • chroot — 改变根目录
  • closedir — 关闭目录句柄
  • dir — 返回一个 Directory 类实例
  • getcwd — 取得当前工作目录
  • opendir — 打开目录句柄
  • readdir — 从目录句柄中读取条目
  • rewinddir — 倒回目录句柄
  • scandir — 列出指定路径中的文件和目录
本站为非盈利网站，作品由网友提供上传，如无意中有侵犯您的版权，请联系删除