Dutch PHP Conference 2023 - Call for Papers

La clase SplFileObject

(PHP 5 >= 5.1.0, PHP 7, PHP 8)


La clase SplFileObject ofrece una interfaz orientada a objetos para un fichero.

Sinopsis de la Clase

class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIterator {
/* Constantes */
const integer DROP_NEW_LINE = 1;
const integer READ_AHEAD = 2;
const integer SKIP_EMPTY = 4;
const integer READ_CSV = 8;
/* Métodos */
public __construct(
    string $filename,
    string $open_mode = "r",
    bool $use_include_path = false,
    resource $context = ?
public current(): string|array
public eof(): bool
public fflush(): bool
public fgetc(): string
public fgetcsv(string $delimiter = ",", string $enclosure = "\"", string $escape = "\\"): array
public fgets(): string
public fgetss(string $allowable_tags = ?): string
public flock(int $operation, int &$wouldblock = ?): bool
public fpassthru(): int
public fputcsv(
    array $fields,
    string $delimiter = ",",
    string $enclosure = '"',
    string $escape = "\"
): int
public fread(int $length): string
public fscanf(string $format, mixed &$... = ?): mixed
public fseek(int $offset, int $whence = SEEK_SET): int
public fstat(): array
public ftell(): int
public ftruncate(int $size): bool
public fwrite(string $str, int $length = ?): int
public getChildren(): void
public getCsvControl(): array
public getFlags(): int
public getMaxLineLen(): int
public hasChildren(): bool
public key(): int
public next(): void
public rewind(): void
public seek(int $line_pos): void
public setCsvControl(string $delimiter = ",", string $enclosure = "\"", string $escape = "\\"): void
public setFlags(int $flags): void
public setMaxLineLen(int $max_len): void
public valid(): bool
/* Métodos heredados */
public SplFileInfo::getATime(): int
public SplFileInfo::getBasename(string $suffix = ?): string
public SplFileInfo::getCTime(): int
public SplFileInfo::getExtension(): string
public SplFileInfo::getFileInfo(string $class_name = ?): SplFileInfo
public SplFileInfo::getFilename(): string
public SplFileInfo::getGroup(): int
public SplFileInfo::getInode(): int
public SplFileInfo::getMTime(): int
public SplFileInfo::getOwner(): int
public SplFileInfo::getPath(): string
public SplFileInfo::getPathInfo(string $class_name = ?): SplFileInfo
public SplFileInfo::getPathname(): string
public SplFileInfo::getPerms(): int
public SplFileInfo::getRealPath(): string
public SplFileInfo::getSize(): int
public SplFileInfo::getType(): string
public SplFileInfo::isDir(): bool
public SplFileInfo::isFile(): bool
public SplFileInfo::isLink(): bool
public SplFileInfo::openFile(string $open_mode = "r", bool $use_include_path = false, resource $context = null): SplFileObject
public SplFileInfo::setFileClass(string $class_name = "SplFileObject"): void
public SplFileInfo::setInfoClass(string $class_name = "SplFileInfo"): void
public SplFileInfo::__toString(): string

Constantes predefinidas


Colocar nuevas líneas al final de una línea.


Leer sobre rewind/next.


Saltar líneas vacías en el fichero. Esto requiere que la bandera READ_AHEAD esté activada para que funcione como se tenía previsto.


Leer líneas como filas CSV.

Historial de cambios

Versión Descripción
5.3.9 El valor de SplFileObject::SKIP_EMPTY cambió a 4. Anteriormente, el valor era 6.

Tabla de contenidos

add a note

User Contributed Notes 3 notes

Lars Gyrup Brink Nielsen
9 years ago
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:

print "Declaring file object\n";
$file = new SplFileObject('example.txt');

"Trying to delete file...\n";

"Closing file object\n";
$file = null;

"Deleting file...\n";

'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!
marcus at synchromedia dot co dot uk
8 years ago
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);
rlazarotto15+dont+spam+me at gmail dot com
2 years ago
Complimenting marcus at synchromedia dot co dot uk comment, you can also do something like this:


// 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

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).
To Top