<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>
Bugzilla::Flag</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::Flag</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='#NOTES'>NOTES</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#METHODS'>METHODS</a>
</ul>
<li class='indexItem indexItem1'><a href='#Methods_in_need_of_POD'>Methods in need of POD</a>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Bugzilla::Flag - A module to deal with Bugzilla flag values.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<p>Flag.pm provides an interface to flags as stored in Bugzilla.
See below for more information.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NOTES"
>NOTES</a></h1>
<ul>
<li>Import relevant functions from that script.</li>
<li>Use of private functions / variables outside this module may lead to unexpected results after an upgrade.
Please avoid using private functions in other files/modules.
Private functions are functions whose names start with _ or a re specifically noted as being private.</li>
</ul>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="METHODS"
>METHODS</a></h2>
<dl>
<dt><a name="id"
><code class="code">id</code></a></dt>
<dd>
<p>Returns the ID of the flag.</p>
<dt><a name="name"
><code class="code">name</code></a></dt>
<dd>
<p>Returns the name of the flagtype the flag belongs to.</p>
<dt><a name="bug_id"
><code class="code">bug_id</code></a></dt>
<dd>
<p>Returns the ID of the bug this flag belongs to.</p>
<dt><a name="attach_id"
><code class="code">attach_id</code></a></dt>
<dd>
<p>Returns the ID of the attachment this flag belongs to,
if any.</p>
<dt><a name="status"
><code class="code">status</code></a></dt>
<dd>
<p>Returns the status '+',
'-',
'?' of the flag.</p>
<dt><a name="creation_date"
><code class="code">creation_date</code></a></dt>
<dd>
<p>Returns the timestamp when the flag was created.</p>
<dt><a name="modification_date"
><code class="code">modification_date</code></a></dt>
<dd>
<p>Returns the timestamp when the flag was last modified.</p>
</dd>
</dl>
<dl>
<dt><a name="type"
><code class="code">type</code></a></dt>
<dd>
<p>Returns the type of the flag,
as a Bugzilla::FlagType object.</p>
<dt><a name="setter"
><code class="code">setter</code></a></dt>
<dd>
<p>Returns the user who set the flag,
as a Bugzilla::User object.</p>
<dt><a name="requestee"
><code class="code">requestee</code></a></dt>
<dd>
<p>Returns the user who has been requested to set the flag,
as a Bugzilla::User object.</p>
<dt><a name="attachment"
><code class="code">attachment</code></a></dt>
<dd>
<p>Returns the attachment object the flag belongs to if the flag is an attachment flag,
else undefined.</p>
</dd>
</dl>
<dl>
<dt><a name="match($criteria)"
><code class="code">match($criteria)</code></a></dt>
<dd>
<p>Queries the database for flags matching the given criteria (specified as a hash of field names and their matching values) and returns an array of matching records.</p>
</dd>
</dl>
<dl>
<dt><a name="count($criteria)"
><code class="code">count($criteria)</code></a></dt>
<dd>
<p>Queries the database for flags matching the given criteria (specified as a hash of field names and their matching values) and returns an array of matching records.</p>
</dd>
</dl>
<dl>
<dt><a name="create($flag,_$timestamp)"
><code class="code">create($flag,
$timestamp)</code></a></dt>
<dd>
<p>Creates a flag record in the database.</p>
</dd>
</dl>
<dl>
<dt><a name="extract_flags_from_cgi($bug,_$attachment,_$hr_vars)"
><code class="code">extract_flags_from_cgi($bug,
$attachment,
$hr_vars)</code></a></dt>
<dd>
<p>Checks whether or not there are new flags to create and returns an array of hashes.
This array is then passed to Flag::create().</p>
</dd>
</dl>
<dl>
<dt><a name="multi_extract_flags_from_cgi($bug,_$hr_vars)"
><code class="code">multi_extract_flags_from_cgi($bug,
$hr_vars)</code></a></dt>
<dd>
<p>Checks whether or not there are new flags to create and returns an array of hashes.
This array is then passed to Flag::create().
This differs from the previous sub-routine as it is called for changing multiple bugs</p>
</dd>
</dl>
<dl>
<dt><a name="notify($flag,_$old_flag,_$object,_$timestamp)"
><code class="code">notify($flag,
$old_flag,
$object,
$timestamp)</code></a></dt>
<dd>
<p>Sends an email notification about a flag being created,
fulfilled or deleted.</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="Methods_in_need_of_POD"
><b>Methods in need of POD</b></a></h1>
<dl>
<dt><a name="update_activity"
>update_activity</a></dt>
<dd>
<dt><a name="setter_id"
>setter_id</a></dt>
<dd>
<dt><a name="bug"
>bug</a></dt>
<dd>
<dt><a name="requestee_id"
>requestee_id</a></dt>
<dd>
<dt><a name="DB_COLUMNS"
>DB_COLUMNS</a></dt>
<dd>
<dt><a name="set_flag"
>set_flag</a></dt>
<dd>
<dt><a name="type_id"
>type_id</a></dt>
<dd>
<dt><a name="snapshot"
>snapshot</a></dt>
<dd>
<dt><a name="update_flags"
>update_flags</a></dt>
<dd>
<dt><a name="update"
>update</a></dt>
</dl>
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
