changed POD formatting
This commit is contained in:
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 indicating whether the user can edit the current post.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The unique identifier to check privileges against. Defaults to the current user.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub canEdit {
|
||||
|
|
@ -91,14 +87,10 @@ sub canEdit {
|
|||
|
||||
Returns a boolean indicating whether the user can view the current post.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The unique identifier to check privileges against. Defaults to the current user.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub canView {
|
||||
|
|
@ -123,14 +115,10 @@ sub canView {
|
|||
|
||||
Creates a new post.
|
||||
|
||||
=over
|
||||
|
||||
=item data
|
||||
=head3 data
|
||||
|
||||
A hash reference containing the data to use to create the post. See the forumPost table for details.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub create {
|
||||
|
|
@ -148,14 +136,10 @@ sub create {
|
|||
|
||||
Returns a hash reference containing all of the parameters of this post.
|
||||
|
||||
=over
|
||||
|
||||
=item param
|
||||
=head3 param
|
||||
|
||||
The name of a parameter to get. If specified then the method will return only the value for this parameter as a scalar.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub get {
|
||||
|
|
@ -214,18 +198,14 @@ sub getThread {
|
|||
|
||||
Returns a boolean indicating whether this user has already rated this post.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
A unique identifier for a user to check. Defaults to the current user.
|
||||
|
||||
=item ipAddress
|
||||
=head3 ipAddress
|
||||
|
||||
If the user ID equals 1 (visitor) then an IP address is used to distinguish the user. Defaults to the current user's ip address.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub hasRated {
|
||||
|
|
@ -259,14 +239,10 @@ sub incrementViews {
|
|||
|
||||
Returns a boolean indicating whether this post is marked read for the user.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
A unique id for a user that you want to check. Defaults to the current user.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub isMarkedRead {
|
||||
|
|
@ -299,14 +275,10 @@ sub isReply {
|
|||
|
||||
Marks this post read for this user.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
A unique identifier for a user. Defaults to the current user.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub markRead {
|
||||
|
|
@ -325,14 +297,10 @@ sub markRead {
|
|||
|
||||
Constructor.
|
||||
|
||||
=over
|
||||
|
||||
=item postId
|
||||
=head3 postId
|
||||
|
||||
The unique identifier for the post object you wish to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
|
|
@ -351,22 +319,18 @@ sub new {
|
|||
|
||||
Stores a rating against this post.
|
||||
|
||||
=over
|
||||
|
||||
=item rating
|
||||
=head3 rating
|
||||
|
||||
An integer between 1 and 5 (5 being best) to rate this post with.
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The unique id for the user rating this post. Defaults to the current user.
|
||||
|
||||
=item ipAddress
|
||||
=head3 ipAddress
|
||||
|
||||
The ip address of the user doing the rating. Defaults to the current user's IP.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub rate {
|
||||
|
|
@ -402,14 +366,10 @@ sub recalculateRating {
|
|||
|
||||
Sets properties to the database and the object.
|
||||
|
||||
=over
|
||||
|
||||
=item data
|
||||
=head3 data
|
||||
|
||||
A hash reference containing the properties to set. See the forumPost table for details.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
|
|
@ -511,14 +471,10 @@ sub setStatusPending {
|
|||
|
||||
Negates the markRead method.
|
||||
|
||||
=over
|
||||
|
||||
=item userId
|
||||
=head3 userId
|
||||
|
||||
The unique id of the user marking unread. Defaults to the current user.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub unmarkRead {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue