Overview

Namespaces

  • None
  • PHP

Classes

  • Eabi_DpdEE_Block_Adminhtml_Config_Form_Field_Country
  • Eabi_DpdEE_Block_Info_Payment
  • Eabi_DpdEE_Block_Invoice
  • Eabi_DpdEE_Block_Order_Courier
  • Eabi_DpdEE_Helper_Data
  • Eabi_DpdEE_Model_Api
  • Eabi_DpdEE_Model_Button_Courier
  • Eabi_DpdEE_Model_Config
  • Eabi_DpdEE_Model_Flat
  • Eabi_DpdEE_Model_Observer
  • Eabi_DpdEE_Model_Payment_Processor
  • Eabi_DpdEE_Model_Post
  • Eabi_DpdEE_Model_Source_Label_Position
  • Eabi_DpdEE_Model_Source_Service
  • Eabi_Livehandler_Adminhtml_LivehandlerController
  • Eabi_Livehandler_Adminhtml_RemoveController
  • Eabi_Livehandler_Block_Adminhtml_Config_Form_Field_Button
  • Eabi_Livehandler_Block_Adminhtml_Config_Form_Field_Remove
  • Eabi_Livehandler_Block_Email
  • Eabi_LiveHandler_Block_Footer
  • Eabi_Livehandler_Helper_Data
  • Eabi_Livehandler_Helper_Keypair
  • Eabi_Livehandler_IndexController
  • Eabi_Livehandler_Model_Abstract
  • Eabi_Livehandler_Model_Action_Abstract
  • Eabi_Livehandler_Model_Action_Postoffice_Print
  • Eabi_Livehandler_Model_Action_Postoffice_Send
  • Eabi_Livehandler_Model_Adminhtml_Gridmanager
  • Eabi_Livehandler_Model_Directory_Collection
  • Eabi_Livehandler_Model_Entry
  • Eabi_Livehandler_Model_File_Object
  • Eabi_Livehandler_Model_Mysql4_Entry
  • Eabi_Livehandler_Model_Mysql4_Entry_Collection
  • Eabi_Livehandler_Model_Ordergrid
  • Eabi_Livehandler_Model_System_Config_Backend_Button
  • Eabi_Postoffice_Adminhtml_PostofficeController
  • Eabi_Postoffice_Block_Adminhtml_Config_Form_Field_License
  • Eabi_Postoffice_Block_Adminhtml_Config_Form_Field_Remove
  • Eabi_Postoffice_Block_Config_Rebuildbutton
  • Eabi_Postoffice_Helper_Countrycode
  • Eabi_Postoffice_Helper_Data
  • Eabi_Postoffice_IndexController
  • Eabi_Postoffice_Model_Carrier_Abstract
  • Eabi_Postoffice_Model_Carrier_Result
  • Eabi_Postoffice_Model_Carriermodule
  • Eabi_Postoffice_Model_Mysql4_Carriermodule
  • Eabi_Postoffice_Model_Mysql4_Carriermodule_Collection
  • Eabi_Postoffice_Model_Mysql4_Office
  • Eabi_Postoffice_Model_Mysql4_Office_Collection
  • Eabi_Postoffice_Model_Observer
  • Eabi_Postoffice_Model_Office
  • Eabi_Postoffice_Model_Orderview
  • Eabi_Postoffice_Model_Source_Sendevent
  • Eabi_Postoffice_Model_Updater
  • Overview
  • Namespace
  • Class
  • Tree

No namespace

Classes summary
Eabi_DpdEE_Block_Adminhtml_Config_Form_Field_Country

Displays list of countries at the shipping modules configuration field.

Number of countries are unlimited and if more than one of the same country exist in the list, then last country declaration overrrides previous one.

Each country declaration contains following:

  • Base shipping price
  • Additional price for each Kilogram. (data is taken from products weight field)
  • Free shipping starts from price (Without VAT). Free shipping is disabled when this field is left empty.
  • Cash on Delivery fee. Cash on delivery is disabled, when field is left empty.
Eabi_DpdEE_Block_Info_Payment

Renders Cash on Delivery description text to order confirmation and e-mail templates

