Класс __CControllerPacket

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

Открытые члены
	isDebugEnabled ()
	getDebugLogDirectory ()
	getDebugLogFileName ()
	Debug ($sText)
	Check ()
	Sign ()

Поля данных
	$debug_const = ''
	$debug_file_const = ''
	$member_id
	$session_id
	$version
	$strParameters = ""
	$arParameters = []
	$hash
	$secret_id
	$encoding

Защищенные члены
	unpackParameters ($parameters, $encoding='')
	_decode (&$arParameters, $encodingFrom, $encodingTo)

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

Class __CControllerPacket

Base class for various types of packets.

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

Методы

_decode()

_decode ( & $arParameters, $encodingFrom, $encodingTo )

protected

Recursively converts arParameter character set.

Аргументы

array	&$arParameters	Input/Output parameter.
string	$encodingFrom	Encoding character set identifier.
string	$encodingTo	Encoding character set identifier.

Возвращает

void

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

Check()

Check

(

)

Checks given parameters signature against $hash member.

Аргументы

string

$parameter,...

Parameter to be checked

Возвращает

boolean

Переопределяется в __CControllerPacketRequest, __CControllerPacketResponse и CControllerClientRequestFrom.

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

Debug()

Debug

(

$sText

)

Writes given information into log file.

Аргументы

string | array

$sText

Text to write to log.

Возвращает

void

См. также

__CControllerPacket\isDebugEnabled

__CControllerPacket\getDebugLogDirectory

__CControllerPacket\getDebugLogFileName

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

getDebugLogDirectory()

getDebugLogDirectory

(

)

Returns debug logs directory. You may define constant CONTROLLER_CLIENT_LOG_DIR. It's value must end with directory delimiter. By default, logging will be into /bitrix/controller_logs/ directory under the DOCUMENT_ROOT.

Возвращает

string

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

getDebugLogFileName()

getDebugLogFileName

(

)

Returns log file name. It's equal to session identifier or if there is no session it's randomized.

Возвращает

string

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

isDebugEnabled()

isDebugEnabled

(

)

Returns true if debug is enabled.

Возвращает

boolean

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

Sign()

Sign

(

)

Returns signature for given parameters. Sets $hash member with calculated value.

Аргументы

string

$parameter,...

Parameter to be checked

Возвращает

boolean

Переопределяется в __CControllerPacketRequest и __CControllerPacketResponse.

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

unpackParameters()

unpackParameters ( $parameters, $encoding = '' )

protected

Unpacks $parameters and converts it using given $encoding into site charset. Preserves "file" member of the array.

Аргументы

string	$parameters	Serialized data.
string	$encoding	Encoding character set identifier.

Возвращает

mixed|null

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

Поля

$arParameters

$arParameters = []

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

$debug_const

$debug_const = ''

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

$debug_file_const

$debug_file_const = ''

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

$encoding

$encoding

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

$hash

$hash

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

$member_id

$member_id

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

$secret_id

$secret_id

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

$session_id

$session_id

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

$strParameters

$strParameters = ""

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

$version

$version

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

---

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

• C:/bitrix/modules/main/classes/general/controller_member.php