Bitrix API

Lead extends EntityBase

Table of Contents

Methods

checkDeletePermission()  : mixed
checkReadPermission()  : mixed
cleanup()  : void
Perform deferred cleaning of the related entities.
create()  : mixed
delete()  : mixed
getByID()  : array<string|int, mixed>|null
Get Entity By ID.
getChildEntityIDs()  : mixed
getCount()  : mixed
getDbTableAlias()  : mixed
getEntityMultifields()  : mixed
getEntityTypeID()  : mixed
getInstance()  : Lead
getLastID()  : int|mixed
Get id of last created item
getNewIDs()  : array<string|int, mixed>
Get ids of last created items
getResponsibleID()  : mixed
getSubsidiaryEntities()  : mixed
getTopIDs()  : array<string|int, mixed>
Get ids according to $params
isExists()  : bool
Check if Entity exists.
prepareFilter()  : mixed
selectExisted()  : array<string|int, mixed>
Select only existed entity IDs.
setChildEntityIDs()  : mixed
setEntityMultifields()  : mixed
update()  : mixed

Methods

checkDeletePermission()

public checkDeletePermission([mixed $entityID = 0 ][, mixed $userPermissions = null ]) : mixed
Parameters
$entityID : mixed = 0
$userPermissions : mixed = null

checkReadPermission()

public checkReadPermission([mixed $entityID = 0 ][, mixed $userPermissions = null ]) : mixed
Parameters
$entityID : mixed = 0
$userPermissions : mixed = null

cleanup()

Perform deferred cleaning of the related entities.

public cleanup(int $entityID) : void
Parameters
$entityID : int

Entity ID.

create()

public create(array<string|int, mixed> $fields) : mixed
Parameters
$fields : array<string|int, mixed>

delete()

public delete(mixed $entityID[, array<string|int, mixed> $options = array() ]) : mixed
Parameters
$entityID : mixed
$options : array<string|int, mixed> = array()

getByID()

Get Entity By ID.

public getByID(int $entityID) : array<string|int, mixed>|null
Parameters
$entityID : int

Entity ID.

Tags
throws
NotImplementedException
Return values
array<string|int, mixed>|null

getChildEntityIDs()

public static getChildEntityIDs(mixed $ID, mixed $childEntityTypeID) : mixed
Parameters
$ID : mixed
$childEntityTypeID : mixed

getCount()

public getCount(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

getDbTableAlias()

public getDbTableAlias() : mixed

getEntityMultifields()

public getEntityMultifields(mixed $entityID[, array<string|int, mixed> $options = null ]) : mixed
Parameters
$entityID : mixed
$options : array<string|int, mixed> = null

getEntityTypeID()

public getEntityTypeID() : mixed

getInstance()

public static getInstance() : Lead
Return values
Lead

getLastID()

Get id of last created item

public getLastID([int $userID = 0 ][, bool $enablePermissionCheck = true ]) : int|mixed
Parameters
$userID : int = 0
$enablePermissionCheck : bool = true
Return values
int|mixed

getNewIDs()

Get ids of last created items

public getNewIDs(mixed $offsetID[, string $order = 'DESC' ][, int $limit = 100 ][, int $userID = 0 ][, bool $enablePermissionCheck = true ][, int|null $categoryId = null ]) : array<string|int, mixed>
Parameters
$offsetID : mixed
$order : string = 'DESC'
$limit : int = 100
$userID : int = 0
$enablePermissionCheck : bool = true
$categoryId : int|null = null
Return values
array<string|int, mixed>

getResponsibleID()

public static getResponsibleID(mixed $entityID) : mixed
Parameters
$entityID : mixed

getSubsidiaryEntities()

public static getSubsidiaryEntities(mixed $ID) : mixed
Parameters
$ID : mixed

getTopIDs()

Get ids according to $params

public getTopIDs(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>

isExists()

Check if Entity exists.

public isExists(int $entityID) : bool
Parameters
$entityID : int

Entity ID.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

prepareFilter()

public prepareFilter(array<string|int, mixed> &$filterFields[, array<string|int, mixed> $params = null ]) : mixed

Use \Bitrix\Main\Filter\Filter::getValue

Parameters
$filterFields : array<string|int, mixed>
$params : array<string|int, mixed> = null
Tags
see
Filter::getValue

selectExisted()

Select only existed entity IDs.

public static selectExisted(array<string|int, mixed> $entityIDs) : array<string|int, mixed>
Parameters
$entityIDs : array<string|int, mixed>

Deal IDs to check.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>

setChildEntityIDs()

public static setChildEntityIDs(mixed $ID, mixed $childEntityTypeID, array<string|int, mixed> $childEntityIDs) : mixed
Parameters
$ID : mixed
$childEntityTypeID : mixed
$childEntityIDs : array<string|int, mixed>

setEntityMultifields()

public setEntityMultifields(mixed $entityID, array<string|int, mixed> $data) : mixed
Parameters
$entityID : mixed
$data : array<string|int, mixed>

update()

public update(mixed $entityID, array<string|int, mixed> $fields) : mixed
Parameters
$entityID : mixed
$fields : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results