Bitrix API

ValueStorage extends EntityObject

Entity object

Tags
subpackage

main

Table of Contents

Properties

$authContext  : Context
$customData  : Dictionary
$dataClass  : DataManager
Entity Table class. Read-only property.
$entity  : Entity
$primary  : array<string|int, mixed>
$primaryAsString  : string
$state  : int

Methods

__call()  : mixed
Magic to handle getters, setters etc.
__clone()  : mixed
__construct()  : mixed
EntityObject constructor
__get()  : mixed
Magic read-only properties
__set()  : mixed
Magic read-only properties
addTo()  : mixed
collectValues()  : array<string|int, mixed>
Returns all objects values as an array
defineAuthContext()  : mixed
delete()  : Result
ActiveRecord delete.
fill()  : mixed
Fills all the values and relations of object
get()  : mixed
getId()  : Collection|EntityObject|mixed
Fast popular alternative to __call().
has()  : mixed
isChanged()  : mixed
isFilled()  : mixed
offsetExists()  : bool
ArrayAccess interface implementation.
offsetGet()  : mixed|null
ArrayAccess interface implementation.
offsetSet()  : void
ArrayAccess interface implementation.
offsetUnset()  : void
ArrayAccess interface implementation.
remindActual()  : mixed
removeAll()  : mixed
removeFrom()  : mixed
require()  : mixed
reset()  : mixed
save()  : Result
ActiveRecord save.
set()  : mixed
setValue()  : mixed
sysFillRelationCollection()  : Collection
sysGetEntity()  : Entity
sysGetPrimary()  : array<string|int, mixed>
Returns [primary => value] array.
sysGetPrimaryAsString()  : mixed
sysPostSave()  : mixed
sysSaveCurrentReferences()  : mixed
sysSerializePrimary()  : string
unset()  : mixed
wakeUp()  : static
Constructs existing object from pre-selected data, including references and relations.

Properties

$primary read-only

public array<string|int, mixed> $primary

$primaryAsString read-only

public string $primaryAsString

Methods

__call()

Magic to handle getters, setters etc.

public __call(mixed $name, mixed $arguments) : mixed
Parameters
$name : mixed
$arguments : mixed
Tags
throws
ArgumentException
throws
SystemException

__construct()

EntityObject constructor

public final __construct([bool|array<string|int, mixed> $setDefaultValues = true ]) : mixed
Parameters
$setDefaultValues : bool|array<string|int, mixed> = true
Tags
throws
ArgumentException
throws
SystemException

__get()

Magic read-only properties

public __get(mixed $name) : mixed
Parameters
$name : mixed
Tags
throws
ArgumentException
throws
SystemException

__set()

Magic read-only properties

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Tags
throws
SystemException

addTo()

public final addTo(mixed $fieldName, mixed $value) : mixed
Parameters
$fieldName : mixed
$value : mixed
Tags
throws
ArgumentException
throws
SystemException

collectValues()

Returns all objects values as an array

public final collectValues([int $valuesType = Values::ALL ][, int $fieldsMask = FieldTypeMask::ALL ][, bool $recursive = false ]) : array<string|int, mixed>
Parameters
$valuesType : int = Values::ALL
$fieldsMask : int = FieldTypeMask::ALL
$recursive : bool = false
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

delete()

ActiveRecord delete.

public final delete() : Result
Tags
throws
ArgumentException
throws
SystemException
Return values
Result

fill()

Fills all the values and relations of object

public final fill([int|array<string|int, string> $fields = FieldTypeMask::ALL ]) : mixed
Parameters
$fields : int|array<string|int, string> = FieldTypeMask::ALL

Names of fields to fill

Tags
throws
ArgumentException
throws
SystemException

get()

public final get(mixed $fieldName) : mixed
Parameters
$fieldName : mixed
Tags
throws
ArgumentException
throws
SystemException

has()

public final has(mixed $fieldName) : mixed
Parameters
$fieldName : mixed
Tags
throws
ArgumentException
throws
SystemException

isChanged()

public final isChanged(mixed $fieldName) : mixed
Parameters
$fieldName : mixed
Tags
throws
ArgumentException
throws
SystemException

isFilled()

public final isFilled(mixed $fieldName) : mixed
Parameters
$fieldName : mixed
Tags
throws
ArgumentException
throws
SystemException

offsetExists()

ArrayAccess interface implementation.

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Tags
throws
ArgumentException
throws
SystemException
Return values
bool

offsetGet()

ArrayAccess interface implementation.

public offsetGet(mixed $offset) : mixed|null
Parameters
$offset : mixed
Tags
throws
ArgumentException
throws
SystemException
Attributes
#[ReturnTypeWillChange]
Return values
mixed|null

offsetSet()

ArrayAccess interface implementation.

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed
Tags
throws
ArgumentException
throws
SystemException

offsetUnset()

ArrayAccess interface implementation.

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

remindActual()

public final remindActual(mixed $fieldName) : mixed
Parameters
$fieldName : mixed
Tags
throws
ArgumentException
throws
SystemException

removeAll()

public final removeAll(mixed $fieldName) : mixed
Parameters
$fieldName : mixed
Tags
throws
ArgumentException
throws
SystemException

removeFrom()

public final removeFrom(mixed $fieldName, mixed $value) : mixed
Parameters
$fieldName : mixed
$value : mixed
Tags
throws
ArgumentException
throws
SystemException

require()

public final require(mixed $fieldName) : mixed
Parameters
$fieldName : mixed
Tags
throws
ArgumentException
throws
SystemException

reset()

public final reset(mixed $fieldName) : mixed
Parameters
$fieldName : mixed
Tags
throws
ArgumentException
throws
SystemException

save()

ActiveRecord save.

public final save() : Result
Tags
throws
ArgumentException
throws
SystemException
throws
Exception
Return values
Result

set()

public final set(mixed $fieldName, mixed $value) : mixed
Parameters
$fieldName : mixed
$value : mixed
Tags
throws
ArgumentException
throws
SystemException

setValue()

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

sysGetEntity()

public sysGetEntity() : Entity
Tags
throws
ArgumentException
throws
SystemException
Return values
Entity

sysGetPrimary()

Returns [primary => value] array.

public sysGetPrimary() : array<string|int, mixed>
Tags
throws
ArgumentException
throws
SystemException
Return values
array<string|int, mixed>

sysGetPrimaryAsString()

public sysGetPrimaryAsString() : mixed

sysSaveCurrentReferences()

public sysSaveCurrentReferences() : mixed

sysSerializePrimary()

public static sysSerializePrimary(array<string|int, mixed> $primary, Entity $entity) : string
Parameters
$primary : array<string|int, mixed>
$entity : Entity
Tags
throws
ArgumentException
Return values
string

unset()

public final unset(mixed $fieldName) : mixed
Parameters
$fieldName : mixed
Tags
throws
ArgumentException
throws
SystemException

wakeUp()

Constructs existing object from pre-selected data, including references and relations.

public final static wakeUp(mixed $row) : static
Parameters
$row : mixed

Array of [field => value] or single scalar primary value.

Tags
throws
ArgumentException
throws
SystemException
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results