Bitrix API

Complex

Class `Entity complex identificator`.

Table of Contents

Methods

__construct()  : mixed
Entity complex identificator constructor.
getId()  : int
Get entity ID.
getTypeId()  : int
Get entity type ID.
isEqual()  : bool
Return true if this entities is equal.
toArray()  : array<string|int, mixed>
Convert to array.
validateId()  : bool
Return true if ID is valid.

Methods

__construct()

Entity complex identificator constructor.

public __construct(int $entityTypeId, int $entityId) : mixed
Parameters
$entityTypeId : int

Entity type ID.

$entityId : int

Entity ID.

Tags
throws
ArgumentNullException

getId()

Get entity ID.

public getId() : int
Return values
int

getTypeId()

Get entity type ID.

public getTypeId() : int
Return values
int

isEqual()

Return true if this entities is equal.

public static isEqual(Complex $complexA, Complex $complexB) : bool
Parameters
$complexA : Complex

Complex identificator A.

$complexB : Complex

Complex identificator B.

Return values
bool

toArray()

Convert to array.

public toArray([array<string|int, mixed> $keys = ['ENTITY_TYPE_ID', 'ENTITY_ID'] ]) : array<string|int, mixed>
Parameters
$keys : array<string|int, mixed> = ['ENTITY_TYPE_ID', 'ENTITY_ID']

Keys of array.

Return values
array<string|int, mixed>

validateId()

Return true if ID is valid.

public static validateId(mixed $id) : bool
Parameters
$id : mixed

ID.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results