the start of the inbox system for workflow, the rest will have to wait until we get some activities going

lib/WebGUI/Inbox.pm

@@ -0,0 +1,148 @@
+package WebGUI::Inbox;
+
+=head1 LEGAL
+
+ -------------------------------------------------------------------
+  WebGUI is Copyright 2001-2006 Plain Black Corporation.
+ -------------------------------------------------------------------
+  Please read the legal notices (docs/legal.txt) and the license
+  (docs/license.txt) that came with this distribution before using
+  this software.
+ -------------------------------------------------------------------
+  http://www.plainblack.com                     info@plainblack.com
+ -------------------------------------------------------------------
+
+=cut
+
+use strict;
+
+=head1 NAME
+
+Package WebGUI::Inbox;
+
+=head1 DESCRIPTION
+
+This class provides a message routing system, which is primarily used by WebGUI's workflow engine.
+
+=head1 SYNOPSIS
+
+ use WebGUI::Inbox;
+
+=head1 METHODS
+
+These methods are available from this class:
+
+=cut
+
+
+#-------------------------------------------------------------------
+
+=head2 addMessage ( )
+
+=cut 
+
+sub addMessage {
+	my $self = shift;
+	return WebGUI::Inbox::Message->create($self);
+}
+
+#-------------------------------------------------------------------
+
+=head2 DESTROY ( )
+
+Deconstructor.
+
+=cut
+
+sub DESTROY {
+        my $self = shift;
+        undef $self;
+}
+
+#-------------------------------------------------------------------
+
+=head2 getMessage ( messageId ) 
+
+Returns a WebGUI::Inbox::Message object.
+
+=head3 messageId
+
+The id of the message to retrieve.
+
+=cut
+
+sub getMessage {
+	my $self = shift;
+	return WebGUI::Inbox::Message->new($self->session, shift);
+}
+
+
+#-------------------------------------------------------------------
+
+=head2 getMessagesForUser ( user [ , limit ] )
+
+Returns an array reference containing the most recent message objects for a given user.
+
+=head3 user
+
+A user object.
+
+=head3 limit
+
+An integer indicating the number of messages to fetch. Defaults to 30.
+
+=cut
+
+sub getMessagesForUser {
+	my $self = shift;
+	my $user = shift;
+	my $limit = shift;
+	my @messages = ();
+	my $counter = 0;
+	my $rs = $self->session->db->read("select messageId, userId, groupId from inbox order by status='pending', dateStamp");
+	while (my ($messageId, $userId, $groupId) = $rs->array) {
+		if ($user->userId eq $userId || $user->isInGroup($groupId)) {
+			push(@messages, $self->getMessage($messageId));
+			$counter++;
+		}
+		last if ($counter >= $limit);
+	}
+	$rs->finish;
+	return \@messages;	
+}
+
+
+#-------------------------------------------------------------------
+
+=head2 new ( session )
+
+Constructor.
+
+=head3 session
+
+A reference to the current session.
+
+=cut
+
+sub new {
+	my $class = shift;
+	my $session = shift;
+	bless {_session=>$session}, $class;
+}
+
+#-------------------------------------------------------------------
+
+=head2 session
+
+Returns a reference to the current session.
+
+=cut
+
+sub session {
+	my $self = shift;
+	return $self->{_session};
+}
+
+
+1;
+