Adam Kennedy > JSAN-Client-0.29 > JSAN::Index::Author

Download:
JSAN-Client-0.29.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  2
View/Report Bugs
Module Version: 0.29   Source  

NAME ^

JSAN::Index::Author - A JavaScript Archive Network (JSAN) Author

DESCRIPTION ^

This class provides objects that represent authors in the JSAN::Index.

METHODS ^

In addition to the general methods provided by ORLite, this class has the following additional methods.

login

The login accessor returns the JSAN author code/login for the author.

name

The name accessor returns the full name of the author.

doc

The doc accessor returns the root-relative documentation path for the author on any http://openjsan.org/ mirror.

email

The email accessor returns the public email address for the author.

url

The url acessor returns the uri for the authors homepage as a string.

releases

The releases method finds and retrieves all of the releases for an author.

Returns a list of JSAN::Index::Release objects.

SUPPORT ^

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.

AUTHOR ^

Adam Kennedy <adamk@cpan.org>

SEE ALSO ^

JSAN::Index, JSAN::Shell, http://openjsan.org

COPYRIGHT ^

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.

NAME ^

JSAN::Index::Author - JSAN::Index class for the author table

SYNOPSIS ^

  TO BE COMPLETED

DESCRIPTION ^

TO BE COMPLETED

METHODS ^

select

  # 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.

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.

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.

Throws an exception on error, typically directly from the DBI layer.

count

  # 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.

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.

Returns the number of objects that match the condition.

Throws an exception on error, typically directly from the DBI layer.

ACCESSORS ^

login

  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

SQL ^

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
      )
  )

SUPPORT ^

JSAN::Index::Author is part of the JSAN::Index API.

See the documentation for JSAN::Index for more information.

COPYRIGHT ^

Copyright 2009 - 2010 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.

syntax highlighting: