1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
49 package RT::Shredder::Plugin::Base::Search;
52 use warnings FATAL => 'all';
54 use base qw(RT::Shredder::Plugin::Base);
58 RT::Shredder::Plugin::Base - base class for Shredder plugins.
62 sub Type { return 'search' }
66 Arguments which all plugins support.
68 =head2 limit - unsigned integer
70 Allow you to limit search results. B<< Default value is C<10> >>.
80 grep $_ && !$seen{$_},
81 shift->SUPER::SupportArgs(@_),
90 if( defined $args{'limit'} && $args{'limit'} ne '' ) {
91 my $limit = $args{'limit'};
92 $limit =~ s/[^0-9]//g;
93 unless( $args{'limit'} eq $limit ) {
94 return( 0, "'limit' should be an unsigned integer");
96 $args{'limit'} = $limit;
100 return $self->SUPER::TestArgs( %args );
103 sub SetResolvers { return 1 }
106 =head2 FetchNext $collection [, $init]
108 Returns next object in collection as method L<RT::SearchBuilder/Next>, but
109 doesn't stop on page boundaries.
111 When method is called with true C<$init> arg it enables pages on collection
112 and selects first page.
114 Main purpose of this method is to avoid loading of whole collection into
115 memory as RT does by default when pager is not used. This method init paging
116 on the collection, but doesn't stop when reach page end.
120 $plugin->FetchNext( $tickets, 'init' );
121 while( my $ticket = $plugin->FetchNext( $tickets ) ) {
127 use constant PAGE_SIZE => 100;
129 my ($self, $objs, $init) = @_;
131 $objs->RowsPerPage( PAGE_SIZE );
136 my $obj = $objs->Next;