Overview

Namespaces

  • None
  • PHP

Classes

  • eabi_dpd_courier
  • Eabi_dpd_courierCourierModuleFrontController
  • eabi_dpd_parcelstore
  • eabi_dpd_parcelstore_data_send_executor
  • eabi_dpd_parcelstore_dpd_api
  • eabi_dpd_parcelstore_dpd_helper
  • eabi_dpd_parcelstore_html_helper
  • eabi_dpd_parcelstore_validator_helper
  • Eabi_dpd_parcelstoreCourierModuleFrontController
  • Eabi_Postoffice
  • eabi_postoffice_dialcode_helper
  • Eabi_PostofficePostofficeModuleFrontController
  • Overview
  • Namespace
  • Class
  • Tree

No namespace

Classes summary
eabi_dpd_courier

Represents DPD courier shipping method.

Extra order data is stored under specialized order comment

Can perform following business actions:

  • Calculate shipping price based on country and weight
  • Send information about shipment data to DPD server.
  • Call courier to pick up the shipment that was ordered using this carrier.
Eabi_dpd_courierCourierModuleFrontController

This class is called when DPD courier is called and eabi_dpd_parcelstore module is at the disabled state.

eabi_dpd_parcelstore

Represents DPD parcel terminal shipping method.

Extra order data is stored under specialized order comment

Can perform following business actions:

  • Calculate shipping price based on country and weight
  • Display list of user selectable parcel terminals, which is auto updated.
  • Send information about shipment data to DPD server.
  • Call courier to pick up the shipment that was ordered using this carrier.
eabi_dpd_parcelstore_data_send_executor

Handles automatic data sending functions between PrestaShop order and DPD api

Performs following:

  • Adds extra fields to current shipping method configuration with appropriate validator rules.
  • Sends data to DPD parcel terminal (op=order)
  • Fetches PDF packing slip for the carrier
eabi_dpd_parcelstore_dpd_api

Wrapper class for communicating with DPD API

Each request is prefilled with username, password, return address data whenever possible.

Each response is json_decoded to assoc array and Exception is thrown when response error code is else than integer 0

eabi_dpd_parcelstore_dpd_helper

Helper class for DPD shipping method related actions

getLocaleToTerritory originates from Zend Framework since PrestaShop does not support proper locales and PHP itself does not too.

eabi_dpd_parcelstore_html_helper

Allows to create label and input combinations by <span class="php-var">$_html_template</span> where each get*Html function creates exactly one input row.

each get*Html function takes following arguments:

  • <span class="php-var">$fieldName</span> - name attribute for designated input element
  • <span class="php-var">$fieldData</span> - assoc array containing data how to build the input element
  • <span class="php-var">$value</span> - if this field needs to set a value, then supply it here. Multiselects accept comma separated string values

<span class="php-var">$fieldData</span> is in following format:

  • <pre> 'title' => label attribute for the form element, 'type' => text,textarea,select,multiselect,password are allowed field types. 'description' => if this field is filled, then it is displayed next to input, 'default' => default value for the current field, 'css' => form field elements style attribute, 'validate-if' => validation can be invoked based on conditions defined in assoc array('form-field-name' => 'expected-value', 'another-form-field-name' => 'another-value'), which are processed as validate-if-any is true. 'validate' => array of validation routine names, 'options' => assoc array of select,multiselect options,
eabi_dpd_parcelstore_validator_helper

Each validation function returns true or string to be translated with error message.

Arguments:

  • <span class="php-var">$field_name</span> - field name that needs to be validated from <span class="php-var">$data</span> POST array
  • <span class="php-var">$data</span> - Possibly $_POST of $_REQUEST, where data to be validated is looked up
  • <span class="php-var">$validateIfs</span> - assoc array of rules, when this validation should be triggered
  • <span class="php-var">$formFieldData</span> - information how to render the form element.
Eabi_dpd_parcelstoreCourierModuleFrontController

Handles Order DPD courier to pickup goods commands when DPD parcelstore is enabled.

This controller is included in the front, because PrestaShop does not support backend URLs for the modules without creating menu item for it first.

It is only checked that user would be at least logged in the admin.

Eabi_Postoffice

Base class for carriers, which ask customer to pick parcel terminal of choice from dropdown list.

Offers following business functions:

  • Chosen parcel terminal is forwarded to the Merchant
  • Offers auto update functionality for parcel terminals if subclasses implement actual parcel terminal fetch procedure
eabi_postoffice_dialcode_helper Description of dialcode_helper
Eabi_PostofficePostofficeModuleFrontController Description of postoffice
API documentation generated by ApiGen 2.8.0