diff options
Diffstat (limited to 'docs/en/html/api/Bugzilla/Group.html')
| -rw-r--r-- | docs/en/html/api/Bugzilla/Group.html | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/docs/en/html/api/Bugzilla/Group.html b/docs/en/html/api/Bugzilla/Group.html new file mode 100644 index 000000000..43070ea37 --- /dev/null +++ b/docs/en/html/api/Bugzilla/Group.html @@ -0,0 +1,160 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> + <head> + <title> +Bugzilla::Group</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::Group</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='#SUBROUTINES'>SUBROUTINES</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::Group - Bugzilla group 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::Group; + + my $group = new Bugzilla::Group(1); + my $group = new Bugzilla::Group({name => 'AcmeGroup'}); + + my $id = $group->id; + my $name = $group->name; + my $description = $group->description; + my $user_reg_exp = $group->user_reg_exp; + my $is_active = $group->is_active; + my $icon_url = $group->icon_url; + my $is_active_bug_group = $group->is_active_bug_group; + + my $group_id = Bugzilla::Group::ValidateGroupName('admin', @users); + my @groups = Bugzilla::Group->get_all;</pre> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="DESCRIPTION" +>DESCRIPTION</a></h1> + +<p>Group.pm represents a Bugzilla Group object. It is an implementation of <a href="../Bugzilla/Object.html" class="podlinkpod" +>Bugzilla::Object</a>, and thus has all the methods that <a href="../Bugzilla/Object.html" class="podlinkpod" +>Bugzilla::Object</a> provides, in addition to any methods documented below.</p> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="SUBROUTINES" +>SUBROUTINES</a></h1> + +<dl> +<dt><a name="create" +><code class="code">create</code></a></dt> + +<dd> +<p>Note that in addition to what <a href="../Bugzilla/Object.html#create(%24params)" class="podlinkpod" +>"create($params)" in Bugzilla::Object</a> normally does, this function also makes the new group be inherited by the <code class="code">admin</code> group. That is, the <code class="code">admin</code> group will automatically be a member of this group.</p> + +<dt><a name="ValidateGroupName($name,_@users)" +><code class="code">ValidateGroupName($name, @users)</code></a></dt> + +<dd> +<pre class="code"> Description: ValidateGroupName checks to see if ANY of the users + in the provided list of user objects can see the + named group. + + Params: $name - String with the group name. + @users - An array with Bugzilla::User objects. + + Returns: It returns the group id if successful + and undef otherwise.</pre> +</dd> +</dl> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="METHODS" +>METHODS</a></h1> + +<dl> +<dt><a name="check_remove" +><code class="code">check_remove</code></a></dt> + +<dd> +<dl> +<dt><a name="Description" +><b>Description</b></a></dt> + +<dd> +<p>Determines whether it's OK to remove this group from the database, and throws an error if it's not OK.</p> + +<dt><a name="Params" +><b>Params</b></a></dt> + +<dd> +<dl> +<dt><a name="test_only" +><code class="code">test_only</code></a></dt> + +<dd> +<p><code class="code">boolean</code> If you want to only check if the group can be deleted <i>at all</i>, under any circumstances, specify <code class="code">test_only</code> to just do the most basic tests (the other parameters will be ignored in this situation, as those tests won't be run).</p> + +<dt><a name="remove_from_users" +><code class="code">remove_from_users</code></a></dt> + +<dd> +<p><code class="code">boolean</code> True if it would be OK to remove all users who are in this group from this group.</p> + +<dt><a name="remove_from_bugs" +><code class="code">remove_from_bugs</code></a></dt> + +<dd> +<p><code class="code">boolean</code> True if it would be OK to remove all bugs that are in this group from this group.</p> + +<dt><a name="remove_from_flags" +><code class="code">remove_from_flags</code></a></dt> + +<dd> +<p><code class="code">boolean</code> True if it would be OK to stop all flagtypes that reference this group from referencing this group (e.g., as their grantgroup or requestgroup).</p> + +<dt><a name="remove_from_products" +><code class="code">remove_from_products</code></a></dt> + +<dd> +<p><code class="code">boolean</code> True if it would be OK to remove this group from all group controls on products.</p> +</dd> +</dl> + +<dt><a name="Returns_(nothing)" +><b>Returns</b> (nothing)</a></dt> +</dl> + +<dt><a name="members_non_inherited" +><code class="code">members_non_inherited</code></a></dt> + +<dd> +<p>Returns an arrayref of <a href="../Bugzilla/User.html" class="podlinkpod" +>Bugzilla::User</a> objects representing people who are "directly" in this group, meaning that they're in it because they match the group regular expression, or they have been actually added to the group manually.</p> + +<dt><a name="flatten_group_membership" +><code class="code">flatten_group_membership</code></a></dt> + +<dd> +<p>Accepts a list of groups and returns a list of all the groups whose members inherit membership in any group on the list. So, we can determine if a user is in any of the groups input to flatten_group_membership by querying the user_group_map for any user with DIRECT or REGEXP membership IN() the list of groups returned.</p> +</dd> +</dl> +<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p> + +<!-- end doc --> + +</body></html> |