Bitrix API

Type

Table of Contents

Constants

PSEUDO_SCOPE_CODE_FORMS  = 'crm_forms'
Pseudo scope for crm forms.
SCOPE_CODE_GROUP  = 'GROUP'
Scope group.
SCOPE_CODE_KNOWLEDGE  = 'KNOWLEDGE'
Scope knowledge.
SCOPE_CODE_MAINPAGE  = 'MAINPAGE'
Scope for mainpage (welcome)

Methods

clearScope()  : void
Clear selected scope.
getCurrentScopeId()  : string|null
Returns current scope id.
getDomainId()  : int|string
Returns domain id for new site.
getExcludedHooks()  : array<string|int, mixed>
Returns array of hook's codes, which excluded by scope.
getFilterType()  : string|array<string|int, string>|null
Returns filter value for 'TYPE' key.
getKeyCode()  : string
Return general key for site path (ID or CODE).
getOperationsForSite()  : array<string|int, mixed>|null
Scoped method for returning available operations of site.
getPublicationPath()  : string|null
Returns publication path string.
getSiteSpecialType()  : string|null
Detect site special type (forms or mainpage)
isEnabled()  : bool
Returns true, if type is enabled in system.
isPublicScope()  : bool
Returns true if scope is public.
prepareBlockManifest()  : array<string|int, mixed>
Change manifest field by special conditions of site type
setScope()  : void
Set global scope.

Constants

PSEUDO_SCOPE_CODE_FORMS

Pseudo scope for crm forms.

public mixed PSEUDO_SCOPE_CODE_FORMS = 'crm_forms'

SCOPE_CODE_GROUP

Scope group.

public mixed SCOPE_CODE_GROUP = 'GROUP'

SCOPE_CODE_KNOWLEDGE

Scope knowledge.

public mixed SCOPE_CODE_KNOWLEDGE = 'KNOWLEDGE'

SCOPE_CODE_MAINPAGE

Scope for mainpage (welcome)

public mixed SCOPE_CODE_MAINPAGE = 'MAINPAGE'

Methods

clearScope()

Clear selected scope.

public static clearScope() : void

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|string
Return values
int|string

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([bool $strict = false ]) : string|array<string|int, string>|null
Parameters
$strict : bool = false

If strict, returns without default.

Return values
string|array<string|int, string>|null

getKeyCode()

Return general key for site path (ID or CODE).

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>|null
Parameters
$siteId : int

Site id.

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

getPublicationPath()

Returns publication path string.

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

getSiteSpecialType()

Detect site special type (forms or mainpage)

public static getSiteSpecialType(string $siteCode) : string|null
Parameters
$siteCode : string
Return values
string|null

isEnabled()

Returns true, if type is enabled in system.

public static isEnabled(string $code) : bool
Parameters
$code : string

Type code.

Return values
bool

isPublicScope()

Returns true if scope is public.

public static isPublicScope([string|null $scope = null ]) : bool
Parameters
$scope : string|null = null

Scope code.

Return values
bool

prepareBlockManifest()

Change manifest field by special conditions of site type

public static prepareBlockManifest(array<string|int, mixed> $manifest) : array<string|int, mixed>
Parameters
$manifest : array<string|int, mixed>
Return values
array<string|int, mixed> —

prepared manifest

setScope()

Set global scope.

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

Scope code.

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

Additional params.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results