changed POD formatting
This commit is contained in:
parent
bf5a0145ae
commit
2b6eb201a9
55 changed files with 1188 additions and 3220 deletions
|
|
@ -75,18 +75,14 @@ These methods are available from this class:
|
|||
|
||||
Creates a new thread, including the root post in that thread.
|
||||
|
||||
=over
|
||||
|
||||
=item data
|
||||
=head3 data
|
||||
|
||||
The properties of this thread. See the forumThread table for details.
|
||||
|
||||
=item postData
|
||||
=head3 postData
|
||||
|
||||
The properties of the root post in this thread. See the forumPost table and the WebGUI::Forum::Post->create method for details.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub create {
|
||||
|
|
@ -126,14 +122,10 @@ sub decrementReplies {
|
|||
|
||||
Returns a hash reference containing all the properties of this thread.
|
||||
|
||||
=over
|
||||
|
||||
=item param
|
||||
=head3 param
|
||||
|
||||
The name of a specific property. If specified only the value of that property will be return as a scalar.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub get {
|
||||
|
|
@ -184,14 +176,10 @@ sub getNextThread {
|
|||
|
||||
Returns a post object.
|
||||
|
||||
=over
|
||||
|
||||
=item postId
|
||||
=head3 postId
|
||||
|
||||
The unique id of the post object you wish to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub getPost {
|
||||
|
|
@ -239,18 +227,14 @@ sub isLocked {
|
|||
|
||||
Increments the replies counter for this thread.
|
||||
|
||||
=over
|
||||
|
||||
=item lastPostDate
|
||||
=head3 lastPostDate
|
||||
|
||||
The date of the reply that caused the replies counter to be incremented.
|
||||
|
||||
=item lastPostId
|
||||
=head3 lastPostId
|
||||
|
||||
The id of the reply that caused the replies counter to be incremented.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub incrementReplies {
|
||||
|
|
@ -293,14 +277,10 @@ sub isSticky {
|
|||
|
||||
Returns a boolean indicating whether the user is subscribed to this thread.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The unique id of the user to check. Defaults to the current user.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub isSubscribed {
|
||||
|
|
@ -330,14 +310,10 @@ sub lock {
|
|||
|
||||
Constructor.
|
||||
|
||||
=over
|
||||
|
||||
=item threadId
|
||||
=head3 threadId
|
||||
|
||||
The unique id of the thread object you wish to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
|
|
@ -374,14 +350,10 @@ sub recalculateRating {
|
|||
|
||||
Sets properties for this thread both to the object and to the database.
|
||||
|
||||
=over
|
||||
|
||||
=item data
|
||||
=head3 data
|
||||
|
||||
A hash reference containing the properties to set. See the forumThread table for details.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub set {
|
||||
|
|
@ -399,18 +371,14 @@ sub set {
|
|||
|
||||
Sets the pertinent details for the last post. Can also be done directly using the set method.
|
||||
|
||||
=over
|
||||
|
||||
=item lastPostDate
|
||||
=head3 lastPostDate
|
||||
|
||||
The epoch date of the post.
|
||||
|
||||
=item lastPostId
|
||||
=head3 lastPostId
|
||||
|
||||
The unique id of the post.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub setLastPost {
|
||||
|
|
@ -507,14 +475,10 @@ sub stick {
|
|||
|
||||
Subscribes the user to this thread.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The unique id of the user. Defaults to the current user.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub subscribe {
|
||||
|
|
@ -557,14 +521,10 @@ sub unstick {
|
|||
|
||||
Negates the subscribe method.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The unique id of the user to unsubscribe. Defaults to the current user.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub unsubscribe {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue