(PHP 5 >= 5.1.0, PHP 7, PHP 8)
Introduction
La classe SplFileObject offre une interface orientée objet pour un fichier.
Synopsis de la 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éthodes */
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
= "\\"
): 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éthodes héritées */
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 pré-définies
SplFileObject::DROP_NEW_LINE
-
Supprime les nouvelles lignes à la fin d'une ligne.
SplFileObject::READ_AHEAD
-
Lecture sur rewind/next.
SplFileObject::SKIP_EMPTY
-
Ignore les lignes vierges du fichier. Ceci nécessite l'activation
du drapeau READ_AHEAD
afin de fonctionner comme attendu.
SplFileObject::READ_CSV
-
Lit les lignes en tant que lignes CSV.
Sommaire
- SplFileObject::__construct — Construit un nouvel objet fichier
- SplFileObject::current — Récupère la ligne courante d'un fichier
- SplFileObject::eof — Vérifie si la fin du fichier est atteinte
- SplFileObject::fflush — Écrit l'affichage dans le fichier
- SplFileObject::fgetc — Récupère un caractère depuis le fichier
- SplFileObject::fgetcsv — Récupère une ligne depuis le fichier et l'analyse comme étant des données CSV
- SplFileObject::fgets — Récupère une ligne d'un fichier
- SplFileObject::fgetss — Récupère une ligne d'un fichier et supprime les balises HTML
- SplFileObject::flock — Verrouille ou déverrouille un fichier
- SplFileObject::fpassthru — Affiche toutes les données en attente sur un pointeur de fichier
- SplFileObject::fputcsv — Écrit un tableau sous la forme d'une ligne CSV
- SplFileObject::fread — Lit depuis un fichier
- SplFileObject::fscanf — Analyse une entrée d'un fichier suivant un format donné
- SplFileObject::fseek — Se déplace à une position donnée
- SplFileObject::fstat — Récupère les informations d'un fichier
- SplFileObject::ftell — Retourne la position courant dans le fichier
- SplFileObject::ftruncate — Coupe le fichier à une longueur donnée
- SplFileObject::fwrite — Écrit dans le fichier
- SplFileObject::getChildren — Récupère le fils
- SplFileObject::getCsvControl — Récupère les options pour CSV
- SplFileObject::getCurrentLine — Alias de SplFileObject::fgets
- SplFileObject::getFlags — Récupère les drapeaux pour l'objet SplFileObject
- SplFileObject::getMaxLineLen — Récupère la longueur maximale d'une ligne
- SplFileObject::hasChildren — Vérifie si SplFileObject a un fils
- SplFileObject::key — Récupère le numéro de la ligne courant
- SplFileObject::next — Se déplace sur la prochaine ligne
- SplFileObject::rewind — Réinitialise le fichier à la première ligne
- SplFileObject::seek — Se déplace sur une ligne spécifique
- SplFileObject::setCsvControl — Définit les options CSV
- SplFileObject::setFlags — Définit les drapeaux pour l'objet SplFileObject
- SplFileObject::setMaxLineLen — Définit la longueur maximale d'une ligne
- SplFileObject::__toString — Retourne la ligne courante sous forme de chaîne de caractères
- SplFileObject::valid — Vérifie si la fin du fichier a été atteinte