2170509c0f
There would be far too much rewriting in order to change the EU driver to use FormBuilder. We can revisit that later.
309 lines
7.1 KiB
Perl
309 lines
7.1 KiB
Perl
package WebGUI::Shop::TaxDriver;
|
|
|
|
=head1 LEGAL
|
|
|
|
-------------------------------------------------------------------
|
|
WebGUI is Copyright 2001-2009 Plain Black Corporation.
|
|
-------------------------------------------------------------------
|
|
Please read the legal notices (docs/legal.txt) and the license
|
|
(docs/license.txt) that came with this distribution before using
|
|
this software.
|
|
-------------------------------------------------------------------
|
|
http://www.plainblack.com info@plainblack.com
|
|
-------------------------------------------------------------------
|
|
|
|
=cut
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::Shop::TaxDriver
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This package is the base class for all modules which implement a tax driver.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use WebGUI::Shop::TaxDriver;
|
|
|
|
my $taxDriver = WebGUI::Shop::TaxDriver->new($session);
|
|
|
|
=head1 METHODS
|
|
|
|
These subroutines are available from this package:
|
|
|
|
=cut
|
|
|
|
use strict;
|
|
|
|
use Moose;
|
|
use WebGUI::Definition;
|
|
use Scalar::Util qw/blessed/;
|
|
|
|
has session => (
|
|
is => 'ro',
|
|
required => 1,
|
|
);
|
|
|
|
has messages => (
|
|
is => 'rw',
|
|
default => sub { [] },
|
|
);
|
|
|
|
use JSON qw{ from_json to_json };
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 new ( $session )
|
|
|
|
Constructor
|
|
|
|
=head3 session
|
|
|
|
Instanciated WebGUI::Session object.
|
|
|
|
=cut
|
|
|
|
around BUILDARGS => sub {
|
|
my $orig = shift;
|
|
my $class = shift;
|
|
my $session = shift;
|
|
|
|
if (! (blessed $session && $session->isa('WebGUI::Session'))) {
|
|
WebGUI::Error::InvalidObject->throw(expected=>"WebGUI::Session", got=>(ref $session), error=>"Need a session.");
|
|
}
|
|
|
|
my $optionsJSON = $session->db->quickScalar( 'select options from taxDriver where className=?', [
|
|
$class,
|
|
] );
|
|
|
|
my $options = $optionsJSON ? from_json( $optionsJSON ) : {};
|
|
$options->{session} = $session;
|
|
|
|
return $class->$orig($options);
|
|
};
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::Shop::TaxDriver
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Base class for all modules which do tax calculations in the Shop.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use base WebGUI::Shop::TaxDriver;
|
|
|
|
my $driver = WebGUI::Shop::TaxDriver->new($session);
|
|
|
|
=head1 METHODS
|
|
|
|
These subroutines are available from this package:
|
|
|
|
=cut
|
|
|
|
=head2 appendCartItemVars ( var, cartItem )
|
|
|
|
Adds tax driver specific template variables for the given cart item to the supplied hashref.
|
|
|
|
=head3 var
|
|
|
|
The template variable hash ref to add the tax vars to.
|
|
|
|
=head3 cartItem
|
|
|
|
The instanstance of WebGUI::Shop::CartItem to add the vars for.
|
|
|
|
=cut
|
|
|
|
sub appendCartItemVars {
|
|
my $self = shift;
|
|
my $var = shift;
|
|
my $item = shift;
|
|
|
|
WebGUI::Error::InvalidParam->throw( 'Must supply a hash ref' )
|
|
unless $var && ref $var eq 'HASH';
|
|
WebGUI::Error::InvalidObject->throw( expected => 'WebGUI::Shop::CartItem', got => ref $item, error => 'Must pass a cart item' )
|
|
unless $item && $item->isa( 'WebGUI::Shop::CartItem' );
|
|
|
|
my $sku = $item->getSku;
|
|
my $address = eval { $item->getShippingAddress };
|
|
my $taxRate = $self->getTaxRate( $sku, $address );
|
|
|
|
my $quantity = $item->get( 'quantity' );
|
|
my $price = $sku->getPrice;
|
|
my $tax = $price * $taxRate / 100;
|
|
|
|
$var->{ taxRate } = $taxRate;
|
|
$var->{ taxAmount } = $item->cart->formatCurrency( $tax );
|
|
$var->{ pricePlusTax } = $item->cart->formatCurrency( $price + $tax );
|
|
$var->{ extendedPricePlusTax } = $item->cart->formatCurrency( $quantity * ( $price + $tax ) );
|
|
}
|
|
|
|
#-----------------------------------------------------------
|
|
|
|
=head2 canManage ( )
|
|
|
|
Returns true if the current user can manage taxes.
|
|
|
|
=cut
|
|
|
|
sub canManage {
|
|
my $self = shift;
|
|
my $admin = WebGUI::Shop::Admin->new( $self->session );
|
|
|
|
return $admin->canManage;
|
|
}
|
|
|
|
#-----------------------------------------------------------
|
|
|
|
=head2 className {
|
|
|
|
Returns the class name of your plugin.
|
|
|
|
=cut
|
|
|
|
sub className {
|
|
my $self = shift;
|
|
|
|
my $className = ref $self;
|
|
$self->session->log->fatal( "Tax plugin (".$self->className.") is required to overload the className method" )
|
|
if $className eq 'WebGUI::Shop::TaxDriver';
|
|
|
|
return $className;
|
|
}
|
|
|
|
|
|
#-----------------------------------------------------------
|
|
|
|
=head2 getEditForm ( )
|
|
|
|
Returns the edit form that contains the configuration options for this plugin in the admin console.
|
|
|
|
=cut
|
|
|
|
sub getEditForm {
|
|
return 'This plugin has no configuration options';
|
|
}
|
|
|
|
#-----------------------------------------------------------
|
|
|
|
=head2 getTaxRate ( sku, [ address ] )
|
|
|
|
Returns the tax rate in percents (eg. 19 for a rate of 19%) for the given sku and shipping address. Your tax driver
|
|
must overload this method.
|
|
|
|
Note that address is optional and that it's up to your plugin to handle that case.
|
|
|
|
=head3 sku
|
|
|
|
The sku for which the tax rate must be determined. Should be a WebGUI::Asset::Sku::* instance.
|
|
|
|
=head3 address
|
|
|
|
Optional, the shipping address for which to calculate the tax. Must be an instance of WebGUI::Shop::Address.
|
|
|
|
=cut
|
|
|
|
sub getTaxRate {
|
|
my $self = shift;
|
|
|
|
$self->session->log->fatal("Tax plugin ". $self->className ." is required to overload getTaxRate");
|
|
}
|
|
|
|
#-----------------------------------------------------------
|
|
|
|
=head2 getTransactionTaxData ( sku, address )
|
|
|
|
Returns a hashref containing tax information that should be stored along with transaction items.
|
|
|
|
=head3 sku
|
|
|
|
The sku belonging to the transaction item.
|
|
|
|
=head3 address
|
|
|
|
The address belonging to the transaction item.
|
|
|
|
=cut
|
|
|
|
sub getTransactionTaxData {
|
|
my $self = shift;
|
|
|
|
my $config = {
|
|
className => $self->className,
|
|
};
|
|
|
|
return $config;
|
|
}
|
|
|
|
#-----------------------------------------------------------
|
|
|
|
=head2 getUserScreen ( )
|
|
|
|
Returns the screen for entering per user configuration for this tax driver.
|
|
|
|
=cut
|
|
|
|
sub getUserScreen {
|
|
return 'There are no tax options to configure.';
|
|
}
|
|
|
|
#-----------------------------------------------------------
|
|
|
|
=head2 skuFormDefinition ( )
|
|
|
|
Returns a hash ref containing the form definition for the per sku options for this tax driver.
|
|
|
|
=cut
|
|
|
|
sub skuFormDefinition {
|
|
return {};
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 processSkuFormPost ( )
|
|
|
|
Processes the form parameters defined in the skuFormDefinition method and returns a hash ref containing the result.
|
|
|
|
=cut
|
|
|
|
sub processSkuFormPost {
|
|
my $self = shift;
|
|
my $form = $self->session->form;
|
|
my $configuration = {};
|
|
|
|
my $definition = $self->skuFormDefinition;
|
|
|
|
foreach my $fieldName ( keys %{ $definition } ) {
|
|
my ($fieldType, $defaultValue) = @{ $definition->{ $fieldName } }{ qw{ fieldType defaultValue } };
|
|
|
|
$configuration->{ $fieldName } = $form->process( $fieldName, $fieldType, $defaultValue );
|
|
}
|
|
|
|
return $configuration;
|
|
}
|
|
|
|
#-----------------------------------------------------------
|
|
|
|
=head2 write ( )
|
|
|
|
Store the properties of this object to the database, as a JSON blob.
|
|
|
|
=cut
|
|
|
|
sub write {
|
|
my $self = shift;
|
|
|
|
my $options = $self->get();
|
|
|
|
# Persist to db
|
|
$self->session->db->write( 'replace into taxDriver (className, options) values (?,?)', [
|
|
$self->className,
|
|
to_json( $options ),
|
|
] );
|
|
}
|
|
|
|
1;
|