Description is only displayed when merchant sets description for DPD cash on delivery method

Eabi_DpdEE_Block_Invoice

Displays cash on delivery payment description under payment method selection when cash on delivery payment method is selected

Eabi_DpdEE_Block_Order_Courier

Renders HTML block which allows to call DPD courier to pick up shipment.

Template is located at eabi_dpdee/order/courier.phtml in adminhtml theme folder

Information that can be sent to courier:

  • Merchant can pick suitable date from available list when courier should come
  • Merchant can pick suitable time-range from available list for the selected date
  • Merchant can specify how many envelopes, parcels, pallets should be picked up
  • Merchant can leave comment for the courier
  • By default one checked order equals one parcel
Eabi_DpdEE_Helper_Data

Helper class for DPD shipping method related actions

Eabi_DpdEE_Model_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_DpdEE_Model_Button_Courier

Renders button at the Magento Administrators Sales Order Grid, which allows to call DPD courier.

Button is displayed when order shipping method is DPD and parcel data is sent to DPD server.

Eabi_DpdEE_Model_Config

Configuration variables proxy class

Eabi_DpdEE_Model_Flat

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.
  • Display tracking link to user when tracking code is added to the shipment.
  • Call courier to pick up the shipment that was ordered using this carrier.
  • Print out packing slip PDF from Order view.
Eabi_DpdEE_Model_Observer

Holds all Mage::dispatchEvent() actions

Eabi_DpdEE_Model_Payment_Processor

DPD Cash on delivery payment method

Displays optional description and additional cash on delivery fee when set.

Cash on delivery fee would be added on top of shipping price

Eabi_DpdEE_Model_Post

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.
  • Display tracking link to user when tracking code is added to the shipment.
  • Call courier to pick up the shipment that was ordered using this carrier.
  • Print out packing slip PDF from Order view.
Eabi_DpdEE_Model_Source_Label_Position

Source model of all possible DPD Packing slip label positions

Eabi_DpdEE_Model_Source_Service

Source model of all possible DPD API service codes

Eabi_Livehandler_Adminhtml_LivehandlerController

Handles the AJAX request defined for the backend (from database table eabi_livehandler)

Security model: If Page itself can be displayed, then it is allowed to run actions, which are bound to current Livehandler model. If user switches page, then current model actions cannot be run any more.

If user does not show any activity for Eabi_Livehandler_IndexController::ALLOWED time seconds, then actions cannot be run after timeout.

Eabi_Livehandler_Adminhtml_RemoveController

Removes old livehandler from app/local folder

Eabi_Livehandler_Block_Adminhtml_Config_Form_Field_Button

Renders list of available action buttons in Magento admin > System > Configuration > Eabi Livehandler > Admin Order Grid Helper configuration menu

Each button refers to subclass of Eabi_Livehandler_Model_Action_Abstract and contains following:

  • button_name - name of the button relative to eabi_livehandler/action_<button-name> or full magento model name
  • sort_order - buttons in the order info display are sorted ascending order
  • disabled - 0 means button is enabled, 1 means button is disabled
Eabi_Livehandler_Block_Adminhtml_Config_Form_Field_Remove

Renders button, which allows to delete old instance of Eabi_Livehandler from app/code/local folder in Magento admin > System > Configuration > Eabi Livehandler > Admin Order Grid Helper configuration menu, if such old instance exists

Use following system.xml struct to include this button:

<pre> <removal translate=""> <label></label> <frontend_model>eabi_postoffice/adminhtml_config_form_field_remove</frontend_model> <sort_order>1000001</sort_order> <show_in_default>1</show_in_default> <show_in_website>0</show_in_website> <show_in_store>0</show_in_store> </removal>
Eabi_Livehandler_Block_Email Description of Email
Eabi_LiveHandler_Block_Footer

Writes javascript before_body_end when request_var from eabi_livehandler table matches Magentos request full name.

Sets up listener for corresponding Magento model, which comes from model_class field.

Listener works only when matching javascript is rendered and user has not left the page.

On other cases this class does nothing

Eabi_Livehandler_Helper_Data

Handles saving and loading Magento's core_config_data values.

Can save and load PHP objects to core_config_data table.

