php man page for opendir

OPENDIR(3)								 1								OPENDIR(3)

opendir - Open directory handle

SYNOPSIS
       resource opendir (string  $path, [resource  $context])

DESCRIPTION
	Opens up a directory handle to be used in subsequent closedir(3), readdir(3), and rewinddir(3) calls.

PARAMETERS
	      o $path
		- The directory path that is to be opened

	      o $context
		- For a description of the $context parameter, refer to the streams section of the manual.

RETURN VALUES
	Returns a directory handle resource on success, or FALSE on failure.

	If  $path  is  not  a  valid  directory or the directory can not be opened due to permission restrictions or filesystem errors, opendir(3)
       returns FALSE and generates a PHP error of level  E_WARNING. You can suppress the error output of opendir(3) by prepending '@' to the front
       of the function name.

CHANGELOG
       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 5.0.0	|						    |
       |	|						    |
       |	|      $path supports the ftp:// URL wrapper.	    |
       |	|						    |
       | 4.3.0	|						    |
       |	|						    |
       |	| $path  can  also be any URL which supports direc- |
       |	| tory listing, however only the file:// URL  wrap- |
       |	| per supports this in PHP 4			    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES
       Example #1

	      opendir(3) example

	      <?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) . "
";
		      }
		      closedir($dh);
		  }
	      }
	      ?>

	      The above example will output something similar to:

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

SEE ALSO
       is_dir(3), readdir(3), dir(3).

PHP Documentation Group 														OPENDIR(3)