Chirpy!

Latest Version: 0.3
Released: 2007-02-09

Chirpy! 0.2 API Documentation

<<
Chirpy::Quote

NAME

Chirpy::Quote - Represents a quote

SYNOPSIS

 $quote = new Chirpy::Quote(
     $id, $body, $notes, $rating, $submitted, $approved, $flagged, $tags);

 $id = $quote->get_id();
 $quote->set_id($id);

 $body = $quote->get_body();
 $quote->set_body($body);

 $notes = $quote->get_notes();
 $quote->set_notes($notes);

 $rating = $quote->get_rating();
 $quote->set_rating($rating);

 $submitted = $quote->get_date_submitted();
 $quote->set_date_submitted($submitted);

 $approved = $quote->get_approved();
 $quote->set_approved($approved);

 $flagged = $quote->get_flagged();
 $quote->set_flagged($flagged);
 
 $tags = $quote->get_tags();
 $quote->set_tags($tags);
 $quote->add_tag($tag);
 $quote->remove_tag($tag);

CONSTRAINTS

ID

The quote ID must be a positive non-zero integer.

Body

The quote body can be any text string.

Notes

The quote notes can be any text string, if any.

Rating

The quote rating must be an integer.

Submitted

The date when the quote was submitted must be a UNIX timestamp.

Approved

The quote approval status is 1 if the quote has been approved, 0 if it has not.

Flagged

The quote flag status is 1 if the quote has been reported, 0 if it has not.

AUTHOR

Tim De Pauw <ceetee@users.sourceforge.net>

SEE ALSO

Chirpy, http://chirpy.sourceforge.net/

COPYRIGHT

Copyright 2005-2006 Tim De Pauw. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.