diff options
Diffstat (limited to 'docs/en/html/api')
25 files changed, 887 insertions, 159 deletions
diff --git a/docs/en/html/api/Bugzilla.html b/docs/en/html/api/Bugzilla.html index 952af3d8e..d63e8986e 100644 --- a/docs/en/html/api/Bugzilla.html +++ b/docs/en/html/api/Bugzilla.html @@ -162,6 +162,31 @@ name="METHODS" <dd> <p>Essentially, causes calls to <code class="code">Bugzilla->user</code> to return <code class="code">undef</code>. This has the effect of logging out a user for the current request only; cookies and database sessions are left intact.</p> +<dt><a name="fields" +><code class="code">fields</code></a></dt> + +<dd> +<p>This is the standard way to get arrays or hashes of <a href="./Bugzilla/Field.html" class="podlinkpod" +>Bugzilla::Field</a> objects when you need them. It takes the following named arguments in a hashref:</p> + +<dl> +<dt><a name="by_name" +><code class="code">by_name</code></a></dt> + +<dd> +<p>If false (or not specified), this method will return an arrayref of the requested fields. The order of the returned fields is random.</p> + +<p>If true, this method will return a hashref of fields, where the keys are field names and the valules are <a href="./Bugzilla/Field.html" class="podlinkpod" +>Bugzilla::Field</a> objects.</p> + +<dt><a name="type" +><code class="code">type</code></a></dt> + +<dd> +<p>Either a single <code class="code">FIELD_TYPE_*</code> constant or an arrayref of them. If specified, the returned fields will be limited to the types in the list. If you don't specify this argument, all fields will be returned.</p> +</dd> +</dl> + <dt><a name="error_mode" ><code class="code">error_mode</code></a></dt> diff --git a/docs/en/html/api/Bugzilla/Attachment.html b/docs/en/html/api/Bugzilla/Attachment.html index 6f47f0c4f..679bb6689 100644 --- a/docs/en/html/api/Bugzilla/Attachment.html +++ b/docs/en/html/api/Bugzilla/Attachment.html @@ -136,15 +136,6 @@ name="Instance_Properties" </dl> <dl> -<dt><a name="isurl" -><code class="code">isurl</code></a></dt> - -<dd> -<p>whether or not the attachment is a URL</p> -</dd> -</dl> - -<dl> <dt><a name="isobsolete" ><code class="code">isobsolete</code></a></dt> @@ -248,7 +239,7 @@ name="Class_Methods" <dd> <p>Description: inserts an attachment into the given bug.</p> -<p>Params: takes a hashref with the following keys: <code class="code">bug</code> - Bugzilla::Bug object - the bug for which to insert the attachment. <code class="code">data</code> - Either a filehandle pointing to the content of the attachment, or the content of the attachment itself. <code class="code">description</code> - string - describe what the attachment is about. <code class="code">filename</code> - string - the name of the attachment (used by the browser when downloading it). If the attachment is a URL, this parameter has no effect. <code class="code">mimetype</code> - string - a valid MIME type. <code class="code">creation_ts</code> - string (optional) - timestamp of the insert as returned by SELECT LOCALTIMESTAMP(0). <code class="code">ispatch</code> - boolean (optional, default false) - true if the attachment is a patch. <code class="code">isprivate</code> - boolean (optional, default false) - true if the attachment is private. <code class="code">isurl</code> - boolean (optional, default false) - true if the attachment is a URL pointing to some external ressource. <code class="code">store_in_file</code> - boolean (optional, default false) - true if the attachment must be stored in data/attachments/ instead of in the DB.</p> +<p>Params: takes a hashref with the following keys: <code class="code">bug</code> - Bugzilla::Bug object - the bug for which to insert the attachment. <code class="code">data</code> - Either a filehandle pointing to the content of the attachment, or the content of the attachment itself. <code class="code">description</code> - string - describe what the attachment is about. <code class="code">filename</code> - string - the name of the attachment (used by the browser when downloading it). If the attachment is a URL, this parameter has no effect. <code class="code">mimetype</code> - string - a valid MIME type. <code class="code">creation_ts</code> - string (optional) - timestamp of the insert as returned by SELECT LOCALTIMESTAMP(0). <code class="code">ispatch</code> - boolean (optional, default false) - true if the attachment is a patch. <code class="code">isprivate</code> - boolean (optional, default false) - true if the attachment is private.</p> <p>Returns: The new attachment object.</p> diff --git a/docs/en/html/api/Bugzilla/Auth.html b/docs/en/html/api/Bugzilla/Auth.html index fdc5fcb9b..b0db2031f 100644 --- a/docs/en/html/api/Bugzilla/Auth.html +++ b/docs/en/html/api/Bugzilla/Auth.html @@ -249,6 +249,12 @@ Note that this doesn't check the <code class="code">createemailregexp</code Params: None Returns: <code class="code">true</code> if users are allowed to create new Bugzilla accounts, <code class="code">false</code> otherwise.</p> +<dt><a name="extern_id_used" +><code class="code">extern_id_used</code></a></dt> + +<dd> +<p>Description: Whether or not current login system uses extern_id.</p> + <dt><a name="can_change_email" ><code class="code">can_change_email</code></a></dt> diff --git a/docs/en/html/api/Bugzilla/Auth/Login.html b/docs/en/html/api/Bugzilla/Auth/Login.html index c6436f001..a7ab41142 100644 --- a/docs/en/html/api/Bugzilla/Auth/Login.html +++ b/docs/en/html/api/Bugzilla/Auth/Login.html @@ -117,6 +117,14 @@ name="INFO_METHODS" <dd> <p>True if this login method requires no interaction from the user within Bugzilla. (For example, <code class="code">Env</code> auth is "automatic" because the webserver just passes us an environment variable on most page requests, and does not ask the user for authentication information directly in Bugzilla.) Defaults to <code class="code">false</code>.</p> + +<dt><a name="extern_id_used" +><code class="code">extern_id_used</code></a></dt> + +<dd> +<p>Whether or not this login method uses the extern_id field. If used, users with editusers permission will be be allowed to edit the extern_id for all users.</p> + +<p>The default value is <code class="code">0</code>.</p> </dd> </dl> <p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p> diff --git a/docs/en/html/api/Bugzilla/Auth/Verify.html b/docs/en/html/api/Bugzilla/Auth/Verify.html index 42f543ac7..27fcab8da 100644 --- a/docs/en/html/api/Bugzilla/Auth/Verify.html +++ b/docs/en/html/api/Bugzilla/Auth/Verify.html @@ -133,6 +133,16 @@ These are all no-parameter methods that return either <code class="code">true</ <dd> <p>Whether or not users can manually create accounts in this type of account source. Defaults to <code class="code">true</code>.</p> + +<dt><a name="extern_id_used" +><code class="code">extern_id_used</code></a></dt> + +<dd> +<p>Whether or not this verifier method uses the extern_id field. +If used, +users with editusers permission will be be allowed to edit the extern_id for all users.</p> + +<p>The default value is <code class="code">false</code>.</p> </dd> </dl> <p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p> diff --git a/docs/en/html/api/Bugzilla/DB.html b/docs/en/html/api/Bugzilla/DB.html index 32003eb80..633fb89d3 100644 --- a/docs/en/html/api/Bugzilla/DB.html +++ b/docs/en/html/api/Bugzilla/DB.html @@ -557,8 +557,8 @@ name="SQL_Generation" </dd> </dl> -<dt><a name="sql_interval" -><code class="code">sql_interval</code></a></dt> +<dt><a name="sql_date_math" +><code class="code">sql_date_math</code></a></dt> <dd> <dl> @@ -566,7 +566,7 @@ name="SQL_Generation" ><b>Description</b></a></dt> <dd> -<p>Outputs proper SQL syntax for a time interval function.</p> +<p>Outputs proper SQL syntax for adding some amount of time to a date.</p> <p>Abstract method, should be overridden by database specific code.</p> @@ -575,19 +575,37 @@ name="SQL_Generation" <dd> <dl> -<dt><a name="$interval_-_the_time_interval_requested_(e.g._'30')_(integer)" -><code class="code">$interval</code> - the time interval requested (e.g. '30') (integer)</a></dt> +<dt><a name="$date" +><code class="code">$date</code></a></dt> <dd> -<dt><a name="$units_-_the_units_the_interval_is_in_(e.g._'MINUTE')_(string)" -><code class="code">$units</code> - the units the interval is in (e.g. 'MINUTE') (string)</a></dt> +<p><code class="code">string</code> The date being added to or subtracted from.</p> + +<dt><a name="$operator" +><code class="code">$operator</code></a></dt> + +<dd> +<p><code class="code">string</code> Either <code class="code">-</code> or <code class="code">+</code>, depending on whether you're subtracting or adding.</p> + +<dt><a name="$interval" +><code class="code">$interval</code></a></dt> + +<dd> +<p><code class="code">integer</code> The time interval you're adding or subtracting (e.g. <code class="code">30</code>)</p> + +<dt><a name="$units" +><code class="code">$units</code></a></dt> + +<dd> +<p><code class="code">string</code> the units the interval is in (e.g. 'MINUTE')</p> +</dd> </dl> <dt><a name="Returns" ><b>Returns</b></a></dt> <dd> -<p>Formatted SQL for interval function (scalar)</p> +<p>Formatted SQL for adding or subtracting a date and some amount of time (scalar)</p> </dd> </dl> @@ -733,7 +751,7 @@ name="SQL_Generation" <p>If one value is returned, it is a numeric expression that indicates a match with a positive value and a non-match with zero. In this case, the DB must support casting numeric expresions to booleans.</p> -<p>If the DB does not support casting numeric expresions to booleans, then the first value is a boolean expression that indicates the presence of a match, and the second value is a numeric expression that can be used for ranking.</p> +<p>If two values are returned, then the first value is a boolean expression that indicates the presence of a match, and the second value is a numeric expression that can be used for ranking.</p> <p>There is a ANSI SQL version of this method implemented using LIKE operator, but it's not a real full text search. DB specific modules should override this, as this generic implementation will be always much slower. This generic implementation returns 'relevance' as 0 for no match, or 1 for a match.</p> diff --git a/docs/en/html/api/Bugzilla/DB/Schema.html b/docs/en/html/api/Bugzilla/DB/Schema.html index 61cada880..312492cba 100644 --- a/docs/en/html/api/Bugzilla/DB/Schema.html +++ b/docs/en/html/api/Bugzilla/DB/Schema.html @@ -549,6 +549,12 @@ name="METHODS" C<ABSTRACT_SCHEMA> format. Returns: nothing</pre> +<dt><a name="set_fk($table,_$column_\%fk_def)" +><code class="code">set_fk($table, $column \%fk_def)</code></a></dt> + +<dd> +<p>Sets the <code class="code">REFERENCES</code> item on the specified column.</p> + <dt><a name="set_index($table,_$name,_$definition)" ><code class="code">set_index($table, $name, $definition)</code></a></dt> @@ -619,7 +625,7 @@ name="SERIALIZATION/DESERIALIZATION" <pre class="code"> Description: Used for when you've read a serialized Schema off the disk, and you want a Schema object that represents that data. Params: $serialized - scalar. The serialized data. - $version - A number in the format X.YZ. The "version" + $version - A number. The "version" of the Schema that did the serialization. See the docs for C<SCHEMA_VERSION> for more details. Returns: A Schema object. It will have the methods of (and work diff --git a/docs/en/html/api/Bugzilla/DB/Sqlite.html b/docs/en/html/api/Bugzilla/DB/Sqlite.html new file mode 100644 index 000000000..3c749d4a3 --- /dev/null +++ b/docs/en/html/api/Bugzilla/DB/Sqlite.html @@ -0,0 +1,40 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> + <head> + <title> +Bugzilla::DB::Sqlite</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::DB::Sqlite</h1> +<div class='indexgroup'> +<ul class='indexList indexList1'> + <li class='indexItem indexItem1'><a href='#NAME'>NAME</a> + <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a> +</ul> +</div> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="NAME" +>NAME</a></h1> + +<p>Bugzilla::DB::Sqlite - Bugzilla database compatibility layer for SQLite</p> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="DESCRIPTION" +>DESCRIPTION</a></h1> + +<p>This module overrides methods of the Bugzilla::DB module with a SQLite-specific implementation. +It is instantiated by the Bugzilla::DB module and should never be used directly.</p> + +<p>For interface details see <a href="../../Bugzilla/DB.html" class="podlinkpod" +>Bugzilla::DB</a> and <a href="../../DBI.html" class="podlinkpod" +>DBI</a>.</p> +<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p> + +<!-- end doc --> + +</body></html> diff --git a/docs/en/html/api/Bugzilla/Extension.html b/docs/en/html/api/Bugzilla/Extension.html index a7f66f044..101f10812 100644 --- a/docs/en/html/api/Bugzilla/Extension.html +++ b/docs/en/html/api/Bugzilla/Extension.html @@ -68,6 +68,7 @@ Bugzilla::Extension</title> <li class='indexItem indexItem3'><a href='#enabled'>enabled</a> <li class='indexItem indexItem3'><a href='#package_dir'>package_dir</a> <li class='indexItem indexItem3'><a href='#template_dir'>template_dir</a> + <li class='indexItem indexItem3'><a href='#web_dir'>web_dir</a> <li class='indexItem indexItem3'><a href='#lib_dir'>lib_dir</a> </ul> </ul> @@ -511,6 +512,17 @@ name="template_dir" <p>If you want to override this method, and you have a <em class="code">Config.pm</em>, you must override this method in <em class="code">Config.pm</em>.</p> <h3><a class='u' href='#___top' title='click to go to top of document' +name="web_dir" +><code class="code">web_dir</code></a></h3> + +<p>The directory that your package's web related files are in, such as css and javascript.</p> + +<p>This defaults to the <code class="code">web</code> subdirectory of the <a href="#package_dir" class="podlinkpod" +>"package_dir"</a>.</p> + +<p>If you want to override this method, and you have a <em class="code">Config.pm</em>, you must override this method in <em class="code">Config.pm</em>.</p> + +<h3><a class='u' href='#___top' title='click to go to top of document' name="lib_dir" ><code class="code">lib_dir</code></a></h3> diff --git a/docs/en/html/api/Bugzilla/Field.html b/docs/en/html/api/Bugzilla/Field.html index 4eee90cf7..8dd85b0c7 100644 --- a/docs/en/html/api/Bugzilla/Field.html +++ b/docs/en/html/api/Bugzilla/Field.html @@ -39,7 +39,7 @@ name="SYNOPSIS" use Data::Dumper; # Display information about all fields. - print Dumper(Bugzilla->get_fields()); + print Dumper(Bugzilla->fields()); # Display information about non-obsolete custom fields. print Dumper(Bugzilla->active_custom_fields); @@ -47,9 +47,9 @@ name="SYNOPSIS" use Bugzilla::Field; # Display information about non-obsolete custom fields. - # Bugzilla->get_fields() is a wrapper around Bugzilla::Field->match(), - # so both methods take the same arguments. - print Dumper(Bugzilla::Field->match({ obsolete => 0, custom => 1 })); + # Bugzilla->fields() is a wrapper around Bugzilla::Field->get_all(), + # with arguments which filter the fields before returning them. + print Dumper(Bugzilla->fields({ obsolete => 0, custom => 1 })); # Create or update a custom field or field definition. my $field = Bugzilla::Field->create( @@ -211,12 +211,12 @@ name="Instance_Properties" </dl> <dl> -<dt><a name="visibility_value" -><code class="code">visibility_value</code></a></dt> +<dt><a name="visibility_values" +><code class="code">visibility_values</code></a></dt> <dd> <p>If we have a <a href="#visibility_field" class="podlinkpod" ->"visibility_field"</a>, then what value does that field have to be set to in order to show this field? Returns a <a href="../Bugzilla/Field/Choice.html" class="podlinkpod" +>"visibility_field"</a>, then what values does that field have to be set to in order to show this field? Returns a <a href="../Bugzilla/Field/Choice.html" class="podlinkpod" >Bugzilla::Field::Choice</a> or undef if there is no <code class="code">visibility_field</code> set.</p> </dd> </dl> @@ -287,6 +287,16 @@ name="Instance_Properties" </dd> </dl> +<dl> +<dt><a name="is_numeric" +><code class="code">is_numeric</code></a></dt> + +<dd> +<p>A boolean specifying whether or not this field logically contains numeric (integer, decimal, or boolean) values. By "logically contains" we mean that the user inputs numbers into the value of the field in the UI. This is mostly used by <a href="../Bugzilla/Search.html" class="podlinkpod" +>Bugzilla::Search</a>.</p> +</dd> +</dl> + <h2><a class='u' href='#___top' title='click to go to top of document' name="Instance_Mutators" >Instance Mutators</a></h2> @@ -330,8 +340,8 @@ name="Instance_Mutators" ><code class="code">set_visibility_field</code></a></dt> <dd> -<dt><a name="set_visibility_value" -><code class="code">set_visibility_value</code></a></dt> +<dt><a name="set_visibility_values" +><code class="code">set_visibility_values</code></a></dt> <dd> <dt><a name="set_value_field" diff --git a/docs/en/html/api/Bugzilla/Group.html b/docs/en/html/api/Bugzilla/Group.html index 5ce9ae6f8..472bbdc9c 100644 --- a/docs/en/html/api/Bugzilla/Group.html +++ b/docs/en/html/api/Bugzilla/Group.html @@ -70,15 +70,11 @@ name="SUBROUTINES" ><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. +<p>Description: ValidateGroupName checks to see if ANY of the users in the provided list of user objects can see the named group.</p> - Params: $name - String with the group name. - @users - An array with Bugzilla::User objects. +<p>Params: $name - String with the group name. @users - An array with Bugzilla::User objects.</p> - Returns: It returns the group id if successful - and undef otherwise.</pre> +<p>Returns: It returns the group id if successful and undef otherwise.</p> </dd> </dl> @@ -139,6 +135,12 @@ name="METHODS" </dd> </dl> +<dt><a name="check_members_are_visible" +><code class="code">check_members_are_visible</code></a></dt> + +<dd> +<p>Throws an error if this group is not visible (according to visibility groups) to the currently-logged-in user.</p> + <dt><a name="check_remove" ><code class="code">check_remove</code></a></dt> diff --git a/docs/en/html/api/Bugzilla/Hook.html b/docs/en/html/api/Bugzilla/Hook.html index 53d7390c5..34b82e05d 100644 --- a/docs/en/html/api/Bugzilla/Hook.html +++ b/docs/en/html/api/Bugzilla/Hook.html @@ -47,7 +47,9 @@ Bugzilla::Hook</title> <li class='indexItem indexItem2'><a href='#install_before_final_checks'>install_before_final_checks</a> <li class='indexItem indexItem2'><a href='#install_filesystem'>install_filesystem</a> <li class='indexItem indexItem2'><a href='#install_update_db'>install_update_db</a> + <li class='indexItem indexItem2'><a href='#install_update_db_fielddefs'>install_update_db_fielddefs</a> <li class='indexItem indexItem2'><a href='#db_schema_abstract_schema'>db_schema_abstract_schema</a> + <li class='indexItem indexItem2'><a href='#job_map'>job_map</a> <li class='indexItem indexItem2'><a href='#mailer_before_send'>mailer_before_send</a> <li class='indexItem indexItem2'><a href='#object_before_create'>object_before_create</a> <li class='indexItem indexItem2'><a href='#object_before_delete'>object_before_delete</a> @@ -530,6 +532,13 @@ name="bugmail_recipients" <p>(We use <code class="code">+</code> in front of <code class="code">REL_CC</code> so that Perl interprets it as a constant instead of as a string.)</p> +<dt><a name="users" +><code class="code">users</code></a></dt> + +<dd> +<p>This is a hash of <a href="../Bugzilla/User.html" class="podlinkpod" +>Bugzilla::User</a> objects, keyed by id. This is so you can find out more information about any of the user ids in the <code class="code">recipients</code> hash. Every id in the incoming <code class="code">recipients</code> hash will have an object in here. (But if you add additional recipients to the <code class="code">recipients</code> hash, you are <b>not</b> required to add them to this hash.)</p> + <dt><a name="diffs" ><code class="code">diffs</code></a></dt> @@ -745,7 +754,7 @@ name="install_before_final_checks" name="install_filesystem" >install_filesystem</a></h2> -<p>Allows for additional files and directories to be added to the list of files and directories already managed by checksetup.pl. You will be able to also set the permissions for the files and directories using this hook. You are also able to set or change permissions for current files and directories using this hook. You are also able to create appropriate htaccess files for the any directories to secure its contents. For examples see <a href="../FILESYSTEM.html" class="podlinkpod" +<p>Allows for additional files and directories to be added to the list of files and directories already managed by checksetup.pl. You will be able to also set permissions for the files and directories using this hook. You can also use this hook to create appropriate .htaccess files for any directory to secure its contents. For examples see <a href="../FILESYSTEM.html" class="podlinkpod" >FILESYSTEM</a> in <a href="../Bugzilla/Install/Filesystem.html" class="podlinkpod" >Bugzilla::Install::Filesystem</a>.</p> @@ -839,6 +848,15 @@ name="install_update_db" <p>This happens at the very end of all the tables being updated during an installation or upgrade. If you need to modify your custom schema or add new columns to existing tables, do it here. No params are passed.</p> <h2><a class='u' href='#___top' title='click to go to top of document' +name="install_update_db_fielddefs" +>install_update_db_fielddefs</a></h2> + +<p>This is used to update the schema of the fielddefs table before any other schema changes take place. No params are passed.</p> + +<p>This hook should only be used for updating the schema of the <code class="code">fielddefs</code> table. Do not modify any other table in this hook. To modify other tables, use the <a href="#install_update_db" class="podlinkpod" +>"install_update_db"</a> hook.</p> + +<h2><a class='u' href='#___top' title='click to go to top of document' name="db_schema_abstract_schema" >db_schema_abstract_schema</a></h2> @@ -856,6 +874,21 @@ name="db_schema_abstract_schema" </dl> <h2><a class='u' href='#___top' title='click to go to top of document' +name="job_map" +>job_map</a></h2> + +<p>Bugzilla has a system - <a href="../Bugzilla/JobQueue.html" class="podlinkpod" +>Bugzilla::JobQueue</a> - for running jobs asynchronously, if the administrator has set it up. This hook allows the addition of mappings from job names to handler classes, so an extension can fire off jobs.</p> + +<p>Params:</p> + +<dl> +<dt><a +><code class="code">job_map</code> - The job map hash. Key: the name of the job, as should be passed to Bugzilla->job_queue->insert(). Value: the name of the Perl module which implements the task (an instance of <a href="../TheSchwartz/Worker.html" class="podlinkpod" +>TheSchwartz::Worker</a>).</a></dt> +</dl> + +<h2><a class='u' href='#___top' title='click to go to top of document' name="mailer_before_send" >mailer_before_send</a></h2> diff --git a/docs/en/html/api/Bugzilla/Install/Filesystem.html b/docs/en/html/api/Bugzilla/Install/Filesystem.html index 86e713007..608596bcc 100644 --- a/docs/en/html/api/Bugzilla/Install/Filesystem.html +++ b/docs/en/html/api/Bugzilla/Install/Filesystem.html @@ -71,6 +71,15 @@ Note that permissions are different depending on whether or not <code class="co <p>Returns: nothing</p> +<dt><a name="fix_dir_permissions" +><code class="code">fix_dir_permissions</code></a></dt> + +<dd> +<p>Given the name of a directory, +its permissions will be fixed according to how they are supposed to be set in Bugzilla's current configuration. +If it fails to set the permissions, +a warning will be printed to STDERR.</p> + <dt><a name="fix_file_permissions" ><code class="code">fix_file_permissions</code></a></dt> diff --git a/docs/en/html/api/Bugzilla/Object.html b/docs/en/html/api/Bugzilla/Object.html index 30ee23337..23fe9bfdf 100644 --- a/docs/en/html/api/Bugzilla/Object.html +++ b/docs/en/html/api/Bugzilla/Object.html @@ -402,8 +402,7 @@ name="Database_Manipulation" >"create"</a>. This subroutine exists so that it can be overridden by subclasses who need to do special validations of their input parameters. This method is <b>only</b> called by <a href="#create" class="podlinkpod" >"create"</a>.</p> -<p>Params: The same as <a href="#create" class="podlinkpod" ->"create"</a>.</p> +<p>Params: <code class="code">$params</code> - hashref - A value to put in each database field for this object. <code class="code">$options</code> - hashref - Processing options. Currently the only option supported is <b>skip</b>, which can be used to specify a list of fields to not validate.</p> <p>Returns: A hash, in a similar format as <code class="code">$params</code>, except that these are the values to be inserted into the database, not the values that were input to <a href="#create" class="podlinkpod" >"create"</a>.</p> diff --git a/docs/en/html/api/Bugzilla/Token.html b/docs/en/html/api/Bugzilla/Token.html index 54efa29dc..86f8834b9 100644 --- a/docs/en/html/api/Bugzilla/Token.html +++ b/docs/en/html/api/Bugzilla/Token.html @@ -34,7 +34,7 @@ name="SYNOPSIS" <pre class="code"> use Bugzilla::Token; Bugzilla::Token::issue_new_user_account_token($login_name); - Bugzilla::Token::IssueEmailChangeToken($user, $old_email, $new_email); + Bugzilla::Token::IssueEmailChangeToken($user, $new_email); Bugzilla::Token::IssuePasswordToken($user); Bugzilla::Token::DeletePasswordTokens($user_id, $reason); Bugzilla::Token::Cancel($token, $cancelaction, $vars); @@ -68,8 +68,8 @@ name="SUBROUTINES" Returns: Nothing. It throws an error if the same user made the same request in the last few minutes.</pre> -<dt><a name="sub_IssueEmailChangeToken($user,_$old_email,_$new_email)" -><code class="code">sub IssueEmailChangeToken($user, $old_email, $new_email)</code></a></dt> +<dt><a name="sub_IssueEmailChangeToken($user,_$new_email)" +><code class="code">sub IssueEmailChangeToken($user, $new_email)</code></a></dt> <dd> <pre class="code"> Description: Sends two distinct tokens per email to the old and new email @@ -78,7 +78,6 @@ name="SUBROUTINES" Params: $user - User object of the user requesting a new email address. - $old_email - The current (old) email address of the user. $new_email - The new email address of the user. Returns: Nothing.</pre> diff --git a/docs/en/html/api/Bugzilla/User.html b/docs/en/html/api/Bugzilla/User.html index 52fb5652f..f39b140e0 100644 --- a/docs/en/html/api/Bugzilla/User.html +++ b/docs/en/html/api/Bugzilla/User.html @@ -153,6 +153,12 @@ name="Saved_and_Shared_Queries" <dd> <p>An arrayref of group ids. The user can share their own queries with these groups.</p> + +<dt><a name="tags" +><code class="code">tags</code></a></dt> + +<dd> +<p>Returns a hashref with tag IDs as key, and a hashref with tag 'id', 'name' and 'bug_count' as value.</p> </dd> </dl> @@ -254,6 +260,12 @@ name="Other_Methods" <dd> <p>Returns a hash of hashes which holds the user's settings. The first key is the name of the setting, as found in setting.name. The second key is one of: is_enabled - true if the user is allowed to set the preference themselves; false to force the site defaults for themselves or must accept the global site default value default_value - the global site default for this setting value - the value of this setting for this user. Will be the same as the default_value if the user is not logged in, or if is_default is true. is_default - a boolean to indicate whether the user has chosen to make a preference for themself or use the site default.</p> +<dt><a name="setting(name)" +><code class="code">setting(name)</code></a></dt> + +<dd> +<p>Returns the value for the specified setting.</p> + <dt><a name="timezone" ><code class="code">timezone</code></a></dt> @@ -428,6 +440,23 @@ name="Other_Methods" Returns: On success, a product object. On failure, an error is thrown.</pre> +<dt><a name="check_can_admin_flagtype($flagtype_id)" +><code class="code">check_can_admin_flagtype($flagtype_id)</code></a></dt> + +<dd> +<pre class="code"> Description: Checks whether the user is allowed to edit properties of the flag type. + If the flag type is also used by some products for which the user + hasn't editcomponents privs, then the user is only allowed to edit + the inclusion and exclusion lists for products he can administrate. + + Params: $flagtype_id - a flag type ID. + + Returns: On success, a flag type object. On failure, an error is thrown. + In list context, a boolean indicating whether the user can edit + all properties of the flag type is also returned. The boolean + is false if the user can only edit the inclusion and exclusions + lists.</pre> + <dt><a name="can_request_flag($flag_type)" ><code class="code">can_request_flag($flag_type)</code></a></dt> diff --git a/docs/en/html/api/Bugzilla/User/Setting.html b/docs/en/html/api/Bugzilla/User/Setting.html index 31c63f554..17c54d66e 100644 --- a/docs/en/html/api/Bugzilla/User/Setting.html +++ b/docs/en/html/api/Bugzilla/User/Setting.html @@ -162,8 +162,8 @@ name="POD_ERRORS" which are explained below:</b></p> <dl> -<dt><a name="Around_line_397:" ->Around line 397:</a></dt> +<dt><a name="Around_line_398:" +>Around line 398:</a></dt> <dd> <p>You forgot a '=back' before '=head1'</p> diff --git a/docs/en/html/api/Bugzilla/Util.html b/docs/en/html/api/Bugzilla/Util.html index 25351c1ac..234992193 100644 --- a/docs/en/html/api/Bugzilla/Util.html +++ b/docs/en/html/api/Bugzilla/Util.html @@ -275,6 +275,12 @@ name="String_Manipulation" <dd> <p>Disable utf8 on STDOUT (and display raw data instead).</p> +<dt><a name="detect_encoding($str)" +><code class="code">detect_encoding($str)</code></a></dt> + +<dd> +<p>Guesses what encoding a given data is encoded in, returning the canonical name of the detected encoding (which may be different from the MIME charset specification).</p> + <dt><a ><code class="code">clean_text($str)</code> Returns the parameter "cleaned" by exchanging non-printable characters with spaces. Specifically characters (ASCII 0 through 31) and (ASCII 127) will become ASCII 32 (Space).</a></dt> @@ -335,12 +341,6 @@ name="Formatting_Time" <p>This routine is mainly called from templates to filter dates, see "FILTER time" in <a href="../Bugzilla/Template.html" class="podlinkpod" >Bugzilla::Template</a>.</p> -<dt><a name="format_time_decimal($time)" -><code class="code">format_time_decimal($time)</code></a></dt> - -<dd> -<p>Returns a number with 2 digit precision, unless the last digit is a 0. Then it returns only 1 digit precision.</p> - <dt><a name="datetime_from($time,_$timezone)" ><code class="code">datetime_from($time, $timezone)</code></a></dt> diff --git a/docs/en/html/api/Bugzilla/WebService.html b/docs/en/html/api/Bugzilla/WebService.html index e41d1d56f..0f9342ee9 100644 --- a/docs/en/html/api/Bugzilla/WebService.html +++ b/docs/en/html/api/Bugzilla/WebService.html @@ -329,6 +329,11 @@ name="WebService_Methods" >Bugzilla::WebService::Bugzilla</a></a></dt> <dd> +<dt><a name="Bugzilla::WebService::Group" +><a href="../Bugzilla/WebService/Group.html" class="podlinkpod" +>Bugzilla::WebService::Group</a></a></dt> + +<dd> <dt><a name="Bugzilla::WebService::Product" ><a href="../Bugzilla/WebService/Product.html" class="podlinkpod" >Bugzilla::WebService::Product</a></a></dt> diff --git a/docs/en/html/api/Bugzilla/WebService/Bug.html b/docs/en/html/api/Bugzilla/WebService/Bug.html index f6f97779b..1caf38988 100644 --- a/docs/en/html/api/Bugzilla/WebService/Bug.html +++ b/docs/en/html/api/Bugzilla/WebService/Bug.html @@ -254,14 +254,20 @@ this will simply be an empty array.</p> >"create"</a>, etc.</p> -<dt><a name="sortkey" -><code class="code">sortkey</code></a></dt> +<dt><a name="sort_key" +><code class="code">sort_key</code></a></dt> <dd> <p><code class="code">int</code> Values, when displayed in a list, are sorted first by this integer and then secondly by their name.</p> +<dt><a name="sortkey" +><code class="code">sortkey</code></a></dt> + +<dd> +<p><b>DEPRECATED</b> - Use <code class="code">sort_key</code> instead.</p> + <dt><a name="visibility_values" ><code class="code">visibility_values</code></a></dt> @@ -332,6 +338,10 @@ this is an array of hashes that determines which statuses you can transition to <dd> <dt><a name="The_is_mandatory_return_value_was_added_in_Bugzilla_4.0." >The <code class="code">is_mandatory</code> return value was added in Bugzilla <b>4.0</b>.</a></dt> + +<dd> +<dt><a name="sortkey_was_renamed_to_sort_key_in_Bugzilla_4.2." +><code class="code">sortkey</code> was renamed to <code class="code">sort_key</code> in Bugzilla <b>4.2</b>.</a></dt> </dl> </dd> </dl> @@ -453,19 +463,14 @@ The return value looks like this:</p> <pre class="code"> { bugs => { - 1345 => { - attachments => [ - { (attachment) }, - { (attachment) } - ] - }, - 9874 => { - attachments => [ - { (attachment) }, - { (attachment) } - ] - - }, + 1345 => [ + { (attachment) }, + { (attachment) } + ], + 9874 => [ + { (attachment) }, + { (attachment) } + ], }, attachments => { @@ -474,7 +479,7 @@ The return value looks like this:</p> } }</pre> -<p>The attachments of any bugs that you specified in the <code class="code">ids</code> argument in input are returned in <code class="code">bugs</code> on output. <code class="code">bugs</code> is a hash that has integer bug IDs for keys and contains a single key, <code class="code">attachments</code>. That key points to an arrayref that contains attachments as a hash. (Fields for attachments are described below.)</p> +<p>The attachments of any bugs that you specified in the <code class="code">ids</code> argument in input are returned in <code class="code">bugs</code> on output. <code class="code">bugs</code> is a hash that has integer bug IDs for keys and the values are arrayrefs that contain hashes as attachments. (Fields for attachments are described below.)</p> <p>For any attachments that you specified directly in <code class="code">attachment_ids</code>, they are returned in <code class="code">attachments</code> on output. This is a hash where the attachment ids point directly to hashes describing the individual attachment.</p> @@ -543,12 +548,6 @@ The return value looks like this:</p> <dd> <p><code class="code">boolean</code> True if the attachment is obsolete, False otherwise.</p> -<dt><a name="is_url" -><code class="code">is_url</code></a></dt> - -<dd> -<p><code class="code">boolean</code> True if the attachment is a URL instead of actual data, False otherwise. Note that such attachments only happen when the Bugzilla installation has at some point had the <code class="code">allow_attach_url</code> parameter enabled.</p> - <dt><a name="is_patch" ><code class="code">is_patch</code></a></dt> @@ -600,6 +599,10 @@ The return value looks like this:</p> <dd> <dt><a name="The_data_return_value_was_added_in_Bugzilla_4.0." >The <code class="code">data</code> return value was added in Bugzilla <b>4.0</b>.</a></dt> + +<dd> +<dt><a name="In_Bugzilla_4.2,_the_is_url_return_value_was_removed_(this_attribute_no_longer_exists_for_attachments)." +>In Bugzilla <b>4.2</b>, the <code class="code">is_url</code> return value was removed (this attribute no longer exists for attachments).</a></dt> </dl> </dd> </dl> @@ -1777,14 +1780,6 @@ name="add_attachment" <p><code class="code">boolean</code> True if the attachment should be private (restricted to the "insidergroup"), False if the attachment should be public.</p> <p>Defaults to False if not specified.</p> - -<dt><a name="is_url" -><code class="code">is_url</code></a></dt> - -<dd> -<p><code class="code">boolean</code> True if the attachment is just a URL, pointing to data elsewhere. If so, the <code class="code">data</code> item should just contain the URL.</p> - -<p>Defaults to False if not specified.</p> </dd> </dl> @@ -1815,12 +1810,6 @@ name="add_attachment" <dd> <p>You specified a <code class="code">content_type</code> argument that was blank, not a valid MIME type, or not a MIME type that Bugzilla accepts for attachments.</p> -<dt><a name="602_(Illegal_URL)" ->602 (Illegal URL)</a></dt> - -<dd> -<p>You specified <code class="code">is_url</code> as True, but the data that you attempted to attach was not a valid URL.</p> - <dt><a name="603_(File_Name_Not_Specified)" >603 (File Name Not Specified)</a></dt> @@ -1833,12 +1822,6 @@ name="add_attachment" <dd> <p>You did not specify a value for the <code class="code">summary</code> argument.</p> -<dt><a name="605_(URL_Attaching_Disabled)" ->605 (URL Attaching Disabled)</a></dt> - -<dd> -<p>You attempted to attach a URL, setting <code class="code">is_url</code> to True, but this Bugzilla does not support attaching URLs.</p> - <dt><a name="606_(Empty_Data)" >606 (Empty Data)</a></dt> @@ -1846,6 +1829,19 @@ name="add_attachment" <p>You set the "data" field to an empty string.</p> </dd> </dl> + +<dt><a name="History" +><b>History</b></a></dt> + +<dd> +<dl> +<dt><a name="Added_in_Bugzilla_4.0." +>Added in Bugzilla <b>4.0</b>.</a></dt> + +<dd> +<dt><a name="The_is_url_parameter_was_removed_in_Bugzilla_4.2." +>The <code class="code">is_url</code> parameter was removed in Bugzilla <b>4.2</b>.</a></dt> +</dl> </dd> </dl> diff --git a/docs/en/html/api/Bugzilla/WebService/Group.html b/docs/en/html/api/Bugzilla/WebService/Group.html new file mode 100644 index 000000000..95c068876 --- /dev/null +++ b/docs/en/html/api/Bugzilla/WebService/Group.html @@ -0,0 +1,159 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> + <head> + <title> +Bugzilla::Webservice::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::Webservice::Group</h1> +<div class='indexgroup'> +<ul class='indexList indexList1'> + <li class='indexItem indexItem1'><a href='#NAME'>NAME</a> + <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a> + <li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a> + <li class='indexItem indexItem1'><a href='#Group_Creation'>Group Creation</a> + <ul class='indexList indexList2'> + <li class='indexItem indexItem2'><a href='#create'>create</a> + </ul> +</ul> +</div> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="NAME" +>NAME</a></h1> + +<p>Bugzilla::Webservice::Group - The API for creating, +changing, +and getting information about Groups.</p> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="DESCRIPTION" +>DESCRIPTION</a></h1> + +<p>This part of the Bugzilla API allows you to create Groups and get information about them.</p> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="METHODS" +>METHODS</a></h1> + +<p>See <a href="../../Bugzilla/WebService.html" class="podlinkpod" +>Bugzilla::WebService</a> for a description of how parameters are passed, +and what <b>STABLE</b>, +<b>UNSTABLE</b>, +and <b>EXPERIMENTAL</b> mean.</p> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="Group_Creation" +>Group Creation</a></h1> + +<h2><a class='u' href='#___top' title='click to go to top of document' +name="create" +>create</a></h2> + +<p><b>UNSTABLE</b></p> + +<dl> +<dt><a name="Description" +><b>Description</b></a></dt> + +<dd> +<p>This allows you to create a new group in Bugzilla.</p> + +<dt><a name="Params" +><b>Params</b></a></dt> + +<dd> +<p>Some params must be set, +or an error will be thrown. +These params are marked <b>Required</b>.</p> + +<dl> +<dt><a name="name" +><code class="code">name</code></a></dt> + +<dd> +<p><b>Required</b> <code class="code">string</code> A short name for this group. +Must be unique. +This is not usually displayed in the user interface, +except in a few places.</p> + +<dt><a name="description" +><code class="code">description</code></a></dt> + +<dd> +<p><b>Required</b> <code class="code">string</code> A human-readable name for this group. +Should be relatively short. +This is what will normally appear in the UI as the name of the group.</p> + +<dt><a name="user_regexp" +><code class="code">user_regexp</code></a></dt> + +<dd> +<p><code class="code">string</code> A regular expression. +Any user whose Bugzilla username matches this regular expression will automatically be granted membership in this group.</p> + +<dt><a name="is_active" +><code class="code">is_active</code></a></dt> + +<dd> +<p><code class="code">boolean</code> <code class="code">True</code> if new group can be used for bugs, +<code class="code">False</code> if this is a group that will only contain users and no bugs will be restricted to it.</p> + +<dt><a name="icon_url" +><code class="code">icon_url</code></a></dt> + +<dd> +<p><code class="code">string</code> A URL pointing to a small icon used to identify the group. +This icon will show up next to users' names in various parts of Bugzilla if they are in this group.</p> +</dd> +</dl> + +<dt><a name="Returns" +><b>Returns</b></a></dt> + +<dd> +<p>A hash with one element, +<code class="code">id</code>. +This is the id of the newly-created group.</p> + +<dt><a name="Errors" +><b>Errors</b></a></dt> + +<dd> +<dl> +<dt><a name="800_(Empty_Group_Name)" +>800 (Empty Group Name)</a></dt> + +<dd> +<p>You must specify a value for the <code class="code">name</code> field.</p> + +<dt><a name="801_(Group_Exists)" +>801 (Group Exists)</a></dt> + +<dd> +<p>There is already another group with the same <code class="code">name</code>.</p> + +<dt><a name="802_(Group_Missing_Description)" +>802 (Group Missing Description)</a></dt> + +<dd> +<p>You must specify a value for the <code class="code">description</code> field.</p> + +<dt><a name="803_(Group_Regexp_Invalid)" +>803 (Group Regexp Invalid)</a></dt> + +<dd> +<p>You specified an invalid regular expression in the <code class="code">user_regexp</code> field.</p> +</dd> +</dl> +</dd> +</dl> +<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p> + +<!-- end doc --> + +</body></html> diff --git a/docs/en/html/api/Bugzilla/WebService/Product.html b/docs/en/html/api/Bugzilla/WebService/Product.html index 33e29197b..99467f979 100644 --- a/docs/en/html/api/Bugzilla/WebService/Product.html +++ b/docs/en/html/api/Bugzilla/WebService/Product.html @@ -22,6 +22,10 @@ Bugzilla::Webservice::Product</title> <li class='indexItem indexItem2'><a href='#get_accessible_products'>get_accessible_products</a> <li class='indexItem indexItem2'><a href='#get'>get</a> </ul> + <li class='indexItem indexItem1'><a href='#Product_Creation'>Product Creation</a> + <ul class='indexList indexList2'> + <li class='indexItem indexItem2'><a href='#create'>create</a> + </ul> </ul> </div> @@ -157,9 +161,25 @@ name="get" ><b>Params</b></a></dt> <dd> -<p>A hash containing one item, -<code class="code">ids</code>, -that is an array of product ids.</p> +<p>In addition to the parameters below, +this method also accepts the standard <a href="../../Bugzilla/WebService.html#include_fields" class="podlinkpod" +>include_fields</a> and <a href="../../Bugzilla/WebService.html#exclude_fields" class="podlinkpod" +>exclude_fields</a> arguments.</p> + +<dl> +<dt><a name="ids" +><code class="code">ids</code></a></dt> + +<dd> +<p>An array of product ids</p> + +<dt><a name="names" +><code class="code">names</code></a></dt> + +<dd> +<p>An array of product names</p> +</dd> +</dl> <dt><a name="Returns" ><b>Returns</b></a></dt> @@ -169,15 +189,130 @@ that is an array of product ids.</p> <code class="code">products</code>, that is an array of hashes. Each hash describes a product, -and has the following items: <code class="code">id</code>, -<code class="code">name</code>, -<code class="code">description</code>, -and <code class="code">internals</code>. -The <code class="code">id</code> item is the id of the product. -The <code class="code">name</code> item is the name of the product. -The <code class="code">description</code> is the description of the product. -Finally, -the <code class="code">internals</code> is an internal representation of the product.</p> +and has the following items:</p> + +<dl> +<dt><a name="id" +><code class="code">id</code></a></dt> + +<dd> +<p><code class="code">int</code> An integer id uniquely identifying the product in this installation only.</p> + +<dt><a name="name" +><code class="code">name</code></a></dt> + +<dd> +<p><code class="code">string</code> The name of the product. +This is a unique identifier for the product.</p> + +<dt><a name="description" +><code class="code">description</code></a></dt> + +<dd> +<p><code class="code">string</code> A description of the product, +which may contain HTML.</p> + +<dt><a name="is_active" +><code class="code">is_active</code></a></dt> + +<dd> +<p><code class="code">boolean</code> A boolean indicating if the product is active.</p> + +<dt><a name="default_milestone" +><code class="code">default_milestone</code></a></dt> + +<dd> +<p><code class="code">string</code> The name of the default milestone for the product.</p> + +<dt><a name="has_unconfirmed" +><code class="code">has_unconfirmed</code></a></dt> + +<dd> +<p><code class="code">boolean</code> Indicates whether the UNCONFIRMED bug status is available for this product.</p> + +<dt><a name="classification" +><code class="code">classification</code></a></dt> + +<dd> +<p><code class="code">string</code> The classification name for the product.</p> + +<dt><a name="components" +><code class="code">components</code></a></dt> + +<dd> +<p><code class="code">array</code> An array of hashes, +where each hash describes a component, +and has the following items:</p> + +<dl> +<dt><a name="id" +><code class="code">id</code></a></dt> + +<dd> +<p><code class="code">int</code> An integer id uniquely identifying the component in this installation only.</p> + +<dt><a name="name" +><code class="code">name</code></a></dt> + +<dd> +<p><code class="code">string</code> The name of the component. +This is a unique identifier for this component.</p> + +<dt><a name="description" +><code class="code">description</code></a></dt> + +<dd> +<p><code class="code">string</code> A description of the component, +which may contain HTML.</p> + +<dt><a name="default_assigned_to" +><code class="code">default_assigned_to</code></a></dt> + +<dd> +<p><code class="code">string</code> The login name of the user to whom new bugs will be assigned by default.</p> + +<dt><a name="default_qa_contact" +><code class="code">default_qa_contact</code></a></dt> + +<dd> +<p><code class="code">string</code> The login name of the user who will be set as the QA Contact for new bugs by default.</p> + +<dt><a name="sort_key" +><code class="code">sort_key</code></a></dt> + +<dd> +<p><code class="code">int</code> Components, +when displayed in a list, +are sorted first by this integer and then secondly by their name.</p> + +<dt><a name="is_active" +><code class="code">is_active</code></a></dt> + +<dd> +<p><code class="code">boolean</code> A boolean indicating if the component is active. +Inactive components are not enabled for new bugs.</p> +</dd> +</dl> + +<dt><a name="versions" +><code class="code">versions</code></a></dt> + +<dd> +<p><code class="code">array</code> An array of hashes, +where each hash describes a version, +and has the following items: <code class="code">name</code>, +<code class="code">sort_key</code> and <code class="code">is_active</code>.</p> + +<dt><a name="milestones" +><code class="code">milestones</code></a></dt> + +<dd> +<p><code class="code">array</code> An array of hashes, +where each hash describes a milestone, +and has the following items: <code class="code">name</code>, +<code class="code">sort_key</code> and <code class="code">is_active</code>.</p> +</dd> +</dl> <p>Note, that if the user tries to access a product that is not in the list of accessible products for the user, @@ -187,6 +322,164 @@ and no information about that product is returned.</p> <dt><a name="Errors_(none)" ><b>Errors</b> (none)</a></dt> + +<dd> +<dt><a name="History" +><b>History</b></a></dt> + +<dd> +<dl> +<dt><a name="In_Bugzilla_4.2,_names_was_added_as_an_input_parameter." +>In Bugzilla <b>4.2</b>, +<code class="code">names</code> was added as an input parameter.</a></dt> + +<dd> +<dt><a +>In Bugzilla <b>4.2</b>, +<code class="code">classification</code>, +<code class="code">components</code>, +<code class="code">versions</code>, +<code class="code">milestones</code>, +<code class="code">default_milestone</code> and <code class="code">has_unconfirmed</code> were added to the fields returned by <code class="code">get</code> as a replacement for <code class="code">internals</code>, +which has been removed.</a></dt> +</dl> +</dd> +</dl> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="Product_Creation" +>Product Creation</a></h1> + +<h2><a class='u' href='#___top' title='click to go to top of document' +name="create" +>create</a></h2> + +<p><b>EXPERIMENTAL</b></p> + +<dl> +<dt><a name="Description" +><b>Description</b></a></dt> + +<dd> +<p>This allows you to create a new product in Bugzilla.</p> + +<dt><a name="Params" +><b>Params</b></a></dt> + +<dd> +<p>Some params must be set, +or an error will be thrown. +These params are marked <b>Required</b>.</p> + +<dl> +<dt><a name="name" +><code class="code">name</code></a></dt> + +<dd> +<p><b>Required</b> <code class="code">string</code> The name of this product. +Must be globally unique within Bugzilla.</p> + +<dt><a name="description" +><code class="code">description</code></a></dt> + +<dd> +<p><b>Required</b> <code class="code">string</code> A description for this product. +Allows some simple HTML.</p> + +<dt><a name="version" +><code class="code">version</code></a></dt> + +<dd> +<p><b>Required</b> <code class="code">string</code> The default version for this product.</p> + +<dt><a name="has_unconfirmed" +><code class="code">has_unconfirmed</code></a></dt> + +<dd> +<p><code class="code">boolean</code> Allow the UNCONFIRMED status to be set on bugs in this product. +Default: true.</p> + +<dt><a name="classification" +><code class="code">classification</code></a></dt> + +<dd> +<p><code class="code">string</code> The name of the Classification which contains this product.</p> + +<dt><a name="default_milestone" +><code class="code">default_milestone</code></a></dt> + +<dd> +<p><code class="code">string</code> The default milestone for this product. +Default: '---'.</p> + +<dt><a name="is_open" +><code class="code">is_open</code></a></dt> + +<dd> +<p><code class="code">boolean</code> True if the product is currently allowing bugs to be entered into it. +Default: true.</p> + +<dt><a name="create_series" +><code class="code">create_series</code></a></dt> + +<dd> +<p><code class="code">boolean</code> True if you want series for New Charts to be created for this new product. +Default: true.</p> +</dd> +</dl> + +<dt><a name="Returns" +><b>Returns</b></a></dt> + +<dd> +<p>A hash with one element, +id. +This is the id of the newly-filed product.</p> + +<dt><a name="Errors" +><b>Errors</b></a></dt> + +<dd> +<dl> +<dt><a name="51_(Classification_does_not_exist)" +>51 (Classification does not exist)</a></dt> + +<dd> +<p>You must specify an existing classification name.</p> + +<dt><a name="700_(Product_blank_name)" +>700 (Product blank name)</a></dt> + +<dd> +<p>You must specify a non-blank name for this product.</p> + +<dt><a name="701_(Product_name_too_long)" +>701 (Product name too long)</a></dt> + +<dd> +<p>The name specified for this product was longer than the maximum allowed length.</p> + +<dt><a name="702_(Product_name_already_exists)" +>702 (Product name already exists)</a></dt> + +<dd> +<p>You specified the name of a product that already exists. +(Product names must be globally unique in Bugzilla.)</p> + +<dt><a name="703_(Product_must_have_description)" +>703 (Product must have description)</a></dt> + +<dd> +<p>You must specify a description for this product.</p> + +<dt><a name="704_(Product_must_have_version)" +>704 (Product must have version)</a></dt> + +<dd> +<p>You must specify a version for this product.</p> +</dd> +</dl> +</dd> </dl> <p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p> diff --git a/docs/en/html/api/collectstats.html b/docs/en/html/api/collectstats.html new file mode 100644 index 000000000..c80f4d598 --- /dev/null +++ b/docs/en/html/api/collectstats.html @@ -0,0 +1,64 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> + <head> + <title> +collectstats.pl</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>collectstats.pl</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='#OPTIONS'>OPTIONS</a> + <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a> +</ul> +</div> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="NAME" +>NAME</a></h1> + +<p>collectstats.pl - Collect data about Bugzilla bugs.</p> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="SYNOPSIS" +>SYNOPSIS</a></h1> + +<pre class="code"> ./collectstats.pl [--regenerate] [--help]</pre> + +<p>Collects data about bugs to be used in Old and New Charts.</p> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="OPTIONS" +>OPTIONS</a></h1> + +<dl> +<dt><a name="--help" +><b>--help</b></a></dt> + +<dd> +<p>Print this help page.</p> + +<dt><a name="--regenerate" +><b>--regenerate</b></a></dt> + +<dd> +<p>Recreate all the data about bugs, from day 1. This option is only relevant for Old Charts, and has no effect for New Charts. This option will overwrite all existing collected data and can take a huge amount of time. You normally don't need to use this option (do not use it in a cron job).</p> +</dd> +</dl> + +<h1><a class='u' href='#___top' title='click to go to top of document' +name="DESCRIPTION" +>DESCRIPTION</a></h1> + +<p>This script collects data about all bugs for Old Charts, triaged by product and by bug status and resolution. It also collects data for New Charts, based on existing series. For New Charts, data is only collected once a series is defined; this script cannot recreate data prior to this date.</p> +<p class="backlinkbottom"><b><a name="___bottom" href="index.html" title="All Documents"><<</a></b></p> + +<!-- end doc --> + +</body></html> diff --git a/docs/en/html/api/index.html b/docs/en/html/api/index.html index c089302fa..af8b058b4 100644 --- a/docs/en/html/api/index.html +++ b/docs/en/html/api/index.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> - <title>Bugzilla 4.0.4 API Documentation</title> + <title>Bugzilla 4.2 API Documentation</title> <link rel="stylesheet" title="style" type="text/css" href="./../../../style.css" media="all" > </head> <body class="contentspage"> - <h1>Bugzilla 4.0.4 API Documentation</h1> + <h1>Bugzilla 4.2 API Documentation</h1> <dl class='superindex'> <dt><a name="Extensions">Extensions</a></dt> <dd> @@ -27,50 +27,54 @@ <td>A do-it-all upgrade and installation script for Bugzilla.</td> </tr> <tr class="odd"> + <th><a href="./collectstats.html">collectstats</a></th> + <td>Collect data about Bugzilla bugs.</td> +</tr> +<tr class="even"> <th><a href="./contrib/bz_webservice_demo.html">contrib::bz_webservice_demo</a></th> <td>Show how to talk to Bugzilla via XMLRPC</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./contrib/bzdbcopy.html">contrib::bzdbcopy</a></th> <td>Copies data from one Bugzilla database to another.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./contrib/console.html">contrib::console</a></th> <td>command-line interface to Bugzilla API</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./contrib/extension-convert.html">contrib::extension-convert</a></th> <td>Convert extensions from the pre-3.6 format to the 3.6 format.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./contrib/merge-users.html">contrib::merge-users</a></th> <td>Merge two user accounts.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./contrib/recode.html">contrib::recode</a></th> <td>Converts a database from one encoding (or multiple encodings) to UTF-8.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./email_in.html">email_in</a></th> <td>The Bugzilla Inbound Email Interface</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./importxml.html">importxml</a></th> <td>Import bugzilla bug data from xml.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./install-module.html">install-module</a></th> <td>Installs or upgrades modules from CPAN. This script does not run on Windows.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./jobqueue.html">jobqueue</a></th> <td>Runs jobs in the background for Bugzilla.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./migrate.html">migrate</a></th> <td>A script to migrate from other bug-trackers to Bugzilla.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./sanitycheck.html">sanitycheck</a></th> <td>Perl script to perform a sanity check at the command line</td> </tr> @@ -144,173 +148,181 @@ <td>Abstract database schema for Bugzilla</td> </tr> <tr class="even"> + <th><a href="./Bugzilla/DB/Sqlite.html">Bugzilla::DB::Sqlite</a></th> + <td>Bugzilla database compatibility layer for SQLite</td> +</tr> +<tr class="odd"> <th><a href="./Bugzilla/Error.html">Bugzilla::Error</a></th> <td>Error handling utilities for Bugzilla</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Extension.html">Bugzilla::Extension</a></th> <td>Base class for Bugzilla Extensions.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Field.html">Bugzilla::Field</a></th> <td>a particular piece of information about bugs and useful routines for form field manipulation</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Field/Choice.html">Bugzilla::Field::Choice</a></th> <td>A legal value for a <select>-type field.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Field/ChoiceInterface.html">Bugzilla::Field::ChoiceInterface</a></th> <td>Makes an object act like a Bugzilla::Field::Choice.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Flag.html">Bugzilla::Flag</a></th> <td>A module to deal with Bugzilla flag values.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/FlagType.html">Bugzilla::FlagType</a></th> <td>A module to deal with Bugzilla flag types.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Group.html">Bugzilla::Group</a></th> <td>Bugzilla group class.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Hook.html">Bugzilla::Hook</a></th> <td>Extendable extension hooks for Bugzilla code</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Install.html">Bugzilla::Install</a></th> <td>Functions and variables having to do with installation.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Install/CPAN.html">Bugzilla::Install::CPAN</a></th> <td>Routines to install Perl modules from CPAN.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Install/DB.html">Bugzilla::Install::DB</a></th> <td>Fix up the database during installation.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Install/Filesystem.html">Bugzilla::Install::Filesystem</a></th> <td>Fix up the filesystem during installation.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Install/Localconfig.html">Bugzilla::Install::Localconfig</a></th> <td></td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Install/Requirements.html">Bugzilla::Install::Requirements</a></th> <td>Functions and variables dealing with Bugzilla's perl-module requirements.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Install/Util.html">Bugzilla::Install::Util</a></th> <td>Utility functions that are useful both during installation and afterwards.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/JobQueue.html">Bugzilla::JobQueue</a></th> <td>Interface between Bugzilla and TheSchwartz.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/JobQueue/Runner.html">Bugzilla::JobQueue::Runner</a></th> <td>A class representing the daemon that runs the job queue.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Keyword.html">Bugzilla::Keyword</a></th> <td>A Keyword that can be added to a bug.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Migrate.html">Bugzilla::Migrate</a></th> <td>Functions to migrate from other databases</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Milestone.html">Bugzilla::Milestone</a></th> <td>Bugzilla product milestone class.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Object.html">Bugzilla::Object</a></th> <td>A base class for objects in Bugzilla.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Product.html">Bugzilla::Product</a></th> <td>Bugzilla product class.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Search/Recent.html">Bugzilla::Search::Recent</a></th> <td>A search recently run by a logged-in user.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Search/Saved.html">Bugzilla::Search::Saved</a></th> <td>A saved search</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Status.html">Bugzilla::Status</a></th> <td>Bug status class.</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Template.html">Bugzilla::Template</a></th> <td>Wrapper around the Template Toolkit Template object</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Template/Plugin/Bugzilla.html">Bugzilla::Template::Plugin::Bugzilla</a></th> <td></td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Template/Plugin/Hook.html">Bugzilla::Template::Plugin::Hook</a></th> <td></td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Template/Plugin/User.html">Bugzilla::Template::Plugin::User</a></th> <td></td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Token.html">Bugzilla::Token</a></th> <td>Provides different routines to manage tokens.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Update.html">Bugzilla::Update</a></th> <td>Update routines for Bugzilla</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/User.html">Bugzilla::User</a></th> <td>Object for a Bugzilla user</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/User/Setting.html">Bugzilla::User::Setting</a></th> <td>Object for a user preference setting</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/User/Setting/Lang.html">Bugzilla::User::Setting::Lang</a></th> <td>Object for a user preference setting for preferred language</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/User/Setting/Skin.html">Bugzilla::User::Setting::Skin</a></th> <td>Object for a user preference setting for skins</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/User/Setting/Timezone.html">Bugzilla::User::Setting::Timezone</a></th> <td>Object for a user preference setting for desired timezone</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/Util.html">Bugzilla::Util</a></th> <td>Generic utility functions for bugzilla</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/Version.html">Bugzilla::Version</a></th> <td>Bugzilla product version class.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/WebService.html">Bugzilla::WebService</a></th> <td>The Web Service interface to Bugzilla</td> </tr> -<tr class="even"> +<tr class="odd"> <th><a href="./Bugzilla/WebService/Bug.html">Bugzilla::WebService::Bug</a></th> <td>The API for creating, changing, and getting the details of bugs.</td> </tr> -<tr class="odd"> +<tr class="even"> <th><a href="./Bugzilla/WebService/Bugzilla.html">Bugzilla::WebService::Bugzilla</a></th> <td>Global functions for the webservice interface.</td> </tr> +<tr class="odd"> + <th><a href="./Bugzilla/WebService/Group.html">Bugzilla::WebService::Group</a></th> + <td>The API for creating, changing, and getting information about Groups.</td> +</tr> <tr class="even"> <th><a href="./Bugzilla/WebService/Product.html">Bugzilla::WebService::Product</a></th> <td>The Product API</td> diff --git a/docs/en/html/api/jobqueue.html b/docs/en/html/api/jobqueue.html index b8a5bb2c2..5175a8276 100644 --- a/docs/en/html/api/jobqueue.html +++ b/docs/en/html/api/jobqueue.html @@ -44,6 +44,8 @@ name="SYNOPSIS" stop Stops a running jobqueue daemon restart Stops a running jobqueue if one is running, and then starts a new one. + once Checks the job queue once, executes the first item found (if + any) and then exits check Report the current status of the daemon. install On some *nix systems, this automatically installs and configures jobqueue.pl as a system service so that it will |