1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
6 # <jesse@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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., 675 Mass Ave, Cambridge, MA 02139, USA.
28 # CONTRIBUTION SUBMISSION POLICY:
30 # (The following paragraph is not intended to limit the rights granted
31 # to you to modify and distribute this software under the terms of
32 # the GNU General Public License and is only of importance to you if
33 # you choose to contribute your changes and enhancements to the
34 # community by submitting them to Best Practical Solutions, LLC.)
36 # By intentionally submitting any modifications, corrections or
37 # derivatives to this work, or any other work intended for use with
38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
39 # you are the copyright holder for those contributions and you grant
40 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
41 # royalty-free, perpetual, license to use, copy, create derivative
42 # works based on those contributions, and sublicense and distribute
43 # those contributions and any derivatives thereof.
45 # END BPS TAGGED BLOCK }}}
49 RT::CustomFields - a collection of RT CustomField objects
62 ok (require RT::CustomFields);
69 package RT::CustomFields;
72 no warnings qw(redefine);
73 use DBIx::SearchBuilder::Unique;
78 unless ($self->{_sql_ocfalias}) {
80 $self->{'_sql_ocfalias'} = $self->NewAlias('ObjectCustomFields');
81 $self->Join( ALIAS1 => 'main',
83 ALIAS2 => $self->_OCFAlias,
84 FIELD2 => 'CustomField' );
86 return($self->{_sql_ocfalias});
90 # {{{ sub LimitToGlobalOrQueue
92 =head2 LimitToGlobalOrQueue QUEUEID
94 Limits the set of custom fields found to global custom fields or those tied to the queue with ID QUEUEID
98 sub LimitToGlobalOrQueue {
101 $self->LimitToGlobalOrObjectId( $queue );
102 $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
107 # {{{ sub LimitToQueue
109 =head2 LimitToQueue QUEUEID
111 Takes a queue id (numerical) as its only argument. Makes sure that
112 Scopes it pulls out apply to this queue (or another that you've selected with
113 another call to this method
121 $self->Limit (ALIAS => $self->_OCFAlias,
122 ENTRYAGGREGATOR => 'OR',
126 $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
130 # {{{ sub LimitToGlobal
135 Scopes it pulls out apply to all queues (or another that you've selected with
136 another call to this method or LimitToQueue
144 $self->Limit (ALIAS => $self->_OCFAlias,
145 ENTRYAGGREGATOR => 'OR',
148 $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
157 A subclass of DBIx::SearchBuilder::_DoSearch that makes sure that
158 _Disabled rows never get seen unless we're explicitly trying to see
166 #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
167 unless($self->{'find_disabled_rows'}) {
168 $self->LimitToEnabled();
171 return($self->SUPER::_DoSearch(@_));
181 Returns the next custom field that this user can see.
189 my $CF = $self->SUPER::Next();
190 if ((defined($CF)) and (ref($CF))) {
192 if ($CF->CurrentUserHasRight('SeeCustomField')) {
196 #If the user doesn't have the right to show this queue
198 return($self->Next());
201 #if there never was any queue
209 sub LimitToLookupType {
213 $self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
216 sub LimitToChildType {
220 $self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
221 $self->Limit( FIELD => 'LookupType', ENDSWITH => "$lookup" );
224 sub LimitToParentType {
228 $self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
229 $self->Limit( FIELD => 'LookupType', STARTSWITH => "$lookup" );
232 sub LimitToGlobalOrObjectId {
237 foreach my $id (@_) {
238 $self->Limit( ALIAS => $self->_OCFAlias,
242 ENTRYAGGREGATOR => 'OR' );
243 $global_only = 0 if $id;
246 $self->Limit( ALIAS => $self->_OCFAlias,
250 ENTRYAGGREGATOR => 'OR' ) unless $global_only;
253 { ALIAS => $self->_OCFAlias, FIELD => 'ObjectId' },
254 { ALIAS => $self->_OCFAlias, FIELD => 'SortOrder' },
257 # This doesn't work on postgres.
258 #$self->OrderBy( ALIAS => $class_cfs , FIELD => "SortOrder", ORDER => 'ASC');