JSAN::Index::Author - A JavaScript Archive Network (JSAN) Author
This class provides objects that represent authors in the JSAN::Index.
In addition to the general methods provided by ORLite, this class has the following additional methods.
The login accessor returns the JSAN author code/login for the author.
login
The name accessor returns the full name of the author.
name
The doc accessor returns the root-relative documentation path for the author on any http://openjsan.org/ mirror.
doc
The email accessor returns the public email address for the author.
email
The url acessor returns the uri for the authors homepage as a string.
url
The releases method finds and retrieves all of the releases for an author.
releases
Returns a list of JSAN::Index::Release objects.
Bugs should be reported via the CPAN bug tracker at
http://rt.cpan.org/NoAuth/ReportBug.html?Queue=JSAN-Client
For other issues, contact the author.
Adam Kennedy <adamk@cpan.org>
JSAN::Index, JSAN::Shell, http://openjsan.org
Copyright 2005 - 2007 Adam Kennedy.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.
JSAN::Index::Author - JSAN::Index class for the author table
TO BE COMPLETED
# Get all objects in list context my @list = JSAN::Index::Author->select; # Get a subset of objects in scalar context my $array_ref = JSAN::Index::Author->select( 'where login > ? order by login', 1000, );
The select method executes a typical SQL SELECT query on the author table.
select
SELECT
It takes an optional argument of a SQL phrase to be added after the FROM author section of the query, followed by variables to be bound to the placeholders in the SQL phrase. Any SQL that is compatible with SQLite can be used in the parameter.
FROM author
Returns a list of JSAN::Index::Author objects when called in list context, or a reference to an ARRAY of JSAN::Index::Author objects when called in scalar context.
ARRAY
Throws an exception on error, typically directly from the DBI layer.
# How many objects are in the table my $rows = JSAN::Index::Author->count; # How many objects my $small = JSAN::Index::Author->count( 'where login > ?', 1000, );
The count method executes a SELECT COUNT(*) query on the author table.
count
SELECT COUNT(*)
Returns the number of objects that match the condition.
if ( $object->login ) { print "Object has been inserted\n"; } else { print "Object has not been inserted\n"; }
Returns true, or throws an exception on error.
REMAINING ACCESSORS TO BE COMPLETED
The author table was originally created with the following SQL command.
CREATE TABLE author ( login varchar ( 100 ) NOT NULL, name varchar ( 100 ) NOT NULL, doc varchar ( 100 ) NOT NULL, email varchar ( 100 ) NOT NULL, url varchar ( 100 ) , PRIMARY KEY ( login ) )
JSAN::Index::Author is part of the JSAN::Index API.
See the documentation for JSAN::Index for more information.
Copyright 2009 - 2010 Adam Kennedy.
To install JSAN::Client, copy and paste the appropriate command in to your terminal.
cpanm
cpanm JSAN::Client
CPAN shell
perl -MCPAN -e shell install JSAN::Client
For more information on module installation, please visit the detailed CPAN module installation guide.