Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Base

Открытые члены

 __construct (array $initParams)
 
 getHandlerCode ()
 
 getServiceCode ()
 
 calculate (\Bitrix\Sale\Shipment $shipment=null, $extraServices=array())
 
 getExtraServices ()
 
 getCurrency ()
 
 prepareFieldsForSaving (array $fields)
 
 getConfig ()
 
 getConfigValues ()
 
 getId ()
 
 getCode ()
 
 getName ()
 
 getDescription ()
 
 getParentId ()
 
 getSort ()
 
 getNameWithParent ()
 
 getLogotip ()
 
 getLogotipPath ()
 
 getParentService ()
 
 prepareFieldsForUsing (array $fields)
 
 getEmbeddedExtraServicesList ()
 
 isCompatible (Shipment $shipment)
 
 getCompatibleExtraServiceIds (Shipment $shipment)
 
 getProfilesList ()
 
 getTrackingClass ()
 
 setTrackingClass ($class)
 
 getTrackingParams ()
 
 isTrackingInherited ()
 
 isCalculatePriceImmediately ()
 
 isRestricted ()
 
 isAllowEditShipment ()
 
 getAdminMessage ()
 
 execAdminAction ()
 
 getAdditionalInfoShipmentEdit (Shipment $shipment)
 
 processAdditionalInfoShipmentEdit (Shipment $shipment, array $requestData)
 
 getAdditionalInfoShipmentView (Shipment $shipment)
 
 getAdditionalInfoShipmentPublic (Shipment $shipment)
 
 isClone ()
 
 getAdminAdditionalTabs ()
 
 getVatId ()
 
 setVatId ($vatId)
 
 getDeliveryRequestHandler ()
 
 createProfileObject ($fields)
 
 getTags ()
 

Открытые статические члены

static getClassTitle ()
 
static getClassDescription ()
 
static getDefaultVatRate ()
 
static getAdminFieldsList ()
 
static whetherAdminRestrictionsShow ()
 
static canHasChildren ()
 
static canHasProfiles ()
 
static getChildrenClassNames ()
 
static whetherAdminExtraServicesShow ()
 
static onBeforeAdd (array &$fields=array())
 
static onAfterAdd ($serviceId, array $fields=array())
 
static onBeforeUpdate ($serviceId, array &$fields=array())
 
static onAfterUpdate ($serviceId, array $fields=array())
 
static onAfterDelete ($serviceId)
 
static isProfile ()
 
static onGetBusinessValueConsumers ()
 
static onGetBusinessValueGroups ()
 
static isInstalled ()
 
static install ()
 
static unInstall ()
 
static getSupportedServicesList ()
 
static isHandlerCompatible ()
 

Открытые атрибуты

const EVENT_ON_CALCULATE = "onSaleDeliveryServiceCalculate"
 
const TAG_PROFITABLE = 'profitable'
 

Защищенные члены

 calculateConcrete (\Bitrix\Sale\Shipment $shipment)
 
 getConfigStructure ()
 
 glueValuesToConfig (array $confStructure, $confValues=array())
 
 getProfileType ()
 

Защищенные данные

 $handlerCode = 'UNDEFINED'
 
 $id = 0
 
 $name = ""
 
 $code = ""
 
 $vatId = 0
 
 $sort = 100
 
 $logotip = 0
 
 $parentId = 0
 
 $currency = ""
 
 $active = false
 
 $description = ""
 
 $config = array()
 
 $restricted = false
 
 $trackingClass = ""
 
 $deliveryRequestHandler = null
 
 $extraServices = array()
 
 $trackingParams = array()
 
 $allowEditShipment = array()
 
 $isClone = false
 

Статические защищенные данные

static $isProfile = false
 
static $canHasProfiles = false
 
static $isCalculatePriceImmediately = false
 
static $whetherAdminExtraServicesShow = false
 

Подробное описание

См. определение в файле base.php строка 24

Конструктор(ы)

◆ __construct()

__construct ( array $initParams)

Constructor

Аргументы
array$initParamsDelivery service params
Исключения

Bitrix\Main\ArgumentTypeException

Исключения

Bitrix\Main\SystemException

См. определение в файле base.php строка 66

Методы

◆ calculate()

calculate ( \Bitrix\Sale\Shipment $shipment = null,
$extraServices = array() )

Calculates delivery price

