swipestripe
[ class tree: swipestripe ] [ index: swipestripe ] [ all elements ]

Class: FlatFeeShipping

Source Location: /code/modifiers/shipping/FlatFee/FlatFeeShipping.php

Class Overview

DataObject
   |
   --Modifier
      |
      --FlatFeeShipping

Flat fee shipping, flat fees can be added for each supported shipping country from the SiteConfig using FlatFeeShippingRates.


Author(s):

Version:

  • 1.0

Copyright:

  • Copyright (c) 2011, Frank Mullenger

Implements interfaces:

Methods


Inherited Variables

Inherited Methods

Class: Modifier

Modifier::combined_form_fields()
Get all the form fields from all the supported methods.
Modifier::combined_form_requirements()
Get all the form requirements from all the supported methods.

Class Details

[line 12]
Flat fee shipping, flat fees can be added for each supported shipping country from the SiteConfig using FlatFeeShippingRates.



Tags:

author:  Frank Mullenger <frankmullenger@gmail.com>
version:  1.0
copyright:  Copyright (c) 2011, Frank Mullenger


[ Top ]


Class Methods


static method enable [line 17]

static void enable( )

For setting configuration, should be called from _config.php files only



Tags:

access:  public


[ Top ]

method addToOrder [line 142]

void addToOrder( Order $order, Mixed $value)

Add modifider to an Order .




Implementation of:
Modifier_Interface::addToOrder()
Add modifider to an Order .

Parameters:

Order   $order  
Mixed   $value  

[ Top ]

method Amount [line 83]

Money Amount( Order $order, Int $value)

Get Amount for this modifier so that it can be saved into an Order Modification.



Tags:

access:  public



Implementation of:
Modifier_Interface::Amount()
Get Amount for this modifier so that it can be saved into an Order Modification.

Parameters:

Order   $order  
Int   $value   ID for a FlatFeeShippingRate

[ Top ]

method Description [line 114]

String Description( Order $order, Mixed $value)

Get Description for this modifier so that it can be saved into an Order Modification.



Tags:

access:  public



Implementation of:
Modifier_Interface::Description()
Get Description for this modifier so that it can be saved into an Order Modification.

Parameters:

Order   $order  
Mixed   $value   A value passed from the Checkout form POST data usually

[ Top ]

method getFormFields [line 31]

FieldSet getFormFields( Order $order)

Form fields for displaying on the Checkout form, a dropdown of FlatFeeShippingRates that are filtered depending on the shipping country selected.



Tags:

access:  public



Implementation of:
Modifier_Interface::getFormFields()
Get form fields for this modifier.

Parameters:

Order   $order  

[ Top ]

method getFormRequirements [line 71]

FieldSet getFormRequirements( Order $order)

Get form requirements for this modifier.



Tags:

access:  public



Implementation of:
Modifier_Interface::getFormRequirements()
Get form requirements for this modifier.

Parameters:

Order   $order  

[ Top ]


Documentation generated on Thu, 08 Mar 2012 16:47:26 +1300 by phpDocumentor 1.4.4