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

Открытые члены
	openLoad ()
	openWrite (string $mode=Main\IO\FileStreamOpenMode::WRITE)
	setUtf8Bom (string $mark=self::BOM_TYPE_UTF8)
	hasUtf8Bom ()
	prefaceWithUtf8Bom (bool $exists=true)
	checkUtf8Bom ()
	setFieldsType (string $fieldsType=self::FIELDS_TYPE_WITH_DELIMITER)
	setFieldDelimiter (string $fieldDelimiter=self::DELIMITER_TZP)
	setRowDelimiter (string $rowDelimiter=self::LINE_DELIMITER_WIN)
	setFirstHeader (bool $firstHeader=false)
	getFirstHeader ()
	setWidthMap (array $mapFields)
	fetch ()
	moveFirst ()
	getPos ()
	setPos (int $position=0)
	put (array $fields)
Открытые члены унаследованные от File
	getLangId ()
	setLangId (string $languageId)
	getSourceEncoding ()
	setSourceEncoding (string $encoding)
	getOperatingEncoding ()
	setOperatingEncoding (string $encoding)
	lint (string $content='', array $validTokens=[\T_OPEN_TAG, \T_CLOSE_TAG, \T_WHITESPACE, \T_CONSTANT_ENCAPSED_STRING, \T_VARIABLE, \T_COMMENT, \T_DOC_COMMENT], array $validChars=['[', ']', ';', '='])
	load ()
	loadTokens ()

Поля данных
const	FIELDS_TYPE_FIXED_WIDTH = 'F'
const	FIELDS_TYPE_WITH_DELIMITER = 'R'
const	ERROR_32K_FIELD_LENGTH = '32k_field_length'
const	DELIMITER_TAB = "\t"
const	DELIMITER_ZPT = ','
const	DELIMITER_SPS = ' '
const	DELIMITER_TZP = ';'
const	BOM_TYPE_UTF8 = "\xEF\xBB\xBF"
const	LINE_DELIMITER_WIN = "\r\n"
const	LINE_DELIMITER_UNIX = "\r"

Защищенные члены
	fetchDelimiter ()
	fetchWidth ()
	incrementCurrentPosition ()

Защищенные данные
	$fieldsType = self::FIELDS_TYPE_WITH_DELIMITER
	$fieldDelimiter = self::DELIMITER_TZP
	$bomMark = self::BOM_TYPE_UTF8
	$hasBom = false
	$rowDelimiter = self::LINE_DELIMITER_WIN
	$widthMap = []
	$firstHeader = false
Защищенные данные унаследованные от File
	$languageId
	$sourceEncoding
	$operatingEncoding
	$messages = null
	$messagesCount = null
	$messageCodes = []
	$messageEnclosure = []
	$dataPosition = 0
	$fileIndex

Дополнительные унаследованные члены
Открытые статические члены унаследованные от File
static	instantiateByPath (string $path)
static	instantiateByIndex (Index\FileIndex $fileIndex)
static	instantiateByIoFile (Main\IO\File $fileIn)

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

См. определение в файле csvfile.php строка 8

Методы

◆ checkUtf8Bom()

checkUtf8Bom ( )

Check UTF-8 Byte-Order Mark

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

См. определение в файле csvfile.php строка 182

◆ fetch()

fetch ( )

Fetch data row.

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

См. определение в файле csvfile.php строка 458

◆ fetchDelimiter()

fetchDelimiter ( )

protected

Fetches data row as delimited columns.

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

См. определение в файле csvfile.php строка 290

◆ fetchWidth()

fetchWidth ( )

protected

Fetches data row as fixed width columns.

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

См. определение в файле csvfile.php строка 382

◆ getFirstHeader()

getFirstHeader ( )

Tells true if first row is a header.

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

См. определение в файле csvfile.php строка 263

◆ getPos()

getPos ( )

Returns reading position.

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

См. определение в файле csvfile.php строка 510

◆ hasUtf8Bom()

hasUtf8Bom ( )

Tells true if UTF Byte-Order Mark exists in the file.

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

См. определение в файле csvfile.php строка 159

◆ incrementCurrentPosition()

incrementCurrentPosition ( )

protected

Moves reading position and reads file into buffer.

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

См. определение в файле csvfile.php строка 483

◆ moveFirst()

moveFirst ( )

Moves reading position to the first byte.

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

См. определение в файле csvfile.php строка 500

◆ openLoad()

openLoad ( )

Opens file for reading.

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

См. определение в файле csvfile.php строка 95

◆ openWrite()

openWrite ( string $mode = Main\IO\FileStreamOpenMode::WRITE )

Opens file for writing.

Аргументы

string $mode File writing mode.

См. также: \Bitrix\Main\IO\FileStreamOpenMode

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

См. определение в файле csvfile.php строка 116

◆ prefaceWithUtf8Bom()

prefaceWithUtf8Bom ( bool $exists = true )

Sets if UTF-8 Byte-Order Mark exists.

Аргументы

bool $exists Flag value to setup.

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

См. определение в файле csvfile.php строка 171

◆ put()

put ( array $fields )

Writes data fields into file as row.

Аргументы

array $fields Data field.

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

См. определение в файле csvfile.php строка 553

◆ setFieldDelimiter()

