Bitrix API

Group extends Base

Class Base (abstract) Base class for delivery services

Table of Contents

Constants

EVENT_ON_CALCULATE  = "onSaleDeliveryServiceCalculate"
TAG_PROFITABLE  = 'profitable'

Methods

__construct()  : mixed
Constructor
calculate()  : CalculationResult
Calculates delivery price
canHasChildren()  : bool
canHasProfiles()  : bool
createProfileObject()  : mixed
execAdminAction()  : Result
Execute some code on service edit page if need.
getAdditionalInfoShipmentEdit()  : array<string|int, mixed>
getAdditionalInfoShipmentPublic()  : array<string|int, mixed>
getAdditionalInfoShipmentView()  : array<string|int, mixed>
getAdminAdditionalTabs()  : array<string|int, mixed>
getAdminFieldsList()  : array<string|int, mixed>
getAdminMessage()  : array<string|int, mixed>
Show message on service edit page.
getChildrenClassNames()  : array<string|int, mixed>
getClassDescription()  : string
Returns class description
getClassTitle()  : string
Returns class name
getCode()  : string
getCompatibleExtraServiceIds()  : array<string|int, mixed>|null
Returns array of extra service ids available for the specified shipment OR null in case all extra services are available
getConfig()  : array<string|int, mixed>
getConfigValues()  : array<string|int, mixed>
getCurrency()  : string
getDefaultVatRate()  : float|null
getDeliveryRequestHandler()  : HandlerBase
getDescription()  : string
getEmbeddedExtraServicesList()  : array<string|int, mixed>
getExtraServices()  : Manager
getHandlerCode()  : string
getId()  : int
getLogotip()  : int
getLogotipPath()  : string
getName()  : string
getNameWithParent()  : string
getParentId()  : int
getParentService()  : Base|null
getProfilesList()  : array<string|int, mixed>
getServiceCode()  : string
getSort()  : mixed
getSupportedServicesList()  : array<string|int, mixed>
Returns names of supported delivery services
getTags()  : array<string|int, mixed>
getTrackingClass()  : string
getTrackingParams()  : array<string|int, mixed>
getVatId()  : int
install()  : mixed
isAllowEditShipment()  : bool
isCalculatePriceImmediately()  : bool
isClone()  : bool
isCompatible()  : bool
isHandlerCompatible()  : bool
Checks if handler is compatible
isInstalled()  : bool
isProfile()  : bool
isRestricted()  : bool
isTrackingInherited()  : bool
onAfterAdd()  : bool
onAfterDelete()  : bool
onAfterUpdate()  : bool
onBeforeAdd()  : Result
onBeforeUpdate()  : bool
onGetBusinessValueConsumers()  : array<string|int, mixed>
onGetBusinessValueGroups()  : array<string|int, mixed>
prepareFieldsForSaving()  : array<string|int, mixed>
prepareFieldsForUsing()  : array<string|int, mixed>
processAdditionalInfoShipmentEdit()  : Shipment|null
setTrackingClass()  : mixed
setVatId()  : mixed
unInstall()  : mixed
whetherAdminExtraServicesShow()  : bool
whetherAdminRestrictionsShow()  : bool

Constants

EVENT_ON_CALCULATE

public mixed EVENT_ON_CALCULATE = "onSaleDeliveryServiceCalculate"

TAG_PROFITABLE

public mixed TAG_PROFITABLE = 'profitable'

Methods

__construct()

Constructor

public __construct(array<string|int, mixed> $initParams) : mixed
Parameters
$initParams : array<string|int, mixed>

Delivery service params

calculate()

Calculates delivery price

public calculate([Shipment|null $shipment = null ][, array<string|int, mixed> $extraServices = array() ]) : CalculationResult
Parameters
$shipment : Shipment|null = null

.

$extraServices : array<string|int, mixed> = array()

.

Return values
CalculationResult

canHasChildren()

public static canHasChildren() : bool
Return values
bool —

Can this services has children.

canHasProfiles()

public static canHasProfiles() : bool
Return values
bool —

Can this services has profiles.

createProfileObject()

public createProfileObject(mixed $fields) : mixed
Parameters
$fields : mixed

execAdminAction()

Execute some code on service edit page if need.

public execAdminAction() : Result
Return values
Result

getAdditionalInfoShipmentEdit()

public getAdditionalInfoShipmentEdit(Shipment $shipment) : array<string|int, mixed>
Parameters
$shipment : Shipment
Return values
array<string|int, mixed>

getAdditionalInfoShipmentPublic()

public getAdditionalInfoShipmentPublic(Shipment $shipment) : array<string|int, mixed>
Parameters
$shipment : Shipment
Return values
array<string|int, mixed>

getAdditionalInfoShipmentView()

public getAdditionalInfoShipmentView(Shipment $shipment) : array<string|int, mixed>
Parameters
$shipment : Shipment
Return values
array<string|int, mixed>

getAdminAdditionalTabs()

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

Additional tabs to show on edit admin page.

getAdminFieldsList()

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

Fields witch user will see on delivery admin page

getAdminMessage()

Show message on service edit page.

public getAdminMessage() : array<string|int, mixed>
Tags
see
CAdminMessage::CAdminMessage
Return values
array<string|int, mixed> —

