Next:
Yawns::Tags
Previous:
Yawns::Submission::Notes
 [Table of Contents]

Yawns::Submissions



NAME

Yawns::Submission - A module for interfacing with queued polls/articles

SYNOPSIS

    #!/usr/bin/perl -w

    use Yawns::Submissions;
    use strict;

    my $queue = Yawns::Submissions->new();

    #
    # Get counts of pending things.
    #
    my $articles = $queue->articleCount();
    my $polls    = $queue->pollCount();

DESCRIPTION

This module will interface with the submissions queue, allowing the number of polls and articles in the queues to be determined and worked with.

new

  Create a new instance of this object.

maxID

  Return the maximum ID of the submissions.

articleCount

  Find and return the number of pending articles in the queue.

articleCountByUsername

  Find and return the number of pending articles in the queue by the given
 user.

articlesByUser

  Return a hash-ref of all the articles that the given user
 has posted.

getArticleAuthor

  Return the author of the submitted article with the given ID, this is
 used to see if a logged in user may edit the given submission.

pollCount

  Find and return the number of pending polls in the submission queue.

getPolls

  Return all the polls in the submission queue.

getArticleOverview

  Return the name, title, author and lead text off a pending article.

  This is used for the submissions list.

getArticleFeed

  Return all the pending submissions in a form suitable for use in an
 RSS feed.

  This correctly escapes the HTML in the submission title and body.

addArticle

  Add a new article to the article queue.

getSubmission

  Return details about the specified submission.

getSubmissionNotes

  Get the notes associated with the given submission.

addSubmissionNote

  Add a note to a submission

updateSubmission

  Update an article in the submissions queue.  This means that we'll
 change the text, title, etc.

sendMail

  Send the site administrator an email telling them of the new article
 submission.

rejectArticle

  Reject an article from the submissions queue - it is silently deleted.

postArticle

  Post an article from the submissions queue to the front page.

addPoll

  Add a new poll to the submissions queue.

rejectPoll

  Delete a pending poll from the queue.

editPendingPoll

  Edit a pending poll

getPendingPoll

  Get the given pending poll details from the submission queue.

postPoll

  Post a poll from the pending queue onto the live site.

invalidateCache

  Clean any cached content we might have.

AUTHOR

Steve Kemp

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

LICENSE

Copyright (c) 2005-2007 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.


[Top] Generated by HTML::FromPod 0.49 on Fri Nov 21 03:03:58 2008