PHP | DirectoryIterator key()函数

DirectoryIterator类是用于迭代目录的PHP内置类。key()方法返回迭代器的当前键，在内部迭代器用于包含在目录中的项目。

语法

public mixed DirectoryIterator::key ( void )

参数

该函数没有参数。

返回值

返回迭代器的当前键，即一个整数，表示目录中的第几项。

示例

下面是一个使用DirectoryIterator类的示例代码，以便更好地理解key()函数：

$dir = new DirectoryIterator('/path/to/directory');
foreach ($dir as $file) { 
    if (!$file->isDot()) { 
        echo $file->key().' - '.$file->getFilename()."<br>\n"; 
    } 
}

在上述例子中，我们打开一个目录并将其迭代，使用key()函数返回迭代器的当前键，即目录中的第几项，同时使用getFilename()函数返回当前文件名。请注意，我们使用了isDot()函数来排除目录中的“.”和“..”。

注意事项

如果DirectoryIterator迭代器没有启动，则key()函数会返回NULL。

结论

在处理目录中的项时，key()函数非常有用，它可以帮助程序员获取当前项的索引。此外，此函数还可用于检查是否到达了目录尾部。