X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=rt%2Flib%2FRT%2FCustomFieldValues.pm;h=ed1c2fdb676c0dc56b5585139db53b95fa3c812c;hb=HEAD;hp=9cf716179b29dbc79cde3de61c374fd55df2efad;hpb=fc6209f398899f0211cfcedeb81a3cd65e04a941;p=freeside.git diff --git a/rt/lib/RT/CustomFieldValues.pm b/rt/lib/RT/CustomFieldValues.pm index 9cf716179..ed1c2fdb6 100644 --- a/rt/lib/RT/CustomFieldValues.pm +++ b/rt/lib/RT/CustomFieldValues.pm @@ -2,7 +2,7 @@ # # COPYRIGHT: # -# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC +# This software is Copyright (c) 1996-2019 Best Practical Solutions, LLC # # # (Except where explicitly superseded by other copyright notices) @@ -46,46 +46,22 @@ # # END BPS TAGGED BLOCK }}} -# Autogenerated by DBIx::SearchBuilder factory (by ) -# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST. -# -# !! DO NOT EDIT THIS FILE !! -# +package RT::CustomFieldValues; use strict; +use warnings; +use base 'RT::SearchBuilder'; -=head1 NAME - - RT::CustomFieldValues -- Class Description - -=head1 SYNOPSIS - - use RT::CustomFieldValues - -=head1 DESCRIPTION - - -=head1 METHODS - -=cut - -package RT::CustomFieldValues; - -use RT::SearchBuilder; use RT::CustomFieldValue; -use vars qw( @ISA ); -@ISA= qw(RT::SearchBuilder); - +sub Table { 'CustomFieldValues'} sub _Init { my $self = shift; - $self->{'table'} = 'CustomFieldValues'; - $self->{'primary_key'} = 'id'; - # By default, order by SortOrder - $self->OrderByCols( + # By default, order by SortOrder + $self->OrderByCols( { ALIAS => 'main', FIELD => 'SortOrder', ORDER => 'ASC' }, @@ -95,58 +71,72 @@ sub _Init { { ALIAS => 'main', FIELD => 'id', ORDER => 'ASC' }, - ); + ); return ( $self->SUPER::_Init(@_) ); } +# {{{ sub LimitToCustomField +=head2 LimitToCustomField FIELD -=head2 NewItem - -Returns an empty new RT::CustomFieldValue item +Limits the returned set to values for the custom field with Id FIELD =cut - -sub NewItem { + +sub LimitToCustomField { my $self = shift; - return(RT::CustomFieldValue->new($self->CurrentUser)); + my $cf = shift; + return $self->Limit( + FIELD => 'CustomField', + VALUE => $cf, + OPERATOR => '=', + ); } - eval "require RT::CustomFieldValues_Overlay"; - if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValues_Overlay.pm}) { - die $@; - }; +=head2 SetCustomFieldObject - eval "require RT::CustomFieldValues_Vendor"; - if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValues_Vendor.pm}) { - die $@; - }; +Store the CustomField object which loaded this CustomFieldValues collection. +Consumers of CustomFieldValues collection (such as External Custom Fields) +can now work out how they were loaded (off a Queue or Ticket or something else) +by inspecting the CustomField. - eval "require RT::CustomFieldValues_Local"; - if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValues_Local.pm}) { - die $@; - }; +=cut + +sub SetCustomFieldObject { + my $self = shift; + return $self->{'custom_field'} = shift; +} +=head2 CustomFieldObject +Returns the CustomField object used to load this CustomFieldValues collection. +Relies on $CustomField->Values having been called, is not set on manual loads. +=cut -=head1 SEE ALSO +sub CustomFieldObject { + my $self = shift; + return $self->{'custom_field'}; +} -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. +=head2 AddRecord -These overlay files can contain new subs or subs to replace existing subs in this module. +Propagates the CustomField object from the Collection +down to individual CustomFieldValue objects. -Each of these files should begin with the line +=cut - no warnings qw(redefine); +sub AddRecord { + my $self = shift; + my $CFV = shift; -so that perl does not kick and scream when you redefine a subroutine or variable in your overlay. + $CFV->SetCustomFieldObj($self->CustomFieldObject); -RT::CustomFieldValues_Overlay, RT::CustomFieldValues_Vendor, RT::CustomFieldValues_Local + push @{$self->{'items'}}, $CFV; + $self->{'rows'}++; +} -=cut +RT::Base->_ImportOverlays(); 1;