Myco::Entity::SampleEntityAddress - Myco Addresses.
Index
Code Index:
NAME
Myco::Entity::SampleEntityAddress - Myco Addresses.
SYNOPSIS
use Myco::User;
# Constructors.
my $addr = Myco::Entity::SampleEntityAddress->new;
# See Myco::Entity for more.
# Instance Methods.
my $address_key = $addr->get_address_key;
$addr->set_address_key($address_key);
my $street = $addr->get_street;
$addr->set_street($street);
my $city = $addr->get_city;
$addr->set_city($city);
my $state = $addr->get_state;
$addr->set_state($state);
my $zip = $addr->get_zip;
$addr->set_zip($zip);
my $country = $addr->get_country;
$addr->set_country($country);
$addr->save;
$addr->destroy;
DESCRIPTION
This class, along with Myco::Entity::SampleEntityBase
and Myco::Entity::SampleEntityAddress,
provide the basis for all tests provided with the core myco system.
Objects of this class represent addresses in Myco - in fact, the entire class
is a ripoff of Myco::Address. In addition to the typical address parts each
also has a value called "address_key". This value must be unique across all
addresses for a given person, though different persons can have the same
address_key.
CONSTRUCTORS
ATTRIBUTES
Attributes may be initially set during object construction (with new()) but
otherwise are accessed solely through accessor methods. Typical usage:
-
set
$obj->set_attr($value);
This method sets the value of the "attr" attribute. These methods, implemented
by Class::Tangram, perform data validation. If there is any
concern that the set method might be called with invalid data then the call
should be wrapped in an eval block to catch exceptions that would result.
-
get
$value = $obj->get_attr;
This method returns the value of the "attr" attribute.
A listing of available attributes follows:
address_key
type: string(32) default value: 'home'
A short descripter that uniquely describes an address on a per-person bases.
All addresses associated with a single person must have different address_keys,
but different people can have the same address_key. The address_key is stored
internally in lowercase, so address_key matches are case-insensitive.
street
type: string(159)
The street portion of the address. May be multiple lines by using new line
characters.
city
type: string(128)
The address city.
state
type: string(2)
The address state or province.
zip
type: string(16)
The address postal code.
country
type: string(64)
The address country. preferrably specified as an ISO 3166-1 two-letter code.
LICENSE AND COPYRIGHT
Copyright (c) 2006 the myco project. All rights reserved.
This software is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
AUTHOR
David Wheeler <david@wheeler.net>
SEE ALSO
Myco::Entity,
Tangram,
Class::Tangram,
Lingua::Strfname (Lingua::Strname).
package Myco::Entity::SampleEntityAddress;
##############################################################################
# $Id: SampleEntityAddress.pm,v 1.5 2006/02/27 23:03:19 sommerb Exp $
#
# See license and copyright near the end of this file.
##############################################################################
##############################################################################
# Dependencies
##############################################################################
# Module Dependencies and Compiler Pragma
use strict;
use warnings;
use Myco::Exceptions;
##############################################################################
# Programmatic Dependences
use Myco::Constants;
use Locale::SubCountry;
##############################################################################
# Inheritance & Introspection
##############################################################################
use base qw(Myco::Entity);
my $md = Myco::Entity::Meta->new
( name => __PACKAGE__,
tangram => { table => 'sample_entity_address' },
ui => {
displayname => 'address_key',
list => { layout => [qw(__DISPLAYNAME__ city state country)] },
view => { layout => [qw(street city state zip country)] }
}
);
##############################################################################
# Function and Closure Prototypes
##############################################################################
# None.
##############################################################################
# Constants
##############################################################################
use constant DEBUG => 0;
use constant COUNTRY_CODES => scalar Myco::Constants->country_codes;
use constant LOCALE_US => scalar Locale::SubCountry->new('United States');
use constant LOCALE_Canada => scalar Locale::SubCountry->new('Canada');
##############################################################################
# Constructors
##############################################################################
$md->add_attribute( name => 'address_key',
type => 'string',
type_options => { string_length => 32 },
tangram_options => {
sql => 'VARCHAR(32) NOT NULL',
required => 1,
init_default => 'home',
},
ui => { options => { hidden => 1 } }
);
sub set_address_key { $_[0]->SUPER::set_address_key( lc $_[1] ) }
$md->add_attribute(name => 'street',
type => 'string',
type_options => { string_length => 159 },
ui => {
widget => [ 'textarea', -columns => 35, -rows => 1 ],
label => 'Street',
}
);
$md->add_attribute( name => 'city',
type => 'string',
type_options => { string_length => 128 },
ui => {
widget => [ 'textfield', -size => 15, ],
label => 'City',
},
);
# Remove 'MA' to put it up front. Word to my homies from da Bay State!
my %state_codes_hash = LOCALE_US->code_full_name_hash;
my %state_codes = map { $_ => 1 } LOCALE_US->all_codes;
delete $state_codes_hash{MA};
delete $state_codes{MA};
my @state_codes = keys %state_codes;
$md->add_attribute( name => 'state',
type => 'string',
type_options => { string_length => 64 },
values => [ '__select__',
'__blank__',
' ',
'__blank__',
'MA',
'__blank__',
@state_codes,
'__blank__',
LOCALE_Canada->all_codes,
'__blank__',
'__other__' ],
value_labels => { ' ' => 'NONE',
MA => 'Massachusetts',
%state_codes_hash,
LOCALE_Canada->code_full_name_hash,
},
ui => {
label => 'State/Province',
},
);
$md->add_attribute( name => 'zip',
type => 'string',
type_options => { string_length => 16 },
ui => {
label => 'Zip/Postal code',
widget => [ 'textfield', -size => 16, ],
},
);
$md->add_attribute( name => 'country',
type => 'string',
type_options => { string_length => 64 },
values => COUNTRY_CODES,
value_labels => { Myco::Constants->country_hash_by_code },
ui => {
options => { value_default => 'us' },
label => 'Country',
},
);
##############################################################################
$md->activate_class;
1;
__END__