Bitrix API

ActualRanking

Class ActualRanking

Table of Contents

Methods

addModifier()  : $this
Add custom modifier.
getDealId()  : int|null
Get deal of top entity in ranked list.
getDeals()  : array<string|int, int>
Get deals of top entity in ranked list.
getDynamicId()  : int|null
Get dynamic entity of top entity in ranked list.
getDynamics()  : array<string|int, int>
Get dynamics of top entity in ranked list.
getEntityId()  : int|null
Get top entity id in ranked list.
getEntityTypeId()  : int|null
Get top entity type id.
getLeads()  : array<string|int, int>
Get leads of top entity in ranked list.
getModifiedList()  : array<string|int, mixed>|null
Get modified list.
getOrders()  : array<string|int, int>
Get orders of top entity in ranked list.
getRankedList()  : array<string|int, mixed>
Get ranked list of entity ids.
getReturnCustomerLeadId()  : int|null
Get lead(return customer type) id of top entity in ranked list.
isRanked()  : bool
Return true if list is ranked.
rank()  : $this
Rank entity list.
setDynamicTypeId()  : $this
Set dynamic type ID.
setModifiedList()  : mixed
Set modified list.
setModifiers()  : $this
Set custom modifiers.
setRankedList()  : $this
Set ranked list of entity ids.

Methods

addModifier()

Add custom modifier.

public addModifier(callable $modifier) : $this
Parameters
$modifier : callable

Modifier.

Return values
$this

getDealId()

Get deal of top entity in ranked list.

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

getDeals()

Get deals of top entity in ranked list.

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

getDynamicId()

Get dynamic entity of top entity in ranked list.

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

getDynamics()

Get dynamics of top entity in ranked list.

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

getEntityId()

Get top entity id in ranked list.

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

getEntityTypeId()

Get top entity type id.

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

getLeads()

Get leads of top entity in ranked list.

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

getModifiedList()

Get modified list.

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

getOrders()

Get orders of top entity in ranked list.

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

getRankedList()

Get ranked list of entity ids.

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

getReturnCustomerLeadId()

Get lead(return customer type) id of top entity in ranked list.

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

isRanked()

Return true if list is ranked.

public isRanked() : bool
Return values
bool

rank()

Rank entity list.

public rank(int $entityTypeId, array<string|int, mixed> $list[, bool $isRankable = true ]) : $this
Parameters
$entityTypeId : int

Entity type id.

$list : array<string|int, mixed>

List of entity ids.

$isRankable : bool = true

Is rankable.

Return values
$this

setDynamicTypeId()

Set dynamic type ID.

public setDynamicTypeId(mixed $dynamicTypeId) : $this
Parameters
$dynamicTypeId : mixed
Return values
$this

setModifiedList()

Set modified list.

public setModifiedList(array<string|int, mixed>|null $modifiedList) : mixed
Parameters
$modifiedList : array<string|int, mixed>|null

Modified list.

setModifiers()

Set custom modifiers.

public setModifiers(array<string|int, callable> $modifiers) : $this
Parameters
$modifiers : array<string|int, callable>

Modifiers.

Return values
$this

setRankedList()

Set ranked list of entity ids.

public setRankedList(array<string|int, mixed> $list) : $this
Parameters
$list : array<string|int, mixed>

List.

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results