rt/lib/RT/SavedSearch.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 =head1 NAME
  50
  51 RT::SavedSearch - an API for saving and retrieving search form values.
  52
  53 =head1 SYNOPSIS
  54
  55   use RT::SavedSearch
  56
  57 =head1 DESCRIPTION
  58
  59 SavedSearch is an object based on L<RT::SharedSetting> that can belong
  60 to either an L<RT::User> or an L<RT::Group>. It consists of an ID,
  61 a description, and a number of search parameters.
  62
  63 =cut
  64
  65 package RT::SavedSearch;
  66
  67 use strict;
  68 use warnings;
  69 use base qw/RT::SharedSetting/;
  70
  71 =head1 METHODS
  72
  73 =head2 ObjectName
  74
  75 An object of this class is called "search"
  76
  77 =cut
  78
  79 sub ObjectName { "search" }
  80
  81 sub PostLoad {
  82     my $self = shift;
  83     $self->{'Type'} = $self->{'Attribute'}->SubValue('SearchType');
  84 }
  85
  86 sub SaveAttribute {
  87     my $self   = shift;
  88     my $object = shift;
  89     my $args   = shift;
  90
  91     my $params = $args->{'SearchParams'};
  92
  93     $params->{'SearchType'} = $args->{'Type'} || 'Ticket';
  94
  95     return $object->AddAttribute(
  96         'Name'        => 'SavedSearch',
  97         'Description' => $args->{'Name'},
  98         'Content'     => $params,
  99     );
 100 }
 101
 102
 103 sub UpdateAttribute {
 104     my $self = shift;
 105     my $args = shift;
 106     my $params = $args->{'SearchParams'} || {};
 107
 108     my ($status, $msg) = $self->{'Attribute'}->SetSubValues(%$params);
 109
 110     if ($status && $args->{'Name'}) {
 111         ($status, $msg) = $self->{'Attribute'}->SetDescription($args->{'Name'});
 112     }
 113
 114     return ($status, $msg);
 115 }
 116
 117 =head2 Type
 118
 119 Returns the type of this search, e.g. 'Ticket'.  Useful for denoting the
 120 saved searches that are relevant to a particular search page.
 121
 122 =cut
 123
 124 sub Type {
 125     my $self = shift;
 126     return $self->{'Type'};
 127 }
 128
 129 eval "require RT::SavedSearch_Vendor";
 130 die $@ if ($@ && $@ !~ qr{^Can't locate RT/SavedSearch_Vendor.pm});
 131 eval "require RT::SavedSearch_Local";
 132 die $@ if ($@ && $@ !~ qr{^Can't locate RT/SavedSearch_Local.pm});
 133
 134 1;