rt/lib/RT/CustomFieldValues/Groups.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 package RT::CustomFieldValues::Groups;
  50
  51 use strict;
  52 use warnings;
  53
  54 use base qw(RT::CustomFieldValues::External);
  55
  56 =head1 NAME
  57
  58 RT::CustomFieldValues::Groups - Provide RT's groups as a dynamic list of CF values
  59
  60 =head1 SYNOPSIS
  61
  62 To use as a source of CF values, add the following to your F<RT_SiteConfig.pm>
  63 and restart RT.
  64
  65     # In RT_SiteConfig.pm
  66     Set( @CustomFieldValuesSources, "RT::CustomFieldValues::Groups" );
  67
  68 Then visit the modify CF page in the RT admin configuration.
  69
  70 =head1 METHODS
  71
  72 Most methods are inherited from L<RT::CustomFieldValues::External>, except the
  73 ones below.
  74
  75 =head2 SourceDescription
  76
  77 Returns a brief string describing this data source.
  78
  79 =cut
  80
  81 sub SourceDescription {
  82     return 'RT user defined groups';
  83 }
  84
  85 =head2 ExternalValues
  86
  87 Returns an arrayref containing a hashref for each possible value in this data
  88 source, where the value name is the group name.
  89
  90 =cut
  91
  92 sub ExternalValues {
  93     my $self = shift;
  94
  95     my @res;
  96     my $i = 0;
  97     my $groups = RT::Groups->new( $self->CurrentUser );
  98     $groups->LimitToUserDefinedGroups;
  99     $groups->OrderByCols( { FIELD => 'Name' } );
 100     while( my $group = $groups->Next ) {
 101         push @res, {
 102             name        => $group->Name,
 103             description => $group->Description,
 104             sortorder   => $i++,
 105         };
 106     }
 107     return \@res;
 108 }
 109
 110 RT::Base->_ImportOverlays();
 111
 112 1;