Аргументы
Shipment | null$shipment.
array$extraServices.
Возвращает
\Bitrix\Sale\Delivery\CalculationResult

См. определение в файле base.php строка 165

◆ calculateConcrete()

calculateConcrete ( \Bitrix\Sale\Shipment $shipment)
protected
Аргументы
\Bitrix\Sale\Shipment$shipment,.
Возвращает
Delivery\CalculationResult

См. определение в файле base.php строка 296

◆ canHasChildren()

static canHasChildren ( )
static
Возвращает
bool Can this services has children.

См. определение в файле base.php строка 442

◆ canHasProfiles()

static canHasProfiles ( )
static
Возвращает
bool Can this services has profiles.

См. определение в файле base.php строка 450

◆ createProfileObject()

createProfileObject ( $fields)

См. определение в файле base.php строка 923

◆ execAdminAction()

execAdminAction ( )

Execute some code on service edit page if need.

Возвращает
Result

См. определение в файле base.php строка 794

◆ getAdditionalInfoShipmentEdit()

getAdditionalInfoShipmentEdit ( Shipment $shipment)
Аргументы
Shipment$shipment
Возвращает
array

См. определение в файле base.php строка 803

◆ getAdditionalInfoShipmentPublic()

getAdditionalInfoShipmentPublic ( Shipment $shipment)
Аргументы
Shipment$shipment
Возвращает
array

См. определение в файле base.php строка 831

◆ getAdditionalInfoShipmentView()

getAdditionalInfoShipmentView ( Shipment $shipment)
Аргументы
Shipment$shipment
Возвращает
array

См. определение в файле base.php строка 822

◆ getAdminAdditionalTabs()

getAdminAdditionalTabs ( )
Возвращает
array Additional tabs to show on edit admin page.

См. определение в файле base.php строка 894

◆ getAdminFieldsList()

static getAdminFieldsList ( )
static
Возвращает
array Fields witch user will see on delivery admin page

См. определение в файле base.php строка 425

◆ getAdminMessage()

getAdminMessage ( )

Show message on service edit page.

Возвращает
array array("MESSAGE"=>"", "TYPE"=>("ERROR"|"OK"|"PROGRESS"), "DETAILS"=>"", "HTML"=>true)
См. также
\CAdminMessage::CAdminMessage

См. определение в файле base.php строка 785

◆ getChildrenClassNames()

static getChildrenClassNames ( )
static
Возвращает
array profiles handlers class names

См. определение в файле base.php строка 458

◆ getClassDescription()

static getClassDescription ( )
static

Returns class description

Возвращает
string

См. определение в файле base.php строка 279

◆ getClassTitle()

static getClassTitle ( )
static

Returns class name

Возвращает
string

См. определение в файле base.php строка 270

◆ getCode()

getCode ( )
Возвращает
string

См. определение в файле base.php строка 474

◆ getCompatibleExtraServiceIds()

getCompatibleExtraServiceIds ( Shipment $shipment)

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

Аргументы
Shipment$shipment
Возвращает
array|null

См. определение в файле base.php строка 660

◆ getConfig()

getConfig ( )
Возвращает
array
Исключения
SystemException

См. определение в файле base.php строка 401

◆ getConfigStructure()

getConfigStructure ( )
protected

Returns service configuration (only structure without values)

Возвращает
array
Исключения

Exception

См. определение в файле base.php строка 359

◆ getConfigValues()

getConfigValues ( )
Возвращает
array

См. определение в файле base.php строка 417

◆ getCurrency()

getCurrency ( )
Возвращает
string The currency of delivery service.

См. определение в файле base.php строка 236

◆ getDefaultVatRate()

static getDefaultVatRate ( )
static
Возвращает
float|null

См. определение в файле base.php строка 287

◆ getDeliveryRequestHandler()

getDeliveryRequestHandler ( )
Возвращает
Requests\HandlerBase

См. определение в файле base.php строка 918

◆ getDescription()

getDescription ( )
Возвращает
string

См. определение в файле base.php строка 490

◆ getEmbeddedExtraServicesList()

getEmbeddedExtraServicesList ( )
Возвращает
array

См. определение в файле base.php строка 568

◆ getExtraServices()

getExtraServices ( )
Возвращает
Delivery\ExtraServices\Manager

См. определение в файле base.php строка 228

◆ getHandlerCode()

