532 lines
23 KiB
HTML
532 lines
23 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>
|
|
Bugzilla::Object</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::Object</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='#CONSTANTS'>CONSTANTS</a>
|
|
<li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
|
|
<ul class='indexList indexList2'>
|
|
<li class='indexItem indexItem2'><a href='#Constructors'>Constructors</a>
|
|
<li class='indexItem indexItem2'><a href='#Database_Manipulation'>Database Manipulation</a>
|
|
<li class='indexItem indexItem2'><a href='#Mutators'>Mutators</a>
|
|
<li class='indexItem indexItem2'><a href='#Simple_Validators'>Simple Validators</a>
|
|
</ul>
|
|
<li class='indexItem indexItem1'><a href='#CLASS_FUNCTIONS'>CLASS FUNCTIONS</a>
|
|
</ul>
|
|
</div>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="NAME"
|
|
>NAME</a></h1>
|
|
|
|
<p>Bugzilla::Object - A base class for objects in Bugzilla.</p>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="SYNOPSIS"
|
|
>SYNOPSIS</a></h1>
|
|
|
|
<pre class="code"> my $object = new Bugzilla::Object(1);
|
|
my $object = new Bugzilla::Object({name => 'TestProduct'});
|
|
|
|
my $id = $object->id;
|
|
my $name = $object->name;</pre>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="DESCRIPTION"
|
|
>DESCRIPTION</a></h1>
|
|
|
|
<p>Bugzilla::Object is a base class for Bugzilla objects. You never actually create a Bugzilla::Object directly, you only make subclasses of it.</p>
|
|
|
|
<p>Basically, Bugzilla::Object exists to allow developers to create objects more easily. All you have to do is define <code class="code">DB_TABLE</code>, <code class="code">DB_COLUMNS</code>, and sometimes <code class="code">LIST_ORDER</code> and you have a whole new object.</p>
|
|
|
|
<p>You should also define accessors for any columns other than <code class="code">name</code> or <code class="code">id</code>.</p>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="CONSTANTS"
|
|
>CONSTANTS</a></h1>
|
|
|
|
<p>Frequently, these will be the only things you have to define in your subclass in order to have a fully-functioning object. <code class="code">DB_TABLE</code> and <code class="code">DB_COLUMNS</code> are required.</p>
|
|
|
|
<dl>
|
|
<dt><a name="DB_TABLE"
|
|
><code class="code">DB_TABLE</code></a></dt>
|
|
|
|
<dd>
|
|
<p>The name of the table that these objects are stored in. For example, for <code class="code">Bugzilla::Keyword</code> this would be <code class="code">keyworddefs</code>.</p>
|
|
|
|
<dt><a name="DB_COLUMNS"
|
|
><code class="code">DB_COLUMNS</code></a></dt>
|
|
|
|
<dd>
|
|
<p>The names of the columns that you want to read out of the database and into this object. This should be an array.</p>
|
|
|
|
<dt><a name="NAME_FIELD"
|
|
><code class="code">NAME_FIELD</code></a></dt>
|
|
|
|
<dd>
|
|
<p>The name of the column that should be considered to be the unique "name" of this object. The 'name' is a <b>string</b> that uniquely identifies this Object in the database. Defaults to 'name'. When you specify <code class="code">{name =</code> $name}> to <code class="code">new()</code>, this is the column that will be matched against in the DB.</p>
|
|
|
|
<dt><a name="ID_FIELD"
|
|
><code class="code">ID_FIELD</code></a></dt>
|
|
|
|
<dd>
|
|
<p>The name of the column that represents the unique <b>integer</b> ID of this object in the database. Defaults to 'id'.</p>
|
|
|
|
<dt><a name="LIST_ORDER"
|
|
><code class="code">LIST_ORDER</code></a></dt>
|
|
|
|
<dd>
|
|
<p>The order that <code class="code">new_from_list</code> and <code class="code">get_all</code> should return objects in. This should be the name of a database column. Defaults to <a href="#NAME_FIELD" class="podlinkpod"
|
|
>"NAME_FIELD"</a>.</p>
|
|
|
|
<dt><a name="REQUIRED_CREATE_FIELDS"
|
|
><code class="code">REQUIRED_CREATE_FIELDS</code></a></dt>
|
|
|
|
<dd>
|
|
<p>The list of fields that <b>must</b> be specified when the user calls <code class="code">create()</code>. This should be an array.</p>
|
|
|
|
<dt><a name="VALIDATORS"
|
|
><code class="code">VALIDATORS</code></a></dt>
|
|
|
|
<dd>
|
|
<p>A hashref that points to a function that will validate each param to <a href="#create" class="podlinkpod"
|
|
>"create"</a>.</p>
|
|
|
|
<p>Validators are called both by <a href="#create" class="podlinkpod"
|
|
>"create"</a> and <a href="#set" class="podlinkpod"
|
|
>"set"</a>. When they are called by <a href="#create" class="podlinkpod"
|
|
>"create"</a>, the first argument will be the name of the class (what we normally call <code class="code">$class</code>).</p>
|
|
|
|
<p>When they are called by <a href="#set" class="podlinkpod"
|
|
>"set"</a>, the first argument will be a reference to the current object (what we normally call <code class="code">$self</code>).</p>
|
|
|
|
<p>The second argument will be the value passed to <a href="#create" class="podlinkpod"
|
|
>"create"</a> or <a href="#set" class="podlinkpod"
|
|
>"set"</a>for that field.</p>
|
|
|
|
<p>The third argument will be the name of the field being validated. This may be required by validators which validate several distinct fields.</p>
|
|
|
|
<p>These functions should call <a href="../Bugzilla/Error.html#ThrowUserError" class="podlinkpod"
|
|
>"ThrowUserError" in Bugzilla::Error</a> if they fail.</p>
|
|
|
|
<p>The validator must return the validated value.</p>
|
|
|
|
<dt><a name="UPDATE_VALIDATORS"
|
|
><code class="code">UPDATE_VALIDATORS</code></a></dt>
|
|
|
|
<dd>
|
|
<p>This is just like <a href="#VALIDATORS" class="podlinkpod"
|
|
>"VALIDATORS"</a>, but these validators are called only when updating an object, not when creating it. Any validator that appears here must not appear in <a href="#VALIDATORS" class="podlinkpod"
|
|
>"VALIDATORS"</a>.</p>
|
|
|
|
<p><a href="../Bugzilla/Bug.html" class="podlinkpod"
|
|
>Bugzilla::Bug</a> has good examples in its code of when to use this.</p>
|
|
|
|
<dt><a name="UPDATE_COLUMNS"
|
|
><code class="code">UPDATE_COLUMNS</code></a></dt>
|
|
|
|
<dd>
|
|
<p>A list of columns to update when <a href="#update" class="podlinkpod"
|
|
>"update"</a> is called. If a field can't be changed, it shouldn't be listed here. (For example, the <a href="#ID_FIELD" class="podlinkpod"
|
|
>"ID_FIELD"</a> usually can't be updated.)</p>
|
|
|
|
<dt><a name="NUMERIC_COLUMNS"
|
|
><code class="code">NUMERIC_COLUMNS</code></a></dt>
|
|
|
|
<dd>
|
|
<p>When <a href="#update" class="podlinkpod"
|
|
>"update"</a> is called, it compares each column in the object to its current value in the database. It only updates columns that have changed.</p>
|
|
|
|
<p>Any column listed in NUMERIC_COLUMNS is treated as a number, not as a string, during these comparisons.</p>
|
|
|
|
<dt><a name="DATE_COLUMNS"
|
|
><code class="code">DATE_COLUMNS</code></a></dt>
|
|
|
|
<dd>
|
|
<p>This is much like <a href="#NUMERIC_COLUMNS" class="podlinkpod"
|
|
>"NUMERIC_COLUMNS"</a>, except that it treats strings as dates when being compared. So, for example, <code class="code">2007-01-01</code> would be equal to <code class="code">2007-01-01 00:00:00</code>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="METHODS"
|
|
>METHODS</a></h1>
|
|
|
|
<h2><a class='u' href='#___top' title='click to go to top of document'
|
|
name="Constructors"
|
|
>Constructors</a></h2>
|
|
|
|
<dl>
|
|
<dt><a name="new"
|
|
><code class="code">new</code></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a name="Description"
|
|
><b>Description</b></a></dt>
|
|
|
|
<dd>
|
|
<p>The constructor is used to load an existing object from the database, by id or by name.</p>
|
|
|
|
<dt><a name="Params"
|
|
><b>Params</b></a></dt>
|
|
|
|
<dd>
|
|
<p>If you pass an integer, the integer is the id of the object, from the database, that we want to read in. (id is defined as the value in the <a href="#ID_FIELD" class="podlinkpod"
|
|
>"ID_FIELD"</a> column).</p>
|
|
|
|
<p>If you pass in a hashref, you can pass a <code class="code">name</code> key. The value of the <code class="code">name</code> key is the case-insensitive name of the object (from <a href="#NAME_FIELD" class="podlinkpod"
|
|
>"NAME_FIELD"</a>) in the DB. You can also pass in an <code class="code">id</code> key which will be interpreted as the id of the object you want (overriding the <code class="code">name</code> key).</p>
|
|
|
|
<p><b>Additional Parameters Available for Subclasses</b></p>
|
|
|
|
<p>If you are a subclass of <code class="code">Bugzilla::Object</code>, you can pass <code class="code">condition</code> and <code class="code">values</code> as hash keys, instead of the above.</p>
|
|
|
|
<p><code class="code">condition</code> is a set of SQL conditions for the WHERE clause, which contain placeholders.</p>
|
|
|
|
<p><code class="code">values</code> is a reference to an array. The array contains the values for each placeholder in <code class="code">condition</code>, in order.</p>
|
|
|
|
<p>This is to allow subclasses to have complex parameters, and then to translate those parameters into <code class="code">condition</code> and <code class="code">values</code> when they call <code class="code">$self-</code>SUPER::new> (which is this function, usually).</p>
|
|
|
|
<p>If you try to call <code class="code">new</code> outside of a subclass with the <code class="code">condition</code> and <code class="code">values</code> parameters, Bugzilla will throw an error. These parameters are intended <b>only</b> for use by subclasses.</p>
|
|
|
|
<dt><a name="Returns"
|
|
><b>Returns</b></a></dt>
|
|
|
|
<dd>
|
|
<p>A fully-initialized object, or <code class="code">undef</code> if there is no object in the database matching the parameters you passed in.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dt><a name="check"
|
|
><code class="code">check</code></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a name="Description"
|
|
><b>Description</b></a></dt>
|
|
|
|
<dd>
|
|
<p>Checks if there is an object in the database with the specified name, and throws an error if you specified an empty name, or if there is no object in the database with that name.</p>
|
|
|
|
<dt><a name="Params"
|
|
><b>Params</b></a></dt>
|
|
|
|
<dd>
|
|
<p>The parameters are the same as for <a href="#new" class="podlinkpod"
|
|
>"new"</a>, except that if you don't pass a hashref, the single argument is the <i>name</i> of the object, not the id.</p>
|
|
|
|
<dt><a name="Returns"
|
|
><b>Returns</b></a></dt>
|
|
|
|
<dd>
|
|
<p>A fully initialized object, guaranteed.</p>
|
|
|
|
<dt><a name="Notes_For_Implementors"
|
|
><b>Notes For Implementors</b></a></dt>
|
|
|
|
<dd>
|
|
<p>If you implement this in your subclass, make sure that you also update the <code class="code">object_name</code> block at the bottom of the <em class="code">global/user-error.html.tmpl</em> template.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dt><a name="new_from_list(\@id_list)"
|
|
><code class="code">new_from_list(\@id_list)</code></a></dt>
|
|
|
|
<dd>
|
|
<pre class="code"> Description: Creates an array of objects, given an array of ids.
|
|
|
|
Params: \@id_list - A reference to an array of numbers, database ids.
|
|
If any of these are not numeric, the function
|
|
will throw an error. If any of these are not
|
|
valid ids in the database, they will simply
|
|
be skipped.
|
|
|
|
Returns: A reference to an array of objects.</pre>
|
|
|
|
<dt><a name="match"
|
|
><code class="code">match</code></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a name="Description"
|
|
><b>Description</b></a></dt>
|
|
|
|
<dd>
|
|
<p>Gets a list of objects from the database based on certain criteria.</p>
|
|
|
|
<p>Basically, a simple way of doing a sort of "SELECT" statement (like SQL) to get objects.</p>
|
|
|
|
<p>All criteria are joined by <code class="code">AND</code>, so adding more criteria will give you a smaller set of results, not a larger set.</p>
|
|
|
|
<dt><a name="Params"
|
|
><b>Params</b></a></dt>
|
|
|
|
<dd>
|
|
<p>A hashref, where the keys are column names of the table, pointing to the value that you want to match against for that column.</p>
|
|
|
|
<p>There are two special values, the constants <code class="code">NULL</code> and <code class="code">NOT_NULL</code>, which means "give me objects where this field is NULL or NOT NULL, respectively."</p>
|
|
|
|
<p>In addition to the column keys, there are a few special keys that can be used to rig the underlying database queries. These are <code class="code">LIMIT</code>, <code class="code">OFFSET</code>, and <code class="code">WHERE</code>.</p>
|
|
|
|
<p>The value for the <code class="code">LIMIT</code> key is expected to be an integer defining the number of objects to return, while the value for <code class="code">OFFSET</code> defines the position, relative to the number of objects the query would normally return, at which to begin the result set. If <code class="code">OFFSET</code> is defined without a corresponding <code class="code">LIMIT</code> it is silently ignored.</p>
|
|
|
|
<p>The <code class="code">WHERE</code> key provides a mechanism for adding arbitrary WHERE clauses to the underlying query. Its value is expected to a hash reference whose keys are the columns, operators and placeholders, and the values are the placeholders' bind value. For example:</p>
|
|
|
|
<pre class="code"> WHERE => { 'some_column >= ?' => $some_value }</pre>
|
|
|
|
<p>would constrain the query to only those objects in the table whose 'some_column' column has a value greater than or equal to $some_value.</p>
|
|
|
|
<p>If you don't specify any criteria, calling this function is the same as doing <code class="code">[$class->get_all]</code>.</p>
|
|
|
|
<dt><a name="Returns"
|
|
><b>Returns</b></a></dt>
|
|
|
|
<dd>
|
|
<p>An arrayref of objects, or an empty arrayref if there are no matches.</p>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a class='u' href='#___top' title='click to go to top of document'
|
|
name="Database_Manipulation"
|
|
>Database Manipulation</a></h2>
|
|
|
|
<dl>
|
|
<dt><a name="create"
|
|
><code class="code">create</code></a></dt>
|
|
|
|
<dd>
|
|
<p>Description: Creates a new item in the database. Throws a User Error if any of the passed-in params are invalid.</p>
|
|
|
|
<p>Params: <code class="code">$params</code> - hashref - A value to put in each database field for this object. Certain values must be set (the ones specified in <a href="#REQUIRED_CREATE_FIELDS" class="podlinkpod"
|
|
>"REQUIRED_CREATE_FIELDS"</a>), and the function will throw a Code Error if you don't set them.</p>
|
|
|
|
<p>Returns: The Object just created in the database.</p>
|
|
|
|
<p>Notes: In order for this function to work in your subclass, your subclass's <a href="#ID_FIELD" class="podlinkpod"
|
|
>"ID_FIELD"</a> must be of <code class="code">SERIAL</code> type in the database. Your subclass also must define <a href="#REQUIRED_CREATE_FIELDS" class="podlinkpod"
|
|
>"REQUIRED_CREATE_FIELDS"</a> and <a href="#VALIDATORS" class="podlinkpod"
|
|
>"VALIDATORS"</a>.</p>
|
|
|
|
<pre class="code"> Subclass Implementors: This function basically just
|
|
calls L</check_required_create_fields>, then
|
|
L</run_create_validators>, and then finally
|
|
L</insert_create_data>. So if you have a complex system that
|
|
you need to implement, you can do it by calling these
|
|
three functions instead of C<SUPER::create>.</pre>
|
|
|
|
<dt><a name="check_required_create_fields"
|
|
><code class="code">check_required_create_fields</code></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a name="Description"
|
|
><b>Description</b></a></dt>
|
|
|
|
<dd>
|
|
<p>Part of <a href="#create" class="podlinkpod"
|
|
>"create"</a>. Throws an error if any of the <a href="#REQUIRED_CREATE_FIELDS" class="podlinkpod"
|
|
>"REQUIRED_CREATE_FIELDS"</a> have not been specified in <code class="code">$params</code></p>
|
|
|
|
<dt><a name="Params"
|
|
><b>Params</b></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a name="$params_-_The_same_as_$params_from_"create"."
|
|
><code class="code">$params</code> - The same as <code class="code">$params</code> from <a href="#create" class="podlinkpod"
|
|
>"create"</a>.</a></dt>
|
|
</dl>
|
|
|
|
<dt><a name="Returns_(nothing)"
|
|
><b>Returns</b> (nothing)</a></dt>
|
|
</dl>
|
|
|
|
<dt><a name="run_create_validators"
|
|
><code class="code">run_create_validators</code></a></dt>
|
|
|
|
<dd>
|
|
<p>Description: Runs the validation of input parameters for <a href="#create" class="podlinkpod"
|
|
>"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>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>
|
|
|
|
<dt><a name="insert_create_data"
|
|
><code class="code">insert_create_data</code></a></dt>
|
|
|
|
<dd>
|
|
<p>Part of <a href="#create" class="podlinkpod"
|
|
>"create"</a>.</p>
|
|
|
|
<p>Takes the return value from <a href="#run_create_validators" class="podlinkpod"
|
|
>"run_create_validators"</a> and inserts the data into the database. Returns a newly created object.</p>
|
|
|
|
<dt><a name="update"
|
|
><code class="code">update</code></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a name="Description"
|
|
><b>Description</b></a></dt>
|
|
|
|
<dd>
|
|
<p>Saves the values currently in this object to the database. Only the fields specified in <a href="#UPDATE_COLUMNS" class="podlinkpod"
|
|
>"UPDATE_COLUMNS"</a> will be updated, and they will only be updated if their values have changed.</p>
|
|
|
|
<dt><a name="Params_(none)"
|
|
><b>Params</b> (none)</a></dt>
|
|
|
|
<dd>
|
|
<dt><a name="Returns"
|
|
><b>Returns</b></a></dt>
|
|
|
|
<dd>
|
|
<p><b>In scalar context:</b></p>
|
|
|
|
<p>A hashref showing what changed during the update. The keys are the column names from <a href="#UPDATE_COLUMNS" class="podlinkpod"
|
|
>"UPDATE_COLUMNS"</a>. If a field was not changed, it will not be in the hash at all. If the field was changed, the key will point to an arrayref. The first item of the arrayref will be the old value, and the second item will be the new value.</p>
|
|
|
|
<p>If there were no changes, we return a reference to an empty hash.</p>
|
|
|
|
<p><b>In array context:</b></p>
|
|
|
|
<p>Returns a list, where the first item is the above hashref. The second item is the object as it was in the database before update() was called. (This is mostly useful to subclasses of <code class="code">Bugzilla::Object</code> that are implementing <code class="code">update</code>.)</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dt><a name="remove_from_db"
|
|
><code class="code">remove_from_db</code></a></dt>
|
|
|
|
<dd>
|
|
<p>Removes this object from the database. Will throw an error if you can't remove it for some reason. The object will then be destroyed, as it is not safe to use the object after it has been removed from the database.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a class='u' href='#___top' title='click to go to top of document'
|
|
name="Mutators"
|
|
>Mutators</a></h2>
|
|
|
|
<p>These are used for updating the values in objects, before calling <code class="code">update</code>.</p>
|
|
|
|
<dl>
|
|
<dt><a name="set"
|
|
><code class="code">set</code></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a name="Description"
|
|
><b>Description</b></a></dt>
|
|
|
|
<dd>
|
|
<p>Sets a certain hash member of this class to a certain value. Used for updating fields. Calls the validator for this field, if it exists. Subclasses should use this function to implement the various <code class="code">set_</code> mutators for their different fields.</p>
|
|
|
|
<p>If your class defines a method called <code class="code">_set_global_validator</code>, <code class="code">set</code> will call it with <code class="code">($value, $field)</code> as arguments, after running the validator for this particular field. <code class="code">_set_global_validator</code> does not return anything.</p>
|
|
|
|
<p>See <a href="#VALIDATORS" class="podlinkpod"
|
|
>"VALIDATORS"</a> for more information.</p>
|
|
|
|
<p><b>NOTE</b>: This function is intended only for use by subclasses. If you call it from anywhere else, it will throw a <code class="code">CodeError</code>.</p>
|
|
|
|
<dt><a name="Params"
|
|
><b>Params</b></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a
|
|
><code class="code">$field</code> - The name of the hash member to update. This should be the same as the name of the field in <a href="#VALIDATORS" class="podlinkpod"
|
|
>"VALIDATORS"</a>, if it exists there.</a></dt>
|
|
|
|
<dd>
|
|
<dt><a name="$value_-_The_value_that_you're_setting_the_field_to."
|
|
><code class="code">$value</code> - The value that you're setting the field to.</a></dt>
|
|
</dl>
|
|
|
|
<dt><a name="Returns_(nothing)"
|
|
><b>Returns</b> (nothing)</a></dt>
|
|
</dl>
|
|
|
|
<dt><a name="set_all"
|
|
><code class="code">set_all</code></a></dt>
|
|
|
|
<dd>
|
|
<dl>
|
|
<dt><a name="Description"
|
|
><b>Description</b></a></dt>
|
|
|
|
<dd>
|
|
<p>This is a convenience function which is simpler than calling many different <code class="code">set_</code> functions in a row. You pass a hashref of parameters and it calls <code class="code">set_$key($value)</code> for every item in the hashref.</p>
|
|
|
|
<dt><a name="Params"
|
|
><b>Params</b></a></dt>
|
|
|
|
<dd>
|
|
<p>Takes a hashref of the fields that need to be set, pointing to the value that should be passed to the <code class="code">set_</code> function that is called.</p>
|
|
|
|
<dt><a name="Returns_(nothing)"
|
|
><b>Returns</b> (nothing)</a></dt>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a class='u' href='#___top' title='click to go to top of document'
|
|
name="Simple_Validators"
|
|
>Simple Validators</a></h2>
|
|
|
|
<p>You can use these in your subclass <a href="#VALIDATORS" class="podlinkpod"
|
|
>"VALIDATORS"</a> or <a href="#UPDATE_VALIDATORS" class="podlinkpod"
|
|
>"UPDATE_VALIDATORS"</a>. Note that you have to reference them like <code class="code">\&Bugzilla::Object::check_boolean</code>, you can't just write <code class="code">\&check_boolean</code>.</p>
|
|
|
|
<dl>
|
|
<dt><a name="check_boolean"
|
|
><code class="code">check_boolean</code></a></dt>
|
|
|
|
<dd>
|
|
<p>Returns <code class="code">1</code> if the passed-in value is true, <code class="code">0</code> otherwise.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h1><a class='u' href='#___top' title='click to go to top of document'
|
|
name="CLASS_FUNCTIONS"
|
|
>CLASS FUNCTIONS</a></h1>
|
|
|
|
<dl>
|
|
<dt><a name="get_all"
|
|
><code class="code">get_all</code></a></dt>
|
|
|
|
<dd>
|
|
<pre class="code"> Description: Returns all objects in this table from the database.
|
|
|
|
Params: none.
|
|
|
|
Returns: A list of objects, or an empty list if there are none.
|
|
|
|
Notes: Note that you must call this as C<$class->get_all>. For
|
|
example, C<Bugzilla::Keyword->get_all>.
|
|
C<Bugzilla::Keyword::get_all> will not work.</pre>
|
|
</dd>
|
|
</dl>
|
|
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p>
|
|
|
|
<!-- end doc -->
|
|
|
|
</body></html>
|