diff --git a/reference/dir/functions/chdir.xml b/reference/dir/functions/chdir.xml index f82e0b7d79..be3257f60f 100644 --- a/reference/dir/functions/chdir.xml +++ b/reference/dir/functions/chdir.xml @@ -1,25 +1,25 @@ - + - - - chdir - Change directory - - - &reftitle.description; - - boolchdir - stringdirectory - - - Changes PHP's current directory to - directory. &return.success; - - - - <function>chdir</function> example - + + + chdir + Change directory + + + &reftitle.description; + + boolchdir + stringdirectory + + + Changes PHP's current directory to + directory. &return.success; + + + + <function>chdir</function> example + ]]> - - &example.outputs; - + + &example.outputs; + - - - - ¬e.sm.uidcheck.dir; - - See also getcwd. - - - + + + + ¬e.sm.uidcheck.dir; + + See also getcwd. + + + + - - - chroot - Change the root directory - - - &reftitle.description; - - boolchroot - stringdirectory - - - Changes the root directory of the current process to - directory. &return.success; - - - This function is only available if your system supports it and - you're using the CLI, CGI or Embed SAPI. - - chroot requires root privileges. - ¬e.no-windows; - - + + + chroot + Change the root directory + + + &reftitle.description; + + boolchroot + stringdirectory + + + Changes the root directory of the current process to + directory. &return.success; + + + This function is only available if your system supports it and + you're using the CLI, CGI or Embed SAPI. + + chroot requires root privileges. + ¬e.no-windows; + + + - - - dir - Directory class - - - &reftitle.description; - - dir - - dir - stringdirectory - - - stringpath - - - resourcehandle - - stringread - voidrewind - voidclose - - - A pseudo-object oriented mechanism for reading a directory. The - given directory is opened. Two properties - are available once the directory has been opened. The handle - property can be used with other directory functions such as - readdir, rewinddir and - closedir. The path property is set to path - the directory that was opened. Three methods are available: - read, rewind and close. - - - Please note the fashion in which dir's - return value is checked in the example below. We are explicitly - testing whether the return value is identical to (equal to and of - the same type as--see - Comparison Operators for more information) &false; since - otherwise, any directory entry whose name evaluates to &false; will - stop the loop. - - <function>dir</function> example - + + + dir + Directory class + + + &reftitle.description; + + dir + + dir + stringdirectory + + + stringpath + + + resourcehandle + + stringread + voidrewind + voidclose + + + A pseudo-object oriented mechanism for reading a directory. The + given directory is opened. Two properties + are available once the directory has been opened. The handle + property can be used with other directory functions such as + readdir, rewinddir and + closedir. The path property is set to path + the directory that was opened. Three methods are available: + read, rewind and close. + + + Please note the fashion in which dir's + return value is checked in the example below. We are explicitly + testing whether the return value is identical to (equal to and of + the same type as--see + Comparison Operators for more information) &false; since + otherwise, any directory entry whose name evaluates to &false; will + stop the loop. + + <function>dir</function> example + read())) { $d->close(); ?> ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + - - - - - - The order in which directory entries are returned by the read method is - system-dependent. - - - - - This defines the internal class - Directory, meaning that you will not be - able to define your own classes with that name. For a full list - of predefined classes in PHP, please see Predefined Classes. - - - - + + + + + + The order in which directory entries are returned by the read method is + system-dependent. + + + + + This defines the internal class + Directory, meaning that you will not be + able to define your own classes with that name. For a full list + of predefined classes in PHP, please see Predefined Classes. + + + + + - - - closedir - Close directory handle - - - &reftitle.description; - - voidclosedir - resourcedir_handle - - - Closes the directory stream indicated by - dir_handle. The stream must have previously - been opened by opendir. - - - - <function>closedir</function> example - + + + closedir + Close directory handle + + + &reftitle.description; + + voidclosedir + resourcedir_handle + + + Closes the directory stream indicated by + dir_handle. The stream must have previously + been opened by opendir. + + + + <function>closedir</function> example + ]]> - - - - - + + + + + + - - - getcwd - Gets the current working directory - - - &reftitle.description; - - stringgetcwd - - - - Returns the current working directory, or &false; on failure. - - - - On some Unix variants, getcwd will return - &false; if any one of the parent directories does not have the - readable or search mode set, even if the current directory - does. See chmod for more information on - modes and permissions. - - - - - <function>getcwd</function> example - + + + getcwd + Gets the current working directory + + + &reftitle.description; + + stringgetcwd + + + + Returns the current working directory, or &false; on failure. + + + + On some Unix variants, getcwd will return + &false; if any one of the parent directories does not have the + readable or search mode set, even if the current directory + does. See chmod for more information on + modes and permissions. + + + + + <function>getcwd</function> example + ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + - - - - - See also chdir and - chmod. - - - + + + + + See also chdir and + chmod. + + + + - - - opendir - Open directory handle - - - &reftitle.description; - - resourceopendir - stringpath - - - Returns a directory handle to be used in subsequent - closedir, readdir, and - rewinddir calls. - - - If path is not a valid directory or the - directory can not be opened due to permission restrictions or - filesystem errors, opendir returns &false; and - generates a PHP error of level - E_WARNING. You can suppress the error output of - opendir by prepending - '@' to the - front of the function name. - - - - <function>opendir</function> example - + + + opendir + Open directory handle + + + &reftitle.description; + + resourceopendir + stringpath + + + Returns a directory handle to be used in subsequent + closedir, readdir, and + rewinddir calls. + + + If path is not a valid directory or the + directory can not be opened due to permission restrictions or + filesystem errors, opendir returns &false; and + generates a PHP error of level + E_WARNING. You can suppress the error output of + opendir by prepending + '@' to the + front of the function name. + + + + <function>opendir</function> example + ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + - - - - - As of PHP 4.3.0 path can also - be any URL which supports directory listing, however only the file:// - URL wrapper supports this in PHP 4.3. As of - PHP 5.0.0, support for the ftp:// - URL wrapper is included as well. - - - See also is_dir, - readdir, and - Dir - - - + + + + + As of PHP 4.3.0 path can also + be any URL which supports directory listing, however only the file:// + URL wrapper supports this in PHP 4.3. As of + PHP 5.0.0, support for the ftp:// + URL wrapper is included as well. + + + See also is_dir, + readdir, and + Dir + + + + - - - readdir - Read entry from directory handle - - - &reftitle.description; - - stringreaddir - resourcedir_handle - - - Returns the filename of the next file from the directory. The - filenames are returned in the order in which they are stored by - the filesystem. - - - Please note the fashion in which readdir's - return value is checked in the examples below. We are explicitly - testing whether the return value is identical to (equal to and of - the same type as--see Comparison - Operators for more information) &false; since otherwise, - any directory entry whose name evaluates to &false; will stop the - loop (e.g. a directory named "0"). - - - - List all files in a directory - + + + readdir + Read entry from directory handle + + + &reftitle.description; + + stringreaddir + resourcedir_handle + + + Returns the filename of the next file from the directory. The + filenames are returned in the order in which they are stored by + the filesystem. + + + Please note the fashion in which readdir's + return value is checked in the examples below. We are explicitly + testing whether the return value is identical to (equal to and of + the same type as--see Comparison + Operators for more information) &false; since otherwise, + any directory entry whose name evaluates to &false; will stop the + loop (e.g. a directory named "0"). + + + + List all files in a directory + ]]> - - - - - Note that readdir will return the . - and - .. entries. If you don't want these, simply strip - them out: - - - List all files in the current directory and strip out <literal>.</literal> - and <literal>..</literal> - - + + + + + Note that readdir will return the . + and + .. entries. If you don't want these, simply strip + them out: + + + List all files in the current directory and strip out <literal>.</literal> + and <literal>..</literal> + + ]]> - - - - - See also is_dir and - glob. - - - + + + + + See also is_dir and + glob. + + + + - - - rewinddir - Rewind directory handle - - - &reftitle.description; - - voidrewinddir - resourcedir_handle - - - Resets the directory stream indicated by - dir_handle to the beginning of the - directory. - + + + rewinddir + Rewind directory handle + + + &reftitle.description; + + voidrewinddir + resourcedir_handle + + + Resets the directory stream indicated by + dir_handle to the beginning of the + directory. + - - + + - - - scandir - - List files and directories inside the specified path - - - - &reftitle.description; - - arrayscandir - stringdirectory - intsorting_order - resourcecontext - - - Returns an array of files and directories from the - directory. If directory - is not a directory, then boolean &false; is returned, and an error of - level E_WARNING is generated. - - - By default, the sorted order is alphabetical in ascending order. If - the optional sorting_order is used (set to 1), - then sort order is alphabetical in descending order. - - - For a description of the context parameter, refer - to . - - - - A simple <function>scandir</function> example - + + + + scandir + + List files and directories inside the specified path + + + + &reftitle.description; + + arrayscandir + stringdirectory + intsorting_order + resourcecontext + + + Returns an array of files and directories from the + directory. If directory + is not a directory, then boolean &false; is returned, and an error of + level E_WARNING is generated. + + + By default, the sorted order is alphabetical in ascending order. If + the optional sorting_order is used (set to 1), + then sort order is alphabetical in descending order. + + + For a description of the context parameter, refer + to . + + + + A simple <function>scandir</function> example + ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + . ) ]]> - - - - - - PHP 4 alternatives to <function>scandir</function> - + + + + + + PHP 4 alternatives to <function>scandir</function> + ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + . ) ]]> - - - - &tip.fopen-wrapper; - - See also opendir, - readdir, - glob, - is_dir, and - sort. - - - + + + + &tip.fopen-wrapper; + + See also opendir, + readdir, + glob, + is_dir, and + sort. + + +