added address book management system, no ui

lib/WebGUI/Shop/Address.pm

@@ -0,0 +1,231 @@
+package WebGUI::Shop::Address;
+
+use strict;
+use Class::InsideOut qw{ :std };
+use WebGUI::Exception::Shop;
+
+=head1 NAME
+
+Package WebGUI::Shop::Address
+
+=head1 DESCRIPTION
+
+An address is used to track shipping or payment addresses in the commerce system.
+
+=head1 SYNOPSIS
+
+ use WebGUI::Shop::Address;
+
+ my $address = WebGUI::Shop::Address->new($addressBook, $addressId);
+
+=head1 METHODS
+
+These subroutines are available from this package:
+
+=cut
+
+readonly addressBook => my %addressBook;
+private properties => my %properties;
+
+#-------------------------------------------------------------------
+
+=head2 addressBook ( )
+
+Returns a reference to the Address Book.
+
+=cut
+
+#-------------------------------------------------------------------
+
+=head2 create ( addressBook, address)
+
+Constructor. Adds an address to an address book. Returns a reference to the address.
+
+=head3 addressBook
+
+A reference to a WebGUI::Shop::AddressBook object.
+
+=head3 address
+
+A hash reference containing the properties to set in the address.
+
+=cut
+
+sub create {
+    my ($class, $book, $addressData) = @_;
+    unless (defined $book && $book->isa("WebGUI::Shop::AddressBook")) {
+        WebGUI::Error::InvalidObject->throw(expected=>"WebGUI::Shop::AddressBook", got=>(ref $book), error=>"Need an address book.", param=>$book);
+    }
+    unless (defined $addressData && ref $addressData eq "HASH") {
+        WebGUI::Error::InvalidParam->throw(param=>$addressData, error=>"Need a hash reference.");
+    }
+    my $id = $book->session->db->setRow("addressBook","addressBookId", {addressId=>"new"});
+    my $address = $class->new($book, $id);
+    $address->update($addressData);
+    return $address;
+}
+
+#-------------------------------------------------------------------
+
+=head2 delete ( )
+
+Removes this address from the book.
+
+=cut
+
+sub delete {
+    my $self = shift;
+    $self->addressBook->session->db->deleteRow("address","addressId",$self->getId);
+    undef $self;
+    return undef;
+}
+
+#-------------------------------------------------------------------
+
+=head2 get ( [ property ] )
+
+Returns a duplicated hash reference of this object’s data.
+
+=head3 property
+
+Any field − returns the value of a field rather than the hash reference.
+
+=cut
+
+sub get {
+    my ($self, $name) = @_;
+    if (defined $name) {
+        return $properties{id $self}{$name};
+    }
+    my %copyOfHashRef = %{$properties{id $self}};
+    return \%copyOfHashRef;
+}
+
+#-------------------------------------------------------------------
+
+=head2 getId () 
+
+Returns the unique id of this item.
+
+=cut
+
+sub getId {
+    my $self = shift;
+    return $self->get("addressId");
+}
+
+
+#-------------------------------------------------------------------
+
+=head2 new ( addressBook, addressId )
+
+Constructor.  Instanciates an address based upon addressId.
+
+=head3 addressBook
+
+A reference to a WebGUI::Shop::AdressBook object.
+
+=head3 addressId
+
+The unique id of the address to instanciate.
+
+=cut
+
+sub new {
+    my ($class, $book, $addressId) = @_;
+    unless (defined $book && $book->isa("WebGUI::Shop::AddressBook")) {
+        WebGUI::Error::InvalidObject->throw(expected=>"WebGUI::Shop::AddressBook", got=>(ref $book), error=>"Need an address book.");
+    }
+    unless (defined $addressId) {
+        WebGUI::Error::InvalidParam->throw(error=>"Need an addressId.", param=>$addressId);
+    }
+    my $address = $book->session->db->quickHashRef('select * from address where addressId=?', [$addressId]);
+    if ($address->{addressId} eq "") {
+        WebGUI::Error::ObjectNotFound->throw(error=>"Address not found.", id=>$addressId);
+    }
+    if ($address->{addressBookId} ne $book->getId) {
+        WebGUI::Error::ObjectNotFound->throw(error=>"Address not in this address book.", id=>$addressId);
+    }
+    my $self = register $class;
+    my $id        = id $self;
+    $addressBook{ $id }   = $book;
+    $properties{ $id } = $address;
+    return $self;
+}
+
+
+#-------------------------------------------------------------------
+
+=head2 update ( properties )
+
+Sets properties of the address.
+
+=head3 properties
+
+A hash reference that contains one or more of the following:
+
+=head4 label
+
+A human readable label like "home" or "work".
+
+=head4 name
+
+The name of the company or person to address this to.
+
+=head4 address1
+
+The street name and number.
+
+=head4 address2
+
+Suite number or other addressing information.
+
+=head4 address3
+
+Care of info or other addressing information.
+
+=head4 city
+
+The city that this address is in.
+
+=head4 state
+
+The state or province that this address is in.
+
+=head4 code 
+
+The postal code or zip code that this address is in.
+
+=head4 country
+
+The country that this address is in.
+
+=head4 phoneNumber
+
+A telephone number for this address. It is required by some shippers.
+
+=head4 addressBookId
+
+The address book that this address belongs to.
+
+=cut
+
+sub update {
+    my ($self, $newProperties) = @_;
+    my $id = id $self;
+    $properties{$id}{address2} = (exists $newProperties->{address2}) ? $newProperties->{address2} : $properties{$id}{address2};
+    $properties{$id}{address3} = (exists $newProperties->{address3}) ? $newProperties->{address3} : $properties{$id}{address3};
+    $properties{$id}{state} = (exists $newProperties->{state}) ? $newProperties->{state} : $properties{$id}{state};
+    $properties{$id}{code} = $newProperties->{code} || $properties{$id}{code};
+    $properties{$id}{city} = $newProperties->{city} || $properties{$id}{city};
+    $properties{$id}{label} = $newProperties->{label} || $properties{$id}{label};
+    $properties{$id}{name} = $newProperties->{name} || $properties{$id}{name};
+    $properties{$id}{country} = $newProperties->{country} || $properties{$id}{country};
+    $properties{$id}{address1} = $newProperties->{address1} || $properties{$id}{address1};
+    $properties{$id}{phoneNumber} = $newProperties->{phoneNumber} || $properties{$id}{phoneNumber};
+    $properties{$id}{addressBookId} = $self->addressBook->getId;
+    $self->addressBook->session->db->setRow("address","addressId",$properties{$id});
+}
+
+
+1;