rt/lib/RT/SavedSearches.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
   6 #                                          <sales@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::SavedSearches - a pseudo-collection for SavedSearch objects.
  52
  53 =head1 SYNOPSIS
  54
  55   use RT::SavedSearches
  56
  57 =head1 DESCRIPTION
  58
  59   SavedSearches is an object consisting of a number of SavedSearch objects.
  60   It works more or less like a DBIx::SearchBuilder collection, although it
  61   is not.
  62
  63 =head1 METHODS
  64
  65
  66 =cut
  67
  68 package RT::SavedSearches;
  69
  70 use RT::SavedSearch;
  71
  72 use strict;
  73 use base 'RT::SharedSettings';
  74
  75 sub RecordClass {
  76     return 'RT::SavedSearch';
  77 }
  78
  79 =head2 LimitToPrivacy
  80
  81 Takes two argumets: a privacy string, of the format "<class>-<id>", as
  82 produced by RT::SavedSearch::Privacy(); and a type string, as produced
  83 by RT::SavedSearch::Type().  The SavedSearches object will load the
  84 searches belonging to that user or group that are of the type
  85 specified.  If no type is specified, all the searches belonging to the
  86 user/group will be loaded.  Repeated calls to the same object should DTRT.
  87
  88 =cut
  89
  90 sub LimitToPrivacy {
  91     my $self = shift;
  92     my $privacy = shift;
  93     my $type = shift;
  94
  95     my $object = $self->_GetObject($privacy);
  96
  97     if ($object) {
  98         $self->{'objects'} = [];
  99         my @search_atts = $object->Attributes->Named('SavedSearch');
 100         foreach my $att (@search_atts) {
 101             my $search = RT::SavedSearch->new($self->CurrentUser);
 102             $search->Load($privacy, $att->Id);
 103             next if $type && $search->Type && $search->Type ne $type;
 104             push(@{$self->{'objects'}}, $search);
 105         }
 106     } else {
 107         $RT::Logger->error("Could not load object $privacy");
 108     }
 109 }
 110
 111 ### Internal methods
 112
 113 sub _PrivacyObjects {
 114     my $self = shift;
 115     Carp::carp("RT::SavedSearches->_PrivacyObjects is deprecated. Please use RT::SavedSearch->_PrivacyObjects");
 116     my $search = RT::SavedSearch->new($self->CurrentUser);
 117     return $search->_PrivacyObjects(@_);
 118 }
 119
 120 RT::Base->_ImportOverlays();
 121
 122 1;