Bitrix API

FinderDestTable extends EntityUsageTable

Class FinderDestTable Is used to store and retrieve last used destinations in the destinations selector dialog

Table of Contents

Methods

convertRights()  : array<string|int, mixed>
Converts access rights into destination codes
createCollection()  : EO_FinderDest_Collection
createObject()  : EO_FinderDest
getById()  : EO_FinderDest_Result
getByPrimary()  : EO_FinderDest_Result
getEntity()  : EO_FinderDest_Entity
getList()  : EO_FinderDest_Result
getMailUserId()  : array<string|int, mixed>
Returns array of email user IDs fetched from users (email and not email) destination codes
merge()  : void
Adds or updates data about using destinations by a user
migrateData()  : void
Used once to fill b_finder_dest table
onAfterDiskAjaxAction()  : void
query()  : EO_FinderDest_Query
wakeUpCollection()  : EO_FinderDest_Collection
wakeUpObject()  : EO_FinderDest

Methods

convertRights()

Converts access rights into destination codes

public static convertRights(array<string|int, mixed> $rights[, array<string|int, mixed> $excludeCodes = [] ]) : array<string|int, mixed>
Parameters
$rights : array<string|int, mixed>

access right codes to convert

$excludeCodes : array<string|int, mixed> = []

access right codes to not process

Return values
array<string|int, mixed> —

destination codes

createCollection()

public static createCollection() : EO_FinderDest_Collection
Return values
EO_FinderDest_Collection

createObject()

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

getById()

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

getByPrimary()

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

getEntity()

public static getEntity() : EO_FinderDest_Entity
Return values
EO_FinderDest_Entity

getList()

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

getMailUserId()

Returns array of email user IDs fetched from users (email and not email) destination codes

public static getMailUserId(mixed $code) : array<string|int, mixed>
Parameters
$code : mixed

user destination code or array of them

Return values
array<string|int, mixed>

merge()

Adds or updates data about using destinations by a user

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

data to store, keys: USER_ID - user who selected a destination, CODE - code or array of codes of destinations, CONTEXT - the place where a destination is selected

migrateData()

Used once to fill b_finder_dest table

public static migrateData() : void

onAfterDiskAjaxAction()

public static onAfterDiskAjaxAction(array<string|int, mixed> $sharings) : void

isn't used in the kernel already Handler for onAfterAjaxActionCreateFolderWithSharing, onAfterAjaxActionAppendSharing and onAfterAjaxActionChangeSharingAndRights events of disk module Converts sharings into destination codes and stores them

Parameters
$sharings : array<string|int, mixed>

query()

public static query() : EO_FinderDest_Query
Return values
EO_FinderDest_Query

wakeUpCollection()

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

wakeUpObject()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results