DirectoryIterator to get file and directory info

In this tutorial is presented DirectoryIterator, a PHP class added in PHP 5+.
This class is useful to traverse a directory, and get informations about its folders and files (file name, last accessed time, size, etc.).
Like any other class, to use DirectoryIterator you must create an object instance of this class, using:

$objDI = new DirectoryIterator($path);

- $path - represents path of the directory to traverse. For the crrent directory you can use for path: __DIR__ , or dirname(__FILE__).
Then you can use its methods.
- To understand how to use DirectoryIterator , let's see some practical examples.

Get the path to the file

- uses getPath() method.

$objDI = new DirectoryIterator(__DIR__);
echo $objDI->getPath();           // /home/examples/public_html

The instance of DirectoryIterator contains an object with info about the files and directories in the current folder. This object can be traversed with a foreach() instruction to get info of each item.

Get the name of the files in current directory

- Uses isFile() to check if it's a file, and getFilename() to get the name.

$objDI = new DirectoryIterator(__DIR__);
foreach($objDI as $fileinfo) {
  // if it's a file
  if($fileinfo->isFile()) {
    echo $fileinfo->getFilename() .'<br/>';
  }
}

/* Returns something similar to:
 admin.php
 coursesweb.jpg
 jquery.js
 course.html
*/

Get the size of the files

- Uses isFile() to check if it's a file, and getSize() to get the size (in bytes).

$objDI = new DirectoryIterator(__DIR__);
foreach($objDI as $fileinfo) {
  // if it's a file
  if($fileinfo->isFile()) {
    $filesize = $fileinfo->getSize() / 1024;          // 1 KB = 1024 bytes
    echo $fileinfo->getFilename() .' '. $filesize .' KB<br/>';
  }
}

/* Returns something similar to:
 admin.php 3.1572265625 KB
 coursesweb.jpg 11.498046875 KB
 jquery.js 122.095703125 KB
*/

Get directories name

- Uses isDir() to check if it's a directory, isDot() that checks if current item is '.', or '..', and getFilename() to get the name.

$objDI = new DirectoryIterator(__DIR__);
foreach($objDI as $fileinfo) {
  // if it's a directory, but not '.', or '..'
  if($fileinfo->isDir() && !$fileinfo->isDot()) {
    echo $fileinfo->getFilename() .'<br/>';
  }
}

/* Returns something similar to:
 Pages
 CoursesWeb
 Tutorials
*/

Get CHMOD permisions

- Uses isDot() to check if not '.', or '..', and getPerms() to get the permissions of current item (as a decimal integer).

$objDI = new DirectoryIterator(__DIR__);
foreach($objDI as $fileinfo) {
  // if not '.', or '..'
  if(!$fileinfo->isDot()) {
    // get octal from decimal integer
    $octal_perms = substr(sprintf('%o', $fileinfo->getPerms()), -4);
    echo $fileinfo->getFilename() .' '. $octal_perms .'
';
  }
}

/* Returns something similar to:
 admin.php 0644
 Pages 0755
 Tutorials.html 0644
*/

Check if directory and files are writable

- Uses isWritable(). Returns True if the current file/directory is writable, otherwise, False.

$objDI = new DirectoryIterator(dirname(__FILE__));
foreach($objDI as $fileinfo) {
  if($fileinfo->isWritable()) {
    echo $fileinfo->getFilename() .' is writable<br/>';
  }
}

/* Returns something similar to:
 coursesweb.htm  is writable
 Pages  is writable
 websites.txt  is writable
*/

Get last accessed time of the file

- Uses isFile() to check if it's a file, and getATime() to get the last accessed time, as a Unix timestamp.

$objDI = new DirectoryIterator(dirname(__FILE__));
foreach($objDI as $fileinfo) {
  if($fileinfo->isFile()) {
    echo $fileinfo->getFilename() .' '. $fileinfo->getATime() .'<br/>';
  }
}

/* Returns something similar to:
 coursesweb.htm  1319637336
 Pages  1319880959
 websites.txt 1327757524
*/