The SplFileObject class
(PHP 5 >= 5.1.0)
Introduction
The SplFileObject class offers an object oriented interface for a file.
Class synopsis
/* Constants */
/* Methods */
public __construct
( string
$filename
[, string $open_mode = "r"
[, bool $use_include_path = false
[, resource $context
]]] )
public array fgetcsv
([ string
$delimiter = ","
[, string $enclosure = "\""
[, string $escape = "\\"
]]] )
public void setCsvControl
([ string
$delimiter = ","
[, string $enclosure = "\""
[, string $escape = "\\"
]]] )/* Inherited methods */
public SplFileObject SplFileInfo::openFile
([ string
}$open_mode = "r"
[, bool $use_include_path = false
[, resource $context = NULL
]]] )Predefined Constants
SplFileObject::DROP_NEW_LINE-
Drop newlines at the end of a line.
SplFileObject::READ_AHEAD-
Read on rewind/next.
SplFileObject::SKIP_EMPTY-
Skips empty lines in the file. This requires the
READ_AHEADflag be enabled, to work as expected. SplFileObject::READ_CSV-
Read lines as CSV rows.
Changelog
| Version | Description |
|---|---|
| 5.3.9 |
SplFileObject::SKIP_EMPTY value changed to 4.
Previously, value was 6.
|
Table of Contents
- SplFileObject::__construct — Construct a new file object.
- SplFileObject::current — Retrieve current line of file
- SplFileObject::eof — Reached end of file
- SplFileObject::fflush — Flushes the output to the file
- SplFileObject::fgetc — Gets character from file
- SplFileObject::fgetcsv — Gets line from file and parse as CSV fields
- SplFileObject::fgets — Gets line from file
- SplFileObject::fgetss — Gets line from file and strip HTML tags
- SplFileObject::flock — Portable file locking
- SplFileObject::fpassthru — Output all remaining data on a file pointer
- SplFileObject::fputcsv — Write a field array as a CSV line
- SplFileObject::fscanf — Parses input from file according to a format
- SplFileObject::fseek — Seek to a position
- SplFileObject::fstat — Gets information about the file
- SplFileObject::ftell — Return current file position
- SplFileObject::ftruncate — Truncates the file to a given length
- SplFileObject::fwrite — Write to file
- SplFileObject::getChildren — No purpose
- SplFileObject::getCsvControl — Get the delimiter and enclosure character for CSV
- SplFileObject::getCurrentLine — Alias of SplFileObject::fgets
- SplFileObject::getFlags — Gets flags for the SplFileObject
- SplFileObject::getMaxLineLen — Get maximum line length
- SplFileObject::hasChildren — SplFileObject does not have children
- SplFileObject::key — Get line number
- SplFileObject::next — Read next line
- SplFileObject::rewind — Rewind the file to the first line
- SplFileObject::seek — Seek to specified line
- SplFileObject::setCsvControl — Set the delimiter and enclosure character for CSV
- SplFileObject::setFlags — Sets flags for the SplFileObject
- SplFileObject::setMaxLineLen — Set maximum line length
- SplFileObject::__toString — Alias of SplFileObject::current
- SplFileObject::valid — Not at EOF
Коментарии
Note that this class has a private (and thus, not documented) property that holds the file pointer. Combine this with the fact that there is no method to close the file handle, and you get into situations where you are not able to delete the file with unlink(), etc., because an SplFileObject still has a handle open.
To get around this issue, delete the SplFileObject like this:
---------------------------------------------------------------------
<?php
print "Declaring file object\n";
$file = new SplFileObject('example.txt');
print "Trying to delete file...\n";
unlink('example.txt');
print "Closing file object\n";
$file = null;
print "Deleting file...\n";
unlink('example.txt');
print 'File deleted!';
?>
---------------------------------------------------------------------
which will output:
---------------------------------------------------------------------
Declaring file object
Trying to delete file...
Warning: unlink(example.txt): Permission denied in file.php on line 6
Closing file object
Deleting file...
File deleted!
---------------------------------------------------------------------
If you want to skip blank lines when reading a CSV file, you need *all * the flags:
$file->setFlags(SplFileObject::READ_CSV | SplFileObject::READ_AHEAD | SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE);
Complimenting marcus at synchromedia dot co dot uk comment, you can also do something like this:
<?php
// create a SplFileObject for reading - note that there are no flags
$file = new SplFileObject('/path/to/file', 'r');
// iterate over its contents
while (!$file->eof()) {
// get the current line
$line = $file->fgets();
// trim it, and then check if its empty
if (empty(trim($line))) {
// skips the current iteration
continue;
}
}
While this may seem like a overkill for such thing, it allows you to do some processing with the empty lines that might come (I had to do this mostly because I needed to count empty lines instead of just skipping them). Since it also trims the line before checking if it's empty, you won't get lines composed only of empty spaces (I don't know if the flags also make it trim the content before checking it).
with php 8.3, with or without SplFileObject::DROP_NEW_LINE, you get an array with empty values at the end.