Bitrix API

Sharing

Table of Contents

Constants

CODE_DEPARTMENT  = 'DR'
CODE_GROUP  = 'G'
CODE_SOCNET_GROUP  = 'SG'
CODE_USER  = 'U'
ERROR_SHARING_ADD  = 'REPORT_SHARING_ADD_12000'
ERROR_SHARING_DELETE  = 'REPORT_SHARING_DELETE_12002'
ERROR_SHARING_UPDATE  = 'REPORT_SHARING_UPDATE_12001'
TYPE_DEPARTMENT  = 'department'
TYPE_GROUP  = 'groups'
TYPE_SOCNET_GROUP  = 'sonetgroups'
TYPE_USER  = 'users'

Methods

__construct()  : mixed
changeSharing()  : mixed
The method changes the share.
getEntityOfSharing()  : array<string|int, mixed>
Get an array shared entity.
getErrors()  : array<string|int, Error>
getSocNetDestination()  : array<string|int, mixed>
Get socnet destination.
getTypeData()  : array<string|int, mixed>
Get an array of desired size depending on the type of entity.
getUserData()  : array<string|int, mixed>
Get an array user data for sharing.
onReportDelete()  : mixed
Removes all related entities by removing report.
parseEntityValue()  : array<string|int, mixed>|null
Parses entity code to get entity type and entity id.

Constants

CODE_DEPARTMENT

public mixed CODE_DEPARTMENT = 'DR'

CODE_GROUP

public mixed CODE_GROUP = 'G'

CODE_SOCNET_GROUP

public mixed CODE_SOCNET_GROUP = 'SG'

CODE_USER

public mixed CODE_USER = 'U'

ERROR_SHARING_ADD

public mixed ERROR_SHARING_ADD = 'REPORT_SHARING_ADD_12000'

ERROR_SHARING_DELETE

public mixed ERROR_SHARING_DELETE = 'REPORT_SHARING_DELETE_12002'

ERROR_SHARING_UPDATE

public mixed ERROR_SHARING_UPDATE = 'REPORT_SHARING_UPDATE_12001'

TYPE_DEPARTMENT

public mixed TYPE_DEPARTMENT = 'department'

TYPE_GROUP

public mixed TYPE_GROUP = 'groups'

TYPE_SOCNET_GROUP

public mixed TYPE_SOCNET_GROUP = 'sonetgroups'

TYPE_USER

public mixed TYPE_USER = 'users'

Methods

__construct()

public __construct(mixed $reportId) : mixed
Parameters
$reportId : mixed

changeSharing()

The method changes the share.

public changeSharing(mixed $listNewEntity) : mixed
Parameters
$listNewEntity : mixed
  • List new reports.

getEntityOfSharing()

Get an array shared entity.

public static getEntityOfSharing(mixed $reportId) : array<string|int, mixed>
Parameters
$reportId : mixed

.

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

getErrors()

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

getSocNetDestination()

Get socnet destination.

public static getSocNetDestination(mixed $userId[, array<string|int, mixed> $selected = array() ]) : array<string|int, mixed>
Parameters
$userId : mixed
$selected : array<string|int, mixed> = array()
Tags
throws
LoaderException
Return values
array<string|int, mixed>

getTypeData()

Get an array of desired size depending on the type of entity.

public static getTypeData(mixed $type, mixed $id) : array<string|int, mixed>
Parameters
$type : mixed
$id : mixed
Tags
throws
LoaderException
Return values
array<string|int, mixed>

getUserData()

Get an array user data for sharing.

public static getUserData(mixed $userId) : array<string|int, mixed>
Parameters
$userId : mixed
Return values
array<string|int, mixed>

onReportDelete()

Removes all related entities by removing report.

public static onReportDelete(mixed $reportId) : mixed
Parameters
$reportId : mixed
Tags
throws
Exception

parseEntityValue()

Parses entity code to get entity type and entity id.

public static parseEntityValue(mixed $entity) : array<string|int, mixed>|null

Ex. SG444 = array('SG', 444)

Parameters
$entity : mixed
Return values
array<string|int, mixed>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results