Bitrix API

Scope

Class Scope

Table of Contents

Methods

getAllUserScopes()  : array<string|int, mixed>
getById()  : array<string|int, mixed>|null
getInstance()  : Scope
getScopeById()  : array<string|int, mixed>|null
getScopeMembers()  : array<string|int, mixed>
getUserScopes()  : array<string|int, mixed>
handleMemberAddedToDepartment()  : void
handleMemberAddedToSocialGroup()  : void
isHasScope()  : bool
removeByIds()  : void
setScope()  : void
Set user option with config scope type and scopeId if selected custom scope
setScopeConfig()  : mixed
setScopeForEligibleUsers()  : void
updateScopeAccessCodes()  : array<string|int, mixed>
updateScopeAutoApplyScope()  : UpdateResult
updateScopeConfig()  : mixed
updateScopeName()  : UpdateResult

Methods

getAllUserScopes()

public getAllUserScopes(string $entityTypeId[, string|null $moduleId = null ][, bool $loadMetadata = true ]) : array<string|int, mixed>
Parameters
$entityTypeId : string
$moduleId : string|null = null
$loadMetadata : bool = true
Return values
array<string|int, mixed>

getById()

public getById(int $scopeId) : array<string|int, mixed>|null
Parameters
$scopeId : int
Return values
array<string|int, mixed>|null

getScopeById()

public getScopeById(int $scopeId) : array<string|int, mixed>|null
Parameters
$scopeId : int
Return values
array<string|int, mixed>|null

getScopeMembers()

public getScopeMembers(int $configId) : array<string|int, mixed>
Parameters
$configId : int
Return values
array<string|int, mixed>

getUserScopes()

public getUserScopes(string $entityTypeId[, string|null $moduleId = null ][, bool $loadMetadata = true ]) : array<string|int, mixed>
Parameters
$entityTypeId : string
$moduleId : string|null = null
$loadMetadata : bool = true
Return values
array<string|int, mixed>

handleMemberAddedToDepartment()

public static handleMemberAddedToDepartment(Event $event) : void
Parameters
$event : Event

handleMemberAddedToSocialGroup()

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

isHasScope()

public isHasScope(int $scopeId) : bool
Parameters
$scopeId : int
Return values
bool

removeByIds()

public removeByIds(iterable<string|int, mixed> $ids) : void
Parameters
$ids : iterable<string|int, mixed>
Tags
throws
Exception

setScope()

Set user option with config scope type and scopeId if selected custom scope

public setScope(string $categoryName, string $guid, string $scope[, int $userScopeId = 0 ]) : void
Parameters
$categoryName : string
$guid : string
$scope : string
$userScopeId : int = 0

setScopeConfig()

public setScopeConfig(string $category, string $entityTypeId, string $name, array<string|int, mixed> $accessCodes, array<string|int, mixed> $config[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$category : string
$entityTypeId : string
$name : string
$accessCodes : array<string|int, mixed>
$config : array<string|int, mixed>
$params : array<string|int, mixed> = []

setScopeForEligibleUsers()

public setScopeForEligibleUsers(int $scopeId) : void
Parameters
$scopeId : int

updateScopeAccessCodes()

public updateScopeAccessCodes(int $configId[, array<string|int, mixed> $accessCodes = [] ]) : array<string|int, mixed>
Parameters
$configId : int
$accessCodes : array<string|int, mixed> = []
Return values
array<string|int, mixed>

updateScopeAutoApplyScope()

public updateScopeAutoApplyScope(int $id, bool $autoApplyScope) : UpdateResult
Parameters
$id : int
$autoApplyScope : bool
Return values
UpdateResult

updateScopeConfig()

public updateScopeConfig(int $id, array<string|int, mixed> $config) : mixed
Parameters
$id : int
$config : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results