setFieldDelimiter ( string $fieldDelimiter = self::DELIMITER_TZP )

Sets up delimiter character.

Аргументы

string $fieldDelimiter Char.

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

См. определение в файле csvfile.php строка 224

◆ setFieldsType()

setFieldsType ( string $fieldsType = self::FIELDS_TYPE_WITH_DELIMITER )

Set fields type.

Аргументы

string $fieldsType Type.

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

См. определение в файле csvfile.php строка 209

◆ setFirstHeader()

setFirstHeader ( bool $firstHeader = false )

Sets first row as a header.

Аргументы

bool $firstHeader Flag.

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

См. определение в файле csvfile.php строка 251

◆ setPos()

setPos ( int $position = 0 )

Sets new reading position.

Аргументы

int $position Reading position.

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

См. определение в файле csvfile.php строка 522

◆ setRowDelimiter()

setRowDelimiter ( string $rowDelimiter = self::LINE_DELIMITER_WIN )

Sets up row delimiter character.

Аргументы

string $rowDelimiter Char.

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

См. определение в файле csvfile.php строка 238

◆ setUtf8Bom()

setUtf8Bom ( string $mark = self::BOM_TYPE_UTF8 )

Sets UTF Byte-Order Mark.

Аргументы

string $mark BOM mark.

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

См. определение в файле csvfile.php строка 147

◆ setWidthMap()

setWidthMap ( array $mapFields )

Sets up fields widths.

Аргументы

int[] $mapFields Fields widths.

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

См. определение в файле csvfile.php строка 274

Поля

◆ $bomMark

$bomMark = self::BOM_TYPE_UTF8

protected

См. определение в файле csvfile.php строка 43

◆ $fieldDelimiter

$fieldDelimiter = self::DELIMITER_TZP

protected

См. определение в файле csvfile.php строка 34

◆ $fieldsType

$fieldsType = self::FIELDS_TYPE_WITH_DELIMITER

protected

См. определение в файле csvfile.php строка 22

◆ $firstHeader

$firstHeader = false

protected

См. определение в файле csvfile.php строка 70

◆ $hasBom

$hasBom = false

protected

См. определение в файле csvfile.php строка 49

◆ $rowDelimiter

$rowDelimiter = self::LINE_DELIMITER_WIN

protected

См. определение в файле csvfile.php строка 58

◆ $widthMap

$widthMap = []

protected

См. определение в файле csvfile.php строка 64

◆ BOM_TYPE_UTF8

const BOM_TYPE_UTF8 = "\xEF\xBB\xBF"

См. определение в файле csvfile.php строка 37

◆ DELIMITER_SPS

const DELIMITER_SPS = ' '

См. определение в файле csvfile.php строка 27

◆ DELIMITER_TAB

const DELIMITER_TAB = "\t"

См. определение в файле csvfile.php строка 25

◆ DELIMITER_TZP

const DELIMITER_TZP = ';'

См. определение в файле csvfile.php строка 28

◆ DELIMITER_ZPT

const DELIMITER_ZPT = ','

См. определение в файле csvfile.php строка 26

◆ ERROR_32K_FIELD_LENGTH

const ERROR_32K_FIELD_LENGTH = '32k_field_length'

См. определение в файле csvfile.php строка 16

◆ FIELDS_TYPE_FIXED_WIDTH

const FIELDS_TYPE_FIXED_WIDTH = 'F'

См. определение в файле csvfile.php строка 12

◆ FIELDS_TYPE_WITH_DELIMITER

const FIELDS_TYPE_WITH_DELIMITER = 'R'

См. определение в файле csvfile.php строка 14

◆ LINE_DELIMITER_UNIX

const LINE_DELIMITER_UNIX = "\r"

См. определение в файле csvfile.php строка 52

◆ LINE_DELIMITER_WIN

const LINE_DELIMITER_WIN = "\r\n"

См. определение в файле csvfile.php строка 51

Объявления и описания членов класса находятся в файле:

C:/bitrix/modules/translate/lib/io/csvfile.php

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

Поля данных

Защищенные члены

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

Дополнительные унаследованные члены

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

Методы

◆ checkUtf8Bom()

◆ fetch()

◆ fetchDelimiter()

◆ fetchWidth()

◆ getFirstHeader()

◆ getPos()

◆ hasUtf8Bom()

◆ incrementCurrentPosition()

◆ moveFirst()

◆ openLoad()

◆ openWrite()

◆ prefaceWithUtf8Bom()

◆ put()

◆ setFieldDelimiter()

◆ setFieldsType()

◆ setFirstHeader()

◆ setPos()

◆ setRowDelimiter()

◆ setUtf8Bom()

◆ setWidthMap()

Поля

◆ $bomMark

◆ $fieldDelimiter

◆ $fieldsType

◆ $firstHeader

◆ $hasBom

◆ $rowDelimiter

◆ $widthMap

◆ BOM_TYPE_UTF8

◆ DELIMITER_SPS

◆ DELIMITER_TAB

◆ DELIMITER_TZP

◆ DELIMITER_ZPT

◆ ERROR_32K_FIELD_LENGTH

◆ FIELDS_TYPE_FIXED_WIDTH

◆ FIELDS_TYPE_WITH_DELIMITER

◆ LINE_DELIMITER_UNIX

◆ LINE_DELIMITER_WIN