1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
6 # <sales@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/licenses/old-licenses/gpl-2.0.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 }}}
51 RT::Attributes - collection of RT::Attribute objects
56 my $Attributes = new RT::Attributes($CurrentUser);
66 package RT::Attributes;
69 no warnings qw(redefine);
74 $self->SUPER::_DoSearch();
75 # if _DoSearch doesn't fully succeed, 'must_redo_search' will be true
76 # and call _BuildAccessTable then will result in a deep recursion
77 if ( $self->{'must_redo_search'} ) {
79 "_DoSearch is not so successful as it still needs redo search, won't call _BuildAccessTable"
83 $self->_BuildAccessTable();
88 sub _BuildAccessTable {
90 delete $self->{'attr'};
91 while (my $attr = $self->Next) {
92 push @{$self->{'attr'}->{$attr->Name}}, $attr;
99 $self->_DoSearch if ($self->{'must_redo_search'});
100 unless ($self->{'attr'}) {
101 $self->{'attr'}->{'__none'} = RT::Attribute->new($self->CurrentUser);
103 return ($self->{'attr'});
108 Returns a list of the Names of all attributes for this object.
114 my @keys = keys %{$self->_AttrHash};
122 Returns an array of all the RT::Attribute objects with the name STRING
130 if ($self->_AttrHash) {
131 @attributes = @{($self->_AttrHash->{$name}||[])};
133 return (@attributes);
138 Returns the RT::Attribute objects with the id ID
140 XXX TODO XXX THIS NEEDS A BETTER ACL CHECK
148 my $attr = RT::Attribute->new($self->CurrentUser);
149 $attr->LoadByCols( id => $id );
153 =head2 DeleteEntry { Name => Content => , id => }
155 Deletes attributes with
157 and the matching content or id
159 If Content and id are both undefined, delete all attributes with
174 foreach my $attr ( $self->Named( $args{'Name'} ) ) {
175 if ( ( !defined $args{'id'} and !defined $args{'Content'} )
176 or ( defined $args{'id'} and $attr->id eq $args{'id'} )
177 or ( defined $args{'Content'} and $attr->Content eq $args{'Content'} ) )
179 my ($id, $msg) = $attr->Delete;
180 return ($id, $msg) unless $id;
184 return (0, "No entry found") unless $found;
186 # XXX: above string must work but because of bug in DBIx::SB it doesn't,
187 # to reproduce delete string below and run t/api/attribute-tests.t
189 return (1, $self->loc('Attribute Deleted'));
195 =head2 LimitToObject $object
197 Limit the Attributes to rights for the object $object. It needs to be an RT::Record class.
204 unless (defined($obj) && ref($obj) && UNIVERSAL::can($obj, 'id') && $obj->id) {
207 $self->Limit(FIELD => 'ObjectType', OPERATOR=> '=', VALUE => ref($obj), ENTRYAGGREGATOR => 'OR');
208 $self->Limit(FIELD => 'ObjectId', OPERATOR=> '=', VALUE => $obj->id, ENTRYAGGREGATOR => 'OR', QUOTEVALUE => 0);