Класс File

Граф наследования: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 ()

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

Защищенные данные
	$languageId
	$sourceEncoding
	$operatingEncoding
	$messages = null
	$messagesCount = null
	$messageCodes = []
	$messageEnclosure = []
	$dataPosition = 0
	$fileIndex

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

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

Методы

getLangId()

getLangId

(

)

Returns language code of the file. If it is empty tries to detect it.

Возвращает

string

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

getOperatingEncoding()

getOperatingEncoding

(

)

Returns operating encoding.

Возвращает

string

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

getSourceEncoding()

getSourceEncoding

(

)

Returns source encoding of the file.

Возвращает

string

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

instantiateByIndex()

instantiateByIndex ( Index\FileIndex $fileIndex )

static

Constructs instance by file index.

Аргументы

Index\FileIndex

$fileIndex

Language file index.

Возвращает

Translate\File

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

instantiateByIoFile()

instantiateByIoFile ( Main\IO\File $fileIn )

static

Constructs instance by io file.

Аргументы

Main\IO\File

$fileIn

Language file.

Возвращает

Translate\File

Исключения

Main

ArgumentException

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

instantiateByPath()

instantiateByPath ( string $path )

static

Constructs instance by path.

Аргументы

string

$path

Path to language file.

Возвращает

Translate\File

Исключения

Main

ArgumentException

Переопределяется в Settings.

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

lint()

lint	(	string	$content = '',
		array	$validTokens = [\T_OPEN_TAG, \T_CLOSE_TAG, \T_WHITESPACE, \T_CONSTANT_ENCAPSED_STRING, \T_VARIABLE, \T_COMMENT, \T_DOC_COMMENT] )

Lints php code.

Аргументы

string	$content	Content to validate either content of the current file will be taken.
int[]	$validTokens	Allowed php tokens.
string[]	$validChars	Allowed statement characters.

Возвращает

bool

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

load()

load

(

)

Loads language file for operate.

Возвращает

bool

Исключения

ParseError

Переопределяется в Settings.

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

loadTokens()

loadTokens

(

)

Lints php code.

Возвращает

bool

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

setLangId()

setLangId

(

string

$languageId

)

Sets language code of the file.

Аргументы

string

$languageId

Lang code.

Возвращает

self

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

setOperatingEncoding()

setOperatingEncoding

(

string

$encoding

)

Sets operating encoding.

Аргументы

string

$encoding

Encoding code.

Возвращает

self

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

setSourceEncoding()

setSourceEncoding

(

string

$encoding

)

Sets source encoding of the file.

Аргументы

string

$encoding

Encoding code.

Возвращает

self

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

Поля

$dataPosition

$dataPosition = 0

protected

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

$fileIndex

$fileIndex

protected

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

$languageId

$languageId

protected

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

$messageCodes

$messageCodes = []

protected

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

$messageEnclosure

$messageEnclosure = []

protected

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

$messages

$messages = null

protected

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

$messagesCount

$messagesCount = null

protected

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

$operatingEncoding

$operatingEncoding

protected

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

$sourceEncoding

$sourceEncoding

protected

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

---

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

• C:/bitrix/modules/translate/lib/file.php