<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title> Bugzilla::Search::Saved</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::Search::Saved</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='#METHODS'>METHODS</a> <ul class='indexList indexList2'> <li class='indexItem indexItem2'><a href='#Constructors_and_Database_Manipulation'>Constructors and Database Manipulation</a> <li class='indexItem indexItem2'><a href='#Accessors'>Accessors</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::Search::Saved - A saved search</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="SYNOPSIS" >SYNOPSIS</a></h1> <pre class="code"> use Bugzilla::Search::Saved; my $query = new Bugzilla::Search::Saved($query_id); my $edit_link = $query->edit_link; my $search_url = $query->url; my $owner = $query->user; my $num_subscribers = $query->shared_with_users;</pre> <h1><a class='u' href='#___top' title='click to go to top of document' name="DESCRIPTION" >DESCRIPTION</a></h1> <p>This module exists to represent a <a href="../../Bugzilla/Search.html" class="podlinkpod" >Bugzilla::Search</a> that has been saved to the database.</p> <p>This is an implementation of <a href="../../Bugzilla/Object.html" class="podlinkpod" >Bugzilla::Object</a>, and so has all the same methods available as <a href="../../Bugzilla/Object.html" class="podlinkpod" >Bugzilla::Object</a>, in addition to what is documented below.</p> <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_and_Database_Manipulation" >Constructors and Database Manipulation</a></h2> <dl> <dt><a name="new" ><code class="code">new</code></a></dt> <dd> <p>Takes either an id, or the named parameters <code class="code">user</code> and <code class="code">name</code>. <code class="code">user</code> can be either a <a href="../../Bugzilla/User.html" class="podlinkpod" >Bugzilla::User</a> object or a numeric user id.</p> <p>See also: <a href="../../Bugzilla/Object.html#new" class="podlinkpod" >"new" in Bugzilla::Object</a>.</p> <dt><a name="preload" ><code class="code">preload</code></a></dt> <dd> <p>Sets <code class="code">link_in_footer</code> for all given saved searches at once, for the currently logged in user. This is much faster than calling this method for each saved search individually.</p> </dd> </dl> <h2><a class='u' href='#___top' title='click to go to top of document' name="Accessors" >Accessors</a></h2> <p>These return data about the object, without modifying the object.</p> <dl> <dt><a name="edit_link" ><code class="code">edit_link</code></a></dt> <dd> <p>A url with which you can edit the search.</p> <dt><a name="url" ><code class="code">url</code></a></dt> <dd> <p>The CGI parameters for the search, as a string.</p> <dt><a name="link_in_footer" ><code class="code">link_in_footer</code></a></dt> <dd> <p>Whether or not this search should be displayed in the footer for the <i>current user</i> (not the owner of the search, but the person actually using Bugzilla right now).</p> <dt><a name="type" ><code class="code">type</code></a></dt> <dd> <p>The numeric id of the type of search this is (from <a href="../../Bugzilla/Constants.html" class="podlinkpod" >Bugzilla::Constants</a>).</p> <dt><a name="shared_with_group" ><code class="code">shared_with_group</code></a></dt> <dd> <p>The <a href="../../Bugzilla/Group.html" class="podlinkpod" >Bugzilla::Group</a> that this search is shared with. <code class="code">undef</code> if this search isn't shared.</p> <dt><a name="shared_with_users" ><code class="code">shared_with_users</code></a></dt> <dd> <p>Returns how many users (besides the author of the saved search) are using the saved search, i.e. have it displayed in their footer.</p> </dd> </dl> <p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p> <!-- end doc --> </body></html>