Класс Settings

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

Открытые члены
	getOption (string $langPath, string $optionType)
	getOptions (string $langPath='')
	load ()
	save ()
	offsetExists ($code)
	offsetGet ($code)
	offsetSet ($code, $phrase)
	offsetUnset ($code)
	current ()
	next ()
	key ()
	valid ()
	rewind ()
	count ($allowDirectFileAccess=false)
Открытые члены унаследованные от 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=['[', ']', ';', '='])
	loadTokens ()

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

Поля данных
const	FILE_NAME = '.settings.php'
const	OPTION_LANGUAGES = 'languages'

Защищенные данные
	$options
	$optionsCount
	$optionCodes = []
	$dataPosition = 0
Защищенные данные унаследованные от File
	$languageId
	$sourceEncoding
	$operatingEncoding
	$messages = null
	$messagesCount = null
	$messageCodes = []
	$messageEnclosure = []
	$dataPosition = 0
	$fileIndex

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

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

Методы

count()

count

(

$allowDirectFileAccess = false

)

Returns amount phrases in the language file.

Аргументы

bool

$allowDirectFileAccess

Allow include file to count phrases.

Возвращает

int

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

current()

current

(

)

Return the current phrase element.

Возвращает

array|null

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

getOption()

getOption	(	string	$langPath,
		string	$optionType )

Returns option for file/folder.

Аргументы

string	$langPath	Path to language file.
string	$optionType	Option type.

Возвращает

array

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

getOptions()

getOptions

(

string

$langPath = ''

)

Returns option for file/folder.

Аргументы

string

$langPath

Path to language file.

Возвращает

array

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

instantiateByPath()

instantiateByPath ( string $fullPath )

static

Constructs instance by lang path.

Аргументы

string

$fullPath

Full path to language file.

Возвращает

Translate\Settings|null

Исключения

Main

ArgumentException

Переопределяет метод предка File.

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

key()

key

(

)

Return the key of the current phrase element.

Возвращает

string|null

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

load()

load

(

)

Loads option file for operate.

Возвращает

bool

Переопределяет метод предка File.

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

next()

next

(

)

Move forward to next phrase element.

Возвращает

void

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

offsetExists()

offsetExists

(

$code

)

Аргументы

string

$code

Phrase code.

Возвращает

boolean

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

offsetGet()

offsetGet

(

$code

)

Аргументы

string

$code

Phrase code.

Возвращает

string|null

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

offsetSet()

offsetSet	(		$code,
			$phrase )

Offset to set

Аргументы

string	$code	Phrase code.
string	$phrase	Phrase.

Возвращает

void

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

offsetUnset()

offsetUnset

(

$code

)

Unset phrase by code.

Аргументы

string

$code

Language code.

Возвращает

void

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

rewind()

rewind

(

)

Rewind the Iterator to the first element.

Возвращает

void

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

save()

save

(

)

Save changes or create new file.

Возвращает

boolean

Исключения

Main

IO\IoException

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

valid()

valid

(

)

Checks if current position is valid.

Возвращает

boolean

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

Поля

$dataPosition

$dataPosition = 0

protected

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

$optionCodes

$optionCodes = []

protected

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

$options

$options

protected

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

$optionsCount

$optionsCount

protected

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

FILE_NAME

const FILE_NAME = '.settings.php'

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

OPTION_LANGUAGES

const OPTION_LANGUAGES = 'languages'

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

---

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

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