Bitrix API

Manager

Table of Contents

Constants

RIGHTS_ADMIN_IDX  = 0
RIGHTS_CLIENT_IDX  = 2
RIGHTS_MANAGER_IDX  = 1
STORE_PICKUP_CLASS  = '\Bitrix\Sale\Delivery\ExtraServices\Store'
STORE_PICKUP_CODE  = 'BITRIX_STORE_PICKUP'

Methods

__construct()  : mixed
Manager constructor.
addItem()  : bool
deleteStores()  : Result
getAdminParamsControl()  : string
getClassesList()  : array<string|int, mixed>
getExtraServicesList()  : array<string|int, mixed>
getItem()  : Base|null
getItemByCode()  : Base|null
getItems()  : array<string|int, Base>
getObjectsForShipment()  : array<string|int, Base>
getStoreIdForShipment()  : int
getStoresFields()  : array<string|int, mixed>
getStoresList()  : array<string|int, mixed>
getTotalCost()  : float
getTotalCostShipment()  : float
getValuesForShipment()  : array<string|int, mixed>
initClassesList()  : bool|null
isClone()  : bool
prepareParamsToSave()  : mixed
Prepares fields for saving
saveStoreIdForShipment()  : Result
saveStores()  : Result
saveValuesForShipment()  : Result
setOperationCurrency()  : mixed
setStoresUnActive()  : Result
setValues()  : mixed

Constants

RIGHTS_ADMIN_IDX

public mixed RIGHTS_ADMIN_IDX = 0

RIGHTS_CLIENT_IDX

public mixed RIGHTS_CLIENT_IDX = 2

RIGHTS_MANAGER_IDX

public mixed RIGHTS_MANAGER_IDX = 1

STORE_PICKUP_CLASS

public mixed STORE_PICKUP_CLASS = '\Bitrix\Sale\Delivery\ExtraServices\Store'

STORE_PICKUP_CODE

public mixed STORE_PICKUP_CODE = 'BITRIX_STORE_PICKUP'

Methods

__construct()

Manager constructor.

public __construct(array<string|int, mixed>|int $initParam[, string $currency = "" ][, array<string|int, mixed> $values = array() ][, array<string|int, mixed> $additionalParams = array() ]) : mixed
Parameters
$initParam : array<string|int, mixed>|int
$currency : string = ""
$values : array<string|int, mixed> = array()
$additionalParams : array<string|int, mixed> = array()

addItem()

public addItem(array<string|int, mixed> $params, string $currency[, mixed $value = null ][, array<string|int, mixed> $additionalParams = array() ]) : bool
Parameters
$params : array<string|int, mixed>
$currency : string
$value : mixed = null
$additionalParams : array<string|int, mixed> = array()
Tags
throws
ArgumentNullException
throws
SystemException
Return values
bool

deleteStores()

public static deleteStores(int $deliveryId) : Result
Parameters
$deliveryId : int
Tags
throws
Exception
Return values
Result

getAdminParamsControl()

public static getAdminParamsControl(string $className, string $name, array<string|int, mixed> $params) : string
Parameters
$className : string
$name : string
$params : array<string|int, mixed>
Tags
throws
ArgumentNullException
throws
SystemException
Return values
string —

Html for extra service administration

getClassesList()

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

Classes list

getExtraServicesList()

public static getExtraServicesList(int $deliveryId[, bool $stores = false ]) : array<string|int, mixed>
Parameters
$deliveryId : int
$stores : bool = false
Tags
throws
SystemException
Return values
array<string|int, mixed>

getItem()

public getItem(int $id) : Base|null
Parameters
$id : int
Return values
Base|null

getItemByCode()

public getItemByCode(mixed $code) : Base|null
Parameters
$code : mixed
Return values
Base|null

getItems()

public getItems() : array<string|int, Base>
Return values
array<string|int, Base>

getObjectsForShipment()

public static getObjectsForShipment(int $shipmentId, int $deliveryId, string $currency) : array<string|int, Base>
Parameters
$shipmentId : int
$deliveryId : int
$currency : string
Tags
throws
SystemException
Return values
array<string|int, Base>

getStoreIdForShipment()

public static getStoreIdForShipment(int $shipmentId, int $deliveryId) : int
Parameters
$shipmentId : int
$deliveryId : int
Return values
int

getStoresFields()

public static getStoresFields(int $deliveryId[, bool $onlyActive = true ]) : array<string|int, mixed>
Parameters
$deliveryId : int
$onlyActive : bool = true
Return values
array<string|int, mixed>

getStoresList()

public static getStoresList(int $deliveryId) : array<string|int, mixed>
Parameters
$deliveryId : int
Return values
array<string|int, mixed>

getTotalCost()

public getTotalCost() : float
Tags
use

\Bitrix\Sale\Delivery\ExtraServices\Manager::getTotalCostShipment()

Return values
float —

total cost

getTotalCostShipment()

public getTotalCostShipment([Shipment|null $shipment = null ]) : float
Parameters
$shipment : Shipment|null = null
Return values
float

getValuesForShipment()

public static getValuesForShipment(int $shipmentId, int $deliveryId) : array<string|int, mixed>
Parameters
$shipmentId : int
$deliveryId : int
Return values
array<string|int, mixed>

initClassesList()

public static initClassesList() : bool|null
Tags
throws
SystemException
throws
LoaderException
Return values
bool|null

isClone()

public isClone() : bool
Return values
bool

prepareParamsToSave()

Prepares fields for saving

public static prepareParamsToSave(mixed $params) : mixed
Parameters
$params : mixed

saveStoreIdForShipment()

public static saveStoreIdForShipment(int $shipmentId, int $deliveryId, int $storeId) : Result
Parameters
$shipmentId : int
$deliveryId : int
$storeId : int
Tags
throws
ArgumentNullException
throws
ArgumentException
throws
Exception
Return values
Result

saveStores()

public static saveStores(int $deliveryId, array<string|int, mixed> $storesList) : Result
Parameters
$deliveryId : int
$storesList : array<string|int, mixed>
Tags
throws
Exception
Return values
Result

saveValuesForShipment()

public static saveValuesForShipment(int $shipmentId, array<string|int, mixed> $extraServices) : Result
Parameters
$shipmentId : int
$extraServices : array<string|int, mixed>
Tags
throws
ArgumentNullException
throws
ArgumentException
throws
Exception
Return values
Result

setOperationCurrency()

public setOperationCurrency(string $currency) : mixed
Parameters
$currency : string

setStoresUnActive()

public static setStoresUnActive(int $deliveryId) : Result
Parameters
$deliveryId : int
Tags
throws
Exception
Return values
Result

setValues()

public setValues([array<string|int, mixed> $values = array() ]) : mixed
Parameters
$values : array<string|int, mixed> = array() 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results