array("MESSAGE"=>"", "TYPE"=>("ERROR"|"OK"|"PROGRESS"), "DETAILS"=>"", "HTML"=>true)

getChildrenClassNames()

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

profiles handlers class names

getClassDescription()

Returns class description

public static getClassDescription() : string
Return values
string

getClassTitle()

Returns class name

public static getClassTitle() : string
Return values
string

getCode()

public getCode() : string
Return values
string

getCompatibleExtraServiceIds()

Returns array of extra service ids available for the specified shipment OR null in case all extra services are available

public getCompatibleExtraServiceIds(Shipment $shipment) : array<string|int, mixed>|null
Parameters
$shipment : Shipment
Return values
array<string|int, mixed>|null

getConfig()

public getConfig() : array<string|int, mixed>
Tags
throws
SystemException
Return values
array<string|int, mixed>

getConfigValues()

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

getCurrency()

public getCurrency() : string
Return values
string —

The currency of delivery service.

getDefaultVatRate()

public static getDefaultVatRate() : float|null
Return values
float|null

getDescription()

public getDescription() : string
Return values
string

getEmbeddedExtraServicesList()

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

getHandlerCode()

public getHandlerCode() : string
Return values
string

getId()

public getId() : int
Return values
int

getLogotip()

public getLogotip() : int
Return values
int

getLogotipPath()

public getLogotipPath() : string
Return values
string

getName()

public getName() : string
Return values
string

getNameWithParent()

public getNameWithParent() : string
Return values
string

getParentId()

public getParentId() : int
Return values
int

getParentService()

public getParentService() : Base|null
Tags
throws
SystemException
throws
ArgumentNullException
Return values
Base|null

getProfilesList()

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

Profiles list

getServiceCode()

public getServiceCode() : string
Return values
string

getSort()

public getSort() : mixed

getSupportedServicesList()

Returns names of supported delivery services

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

getTags()

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

getTrackingClass()

public getTrackingClass() : string
Return values
string —

Class name inherited from \Bitrix\Sale\Delivery\Tracking\Base

getTrackingParams()

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

getVatId()

public getVatId() : int
Return values
int

install()

public static install() : mixed

isAllowEditShipment()

public isAllowEditShipment() : bool
Return values
bool

isCalculatePriceImmediately()

public isCalculatePriceImmediately() : bool
Return values
bool

isClone()

public isClone() : bool
Return values
bool

isCompatible()

public isCompatible(Shipment $shipment) : bool
Parameters
$shipment : Shipment
Return values
bool

isHandlerCompatible()

Checks if handler is compatible

public static isHandlerCompatible() : bool
Return values
bool

isInstalled()

public static isInstalled() : bool
Return values
bool

isProfile()

public static isProfile() : bool
Return values
bool

isRestricted()

public isRestricted() : bool
Return values
bool

isTrackingInherited()

public isTrackingInherited() : bool
Return values
bool

onAfterAdd()

public static onAfterAdd(int $serviceId[, array<string|int, mixed> $fields = array() ]) : bool
Parameters
$serviceId : int
$fields : array<string|int, mixed> = array()
Return values
bool

onAfterDelete()

public static onAfterDelete(int $serviceId) : bool
Parameters
$serviceId : int
Return values
bool

onAfterUpdate()

public static onAfterUpdate(int $serviceId[, array<string|int, mixed> $fields = array() ]) : bool
Parameters
$serviceId : int
$fields : array<string|int, mixed> = array()
Return values
bool

onBeforeAdd()

public static onBeforeAdd([array<string|int, mixed> &$fields = array() ]) : Result
Parameters
$fields : array<string|int, mixed> = array()
Return values
Result

onBeforeUpdate()

public static onBeforeUpdate(int $serviceId[, array<string|int, mixed> &$fields = array() ]) : bool
Parameters
$serviceId : int
$fields : array<string|int, mixed> = array()
Return values
bool

onGetBusinessValueConsumers()

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

onGetBusinessValueGroups()

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

prepareFieldsForSaving()

public prepareFieldsForSaving(array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$fields : array<string|int, mixed>
Tags
throws
SystemException
Return values
array<string|int, mixed>

prepareFieldsForUsing()

public prepareFieldsForUsing(array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$fields : array<string|int, mixed>
Return values
array<string|int, mixed>

processAdditionalInfoShipmentEdit()

public processAdditionalInfoShipmentEdit(Shipment $shipment, array<string|int, mixed> $requestData) : Shipment|null
Parameters
$shipment : Shipment
$requestData : array<string|int, mixed>
Return values
Shipment|null

setTrackingClass()

public setTrackingClass(string $class) : mixed
Parameters
$class : string

Class name inherited from \Bitrix\Sale\Delivery\Tracking\Base

setVatId()

public setVatId(int $vatId) : mixed
Parameters
$vatId : int

unInstall()

public static unInstall() : mixed

whetherAdminExtraServicesShow()

public static whetherAdminExtraServicesShow() : bool
Return values
bool —

If admin could edit extra services

whetherAdminRestrictionsShow()

public static whetherAdminRestrictionsShow() : bool
Return values
bool —

Show or not restrictions on admin page For example lib/delivery/services/group.php: we must hide it on public page always, and nobody can cancel this.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results