getHandlerCode ( )
Возвращает
string

См. определение в файле base.php строка 135

◆ getId()

getId ( )
Возвращает
int

См. определение в файле base.php строка 466

◆ getLogotip()

getLogotip ( )
Возвращает
int

См. определение в файле base.php строка 527

◆ getLogotipPath()

getLogotipPath ( )
Возвращает
string

См. определение в файле base.php строка 535

◆ getName()

getName ( )
Возвращает
string

См. определение в файле base.php строка 482

◆ getNameWithParent()

getNameWithParent ( )
Возвращает
string

См. определение в файле base.php строка 514

◆ getParentId()

getParentId ( )
Возвращает
int

См. определение в файле base.php строка 498

◆ getParentService()

getParentService ( )
Возвращает
Base|null
Исключения
SystemException

Bitrix\Main\ArgumentNullException

См. определение в файле base.php строка 546

◆ getProfilesList()

getProfilesList ( )
Возвращает
array Profiles list

См. определение в файле base.php строка 668

◆ getProfileType()

getProfileType ( )
protected
Возвращает
string

См. определение в файле base.php строка 684

◆ getServiceCode()

getServiceCode ( )
Возвращает
string

См. определение в файле base.php строка 143

◆ getSort()

getSort ( )
Возвращает
mixed

См. определение в файле base.php строка 506

◆ getSupportedServicesList()

static getSupportedServicesList ( )
static

Returns names of supported delivery services

Возвращает
array

См. определение в файле base.php строка 886

◆ getTags()

getTags ( )
Возвращает
array

См. определение в файле base.php строка 946

◆ getTrackingClass()

getTrackingClass ( )
Возвращает
string Class name inherited from \Bitrix\Sale\Delivery\Tracking\Base

См. определение в файле base.php строка 692

◆ getTrackingParams()

getTrackingParams ( )
Возвращает
array

См. определение в файле base.php строка 708

◆ getVatId()

getVatId ( )
Возвращает
int

См. определение в файле base.php строка 902

◆ glueValuesToConfig()

glueValuesToConfig ( array $confStructure,
$confValues = array() )
protected
Аргументы
array$confStructureThe structure of configuration
array$confValuesThe configuration's values
Возвращает
array glued config with values

См. определение в файле base.php строка 369

◆ install()

static install ( )
static

См. определение в файле base.php строка 761

◆ isAllowEditShipment()

isAllowEditShipment ( )
Возвращает
bool

См. определение в файле base.php строка 774

◆ isCalculatePriceImmediately()

isCalculatePriceImmediately ( )
Возвращает
bool

См. определение в файле base.php строка 724

◆ isClone()

isClone ( )
Возвращает
bool

См. определение в файле base.php строка 877

◆ isCompatible()

isCompatible ( Shipment $shipment)
Аргументы
Shipment$shipment
Возвращает
bool

См. определение в файле base.php строка 648

◆ isHandlerCompatible()

static isHandlerCompatible ( )
static

Checks if handler is compatible

Возвращает
bool

См. определение в файле base.php строка 933

◆ isInstalled()

static isInstalled ( )
static
Возвращает
bool

См. определение в файле base.php строка 756

◆ isProfile()

static isProfile ( )
static
Возвращает
bool

См. определение в файле base.php строка 676

◆ isRestricted()

isRestricted ( )
Возвращает
bool

См. определение в файле base.php строка 732

◆ isTrackingInherited()

isTrackingInherited ( )
Возвращает
bool

См. определение в файле base.php строка 716

◆ onAfterAdd()

static onAfterAdd ( $serviceId,
array $fields = array() )
static
Аргументы
int$serviceId
array$fields
Возвращает
bool

См. определение в файле base.php строка 610

◆ onAfterDelete()

static onAfterDelete ( $serviceId)
static
Аргументы
int$serviceId
Возвращает
bool

См. определение в файле base.php строка 639

◆ onAfterUpdate()

static onAfterUpdate ( $serviceId,
array $fields = array() )
static
Аргументы
int$serviceId
array$fields
Возвращает
bool

См. определение в файле base.php строка 630

◆ onBeforeAdd()

static onBeforeAdd ( array & $fields = array())
static
Аргументы
array$fields
Возвращает
\Bitrix\Main\Result

См. определение в файле base.php строка 600

◆ onBeforeUpdate()

