rt/lib/RT/Search/FromSQL.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2014 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::Search::FromSQL
  52
  53 =head1 SYNOPSIS
  54
  55 =head1 DESCRIPTION
  56
  57 Find all tickets described by the SQL statement passed as an argument
  58
  59 =head1 METHODS
  60
  61
  62
  63
  64 =cut
  65
  66 package RT::Search::FromSQL;
  67
  68 use strict;
  69 use warnings;
  70 use base qw(RT::Search);
  71
  72 =head2 Describe
  73
  74 Returns a localized string describing the module's function.
  75
  76 =cut
  77
  78 sub Describe  {
  79     my $self = shift;
  80     return ($self->loc("TicketSQL search module", ref $self));
  81 }
  82
  83 =head2 Prepare
  84
  85 The meat of the module.  Runs a search on its Tickets object, using
  86 the SQL string described in its Argument object.  The Tickets object
  87 is reduced to those tickets matching the SQL query.
  88
  89 =cut
  90
  91 sub Prepare  {
  92     my $self = shift;
  93
  94     $self->TicketsObj->FromSQL($self->Argument);
  95     return(1);
  96 }
  97
  98 RT::Base->_ImportOverlays();
  99
 100 1;