1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2011 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 }}}
51 RT::SavedSearches - a pseudo-collection for SavedSearch objects.
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
68 package RT::SavedSearches;
77 my $class = ref($proto) || $proto;
79 bless ($self, $class);
80 $self->CurrentUser(@_);
82 $self->{'objects'} = [];
88 Takes two argumets: a privacy string, of the format "<class>-<id>", as
89 produced by RT::SavedSearch::Privacy(); and a type string, as produced
90 by RT::SavedSearch::Type(). The SavedSearches object will load the
91 searches belonging to that user or group that are of the type
92 specified. If no type is specified, all the searches belonging to the
93 user/group will be loaded. Repeated calls to the same object should DTRT.
102 my $object = $self->_GetObject($privacy);
105 $self->{'objects'} = [];
106 my @search_atts = $object->Attributes->Named('SavedSearch');
107 foreach my $att (@search_atts) {
108 my $search = RT::SavedSearch->new($self->CurrentUser);
109 $search->Load($privacy, $att->Id);
110 next if $type && $search->Type ne $type;
111 push(@{$self->{'objects'}}, $search);
114 $RT::Logger->error("Could not load object $privacy");
122 Returns the next object in the collection.
128 my $search = $self->{'objects'}->[$self->{'idx'}];
132 # We have run out of objects; reset the counter.
140 Returns the number of search objects found.
146 return scalar @{$self->{'objects'}};
151 # _GetObject: helper routine to load the correct object whose parameters
158 return RT::SavedSearch->new($self->CurrentUser)->_GetObject($privacy);
163 # _PrivacyObjects: returns a list of objects that can be used to load saved searches from.
165 sub _PrivacyObjects {
167 my $CurrentUser = $self->CurrentUser;
169 my $groups = RT::Groups->new($CurrentUser);
170 $groups->LimitToUserDefinedGroups;
171 $groups->WithMember( PrincipalId => $CurrentUser->Id,
174 return ( $CurrentUser->UserObj, @{ $groups->ItemsArrayRef() } );
177 RT::Base->_ImportOverlays();