Creating or Opening a Local File (PHP Cookbook)

18.2.1. Problem

You want to open a local file to read data from it or write data to it.

18.2.3. Discussion

The first argument to fopen( ) is the file to open; the second argument is the mode to open the file in. The mode specifies what operations can be performed on the file (reading and/or writing), where the file pointer is placed after the file is opened (at the beginning or end of the file), whether the file is truncated to zero length after opening, and whether the file is created if it doesn't exist, as shown in Table 18-1.

Table 18-1. fopen( ) file modes

Mode	Readable?	Writeable?	File pointer	Truncate?	Create?
`r`	Yes	No	Beginning	No	No
`r+`	Yes	Yes	Beginning	No	No
`w`	No	Yes	Beginning	Yes	Yes
`w+`	Yes	Yes	Beginning	Yes	Yes
`a`	No	Yes	End	No	Yes
`a+`	Yes	Yes	End	No	Yes

On non-POSIX systems, such as Windows, you need to add a b to the mode when opening a binary file, or reads and writes get tripped up on NUL (ASCII 0) characters:

$fh = fopen('c:/images/logo.gif','rb');

To operate on a file, pass the file handle returned from fopen( ) to other I/O functions such as fgets( ), fputs( ), and fclose( ).

If the file given to fopen( ) doesn't have a pathname, the file is opened in the directory of the running script (web context) or in the current directory (command-line context).

You can also tell fopen( ) to search for the file to open in the include_path specified in your php.ini file by passing 1 as a third argument. For example, this searches for file.inc in the include_path:

$fh = fopen('file.inc','r',1) or die("can't open file.inc: $php_errormsg");

18.2.4. See Also

Documentation on fopen( ) at http://www.php.net/fopen.

Table 18-1. fopen( ) file modes

18.2. Creating or Opening a Local File

18.2.1. Problem

18.2.2. Solution

18.2.3. Discussion

18.2.4. See Also


18. Files		18.3. Creating a Temporary File