Yawns::Comment::Notifier

• NAME
• SYNOPSIS
• DESCRIPTION
  • new
  • sendNotification
  • getNotificationKeys
  • getNotificationMethod
  • deleteNotifications
  • setupNewUser
  • save
  • articleReply
  • commentReply
  • weblogReply
  • invalidateCache
• AUTHOR
• LICENSE

NAME

Yawns::Comment::Notifier - Alert a user of a comment reply.

SYNOPSIS

    #!/usr/bin/perl -w

    use Yawns::Comment::Notifier;
    use strict;

    my $alert = Yawns::Comment::Notifier->new( article => 1,
                                               comment => 0 );

    $alert->send();

DESCRIPTION

This module contains code for notifying a user that there is a comment posted, either:

  * In reply to a comment they left upon the site.
  * In reply to a weblog entry they made.
  * In reply to an article they wrote.

new

  Create a new instance of this object.

sendNotification

  This routine is invoked when a new comment is posted upon the site,
 it is responsible for sending out a notification email or message.

  This depends upon the preferences of the recipient.

getNotificationKeys

  Return the keys we have available for notication use.

  This is used for cache cleaning, and testing.

getNotificationMethod

  See if the user wants the given notifications

deleteNotifications

  Delete any notification options for the given user.

setupNewUser

  Setup the default options for a new user.

save

  Save updated preferences

articleReply

  Process a comment which has been posted in response to an article.

commentReply

  Reply to a posted comment

weblogReply

  Reply to a weblog entry

invalidateCache

  Clean any cached content we might have.

AUTHOR

Steve Kemp

http://www.steve.org.uk/

LICENSE

Copyright (c) 2005,2006 by Steve Kemp. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The LICENSE file contains the full text of the license.