Bitrix API

Param implements MessageParameter, RegistryEntry, ActiveRecord uses ActiveRecordImplementation, RegistryEntryImplementation

Message Parameter Class.

Table of Contents

Interfaces

MessageParameter
RegistryEntry
ActiveRecord

Constants

TYPE_BOOL  = 'Boolean'
TYPE_DATE_TIME  = 'DateTime'
TYPE_INT  = 'Integer'
TYPE_INT_ARRAY  = 'ArrayInteger'
TYPE_JSON  = 'Json'
TYPE_STRING  = 'String'
TYPE_STRING_ARRAY  = 'ArrayString'

Methods

__construct()  : mixed
addValue()  : static
delete()  : Result
detectType()  : self
fill()  : static
Fills object's fields with provided values.
fillActual()  : self
getDataClass()  : string
Returns ORM tablet class name.
getDataEntity()  : EntityObject
getDefaultValue()  : mixed|null
getJsonValue()  : mixed
getMessageId()  : int|null
getName()  : string|null
getParamId()  : int|null
getPrimaryId()  : int|null
getRegistry()  : Registry|null
Return link of the object's registry.
getType()  : string
getValue()  : mixed|null
hasValue()  : bool
isChanged()  : bool
Tells true if object has been changed.
isDeleted()  : bool
Tells true if object marked to drop.
isHidden()  : bool
isValid()  : Result
load()  : Result
Restores object state from database.
loadJsonFilter()  : mixed
loadValueFilter()  : mixed
markChanged()  : static
Marks object changed.
markDrop()  : static
Marks object to drop on save.
onAfterOrmUpdate()  : self
prepareFields()  : Result
save()  : Result
saveJsonFilter()  : mixed
saveNameFilter()  : string
saveValueFilter()  : mixed
setJsonValue()  : self
setMessageId()  : self
setName()  : $this
setParamId()  : self
setPrimaryId()  : static
setRegistry()  : self
setType()  : $this
setValue()  : static
toArray()  : array<string|int, mixed>
Returns object state as array.
toPullFormat()  : mixed
toRestFormat()  : string|array<string|int, mixed>|null
unsetValue()  : static

Constants

TYPE_BOOL

public mixed TYPE_BOOL = 'Boolean'

TYPE_DATE_TIME

public mixed TYPE_DATE_TIME = 'DateTime'

TYPE_INT

public mixed TYPE_INT = 'Integer'

TYPE_INT_ARRAY

public mixed TYPE_INT_ARRAY = 'ArrayInteger'

TYPE_JSON

public mixed TYPE_JSON = 'Json'

TYPE_STRING

public mixed TYPE_STRING = 'String'

TYPE_STRING_ARRAY

public mixed TYPE_STRING_ARRAY = 'ArrayString'

Methods

__construct()

public __construct([int|array<string|int, mixed>|EO_MessageParam|null $source = null ]) : mixed
Parameters
$source : int|array<string|int, mixed>|EO_MessageParam|null = null

addValue()

public addValue(mixed $value) : static
Parameters
$value : mixed
Return values
static

detectType()

public detectType() : self
Return values
self

fill()

Fills object's fields with provided values.

public fill(array<string|int, mixed> $source) : static
Parameters
$source : array<string|int, mixed>
Return values
static

fillActual()

public fillActual(array<string|int, mixed> $fieldsToFill) : self
Parameters
$fieldsToFill : array<string|int, mixed>
Return values
self

getDataClass()

Returns ORM tablet class name.

public static getDataClass() : string
Tags
@return

string|DataManager;

Return values
string

getDefaultValue()

public getDefaultValue() : mixed|null
Return values
mixed|null

getJsonValue()

public getJsonValue() : mixed

getMessageId()

public getMessageId() : int|null
Return values
int|null

getName()

public getName() : string|null
Return values
string|null

getParamId()

public getParamId() : int|null
Return values
int|null

getPrimaryId()

public getPrimaryId() : int|null
Return values
int|null

getType()

public getType() : string
Return values
string

getValue()

public getValue() : mixed|null
Return values
mixed|null

hasValue()

public hasValue() : bool
Return values
bool

isHidden()

public isHidden() : bool
Return values
bool

loadJsonFilter()

public loadJsonFilter(mixed $value) : mixed
Parameters
$value : mixed

loadValueFilter()

public loadValueFilter(mixed $value) : mixed
Parameters
$value : mixed

markChanged()

Marks object changed.

public markChanged([bool|null $state = null ]) : static
Parameters
$state : bool|null = null
Return values
static

onAfterOrmUpdate()

public onAfterOrmUpdate(array<string|int, mixed> $fields) : self
Parameters
$fields : array<string|int, mixed>
Return values
self

saveJsonFilter()

public saveJsonFilter(mixed $value) : mixed
Parameters
$value : mixed

saveNameFilter()

public saveNameFilter(mixed $name) : string
Parameters
$name : mixed
Return values
string

saveValueFilter()

public saveValueFilter(mixed $value) : mixed
Parameters
$value : mixed

setJsonValue()

public setJsonValue(mixed $value) : self
Parameters
$value : mixed
Return values
self

setMessageId()

public setMessageId(int $messageId) : self
Parameters
$messageId : int
Return values
self

setName()

public setName(string $name) : $this
Parameters
$name : string
Return values
$this

setParamId()

public setParamId(int $paramId) : self
Parameters
$paramId : int
Return values
self

setPrimaryId()

public setPrimaryId(int $primaryId) : static
Parameters
$primaryId : int
Return values
static

setType()

public setType(string $type) : $this
Parameters
$type : string
Return values
$this

setValue()

public setValue(mixed $value) : static
Parameters
$value : mixed
Return values
static

toArray()

Returns object state as array.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

toPullFormat()

public toPullFormat() : mixed

toRestFormat()

public toRestFormat() : string|array<string|int, mixed>|null
Return values
string|array<string|int, mixed>|null

unsetValue()

public unsetValue() : static
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results