Граф наследования:AbstractFormatType:

Подробное описание

Базовый класс для формата импорта/экспорта данных

Открытые члены
	openFile ($filename, $mode)

	closeFile ()

	writeLine ($data)

	readLine ()

	tellPosition ()

	seekPosition ($position)

	getFileExtension ()

	setOptions (array $options)

	setOption ($key, $value)

	getOption ($key, $default=null)

	prepareExportCellDataCharset ($string_in_utf8, $csv_charset)

	prepareImportCellDataCharset ($string, $csv_charset)

Открытые статические члены
static	getId ()

static	getTitle ()

Поля данных
const	MODE_WRITE = 'write'

const	MODE_READ = 'read'

Защищенные данные
	$options = []

Методы

closeFile ( )

abstract

Закрывает файл

Возвращает: bool

getFileExtension ( )

abstract

Возвращает расширение файла без точки, которое имеет данный формат

Возвращает: string

static getId ( )

staticabstract

Возвращает строковый идентификатор формата данных

Возвращает: string

getOption	(	$key,
		$default = `null`
	)

Возвращает произвольный параметр для импорта/экспорта

Аргументы

string	$key	Ключ параметра
null	$default	Значение параметра по умолчанию

Возвращает: mixed|null

static getTitle ( )

staticabstract

Возвращает название формата данных

Возвращает: string

openFile	(	$filename,
		$mode
	)

abstract

Открывает файл для чтения или записи.

Аргументы

string	$filename	полный путь к файлу
string	$mode	режим, для которого открывается файл - чтение или запись.

Возвращает: bool Возвращает true, если файл может быть успешно открыт

prepareExportCellDataCharset	(	$string_in_utf8,
		$csv_charset
	)

Метод при необходимости подготавливает данные для ячейки. В случае с CSV, данные предварительно нужно переконвертировать в выбранный в настройках формат

Аргументы

string	$string_in_utf8	Строка данных в кодировке UTF-8
string	$csv_charset	Кодировка, выбранная для CSV в настройках системного модуля

Возвращает: false|string

prepareImportCellDataCharset	(	$string,
		$csv_charset
	)

Данный метод должен вернуть строку всегда в UTF-8 формате. В случае с CSV, данные должны быть переконвертированы из тех, что выбранны в настройках в UTF-8

Аргументы

string	$string	Строка данных
string	$csv_charset	Ожидаемая кодировка, выбранная для CSV в настройках системного модуля

Возвращает: false|string

readLine ( )

abstract

Читает одну строку данных из файла

Возвращает: array

seekPosition ( $position )

abstract

Перемещает указатель на нужную позицию в файле

Аргументы

integer $position позиция, которая была возвращена через tellPosition()

Возвращает: mixed

setOption	(	$key,
		$value
	)

Устанавливает произвольный параметр для импорта/экспорта

Аргументы

string	$key	Ключ параметра
string	$value	Значение параметра

setOptions ( array $options )

Устанавливает произвольные параметры для импорта/экспорта

Аргументы

array $options

tellPosition ( )

abstract

Возвращает на какой последней позиции все остановилось

Возвращает: integer

writeLine ( $data )

abstract

Записывает одну строку данных в файл

Аргументы

array $data Данные для одной строки для записи в файл

Возвращает: mixed

Поля

$options = []

protected

const MODE_READ = 'read'

const MODE_WRITE = 'write'

Подробное описание

Открытые члены

Открытые статические члены

Поля данных

Защищенные данные

Методы

Поля