[prev] [thread] [next] [lurker] [Date index for 2002/08/25]
Update of /cvsroot/siesta/siesta/lib/Siesta
In directory usw-pr-cvs1:/tmp/cvs-serv7087
Modified Files:
List.pm
Log Message:
added some docs while i wait for the roast chicken to finish cooking
Index: List.pm
===================================================================
RCS file: /cvsroot/siesta/siesta/lib/Siesta/List.pm,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -d -r1.16 -r1.17
--- List.pm 23 Aug 2002 11:07:01 -0000 1.16
+++ List.pm 25 Aug 2002 15:07:58 -0000 1.17
@@ -8,6 +8,8 @@
The List object for the Sierra system.
+=head1 METHODS
+
=cut
package Siesta::List;
@@ -20,9 +22,11 @@
use Siesta::Storage::Table::List_Users;
use Siesta::Storage::Table::List_Plugins;
+=head2 new(id)
-# this is actually performing more like load at the minute
-# bad me, no cookie! - greg
+This is actually performing more like load at the minute.
+
+=cut
sub new {
my $class = shift;
@@ -42,6 +46,14 @@
return bless $results[0], $class;
}
+=head2 is_member(member)
+
+Returns true or false depending if member is a member of this
+list. This can take either a User object or an email address (the
+primary key for users).
+
+=cut
+
sub is_member {
my $self = shift;
my $member = shift;
@@ -51,6 +63,12 @@
return scalar(@results);
}
+=head2 add_member(member)
+
+Adds a member to a list - This is not currently working
+
+=cut
+
sub add_member {
my $self = shift;
my ($member) = @_;
@@ -63,6 +81,12 @@
}
}
+=head2 remove_member(member)
+
+Removes a member from a list.
+
+=cut
+
sub remove_member {
my $self = shift;
my ($member) = @_;
@@ -76,6 +100,11 @@
return;
}
+=head2 members()
+
+Returns a list of all the members in the list (as User objects)
+
+=cut
sub members {
my $self = shift;
@@ -88,6 +117,12 @@
@results = map { Siesta::User->new($_->user_id()) } @results;
return @results;
}
+
+=head2 plugins()
+
+Returns a list of all the plugins for a list.
+
+=cut
sub plugins {
my $self = shift;
Generated at 13:57 on 01 Jul 2004 by mariachi 0.52