static onBeforeUpdate ( $serviceId,
array & $fields = array() )
static
Аргументы
int$serviceId
array$fields
Возвращает
bool

См. определение в файле base.php строка 620

◆ onGetBusinessValueConsumers()

static onGetBusinessValueConsumers ( )
static
Возвращает
array

См. определение в файле base.php строка 740

◆ onGetBusinessValueGroups()

static onGetBusinessValueGroups ( )
static
Возвращает
array

См. определение в файле base.php строка 748

◆ prepareFieldsForSaving()

prepareFieldsForSaving ( array $fields)
Аргументы
array$fields
Возвращает
array
Исключения
SystemException

См. определение в файле base.php строка 311

◆ prepareFieldsForUsing()

prepareFieldsForUsing ( array $fields)
Аргументы
array$fields
Возвращает
array

См. определение в файле base.php строка 560

◆ processAdditionalInfoShipmentEdit()

processAdditionalInfoShipmentEdit ( Shipment $shipment,
array $requestData )
Аргументы
Shipment$shipment
array$requestData
Возвращает
Shipment|null

См. определение в файле base.php строка 813

◆ setTrackingClass()

setTrackingClass ( $class)
Аргументы
string$classClass name inherited from \Bitrix\Sale\Delivery\Tracking\Base

См. определение в файле base.php строка 700

◆ setVatId()

setVatId ( $vatId)
Аргументы
int$vatId

См. определение в файле base.php строка 910

◆ unInstall()

static unInstall ( )
static

См. определение в файле base.php строка 766

◆ whetherAdminExtraServicesShow()

static whetherAdminExtraServicesShow ( )
static
Возвращает
bool If admin could edit extra services

См. определение в файле base.php строка 591

◆ whetherAdminRestrictionsShow()

static whetherAdminRestrictionsShow ( )
static
Возвращает
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.

См. определение в файле base.php строка 434

Данные класса

◆ $active

$active = false
protected

См. определение в файле base.php строка 36

◆ $allowEditShipment

$allowEditShipment = array()
protected

См. определение в файле base.php строка 46

◆ $canHasProfiles

$canHasProfiles = false
staticprotected

См. определение в файле base.php строка 49

◆ $code

$code = ""
protected

См. определение в файле base.php строка 30

◆ $config

$config = array()
protected

См. определение в файле base.php строка 38

◆ $currency

$currency = ""
protected

См. определение в файле base.php строка 35

◆ $deliveryRequestHandler

$deliveryRequestHandler = null
protected

См. определение в файле base.php строка 42

◆ $description

$description = ""
protected

См. определение в файле base.php строка 37

◆ $extraServices

$extraServices = array()
protected

См. определение в файле base.php строка 44

◆ $handlerCode

$handlerCode = 'UNDEFINED'
protected

См. определение в файле base.php строка 26

◆ $id

$id = 0
protected

См. определение в файле base.php строка 28

◆ $isCalculatePriceImmediately

$isCalculatePriceImmediately = false
staticprotected

См. определение в файле base.php строка 50

◆ $isClone

$isClone = false
protected

См. определение в файле base.php строка 58

◆ $isProfile

$isProfile = false
staticprotected

См. определение в файле base.php строка 48

◆ $logotip

$logotip = 0
protected

См. определение в файле base.php строка 33

◆ $name

$name = ""
protected

См. определение в файле base.php строка 29

◆ $parentId

$parentId = 0
protected

См. определение в файле base.php строка 34

◆ $restricted

$restricted = false
protected

См. определение в файле base.php строка 39

◆ $sort

$sort = 100
protected

См. определение в файле base.php строка 32

◆ $trackingClass

$trackingClass = ""
protected

См. определение в файле base.php строка 40

◆ $trackingParams

$trackingParams = array()
protected

См. определение в файле base.php строка 45

◆ $vatId

$vatId = 0
protected

См. определение в файле base.php строка 31

◆ $whetherAdminExtraServicesShow

$whetherAdminExtraServicesShow = false
staticprotected

См. определение в файле base.php строка 51

◆ EVENT_ON_CALCULATE

const EVENT_ON_CALCULATE = "onSaleDeliveryServiceCalculate"

См. определение в файле base.php строка 53

◆ TAG_PROFITABLE

const TAG_PROFITABLE = 'profitable'

См. определение в файле base.php строка 55