Php/docs/filesystemiterator.key

• PHP Manual
• FilesystemIterator
• Retrieve the key for the current file

FilesystemIterator::key

(PHP 5 >= 5.3.0, PHP 7)

FilesystemIterator::key — Retrieve the key for the current file

Description

public FilesystemIterator::key ( ) : string

Parameters

This function has no parameters.

Return Values

Returns the pathname or filename depending on the set flags. See the FilesystemIterator constants.

Examples

Example #1 FilesystemIterator::key() example

This example will list the contents of the directory containing the script.

<?php$iterator = new FilesystemIterator(dirname(__FILE__), FilesystemIterator::KEY_AS_FILENAME);foreach ($iterator as $fileinfo) {    echo $iterator->key() . "\n";}?>

The above example will output something similar to:

apple.jpg
banana.jpg
example.php

See Also

• FilesystemIterator constants
• DirectoryIterator::key() - Return the key for the current DirectoryIterator item
• DirectoryIterator::getFilename() - Return file name of current DirectoryIterator item
• DirectoryIterator::getPathname() - Return path and file name of current DirectoryIterator item