Класс Params

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

Открытые члены
	isLoaded ()
	load ($source)
	loadByMessage (Message $message)
	loadByMessageId (int $messageId)
	delete ()
	isSet (string $paramName)
	offsetExists ($offset)
	get (string $paramName)
	set (string $paramName, $parameter)
	add (MessageParameter $parameter)
	offsetSet ($offset, $entry)
	remove (string $paramName='')
	clear ()
	offsetUnset ($offset)
	setMessageId (int $messageId)
	getMessageId ()
	toArray ()
	toRestFormat ()
	toPullFormat (?array $extraParams=null)
	fill (array $values)
	__clone ()
Открытые члены унаследованные от Registry
	unsetByKeys (array $keys)
	mergeRegistry (Registry $registry)
	filter (callable $predicate)
	getAny ()
	isEmpty ()

Открытые статические члены
static	getType (string $paramName)
static	addType (string $paramName, array $description)
static	initTypes ()
static	create (string $paramName)

Поля данных
const	EVENT_MESSAGE_PARAM_TYPE_INIT = 'OnMessageParamTypesInit'
const	FILE_ID = 'FILE_ID'
const	ATTACH = 'ATTACH'
const	MENU = 'MENU'
const	KEYBOARD = 'KEYBOARD'
const	KEYBOARD_UID = 'KEYBOARD_UID'
const	IS_DELETED = 'IS_DELETED'
const	IS_ERROR = 'IS_ERROR'
const	IS_DELIVERED = 'IS_DELIVERED'
const	IS_EDITED = 'IS_EDITED'
const	IS_PINNED = 'IS_PINNED'
const	CAN_ANSWER = 'CAN_ANSWER'
const	URL_ONLY = 'URL_ONLY'
const	LARGE_FONT = 'LARGE_FONT'
const	SENDING = 'SENDING'
const	SENDING_TS = 'SENDING_TS'
const	USER_ID = 'USER_ID'
const	AVATAR = 'AVATAR'
const	NAME = 'NAME'
const	NOTIFY = 'NOTIFY'
const	CODE = 'CODE'
const	TYPE = 'TYPE'
const	COMPONENT_ID = 'COMPONENT_ID'
const	COMPONENT_PARAMS = 'COMPONENT_PARAMS'
const	STYLE_CLASS = 'CLASS'
const	CALL_ID = 'CALL_ID'
const	CHAT_ID = 'CHAT_ID'
const	CHAT_MESSAGE = 'CHAT_MESSAGE'
const	CHAT_USER = 'CHAT_USER'
const	DATE_TS = 'DATE_TS'
const	LIKE = 'LIKE'
const	FAVORITE = 'FAVORITE'
const	KEYBOARD_ACTION = 'KEYBOARD_ACTION'
const	URL_ID = 'URL_ID'
const	LINK_ACTIVE = 'LINK_ACTIVE'
const	USERS = 'USERS'
const	CHAT_LAST_DATE = 'CHAT_LAST_DATE'
const	DATE_TEXT = 'DATE_TEXT'
const	IS_ROBOT_MESSAGE = 'IS_ROBOT_MESSAGE'
const	FORWARD_ID = 'FORWARD_ID'
const	FORWARD_CONTEXT_ID = 'FORWARD_CONTEXT_ID'
const	FORWARD_USER_ID = 'FORWARD_USER_ID'
const	FORWARD_CHAT_TITLE = 'FORWARD_CHAT_TITLE'
const	REPLY_ID = 'REPLY_ID'
const	BETA = 'BETA'
const	COPILOT_PROMPT_CODE = 'COPILOT_PROMPT_CODE'
const	COPILOT_ROLE = 'COPILOT_ROLE'
const	CRM_FORM_FILLED = 'CRM_FORM_FILLED'
const	CRM_FORM_ID = 'CRM_FORM_ID'
const	CRM_FORM_SEC = 'CRM_FORM_SEC'

Защищенные члены
	initByArray (array $items)
	initByDataEntity (ORM\Objectify\EntityObject $entity)

