root/Trunk/WebGUI/Macros/RecentThreads.pm

package WebGUI::Macro::RecentThreads;

#-------------------------------------------------------------------
# WebGUI is Copyright 2001-2005 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
#-------------------------------------------------------------------

use strict;
use WebGUI::Asset::Template;
use WebGUI::Asset::Wobject::Collaboration;

=head1 NAME

Package WebGUI::Macro::RecentPosts

=head1 DESCRIPTION

Macro for displaying the latest X posts in one or more collaboration systems.

=head2 process ( assetId,templateId [,numPosts,orderByField,descendingOrder,summaryField,dateField] )

process takes 2 required parameters and 5 optional ones.

=head3 assetId

The assetId of the parent of the collaboration system(s) from which recent
posts should be pulled. If only pulling from one CS, you can specify its assetId directly.

=head3 templateId

The templateId of the template the recent posts should be displayed in.

=head3 numPosts

The number of recent posts to pull; default is 3.

=head3 orderByVar

The name of the *template* variable to order the posts by; default is none.
        (i.e. 'post_url', 'post_title', 'post_epoch_date', 'post_date' or 'post_username')

=head3 descendingOrder

If set to a true value (i.e. 1), posts will be in descending order.

=head3 summaryField

The name of the field to use for the summary; default is none.

=head3 dateField

The name of the field to get the date of the post from; default is dateSubmitted.

=cut

#-------------------------------------------------------------------
sub process {
        my $session = shift;
        my $parentAssetId = shift;
        my $templateId = shift;
        my $numPosts = shift;
        $numPosts ||= 3;
        my $orderByVar = shift;
        my $descendingOrder = shift;
        my $summaryField = shift;
        my $dateField = shift;
        # !!!!!!
        #$dateField ||= 'dateSubmitted';
        $dateField ||= 'revisionDate';
        # !!!!!!
        my %var;
        my @postLoop;
        my $cs = WebGUI::Asset->newByDynamicClass($session,$parentAssetId);
        my $threads = $cs->getLineage(["descendants"],{returnObjects=>1});
        foreach my $thread (@$threads) {
                my $class = ref ( $thread );
                next unless ($class eq 'WebGUI::Asset::Post::Thread');
                my $post = $thread->getPosts();
                my $post = $post->[0]; # there should only be one thread in these CS's
                # next unless ($post->get("state") eq "published");
                next unless ($post->get("status") eq "approved");
                my $epochDate;
                my $date = $post->get($dateField);
                if ($date =~ /^\d{4}-\d{2}-\d{2}/) {
                        $epochDate = $session->datetime->setToEpoch($date);
                } else {
                        $epochDate = $date;
                }
                #return "dateField: $dateField<br />epochDate: $epochDate";
                my $humanDate = $session->datetime->epochToHuman($epochDate,"%M/%D/%y @ %H:%n %p");
                my %varHash = (
                        'post_url' => $post->getUrl,
                        'post_title' => $post->get("title"),
                        'post_epoch_date' => $epochDate,
                        'post_date' => $humanDate,
                        # !!!!!!
                        #'post_thumbnail' => $post->getThumbnailUrl,
                        #'post_userDefined1' => $post->get("userDefined1"),
                        #'post_userDefined2' => $post->get("userDefined2"),
                        #'post_userDefined3' => $post->get("userDefined3"),
                        #'post_userDefined4' => $post->get("userDefined4"),
                        #'post_userDefined5' => $post->get("userDefined5")
                        'post_username' => $post->get("username"),
                        #'post_posterprofileurl' => $post->getPosterProfileUrl
                        # !!!!!!
                );
                if ($summaryField) {
                        $varHash{'post_summary'} = $post->get($summaryField);
                }
                push (@postLoop, \%varHash);
        }
        my @sortedPostLoop;
        if ($orderByVar) {
                if ($descendingOrder) {
                        #return "Descending order!";
                        @sortedPostLoop = sort {$b->{$orderByVar} <=> $a->{$orderByVar}} @postLoop;
                } else {
                        @sortedPostLoop = sort {$a->{$orderByVar} <=> $b->{$orderByVar}} @postLoop;
                }
        } else {
                @sortedPostLoop = @postLoop;
        }
        my @returnPostLoop;
        if ($numPosts <= $#sortedPostLoop) {
                @returnPostLoop = @sortedPostLoop[0..($numPosts-1)];
        } else {
                @returnPostLoop = @sortedPostLoop;
        }
        $var{postLoop} = \@returnPostLoop;
        return WebGUI::Asset::Template->new($session,$templateId)->process(\%var);
}

1;