php8.5
/
Download
Home/ Manual/ reference / spl/ The SplFileObject class

The SplFileObject class

Guide Edit on GitHub ✎

The SplFileObject class offers an object-oriented interface for a file.

Intro

The SplFileObject class offers an object-oriented interface for a file.

Class synopsis

class SplFileObject extends SplFileInfo implements RecursiveIterator implements SeekableIterator { }

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_AHEAD flag be enabled, to work as expected.

SplFileObject::READ_CSV

Read lines as CSV rows.

Changelog

VersionDescription

Splfileobject

In this section

SplFileObject::__construct

Construct a new file object

SplFileObject::__toString

Returns the current line as a string

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::fread

Read from file

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, enclosure and escape character for CSV

SplFileObject::getCurrentLine

Alias 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, enclosure and escape character for CSV

SplFileObject::setFlags

Sets flags for the SplFileObject

SplFileObject::setMaxLineLen

Set maximum line length

SplFileObject::valid

Not at EOF

Source: reference/spl/splfileobject.xml · from the official PHP manual (php/doc-en)