Защищенные данные
bool	$isLoaded = false
int	$messageId = null
array	$droppedItems = []

Статические защищенные данные
static bool	$typeLoaded = false
static array	$typeMap

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

<int,MessageParameter> @method MessageParameter offsetGet($key)

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

Методы

__clone()

__clone

(

)

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

add()

add

(

MessageParameter

$parameter

)

Аргументы

mixed

$parameter

Возвращает

self

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

addType()

addType ( string $paramName, array $description )

static

Add new message parameter description.

Аргументы

string	$paramName
array	$description

Возвращает

void

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

clear()

clear

(

)

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

create()

create ( string $paramName )

static

Returns instance of Parameter.

Аргументы

string

$paramName

Возвращает

MessageParameter

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

delete()

delete

(

)

Drops all message params.

Возвращает

Result

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

fill()

fill

(

array

$values

)

Аргументы

array<string,mixed>

$values

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

get()

get

(

string

$paramName

)

Аргументы

string

$paramName

Возвращает

MessageParameter

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

getMessageId()

getMessageId

(

)

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

getType()

getType ( string $paramName )

static

Returns message parameter description.

Аргументы

string

$paramName

Возвращает

array<string: type, string: className, mixed: default, callable: saveValueFilter, callable: loadValueFilter>

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

initByArray()

initByArray ( array $items )

protected

Аргументы

array

$items

Возвращает

Result

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

initByDataEntity()

initByDataEntity ( ORM\Objectify\EntityObject $entity )

protected

Аргументы

ORM\Objectify\EntityObject

$entity

Возвращает

Result

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

initTypes()

initTypes ( )

static

Loads specific modules message parameter types from .settings.php.

Возвращает

void

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

isLoaded()

isLoaded

(

)

Tells true if paraams have been loaded from DB.

Возвращает

bool

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

isSet()

isSet

(

string

$paramName

)

Аргументы

string

$paramName

Возвращает

bool

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

load()

load

(

$source

)

Аргументы

array | ORM\Objectify\Collection | ORM\Objectify\EntityObject | EO_MessageParam_Collection | EO_MessageParam

$source

Возвращает

Result

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

loadByMessage()

loadByMessage

(

Message

$message

)

Аргументы

Message

$message

Возвращает

Result

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

loadByMessageId()

loadByMessageId

(

int

$messageId

)

Аргументы

int

$messageId

Возвращает

Result

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

offsetExists()

offsetExists

(

$offset

)

Аргументы

string

$offset

Возвращает

bool

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

offsetSet()

offsetSet	(		$offset,
			$entry )

Alias to add method.

Аргументы

string	$offset
MessageParameter	$entry

Возвращает

void

Исключения

ArgumentTypeException

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

offsetUnset()

offsetUnset

(

$offset

)

Аргументы

string

$offset

Возвращает

void

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

remove()

remove

(

string

$paramName = ''

)

Аргументы

string

$paramName

Возвращает

self

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

set()

set	(	string	$paramName,
			$parameter )

Аргументы

string	$paramName
mixed	$parameter

Возвращает

self

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

setMessageId()

setMessageId

(

int

$messageId

)

Аргументы

int

$messageId

Возвращает

$this

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

toArray()

toArray

(

)

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

toPullFormat()

toPullFormat

(

?array

$extraParams = null

)

Возвращает

array

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

toRestFormat()

toRestFormat

(

)

Возвращает

array<string, string|array>

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

Поля

$droppedItems

array $droppedItems = []

protected

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

$isLoaded

bool $isLoaded = false

protected

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

$messageId

int $messageId = null

protected

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

$typeLoaded

bool $typeLoaded = false

staticprotected

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

$typeMap

array $typeMap

staticprotected

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

ATTACH

const ATTACH = 'ATTACH'

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

AVATAR

const AVATAR = 'AVATAR'

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

BETA

const BETA = 'BETA'

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

CALL_ID

const CALL_ID = 'CALL_ID'

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

CAN_ANSWER

