DIWE - File handling with PHP

Diploma in Web Engineering
Module VIII: File handling with PHP
Rasan Samarasinghe
ESOFT Computer Studies (pvt) Ltd.
No 68/1, Main Street, Pallegama, Embilipitiya.

Contents
1. include and require Statements
2. include and require
3. include_once Statement
4. Validating Files
5. file_exists() function
6. is_dir() function
7. is_readable() function
8. is_writable() function
9. is_executable() function
10. filesize() function
11. filemtime() function
12. filectime() function
13. fileatime() function
14. Creating and deleting files
15. touch() function
16. unlink() function
17. File reading, writing and appending
18. Open File - fopen()
19. Close File - fclose()
20. Read File - fread()
21. Read Single Line - fgets()
22. Check End-Of-File - feof()
23. Read Single Character - fgetc()
24. Seek File - fseek()
25. Write File - fwrite()
26. Write File - fputs()
27. Lock File - flock()
28. Working with Directories
29. Create directory - mkdir()
30. Remove directory - rmdir()
31. Open directory - opendir()
32. Read directory - readdir()

include and require Statements
The include and require statements takes all the
text/code/markup that exists in the specified file and
copies it into the file that uses the include statement.
Syntax:
include 'filename';
or
require 'filename';

include statement example 1 (menu.php file)
<?php
echo '<a href="/index.php">Home</a> |
<a href="courses.php">Courses</a> |
<a href="branches.php">Branches</a> |
<a href="about.php">About Us</a> |
<a href="contact.php">Contact Us</a>';
?>

include statement example 1 (index.php file)
<html>
<body>
<div>
<?php include 'menu.php';?>
</div>
<h1>Welcome to Esoft Metro Campus!</h1>
<p>The leader in professional ICT education.</p>
</body>
</html>

include statement example 2 (core.php file)
<?php
function showFooter(){
echo "<p>Copyright © " . date("Y") . "
Wegaspace.com</p>";
}
?>

include statement example 2 (index.php file)
<html>
<body>
<h1>Welcome to Wegaspace!</h1>
<p>The most unique wap community ever!</p>
<?php
include 'footer.php';
showFooter();
?>
</body>
</html>

include and require
The include and require statements are identical,
except upon failure:
• require will produce a fatal error
(E_COMPILE_ERROR) and stop the script
• include will only produce a warning (E_WARNING)
and the script will continue

include_once Statement
The require_once() statement will check if the file
has already been included, and if so, not include
(require) it again.
Syntax:
include_once 'filename';

include_once statement example
world.php file
<?php
echo "Hello World!<br/>";
?>
srilanka.php file
<?php
echo "Hello Sri Lanka!<br/>";
?>

include_once statement example
<html>
<body>
<p>
<?php
include 'world.php';
include 'world.php'; // includes the file again
include_once 'srilanka.php';
include_once 'srilanka.php'; // not includes the file again
?>
</p>
</body>
</html>

Validating Files
• file_exists() function
• is_dir() function
• is_readable() function
• is_writable() function
• is_executable() function
• filesize() function
• filemtime() function
• filectime() function
• fileatime() function

file_exists() function
The file_exists() function checks whether or not a
file or directory exists.
This function returns TRUE if the file or directory
exists, otherwise it returns FALSE.
Syntax:
file_exists(path)

file_exists() function
<?php
var_dump(file_exists("test.txt"));
?>

is_dir() function
The is_dir() function checks whether the specified
file is a directory.
This function returns TRUE if the directory exists.
Syntax:
is_dir(file)

is_dir() function
$file = "images";
if(is_dir($file)){
echo ("$file is a directory");
} else {
echo ("$file is not a directory");
}

is_readable() function
The is_readable() function checks whether the
specified file is readable.
This function returns TRUE if the file is readable.
Syntax:
is_readable(file)

is_readable() function
$file = "test.txt";
if(is_readable($file)){
echo ("$file is readable");
} else {
echo ("$file is not readable");
}

is_writable() function
The is_writable() function checks whether the
specified file is writeable.
This function returns TRUE if the file is writeable.
Syntax:
is_writable(file)

