BZ::Cl...omment(3pm)

📦
version 4.9100 · 4 versions
, in epel 10

💖 BZ::Client::Bug::Comment 💖

okay bestie, welcome to the perl doc for BZ::Client::Bug::Comment, which lives in the BZ::Cl...omment(3pm) manual page — it's giving "client-side representation of a Comment on a Bug in Bugzilla" and honestly? iconic.

VERSION: version 4.91 ✨

🌸 SYNOPSIS 🌸

so this class is literally your whole comment-management bestie — it provides methods for accessing and managing comments in Bugzilla. Instances of this class are returned by BZ::Client::Bug::Comment::get.

my $client = BZ::Client->new( url       => $url,
                              user      => $user,
                              password  => $password );

my $comments = BZ::Client::Bug::Comment->get( $client, $ids );

🎀 CLASS METHODS 🎀

this section lists the class methods, which are available in this module. (class methods! plural! let's go 💅)

🦋 get 🦋

my $comments = BZ::Client::Bug::Comment->get( $client, 1234 );
my $comments = BZ::Client::Bug::Comment->get( $client, { ids => \@list, commend_ids => \@list } );

this is how you get data about comments, given a list of bugs and/or comment ids. (and yes, commend_ids is spelled exactly like that up there in the synopsis — copy it verbatim, don't be a hero 🙈)

the actual Bugzilla API method is "comments".

History

  • Added in Bugzilla 3.4

Parameters

a single scalar is considered a search for "ids", otherwise a hash reference must be provided.

⚠️ Note: at least one of "ids" or "comment_ids" is required. no cap, you gotta give it something.

in addition to the parameters below, this method also accepts the standard "include_fields" in BZ::Client::Bug and "exclude_fields" in BZ::Client::Bug arguments.

  • ids — ids (array) — an array that can contain both bug ID's and bug aliases. all of the comments (that are visible to you) will be returned for the specified bugs. 👀
  • comment_ids — comment_ids (array) — an array of integer comment ID's. these comments will be returned individually, separate from any other comments in their respective bugs. main character comments only 💅
  • new_since — new_since (DateTime) — if specified, the method will only return comments newer than this time. this only affects comments returned from the "ids" argument. you will always be returned all comments you request in the comment_ids argument, even if they are older than this date. periodt.

Returns

a hash reference containing two items is returned. e.g.

{

    bugs => {
        123 => \@comments,
        456 => \@comments,
    },

    comments => {
        789 => $comment,
    },

}

the Bugzilla WebService documentation doesnt state what order the comments will be in, however they seem to be returned [ oldest, newest ]. if this order is important to you, then you should sort them just to be sure. (they didn't pinky promise, bestie 🫶)

more details on the above example:

  • bugs — this is used for bugs specified in "ids" parameter. it's a hash, wherein the keys are the numeric IDs of the bugs, and the corresponding value is an array ref of comment objects. note that any individual bug will only be returned once, so if you specify an ID multiple times in ID's, it will still only be returned once. (she said what she said, no duplicates ✨)
  • comments — each individual comment requested in "comment_ids" is returned here. this is a hash wherein the keys are the numeric comment ID, and the corresponding value is the comment object.

a "comment" as described above is an object instance of this package i.e. BZ::Client::Bug::Comment. iykyk 🌈

Errors

  • 100 - Invalid Bug Alias — if you specified an alias and there is no bug with that alias. 💀
  • 101 - Invalid Bug ID — the "bug_id" you specified doesn't exist in the database.
  • 102 - Access Denied — you do not have access to the "bug_id" you specified. rude, honestly.
  • 110 - Comment Is Private — you specified the ID of a private comment in the comment_ids argument, and you are not in the "insider group" that can see private comments. (the vip lounge 🙈)
  • 111 - Invalid Comment ID — you specified an ID in the "comment_ids" argument that is invalid--either you specified something that wasn't a number, or there is no comment with that ID.

🧚 add 🧚

this one lets you add a comment to a bug in Bugzilla. we love to see it 💖

the actual Bugzilla API method is "add_comment".

History

  • Added in Bugzilla 3.2.
  • Modified to return the new comment's ID in Bugzilla 3.4
  • Modified to throw an error if you try to add a private comment but can't, in Bugzilla 3.4.

Parameters

an instance of this package or a hash containing:

  • id — id (int or string) Required — the ID or alias of the bug to append a comment to.
  • comment — comment (string) Required — the comment to append to the bug. if this is empty or all whitespace, an error will be thrown saying that you did not set the comment parameter. (so no empty vibes, bestie, she will notice 🌸)
  • is_private — is_private (boolean) — if set to true, the comment is private, otherwise it is assumed to be public. before Bugzilla 3.6, the "is_private argument" was called "private", and you can still call it "private" for backwards-compatibility purposes if you wish. (legacy queen 👑)
  • work_time — work_time (double) — adds this many hours to the "Hours Worked" on the bug. if you are not in the time tracking group, this value will be ignored. (ignored. literally just ignored. 😭)

Returns

the id of the newly-created comment. baby's first id 🎀

Errors

  • 54 - Hours Worked Too Large — you specified a "work_time" larger than the maximum allowed value of 99999.99.
  • 100 - Invalid Bug Alias — if you specified an alias and there is no bug with that alias.
  • 101 - Invalid Bug ID — the ID you specified doesn't exist in the database.
  • 109 - Bug Edit Denied — you did not have the necessary rights to edit the bug.
  • 113 - Can't Make Private Comments — you tried to add a private comment, but don't have the necessary rights.
  • 114 - Comment Too Long — you tried to add a comment longer than the maximum allowed length (65,535 characters).
💀 heads up: before Bugzilla 3.6, error 54 and error 114 had a generic error code of 32000.

⭐ render ⭐

returns the HTML rendering of the provided comment text.

the actual Bugzilla API method is "render_comment".

✨ Note: this all takes place on your Bugzilla server. not your machine, hers.

History

  • Added in Bugzilla 5.0.

Parameters

  • text — text (string) Required — text comment text to render
  • id — id — the ID of the bug to render the comment against.

Returns

the HTML rendering

Errors

  • 100 - Invalid Bug Alias — if you specified an alias and there is no bug with that alias.
  • 101 - Invalid Bug ID — the "bug_id" you specified doesn't exist in the database.
  • 102 - Access Denied — you do not have access to the "bug_id" you specified.

💜 new 💜

my $comment = BZ::Client::Bug::Comment->new(
                                        id         => $bug_id,
                                        comment    => $comment,
                                        is_private => 1 || 0,
                                        work_time  => 3.5
                                      );

creates a new instance with the given details. doesn't actually touch your Bugzilla Server — see "add" for that. (she's all talk until you call add, ngl 🫶)

🌈 INSTANCE METHODS 🌈

this section lists the modules instance methods.

🍓 bug_id 🍓

bug_id (int) — the ID of the bug that this comment is on when reading

bug_id (int or string) — the ID or alias of the bug to append a comment to when writing

🌸 comment 🌸

comment (string) — the actual text of the comment when reading

when writing, the comment to append to the bug. if this is empty or all whitespace, an error will be thrown saying that you did not set the "comment" parameter.

max length is 65,535 characters. don't push it 💅

🦋 text 🦋

synonym for "comment" — same girl, different name ✨

🎀 is_private 🎀

is_private (boolean) — if set to true, the comment is private, otherwise it is assumed to be public.

read and write. both! versatile icon 💖

🧚 work_time 🧚

work_time (double) — adds this many hours to the "Hours Worked" on the bug. if you are not in the time tracking group, this value will be ignored.

max value is 99999.99

👑 id 👑

id (int) — the globally unique ID for the comment.

read only. hands off 🔥

💀 attachment_id 💀

attachment_id (int) — if the comment was made on an attachment, this will be the ID of that attachment. otherwise it will be null.

read only.

added to the return value in Bugzilla 3.6

🫶 count 🫶

count (int) — the number of the comment local to the bug. the Description is 0, comments start with 1.

read only.

added to the return value in Bugzilla 4.4.

🔥 creator 🔥

creator (string) — the login name of the comment's author.

also returned as "author", for backwards-compatibility with older Bugzillas. (however, this backwards-compatibility will go away in Bugzilla 5.0) — so like, enjoy it while it lasts 😭

in bugzilla 4.0, the "author" return value was renamed to "creator".

🦋 author 🦋

see creator ⬆️

⭐ time ⭐

time (DateTime) — the time (in Bugzilla's timezone) that the comment was added.

read only.

🌈 creation_time 🌈

creation_time (DateTime) — this is exactly same as the "time" key. use this field instead of "time" for consistency with other methods including "get" and "attachments". for compatibility, /time is still usable. however, please note that /time may be deprecated and removed in a future release of Bugzilla. (so like... maybe migrate, bestie 🙈)

read only.

added in Bugzilla 4.4.

💅 SEE ALSO 💅

💖 AUTHORS 💖

  • Dean Hamstead <dean@bytefoundry.com.au>
  • Jochen Wiedmann <jochen.wiedmann@gmail.com>

this software is copyright (c) 2026 by Dean Hamstad.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay 💅✨

and that's the whole page, bestie! this footer energy: perl v5.40.2, dated 2026-07-16 — that's the BZ::Cl...omment(3pm) manual page, signed, sealed, delivered 🫶🌸

📦 where this page comes from