const CAN_ANSWER = 'CAN_ANSWER'

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

CHAT_ID

const CHAT_ID = 'CHAT_ID'

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

CHAT_LAST_DATE

const CHAT_LAST_DATE = 'CHAT_LAST_DATE'

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

CHAT_MESSAGE

const CHAT_MESSAGE = 'CHAT_MESSAGE'

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

CHAT_USER

const CHAT_USER = 'CHAT_USER'

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

CODE

const CODE = 'CODE'

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

COMPONENT_ID

const COMPONENT_ID = 'COMPONENT_ID'

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

COMPONENT_PARAMS

const COMPONENT_PARAMS = 'COMPONENT_PARAMS'

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

COPILOT_PROMPT_CODE

const COPILOT_PROMPT_CODE = 'COPILOT_PROMPT_CODE'

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

COPILOT_ROLE

const COPILOT_ROLE = 'COPILOT_ROLE'

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

CRM_FORM_FILLED

const CRM_FORM_FILLED = 'CRM_FORM_FILLED'

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

CRM_FORM_ID

const CRM_FORM_ID = 'CRM_FORM_ID'

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

CRM_FORM_SEC

const CRM_FORM_SEC = 'CRM_FORM_SEC'

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

DATE_TEXT

const DATE_TEXT = 'DATE_TEXT'

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

DATE_TS

const DATE_TS = 'DATE_TS'

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

EVENT_MESSAGE_PARAM_TYPE_INIT

const EVENT_MESSAGE_PARAM_TYPE_INIT = 'OnMessageParamTypesInit'

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

FAVORITE

const FAVORITE = 'FAVORITE'

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

FILE_ID

const FILE_ID = 'FILE_ID'

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

FORWARD_CHAT_TITLE

const FORWARD_CHAT_TITLE = 'FORWARD_CHAT_TITLE'

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

FORWARD_CONTEXT_ID

const FORWARD_CONTEXT_ID = 'FORWARD_CONTEXT_ID'

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

FORWARD_ID

const FORWARD_ID = 'FORWARD_ID'

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

FORWARD_USER_ID

const FORWARD_USER_ID = 'FORWARD_USER_ID'

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

IS_DELETED

const IS_DELETED = 'IS_DELETED'

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

IS_DELIVERED

const IS_DELIVERED = 'IS_DELIVERED'

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

IS_EDITED

const IS_EDITED = 'IS_EDITED'

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

IS_ERROR

const IS_ERROR = 'IS_ERROR'

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

IS_PINNED

const IS_PINNED = 'IS_PINNED'

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

IS_ROBOT_MESSAGE

const IS_ROBOT_MESSAGE = 'IS_ROBOT_MESSAGE'

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

KEYBOARD

const KEYBOARD = 'KEYBOARD'

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

KEYBOARD_ACTION

const KEYBOARD_ACTION = 'KEYBOARD_ACTION'

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

KEYBOARD_UID

const KEYBOARD_UID = 'KEYBOARD_UID'

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

LARGE_FONT

const LARGE_FONT = 'LARGE_FONT'

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

LIKE

const LIKE = 'LIKE'

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

LINK_ACTIVE

const LINK_ACTIVE = 'LINK_ACTIVE'

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

MENU

const MENU = 'MENU'

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

NAME

const NAME = 'NAME'

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

NOTIFY

const NOTIFY = 'NOTIFY'

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

REPLY_ID

const REPLY_ID = 'REPLY_ID'

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

SENDING

const SENDING = 'SENDING'

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

SENDING_TS

const SENDING_TS = 'SENDING_TS'

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

STYLE_CLASS

const STYLE_CLASS = 'CLASS'

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

TYPE

const TYPE = 'TYPE'

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

URL_ID

const URL_ID = 'URL_ID'

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

URL_ONLY

const URL_ONLY = 'URL_ONLY'

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

USER_ID

const USER_ID = 'USER_ID'

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

USERS

const USERS = 'USERS'

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

---

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

• C:/bitrix/modules/im/lib/V2/Message/Params.php