rt/lib/RT/Dashboards.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2016 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::Dashboards - a pseudo-collection for Dashboard objects.
  52
  53 =head1 SYNOPSIS
  54
  55   use RT::Dashboards
  56
  57 =head1 DESCRIPTION
  58
  59   Dashboards is an object consisting of a number of Dashboard 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::Dashboards;
  69
  70 use strict;
  71 use warnings;
  72 use base 'RT::SharedSettings';
  73
  74 use RT::Dashboard;
  75
  76 sub RecordClass {
  77     return 'RT::Dashboard';
  78 }
  79
  80 =head2 LimitToPrivacy
  81
  82 Takes one argument: a privacy string, of the format "<class>-<id>", as produced
  83 by RT::Dashboard::Privacy(). The Dashboards object will load the dashboards
  84 belonging to that user or group. Repeated calls to the same object should DTRT.
  85
  86 =cut
  87
  88 sub LimitToPrivacy {
  89     my $self = shift;
  90     my $privacy = shift;
  91
  92     my $object = $self->_GetObject($privacy);
  93
  94     if ($object) {
  95         $self->{'objects'} = [];
  96         my @dashboard_atts = $object->Attributes->Named('Dashboard');
  97         foreach my $att (@dashboard_atts) {
  98             my $dashboard = RT::Dashboard->new($self->CurrentUser);
  99             $dashboard->Load($privacy, $att->Id);
 100             push(@{$self->{'objects'}}, $dashboard);
 101         }
 102     } else {
 103         $RT::Logger->error("Could not load object $privacy");
 104     }
 105 }
 106
 107 sub ColumnMapClassName {
 108     return 'RT__Dashboard';
 109 }
 110
 111 RT::Base->_ImportOverlays();
 112
 113 1;