NAME

AnnoCPAN::DBI - AnnoCPAN model class (database access module)

SYNOPSIS

use AnnoCPAN::DBI;
my @pods = AnnoCPAN::DBI::Pod->search(name => 'My::Module');
# etc...

DESCRIPTION

This is a collection of classes based on Class::DBI, used for representing the AnnoCPAN data. Warning: Some of the documentation here is incomplete.

CLASSES

AnnoCPAN::DBI

The base class; based on Class::DBI.

AnnoCPAN::DBI::Dist

Represents a distribution (regardless of version); has the following columns:

id
name
rating
review_count
creation_time

AnnoCPAN::DBI::Pod

Represents a document (typically a module, but it may be some other .pod file), regardless of version. Columns:

id
name

AnnoCPAN::DBI::PodDist

Links a pod with a dist (its a many-to-many relationship). Columns:

id 
dist 
pod

AnnoCPAN::DBI::DistVer

Represents a specific version of a distribution Columns:

id
dist 
version 
path 
pause_id 
distver 
mtime

AnnoCPAN::DBI::PodVer

Represents a specific version of a document (a "pod"). Columns:

id
pod
distver
path
description
html

AnnoCPAN::DBI::Section

Represents a paragraph in a POD document. Columns:

id
podver
pos
content
type 

AnnoCPAN::DBI::User

Represents an AnnoCPAN user. Columns:

id
username
password
name
email
profile 
reputation
member_since
last_visit
privs

Note that some of these columns are unused, but they exist for historical reasons.

Other Methods:

$user->can_delete($note)

Return true if the user has the authority to delete $note (an AnnoCPAN::DBI::Note object).

$user->can_edit($note)

Return true if the user has the authority to edit $note (an AnnoCPAN::DBI::Note object).

$user->can_move($note)

Return true if the user has the authority to move $note (an AnnoCPAN::DBI::Note object).

AnnoCPAN::DBI::Note

Represents a note. Columns:

id
pod
min_ver
max_ver
note
ip
time
score
user
section

Note that some of these columns are unused, but they exist for historical reasons.

SEE ALSO

AnnoCPAN::Control, AnnoCPAN::Config

AUTHOR

Ivan Tubert-Brohman <itub@cpan.org>

COPYRIGHT

Copyright (c) 2005 Ivan Tubert-Brohman. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm AnnoCPAN

perl -MCPAN -e shell
install AnnoCPAN