Bitrix API

TextDate extends ParamArray

Message Parameter Class.

Table of Contents

Methods

__clone()  : mixed
__construct()  : mixed
add()  : static
Append collection with new item.
addValue()  : static
delete()  : Result
Delete from the database all entities that are in the registry and have an id
detectType()  : self
filter()  : $this
find()  : static
getAny()  : T|null
getCollectionElementClass()  : string|ActiveRecord
Returns collection item's class name.
getDataClass()  : string|DataManager
Returns ORM tablet class name.
getDataEntityCollection()  : Collection
Before external call, call prepare method to update the state of the entity @see BaseLinkCollection::prepareFields()
getDefaultValue()  : array<string|int, mixed>
getMessageId()  : int|null
getName()  : string|null
getPrimaryIds()  : array<string|int, int>
getRegistry()  : Registry|null
Return link of the object's registry.
getType()  : string
getValue()  : array<string|int, string>
hasUnsaved()  : bool
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.
markChanged()  : static
Marks object changed.
markDrop()  : static
Marks object to drop on save.
merge()  : static
offsetGet()  : MessageParameter|Param
offsetSet()  : void
Alias to add method.
save()  : Result
Saves collection objects states into database.
setMessageId()  : self
setName()  : self
setRegistry()  : self
setType()  : $this
setValue()  : static
toPullFormat()  : mixed
toRestFormat()  : array<string|int, string>|null
unsetByKeys()  : void
unsetValue()  : static

Methods

__construct()

public __construct([mixed $source = null ]) : mixed
Parameters
$source : mixed = null

add()

Append collection with new item.

public add(ActiveRecord $entry) : static
Parameters
$entry : ActiveRecord
Tags
throws
ArgumentTypeException
Return values
static

addValue()

public addValue(int|string $value) : static
Parameters
$value : int|string
Return values
static

delete()

Delete from the database all entities that are in the registry and have an id

public delete() : Result
Return values
Result

detectType()

public detectType() : self
Return values
self

filter()

public filter(callable $predicate) : $this
Parameters
$predicate : callable
Return values
$this

find()

public static find(array<string|int, mixed> $filter, array<string|int, mixed> $order[, int|null $limit = null ][, Context|null $context = null ]) : static
Parameters
$filter : array<string|int, mixed>
$order : array<string|int, mixed>
$limit : int|null = null
$context : Context|null = null
Return values
static

getAny()

public getAny() : T|null
Return values
T|null

getDataEntityCollection()

Before external call, call prepare method to update the state of the entity @see BaseLinkCollection::prepareFields()

public getDataEntityCollection() : Collection
Return values
Collection

getDefaultValue()

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

getMessageId()

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

getName()

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

getPrimaryIds()

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

getType()

public getType() : string
Return values
string

getValue()

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

hasUnsaved()

public hasUnsaved() : bool
Return values
bool

hasValue()

public hasValue() : bool
Return values
bool

isChanged()

Tells true if object has been changed.

public isChanged() : bool
Return values
bool

isDeleted()

Tells true if object marked to drop.

public isDeleted() : bool
Return values
bool

isHidden()

public isHidden() : bool
Return values
bool

load()

Restores object state from database.

public load(array<string|int, mixed>|EO_MessageParam_Collection|Collection $source) : Result
Parameters
$source : array<string|int, mixed>|EO_MessageParam_Collection|Collection
Return values
Result

markChanged()

Marks object changed.

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

markDrop()

Marks object to drop on save.

public markDrop() : static
Return values
static

merge()

public merge(Registry<string|int, T> $registry) : static
Parameters
$registry : Registry<string|int, T>
Return values
static

offsetSet()

Alias to add method.

public offsetSet(mixed $offset, mixed $entry) : void
Parameters
$offset : mixed
$entry : mixed

save()

Saves collection objects states into database.

public save([bool $isGroupSave = false ]) : Result
Parameters
$isGroupSave : bool = false
Return values
Result

setMessageId()

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

setName()

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

setType()

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

setValue()

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

toRestFormat()

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

unsetByKeys()

public unsetByKeys(array<string|int, mixed> $keys) : void
Parameters
$keys : array<string|int, mixed>

unsetValue()

public unsetValue([array<string|int, int>|array<string|int, string> $values = [] ]) : static
Parameters
$values : array<string|int, int>|array<string|int, string> = []
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results