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

Открытые члены
	__construct ($source=null)
	load ($source)
	setValue ($value)
	getDefaultValue ()
	hasValue ()
	getValue ()
	addValue ($value)
	unsetValue ()
	isHidden ()
	toRestFormat ()
	toPullFormat ()
	setParamId (int $paramId)
	getParamId ()
	setMessageId (int $messageId)
	getMessageId ()
	setName (string $name)
	getName ()
	saveNameFilter ($name)
	setType (string $type)
	getType ()
	detectType ()
	setJsonValue ($value)
	getJsonValue ()
	getPrimaryId ()
	setPrimaryId (int $primaryId)
	isValid ()
	saveValueFilter ($value)
	loadValueFilter ($value)
	saveJsonFilter ($value)
	loadJsonFilter ($value)
Открытые члены унаследованные от MessageParameter
	isDeleted ()
Открытые члены унаследованные от RegistryEntry
	setRegistry (Registry $registry)
	getRegistry ()
Открытые члены унаследованные от ActiveRecord
	prepareFields ()
	getDataEntity ()
	save ()
	delete ()
	markChanged ()
	isChanged ()
	markDrop ()
	isDeleted ()
	fill (array $source)
	toArray (bool $recursive)

Открытые статические члены
static	getDataClass ()

Поля данных
const	TYPE_STRING = 'String'
const	TYPE_INT = 'Integer'
const	TYPE_BOOL = 'Boolean'
const	TYPE_STRING_ARRAY = 'ArrayString'
const	TYPE_INT_ARRAY = 'ArrayInteger'
const	TYPE_DATE_TIME = 'DateTime'
const	TYPE_JSON = 'Json'

Защищенные члены
	shouldProcessEmoji ()

Защищенные статические члены
static	mirrorDataEntityFields ()

Защищенные данные
string	$type = null
int	$paramId = null
int	$messageId = null
string	$name = null
	$value = null
string	$jsonValue = null
	$defaultValue = null

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

Message Parameter Class.

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

Конструктор(ы)

◆ __construct()

__construct ( $source = null )

Аргументы

int | array | EO_MessageParam | null $source

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

Методы

◆ addValue()

addValue ( $value )

Аргументы

mixed $value

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

Замещает MessageParameter.

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

◆ detectType()

detectType ( )

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

◆ getDataClass()

getDataClass ( )

static

Возвращает: string|DataManager;

Замещает ActiveRecord.

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

◆ getDefaultValue()

getDefaultValue ( )

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

Замещает MessageParameter.

Переопределяется в Keyboard и Menu.

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

◆ getJsonValue()

getJsonValue ( )

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

◆ getMessageId()

getMessageId ( )

Замещает MessageParameter.

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

◆ getName()

getName ( )

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

Замещает MessageParameter.

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

◆ getParamId()

getParamId ( )

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

◆ getPrimaryId()

getPrimaryId ( )

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

Замещает ActiveRecord.

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

◆ getType()

getType ( )

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

Замещает MessageParameter.

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

◆ getValue()

getValue ( )

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

Замещает MessageParameter.

Переопределяется в Attach, DateTime, Keyboard, Menu, UserAvatar и UserName.

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

◆ hasValue()

hasValue ( )

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

Замещает MessageParameter.

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

◆ isHidden()

isHidden ( )

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

Замещает MessageParameter.

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

◆ isValid()

isValid ( )

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

Замещает MessageParameter.

Переопределяется в Attach, Keyboard и Menu.

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

◆ load()

load ( $source )

Аргументы

int | array | EntityObject $source

Замещает ActiveRecord.

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

◆ loadJsonFilter()

loadJsonFilter ( $value )

Аргументы

mixed $value

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

Переопределяется в CopilotRoles, Attach, ComponentParams, Keyboard и Menu.

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

◆ loadValueFilter()

loadValueFilter ( $value )

Аргументы

mixed $value

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

Переопределяется в CopilotRoles и DateTime.

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

◆ mirrorDataEntityFields()

mirrorDataEntityFields ( )

staticprotected

Возвращает: array<array>

См. также: Param::getParamId; Param::setParamId; Param::setMessageId; Param::getMessageId; Param::setType; Param::getType; Param::setName; Param::getName; Param::saveNameFilter; Param::setValue; Param::getValue; Param::saveValueFilter; Param::loadValueFilter; Param::setJsonValue; Param::getJsonValue; Param::saveJsonFilter; Param::loadJsonFilter

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

