rt/lib/RT/Search/FromSQL.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46
  47 =head1 NAME
  48
  49   RT::Search::FromSQL
  50
  51 =head1 SYNOPSIS
  52
  53 =head1 DESCRIPTION
  54
  55 Find all tickets described by the SQL statement passed as an argument
  56
  57 =head1 METHODS
  58
  59
  60 =begin testing
  61
  62 ok (require RT::Search::Generic);
  63
  64 =end testing
  65
  66
  67 =cut
  68
  69 package RT::Search::FromSQL;
  70
  71 use strict;
  72 use base qw(RT::Search::Generic);
  73
  74 =head2 Describe
  75
  76 Returns a localized string describing the module's function.
  77
  78 =cut
  79
  80 # {{{ sub Describe
  81 sub Describe  {
  82     my $self = shift;
  83     return ($self->loc("TicketSQL search module", ref $self));
  84 }
  85 # }}}
  86
  87 =head2 Prepare
  88
  89 The meat of the module.  Runs a search on its Tickets object, using
  90 the SQL string described in its Argument object.  The Tickets object
  91 is reduced to those tickets matching the SQL query.
  92
  93 =cut
  94
  95 # {{{ sub Prepare
  96 sub Prepare  {
  97     my $self = shift;
  98
  99     $self->TicketsObj->FromSQL($self->Argument);
 100     return(1);
 101 }
 102 # }}}
 103
 104 eval "require RT::Search::FromSQL_Vendor";
 105 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/FromSQL_Vendor.pm});
 106 eval "require RT::Search::FromSQL_Local";
 107 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/FromSQL_Local.pm});
 108
 109 1;