Skip to content

bugzilla
bugzilla
Switch branch/tag
Find file
Normal viewHistoryPermalink
Whine.pm 2.34 KB
Newer Older
Frédéric Buclin's avatar
Bug 680131: Replace the MPL 1.1 license by the MPL 2.0 one in all files, and add…
fe2a998b
 
Frédéric Buclin committed
1 2 3 
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
Eric Black's avatar
Bug 530468: Create a read-only Bugzilla::Whine object for whine events and
4e7c28de
 
Eric Black committed
4 
#
Frédéric Buclin's avatar
Bug 680131: Replace the MPL 1.1 license by the MPL 2.0 one in all files, and add…
fe2a998b
 
Frédéric Buclin committed
5 6 
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.
Eric Black's avatar
Bug 530468: Create a read-only Bugzilla::Whine object for whine events and
4e7c28de
 
Eric Black committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 

use strict;

package Bugzilla::Whine;

use base qw(Bugzilla::Object);

use Bugzilla::Constants;
use Bugzilla::Error;
use Bugzilla::User;
use Bugzilla::Util;
use Bugzilla::Whine::Schedule;
use Bugzilla::Whine::Query;

#############
# Constants #
#############

use constant DB_TABLE => 'whine_events';

use constant DB_COLUMNS => qw(
    id
    owner_userid
    subject
    body
    mailifnobugs
);

use constant LIST_ORDER => 'id';

####################
# Simple Accessors #
####################
sub subject         { return $_[0]->{'subject'};      }
sub body            { return $_[0]->{'body'};         }
sub mail_if_no_bugs { return $_[0]->{'mailifnobugs'}; }

sub user {
    my ($self) = @_;
    return $self->{user} if defined $self->{user};
    $self->{user} = new Bugzilla::User($self->{'owner_userid'});
    return $self->{user};
}

1;

__END__

=head1 NAME

Bugzilla::Whine - A Whine event

=head1 SYNOPSIS

 use Bugzilla::Whine;

 my $event = new Bugzilla::Whine($event_id);

 my $subject      = $event->subject;
 my $body         = $event->body;
 my $mailifnobugs = $event->mail_if_no_bugs;
 my $user         = $event->user;

=head1 DESCRIPTION

This module exists to represent a whine event that has been
saved to the database.

This is an implementation of L<Bugzilla::Object>, and so has all the
same methods available as L<Bugzilla::Object>, in addition to what is
documented below.

=head1 METHODS

=head2 Constructors

=over

=item C<new>

Does not accept a bare C<name> argument. Instead, accepts only an id.

See also: L<Bugzilla::Object/new>.

=back


=head2 Accessors

These return data about the object, without modifying the object.

=over

=item C<subject>

Returns the subject of the whine event.

=item C<body>

Returns the body of the whine event.

=item C<mail_if_no_bugs>

Returns a numeric 1(C<true>) or 0(C<false>) to represent whether this
whine event object is supposed to be mailed even if there are no bugs
returned by the query.

=item C<user>

Returns the L<Bugzilla::User> object for the owner of the L<Bugzilla::Whine>
event.

=back