Eabi_Livehandler_Helper_Keypair

Helper class for generating RSA public and private keys

Eabi_Livehandler_IndexController

Handles the AJAX request defined for the frontend (from database table eabi_livehandler)

Security model: If Page itself can be displayed, then it is allowed to run actions, which are bound to current Livehandler model. If user switches page, then current model actions cannot be run any more.

If user does not show any activity for Eabi_Livehandler_IndexController::ALLOWED time seconds, then actions cannot be run after timeout.

Eabi_Livehandler_Model_Abstract

Base implementing class for eabi_livehandler.model_class property

This class should fire response for the actual ajax request

Eabi_Livehandler_Model_Action_Abstract

Base class for action buttons, which are displayed at Magento Administrators Sales Order Grid.

Buttons are shown when clicking on 'Show Order Info' button.

Buttons can have onclick handler and desired action bound to it, when it is clicked.

Eabi_Livehandler_Model_Action_Postoffice_Print

Renders button at the Magento Administrators Sales Order Grid, which allows to print packing slip from remote server for carriers which support this feature.

Button is displayed when order shipping method supports remote packing slip printing and parcel data is sent.

Does nothing when Eabi_Postoffice module is not installed

Eabi_Livehandler_Model_Action_Postoffice_Send

Renders button at the Magento Administrators Sales Order Grid, which allows to send parcel data to remote server for carriers which support this feature.

Button is displayed when order shipping method supports automatic parcel data sending and parcel data is not already sent.

Does nothing when Eabi_Postoffice module is not installed

Eabi_Livehandler_Model_Adminhtml_Gridmanager

Base class for operating in Magento admin Grids

Eabi_Livehandler_Model_Directory_Collection

Replaces Varien_Directory_Collection for PHP5.3+ compatibility

Eabi_Livehandler_Model_Entry

Represents one entry of eabi_livehandler database table.

Performs following:

  • Render javascript before_body_end part of the page, when Magento request variables match
  • Generates unique URL, where sending data to causes to fire service() function on the model_class instance.
  • Works only when javascript at the bottom of the page is rendered. Which means if you see this page you can fire the action.

Structure:

  • id - unique auto incement id
  • name - Human readable description
  • is_enabled - 1 means action is enabled, 0 means action is disabled
  • is_admin - 1 means action is admin only, 0 means action is public only
  • request_var - Magento request var name, which current action must match. Example: adminhtml/sales_order/index - Magentos Sales Order Grid
  • store_id - id of the store this action should run in
  • website_id - if of the website this action should run in
  • model_class - full Magento model name for the implementing class. Must be instance of Eabi_Livehandler_Model_Abstract
  • created_time - when was this database entry created
  • update_time - when was this database entry updated
  • cached_attributes - not in use, could be used to store data in serialized form
  • parameters - not in use, could be used to store data in serialized form
  • css - used to declare extra css rules, those can also be declared by implementing class. Will be injected to before_body_end as style tag.
  • js - used to display extra javascript, those can be also be declared by implementing class. Will be injetected before_body_end in script[type=javascript] tag
  • html - used to display extra HTML, those can be also be declared by implementing class. Will be injetected before_body_end
Eabi_Livehandler_Model_File_Object

Replaces Varien_File_Object for PHP5.3+ compatibility

Eabi_Livehandler_Model_Mysql4_Entry

Represents one line from eabi_livehandler database table

Eabi_Livehandler_Model_Mysql4_Entry_Collection

Represents collection of eabi_livehandler database table entries

Eabi_Livehandler_Model_Ordergrid

Adds extra button to each row of Magento Adminhtml Sales Order grid called 'Show order info'

Clicking on this button shows almost full information about the order and orders can be switched with press of up-down-left-right arrows.

Order view is synchronized with massaction checkboxes and Merchant can individually check/uncheck orders in this view.

Extra buttons can be added to order view using Eabi_Livehandler_Model_Action_Abstract interface which allow faster order processing than default Magento offers.

Eabi_Livehandler_Model_System_Config_Backend_Button

Represents backend for the Eabi_Livehandler_Block_Adminhtml_Config_Form_Field_Button

