Class ShipcloudController

HttpViewController implements HttpViewControllerInterface

AdminHttpViewController implements AdminStatusOnlyInterface

ShipcloudController

Package: HttpViewControllers
Located at Controllers/HttpView/Admin/ShipcloudController.inc.php

Methods summary

`public`	# `__construct( HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $contentView )` Parameters `$httpContextReader` `$httpResponseProcessor` `$contentView` $defaultContentView Overrides `HttpViewController::__construct`
`protected`	# `isConfigured( )` determines if Shipcloud is configured and ready to use determines if Shipcloud is configured and ready to use
`public`	# `proceed( HttpContextInterface $httpContext )` Override "proceed" method of parent and use it for initialization. Override "proceed" method of parent and use it for initialization. This method must call the parent "proceed" in order to work properly. Parameters `$httpContext` Throws LogicException When no action method is found by the http context reader. Overrides `HttpViewController::proceed`
`public HttpControllerResponseInterface`	# `actionDefault( )` Run the actionDefault method. Run the actionDefault method. Returns `HttpControllerResponseInterface` Overrides `HttpViewController::actionDefault`
`protected array`	# `splitStreet( string $street_address )` Heuristically splits up a street address into its component street name and house number Heuristically splits up a street address into its component street name and house number Parameters `$street_address` Returns array with keys 'street' and 'house_no'
`protected float`	# `getDeclaredValue( integer $orders_id )` retrieves an order's total retrieves an order's total Parameters `$orders_id` the order's id Returns float Todo get this data from OrderService
`public HttpControllerResponse`	# `actionCreateLabelForm( )` Shows a form for entering data for a label Shows a form for entering data for a label Returns `HttpControllerResponse`
`protected KeyValueCollection`	# `_prepareSingleFormDataForShipmentRequest( array $postDataArray, boolean $anon_from = false, string $language_code = null )` Uses POST data from the form returned by actionCreateLabelForm() to populate a KeyValueCollection to be fed to the ShipmentFactory Uses POST data from the form returned by actionCreateLabelForm() to populate a KeyValueCollection to be fed to the ShipmentFactory Parameters `$postDataArray` `$anon_from` used for shipment quote requests `$language_code` ISO2 language code used for advance notices (e.g. DPD Predict) Returns `KeyValueCollection`
`protected string`	# `getOrderLanguageCode( integer $orders_id )` Looks up the language for a given order and returns the 2-letter ISO code Looks up the language for a given order and returns the 2-letter ISO code Parameters `$orders_id` Returns string ISO2 language code
`public JsonHttpControllerResponse`	# `actionCreateLabelFormSubmit( )` Processes form submit for forms created by actionCreateLabelForm() Processes form submit for forms created by actionCreateLabelForm() Returns `JsonHttpControllerResponse`
`public JsonHttpControllerResponse`	# `actionGetShipmentQuote( )` Uses form data (cf. actionCreateLabelForm()) to retrieve a shipment quote Uses form data (cf. actionCreateLabelForm()) to retrieve a shipment quote Returns `JsonHttpControllerResponse`
`public JsonHttpControllerResponse`	# `actionGetMultiShipmentQuote( )` Retrieves shipment quotes (bulk retrieval) Retrieves shipment quotes (bulk retrieval) Returns `JsonHttpControllerResponse`
`public HttpControllerResponse`	# `actionUnconfiguredNote( )` Returns message to be displayed to users if the Shipcloud interface is still unconfigured Returns message to be displayed to users if the Shipcloud interface is still unconfigured Returns `HttpControllerResponse`
`public HttpControllerResponse`	# `actionLoadLabelList( )` Outputs a list of labels for an order identified by its orders_id via the corresponding GET parameter Outputs a list of labels for an order identified by its orders_id via the corresponding GET parameter Returns `HttpControllerResponse`
`public`	# `actionDeleteShipment( )` Deletes a shipment label Deletes a shipment label
`public JsonHttpControllerResponse`	# `actionPickupShipments( )` Requests pickups for a given list of shipments from each of the carriers involved Requests pickups for a given list of shipments from each of the carriers involved Returns `JsonHttpControllerResponse`
`public HttpControllerResponse`	# `actionLoadMultiLabelList( )` Retrieves list of labels for a set of orders listed in POST[orders_ids]. Retrieves list of labels for a set of orders listed in POST[orders_ids]. Returns `HttpControllerResponse`
`public HttpControllerResponse`	# `actionCreateMultiLabelForm( )` Shows form for bulk label retrieval Shows form for bulk label retrieval Returns `HttpControllerResponse`
`protected`	# `_getShippingWeight( $orders_id )` computes total weight of products for an order computes total weight of products for an order
`public JsonHttpControllerResponse`	# `actionCreateMultiLabelFormSubmit( )` Processes form data from form returned by actionCreateMultiLabelForm(). Processes form data from form returned by actionCreateMultiLabelForm(). Returns `JsonHttpControllerResponse`
`protected array`	# `_enforceLengthLimits( string $carrier, array $toArray )` modifies an array containing a delivery address to suit carrier-specific field lengths modifies an array containing a delivery address to suit carrier-specific field lengths Currently returns $toArray unchanged. Future operation tbd. Parameters `$carrier` `$toArray` delivery address Returns array

Methods inherited from AdminHttpViewController

validateCurrentAdminStatus()

Methods inherited from HttpViewController

_callActionMethod(), _getPostData(), _getPostDataCollection(), _getQueryParameter(), _getQueryParametersCollection(), _render(), _validatePageToken()

Properties summary

`protected ShipcloudText`	`$shipcloudText` wrapper for text phrases wrapper for text phrases	#
`protected ShipcloudConfigurationStorage`	`$shipcloudConfigurationStorage` configuration storage configuration storage	#
`protected ShipcloudLogger`	`$shipcloudLogger` logger logger	#

Properties inherited from HttpViewController

$assets, $contentView, $httpContextReader, $httpResponseProcessor, $postDataArray, $queryParametersArray

Packages

Classes

Class ShipcloudController

Methods summary

Parameters

Overrides

Parameters

Throws

Overrides

Returns

Overrides

Parameters

Returns

Parameters

Returns

Todo

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Methods inherited from AdminHttpViewController

Methods inherited from HttpViewController

Properties summary

Properties inherited from HttpViewController