is_writable() function
$file = "test.txt";
if(is_writable($file)) {
echo ("$file is writeable");
} else {
echo ("$file is not writeable");
}

is_executable() function
The is_executable() function checks whether the
specified file is executable.
This function returns TRUE if the file is executable.
Syntax:
is_executable(file)

is_executable() function
$file = "setup.exe";
if(is_executable($file)) {
echo ("$file is executable");
} else {
echo ("$file is not executable");
}

filesize() function
The filesize() function returns the size of the
specified file.
This function returns the file size in bytes on
success or FALSE on failure.
Syntax:
filesize(filename)

filesize() function
echo filesize("test.txt");

filemtime() function
The filemtime() function returns the last time the
file content was modified.
This function returns the last change time as a Unix
timestamp on success, FALSE on failure.
Syntax:
filemtime(filename)

filemtime() function
echo filemtime("test.txt");
echo "<br />";
echo "Last modified: ".date("F d Y
H:i:s.",filemtime("test.txt"));

filectime() function
The filectime() function returns the last time the
specified file was changed.
This function returns the last change time as a Unix
Syntax:
filectime(filename)

filectime() function
echo filectime("test.txt");
echo "<br />";
echo "Last change: ".date("F d Y
H:i:s.",filectime("test.txt"));

fileatime() function
The fileatime() function returns the last access time
of the specified file.
This function returns the last access time as a Unix
Syntax:
fileatime(filename)

fileatime() function
echo fileatime("test.txt");
echo "<br />";
echo "Last access: ".date("F d Y
H:i:s.",fileatime("test.txt"));

Creating and deleting files
• touch() function
• unlink() function

touch() function
The touch() function sets the access and
modification time of the specified file.
This function returns TRUE on success, or FALSE on
failure.
Syntax:
touch(filename, time, atime)

touch() function
touch("test.txt");
touch("test.txt", mktime(8,40,20,2,10,1988));

unlink() function
The unlink() function deletes a file.
failure.
Syntax:
unlink(filename, context)

unlink() function
$file = "test.txt";
if (!unlink($file)) {
echo ("Error deleting $file");
} else {
echo ("Deleted $file");
}

File reading, writing and appending
• Open File - fopen()
• Close File - fclose()
• Read File - fread()
• Read Single Line - fgets()
• Check End-Of-File - feof()
• Read Single Character - fgetc()
• Seek File - fseek()
• Write File - fwrite()
• Write File - fputs()
• Lock File - flock()

Open File - fopen()
The fopen() function opens a file or URL.
If fopen() fails, it returns FALSE and an error on
failure.
Syntax:
fopen(filename, mode, include_path, context)

File open modes
Modes Description
r Open a file for read only. File pointer starts at the beginning of the file
w
Open a file for write only. Erases the contents of the file or creates a new
file if it doesn't exist. File pointer starts at the beginning of the file
a
Open a file for write only. The existing data in file is preserved. File pointer
starts at the end of the file. Creates a new file if the file doesn't exist
x
Creates a new file for write only. Returns FALSE and an error if file already
exists
r+ Open a file for read/write. File pointer starts at the beginning of the file
w+
Open a file for read/write. Erases the contents of the file or creates a new
file if it doesn't exist. File pointer starts at the beginning of the file
a+
Open a file for read/write. The existing data in file is preserved. File pointer
starts at the end of the file. Creates a new file if the file doesn't exist
x+
Creates a new file for read/write. Returns FALSE and an error if file already
exists

Open File - fopen()
$file = fopen("test.txt","r");
$file = fopen("/home/test/test.txt","r");
$file = fopen("/home/test/test.gif","wb");
$file = fopen("http://www.example.com/","r");
$file =
fopen("ftp://user:password@example.com/test.txt
","w");

Close File - fclose()
The fclose() function closes an open file.
This function returns TRUE on success or FALSE on
failure.
Syntax:
fclose(file)

Close File - fclose()
//some code to be executed
fclose($file);

Read File - fread()
The fread() reads from an open file.
The function will stop at the end of the file or when it
reaches the specified length, whichever comes first.
This function returns the read string, or FALSE on
failure.
Syntax:
fread(file, length)

Read File - fread()
fread($file, filesize("test.txt"));
fclose($file);

Read Single Line - fgets()
The fgets() function returns a line from an open file.
The fgets() function stops returning on a new line,
at the specified length, or at EOF, whichever comes
first.
This function returns FALSE on failure.
Syntax:
fgets(file, length)

Read Single Line - fgets()
echo fgets($file). "<br />";
fclose($file);

Check End-Of-File - feof()
The feof() function checks if the "end-of-file" (EOF)
has been reached.
This function returns TRUE if an error occurs, or if
EOF has been reached. Otherwise it returns FALSE.
Syntax:
feof(file)

Check End-Of-File - feof()
$file = fopen("test.txt", "r");
//Output a line of the file until the end is reached
while(! feof($file)) {
echo fgets($file). "<br />";
}
fclose($file);

Read Single Character - fgetc()
The fgetc() function returns a single character from
an open file.
Syntax:
fgetc(file)

Read Single Character - fgetc()
$file = fopen("test2.txt", "r");
while (! feof ($file)) {
echo fgetc($file);
}
fclose($file);

Seek File - fseek()
The fseek() function seeks in an open file.
This function moves the file pointer from its current
position to a new position, forward or backward,
specified by the number of bytes.
This function returns 0 on success, or -1 on failure.
Seeking past EOF will not generate an error.
Syntax:
fseek(file, offset, whence)

Seek File - fseek()
$file = fopen("test.txt", "r");
// read first line
fgets($file);
// move back to beginning of file
fseek($file, 0);

Write File - fwrite()
The fwrite() writes to an open file.
This function returns the number of bytes written, or
FALSE on failure.
Syntax:
fwrite(file, string, length)

Write File - fwrite()
$file = fopen("test.txt","w");
echo fwrite($file,"Hello World. Testing!");
fclose($file);

Write File - fputs()
The fputs() writes to an open file.
This function returns the number of bytes written on
success, or FALSE on failure.
Syntax:
fputs(file, string, length)

Write File - fputs()
$file = fopen("test.txt","w");
echo fputs($file,"Hello World. Testing!");
fclose($file);

Lock File - flock()
The flock() function locks or releases a file.
This function returns TRUE on success or FALSE on
failure.
Syntax:
flock(file, lock, block)

Lock File - flock()
$file = fopen("test.txt", "w+");
if (flock($file, LOCK_EX)) {
fwrite($file, "Write something");
flock($file, LOCK_UN);
} else {
echo "Error locking file!";
}
fclose($file);

Working with Directories
• Create directory - mkdir()
• Remove directory - rmdir()
• Open directory - opendir()
• Read directory - readdir()

Create directory - mkdir()
The mkdir() function creates a directory.
failure.
Syntax:
mkdir(path, mode, recursive, context)

Create directory - mkdir()
mkdir("testing", 0775);

Remove directory - rmdir()
The rmdir() function removes an empty directory.
failure.
Syntax:
rmdir(dir, context)

Remove directory - rmdir()
$path = "images";
if(!rmdir($path)) {
echo ("Could not remove $path");
}

Open directory - opendir()
The opendir() function opens a directory handle.
Syntax:
opendir(path, context);

Open directory - opendir()
$dir = "images";
if ($dh = opendir($dir)){
echo "$dir directory opened";
}
closedir($dh);

Read directory - readdir()
The readdir() function returns the name of the next
entry in a directory.
Syntax:
readdir(dir_handle);

Read directory - readdir()
$dir = "images";
// Open a directory, and read its contents
if (is_dir($dir)){
if ($dh = opendir($dir)){
while (($file = readdir($dh)) !== false){
echo "filename:" . $file . "<br>";
}
closedir($dh);
}
}

The End
http://twitter.com/rasansmn

DIWE - File handling with PHP

Recommended

More Related Content

What's hot (20)

Viewers also liked (20)

Similar to DIWE - File handling with PHP (20)

More from Rasan Samarasinghe (20)

Recently uploaded (20)

DIWE - File handling with PHP

Editor's Notes