1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2007 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., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/copyleft/gpl.html.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
50 RT::CustomFields - a collection of RT CustomField objects
63 ok (require RT::CustomFields);
70 package RT::CustomFields;
73 no warnings qw(redefine);
74 use DBIx::SearchBuilder::Unique;
79 unless ($self->{_sql_ocfalias}) {
81 $self->{'_sql_ocfalias'} = $self->NewAlias('ObjectCustomFields');
82 $self->Join( ALIAS1 => 'main',
84 ALIAS2 => $self->_OCFAlias,
85 FIELD2 => 'CustomField' );
87 return($self->{_sql_ocfalias});
91 # {{{ sub LimitToGlobalOrQueue
93 =head2 LimitToGlobalOrQueue QUEUEID
95 Limits the set of custom fields found to global custom fields or those tied to the queue with ID QUEUEID
99 sub LimitToGlobalOrQueue {
102 $self->LimitToGlobalOrObjectId( $queue );
103 $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
108 # {{{ sub LimitToQueue
110 =head2 LimitToQueue QUEUEID
112 Takes a queue id (numerical) as its only argument. Makes sure that
113 Scopes it pulls out apply to this queue (or another that you've selected with
114 another call to this method
122 $self->Limit (ALIAS => $self->_OCFAlias,
123 ENTRYAGGREGATOR => 'OR',
127 $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
131 # {{{ sub LimitToGlobal
136 Scopes it pulls out apply to all queues (or another that you've selected with
137 another call to this method or LimitToQueue
145 $self->Limit (ALIAS => $self->_OCFAlias,
146 ENTRYAGGREGATOR => 'OR',
149 $self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
158 A subclass of DBIx::SearchBuilder::_DoSearch that makes sure that
159 _Disabled rows never get seen unless we're explicitly trying to see
167 #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
168 unless($self->{'find_disabled_rows'}) {
169 $self->LimitToEnabled();
172 return($self->SUPER::_DoSearch(@_));
182 Returns the next custom field that this user can see.
190 my $CF = $self->SUPER::Next();
191 if ((defined($CF)) and (ref($CF))) {
193 if ($CF->CurrentUserHasRight('SeeCustomField')) {
197 #If the user doesn't have the right to show this queue
199 return($self->Next());
202 #if there never was any queue
210 sub LimitToLookupType {
214 $self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
217 sub LimitToChildType {
221 $self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
222 $self->Limit( FIELD => 'LookupType', ENDSWITH => "$lookup" );
225 sub LimitToParentType {
229 $self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
230 $self->Limit( FIELD => 'LookupType', STARTSWITH => "$lookup" );
233 sub LimitToGlobalOrObjectId {
238 foreach my $id (@_) {
239 $self->Limit( ALIAS => $self->_OCFAlias,
243 ENTRYAGGREGATOR => 'OR' );
244 $global_only = 0 if $id;
247 $self->Limit( ALIAS => $self->_OCFAlias,
251 ENTRYAGGREGATOR => 'OR' ) unless $global_only;
254 { ALIAS => $self->_OCFAlias, FIELD => 'ObjectId' },
255 { ALIAS => $self->_OCFAlias, FIELD => 'SortOrder' },
258 # This doesn't work on postgres.
259 #$self->OrderBy( ALIAS => $class_cfs , FIELD => "SortOrder", ORDER => 'ASC');