The SplFileObject class

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

    Introduction

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

    Class synopsis

    classSplFileObjectextendsSplFileInfoimplementsRecursiveIterator, SeekableIterator {
    publicconstintDROP_NEW_LINE;
    publicconstintREAD_AHEAD;
    publicconstintSKIP_EMPTY;
    publicconstintREAD_CSV;
    public__construct(
        string$filename,
        string$mode = "r",
        bool$useIncludePath = false,
        ?resource$context = null
    )
    publiccurrent(): string|array|false
    publiceof(): bool
    publicfflush(): bool
    publicfgetc(): string|false
    publicfgetcsv(string$separator = ",", string$enclosure = "\"", string$escape = "\\"): array|false
    publicfgets(): string
    publicfgetss(string$allowable_tags = ?): string
    publicflock(int$operation, int&$wouldBlock = null): bool
    publicfpassthru(): int
    publicfputcsv(
        array$fields,
        string$separator = ",",
        string$enclosure = "\"",
        string$escape = "\\",
        string$eol = "\n"
    ): int|false
    publicfread(int$length): string|false
    publicfscanf(string$format, mixed&...$vars): array|int|null
    publicfseek(int$offset, int$whence = SEEK_SET): int
    publicfstat(): array
    publicftell(): int|false
    publicftruncate(int$size): bool
    publicfwrite(string$data, int$length = 0): int|false
    publicgetChildren(): null
    publicgetCsvControl(): array
    publicgetFlags(): int
    publicgetMaxLineLen(): int
    publichasChildren(): false
    publickey(): int
    publicnext(): void
    publicrewind(): void
    publicseek(int$line): void
    publicsetCsvControl(string$separator = ",", string$enclosure = "\"", string$escape = "\\"): void
    publicsetFlags(int$flags): void
    publicsetMaxLineLen(int$maxLength): void
    public__toString(): string
    publicvalid(): bool
    publicSplFileInfo::getATime(): int|false
    publicSplFileInfo::getBasename(string$suffix = ""): string
    publicSplFileInfo::getCTime(): int|false
    publicSplFileInfo::getExtension(): string
    publicSplFileInfo::getFileInfo(?string$class = null): SplFileInfo
    publicSplFileInfo::getFilename(): string
    publicSplFileInfo::getGroup(): int|false
    publicSplFileInfo::getInode(): int|false
    publicSplFileInfo::getLinkTarget(): string|false
    publicSplFileInfo::getMTime(): int|false
    publicSplFileInfo::getOwner(): int|false
    publicSplFileInfo::getPath(): string
    publicSplFileInfo::getPathInfo(?string$class = null): ?SplFileInfo
    publicSplFileInfo::getPathname(): string
    publicSplFileInfo::getPerms(): int|false
    publicSplFileInfo::getRealPath(): string|false
    publicSplFileInfo::getSize(): int|false
    publicSplFileInfo::getType(): string|false
    publicSplFileInfo::isDir(): bool
    publicSplFileInfo::isExecutable(): bool
    publicSplFileInfo::isFile(): bool
    publicSplFileInfo::isLink(): bool
    publicSplFileInfo::isReadable(): bool
    publicSplFileInfo::isWritable(): bool
    publicSplFileInfo::openFile(string$mode = "r", bool$useIncludePath = false, ?resource$context = null): SplFileObject
    publicSplFileInfo::setFileClass(string$class = SplFileObject::class): void
    publicSplFileInfo::setInfoClass(string$class = SplFileInfo::class): void
    publicSplFileInfo::__toString(): string
    }

    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.

    Table of Contents

    To Top