Bitrix API

SortTable extends DataManager

Class SortTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Methods

clearEntity()  : void
Delete all sorts for entity.
clearUser()  : void
Delete all sorts for user.
createCollection()  : EO_Sort_Collection
createObject()  : EO_Sort
getById()  : EO_Sort_Result
getByPrimary()  : EO_Sort_Result
getEntity()  : EO_Sort_Entity
getList()  : EO_Sort_Result
getMap()  : array<string|int, mixed>
Returns entity map definition.
getPrevious()  : array<string|int, mixed>
Set previous item(s).
getTableName()  : string
Returns DB table name for entity.
query()  : EO_Sort_Query
setPrevious()  : void
Set previous item.
wakeUpCollection()  : EO_Sort_Collection
wakeUpObject()  : EO_Sort

Methods

clearEntity()

Delete all sorts for entity.

public static clearEntity(int $entityId, string $entityType) : void
Parameters
$entityId : int

Entity id.

$entityType : string

Entity type (LEAD, DEAL, QUOTE, INVOICE).

clearUser()

Delete all sorts for user.

public static clearUser(int $userId) : void
Parameters
$userId : int

User id.

createCollection()

public static createCollection() : EO_Sort_Collection
Return values
EO_Sort_Collection

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : EO_Sort
Parameters
$setDefaultValues : mixed = = 'true'
Return values
EO_Sort

getById()

public static getById(mixed $id) : EO_Sort_Result
Parameters
$id : mixed
Return values
EO_Sort_Result

getByPrimary()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Sort_Result
Parameters
$primary : mixed
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_Sort_Result

getEntity()

public static getEntity() : EO_Sort_Entity
Return values
EO_Sort_Entity

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_Sort_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_Sort_Result

getMap()

Returns entity map definition.

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

getPrevious()

Set previous item(s).

public static getPrevious(array<string|int, mixed> $filter) : array<string|int, mixed>
Parameters
$filter : array<string|int, mixed>

Item:

  • ENTITY_TYPE_ID = LEAD, DEAL, QUOTE, INVOICE
  • ENTITY_ID = id(s) of entity
  • USER_ID - user id (optionaly)
Return values
array<string|int, mixed>

getTableName()

Returns DB table name for entity.

public static getTableName() : string
Return values
string

query()

public static query() : EO_Sort_Query
Return values
EO_Sort_Query

setPrevious()

Set previous item.

public static setPrevious(array<string|int, mixed> $fields) : void
Parameters
$fields : array<string|int, mixed>

Item:

  • ENTITY_TYPE_ID = LEAD, DEAL, QUOTE, INVOICE
  • ENTITY_ID = id of entity
  • PREV_ENTITY_ID - previous id of entity (optional)
  • USER_ID - user id (optionaly)

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : EO_Sort_Collection
Parameters
$rows : mixed
Return values
EO_Sort_Collection

wakeUpObject()

public static wakeUpObject(mixed $row) : EO_Sort
Parameters
$row : mixed
Return values
EO_Sort 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results