/ 
WWW-USF-Directory-0.003001
River stage zero No dependents
/ WWW::USF::Directory::Entry

NAME

WWW::USF::Directory::Entry - An entry in the USF online directory

VERSION

This documentation refers to version 0.003001

SYNOPSIS

# Print the family name
say $entry->family_name;

DESCRIPTION

This represents an entry in the USF online directory. These objects are typically created by WWW::USF::Directory.

CONSTRUCTOR

This is fully object-oriented, and as such before any method can be used, the constructor needs to be called to create an object to work with.

new

This will construct a new object.

new(%attributes)

%attributes is a HASH where the keys are attributes (specified in the "ATTRIBUTES" section).

new($attributes)

$attributes is a HASHREF where the keys are attributes (specified in the "ATTRIBUTES" section).

ATTRIBUTES

# Set an attribute
$object->attribute_name($new_value);

# Get an attribute
my $value = $object->attribute_name;

affiliations

This is the list of affiliations to USF as WWW::USF::Directory::Entry::Affiliation objects.

campus

This is the campus the entry is affiliated with.

campus_mailstop

This is the mailstop for he entry on campus.

campus_phone

This is the campus phone number.

college

This is the college the entry is affiliated with.

email

This is the e-mail address.

family_name

This is the family name.

first_name

This is the first name.

given_name

This is the given name.

middle_name

This is the middle name.

METHODS

full_name

This will return the full name, which is the given name and the family name joined with a space.

has_campus

This returns a Boolean of if the "campus" attribute is set.

has_campus_mailstop

This returns a Boolean of if the "campus_mailstop" attribute is set.

has_campus_phone

This returns a Boolean of if the "campus_phone" attribute is set.

has_college

This returns a Boolean of if the "college" attribute is set.

has_email

This returns a Boolean of if the "email" attribute is set.

has_middle_name

This returns a Boolean of if the "middle_name" attribute is set.

DEPENDENCIES

AUTHOR

Douglas Christopher Wilson, <doug at somethingdoug.com>

BUGS AND LIMITATIONS

Please report any bugs or feature requests to bug-www-usf-directory at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-USF-Directory. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WWW::USF::Directory

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2010 Douglas Christopher Wilson, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of either:

  • the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or

  • the Artistic License version 2.0.