POD fixes and removing debug output
This commit is contained in:
Wouter van Oijen
parent
f3346bd008
commit
2d9565775f
53 changed files with 267 additions and 215 deletions
|
|
@ -112,7 +112,7 @@ sub priceLineItem {
|
|||
my $quantity = shift;
|
||||
# this is the output of ShoppingCart->getItems (the \@normal arrayref).
|
||||
my $cartItems = shift;
|
||||
use Data::Dumper;
|
||||
#use Data::Dumper;
|
||||
# $self->session->errorHandler->warn('normal contents: '.Dumper($cartItems));
|
||||
# this is the default price of this event.
|
||||
my $price = $self->{_event}->{price};
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ sub cancelRecurringPayment {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 checkoutForm
|
||||
=head2 checkoutForm ( )
|
||||
|
||||
This must return a printRowsOnly'ed WebGUI::HTMLForm containing the fields for the checkout
|
||||
dat you want to collect. Do not include submit buttons. You probably want to override this
|
||||
|
|
@ -80,7 +80,7 @@ sub checkoutForm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 configurationForm
|
||||
=head2 configurationForm ( )
|
||||
|
||||
This generates the configuration form that's displayed in the admin console. You must
|
||||
extend this method to include parameters specific to this payment module. To do so return
|
||||
|
|
@ -116,7 +116,7 @@ sub configurationForm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 confirmRecurringTransaction
|
||||
=head2 confirmRecurringTransaction ( )
|
||||
|
||||
This method is called if your gateway signals you (ie. posts data to some URL) to confirm a
|
||||
recurring payment term has been processed. If this is the case, you probably want to store
|
||||
|
|
@ -133,7 +133,7 @@ sub confirmRecurringTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 confirmTransaction
|
||||
=head2 confirmTransaction ( )
|
||||
|
||||
This method is called when your gateway contacts a specific URL to notify you of the result of a
|
||||
transaction. You should override this method only if your gateway uses this kind of notification
|
||||
|
|
@ -147,7 +147,7 @@ sub confirmTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 connectionError
|
||||
=head2 connectionError ( )
|
||||
|
||||
Returns an error message if there was a connection error. You must override this method.
|
||||
|
||||
|
|
@ -159,7 +159,7 @@ sub connectionError {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 enabled
|
||||
=head2 enabled ( )
|
||||
|
||||
Returns a boolean indicating whether the plugin is enabled or not.
|
||||
|
||||
|
|
@ -187,7 +187,7 @@ sub get {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEnabledPlugins
|
||||
=head2 getEnabledPlugins ( )
|
||||
|
||||
Returns a reference to an array of all enabled instantiated payment plugins.
|
||||
|
||||
|
|
@ -237,7 +237,7 @@ sub init {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 gatewayId
|
||||
=head2 gatewayId ( )
|
||||
|
||||
Returns the gatewayId of the transaction. You must override this method.
|
||||
|
||||
|
|
@ -276,7 +276,7 @@ sub getRecurringPaymentStatus {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 errorCode
|
||||
=head2 errorCode ( )
|
||||
|
||||
Returns the error code of the last submission.
|
||||
|
||||
|
|
@ -335,7 +335,7 @@ sub name {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 namespace
|
||||
=head2 namespace ( )
|
||||
|
||||
Returns the namespace of the plugin.
|
||||
|
||||
|
|
@ -394,7 +394,7 @@ sub recurringTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 resultCode
|
||||
=head2 resultCode ( )
|
||||
|
||||
Returns the result code of the transaction. You must override this method.
|
||||
|
||||
|
|
@ -407,7 +407,7 @@ sub resultCode {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 resultMessage
|
||||
=head2 resultMessage ( )
|
||||
|
||||
Returns the result message of the transaction. You must override this method.
|
||||
|
||||
|
|
@ -529,7 +529,7 @@ sub shippingDescription {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 supports
|
||||
=head2 supports ( )
|
||||
|
||||
Returns a hashref containg the types of payment the plugin supports. The hashref may contain:
|
||||
|
||||
|
|
@ -547,7 +547,7 @@ sub supports {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 transactionCompleted {
|
||||
=head2 transactionCompleted ( )
|
||||
|
||||
A boolean indicating whether the payment has been finished or not. You must override this method.
|
||||
|
||||
|
|
@ -560,7 +560,7 @@ sub transactionCompleted {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 transactionError
|
||||
=head2 transactionError ( )
|
||||
|
||||
Returns an error message if a transaction error has occurred. You must override this method.
|
||||
|
||||
|
|
@ -573,7 +573,7 @@ sub transactionError {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 transactionPending
|
||||
=head2 transactionPending ( )
|
||||
|
||||
A boolean indicating whether the payment is pending or not. You must override this method.
|
||||
|
||||
|
|
@ -586,7 +586,7 @@ sub transactionPending {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 validateFormData
|
||||
=head2 validateFormData ( )
|
||||
|
||||
This method checks the data entered in the checkoutForm. If an error has occurred this method must
|
||||
return an arrayref containing the errormessages tied to the errors. If everything's ok it will return
|
||||
|
|
|
|||
|
|
@ -156,6 +156,7 @@ A copy of the session object
|
|||
The namespace of the plugin.
|
||||
|
||||
=cut
|
||||
|
||||
sub init {
|
||||
my ($class, $self);
|
||||
$class = shift;
|
||||
|
|
|
|||
|
|
@ -287,6 +287,7 @@ A copy of the session object
|
|||
The namespace of the plugin.
|
||||
|
||||
=cut
|
||||
|
||||
sub init {
|
||||
my ($class, $self);
|
||||
$class = shift;
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ use WebGUI::Commerce::ShoppingCart;
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 calc
|
||||
=head2 calc ( )
|
||||
|
||||
Returns the calculated shipping cost. Your plugin must override this method.
|
||||
|
||||
|
|
@ -33,7 +33,7 @@ sub calc {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 description
|
||||
=head2 description ( )
|
||||
|
||||
Returns a description of the shipping configuration. Defaults to the name of your plugin
|
||||
if you do not overload this method.
|
||||
|
|
@ -46,7 +46,7 @@ sub description {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 configurationForm
|
||||
=head2 configurationForm ( )
|
||||
|
||||
This generates the configuration form that's displayed in the admin console. You must
|
||||
extend this method to include parameters specific to this payment module. To do so return
|
||||
|
|
@ -75,7 +75,7 @@ sub configurationForm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 enabled
|
||||
=head2 enabled ( )
|
||||
|
||||
Returns a boolean indicating whether the plugin is enabled or not.
|
||||
|
||||
|
|
@ -103,7 +103,7 @@ sub get {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getOptions
|
||||
=head2 getOptions ( )
|
||||
|
||||
Returns a hash containing the parameters of a user configurable shipping method. If
|
||||
your shipping plugin has an options form you should overload this method.
|
||||
|
|
@ -116,7 +116,7 @@ sub getOptions {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getShippingItems
|
||||
=head2 getShippingItems ( )
|
||||
|
||||
Returns an arrayref containing the items, marked for shipping. If no items are set
|
||||
using setShippingOptions it this method will default to the shopping cart of the user.
|
||||
|
|
@ -141,7 +141,7 @@ sub getShippingItems {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEnabledPlugins
|
||||
=head2 getEnabledPlugins ( )
|
||||
|
||||
Returns a reference to an array of all enabled instantiated payment plugins.
|
||||
|
||||
|
|
@ -195,7 +195,7 @@ sub init {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getShoppingCart
|
||||
=head2 getShoppingCart ( )
|
||||
|
||||
Returns a WebGUI::Commerce::ShoppingCart object of the current user.
|
||||
|
||||
|
|
@ -237,7 +237,7 @@ sub load {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 name
|
||||
=head2 name ( )
|
||||
|
||||
Returns the (display) name of the plugin. You must override this method.
|
||||
|
||||
|
|
@ -250,7 +250,7 @@ sub name {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 namespace
|
||||
=head2 namespace ( )
|
||||
|
||||
Returns the namespace of the plugin.
|
||||
|
||||
|
|
@ -262,7 +262,7 @@ sub namespace {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 optionsOk
|
||||
=head2 optionsOk ( )
|
||||
|
||||
Indicates whether the options loaded into the plugin (by using either setOptions or processOptionsForm)
|
||||
are correct. If your plugin is able of being configured by an options form you must overload this method.
|
||||
|
|
@ -305,7 +305,7 @@ sub prepend {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 processOptionsForm
|
||||
=head2 processOptionsForm ( )
|
||||
|
||||
Processes the submitted form variables from the optionsForm and stores them
|
||||
into the plugin. You only need to overload this method if your plugin is capable
|
||||
|
|
@ -318,7 +318,7 @@ sub processOptionsForm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns the cached, local session variable.
|
||||
|
||||
|
|
@ -366,7 +366,7 @@ sub setShippingItems {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 supportsTracking
|
||||
=head2 supportsTracking ( )
|
||||
|
||||
Returns a boolean indicating whether this plugin supports tracking of the shipment.
|
||||
Overload this method if your plugin does. Defaults to false.
|
||||
|
|
@ -379,7 +379,7 @@ sub supportsTracking {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 trackingInfo
|
||||
=head2 trackingInfo ( )
|
||||
|
||||
Returns a message containing information about the shipment tracking (ie. where the
|
||||
package is or something like that). If your plugin support these tracking, you probably
|
||||
|
|
@ -393,7 +393,7 @@ sub trackingInfo {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 trackingNumber
|
||||
=head2 trackingNumber ( )
|
||||
|
||||
Returns the tracking ID supplied by the shipment company. If your plugin supports tracking
|
||||
you'll have to overload this method. Defaults to undef.
|
||||
|
|
@ -406,7 +406,7 @@ sub trackingNumber {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 trackingUrl
|
||||
=head2 trackingUrl ( )
|
||||
|
||||
Returns the URL where the user can go to either fill in the tracking number or view the tracking
|
||||
info of his package. Overload this method if your plugin supports tracking. Defaults to undef.
|
||||
|
|
|
|||
|
|
@ -272,7 +272,7 @@ sub new {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns the cached, local session variable.
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ sub addItem {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 cancelTransaction
|
||||
=head2 cancelTransaction ( )
|
||||
|
||||
Cancels a recurring transaction. This is done by trying to cancel the subscription at the gateway
|
||||
using a Payment plugin. If this is succesfull the transaction is marked as canceled.
|
||||
|
|
@ -100,7 +100,7 @@ sub cancelTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 completeTransaction
|
||||
=head2 completeTransaction ( )
|
||||
|
||||
Sets the status of a transaction to 'Completed' and executes the handler for every item attached to
|
||||
the transction.
|
||||
|
|
@ -127,7 +127,7 @@ sub completeTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 delete
|
||||
=head2 delete ( )
|
||||
|
||||
Deletes the transaction from the database;
|
||||
|
||||
|
|
@ -163,6 +163,7 @@ The type of the item you want to remove.
|
|||
=cut
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
sub deleteItem {
|
||||
my ($self, $itemId, $itemType, $amount, @items);
|
||||
$self = shift;
|
||||
|
|
@ -297,7 +298,7 @@ sub getByGatewayId {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getItems
|
||||
=head2 getItems ( )
|
||||
|
||||
=cut
|
||||
|
||||
|
|
@ -465,7 +466,7 @@ sub new {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 pendingTransactions
|
||||
=head2 pendingTransactions ( )
|
||||
|
||||
Returns a reference to an array which contains transaction objects of all pending transactions.
|
||||
|
||||
|
|
@ -485,7 +486,7 @@ sub pendingTransactions {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns the cached, local session variable.
|
||||
|
||||
|
|
@ -650,7 +651,7 @@ sub trackingNumber {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 transactionId
|
||||
=head2 transactionId ( )
|
||||
|
||||
Returns the transactionId of the transaction.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue