La clase SplFileObject

(PHP 5 >= 5.1.0, PHP 7)

Introducción

La clase SplFileObject ofrece una interfaz orientada a objetos para un fichero.

Sinopsis de la Clase

SplFileObject extends SplFileInfo implements RecursiveIterator , SeekableIterator {

/* Constantes */

const integer DROP_NEW_LINE = 1 ;

const integer READ_AHEAD = 2 ;

const integer SKIP_EMPTY = 4 ;

const integer READ_CSV = 8 ;

/* Métodos */

public string|array current ( void )

public bool eof ( void )

public bool fflush ( void )

public string fgetc ( void )

public array fgetcsv ([ string $delimiter = "," [, string $enclosure = "\"" [, string $escape = "\\" ]]] )

public string fgets ( void )

public string fgetss ([ string $allowable_tags ] )

public bool flock ( int $operation [, int &$wouldblock ] )

public int fpassthru ( void )

public int fputcsv ( array $fields [, string $delimiter = "," [, string $enclosure = '"' [, string $escape = "\" ]]] )

public string fread ( int $length )

public mixed fscanf ( string $format [, mixed &$... ] )

public int fseek ( int $offset [, int $whence = SEEK_SET ] )

public array fstat ( void )

public int ftell ( void )

public bool ftruncate ( int $size )

public int fwrite ( string $str [, int $length ] )

public void getChildren ( void )

public array getCsvControl ( void )

public int getFlags ( void )

public int getMaxLineLen ( void )

public bool hasChildren ( void )

public int key ( void )

public void next ( void )

public void rewind ( void )

public void seek ( int $line_pos )

public void setCsvControl ([ string $delimiter = "," [, string $enclosure = "\"" [, string $escape = "\\" ]]] )

public void setFlags ( int $flags )

public void setMaxLineLen ( int $max_len )

public void __toString ( void )

public bool valid ( void )

/* Métodos heredados */

public SplFileInfo::__construct ( string $file_name )

public int SplFileInfo::getATime ( void )

public string SplFileInfo::getBasename ([ string $suffix ] )

public int SplFileInfo::getCTime ( void )

public string SplFileInfo::getExtension ( void )

public SplFileInfo SplFileInfo::getFileInfo ([ string $class_name ] )

public string SplFileInfo::getFilename ( void )

public int SplFileInfo::getGroup ( void )

public int SplFileInfo::getInode ( void )

public string SplFileInfo::getLinkTarget ( void )

public int SplFileInfo::getMTime ( void )

public int SplFileInfo::getOwner ( void )

public string SplFileInfo::getPath ( void )

public SplFileInfo SplFileInfo::getPathInfo ([ string $class_name ] )

public string SplFileInfo::getPathname ( void )

public int SplFileInfo::getPerms ( void )

public string SplFileInfo::getRealPath ( void )

public int SplFileInfo::getSize ( void )

public string SplFileInfo::getType ( void )

public bool SplFileInfo::isDir ( void )

public bool SplFileInfo::isExecutable ( void )

public bool SplFileInfo::isFile ( void )

public bool SplFileInfo::isLink ( void )

public bool SplFileInfo::isReadable ( void )

public bool SplFileInfo::isWritable ( void )

public SplFileObject SplFileInfo::openFile ([ string $open_mode = "r" [, bool $use_include_path = false [, resource $context = NULL ]]] )

public void SplFileInfo::setFileClass ([ string $class_name = "SplFileObject" ] )

public void SplFileInfo::setInfoClass ([ string $class_name = "SplFileInfo" ] )

public void SplFileInfo::__toString ( void )

}

Constantes predefinidas

SplFileObject::DROP_NEW_LINE: Colocar nuevas líneas al final de una línea.
SplFileObject::READ_AHEAD: Leer sobre rewind/next.
SplFileObject::SKIP_EMPTY: Saltar líneas vacías en el fichero. Esto requiere que la bandera READ_AHEAD esté activada para que funcione como se tenía previsto.
SplFileObject::READ_CSV: Leer líneas como filas CSV.

Historial de cambios

Versión	Descripción
5.3.9	El valor de `SplFileObject::SKIP_EMPTY` cambió a 4. Anteriormente, el valor era 6.

Tabla de contenidos

SplFileObject::__construct — Construye un nuevo objeto de fichero
SplFileObject::current — Recupera la línea actual del fichero
SplFileObject::eof — Comprueba si es el final del fichero
SplFileObject::fflush — Vuelca el resultado en el fichero
SplFileObject::fgetc — Obtiene un caracter del fichero
SplFileObject::fgetcsv — Obtiene una línea de un fichero y la analiza como campos CSV
SplFileObject::fgets — Obtener la línea de el fichero
SplFileObject::fgetss — Obtiene la línea de el fichero y elimina etiquetas HTML
SplFileObject::flock — Bloqueo de ficheros portable
SplFileObject::fpassthru — Imprimir todos los datos restantes en un apuntador de fichero
SplFileObject::fputcsv — Escribir un array de campos como una línea CSV
SplFileObject::fread — Leer un fichero
SplFileObject::fscanf — Analiza la entrada de un fichero de acuerdo a un formato
SplFileObject::fseek — Mueve el apuntador interno a una posición
SplFileObject::fstat — Obtiene información de el fichero
SplFileObject::ftell — Devuelve la posición del fichero actual
SplFileObject::ftruncate — Trunca el archivo a una longitud dada
SplFileObject::fwrite — Escribe en el fichero
SplFileObject::getChildren — Ningún propósito
SplFileObject::getCsvControl — Obtiene el carácter delimitador y el circundante para campos CSV
SplFileObject::getCurrentLine — Alias de SplFileObject::fgets
SplFileObject::getFlags — Obtener las flags de SplFileObject
SplFileObject::getMaxLineLen — Obtener la longitud máxima de línea
SplFileObject::hasChildren — SplFileObject no tiene hijos
SplFileObject::key — Obtiene el número de línea
SplFileObject::next — Leer la siguiente línea
SplFileObject::rewind — Rebobina el fichero hasta la primera línea
SplFileObject::seek — Mueve el apuntador interno a la línea específicada
SplFileObject::setCsvControl — Establece el carácter delimitador y el circundante para campos CSV
SplFileObject::setFlags — Establece flags para el SplFileObject
SplFileObject::setMaxLineLen — Establecer la longitud máxima de una línea
SplFileObject::__toString — Alias de SplFileObject::current
SplFileObject::valid — Comprueba si el final del finchero ha sido alcanzado