# BEGIN BPS TAGGED BLOCK {{{
-#
+#
# COPYRIGHT:
-#
-# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
-# <jesse@bestpractical.com>
-#
+#
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+# <sales@bestpractical.com>
+#
# (Except where explicitly superseded by other copyright notices)
-#
-#
+#
+#
# LICENSE:
-#
+#
# This work is made available to you under the terms of Version 2 of
# the GNU General Public License. A copy of that license should have
# been provided with this software, but in any event can be snarfed
# from www.gnu.org.
-#
+#
# This work is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
-#
+#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-#
-#
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
# CONTRIBUTION SUBMISSION POLICY:
-#
+#
# (The following paragraph is not intended to limit the rights granted
# to you to modify and distribute this software under the terms of
# the GNU General Public License and is only of importance to you if
# you choose to contribute your changes and enhancements to the
# community by submitting them to Best Practical Solutions, LLC.)
-#
+#
# By intentionally submitting any modifications, corrections or
# derivatives to this work, or any other work intended for use with
# Request Tracker, to Best Practical Solutions, LLC, you confirm that
# royalty-free, perpetual, license to use, copy, create derivative
# works based on those contributions, and sublicense and distribute
# those contributions and any derivatives thereof.
-#
-# END BPS TAGGED BLOCK }}}
-# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
-# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.
-#
-# !! DO NOT EDIT THIS FILE !!
#
-
-use strict;
-
+# END BPS TAGGED BLOCK }}}
=head1 NAME
- RT::CustomFields -- Class Description
-
+ RT::CustomFields - a collection of RT CustomField objects
+
=head1 SYNOPSIS
- use RT::CustomFields
+ use RT::CustomFields;
=head1 DESCRIPTION
-
=head1 METHODS
+
+
=cut
+
package RT::CustomFields;
-use RT::SearchBuilder;
-use RT::CustomField;
+use strict;
+use warnings;
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
+use base 'RT::SearchBuilder';
+use RT::CustomField;
+
+sub Table { 'CustomFields'}
sub _Init {
my $self = shift;
- $self->{'table'} = 'CustomFields';
- $self->{'primary_key'} = 'id';
-
-
# By default, order by SortOrder
$self->OrderByCols(
- { ALIAS => 'main',
- FIELD => 'SortOrder',
- ORDER => 'ASC' },
- { ALIAS => 'main',
- FIELD => 'id',
- ORDER => 'ASC' },
+ { ALIAS => 'main',
+ FIELD => 'SortOrder',
+ ORDER => 'ASC' },
+ { ALIAS => 'main',
+ FIELD => 'Name',
+ ORDER => 'ASC' },
+ { ALIAS => 'main',
+ FIELD => 'id',
+ ORDER => 'ASC' },
);
+ $self->{'with_disabled_column'} = 1;
return ( $self->SUPER::_Init(@_) );
}
+=head2 LimitToGrouping
-=head2 NewItem
+Limits this collection object to custom fields which appear under a
+specified grouping by calling L</Limit> for each CF name as appropriate.
-Returns an empty new RT::CustomField item
+Requires an L<RT::Record> object or class name as the first argument and
+accepts a grouping name as the second. If the grouping name is false
+(usually via the empty string), limits to custom fields which appear in no
+grouping.
+
+I<Caveat:> While the record object or class name is used to find the
+available groupings, no automatic limit is placed on the lookup type of
+the custom fields. It's highly suggested you limit the collection by
+queue or another lookup type first. This is already done for you if
+you're creating the collection via the L</CustomFields> method on an
+L<RT::Record> object.
=cut
-sub NewItem {
+sub LimitToGrouping {
+ my $self = shift;
+ my $obj = shift;
+ my $grouping = shift;
+
+ my $grouping_class = $self->NewItem->_GroupingClass($obj);
+
+ my $config = RT->Config->Get('CustomFieldGroupings');
+ $config = {} unless ref($config) eq 'HASH';
+ $config = $config->{$grouping_class} || [];
+ my %h = ref $config eq "ARRAY" ? @{$config} : %{$config};
+
+ if ( $grouping ) {
+ my $list = $h{$grouping};
+ unless ( $list and ref($list) eq 'ARRAY' and @$list ) {
+ return $self->Limit( FIELD => 'id', VALUE => 0, ENTRYAGGREGATOR => 'AND' );
+ }
+ $self->Limit(
+ FIELD => 'Name',
+ FUNCTION => 'LOWER(?)',
+ OPERATOR => 'IN',
+ VALUE => [map {lc $_} @{$list}],
+ CASESENSITIVE => 1,
+ );
+ } else {
+ my @list = map {@$_} grep defined && ref($_) eq 'ARRAY',
+ values %h;
+
+ return unless @list;
+
+ $self->Limit(
+ FIELD => 'Name',
+ FUNCTION => 'LOWER(?)',
+ OPERATOR => 'NOT IN',
+ VALUE => [ map {lc $_} @list ],
+ CASESENSITIVE => 1,
+ );
+ }
+ return;
+}
+
+
+=head2 LimitToLookupType
+
+Takes LookupType and limits collection.
+
+=cut
+
+sub LimitToLookupType {
+ my $self = shift;
+ my $lookup = shift;
+
+ $self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
+}
+
+=head2 LimitToChildType
+
+Takes partial LookupType and limits collection to records
+where LookupType is equal or ends with the value.
+
+=cut
+
+sub LimitToChildType {
+ my $self = shift;
+ my $lookup = shift;
+
+ $self->Limit( FIELD => 'LookupType', VALUE => "$lookup", OPERATOR => "ENDSWITH" );
+}
+
+
+=head2 LimitToParentType
+
+Takes partial LookupType and limits collection to records
+where LookupType is equal or starts with the value.
+
+=cut
+
+sub LimitToParentType {
+ my $self = shift;
+ my $lookup = shift;
+
+ $self->Limit( FIELD => 'LookupType', VALUE => "$lookup", OPERATOR => "STARTSWITH" );
+}
+
+=head2 LimitToObjectId
+
+Takes an ObjectId and limits the collection to CFs applied to said object.
+
+When called multiple times the ObjectId limits are joined with OR.
+
+=cut
+
+sub LimitToObjectId {
+ my $self = shift;
+ my $id = shift;
+ $self->Limit(
+ ALIAS => $self->_OCFAlias,
+ FIELD => 'ObjectId',
+ OPERATOR => '=',
+ VALUE => $id || 0,
+ ENTRYAGGREGATOR => 'OR'
+ );
+}
+
+=head2 LimitToGlobalOrObjectId
+
+Takes list of object IDs and limits collection to custom
+fields that are added to these objects or globally.
+
+=cut
+
+sub LimitToGlobalOrObjectId {
+ my $self = shift;
+ my $global_only = 1;
+
+
+ foreach my $id (@_) {
+ $self->LimitToObjectId($id);
+ $global_only = 0 if $id;
+ }
+
+ $self->LimitToObjectId(0) unless $global_only;
+}
+
+=head2 LimitToNotAdded
+
+Takes either list of object ids or nothing. Limits collection
+to custom fields to listed objects or any corespondingly. Use
+zero to mean global.
+
+=cut
+
+sub LimitToNotAdded {
+ my $self = shift;
+ return RT::ObjectCustomFields->new( $self->CurrentUser )
+ ->LimitTargetToNotAdded( $self => @_ );
+}
+
+=head2 LimitToAdded
+
+Limits collection to custom fields to listed objects or any corespondingly. Use
+zero to mean global.
+
+=cut
+
+sub LimitToAdded {
+ my $self = shift;
+ return RT::ObjectCustomFields->new( $self->CurrentUser )
+ ->LimitTargetToAdded( $self => @_ );
+}
+
+=head2 LimitToGlobalOrQueue QUEUEID
+
+Limits the set of custom fields found to global custom fields or those
+tied to the queue C<QUEUEID>, similar to L</LimitToGlobalOrObjectId>.
+
+Note that this will cause the collection to only return ticket CFs.
+
+=cut
+
+sub LimitToGlobalOrQueue {
+ my $self = shift;
+ my $queue = shift;
+ $self->LimitToGlobalOrObjectId( $queue );
+ $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
+}
+
+
+=head2 LimitToQueue QUEUEID
+
+Takes a numeric C<QUEUEID>, and limits the Custom Field collection to
+those only applied directly to it; this limit is OR'd with other
+L</LimitToQueue> and L</LimitToGlobal> limits.
+
+Note that this will cause the collection to only return ticket CFs.
+
+=cut
+
+sub LimitToQueue {
+ my $self = shift;
+ my $queue = shift;
+
+ $self->Limit (ALIAS => $self->_OCFAlias,
+ ENTRYAGGREGATOR => 'OR',
+ FIELD => 'ObjectId',
+ VALUE => "$queue")
+ if defined $queue;
+ $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
+}
+
+
+=head2 LimitToGlobal
+
+Limits the Custom Field collection to global ticket CFs; this limit is
+OR'd with L</LimitToQueue> limits.
+
+Note that this will cause the collection to only return ticket CFs.
+
+=cut
+
+sub LimitToGlobal {
+ my $self = shift;
+
+ $self->Limit (ALIAS => $self->_OCFAlias,
+ ENTRYAGGREGATOR => 'OR',
+ FIELD => 'ObjectId',
+ VALUE => 0);
+ $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
+}
+
+
+=head2 ApplySortOrder
+
+Sort custom fields according to thier order application to objects. It's
+expected that collection contains only records of one
+L<RT::CustomField/LookupType> and applied to one object or globally
+(L</LimitToGlobalOrObjectId>), otherwise sorting makes no sense.
+
+=cut
+
+sub ApplySortOrder {
my $self = shift;
- return(RT::CustomField->new($self->CurrentUser));
+ my $order = shift || 'ASC';
+ $self->OrderByCols( {
+ ALIAS => $self->_OCFAlias,
+ FIELD => 'SortOrder',
+ ORDER => $order,
+ } );
}
- eval "require RT::CustomFields_Overlay";
- if ($@ && $@ !~ qr{^Can't locate RT/CustomFields_Overlay.pm}) {
- die $@;
- };
- eval "require RT::CustomFields_Vendor";
- if ($@ && $@ !~ qr{^Can't locate RT/CustomFields_Vendor.pm}) {
- die $@;
- };
+=head2 ContextObject
- eval "require RT::CustomFields_Local";
- if ($@ && $@ !~ qr{^Can't locate RT/CustomFields_Local.pm}) {
- die $@;
- };
+Returns context object for this collection of custom fields,
+but only if it's defined.
+=cut
+sub ContextObject {
+ my $self = shift;
+ return $self->{'context_object'};
+}
-=head1 SEE ALSO
+=head2 SetContextObject
-This class allows "overlay" methods to be placed
-into the following files _Overlay is for a System overlay by the original author,
-_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
+Sets context object for this collection of custom fields.
-These overlay files can contain new subs or subs to replace existing subs in this module.
+=cut
-Each of these files should begin with the line
+sub SetContextObject {
+ my $self = shift;
+ return $self->{'context_object'} = shift;
+}
- no warnings qw(redefine);
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+sub _OCFAlias {
+ my $self = shift;
+ return RT::ObjectCustomFields->new( $self->CurrentUser )
+ ->JoinTargetToThis( $self => @_ );
+}
+
+
+=head2 AddRecord
+
+Overrides the collection to ensure that only custom fields the user can
+see are returned; also propagates down the L</ContextObject>.
+
+=cut
+
+sub AddRecord {
+ my $self = shift;
+ my ($record) = @_;
-RT::CustomFields_Overlay, RT::CustomFields_Vendor, RT::CustomFields_Local
+ $record->SetContextObject( $self->ContextObject );
+ return unless $record->CurrentUserHasRight('SeeCustomField');
+ return $self->SUPER::AddRecord( $record );
+}
+
+=head2 NewItem
+
+Returns an empty new RT::CustomField item
+Overrides <RT::SearchBuilder/NewItem> to make sure </ContextObject>
+is inherited.
=cut
+sub NewItem {
+ my $self = shift;
+ my $res = RT::CustomField->new($self->CurrentUser);
+ $res->SetContextObject($self->ContextObject);
+ return $res;
+}
+
+RT::Base->_ImportOverlays();
1;
projects / freeside.git / blobdiff