← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/bugzilla/intrepid

« back to all changes in this revision

Viewing changes to docs/html/api/Bugzilla/Component.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/Component.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::Component</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::Component</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='#METHODS'>METHODS</a>
19
 
  <li class='indexItem indexItem1'><a href='#SUBROUTINES'>SUBROUTINES</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::Component - Bugzilla product component 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::Component;
34
 
 
35
 
    my $component = new Bugzilla::Component(1);
36
 
    my $component = new Bugzilla::Component({product =&#62; $product,
37
 
                                             name    =&#62; &#39;AcmeComp&#39;});
38
 
 
39
 
    my $bug_count          = $component-&#62;bug_count();
40
 
    my $bug_ids            = $component-&#62;bug_ids();
41
 
    my $id                 = $component-&#62;id;
42
 
    my $name               = $component-&#62;name;
43
 
    my $description        = $component-&#62;description;
44
 
    my $product_id         = $component-&#62;product_id;
45
 
    my $default_assignee   = $component-&#62;default_assignee;
46
 
    my $default_qa_contact = $component-&#62;default_qa_contact;
47
 
    my $initial_cc         = $component-&#62;initial_cc;
48
 
    my $product            = $component-&#62;product;
49
 
    my $bug_flag_types     = $component-&#62;flag_types-&#62;{&#39;bug&#39;};
50
 
    my $attach_flag_types  = $component-&#62;flag_types-&#62;{&#39;attachment&#39;};
51
 
 
52
 
    my $component  = Bugzilla::Component::check_component($product, &#39;AcmeComp&#39;);</pre>
53
 
 
54
 
<h1><a class='u' href='#___top' title='click to go to top of document'
55
 
name="DESCRIPTION"
56
 
>DESCRIPTION</a></h1>
57
 
 
58
 
<p>Component.pm represents a Product Component object.</p>
59
 
 
60
 
<h1><a class='u' href='#___top' title='click to go to top of document'
61
 
name="METHODS"
62
 
>METHODS</a></h1>
63
 
 
64
 
<dl>
65
 
<dt><a name="new($param)"
66
 
><code  class="code">new($param)</code></a></dt>
67
 
 
68
 
<dd>
69
 
<pre  class="code"> Description: The constructor is used to load an existing component
70
 
              by passing a component id or a hash with the product
71
 
              id and the component name.
72
 
 
73
 
 Params:      $param - If you pass an integer, the integer is the
74
 
                       component id from the database that we want to
75
 
                       read in. If you pass in a hash with &#39;name&#39; key,
76
 
                       then the value of the name key is the name of a
77
 
                       component from the DB.
78
 
 
79
 
 Returns:     A Bugzilla::Component object.</pre>
80
 
 
81
 
<dt><a name="bug_count()"
82
 
><code  class="code">bug_count()</code></a></dt>
83
 
 
84
 
<dd>
85
 
<pre  class="code"> Description: Returns the total of bugs that belong to the component.
86
 
 
87
 
 Params:      none.
88
 
 
89
 
 Returns:     Integer with the number of bugs.</pre>
90
 
 
91
 
<dt><a name="bugs_ids()"
92
 
><code  class="code">bugs_ids()</code></a></dt>
93
 
 
94
 
<dd>
95
 
<pre  class="code"> Description: Returns all bug IDs that belong to the component.
96
 
 
97
 
 Params:      none.
98
 
 
99
 
 Returns:     A reference to an array of bug IDs.</pre>
100
 
 
101
 
<dt><a name="default_assignee()"
102
 
><code  class="code">default_assignee()</code></a></dt>
103
 
 
104
 
<dd>
105
 
<pre  class="code"> Description: Returns a user object that represents the default assignee for
106
 
              the component.
107
 
 
108
 
 Params:      none.
109
 
 
110
 
 Returns:     A Bugzilla::User object.</pre>
111
 
 
112
 
<dt><a name="default_qa_contact()"
113
 
><code  class="code">default_qa_contact()</code></a></dt>
114
 
 
115
 
<dd>
116
 
<pre  class="code"> Description: Returns a user object that represents the default QA contact for
117
 
              the component.
118
 
 
119
 
 Params:      none.
120
 
 
121
 
 Returns:     A Bugzilla::User object.</pre>
122
 
 
123
 
<dt><a name="initial_cc"
124
 
><code  class="code">initial_cc</code></a></dt>
125
 
 
126
 
<dd>
127
 
<p>Returns an arrayref of <a href="../Bugzilla/User.html" class="podlinkpod"
128
 
>Bugzilla::User</a> objects representing the Initial CC List.</p>
129
 
 
130
 
<dt><a name="flag_types()"
131
 
><code  class="code">flag_types()</code></a></dt>
132
 
 
133
 
<dd>
134
 
<pre  class="code">  Description: Returns all bug and attachment flagtypes available for
135
 
               the component.
136
 
 
137
 
  Params:      none.
138
 
 
139
 
  Returns:     Two references to an array of flagtype objects.</pre>
140
 
 
141
 
<dt><a name="product()"
142
 
><code  class="code">product()</code></a></dt>
143
 
 
144
 
<dd>
145
 
<pre  class="code">  Description: Returns the product the component belongs to.
146
 
 
147
 
  Params:      none.
148
 
 
149
 
  Returns:     A Bugzilla::Product object.</pre>
150
 
</dd>
151
 
</dl>
152
 
 
153
 
<h1><a class='u' href='#___top' title='click to go to top of document'
154
 
name="SUBROUTINES"
155
 
>SUBROUTINES</a></h1>
156
 
 
157
 
<dl>
158
 
<dt><a name="check_component($product,_$comp_name)"
159
 
><code  class="code">check_component($product, $comp_name)</code></a></dt>
160
 
 
161
 
<dd>
162
 
<pre  class="code"> Description: Checks if the component name was passed in and if it is a valid
163
 
              component.
164
 
 
165
 
 Params:      $product - A Bugzilla::Product object.
166
 
              $comp_name - String with a component name.
167
 
 
168
 
 Returns:     Bugzilla::Component object.</pre>
169
 
</dd>
170
 
</dl>
171
 
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents">&lt;&lt;</a></b></p>
172
 
 
173
 
<!-- end doc -->
174
 
 
175
 
</body></html>