Class 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

Mage_Shipping_Model_Carrier_Abstract

Eabi_Postoffice_Model_Carrier_Abstract

Direct known subclasses

Eabi_DpdEE_Model_Post

Indirect known subclasses

Eabi_DpdEE_Model_Flat

Abstract
Author: matishalmann
Located at Eabi/Postoffice/Model/Carrier/Abstract.php

Methods summary
`abstract public array`	# `getOfficeList( )` This method should be implemented in subclasses of this carrier. Purpose of this method is to return array of Postoffices/Parcel terminals associated to this carrier. This method is called automatically by Magento's cron and the update frequency is regulated by the carriers configuration data of `update_interval` which is expressed in minutes. Usually the carriers are fetched from some remote location and sometimes the fetching may fail, in this case this method should return boolean false in order to avoid Postoffice list being empty. This method should be implemented in subclasses of this carrier. Purpose of this method is to return array of Postoffices/Parcel terminals associated to this carrier. This method is called automatically by Magento's cron and the update frequency is regulated by the carriers configuration data of `update_interval` which is expressed in minutes. Usually the carriers are fetched from some remote location and sometimes the fetching may fail, in this case this method should return boolean false in order to avoid Postoffice list being empty. Each element contained in this array should have the following structure: <code> array( 'place_id' => (int)unique remote id for this office (Mandatory), 'name' => Unique name for this office (Mandatory), 'city' => City where this office is located, 'county' => County where this office is located, 'description' => Description where this office is located, 'country' => Country ID where this office is located format: EN, EE, FI, 'zip' => Zip code for this office, 'group_sort' => higher number places group higher in the parcel terminal list, defaults to 0, ); </code> You can also supply `group_sort` parameter, if you have it. Offices which have greater group_sort parameter are displayed before other postoffices. Alternatively you can write your own group_sort generator function by overwriting the getGroupSort(group_name) method which should return integer value. It is advised to supply at least city or county parameter, because first select menu will be created from group_name parameters and group_name parameter is basically: county_name/city_name Returns `array` of postoffices, where each element is assoc array with described structure.
`public integer`	# `getGroupSort( string $group_name )` If you would like to display certain counties or cities before the others, then you can overwrite this function. This function should return positive integer. The greater the number returned means this county/city is more important than the others and should be displayed before the others. In general postoffices will be displayed according to the following rules: group_sort descending group_name ascending name ascending This function is called only when getOfficeList function does not supply group_sort parameter If you would like to display certain counties or cities before the others, then you can overwrite this function. This function should return positive integer. The greater the number returned means this county/city is more important than the others and should be displayed before the others. In general postoffices will be displayed according to the following rules: group_sort descending group_name ascending name ascending This function is called only when getOfficeList function does not supply group_sort parameter Parameters `$group_name` `string` $group_name county/city or county or city Returns `integer` greater value, means this office belongs to more important group.
`protected boolean`	# `_isAvailable( Mage_Shipping_Model_Rate_Request $request )` This function is called right after: This carrier is active Cart's max weight does not exceed the limit Cart's min weight is not below the limit If this function returns false, then this carrier is not available. This function is called right after: This carrier is active Cart's max weight does not exceed the limit Cart's min weight is not below the limit If this function returns false, then this carrier is not available. Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `boolean` false, if this carrier should not be available.
`public boolean`	# `isTrackingAvailable( )` If carrier supports external tracking URL's then it should return true If carrier supports external tracking URL's then it should return true Returns `boolean`
`public boolean\|string`	# `getTrackingUrl( )` Returns tracking URL for current carrier if one exists. Returns tracking URL for current carrier if one exists. Returns `boolean\|string`
`public boolean`	# `getTrackingInIframe( )` When set to true and $_tracking_url is provided, then instead of clickable link iframe is displayed instead. When set to true and $_tracking_url is provided, then instead of clickable link iframe is displayed instead. Returns `boolean`
`public Varien_Object\|null`	# `getTrackingInfo( string $number )` Attempts to display tracking link or tracking iframe if tracking is supported by the carrier and tracking url is available. Attempts to display tracking link or tracking iframe if tracking is supported by the carrier and tracking url is available. Parameters `$number` `string` $number tracking number Returns `Varien_Object\|null`
`protected boolean`	# `_isMultishipping( Mage_Shipping_Model_Rate_Request $request )` Returns true if this Mage_Shipping_Model_Rate_Request is multishipping. Returns true if this Mage_Shipping_Model_Rate_Request is multishipping. Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `boolean`
`final public boolean\|Eabi_Postoffice_Model_Carrier_Result`	# `collectRates( Mage_Shipping_Model_Rate_Request $request )` use `_isAvailable()` function to determine if the carrier is available. use `_calculateAdditionalShippingPrice` function to calculate any additional shipping cost. use `_isAvailable()` function to determine if the carrier is available. use `_calculateAdditionalShippingPrice` function to calculate any additional shipping cost. Checks for the following conditions: This carrier is active Cart's max weight does not exceed the limit Cart's min weight is not below the limit Calculates the shipping price based on the following: Configurations like `enable_free_shipping`,`free_shipping_from` are enabled or disabled Configuration like `handling_fee` which is the base shipping price. Configuration like `handling_action` which determines whether the shipping price is based on per order or per item If shopping cart rules specify free shipping. Price found from the conditions above will be passed as second parameter to the function `_calculateAdditionalShippingPrice` which in turn can alter the shipping price further. Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `boolean\|Eabi_Postoffice_Model_Carrier_Result` false, if carrier is not available.
`public boolean`	# `isCodEnabled( Mage_Customer_Model_Address $address )` Returns true if cash on delivery is specified for target address Returns true if cash on delivery is specified for target address Parameters `$address` `Mage_Customer_Model_Address` $address Returns `boolean`
`protected float\|integer`	# `_applyPriceFromCod( Mage_Shipping_Model_Rate_Request $request )` Applies extra price from Cash on Delivery, which is added on top of shipping price Applies extra price from Cash on Delivery, which is added on top of shipping price Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `float\|integer`
`final public boolean`	# `isAjaxInsertAllowed( integer $addressId )` Security related, used to prevent customer to enter arbitrary data as their shipping carrier. Security related, used to prevent customer to enter arbitrary data as their shipping carrier. Parameters `$addressId` `integer` $addressId Returns `boolean`
`protected float`	# `_calculateAdditionalShippingPrice( Mage_Shipping_Model_Rate_Request $request, float $price )` This function is called right after the initial price calculation by the </code>collectRates</code> has been called. Overwrite this function if you want to apply more complicated price calculation rules, than </code>collectRates</code> function offers. This function is called right after the initial price calculation by the </code>collectRates</code> has been called. Overwrite this function if you want to apply more complicated price calculation rules, than </code>collectRates</code> function offers. Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request `$price` `float` $price pre-calculated price by the </code>collectRates</code> function. Returns `float` new price, this carrier should have.
`protected array`	# `getOfficesFromAddress( Mage_Shipping_Model_Rate_Request $request )` Overwrite this function in your subclass if you would like to offer automatic postoffice selection based on the user entered address. Overwrite this function in your subclass if you would like to offer automatic postoffice selection based on the user entered address. ["dest_country_id"] => string(2) "EE" ["dest_region_id"] => string(3) "345" ["dest_region_code"] => string(5) "EE-57" ["dest_street"] => string(11) "mina ei tea" ["dest_city"] => string(7) "tallinn" ["dest_postcode"] => string(5) "12345" ["package_value"] => float(16.33) ["package_value_with_discount"] => float(16.33) ["package_weight"] => float(16.16) ["package_qty"] => int(2) ["package_physical_value"] => float(16.33) ["free_method_weight"] => float(16.16) ["store_id"] => string(1) "2" ["website_id"] => string(1) "1" ["free_shipping"] => int(0) ["base_currency (Mage_Directory_Model_Currency)"] => array(1) { ["currency_code"] => string(3) "EUR" } ["package_currency (Mage_Directory_Model_Currency)"] => array(1) { ["currency_code"] => string(3) "EUR" } ["country_id"] => string(2) "EE" ["region_id"] => string(1) "0" ["city"] => string(0) "" ["postcode"] => string(0) "" Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `array` of 'eabi_postoffice/office' models belonging to this carrier.
`public boolean\|array`	# `getGroups( integer $addressId = null )` Returns distinct group_name,group_id,group_sort as Eabi_Postoffice_Model_Mysql4_Office_Collection of 'eabi_postoffice/office' models Result of this function is used to render the first select menu (county/city) for this carrier. If no groups can be found, then this function returns boolean false. Returns distinct group_name,group_id,group_sort as Eabi_Postoffice_Model_Mysql4_Office_Collection of 'eabi_postoffice/office' models Result of this function is used to render the first select menu (county/city) for this carrier. If no groups can be found, then this function returns boolean false. Parameters `$addressId` `integer` $addressId when supplied then only groups from the addressId country are returned. Returns `boolean\|array`
`public Eabi_Postoffice_Model_Mysql4_Office_Collection`	# `getTerminals( integer $groupId = null, integer $addressId = null )` Returns Eabi_Postoffice_Model_Mysql4_Office_Collection which should contain the actual postoffices which belong to the selected group_id in alplabetically sorted order. If no $groupId is supplied, then all the postoffices are returned. Offices are sorted by group_sort descending group_name ascending name ascending Parameters `$groupId` `integer` $groupId `$addressId` `integer` $addressId when supplied then only offices from the addressId country are returned. Returns `Eabi_Postoffice_Model_Mysql4_Office_Collection` See `Eabi_Postoffice_Model_Carrier_Abstract::getGroupSort()`
`public Eabi_Postoffice_Model_Office\|boolean`	# `getTerminal( integer $placeId )` Returns the selected postoffice by it's place id. If no postoffice found, then returns boolean false. Returns the selected postoffice by it's place id. If no postoffice found, then returns boolean false. Parameters `$placeId` `integer` $placeId Returns `Eabi_Postoffice_Model_Office\|boolean` false
`public string`	# `getTerminalTitle( Eabi_Postoffice_Model_Office $office )` Determines how name of each postoffice in the second select menu should be rendered. Determines how name of each postoffice in the second select menu should be rendered. Parameters `$office` `Eabi_Postoffice_Model_Office` $office Returns `string`
`public string`	# `getGroupTitle( Eabi_Postoffice_Model_Office $office )` Determines how name of each county/city in the first select menu should be rendered. Determines how name of each county/city in the first select menu should be rendered. Parameters `$office` `Eabi_Postoffice_Model_Office` $office Returns `string`
`final public boolean\|string`	# `getTerminalComment( Eabi_Postoffice_Model_Office $office )` Should return extra comment for the selected postoffice. For example shipping time. Extra comment is displayed next to select menu just before price display Returning boolean false causes comment to be hidden Should return extra comment for the selected postoffice. For example shipping time. Extra comment is displayed next to select menu just before price display Returning boolean false causes comment to be hidden Parameters `$office` `Eabi_Postoffice_Model_Office` $office Returns `boolean\|string`
`protected boolean\|integer`	# `_getDeliveryTime( Eabi_Postoffice_Model_Office $office )` Returns calculated delivery time for the specified office If no delivery time calculation is available, then boolean FALSE is returned Returns calculated delivery time for the specified office If no delivery time calculation is available, then boolean FALSE is returned Parameters `$office` `Eabi_Postoffice_Model_Office` $office Returns `boolean\|integer`
`protected boolean\|string`	# `_getDisabledComment( Eabi_Postoffice_Model_Office $office )` Should return string text, when specified pickup-point is disabled. If specified pickup-point should not be disabled then this method returns boolean FALSE Should return string text, when specified pickup-point is disabled. If specified pickup-point should not be disabled then this method returns boolean FALSE Parameters `$office` `Eabi_Postoffice_Model_Office` $office Returns `boolean\|string`
`protected`	# `_getStartingDayStamp( mixed $timestamp )`
`public string`	# `getAdminTerminalTitle( Eabi_Postoffice_Model_Office $office )` Determines how name of customer selected postoffice should be rendered and this is also how merchant sees the selected postoffice. Determines how name of customer selected postoffice should be rendered and this is also how merchant sees the selected postoffice. Parameters `$office` `Eabi_Postoffice_Model_Office` $office Returns `string`
`final protected boolean`	# `getPriceFromAddressId( type $addressId )` Used to fetch the price from 'sales/quote_address_rate' database table. Parameters `$addressId` `type` $addressId Returns `boolean`
`final public`	# `setOfficeToSession( integer $addressId, Eabi_Postoffice_Model_Office $office )` Initially this carrier does not set up all the shipping methods for this carrier in the 'sales/quote_address_rate' database table. since storing too many methods in there is not the smartest thing to do So once the user selects the actual office, an AJAX callback is performed and this one inserts the selected office to the database and also to the session, in order the customer would easily reach latest selected offices and the order itself could be placed, since user selected postoffices have to exist in the 'sales/quote_address_rate' database table. This one results in less entries in 'sales/quote_address_rate' database table. Initially this carrier does not set up all the shipping methods for this carrier in the 'sales/quote_address_rate' database table. since storing too many methods in there is not the smartest thing to do So once the user selects the actual office, an AJAX callback is performed and this one inserts the selected office to the database and also to the session, in order the customer would easily reach latest selected offices and the order itself could be placed, since user selected postoffices have to exist in the 'sales/quote_address_rate' database table. This one results in less entries in 'sales/quote_address_rate' database table. Parameters `$addressId` `integer` $addressId `$office` `Eabi_Postoffice_Model_Office` $office Throws `Exception`
`final public Eabi_Postoffice_Model_Carrier_Abstract`	# `clearSession( )` Clears all the session data created by this carrier. Clears all the session data created by this carrier. Returns `Eabi_Postoffice_Model_Carrier_Abstract`
`public Eabi_Postoffice_Model_Carrier_Abstract\|boolean`	# `setConfigData( string $key, mixed $value )` Sets Magento store config for current carrier specified by key Sets Magento store config for current carrier specified by key Parameters `$key` `string` $key `$value` `mixed` $value Returns `Eabi_Postoffice_Model_Carrier_Abstract\|boolean`
`public boolean`	# `isAutoSendAvailable( )` Should return true, when this carrier can automatically send shipment data to third party carrier server. Should return true, when this carrier can automatically send shipment data to third party carrier server. Returns `boolean`
`public boolean\|string`	# `getBarcode( Mage_Sales_Model_Order $order )` Should return the actual generated barcode by the third party carrier server. Overwrite this method in the subclass. This function is available to the merchant, if he/she wants to print the packing slip in the order view. Should return the actual generated barcode by the third party carrier server. Overwrite this method in the subclass. This function is available to the merchant, if he/she wants to print the packing slip in the order view. Parameters `$order` `Mage_Sales_Model_Order` $order order, to get the barcode for. Returns `boolean\|string`
`public boolean`	# `getBarcodePdf( Mage_Sales_Model_Order $order )` Should return the actual Pdf binary which should be packing slip for this order and false in every other case. This function is available to the merchant, if he/she wants to print the packing slip in the order view. Should return the actual Pdf binary which should be packing slip for this order and false in every other case. This function is available to the merchant, if he/she wants to print the packing slip in the order view. Parameters `$order` `Mage_Sales_Model_Order` $order Returns `boolean`
`public boolean`	# `isDataSent( Mage_Sales_Model_Order $order )` Returns true, if data has been sent Returns false, if data has not been sent Returns null, if data sending is not available. Returns true, if data has been sent Returns false, if data has not been sent Returns null, if data sending is not available. Parameters `$order` `Mage_Sales_Model_Order` $order Returns `boolean`
`public boolean`	# `isBarcodeFunctionAvailable( )` If the barcode function is available at all for this carrier. Returns `boolean`
`public boolean\|array`	# `autoSendData( Mage_Sales_Model_Order $order, type $selectedOfficeId )` If automatic data sending is available, then this function should be overwritten and the actual data sending should be performed in here. Also Configuration value of `senddata_enable` should be set to '1' or this function will never be called. If automatic sending is not applicable, then this function should return boolean false. If automatic data sending is successful, then the result will be added to the order comments using `<span class="php-keyword2">print_r</span>()` function. If automatic data sending is available, then this function should be overwritten and the actual data sending should be performed in here. Also Configuration value of `senddata_enable` should be set to '1' or this function will never be called. If automatic sending is not applicable, then this function should return boolean false. If automatic data sending is successful, then the result will be added to the order comments using `<span class="php-keyword2">print_r</span>()` function. Parameters `$order` `Mage_Sales_Model_Order` $order `$selectedOfficeId` `type` $selectedOfficeId remote_place_id - id of the carrier, that the customer selected. Returns `boolean\|array`
`public Mage_Shipping_Model_Rate_Result_Error`	# `checkAvailableShipCountries( Mage_Shipping_Model_Rate_Request $request )` Wrapper function for the parent class, simply for security and session management. For example, when user first selects country, where the carrier is available and then switches country and the carrier is not available any more, then the session has to be cleared a bit, in order to avoid the user entering arbitrary data for the previously available carrier. Wrapper function for the parent class, simply for security and session management. For example, when user first selects country, where the carrier is available and then switches country and the carrier is not available any more, then the session has to be cleared a bit, in order to avoid the user entering arbitrary data for the previously available carrier. Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `Mage_Shipping_Model_Rate_Result_Error`
`public null\|boolean`	# `isPickedUpByCourier( Mage_Sales_Model_Order $order )` Indicates if specified order has been picked up by courier. Should return the following true - If the order has been picked up by courier false - If the order has not been picked up by courier null - If courier pickup is not applicable to specified order Indicates if specified order has been picked up by courier. Should return the following true - If the order has been picked up by courier false - If the order has not been picked up by courier null - If courier pickup is not applicable to specified order Parameters `$order` `Mage_Sales_Model_Order` $order Returns `null\|boolean`
`protected type`	# `getAddressId( Mage_Shipping_Model_Rate_Request $request )` Gets the address_id, which will be used in the 'sales/quote_address_rate' database table, in order to handle user selection of postoffice related to this carrier. Gets the address_id, which will be used in the 'sales/quote_address_rate' database table, in order to handle user selection of postoffice related to this carrier. Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `type`
`protected boolean`	# `_compareAddressToRequest( Mage_Shipping_Model_Rate_Request $request, Mage_Sales_Model_Quote_Address $address )` In multishipping scenarios shipping addresses may not be saved and thus lacking correct id. In such scenario they need to be compared manually to detect the correct chosen parcel terminal In multishipping scenarios shipping addresses may not be saved and thus lacking correct id. In such scenario they need to be compared manually to detect the correct chosen parcel terminal Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request `$address` `Mage_Sales_Model_Quote_Address` $address Returns `boolean`
`protected integer`	# `_getSeconds( array $input )` Converts array input of three elements into seconds First element in array should represent hours Second element in array should represent minutes Third element in array should represent seconds Converts array input of three elements into seconds First element in array should represent hours Second element in array should represent minutes Third element in array should represent seconds Parameters `$input` `array` $input Returns `integer`
`public string`	# `getCode( )` Gets current carrier code for usage in other helper classes. Gets current carrier code for usage in other helper classes. Returns `string`
`protected Mage_Sales_Model_Quote_Address`	# `_getAddressModel( )` Returns `Mage_Sales_Model_Quote_Address`
`protected Mage_Catalog_Model_Product`	# `_getProductModel( )` Returns `Mage_Catalog_Model_Product`
`protected`	# `_getOfficeModel( )`
`protected Eabi_Livehandler_Helper_Data`	# `_getEabi( )` Returns `Eabi_Livehandler_Helper_Data`
`protected Eabi_Postoffice_Helper_Data`	# `_getOfficeHelper( )` Returns `Eabi_Postoffice_Helper_Data`
`protected Eabi_Postoffice_Helper_Countrycode`	# `_getDialCodeHelper( )` Returns `Eabi_Postoffice_Helper_Countrycode`
`protected Mage_Checkout_Model_Session`	# `_getCheckoutSession( )` Return checkout session object Return checkout session object Returns `Mage_Checkout_Model_Session`
`protected Mage_Sales_Model_Quote`	# `_getQuote( )` Return checkout quote object Return checkout quote object Returns `Mage_Sales_Model_Quote`

Properties summary
`protected boolean\|string`	`$_tracking_url`	`false`	# Actual URL can be entered here, where %s in the url would be replaced with supplied tracking number. When tracking number is entered, then user is provided with link to track the status of package on remote server. Actual URL can be entered here, where %s in the url would be replaced with supplied tracking number. When tracking number is entered, then user is provided with link to track the status of package on remote server.
`protected boolean`	`$_track_iframe`	`false`	# When set to true and $_tracking_url is provided, then instead of clickable link iframe is displayed instead. When set to true and $_tracking_url is provided, then instead of clickable link iframe is displayed instead.
`protected Mage_Sales_Model_Quote`	`$_quote`	`false`	#

Namespaces

Classes

Class Eabi_Postoffice_Model_Carrier_Abstract

Direct known subclasses

Indirect known subclasses

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Throws

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns