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

Class: PaymentDecorator

Source Location: /code/order/PaymentDecorator.php

Class Overview

DataObjectDecorator
   |
   --PaymentDecorator

Mixin to augment the Payment class.


Author(s):

Version:

  • 1.0

Copyright:

  • Copyright (c) 2011, Frank Mullenger

Methods



Class Details

[line 12]
Mixin to augment the Payment class.

Payment statuses: Incomplete,Success,Failure,Pending




Tags:

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


[ Top ]


Class Methods


method canCreate [line 40]

Boolean canCreate( [ $member = null])

Cannot create Payments in the CMS.



Tags:

return:  False always


Parameters:

   $member  

[ Top ]

method canDelete [line 50]

Boolean canDelete( [ $member = null])

Cannot delete Payments in the CMS.



Tags:

return:  False always


Parameters:

   $member  

[ Top ]

method extraStatics [line 19]

void extraStatics( )

Extra fields to be added to the Payment class.



[ Top ]

method onAfterWrite [line 115]

void onAfterWrite( )

After payment success process onAfterPayment() in Order.



[ Top ]

method redirectToOrder [line 129]

void redirectToOrder( )

For the purpose of certain payment gateways.



[ Top ]

method SummaryOfAmount [line 59]

String SummaryOfAmount( )

Helper to get a nicely formatted amount for this Payment



Tags:

return:  Payment amount formatted with Nice()


[ Top ]

method SummaryOfType [line 68]

String SummaryOfType( )

Helper to get type of Payment depending on payment class used.



Tags:

return:  Payment class name with camel case exploded


[ Top ]

method updateCMSFields [line 79]

FieldSet updateCMSFields( FieldSet &$fields)

Fields to display this Payment in the CMS, removed some of the unnecessary fields.



Parameters:

FieldSet   &$fields  

[ Top ]


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