Bitrix API

Bitrix24Manager

Class Bitrix24Manager

Required in Biitrix24 context. Provodes information about the license and supported features.

Table of Contents

Methods

getDealCategoryCount()  : int
Get maximum allowed deal category quantity.
getDemoLicensePageUrl()  : string
Get URL for "Free 30-day trial" page.
getLicenseListPageUrl()  : string
Get URL for "Choose a Bitrix24 plan" page.
getMaxVariable()  : int
Fetch variable with MAX value (for maximal editions)
getVariable()  : mixed|null
Get variable value.
hasDemoLicense()  : bool
Check if portal has trial license.
hasNfrLicense()  : bool
Check if portal has NFR license.
hasPurchasedDiskSpace()  : bool
Check if portal has paid for extra disk space.
hasPurchasedLicense()  : bool
Check if portal has paid license.
hasPurchasedUsers()  : bool
Check if portal has paid for extra users.
isAccessEnabled()  : bool
Check accessability of entity type according to Bitrix24 restrictions.
isEnabled()  : bool
Check if current manager enabled.
isEnterprise()  : bool
Method determines if the installed license is an ENTERPRISE
isFeatureEnabled()  : bool
Check if specified feature is enabled
isPaidAccount()  : bool
Check if portal has paid license, paid for extra users, paid for disk space or SIP features.
isRestBizProcEnabled()  : bool
Check if Business Processes are enabled for REST API.
isUnlimitedAccess()  : bool
Check if user has unlimited access
prepareLicenseFeaturePromoterScript()  : string
prepareLicenseInfoHelperScript()  : string
Prepare JavaScript for opening purchaise information by info-helper slider
prepareLicenseInfoHtml()  : string
Prepare HTML for license purchase information.
prepareLicenseInfoPopupScript()  : string
Prepare JavaScript for license purchase information.
prepareStubInfo()  : array<string|int, mixed>|null

Methods

getDealCategoryCount()

Get maximum allowed deal category quantity.

public static getDealCategoryCount() : int
Tags
throws
LoaderException
Return values
int

getDemoLicensePageUrl()

Get URL for "Free 30-day trial" page.

public static getDemoLicensePageUrl() : string
Tags
throws
LoaderException
Return values
string

getLicenseListPageUrl()

Get URL for "Choose a Bitrix24 plan" page.

public static getLicenseListPageUrl() : string
Tags
throws
LoaderException
Return values
string

getMaxVariable()

Fetch variable with MAX value (for maximal editions)

public static getMaxVariable(string $name) : int
Parameters
$name : string

Variable name

Return values
int

getVariable()

Get variable value.

public static getVariable(string $name) : mixed|null
Parameters
$name : string

Name of variable

Return values
mixed|null

hasDemoLicense()

Check if portal has trial license.

public static hasDemoLicense() : bool
Tags
throws
LoaderException
Return values
bool

hasNfrLicense()

Check if portal has NFR license.

public static hasNfrLicense() : bool
Tags
throws
LoaderException
Return values
bool

hasPurchasedDiskSpace()

Check if portal has paid for extra disk space.

public static hasPurchasedDiskSpace() : bool
Tags
throws
LoaderException
Return values
bool

hasPurchasedLicense()

Check if portal has paid license.

public static hasPurchasedLicense() : bool
Tags
throws
LoaderException
Return values
bool

hasPurchasedUsers()

Check if portal has paid for extra users.

public static hasPurchasedUsers() : bool
Tags
throws
LoaderException
Return values
bool

isAccessEnabled()

Check accessability of entity type according to Bitrix24 restrictions.

public static isAccessEnabled(int $entityTypeID[, int $userID = 0 ]) : bool
Parameters
$entityTypeID : int

Entity type ID.

$userID : int = 0

User ID (if not specified then current user ID will be taken).

Tags
throws
ArgumentOutOfRangeException
throws
LoaderException
Return values
bool

isEnabled()

Check if current manager enabled.

public static isEnabled() : bool
Return values
bool

isEnterprise()

Method determines if the installed license is an ENTERPRISE

public static isEnterprise() : bool
Return values
bool

isFeatureEnabled()

Check if specified feature is enabled

public static isFeatureEnabled(string $releaseName) : bool
Parameters
$releaseName : string

Name of release.

Return values
bool

isPaidAccount()

Check if portal has paid license, paid for extra users, paid for disk space or SIP features.

public static isPaidAccount() : bool
Return values
bool

isRestBizProcEnabled()

Check if Business Processes are enabled for REST API.

public static isRestBizProcEnabled() : bool
Return values
bool

isUnlimitedAccess()

Check if user has unlimited access

public static isUnlimitedAccess([int $userID = 0 ]) : bool
Parameters
$userID : int = 0

User ID (if not specified then current user ID will be taken).

Tags
throws
LoaderException
Return values
bool

prepareLicenseFeaturePromoterScript()

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

prepareLicenseInfoHelperScript()

Prepare JavaScript for opening purchaise information by info-helper slider

public static prepareLicenseInfoHelperScript(array<string|int, mixed> $params) : string
Parameters
$params : array<string|int, mixed>

Info-helper params.

Tags
throws
LoaderException
Return values
string

prepareLicenseInfoHtml()

Prepare HTML for license purchase information.

public static prepareLicenseInfoHtml(array<string|int, mixed> $params) : string
Parameters
$params : array<string|int, mixed>

Popup params.

Tags
throws
LoaderException
Return values
string

prepareLicenseInfoPopupScript()

Prepare JavaScript for license purchase information.

public static prepareLicenseInfoPopupScript(array<string|int, mixed> $params) : string
Parameters
$params : array<string|int, mixed>

Popup params.

Tags
throws
LoaderException
Return values
string

prepareStubInfo()

public static prepareStubInfo(array<string|int, mixed> $params) : array<string|int, mixed>|null
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results