rt 4.0.23
[freeside.git] / rt / lib / RT / CustomFieldValue.pm
index f434b44..e6b8a09 100644 (file)
-# BEGIN LICENSE BLOCK
-# 
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
-# 
-# (Except where explictly superceded by other copyright notices)
-# 
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# 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.
-# 
-# Unless otherwise specified, all modifications, corrections or
-# extensions to this work which alter its source code become the
-# property of Best Practical Solutions, LLC when submitted for
-# inclusion in the work.
-# 
-# 
-# END LICENSE 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 !!
 #
+# 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., 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
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# 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 }}}
 
 use strict;
+use warnings;
 
+package RT::CustomFieldValue;
+
+no warnings qw/redefine/;
 
-=head1 NAME
 
-RT::CustomFieldValue
+use RT::CustomField;
+use base 'RT::Record';
 
+sub Table {'CustomFieldValues'}
 
-=head1 SYNOPSIS
 
-=head1 DESCRIPTION
+=head2 ValidateName
 
-=head1 METHODS
+Override the default ValidateName method that stops custom field values
+from being integers.
 
 =cut
 
-package RT::CustomFieldValue;
-use RT::Record; 
-use RT::CustomField;
+sub Create {
+    my $self = shift;
+    my %args = (
+        CustomField => 0,
+        Name        => '',
+        Description => '',
+        SortOrder   => 0,
+        Category    => '',
+        @_,
+    );
+
+    my $cf_id = ref $args{'CustomField'}? $args{'CustomField'}->id: $args{'CustomField'};
+
+    my $cf = RT::CustomField->new( $self->CurrentUser );
+    $cf->Load( $cf_id );
+    unless ( $cf->id ) {
+        return (0, $self->loc("Couldn't load Custom Field #[_1]", $cf_id));
+    }
+    unless ( $cf->CurrentUserHasRight('AdminCustomField') || $cf->CurrentUserHasRight('AdminCustomFieldValues') ) {
+        return (0, $self->loc('Permission Denied'));
+    }
+
+    my ($id, $msg) = $self->SUPER::Create(
+        CustomField => $cf_id,
+        map { $_ => $args{$_} } qw(Name Description SortOrder Category)
+    );
+    return ($id, $msg);
+}
 
+sub ValidateName {
+    return defined $_[1] && length $_[1];
+};
 
-use vars qw( @ISA );
-@ISA= qw( RT::Record );
+=head2 DeleteCategory
 
-sub _Init {
-  my $self = shift; 
+Deletes the category associated with this value
+Returns -1 if there is no Category
 
-  $self->Table('CustomFieldValues');
-  $self->SUPER::_Init(@_);
-}
+=cut
 
+sub DeleteCategory {
+    my $self = shift;
+    my $attr = $self->FirstAttribute('Category') or return (-1,'No Category Set');
+    return $attr->Delete;
+}
 
+=head2 Delete
 
+Make sure we delete our Category when we're deleted
 
+=cut
 
-=item Create PARAMHASH
+sub Delete {
+    my $self = shift;
 
-Create takes a hash of values and creates a row in the database:
+    my ($result, $msg) = $self->DeleteCategory;
 
-  int(11) 'CustomField'.
-  varchar(200) 'Name'.
-  varchar(255) 'Description'.
-  int(11) 'SortOrder'.
+    unless ($result) {
+        return ($result, $msg);
+    }
 
-=cut
+    return $self->SUPER::Delete(@_);
+}
 
+sub _Set { 
+    my $self = shift; 
 
+    my $cf_id = $self->CustomField; 
 
+    my $cf = RT::CustomField->new( $self->CurrentUser ); 
+    $cf->Load( $cf_id ); 
 
-sub Create {
-    my $self = shift;
-    my %args = ( 
-                CustomField => '0',
-                Name => '',
-                Description => '',
-                SortOrder => '0',
-
-                 @_);
-    $self->SUPER::Create(
-                         CustomField => $args{'CustomField'},
-                         Name => $args{'Name'},
-                         Description => $args{'Description'},
-                         SortOrder => $args{'SortOrder'},
-);
+    unless ( $cf->id ) { 
+        return (0, $self->loc("Couldn't load Custom Field #[_1]", $cf_id)); 
+    } 
 
-}
+    unless ($cf->CurrentUserHasRight('AdminCustomField') || $cf->CurrentUserHasRight('AdminCustomFieldValues')) { 
+        return (0, $self->loc('Permission Denied')); 
+    } 
 
+    return $self->SUPER::_Set( @_ ); 
+} 
 
 
-=item id
+=head2 id
 
 Returns the current value of id. 
 (In the database, id is stored as int(11).)
@@ -105,14 +160,14 @@ Returns the current value of id.
 =cut
 
 
-=item CustomField
+=head2 CustomField
 
 Returns the current value of CustomField. 
 (In the database, CustomField is stored as int(11).)
 
 
 
-=item SetCustomField VALUE
+=head2 SetCustomField VALUE
 
 
 Set CustomField to VALUE. 
