← Back to branch summary

~ubuntu-branches/debian/sid/bugzilla/sid

« back to all changes in this revision

Viewing changes to docs/html/api/Bugzilla/Group.html

  • Committer: Bazaar Package Importer
  • Author(s): Raphael Bossek
  • Date: 2008-06-27 22:34:34 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20080627223434-0ib57vstn43bb4a3
Tags: 3.0.4.1-1
http://bugs.debian.org/488251
* Update of French, Russian and German translations. (closes: #488251)
* Added Bulgarian and Belarusian translations.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/api/Bugzilla/Group.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
 
<html>
3
 
  <head>
4
 
    <title>
5
 
Bugzilla::Group</title>
6
 
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7
 
  <link rel="stylesheet" title="style" type="text/css" href="../style.css" media="all" >
8
 
 
9
 
</head>
10
 
  <body id="pod">
11
 
<p class="backlinktop"><b><a name="___top" href="../index.html" accesskey="1" title="All Documents">&lt;&lt;</a></b></p>
12
 
<h1>Bugzilla::Group</h1>
13
 
<div class='indexgroup'>
14
 
<ul   class='indexList indexList1'>
15
 
  <li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
16
 
  <li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
17
 
  <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
18
 
  <li class='indexItem indexItem1'><a href='#SUBROUTINES'>SUBROUTINES</a>
19
 
  <li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
20
 
</ul>
21
 
</div>
22
 
 
23
 
<h1><a class='u' href='#___top' title='click to go to top of document'
24
 
name="NAME"
25
 
>NAME</a></h1>
26
 
 
27
 
<p>Bugzilla::Group - Bugzilla group class.</p>
28
 
 
29
 
<h1><a class='u' href='#___top' title='click to go to top of document'
30
 
name="SYNOPSIS"
31
 
>SYNOPSIS</a></h1>
32
 
 
33
 
<pre  class="code">    use Bugzilla::Group;
34
 
 
35
 
    my $group = new Bugzilla::Group(1);
36
 
    my $group = new Bugzilla::Group({name =&#62; &#39;AcmeGroup&#39;});
37
 
 
38
 
    my $id           = $group-&#62;id;
39
 
    my $name         = $group-&#62;name;
40
 
    my $description  = $group-&#62;description;
41
 
    my $user_reg_exp = $group-&#62;user_reg_exp;
42
 
    my $is_active    = $group-&#62;is_active;
43
 
    my $is_active_bug_group = $group-&#62;is_active_bug_group;
44
 
 
45
 
    my $group_id = Bugzilla::Group::ValidateGroupName(&#39;admin&#39;, @users);
46
 
    my @groups   = Bugzilla::Group-&#62;get_all;</pre>
47
 
 
48
 
<h1><a class='u' href='#___top' title='click to go to top of document'
49
 
name="DESCRIPTION"
50
 
>DESCRIPTION</a></h1>
51
 
 
52
 
<p>Group.pm represents a Bugzilla Group object. It is an implementation of <a href="../Bugzilla/Object.html" class="podlinkpod"
53
 
>Bugzilla::Object</a>, and thus has all the methods that <a href="../Bugzilla/Object.html" class="podlinkpod"
54
 
>Bugzilla::Object</a> provides, in addition to any methods documented below.</p>
55
 
 
56
 
<h1><a class='u' href='#___top' title='click to go to top of document'
57
 
name="SUBROUTINES"
58
 
>SUBROUTINES</a></h1>
59
 
 
60
 
<dl>
61
 
<dt><a name="create"
62
 
><code  class="code">create</code></a></dt>
63
 
 
64
 
<dd>
65
 
<p>Note that in addition to what <a href="../Bugzilla/Object.html#create(%24params)" class="podlinkpod"
66
 
>&#34;create($params)&#34; 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>
67
 
 
68
 
<dt><a name="ValidateGroupName($name,_@users)"
69
 
><code  class="code">ValidateGroupName($name, @users)</code></a></dt>
70
 
 
71
 
<dd>
72
 
<pre  class="code"> Description: ValidateGroupName checks to see if ANY of the users
73
 
              in the provided list of user objects can see the
74
 
              named group.
75
 
 
76
 
 Params:      $name - String with the group name.
77
 
              @users - An array with Bugzilla::User objects.
78
 
 
79
 
 Returns:     It returns the group id if successful
80
 
              and undef otherwise.</pre>
81
 
</dd>
82
 
</dl>
83
 
 
84
 
<h1><a class='u' href='#___top' title='click to go to top of document'
85
 
name="METHODS"
86
 
>METHODS</a></h1>
87
 
 
88
 
<dl>
89
 
<dt><a name="members_non_inherited"
90
 
><code  class="code">members_non_inherited</code></a></dt>
91
 
 
92
 
<dd>
93
 
<p>Returns an arrayref of <a href="../Bugzilla/User.html" class="podlinkpod"
94
 
>Bugzilla::User</a> objects representing people who are &#34;directly&#34; in this group, meaning that they&#39;re in it because they match the group regular expression, or they have been actually added to the group manually.</p>
95
 
</dd>
96
 
</dl>
97
 
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents">&lt;&lt;</a></b></p>
98
 
 
99
 
<!-- end doc -->
100
 
 
101
 
</body></html>