Bitrix API

FavoriteTable extends TaskDataManager

Class FavoriteTable

Fields:

  • TASK_ID int mandatory
  • USER_ID int mandatory

Table of Contents

Methods

add()  : AddResult
Adds a task to favorites for a particular (or current) user. This function DOES NOT check permissions.
check()  : bool
Checks if a task is in favorites for a particular (or current) user. This function DOES NOT check permissions.
createCollection()  : EO_Favorite_Collection
createObject()  : EO_Favorite
delete()  : DeleteResult
Removes a task from favorites for a particular (or current) user. This function DOES NOT check permissions.
deleteByTaskId()  : DeleteResult
Removes a task from favorites for all users. This function DOES NOT check permissions.
deleteList()  : Result
getById()  : EO_Favorite_Result
getByPrimary()  : EO_Favorite_Result
getClass()  : static
getEntity()  : EO_Favorite_Entity
getList()  : EO_Favorite_Result
getMap()  : array<string|int, mixed>
Returns entity map definition.
getTableName()  : string
Returns DB table name for entity.
query()  : EO_Favorite_Query
toggle()  : AddResult|DeleteResult
Switch "favoriteness" of a certain task for a particular (or current) user. This function DOES NOT check permissions.
wakeUpCollection()  : EO_Favorite_Collection
wakeUpObject()  : EO_Favorite

Methods

add()

Adds a task to favorites for a particular (or current) user. This function DOES NOT check permissions.

public static add(array<string|int, mixed> $data) : AddResult
Parameters
$data : array<string|int, mixed>
Return values
AddResult

check()

Checks if a task is in favorites for a particular (or current) user. This function DOES NOT check permissions.

public static check(mixed $primary) : bool
Parameters
$primary : mixed
Return values
bool

createCollection()

public static createCollection() : EO_Favorite_Collection
Return values
EO_Favorite_Collection

createObject()

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

delete()

Removes a task from favorites for a particular (or current) user. This function DOES NOT check permissions.

public static delete(mixed $primary[, mixed $behaviour = array('AFFECT_CHILDREN' => false) ]) : DeleteResult
Parameters
$primary : mixed
$behaviour : mixed = array('AFFECT_CHILDREN' => false)
Return values
DeleteResult

deleteByTaskId()

Removes a task from favorites for all users. This function DOES NOT check permissions.

public static deleteByTaskId(mixed $taskId[, mixed $behaviour = array('LOW_LEVEL' => false) ]) : DeleteResult
Parameters
$taskId : mixed
$behaviour : mixed = array('LOW_LEVEL' => false)
Return values
DeleteResult

deleteList()

public static deleteList(array<string|int, mixed> $filter) : Result
Parameters
$filter : array<string|int, mixed>
Tags
throws
ArgumentException
throws
SqlQueryException
throws
SystemException
Return values
Result

getById()

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

getByPrimary()

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

getClass()

public static getClass() : static
Return values
static

getEntity()

public static getEntity() : EO_Favorite_Entity
Return values
EO_Favorite_Entity

getList()

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

getMap()

Returns entity map definition.

public static getMap() : array<string|int, mixed>
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_Favorite_Query
Return values
EO_Favorite_Query

toggle()

Switch "favoriteness" of a certain task for a particular (or current) user. This function DOES NOT check permissions.

public static toggle(mixed $primary[, mixed $behaviour = array() ]) : AddResult|DeleteResult
Parameters
$primary : mixed
$behaviour : mixed = array()
Return values
AddResult|DeleteResult —

Returns \Bitrix\Main\Entity\AddResult if task was not favorite, but became such, \Bitrix\Main\Entity\DeleteResult otherwise

wakeUpCollection()

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

wakeUpObject()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results