Класс Param

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

Открытые статические члены
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'

Защищенные статические члены
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 строка 18

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

__construct()

__construct

(

$source = null

)

Аргументы

int | array | EO_MessageParam | null

$source

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

Методы

addValue()

addValue

(

$value

)

Аргументы

mixed

$value

Возвращает

static

Замещает MessageParameter.

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

detectType()

detectType

(

)

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

getDataClass()

static getDataClass ( )

static

Возвращает

string|DataManager;

Замещает ActiveRecord.

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

getDefaultValue()

getDefaultValue

(

)

Возвращает

mixed|null

Замещает MessageParameter.

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

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

getJsonValue()

getJsonValue

(

)

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

getMessageId()

getMessageId

(

)

Замещает MessageParameter.

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

getName()

getName

(

)

Возвращает

string|null

Замещает MessageParameter.

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

getParamId()

getParamId

(

)

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

getPrimaryId()

getPrimaryId

(

)

Возвращает

int|null

Замещает ActiveRecord.

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

getType()

getType

(

)

Возвращает

string

Замещает MessageParameter.

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

getValue()

getValue

(

)

Возвращает

mixed|null

Замещает MessageParameter.

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

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

hasValue()

hasValue

(

)

Возвращает

bool

Замещает MessageParameter.

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

isHidden()

isHidden

(

)

Возвращает

bool

Замещает MessageParameter.

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

isValid()

isValid

(

)

Возвращает

Result

Замещает MessageParameter.

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

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

load()

load

(

$source

)

Аргументы

int | array | EntityObject

$source

Замещает ActiveRecord.

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

loadJsonFilter()

loadJsonFilter

(

$value

)

Аргументы

mixed

$value

Возвращает

mixed

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

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

loadValueFilter()

loadValueFilter

(

$value

)

Аргументы

mixed

$value

Возвращает

mixed

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

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

mirrorDataEntityFields()

static mirrorDataEntityFields ( )

staticprotected

Возвращает

array<array>

См. также

Param::getChatId

Param::setChatId

Param::setMessageId

Param::getMessageId

Param::setType

Param::getType

Param::setName

Param::getName

Param::setValue

Param::getValue

Param::saveValueFilter

Param::loadValueFilter

Param::setJsonValue

Param::getJsonValue

Param::saveJsonFilter

Param::loadJsonFilter

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

saveJsonFilter()

saveJsonFilter

(

$value

)

Аргументы

mixed

$value

Возвращает

mixed

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

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

saveValueFilter()

saveValueFilter

(

$value

)

Аргументы

mixed

$value

Возвращает

mixed

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

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

setJsonValue()

setJsonValue

(

$value

)

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

setMessageId()

setMessageId

(

int

$messageId

)

Замещает MessageParameter.

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

setName()

setName

(

string

$name

)

См. также

\Bitrix\Im\V2\Message\Params for common names.

Аргументы

string

$name

Возвращает

$this

Замещает MessageParameter.

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

setParamId()

setParamId

(

int

$paramId

)

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

setPrimaryId()

setPrimaryId

(

int

$primaryId

)

Аргументы

int

$primaryId

Возвращает

static

Замещает ActiveRecord.

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

setType()

setType

(

string

$type

)

См. также

\Bitrix\Im\V2\Message\Param for scalar papam types.

Аргументы

string

$type

Возвращает

$this

Замещает MessageParameter.

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

setValue()

setValue

(

$value

)

Аргументы

mixed

$value

Возвращает

static

Замещает MessageParameter.

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

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

toPullFormat()

toPullFormat

(

)

Возвращает

mixed

Замещает MessageParameter.

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

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

toRestFormat()

toRestFormat

(

)

Возвращает

string|array|null

Замещает MessageParameter.

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

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

unsetValue()

unsetValue

(

)

Возвращает

static

Замещает MessageParameter.

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

Данные класса

$defaultValue

$defaultValue = null

protected

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

$jsonValue

string $jsonValue = null

protected

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

$messageId

int $messageId = null

protected

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

$name

string $name = null

protected

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

$paramId

int $paramId = null

protected

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

$type

string $type = null

protected

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

$value

$value = null

protected

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

TYPE_BOOL

const TYPE_BOOL = 'Boolean'

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

TYPE_DATE_TIME

const TYPE_DATE_TIME = 'DateTime'

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

TYPE_INT

const TYPE_INT = 'Integer'

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

TYPE_INT_ARRAY

const TYPE_INT_ARRAY = 'ArrayInteger'

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

TYPE_JSON

const TYPE_JSON = 'Json'

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

TYPE_STRING

const TYPE_STRING = 'String'

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

TYPE_STRING_ARRAY

const TYPE_STRING_ARRAY = 'ArrayString'

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