Upgrade to 4.0.10.
[usit-rt.git] / lib / RT / SharedSettings.pm
CommitLineData
84fb5b46
MKG
1# BEGIN BPS TAGGED BLOCK {{{
2#
3# COPYRIGHT:
4#
403d7b0b 5# This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
84fb5b46
MKG
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::SharedSettings - a pseudo-collection for SharedSetting objects.
52
53=head1 SYNOPSIS
54
55 use RT::SharedSettings
56
57=head1 DESCRIPTION
58
59 SharedSettings is an object consisting of a number of SharedSetting objects.
60 It works more or less like a DBIx::SearchBuilder collection, although it
61 is not.
62
63=head1 METHODS
64
65
66=cut
67
68package RT::SharedSettings;
69
70use RT::SharedSetting;
71
72use strict;
403d7b0b 73use warnings;
84fb5b46
MKG
74use base 'RT::Base';
75
76sub new {
77 my $proto = shift;
78 my $class = ref($proto) || $proto;
79 my $self = {};
80 bless ($self, $class);
81 $self->CurrentUser(@_);
82 $self->{'idx'} = 0;
83 $self->{'objects'} = [];
84 return $self;
85}
86
87### Accessor methods
88
89=head2 Next
90
91Returns the next object in the collection.
92
93=cut
94
95sub Next {
96 my $self = shift;
97 my $search = $self->{'objects'}->[$self->{'idx'}];
98 if ($search) {
99 $self->{'idx'}++;
100 } else {
101 # We have run out of objects; reset the counter.
102 $self->{'idx'} = 0;
103 }
104 return $search;
105}
106
107=head2 Count
108
109Returns the number of search objects found.
110
111=cut
112
113sub Count {
114 my $self = shift;
115 return scalar @{$self->{'objects'}};
116}
117
118=head2 CountAll
119
120Returns the number of search objects found
121
122=cut
123
124sub CountAll {
125 my $self = shift;
126 return $self->Count;
127}
128
129=head2 GotoPage
130
131Act more like a normal L<DBIx::SearchBuilder> collection.
132Moves the internal index around
133
134=cut
135
136sub GotoPage {
137 my $self = shift;
138 $self->{idx} = shift;
139}
140
141### Internal methods
142
143# _GetObject: helper routine to load the correct object whose parameters
144# have been passed.
145
146sub _GetObject {
147 my $self = shift;
148 my $privacy = shift;
149
150 return $self->RecordClass->new($self->CurrentUser)->_GetObject($privacy);
151}
152
153RT::Base->_ImportOverlays();
154
1551;
156