Bitrix API

Platform extends Platform

AbstractYes

Class Platform

Table of Contents

Constants

LINK_TYPE_PUBLIC_DETAIL_ORDER  = 'PUBLIC_DETAIL_ORDER'
LINK_TYPE_PUBLIC_FEEDBACK  = 'PUBLIC_FEEDBACK'
TRADING_PLATFORM_CODE  = ""

Methods

addLogRecord()  : bool
getAnalyticCode()  : string
getCode()  : string
getExternalLink()  : string
getField()  : mixed
getId()  : mixed
getInfo()  : array<string|int, mixed>
getInstanceByCode()  : Platform
getRealName()  : mixed
getSettings()  : array<string|int, mixed>
install()  : bool
Installs platform
isActive()  : bool
isInstalled()  : bool
isOfType()  : bool
onAfterUpdateShipment()  : mixed
resetSettings()  : mixed
saveSettings()  : bool
setActive()  : bool
Sets the platform active.
setShipmentTableOnAfterUpdateEvent()  : void
uninstall()  : bool
unsetActive()  : bool
Sets the platform inactive.

Constants

LINK_TYPE_PUBLIC_DETAIL_ORDER

public mixed LINK_TYPE_PUBLIC_DETAIL_ORDER = 'PUBLIC_DETAIL_ORDER'

LINK_TYPE_PUBLIC_FEEDBACK

public mixed LINK_TYPE_PUBLIC_FEEDBACK = 'PUBLIC_FEEDBACK'

TRADING_PLATFORM_CODE

public mixed TRADING_PLATFORM_CODE = ""

Methods

addLogRecord()

public addLogRecord(int $level, string $type, string $itemId, string $description) : bool
Parameters
$level : int

The level of event.

$type : string

Type of event.

$itemId : string

Item idenifyer.

$description : string

Description of event.

Return values
bool —

Success or not.

getAnalyticCode()

public getAnalyticCode() : string
Return values
string —

Platform code.

getCode()

public getCode() : string
Return values
string —

Platform code.

getExternalLink()

public getExternalLink(mixed $type, Order $order) : string
Parameters
$type : mixed
$order : Order
Return values
string

getField()

public getField(mixed $fieldName) : mixed
Parameters
$fieldName : mixed

getId()

public getId() : mixed
Return values
mixed —

Id of the current trading platform.

getInfo()

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

getInstanceByCode()

public static getInstanceByCode(mixed $code) : Platform
Parameters
$code : mixed
Tags
throws
ArgumentNullException
Return values
Platform

getRealName()

public getRealName() : mixed

getSettings()

public getSettings() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Platform settings.

install()

Installs platform

public install() : bool
Tags
throws
Exception
Return values
bool

isActive()

public isActive() : bool
Return values
bool

isInstalled()

public isInstalled() : bool
Return values
bool —

Is platfom installed?.

isOfType()

public isOfType(string $type) : bool
Parameters
$type : string
Return values
bool

onAfterUpdateShipment()

public static onAfterUpdateShipment(Event $event, array<string|int, mixed> $additional) : mixed
Parameters
$event : Event
$additional : array<string|int, mixed>

resetSettings()

public resetSettings(mixed $siteId) : mixed
Parameters
$siteId : mixed

saveSettings()

public saveSettings(array<string|int, mixed> $settings) : bool
Parameters
$settings : array<string|int, mixed>

Platform settings.

Return values
bool —

Is success?.

setActive()

Sets the platform active.

public setActive() : bool
Return values
bool

setShipmentTableOnAfterUpdateEvent()

public static setShipmentTableOnAfterUpdateEvent() : void

uninstall()

public uninstall() : bool
Return values
bool —

Is deletion successful?.

unsetActive()

Sets the platform inactive.

public unsetActive() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results