Bitrix API

Group extends Scope

Table of Contents

Methods

getCurrentScopeId()  : string|null
Returns current scope id.
getDomainId()  : int
Returns domain id for new site.
getExcludedHooks()  : array<string|int, mixed>
Returns array of hook's codes, which excluded by scope.
getFilterType()  : string
Returns filter value for 'TYPE' key.
getGroupIdBySiteId()  : int
If for site id exists group, then returns group id.
getKeyCode()  : string
Return general key for site path.
getOperationsForSite()  : array<string|int, mixed>
Scoped method for returning available operations of site.
getPublicationPath()  : string
Returns publication path string.
init()  : void
Method for first time initialization scope.

Methods

getCurrentScopeId()

Returns current scope id.

public static getCurrentScopeId() : string|null
Return values
string|null

getDomainId()

Returns domain id for new site.

public static getDomainId() : int
Return values
int

getExcludedHooks()

Returns array of hook's codes, which excluded by scope.

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

getFilterType()

Returns filter value for 'TYPE' key.

public static getFilterType() : string
Return values
string

getGroupIdBySiteId()

If for site id exists group, then returns group id.

public static getGroupIdBySiteId(int $siteId[, bool $checkAccess = false ]) : int
Parameters
$siteId : int

Site id.

$checkAccess : bool = false

If true check access to binding group.

Return values
int

getKeyCode()

Return general key for site path.

public static getKeyCode() : string
Return values
string

getOperationsForSite()

Scoped method for returning available operations of site.

public static getOperationsForSite(int $siteId) : array<string|int, mixed>
Parameters
$siteId : int

Site id.

Tags
see
Rights::getOperationsForSite
Return values
array<string|int, mixed>

getPublicationPath()

Returns publication path string.

public static getPublicationPath() : string
Return values
string

init()

Method for first time initialization scope.

public static init([array<string|int, mixed> $params = [] ]) : void
Parameters
$params : array<string|int, mixed> = []

Additional params.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results