changed POD formatting
This commit is contained in:
JT Smith
parent
bf5a0145ae
commit
2b6eb201a9
55 changed files with 1188 additions and 3220 deletions
|
|
@ -68,14 +68,10 @@ These methods are available from this class:
|
|||
|
||||
Returns a boolean whether the user has the privileges required to post.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
Defaults to $session{user}{userId}. Specify a user ID to check privileges for.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub canPost {
|
||||
|
|
@ -90,14 +86,10 @@ sub canPost {
|
|||
|
||||
Returns a boolean whether the user has the privileges required to view the forum.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
Defaults to $session{user}{userId}. Specify a user ID to check privileges for.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub canView {
|
||||
|
|
@ -112,9 +104,7 @@ sub canView {
|
|||
|
||||
Creates a new forum. Returns a forum object.
|
||||
|
||||
=over
|
||||
|
||||
=item forumParams
|
||||
=head3 forumParams
|
||||
|
||||
A hash reference containing a list of the parameters to default the forum to. The valid parameters are:
|
||||
|
||||
|
|
@ -138,8 +128,6 @@ archiveAfter - interval
|
|||
postsPerPage - integer
|
||||
masterForumId - Forum ID
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub create {
|
||||
|
|
@ -181,14 +169,10 @@ sub decrementThreads {
|
|||
|
||||
Returns a hash reference containing all of the properties of the forum.
|
||||
|
||||
=over
|
||||
|
||||
=item param
|
||||
=head3 param
|
||||
|
||||
If specified then this method will return the value of this one parameter as a scalar. Param is the name of the parameter to return. See the forum table for details.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub get {
|
||||
|
|
@ -205,14 +189,10 @@ sub get {
|
|||
|
||||
Returns a thread object.
|
||||
|
||||
=over
|
||||
|
||||
=item threadId
|
||||
=head3 threadId
|
||||
|
||||
The unique identifier of a thread in this forum.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub getThread {
|
||||
|
|
@ -229,14 +209,10 @@ sub getThread {
|
|||
|
||||
Returns a boolean indicating whether the user is a moderator.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
Defaults to $session{user}{userId}. A user id to test for moderator privileges.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub isModerator {
|
||||
|
|
@ -251,18 +227,14 @@ sub isModerator {
|
|||
|
||||
Increments this forum's reply counter.
|
||||
|
||||
=over
|
||||
|
||||
=item lastPostDate
|
||||
=head3 lastPostDate
|
||||
|
||||
The date of the post being added.
|
||||
|
||||
=item lastPostId
|
||||
=head3 lastPostId
|
||||
|
||||
The unique identifier of the post being added.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub incrementReplies {
|
||||
|
|
@ -276,18 +248,14 @@ sub incrementReplies {
|
|||
|
||||
Increments the thread counter for this forum.
|
||||
|
||||
=over
|
||||
|
||||
=item lastPostDate
|
||||
=head3 lastPostDate
|
||||
|
||||
The date of the post that was just added.
|
||||
|
||||
=item lastPostId
|
||||
=head3 lastPostId
|
||||
|
||||
The unique identifier of the post that was just added.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub incrementThreads {
|
||||
|
|
@ -314,14 +282,10 @@ sub incrementViews {
|
|||
|
||||
Returns a boolean indicating whether the user is subscribed to the forum.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The user to check for the subscription. Defaults to $session{user}{userId}.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub isSubscribed {
|
||||
|
|
@ -337,14 +301,10 @@ sub isSubscribed {
|
|||
|
||||
Constructor.
|
||||
|
||||
=over
|
||||
|
||||
=item forumId
|
||||
=head3 forumId
|
||||
|
||||
The unique identifier of the forum to retrieve the object for.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
|
|
@ -428,14 +388,10 @@ sub recalculateRating {
|
|||
|
||||
Sets the forum properties both in the object and to the database.
|
||||
|
||||
=over
|
||||
|
||||
=item data
|
||||
=head3 data
|
||||
|
||||
A hash reference containing the properties to set. See the forum table for details.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub set {
|
||||
|
|
@ -453,18 +409,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 {
|
||||
|
|
@ -481,14 +433,10 @@ sub setLastPost {
|
|||
|
||||
Subscribes a user to this forum.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The unique identifier of the user to subscribe. Defaults to the current user.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub subscribe {
|
||||
|
|
@ -505,14 +453,10 @@ sub subscribe {
|
|||
|
||||
Unsubscribes a user from this forum.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The unique identifier 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