Bitrix API

OrderBasketShipment extends OrderBasket

Table of Contents

Constants

EDIT_MODE  = 1
VIEW_MODE  = 0

Properties

$settingsDialog  : mixed

Methods

__construct()  : mixed
getBasePrice()  : mixed
getCatalogMeasures()  : mixed
getCouponsHtml()  : mixed
getDefaultMeasures()  : mixed
getEdit()  : string
getOffersSkuParams()  : mixed
getOffersSkuParamsMode()  : array<string|int, mixed>
getPrices()  : mixed
getProductDataToFillBasket()  : array<string|int, mixed>
getProductDetails()  : array<string|int, mixed>
getProductEditDialogHtml()  : mixed
getProductsData()  : array<string|int, mixed>
getProductsInfo()  : array<string|int, mixed>
getScripts()  : string
getSettingsDialogContent()  : mixed
getTotalHtml()  : mixed
getView()  : string
getViewScript()  : mixed
loadVisibleColumns()  : mixed
modifyFromRequest()  : mixed
prepareData()  : array<string|int, mixed>|null
setSettingsShowPropsVisible()  : void
updateData()  : mixed

Constants

Properties

Methods

__construct()

public __construct(Shipment $shipment[, string $jsObjName = "" ][, string $idPrefix = "" ]) : mixed
Parameters
$shipment : Shipment
$jsObjName : string = ""
$idPrefix : string = ""
Tags
throws
ArgumentNullException

getBasePrice()

public static getBasePrice(Order $order) : mixed
Parameters
$order : Order

getCatalogMeasures()

public static getCatalogMeasures() : mixed

getCouponsHtml()

public getCouponsHtml(mixed $mode[, mixed $needRecalculate = true ]) : mixed
Parameters
$mode : mixed
$needRecalculate : mixed = true

getDefaultMeasures()

public static getDefaultMeasures() : mixed

getEdit()

public getEdit([mixed $defTails = false ]) : string
Parameters
$defTails : mixed = false
Return values
string

getOffersSkuParams()

public getOffersSkuParams(array<string|int, mixed> $productsParams[, array<string|int, mixed> $visibleColumns = array() ]) : mixed
Parameters
$productsParams : array<string|int, mixed>
$visibleColumns : array<string|int, mixed> = array()

getOffersSkuParamsMode()

public static getOffersSkuParamsMode(array<string|int, mixed> $productsParams[, array<string|int, mixed> $visibleColumns = array() ][, int $mode = 0 ]) : array<string|int, mixed>
Parameters
$productsParams : array<string|int, mixed>
$visibleColumns : array<string|int, mixed> = array()
$mode : int = 0
Tags
throws
LoaderException
Return values
array<string|int, mixed>

getPrices()

public getPrices([mixed $discounts = null ]) : mixed
Parameters
$discounts : mixed = null

getProductDataToFillBasket()

public static getProductDataToFillBasket(mixed $productId, mixed $quantity, mixed $userId, mixed $LID, mixed $userColumns[, string $tmpId = "" ]) : array<string|int, mixed>

use \Bitrix\Sale\Helpers\Admin\Product::getData() instead it.

Parameters
$productId : mixed
$quantity : mixed
$userId : mixed
$LID : mixed
$userColumns : mixed
$tmpId : string = ""

we can suggest that this mean the set_item

Tags
throws
LoaderException
Return values
array<string|int, mixed>

getProductDetails()

public static getProductDetails(int $productId, int $quantity, int $userId, string $siteId[, array<string|int, mixed> $columns = array() ]) : array<string|int, mixed>

use OrderBasket::getProductsData instead.

Parameters
$productId : int
$quantity : int
$userId : int
$siteId : string
$columns : array<string|int, mixed> = array()
Tags
throws
SystemException
Return values
array<string|int, mixed>

getProductEditDialogHtml()

public static getProductEditDialogHtml(mixed $currency, mixed $objName) : mixed
Parameters
$currency : mixed
$objName : mixed

getProductsData()

public static getProductsData(array<string|int, int> $productsIds, string $siteId[, array<string|int, mixed> $fields = array() ][, int $userId = 0 ]) : array<string|int, mixed>
Parameters
$productsIds : array<string|int, int>
$siteId : string
$fields : array<string|int, mixed> = array()
$userId : int = 0
Tags
throws
ArgumentNullException
Return values
array<string|int, mixed>

getProductsInfo()

public getProductsInfo(ShipmentItemCollection $shipmentItemCollection) : array<string|int, mixed>
Parameters
$shipmentItemCollection : ShipmentItemCollection
Tags
throws
LoaderException
Return values
array<string|int, mixed>

getScripts()

public getScripts([mixed $recoveryData = array() ]) : string
Parameters
$recoveryData : mixed = array()
Return values
string

getSettingsDialogContent()

public getSettingsDialogContent() : mixed

getTotalHtml()

public getTotalHtml([mixed $needRecalculate = true ]) : mixed
Parameters
$needRecalculate : mixed = true

getView()

public getView([mixed $index = 0 ]) : string
Parameters
$index : mixed = 0
Return values
string

getViewScript()

public getViewScript(mixed $index, mixed $visibleColumns) : mixed
Parameters
$index : mixed
$visibleColumns : mixed

loadVisibleColumns()

public static loadVisibleColumns(mixed $idPrefix) : mixed
Parameters
$idPrefix : mixed

modifyFromRequest()

public modifyFromRequest(mixed $data, mixed $request) : mixed
Parameters
$data : mixed
$request : mixed

prepareData()

public prepareData([array<string|int, mixed> $inParams = array() ]) : array<string|int, mixed>|null
Parameters
$inParams : array<string|int, mixed> = array()
Return values
array<string|int, mixed>|null

setSettingsShowPropsVisible()

public setSettingsShowPropsVisible(bool $isVisible) : void
Parameters
$isVisible : bool

updateData()

public static updateData(Order &$order, mixed &$shipment, mixed $shipmentBasket) : mixed
Parameters
$order : Order
$shipment : mixed
$shipmentBasket : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results