PHP - Manual: SplFileObject

2024-11-14

SplFileObject::__construct »

« SplFileInfo::__toString

SplFileObject 类

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

简介

SplFileObject 类为文件提供了一个面向对象接口。

类摘要

class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIterator {

/* 常量 */

const int DROP_NEW_LINE = 1;

const int READ_AHEAD = 2;

const int SKIP_EMPTY = 4;

const int READ_CSV = 8;

/* 方法 */

public __construct(
    string $filename,
    string $mode = "r",
    bool $useIncludePath = false,
    ?resource $context = null
)

public current(): string|array|false

public eof(): bool

public fflush(): bool

public fgetc(): string|false

public fgetcsv(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): array|false

public fgets(): string

public fgetss(string $allowable_tags = ?): string

public flock(int $operation, int &$wouldBlock = null): bool

public fpassthru(): int

public fputcsv(
    array $fields,
    string $separator = ",",
    string $enclosure = "\"",
    string $escape = "\\",
    string $eol = "\n"
): int|false

public fread(int $length): string|false

public fscanf(string $format, mixed &...$vars): array|int|null

public fseek(int $offset, int $whence = SEEK_SET): int

public fstat(): array

public ftell(): int|false

public ftruncate(int $size): bool

public fwrite(string $data, int $length = 0): int|false

public getChildren(): ?RecursiveIterator

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): void

public setCsvControl(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): void

public setFlags(int $flags): void

public setMaxLineLen(int $maxLength): void

public valid(): bool

/* 继承的方法 */

public SplFileInfo::getATime(): int|false

public SplFileInfo::getBasename(string $suffix = ""): string

public SplFileInfo::getCTime(): int

public SplFileInfo::getExtension(): string

public SplFileInfo::getFileInfo(?string $class = null): SplFileInfo

public SplFileInfo::getFilename(): string

public SplFileInfo::getGroup(): int|false

public SplFileInfo::getInode(): int|false

public SplFileInfo::getLinkTarget(): string|false

public SplFileInfo::getMTime(): int|false

public SplFileInfo::getOwner(): int|false

public SplFileInfo::getPath(): string

public SplFileInfo::getPathInfo(?string $class = null): ?SplFileInfo

public SplFileInfo::getPathname(): string

public SplFileInfo::getPerms(): int|false

public SplFileInfo::getRealPath(): string|false

public SplFileInfo::getSize(): int|false

public SplFileInfo::getType(): string|false

public SplFileInfo::isDir(): bool

public SplFileInfo::isExecutable(): bool

public SplFileInfo::isFile(): bool

public SplFileInfo::isLink(): bool

public SplFileInfo::isReadable(): bool

public SplFileInfo::isWritable(): bool

public SplFileInfo::openFile(string $mode = "r", bool $useIncludePath = false, ?resource $context = null): SplFileObject

public SplFileInfo::setFileClass(string $class = SplFileObject::class): void

public SplFileInfo::setInfoClass(string $class = SplFileInfo::class): void

public SplFileInfo::__toString(): string

}

预定义常量

SplFileObject::DROP_NEW_LINE: 删除行尾的换行符。
SplFileObject::READ_AHEAD: 使用 rewind 或 next 方法时，从文件中读取一行数据。
SplFileObject::SKIP_EMPTY: 跳过文件中的空白行。这需要启用 READ_AHEAD 标志，以达到预期的效果。
SplFileObject::READ_CSV: 以 CSV 行的形式读取。

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::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 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, enclosure and escape character for CSV
SplFileObject::setFlags — Sets flags for the SplFileObject
SplFileObject::setMaxLineLen — Set maximum line length
SplFileObject::__toString — Alias of SplFileObject::fgets
SplFileObject::valid — Not at EOF

add a note

User Contributed Notes 3 notes

down

Lars Gyrup Brink Nielsen ¶

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

---------------------------------------------------------------------
<?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!
---------------------------------------------------------------------

down

marcus at synchromedia dot co dot uk ¶

7 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);

down

rlazarotto15+dont+spam+me at gmail dot com ¶

1 year ago


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

add a note

官方地址：https://www.php.net/manual/en/class.splfileobject.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言 Linux 开发编程科技 Elasticsearch HTML/CSS/XML 网络 JAVA NoSQL 数据库面试 C/C++ Golang Git 算法操作系统正则表达式 Redis 互联网 MySql JavaScript 运维软件国际架构设计 Mac OS TCP/IP Excel Vim Windows Socket Oracle VR MongoDB Python 运营 MemCache 商业硬件电子娱乐设计 nginx 摄影游戏 WordPress HTTP 团建数码电器

php7 安装fileinfo扩展 preg_split — 通过一个正则表达式分隔字符串 php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题 [PHP] inet_pton/inet_ntop IP地址转换函数 array_multisort() 多字段排序 PHPMailer设置utf8 PHPMailer字符集CharSet ADORecordSet对象 adodb手册 PHP 8.1 [鸟哥]PHP_INT_MIN 和 -9223372036854775808 opcache预加载 Composer的Packagist资源 mysql面试题 [鸟哥]PHP FFI详解 - 一种全新的PHP扩展方式 PHP7添加redis扩展 PHP mkdir()写出来的权限与mode值不符合 Packagist / Composer 中国全量镜像 adodb连接mysql多个数据库的问题 php $_SERVER中的SERVER_NAME 和HTTP_HOST的区别 PHPstorm 里面Terminal 不能使用 esc键吗退出编辑模式吗

略微加速

PHP官方手册 - 互联网笔记

SplFileObject 类

简介

类摘要

预定义常量

目录

User Contributed Notes 3 notes