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

Class: FlatFeeShippingField

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

Class Overview

DropdownField
   |
   --ModifierSetField
      |
      --FlatFeeShippingField

Form fields that represent FlatFeeShippingRates in the Checkout form.


Author(s):

Version:

  • 1.0

Copyright:

  • Copyright (c) 2011, Frank Mullenger

Methods


Inherited Variables

Inherited Methods

Class: ModifierSetField

ModifierSetField::__construct()
Creates a new optionset field for order modifers with the naming convention Modifiers[ClassName] where ClassName is name of modifier class.
ModifierSetField::FieldHolder()
Render field with the appropriate template.
ModifierSetField::getModifier()
Get the modifier e.g: FlatFeeShipping
ModifierSetField::validate()
Validation is not currently done on this field at this point.

Class Details

[line 11]
Form fields that represent FlatFeeShippingRates in the Checkout form.



Tags:

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


[ Top ]


Class Methods


method FieldHolder [line 19]

String FieldHolder( )

Render field with the appropriate template.



Overrides ModifierSetField::FieldHolder() (Render field with the appropriate template.)

[ Top ]

method updateValue [line 32]

void updateValue( Order $order)

Update value of the field according to any matching Modifications in the Order. Useful when the source options have changed, if a matching option cannot be found in a Modification then the first option is set at the value (selected).



Parameters:

Order   $order  

[ Top ]

method validate [line 66]

void validate( $validator)

Ensure that the value is the ID of a valid FlatFeeShippingRate and that the FlatFeeShippingRate it represents is valid for the Shipping country being set in the Order.



Overrides ModifierSetField::validate() (Validation is not currently done on this field at this point.)

Parameters:

   $validator  

[ Top ]


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