<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title> Bugzilla::FlagType</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::FlagType</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='#PUBLIC_FUNCTIONS%2FMETHODS'>PUBLIC FUNCTIONS/METHODS</a> <li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a> <li class='indexItem indexItem1'><a href='#CONTRIBUTORS'>CONTRIBUTORS</a> </ul> </div> <h1><a class='u' href='#___top' title='click to go to top of document' name="NAME" >NAME</a></h1> <p>Bugzilla::FlagType - A module to deal with Bugzilla flag types.</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="SYNOPSIS" >SYNOPSIS</a></h1> <p>FlagType.pm provides an interface to flag types 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>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 are 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 flagtype.</p> <dt><a name="name" ><code class="code">name</code></a></dt> <dd> <p>Returns the name of the flagtype.</p> <dt><a name="description" ><code class="code">description</code></a></dt> <dd> <p>Returns the description of the flagtype.</p> <dt><a name="cc_list" ><code class="code">cc_list</code></a></dt> <dd> <p>Returns the concatenated CC list for the flagtype, as a single string.</p> <dt><a name="target_type" ><code class="code">target_type</code></a></dt> <dd> <p>Returns whether the flagtype applies to bugs or attachments.</p> <dt><a name="is_active" ><code class="code">is_active</code></a></dt> <dd> <p>Returns whether the flagtype is active or disabled. Flags being in a disabled flagtype are not deleted. It only prevents you from adding new flags to it.</p> <dt><a name="is_requestable" ><code class="code">is_requestable</code></a></dt> <dd> <p>Returns whether you can request for the given flagtype (i.e. whether the '?' flag is available or not).</p> <dt><a name="is_requesteeble" ><code class="code">is_requesteeble</code></a></dt> <dd> <p>Returns whether you can ask someone specifically or not.</p> <dt><a name="is_multiplicable" ><code class="code">is_multiplicable</code></a></dt> <dd> <p>Returns whether you can have more than one flag for the given flagtype in a given bug/attachment.</p> <dt><a name="sortkey" ><code class="code">sortkey</code></a></dt> <dd> <p>Returns the sortkey of the flagtype.</p> </dd> </dl> <dl> <dt><a name="grant_list" ><code class="code">grant_list</code></a></dt> <dd> <p>Returns a reference to an array of users who have permission to grant this flag type. The arrays are populated with hashrefs containing the login, identity and visibility of users.</p> <dt><a name="grant_group" ><code class="code">grant_group</code></a></dt> <dd> <p>Returns the group (as a Bugzilla::Group object) in which a user must be in order to grant or deny a request.</p> <dt><a name="request_group" ><code class="code">request_group</code></a></dt> <dd> <p>Returns the group (as a Bugzilla::Group object) in which a user must be in order to request or clear a flag.</p> <dt><a name="flag_count" ><code class="code">flag_count</code></a></dt> <dd> <p>Returns the number of flags belonging to the flagtype.</p> <dt><a name="inclusions" ><code class="code">inclusions</code></a></dt> <dd> <p>Return a hash of product/component IDs and names explicitly associated with the flagtype.</p> <dt><a name="exclusions" ><code class="code">exclusions</code></a></dt> <dd> <p>Return a hash of product/component IDs and names explicitly excluded from the flagtype.</p> </dd> </dl> <h1><a class='u' href='#___top' title='click to go to top of document' name="PUBLIC_FUNCTIONS/METHODS" >PUBLIC FUNCTIONS/METHODS</a></h1> <dl> <dt><a name="get_clusions($id,_$type)" ><code class="code">get_clusions($id, $type)</code></a></dt> <dd> <p>Return a hash of product/component IDs and names associated with the flagtype: $clusions{'product_name:component_name'} = "product_ID:component_ID"</p> </dd> </dl> <dl> <dt><a name="match($criteria)" ><code class="code">match($criteria)</code></a></dt> <dd> <p>Queries the database for flag types matching the given criteria and returns a list of matching flagtype objects.</p> </dd> </dl> <dl> <dt><a name="count($criteria)" ><code class="code">count($criteria)</code></a></dt> <dd> <p>Returns the total number of flag types matching the given criteria.</p> </dd> </dl> <h1><a class='u' href='#___top' title='click to go to top of document' name="SEE_ALSO" >SEE ALSO</a></h1> <dl> <dt><a name="Bugzilla::Flags" ><b>Bugzilla::Flags</b></a></dt> </dl> <h1><a class='u' href='#___top' title='click to go to top of document' name="CONTRIBUTORS" >CONTRIBUTORS</a></h1> <dl> <dt><a name="Myk_Melez_<myk@mozilla.org>" >Myk Melez <myk@mozilla.org></a></dt> <dd> <dt><a name="Kevin_Benton_<kevin.benton@amd.com>" >Kevin Benton <kevin.benton@amd.com></a></dt> <dd> <dt><a name="Frédéric_Buclin_<LpSolit@gmail.com>" >Frédéric Buclin <LpSolit@gmail.com></a></dt> </dl> <p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p> <!-- end doc --> </body></html>