add stub for Ship

lib/WebGUI/Shop/Ship.pm

@@ -0,0 +1,123 @@
+package WebGUI::Shop::Ship;
+
+use strict;
+
+use Carp qw(croak);
+use WebGUI::International;
+use WebGUI::Shop::ShipDriver;
+
+=head1 NAME
+
+Package WebGUI::Shop::Ship
+
+=head1 DESCRIPTION
+
+This is the master class to manage ship drivers.
+
+=head1 SYNOPSIS
+
+ use WebGUI::Shop::Ship;
+
+=head1 METHODS
+
+These subroutines are available from this package:
+
+=cut
+
+#-------------------------------------------------------------------
+
+=head2 _loadDriver (  )
+
+The method used to safely load the Shipping drivers.
+
+=cut
+
+sub _loadDriver {
+}
+
+#-------------------------------------------------------------------
+
+=head2 create ( $session, $class, $options )
+
+The interface method for creating new, configured instances of ShipDriver.
+
+=head3 $session
+
+A WebGUI::Session object.
+
+=head4 $class
+
+The class of the new ShipDriver object to create.
+
+=head4 $options
+
+A list of properties to assign to this ShipperDriver.  See C<definition> for details.
+
+=cut
+
+sub create {
+    my $class   = shift;
+    my $session = shift;
+    croak "Definition requires a session object"
+        unless ref $session eq 'WebGUI::Session';
+    my $requestedClass = shift;
+    my $options = shift;
+    croak "You must pass a hashref of options to create a new ShipDriver object"
+        unless defined($options) and ref $options eq 'HASH' and scalar keys %{ $options };
+}
+
+#-------------------------------------------------------------------
+
+=head2 getDrivers ( $session )
+
+This subroutine returns an arrayref of hashrefs, used to validate data put into
+the object by the user, and to automatically generate the edit form to show
+the user.
+
+=cut
+
+sub getDrivers {
+    my $class      = shift;
+    my $session    = shift;
+    croak "Definition requires a session object"
+        unless ref $session eq 'WebGUI::Session';
+}
+
+#-------------------------------------------------------------------
+
+=head2 getOptions ( $session, $cart )
+
+Returns a list of options for the user to ship, along with the cost of using each one.  It is a hash of hashrefs,
+with the key of the primary hash being the shipperId of the driver, and sub keys of label and price.
+
+=head3
+
+=cut
+
+sub getOptions {
+    my $class      = shift;
+    my $session    = shift;
+    croak "Definition requires a session object"
+        unless ref $session eq 'WebGUI::Session';
+}
+
+#-------------------------------------------------------------------
+
+=head2 new ( $session, $shipperId )
+
+Looks up an existing ShipperDriver in the db by shipperId and returns
+that object.
+
+=cut
+
+sub new {
+    my $class     = shift;
+    my $session   = shift;
+    croak "new requires a session object"
+        unless ref $session eq 'WebGUI::Session';
+    my $shipperId = shift;
+    croak "new requires a shipperId"
+        unless defined $shipperId;
+}
+
+1;