Bitrix API

Manager

Table of Contents

Methods

checkReadPermission()  : bool
Check read permissions.
checkWritePermission()  : bool
Check update permissions.
getActiveForms()  : array<string|int, mixed>
Get active non-callback form list.
getCallbackEditUrl()  : string
Get path to crm-form edit page
getCallbackListUrl()  : string
getCallbackNewFormEditUrl()  : string
getEditUrl()  : string
Get path to crm-form edit page.
getFacebookIntegrationFormEditUrl()  : string
Get Facebook integration scenario Form edit url
getListForEntitySelector()  : array<string|int, mixed>|array<string|int, array<string|int, mixed>>|null
Get prepared data to entity selector component.
getListNames()  : array<string|int, mixed>
Get list form names list.
getListNamesEncoded()  : array<string|int, mixed>
Get encoded form names list.
getListPlain()  : array<string|int, mixed>
Get plain form list.
getUrl()  : string
Get path to crm-form list page.
getVkontakteIntegrationFormEditUrl()  : string
Get Facebook integration scenario Form edit url
isEmbeddingAvailable()  : mixed
isEmbeddingEnabled()  : mixed
isInUse()  : bool
Is crm-forms in use.
isOrdersAvailable()  : mixed
onCatalogPriceAfterUpdate()  : void
Handler for Bitrix\Catalog\Model\Price::OnAfterUpdate.
updateScriptCache()  : mixed
updateScriptCacheAgent()  : mixed

Methods

checkReadPermission()

Check read permissions.

public static checkReadPermission([null|CCrmAuthorizationHelper $userPermissions = null ]) : bool
Parameters
$userPermissions : null|CCrmAuthorizationHelper = null

User permissions.

Return values
bool

checkWritePermission()

Check update permissions.

public static checkWritePermission([null|CCrmAuthorizationHelper $userPermissions = null ]) : bool
Parameters
$userPermissions : null|CCrmAuthorizationHelper = null

User permissions.

Return values
bool

getActiveForms()

Get active non-callback form list.

public static getActiveForms([array<string|int, mixed> $params = array('order' => array('ID' => 'DESC'), 'cache' => array('ttl' => 36000)) ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = array('order' => array('ID' => 'DESC'), 'cache' => array('ttl' => 36000))

Query parameters.

Return values
array<string|int, mixed>

getCallbackEditUrl()

Get path to crm-form edit page

public static getCallbackEditUrl(int $formId) : string
Parameters
$formId : int
Return values
string

getCallbackListUrl()

public static getCallbackListUrl([mixed $additionalParameters = [] ]) : string
Parameters
$additionalParameters : mixed = []
Return values
string

getCallbackNewFormEditUrl()

public static getCallbackNewFormEditUrl() : string
Return values
string

getEditUrl()

Get path to crm-form edit page.

public static getEditUrl([int $formId = 0 ][, bool $landingOnly = false ]) : string
Parameters
$formId : int = 0

Form Id.

$landingOnly : bool = false

Get link in landing editor.

Return values
string

getFacebookIntegrationFormEditUrl()

Get Facebook integration scenario Form edit url

public static getFacebookIntegrationFormEditUrl(int $formId) : string
Parameters
$formId : int
Return values
string

getListForEntitySelector()

Get prepared data to entity selector component.

public static getListForEntitySelector(string $entityId, string $tabId) : array<string|int, mixed>|array<string|int, array<string|int, mixed>>|null
Parameters
$entityId : string
$tabId : string
Return values
array<string|int, mixed>|array<string|int, array<string|int, mixed>>|null

getListNames()

Get list form names list.

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

getListNamesEncoded()

Get encoded form names list.

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

getListPlain()

Get plain form list.

public static getListPlain([array<string|int, mixed> $parameters = [] ]) : array<string|int, mixed>
Parameters
$parameters : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getUrl()

Get path to crm-form list page.

public static getUrl() : string
Return values
string

getVkontakteIntegrationFormEditUrl()

Get Facebook integration scenario Form edit url

public static getVkontakteIntegrationFormEditUrl(int $formId) : string
Parameters
$formId : int
Return values
string

isEmbeddingAvailable()

public static isEmbeddingAvailable() : mixed

isEmbeddingEnabled()

public static isEmbeddingEnabled(mixed $formId) : mixed
Parameters
$formId : mixed

isInUse()

Is crm-forms in use.

public static isInUse([string $isCallback = 'N' ]) : bool
Parameters
$isCallback : string = 'N'

Is callback.

Return values
bool

isOrdersAvailable()

public static isOrdersAvailable() : mixed

onCatalogPriceAfterUpdate()

Handler for Bitrix\Catalog\Model\Price::OnAfterUpdate.

public static onCatalogPriceAfterUpdate(Event $event) : void
Parameters
$event : Event
Tags
see
Price

updateScriptCache()

public static updateScriptCache([mixed $fromFormId = null ][, mixed $limit = 50 ]) : mixed
Parameters
$fromFormId : mixed = null
$limit : mixed = 50

updateScriptCacheAgent()

public static updateScriptCacheAgent([mixed $fromFormId = null ]) : mixed
Parameters
$fromFormId : mixed = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results