Bitrix API

Config

Class Config

Table of Contents

Constants

SIGHT_SALT  = 'main_mail_callback'

Methods

generateId()  : $this
Generate ID.
getEntityId()  : string
Get entity ID.
getEntityType()  : string
Get entity type.
getHost()  : string
Get host.
getId()  : string
Get id.
getModuleId()  : string
Get module ID.
getSignature()  : string|null
Get signature.
setEntityId()  : $this
Set entity ID.
setEntityType()  : $this
Set entity type.
setHost()  : $this
Set host.
setModuleId()  : $this
Set module ID.
unpackId()  : $this
Unpack ID.
verifySignature()  : bool
Verify signature.

Constants

SIGHT_SALT

public mixed SIGHT_SALT = 'main_mail_callback'

Methods

generateId()

Generate ID.

public static generateId(string $moduleId[, string|null $entityType = null ], string|int $entityId) : $this
Parameters
$moduleId : string

Module ID.

$entityType : string|null = null

Entity type.

$entityId : string|int

Entity ID.

Tags
throws
ArgumentException
Return values
$this

getEntityId()

Get entity ID.

public getEntityId() : string

Unique per moduleId & entityType. It might be an email or ID of row in some table.

Return values
string

getEntityType()

Get entity type.

public getEntityType() : string
Return values
string

getHost()

Get host.

public getHost() : string
Return values
string

getId()

Get id.

public getId() : string
Return values
string

getModuleId()

Get module ID.

public getModuleId() : string
Return values
string

getSignature()

Get signature.

public getSignature() : string|null
Return values
string|null

setEntityId()

Set entity ID.

public setEntityId(string $entityId) : $this
Parameters
$entityId : string

Entity ID.

Tags
throws
ArgumentException
Return values
$this

setEntityType()

Set entity type.

public setEntityType(string|null $entityType) : $this

Additional category on callback. Unique per moduleId.

Parameters
$entityType : string|null

Entity type.

Tags
throws
ArgumentException
Return values
$this

setHost()

Set host.

public setHost(string $host) : $this
Parameters
$host : string

Host.

Return values
$this

setModuleId()

Set module ID.

public setModuleId(string $moduleId) : $this
Parameters
$moduleId : string

Module ID.

Tags
throws
ArgumentException
Return values
$this

unpackId()

Unpack ID.

public unpackId(string $id) : $this
Parameters
$id : string

ID.

Tags
throws
ArgumentException
Return values
$this

verifySignature()

Verify signature.

public verifySignature(string $signature) : bool
Parameters
$signature : string

Signature.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results