Eabi_Postoffice_Adminhtml_PostofficeController
Eabi_Postoffice_Block_Adminhtml_Config_Form_Field_License

Renders yes/no select box with licensing information

Eabi_Postoffice_Block_Adminhtml_Config_Form_Field_Remove

Renders button, which allows to delete old instance of Eabi_Postoffice from app/code/local folder in Magento admin > System > Configuration > Shipping Methods > DPD - pakivedu.ee configuration menu, if such old instance exists

Eabi_Postoffice_Block_Config_Rebuildbutton

Renders the button under the Magento Configuration panel.

Purpose of this button is to invoke the procedure, which rebuilds the list of Postoffices/Parcel terminals which are directly related to this carrier.

This button is only intended to use in the Magento -> System -> Configuration -> Shipping methods section and the carrier, that is using this button in the configuration panel should extend Eabi_Postoffice_Model_Carrier_Abstract class.

Eabi_Postoffice_Helper_Countrycode Helper class of getting Country Phone dial codes.
Eabi_Postoffice_Helper_Data Helper class for dealing with situation, when Carrier provider needs some shipment data to be sent to Carrier providers server.
Eabi_Postoffice_IndexController

Displays list of available parcel terminals for current carrier and address if carrier supports parcel terminals feature

Eabi_Postoffice_Model_Carrier_Abstract

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
  • Monitors if shipment parcel data is sent to remote server
  • Offers PDF packing slip printing function, if subclasses implement actual fetch procedure.
  • Offers auto update functionality for parcel terminals if subclasses implement actual parcel terminal fetch procedure
  • Offers cash on delivery functionality with help of extra plugins.
  • Offers clickable tracking url or iframe functionality from Magento
Eabi_Postoffice_Model_Carrier_Result This class is required in order to avoid sorting by the price, which is default behaviour for Magento, when sorting shipping methods for single carrier.
Eabi_Postoffice_Model_Carriermodule
Eabi_Postoffice_Model_Mysql4_Carriermodule
Eabi_Postoffice_Model_Mysql4_Carriermodule_Collection

Represents collection of eabi_carriermodule database entries

Eabi_Postoffice_Model_Mysql4_Office
Eabi_Postoffice_Model_Mysql4_Office_Collection

Represents collection of eabi_postoffice database table entries

Eabi_Postoffice_Model_Observer Description of Observer
Eabi_Postoffice_Model_Office

Represents one entry from eabi_postoffice table.

Represents one parcel terminal, which can be selected as preferred shipping location for end user.

Structure:

  • id - unique auto incement id for entry
  • remote_module_id - refers to eabi_carriermodule.id
  • remote_module_name - Magento carrier code, also refers to eabi_carriermodule.carrier_code
  • remote_place_id - Parcel terminal numeric ID, which is provided by remote server.
  • remote_servicing_place_id - not used
  • name - human readable remote parcel terminal short name
  • city - city where remote parcel terminal is located (optional)
  • county - region or county where remote parcel terminal is located (optional)
  • zip_code - zip code for the remote parcel terminal (optional)
  • country - ISO-3166 country code for the remote parcel terminal
  • description - Extra human readable information can be entered here like address, opening times, etc...
  • group_id - unique id that represents city/county combination group. Module auto generates this id for you.
  • group_name - merged city/county if any of those is set. Otherwise left empty
  • group_sort - higher the number, the more important group is and thus parcel terminal belonging to more important group is displayed before the others.
  • local_carrier_id - not used
  • created_time - time, when this parcel terminal entry was created
  • update_time - time, when this parcel terminal was last updated
  • cached_attributes - not used, but can store data in serialized form
Eabi_Postoffice_Model_Orderview

Creates the extra buttons in the sales/order/view in admin.

Added buttons are:

  • Send parcel data to server - if automatic data sending is available for the selected order and data has not been already sent
  • Print packing slip - If automatic data has been sent and packing slip print functionality is available.
Eabi_Postoffice_Model_Source_Sendevent

Represents possible moments for automatic data sending.

Eabi_Postoffice_Model_Updater
DPD Eesti - Pakivedu.ee Shipping module for Magento API documentation generated by ApiGen 2.8.0