Класс HandlerBase

Открытые члены
	__construct (Delivery\Services\Base $deliveryService)
	create (array $shipmentIds, array $additional=[])
	getActions ($requestId)
	getCancelActionCode ()
	getCancelActionName ()
	getShipmentActions (Shipment $shipment)
	executeAction ($requestId, $actionType, array $additional)
	executeShipmentAction ($requestId, $shipmentId, $actionType, array $additional)
	addShipments ($requestId, $shipmentIds, array $additional=[])
	delete ($requestId)
	deleteShipments ($requestId, array $shipmentIds=[])
	updateShipments ($requestId, array $shipmentIds=[])
	getFormFields ($formFieldsType, array $shipmentIds, array $additional=[])
	getContent ($requestId)
	getShipmentContent ($requestId, $shipmentId)
	getHandlingDeliveryServiceId ()
	hasCallbackTrackingSupport ()

Открытые атрибуты
const	CANCEL_ACTION_CODE = 'CANCEL'

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

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

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

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

__construct()

__construct

(

Delivery\Services\Base

$deliveryService

)

Base constructor.

Аргументы

Delivery\Services\Base

$deliveryService

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

Методы

addShipments()

addShipments	(		$requestId,
			$shipmentIds,
		array	$additional = [] )

Add shipments to delivery request

Аргументы

int	$requestId
int[]	$shipmentIds
array	$additional

Возвращает

Result

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

create()

create	(	array	$shipmentIds,
		array	$additional = [] )

Creates delivery request.

Аргументы

int[]	$shipmentIds
array	$additional

Возвращает

Result

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

delete()

delete

(

$requestId

)

Delete delivery request

Аргументы

int

$requestId

Возвращает

Result

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

deleteShipments()

deleteShipments	(		$requestId,
		array	$shipmentIds = [] )

Delete shipment from delivery request

Аргументы

int	$requestId
int[]	$shipmentIds

Возвращает

Result

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

executeAction()

executeAction	(		$requestId,
			$actionType,
		array	$additional )

Executes delivery request action

Аргументы

int	$requestId
string	$actionType
array	$additional

Возвращает

Result

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

executeShipmentAction()

executeShipmentAction	(		$requestId,
			$shipmentId,
			$actionType,
		array	$additional )

Executes action for shipment from delivery request

Аргументы

int	$requestId
int	$shipmentId
string	$actionType
array	$additional

Возвращает

Result

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

getActions()

getActions

(

$requestId

)

Аргументы

int | null

$requestId

Возвращает

array Actions list. For example array( 'ACTION1' => 'ACTION1_NAME', 'ACTION2' => 'ACTION2_NAME').

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

getCancelActionCode()

getCancelActionCode

(

)

Возвращает

string

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

getCancelActionName()

getCancelActionName

(

)

Возвращает

string

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

getContent()

getContent

(

$requestId

)

Returns content of delivery request

Аргументы

int

$requestId

Возвращает

Result

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

getFormFields()

getFormFields	(		$formFieldsType,
		array	$shipmentIds,
		array	$additional = [] )

Returns array of fields if we need some additional information during creation, or action execution, etc.

Аргументы

string	$formFieldsType	(FORM_FIELDS_TYPE_CREATE | FORM_FIELDS_TYPE_ADD | FORM_FIELDS_TYPE_ACTION)
int[]	$shipmentIds
array	$additional

Возвращает

array

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

getHandlingDeliveryServiceId()

getHandlingDeliveryServiceId

(

)

Returns id of delivery service witch actually handles delivery requests

Возвращает

int

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

getShipmentActions()

getShipmentActions

(

Shipment

$shipment

)

Аргументы

Shipment

$shipment

Возвращает

array Actions list For example array( 'ACTION1' => 'ACTION1_NAME', 'ACTION2' => 'ACTION2_NAME').

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

getShipmentContent()

getShipmentContent	(		$requestId,
			$shipmentId )

Returns content of shipment from delivery request

Аргументы

int	$requestId
int	$shipmentId

Возвращает

Result. Data contain array of shipment fields on delivery side

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

hasCallbackTrackingSupport()

hasCallbackTrackingSupport

(

)

Возвращает

bool

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

updateShipments()

updateShipments	(		$requestId,
		array	$shipmentIds = [] )

Update shipment from delivery request

Аргументы

int	$requestId
int[]	$shipmentIds

Возвращает

Result

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

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

$deliveryService

$deliveryService

protected

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

CANCEL_ACTION_CODE

const CANCEL_ACTION_CODE = 'CANCEL'

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