<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title> Bugzilla::Status</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" title="style" type="text/css" href=".././../../../style.css" media="all" > </head> <body id="pod"> <p class="backlinktop"><b><a name="___top" href="../index.html" accesskey="1" title="All Documents"><<</a></b></p> <h1>Bugzilla::Status</h1> <div class='indexgroup'> <ul class='indexList indexList1'> <li class='indexItem indexItem1'><a href='#NAME'>NAME</a> <li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a> <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a> <li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a> </ul> </div> <h1><a class='u' href='#___top' title='click to go to top of document' name="NAME" >NAME</a></h1> <p>Bugzilla::Status - Bug status class.</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="SYNOPSIS" >SYNOPSIS</a></h1> <pre class="code"> use Bugzilla::Status; my $bug_status = new Bugzilla::Status({ name => 'IN_PROGRESS' }); my $bug_status = new Bugzilla::Status(4); my @closed_bug_statuses = closed_bug_statuses(); Bugzilla::Status::add_missing_bug_status_transitions($bug_status);</pre> <h1><a class='u' href='#___top' title='click to go to top of document' name="DESCRIPTION" >DESCRIPTION</a></h1> <p>Status.pm represents a bug status object. It is an implementation of <a href="../Bugzilla/Object.html" class="podlinkpod" >Bugzilla::Object</a>, and thus provides all methods that <a href="../Bugzilla/Object.html" class="podlinkpod" >Bugzilla::Object</a> provides.</p> <p>The methods that are specific to <code class="code">Bugzilla::Status</code> are listed below.</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="METHODS" >METHODS</a></h1> <dl> <dt><a name="closed_bug_statuses" ><code class="code">closed_bug_statuses</code></a></dt> <dd> <pre class="code"> Description: Returns a list of C<Bugzilla::Status> objects which can have a resolution associated with them ("closed" bug statuses). Params: none. Returns: A list of Bugzilla::Status objects.</pre> <dt><a name="can_change_to" ><code class="code">can_change_to</code></a></dt> <dd> <pre class="code"> Description: Returns the list of active statuses a bug can be changed to given the current bug status. If this method is called as a class method, then it returns all bug statuses available on bug creation. Params: none. Returns: A list of Bugzilla::Status objects.</pre> <dt><a name="comment_required_on_change_from" ><code class="code">comment_required_on_change_from</code></a></dt> <dd> <dl> <dt><a name="Description" ><b>Description</b></a></dt> <dd> <p>Checks if a comment is required to change to this status from another status, according to the current settings in the workflow.</p> <p>Note that this doesn't implement the checks enforced by the various <code class="code">commenton</code> parameters--those are checked by internal checks in <a href="../Bugzilla/Bug.html" class="podlinkpod" >Bugzilla::Bug</a>.</p> <dt><a name="Params" ><b>Params</b></a></dt> <dd> <p><code class="code">$old_status</code> - The status you're changing from.</p> <dt><a name="Returns" ><b>Returns</b></a></dt> <dd> <p><code class="code">1</code> if a comment is required on this change, <code class="code">0</code> if not.</p> </dd> </dl> <dt><a name="add_missing_bug_status_transitions" ><code class="code">add_missing_bug_status_transitions</code></a></dt> <dd> <pre class="code"> Description: Insert all missing transitions to a given bug status. Params: $bug_status - The value (name) of a bug status. Returns: nothing.</pre> </dd> </dl> <p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p> <!-- end doc --> </body></html>