A classe SplFileObject

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

Introdução

A classe SplFileObject oferece uma interface orientada a objetos para um arquivo.

Resumo da classe

class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIterator {

/* Constantes */

public const int DROP_NEW_LINE;

public const int READ_AHEAD;

public const int SKIP_EMPTY;

public const int READ_CSV;

/* Métodos */

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(): null

public getCsvControl(): array

public getFlags(): int

public getMaxLineLen(): int

public hasChildren(): false

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 __toString(): string

public valid(): bool

/* Métodos herdados */

public SplFileInfo::getATime(): int|false

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

public SplFileInfo::getCTime(): int|false

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

}

Constantes predefinidas

SplFileObject::DROP_NEW_LINE: Remove quebras de linha no final de uma linha.
SplFileObject::READ_AHEAD: Lê ao rebobinar/avançar.
SplFileObject::SKIP_EMPTY: Pula linhas vazias no arquivo. Isso requer que a flag READ_AHEAD esteja ativada para funcionar como esperado.
SplFileObject::READ_CSV: Lê linhas como linhas CSV.

Índice

SplFileObject::__construct — Constrói um novo objeto de arquivo
SplFileObject::current — Recupera linha atual do arquivo
SplFileObject::eof — Chegou ao final do arquivo
SplFileObject::fflush — Escreve o buffer de saída para o arquivo
SplFileObject::fgetc — Obtém caractere do arquivo
SplFileObject::fgetcsv — Obtém linha do arquivo e interpreta como campos CSV
SplFileObject::fgets — Obtém linha do arquivo
SplFileObject::fgetss — Obtém linha do arquivo e remove tags HTML
SplFileObject::flock — Bloqueio de arquivo portável
SplFileObject::fpassthru — Produz todos os dados restantes em um ponteiro de arquivo
SplFileObject::fputcsv — Escreve um array de campos como uma linha CSV
SplFileObject::fread — Lê do arquivo
SplFileObject::fscanf — Analisa a entrada do arquivo de acordo com um formato
SplFileObject::fseek — Posiciona-se para uma posição
SplFileObject::fstat — Obtém informações sobre o arquivo
SplFileObject::ftell — Retorna a posição atual do arquivo
SplFileObject::ftruncate — Trunca o arquivo para um determinado comprimento
SplFileObject::fwrite — Escreve no arquivo
SplFileObject::getChildren — Sem objetivo
SplFileObject::getCsvControl — Obtém o delimitador, o caractere de fechamento e o caractere de escape para CSV
SplFileObject::getCurrentLine — Sinônimo de SplFileObject::fgets
SplFileObject::getFlags — Obtém as opções para o SplFileObject
SplFileObject::getMaxLineLen — Obtém o comprimento máximo da linha
SplFileObject::hasChildren — SplFileObject não tem filhos
SplFileObject::key — Obtém o número da linha
SplFileObject::next — Lê próxima linha
SplFileObject::rewind — Rebobina o arquivo para a primeira linha
SplFileObject::seek — Busca uma linha especificada
SplFileObject::setCsvControl — Definir o delimitador, o encapsulador e o caractere de escape para CSV
SplFileObject::setFlags — Define as opções para o SplFileObject
SplFileObject::setMaxLineLen — Define o comprimento máximo da linha
SplFileObject::__toString — Retorna a linha atual como uma string
SplFileObject::valid — Não está no final do arquivo (EOF)

Melhore Esta Página

Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema

＋adicione uma nota

Notas Enviadas por Usuários (em inglês) 4 notes

down

Lars Gyrup Brink Nielsen ¶

11 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 ¶

10 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

contact at trimal dot in ¶

8 months ago

with php 8.3, with or without SplFileObject::DROP_NEW_LINE, you get an array with empty values at the end.

down

-1

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

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

＋adicione uma nota