Класс SplFileObject | Руководство по PHP

Вернуться к: Обработка файлов

(PHP 5 >= 5.1.0, PHP 7)

Введение

Класс SplFileObject предоставляет объектно-ориентированный интерфейс для файлов.

Обзор классов

SplFileObject extends SplFileInfo implements RecursiveIterator , SeekableIterator {

/* Константы */

const integer DROP_NEW_LINE = 1 ;

const integer READ_AHEAD = 2 ;

const integer SKIP_EMPTY = 4 ;

const integer READ_CSV = 8 ;

/* Методы */

public __construct ( string $filename [, string $open_mode = "r" [, bool $use_include_path = false [, resource $context ]]] )

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 = '"' ]] )

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 )

/* Наследуемые методы */

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 )

}

Предопределенные константы

SplFileObject::DROP_NEW_LINE: Удаляет символы переноса в конце строки.
SplFileObject::READ_AHEAD: Читает при использовании функций rewind/next.
SplFileObject::SKIP_EMPTY: Пропускает пустые строки с файле. Для правильной работы требуется включить флаг READ_AHEAD.
SplFileObject::READ_CSV: Читает строки в формате CSV.

Список изменений

Версия	Описание
5.3.9	Значение `SplFileObject::SKIP_EMPTY` изменено на 4. Раньше значение было равным 6.

Содержание

SplFileObject::__construct — Конструктор класса SplFileObject
SplFileObject::current — Получение текущей строки файла
SplFileObject::eof — Проверяет, достигнут ли конец файла
SplFileObject::fflush — Сбрасывает буфер вывода в файл
SplFileObject::fgetc — Читает символ из файла
SplFileObject::fgetcsv — Получение строки файла и ее разбор в соответствии с CSV разметкой
SplFileObject::fgets — Читает строку из файла
SplFileObject::fgetss — Получение строки из файла с очисткой от HTML тэгов
SplFileObject::flock — Портируемая блокировка файла
SplFileObject::fpassthru — Выводит все оставшееся содержимое файла в выходной поток
SplFileObject::fputcsv — Записывает массив с полями в виде строки CSV
SplFileObject::fread — Read from file
SplFileObject::fscanf — Разбор строки файла в соответствии с заданным форматом
SplFileObject::fseek — Перевод файлового указателя на заданную позицию
SplFileObject::fstat — Получает информацию о файле
SplFileObject::ftell — Определение текущей позиции файлового указателя
SplFileObject::ftruncate — Обрезает файл до заданной длины
SplFileObject::fwrite — Запись в файл
SplFileObject::getChildren — Метод-заглушка
SplFileObject::getCsvControl — Получает символы разделителя и ограничителя для CSV
SplFileObject::getCurrentLine — Псевдоним метода SplFileObject::fgets
SplFileObject::getFlags — Получает флаги настройки объекта SplFileObject
SplFileObject::getMaxLineLen — Получает максимальную длину строки
SplFileObject::hasChildren — Класс SplFileObject не имеет наследников
SplFileObject::key — Получение номера строки
SplFileObject::next — Читает следующую строку
SplFileObject::rewind — Перевод файлового указателя в начало файла
SplFileObject::seek — Перевод файлового указателя на заданную строку
SplFileObject::setCsvControl — Устанавливает символы разделителя и ограничителя для CSV
SplFileObject::setFlags — Устанавливает флаги для SplFileObject
SplFileObject::setMaxLineLen — Устанавливает максимальную длину строки
SplFileObject::__toString — Псевдоним SplFileObject::current
SplFileObject::valid — Проверяет, достигнут ли конец файла (EOF)

Вернуться к: Обработка файлов