rt/lib/RT/SharedSettings.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2012 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::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
  68 package RT::SharedSettings;
  69
  70 use RT::SharedSetting;
  71
  72 use strict;
  73 use base 'RT::Base';
  74
  75 sub new  {
  76     my $proto = shift;
  77     my $class = ref($proto) || $proto;
  78     my $self  = {};
  79     bless ($self, $class);
  80     $self->CurrentUser(@_);
  81     $self->{'idx'} = 0;
  82     $self->{'objects'} = [];
  83     return $self;
  84 }
  85
  86 ### Accessor methods
  87
  88 =head2 Next
  89
  90 Returns the next object in the collection.
  91
  92 =cut
  93
  94 sub Next {
  95     my $self = shift;
  96     my $search = $self->{'objects'}->[$self->{'idx'}];
  97     if ($search) {
  98         $self->{'idx'}++;
  99     } else {
 100         # We have run out of objects; reset the counter.
 101         $self->{'idx'} = 0;
 102     }
 103     return $search;
 104 }
 105
 106 =head2 Count
 107
 108 Returns the number of search objects found.
 109
 110 =cut
 111
 112 sub Count {
 113     my $self = shift;
 114     return scalar @{$self->{'objects'}};
 115 }
 116
 117 =head2 CountAll
 118
 119 Returns the number of search objects found
 120
 121 =cut
 122
 123 sub CountAll {
 124     my $self = shift;
 125     return $self->Count;
 126 }
 127
 128 =head2 GotoPage
 129
 130 Act more like a normal L<DBIx::SearchBuilder> collection.
 131 Moves the internal index around
 132
 133 =cut
 134
 135 sub GotoPage {
 136     my $self = shift;
 137     $self->{idx} = shift;
 138 }
 139
 140 ### Internal methods
 141
 142 # _GetObject: helper routine to load the correct object whose parameters
 143 #  have been passed.
 144
 145 sub _GetObject {
 146     my $self = shift;
 147     my $privacy = shift;
 148
 149     return $self->RecordClass->new($self->CurrentUser)->_GetObject($privacy);
 150 }
 151
 152 RT::Base->_ImportOverlays();
 153
 154 1;
 155