1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
# BEGIN LICENSE BLOCK
#
# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
#
# (Except where explictly superceded by other copyright notices)
#
# This work is made available to you under the terms of Version 2 of
# the GNU General Public License. A copy of that license should have
# been provided with this software, but in any event can be snarfed
# from www.gnu.org.
#
# This work is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# Unless otherwise specified, all modifications, corrections or
# extensions to this work which alter its source code become the
# property of Best Practical Solutions, LLC when submitted for
# inclusion in the work.
#
#
# END LICENSE BLOCK
=head1 NAME
RT::SearchBuilder - a baseclass for RT collection objects
=head1 SYNOPSIS
=head1 DESCRIPTION
=head1 METHODS
=begin testing
ok (require RT::SearchBuilder);
=end testing
=cut
package RT::SearchBuilder;
use RT::Base;
use DBIx::SearchBuilder;
use strict;
use vars qw(@ISA);
@ISA = qw(DBIx::SearchBuilder RT::Base);
# {{{ sub _Init
sub _Init {
my $self = shift;
$self->{'user'} = shift;
unless(defined($self->CurrentUser)) {
use Carp;
Carp::confess("$self was created without a CurrentUser");
$RT::Logger->err("$self was created without a CurrentUser");
return(0);
}
$self->SUPER::_Init( 'Handle' => $RT::Handle);
}
# }}}
# {{{ sub LimitToEnabled
=head2 LimitToEnabled
Only find items that haven\'t been disabled
=cut
sub LimitToEnabled {
my $self = shift;
$self->Limit( FIELD => 'Disabled',
VALUE => '0',
OPERATOR => '=' );
}
# }}}
# {{{ sub LimitToDisabled
=head2 LimitToDeleted
Only find items that have been deleted.
=cut
sub LimitToDeleted {
my $self = shift;
$self->{'find_disabled_rows'} = 1;
$self->Limit( FIELD => 'Disabled',
OPERATOR => '=',
VALUE => '1'
);
}
# }}}
# {{{ sub FindAllRows
=head2 FindAllRows
Find all matching rows, regardless of whether they are disabled or not
=cut
sub FindAllRows {
shift->{'find_disabled_rows'} = 1;
}
# {{{ sub Limit
=head2 Limit PARAMHASH
This Limit sub calls SUPER::Limit, but defaults "CASESENSITIVE" to 1, thus
making sure that by default lots of things don't do extra work trying to
match lower(colname) agaist lc($val);
=cut
sub Limit {
my $self = shift;
my %args = ( CASESENSITIVE => 1,
@_ );
return $self->SUPER::Limit(%args);
}
# }}}
# {{{ sub ItemsArrayRef
=item ItemsArrayRef
Return this object's ItemsArray.
If it has a SortOrder attribute, sort the array by SortOrder.
Otherwise, if it has a "Name" attribute, sort alphabetically by Name
Otherwise, just give up and return it in the order it came from the db.
=begin testing
use_ok(RT::Queues);
ok(my $queues = RT::Queues->new($RT::SystemUser), 'Created a queues object');
ok( $queues->UnLimit(),'Unlimited the result set of the queues object');
my $items = $queues->ItemsArrayRef();
my @items = @{$items};
ok($queues->NewItem->_Accessible('Name','read'));
my @sorted = sort {lc($a->Name) cmp lc($b->Name)} @items;
ok (@sorted, "We have an array of queues, sorted". join(',',map {$_->Name} @sorted));
ok (@items, "We have an array of queues, raw". join(',',map {$_->Name} @items));
my @sorted_ids = map {$_->id } @sorted;
my @items_ids = map {$_->id } @items;
is ($#sorted, $#items);
is ($sorted[0]->Name, $items[0]->Name);
is ($sorted[-1]->Name, $items[-1]->Name);
is_deeply(\@items_ids, \@sorted_ids, "ItemsArrayRef sorts alphabetically by name");;
=end testing
=cut
sub ItemsArrayRef {
my $self = shift;
my @items;
if ($self->NewItem()->_Accessible('SortOrder','read')) {
@items = sort { $a->SortOrder <=> $b->SortOrder } @{$self->SUPER::ItemsArrayRef()};
}
elsif ($self->NewItem()->_Accessible('Name','read')) {
@items = sort { lc($a->Name) cmp lc($b->Name) } @{$self->SUPER::ItemsArrayRef()};
}
else {
@items = @{$self->SUPER::ItemsArrayRef()};
}
return(\@items);
}
# }}}
eval "require RT::SearchBuilder_Vendor";
die $@ if ($@ && $@ !~ qr{^Can't locate RT/SearchBuilder_Vendor.pm});
eval "require RT::SearchBuilder_Local";
die $@ if ($@ && $@ !~ qr{^Can't locate RT/SearchBuilder_Local.pm});
1;
|