@@ -123,7 +178,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 =cut
 
 
-=item CustomFieldObj
+=head2 CustomFieldObj
 
 Returns the CustomField Object which has the id returned by CustomField
 
@@ -131,20 +186,20 @@ Returns the CustomField Object which has the id returned by CustomField
 =cut
 
 sub CustomFieldObj {
-       my $self = shift;
-       my $CustomField =  RT::CustomField->new($self->CurrentUser);
-       $CustomField->Load($self->__Value('CustomField'));
-       return($CustomField);
+    my $self = shift;
+    my $CustomField =  RT::CustomField->new($self->CurrentUser);
+    $CustomField->Load($self->__Value('CustomField'));
+    return($CustomField);
 }
 
-=item Name
+=head2 Name
 
 Returns the current value of Name. 
 (In the database, Name is stored as varchar(200).)
 
 
 
-=item SetName VALUE
+=head2 SetName VALUE
 
 
 Set Name to VALUE. 
@@ -155,14 +210,14 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 =cut
 
 
-=item Description
+=head2 Description
 
 Returns the current value of Description. 
 (In the database, Description is stored as varchar(255).)
 
 
 
-=item SetDescription VALUE
+=head2 SetDescription VALUE
 
 
 Set Description to VALUE. 
@@ -173,14 +228,14 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 =cut
 
 
-=item SortOrder
+=head2 SortOrder
 
 Returns the current value of SortOrder. 
 (In the database, SortOrder is stored as int(11).)
 
 
 
-=item SetSortOrder VALUE
+=head2 SetSortOrder VALUE
 
 
 Set SortOrder to VALUE. 
@@ -191,7 +246,25 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 =cut
 
 
-=item Creator
+=head2 Category
+
+Returns the current value of Category.
+(In the database, Category is stored as varchar(255).)
+
+
+
+=head2 SetCategory VALUE
+
+
+Set Category to VALUE.
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Category will be stored as a varchar(255).)
+
+
+=cut
+
+
+=head2 Creator
 
 Returns the current value of Creator. 
 (In the database, Creator is stored as int(11).)
@@ -200,7 +273,7 @@ Returns the current value of Creator.
 =cut
 
 
-=item Created
+=head2 Created
 
 Returns the current value of Created. 
 (In the database, Created is stored as datetime.)
@@ -209,7 +282,7 @@ Returns the current value of Created.
 =cut
 
 
-=item LastUpdatedBy
+=head2 LastUpdatedBy
 
 Returns the current value of LastUpdatedBy. 
 (In the database, LastUpdatedBy is stored as int(11).)
@@ -218,7 +291,7 @@ Returns the current value of LastUpdatedBy.
 =cut
 
 
-=item LastUpdated
+=head2 LastUpdated
 
 Returns the current value of LastUpdated. 
 (In the database, LastUpdated is stored as datetime.)
@@ -228,67 +301,36 @@ Returns the current value of LastUpdated.
 
 
 
-sub _ClassAccessible {
+sub _CoreAccessible {
     {
      
         id =>
-               {read => 1, type => 'int(11)', default => ''},
+        {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
         CustomField => 
-               {read => 1, write => 1, type => 'int(11)', default => '0'},
+        {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
         Name => 
-               {read => 1, write => 1, type => 'varchar(200)', default => ''},
+        {read => 1, write => 1, sql_type => 12, length => 200,  is_blob => 0,  is_numeric => 0,  type => 'varchar(200)', default => ''},
         Description => 
-               {read => 1, write => 1, type => 'varchar(255)', default => ''},
+        {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
         SortOrder => 
-               {read => 1, write => 1, type => 'int(11)', default => '0'},
+        {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
+        Category =>
+        {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
         Creator => 
-               {read => 1, auto => 1, type => 'int(11)', default => '0'},
+        {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
         Created => 
-               {read => 1, auto => 1, type => 'datetime', default => ''},
+        {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
         LastUpdatedBy => 
-               {read => 1, auto => 1, type => 'int(11)', default => '0'},
+        {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
         LastUpdated => 
-               {read => 1, auto => 1, type => 'datetime', default => ''},
+        {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 
  }
 };
 
 
-        eval "require RT::CustomFieldValue_Overlay";
-        if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValue_Overlay.pm}) {
-            die $@;
-        };
-
-        eval "require RT::CustomFieldValue_Vendor";
-        if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValue_Vendor.pm}) {
-            die $@;
-        };
-
-        eval "require RT::CustomFieldValue_Local";
-        if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValue_Local.pm}) {
-            die $@;
-        };
-
-
-
-
-=head1 SEE ALSO
 
-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.  
-
-These overlay files can contain new subs or subs to replace existing subs in this module.
-
-If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line 
-
-   no warnings qw(redefine);
-
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
-
-RT::CustomFieldValue_Overlay, RT::CustomFieldValue_Vendor, RT::CustomFieldValue_Local
-
-=cut
 
+RT::Base->_ImportOverlays();
 
 1;