◆ saveJsonFilter()

saveJsonFilter ( $value )

Аргументы

mixed $value

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

Переопределяется в CopilotRoles, Attach, ComponentParams, Keyboard и Menu.

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

◆ saveNameFilter()

saveNameFilter ( $name )

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

◆ saveValueFilter()

saveValueFilter ( $value )

Аргументы

mixed $value

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

Переопределяется в CopilotRoles, Attach, ComponentParams, DateTime, Keyboard и Menu.

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

◆ setJsonValue()

setJsonValue ( $value )

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

◆ setMessageId()

setMessageId ( int $messageId )

Замещает MessageParameter.

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

◆ setName()

setName ( string $name )

См. также: \Bitrix\Im\V2\Message\Params for common names.

Аргументы

string $name

Возвращает: $this

Замещает MessageParameter.

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

◆ setParamId()

setParamId ( int $paramId )

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

◆ setPrimaryId()

setPrimaryId ( int $primaryId )

Аргументы

int $primaryId

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

Замещает ActiveRecord.

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

◆ setType()

setType ( string $type )

См. также: \Bitrix\Im\V2\Message\Param for scalar papam types.

Аргументы

string $type

Возвращает: $this

Замещает MessageParameter.

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

◆ setValue()

setValue ( $value )

Аргументы

mixed $value

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

Замещает MessageParameter.

Переопределяется в CopilotRoles, Attach, ComponentParams, DateTime, Keyboard и Menu.

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

◆ shouldProcessEmoji()

shouldProcessEmoji ( )

protected

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

◆ toPullFormat()

toPullFormat ( )

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

Замещает MessageParameter.

Переопределяется в CopilotRoles, Attach, ComponentParams, Keyboard, Menu и UserAvatar.

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

◆ toRestFormat()

toRestFormat ( )

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

Замещает MessageParameter.

Переопределяется в CopilotRoles, Attach, ComponentParams, DateTime, Keyboard и Menu.

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

◆ unsetValue()

unsetValue ( )

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

Замещает MessageParameter.

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

Поля

◆ $defaultValue

$defaultValue = null

protected

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

◆ $jsonValue

string $jsonValue = null

protected

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

◆ $messageId

int $messageId = null

protected

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

◆ $name

string $name = null

protected

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

◆ $paramId

int $paramId = null

protected

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

◆ $type

string $type = null

protected

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

◆ $value

$value = null

protected

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

◆ TYPE_BOOL

const TYPE_BOOL = 'Boolean'

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

◆ TYPE_DATE_TIME

const TYPE_DATE_TIME = 'DateTime'

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

◆ TYPE_INT

const TYPE_INT = 'Integer'

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

◆ TYPE_INT_ARRAY

const TYPE_INT_ARRAY = 'ArrayInteger'

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

◆ TYPE_JSON

const TYPE_JSON = 'Json'

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

◆ TYPE_STRING

const TYPE_STRING = 'String'

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

◆ TYPE_STRING_ARRAY

const TYPE_STRING_ARRAY = 'ArrayString'

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

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

C:/bitrix/modules/im/lib/V2/Message/Param.php

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

Открытые статические члены

Поля данных

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

Защищенные статические члены

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

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

Конструктор(ы)

◆ __construct()

Методы

◆ addValue()

◆ detectType()

◆ getDataClass()

◆ getDefaultValue()

◆ getJsonValue()

◆ getMessageId()

◆ getName()

◆ getParamId()

◆ getPrimaryId()

◆ getType()

◆ getValue()

◆ hasValue()

◆ isHidden()

◆ isValid()

◆ load()

◆ loadJsonFilter()

◆ loadValueFilter()

◆ mirrorDataEntityFields()

◆ saveJsonFilter()

◆ saveNameFilter()

◆ saveValueFilter()

◆ setJsonValue()

◆ setMessageId()

◆ setName()

◆ setParamId()

◆ setPrimaryId()

◆ setType()

◆ setValue()

◆ shouldProcessEmoji()

◆ toPullFormat()

◆ toRestFormat()

◆ unsetValue()

Поля

◆ $defaultValue

◆ $jsonValue

◆ $messageId

◆ $name

◆ $paramId

◆ $type

◆ $value

◆ TYPE_BOOL

◆ TYPE_DATE_TIME

◆ TYPE_INT

◆ TYPE_INT_ARRAY

◆ TYPE_JSON

◆ TYPE_STRING

◆ TYPE_STRING_ARRAY