X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FScripCondition.pm;h=0d0fa665e0773f5491e089d3f63c2ef0cb278a3a;hp=a4cb26884c21fad440667d4e2da7faa7ab2159df;hb=e9e0cf0989259b94d9758eceff448666a2e5a5cc;hpb=fc6209f398899f0211cfcedeb81a3cd65e04a941 diff --git a/rt/lib/RT/ScripCondition.pm b/rt/lib/RT/ScripCondition.pm index a4cb26884..0d0fa665e 100755 --- a/rt/lib/RT/ScripCondition.pm +++ b/rt/lib/RT/ScripCondition.pm @@ -2,7 +2,7 @@ # # COPYRIGHT: # -# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC +# This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC # # # (Except where explicitly superseded by other copyright notices) @@ -46,86 +46,183 @@ # # 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 !! -# +=head1 NAME -use strict; + RT::ScripCondition - RT scrip conditional +=head1 SYNOPSIS -=head1 NAME + use RT::ScripCondition; -RT::ScripCondition +=head1 DESCRIPTION + +This module should never be called directly by client code. it's an internal module which +should only be accessed through exported APIs in other modules. -=head1 SYNOPSIS -=head1 DESCRIPTION =head1 METHODS =cut + package RT::ScripCondition; -use RT::Record; +use strict; +use warnings; + + +use base 'RT::Record'; + +sub Table {'ScripConditions'} + + + +sub _Init { + my $self = shift; + $self->{'table'} = "ScripConditions"; + return ($self->SUPER::_Init(@_)); +} + +sub _Accessible { + my $self = shift; + my %Cols = ( Name => 'read', + Description => 'read', + ApplicableTransTypes => 'read', + ExecModule => 'read', + Argument => 'read', + Creator => 'read/auto', + Created => 'read/auto', + LastUpdatedBy => 'read/auto', + LastUpdated => 'read/auto' + ); + return($self->SUPER::_Accessible(@_, %Cols)); +} + + +=head2 Create + + Takes a hash. Creates a new Condition entry. + should be better documented. + +=cut + +sub Create { + my $self = shift; + return($self->SUPER::Create(@_)); +} + + +=head2 Delete + +No API available for deleting things just yet. + +=cut + +sub Delete { + my $self = shift; + return(0, $self->loc('Unimplemented')); +} + + +=head2 Load IDENTIFIER -use vars qw( @ISA ); -@ISA= qw( RT::Record ); +Loads a condition takes a name or ScripCondition id. -sub _Init { - my $self = shift; +=cut - $self->Table('ScripConditions'); - $self->SUPER::_Init(@_); +sub Load { + my $self = shift; + my $identifier = shift; + + unless (defined $identifier) { + return (undef); + } + + if ($identifier !~ /\D/) { + return ($self->SUPER::LoadById($identifier)); + } + else { + return ($self->LoadByCol('Name', $identifier)); + } } +=head2 LoadCondition HASH + +takes a hash which has the following elements: TransactionObj and TicketObj. +Loads the Condition module in question. + +=cut + +sub LoadCondition { + my $self = shift; + my %args = ( TransactionObj => undef, + TicketObj => undef, + @_ ); + + #TODO: Put this in an eval + $self->ExecModule =~ /^(\w+)$/; + my $module = $1; + my $type = "RT::Condition::". $module; + + eval "require $type" || die "Require of $type failed.\n$@\n"; + + $self->{'Condition'} = $type->new ( 'ScripConditionObj' => $self, + 'TicketObj' => $args{'TicketObj'}, + 'ScripObj' => $args{'ScripObj'}, + 'TransactionObj' => $args{'TransactionObj'}, + 'Argument' => $self->Argument, + 'ApplicableTransTypes' => $self->ApplicableTransTypes, + CurrentUser => $self->CurrentUser + ); +} -=head2 Create PARAMHASH -Create takes a hash of values and creates a row in the database: - varchar(200) 'Name'. - varchar(255) 'Description'. - varchar(60) 'ExecModule'. - varchar(255) 'Argument'. - varchar(60) 'ApplicableTransTypes'. +=head2 Describe + +Helper method to call the condition module's Describe method. =cut +sub Describe { + my $self = shift; + return ($self->{'Condition'}->Describe()); + +} + +=head2 IsApplicable +Helper method to call the condition module's IsApplicable method. -sub Create { +=cut + +sub IsApplicable { my $self = shift; - my %args = ( - Name => '', - Description => '', - ExecModule => '', - Argument => '', - ApplicableTransTypes => '', - - @_); - $self->SUPER::Create( - Name => $args{'Name'}, - Description => $args{'Description'}, - ExecModule => $args{'ExecModule'}, - Argument => $args{'Argument'}, - ApplicableTransTypes => $args{'ApplicableTransTypes'}, -); + return ($self->{'Condition'}->IsApplicable()); + +} + +sub DESTROY { + my $self=shift; + $self->{'Condition'} = undef; } + + + + =head2 id -Returns the current value of id. +Returns the current value of id. (In the database, id is stored as int(11).) @@ -134,7 +231,7 @@ Returns the current value of id. =head2 Name -Returns the current value of Name. +Returns the current value of Name. (In the database, Name is stored as varchar(200).) @@ -142,7 +239,7 @@ Returns the current value of Name. =head2 SetName VALUE -Set Name to VALUE. +Set Name to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Name will be stored as a varchar(200).) @@ -152,7 +249,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 Description -Returns the current value of Description. +Returns the current value of Description. (In the database, Description is stored as varchar(255).) @@ -160,7 +257,7 @@ Returns the current value of Description. =head2 SetDescription VALUE -Set Description to VALUE. +Set Description to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Description will be stored as a varchar(255).) @@ -170,7 +267,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 ExecModule -Returns the current value of ExecModule. +Returns the current value of ExecModule. (In the database, ExecModule is stored as varchar(60).) @@ -178,7 +275,7 @@ Returns the current value of ExecModule. =head2 SetExecModule VALUE -Set ExecModule to VALUE. +Set ExecModule to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ExecModule will be stored as a varchar(60).) @@ -188,17 +285,17 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 Argument -Returns the current value of Argument. -(In the database, Argument is stored as varchar(255).) +Returns the current value of Argument. +(In the database, Argument is stored as varbinary(255).) =head2 SetArgument VALUE -Set Argument to VALUE. +Set Argument to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. -(In the database, Argument will be stored as a varchar(255).) +(In the database, Argument will be stored as a varbinary(255).) =cut @@ -206,7 +303,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 ApplicableTransTypes -Returns the current value of ApplicableTransTypes. +Returns the current value of ApplicableTransTypes. (In the database, ApplicableTransTypes is stored as varchar(60).) @@ -214,7 +311,7 @@ Returns the current value of ApplicableTransTypes. =head2 SetApplicableTransTypes VALUE -Set ApplicableTransTypes to VALUE. +Set ApplicableTransTypes to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ApplicableTransTypes will be stored as a varchar(60).) @@ -224,7 +321,7 @@ Returns (1, 'Status message') on success and (0, 'Error Message') on failure. =head2 Creator -Returns the current value of Creator. +Returns the current value of Creator. (In the database, Creator is stored as int(11).) @@ -233,7 +330,7 @@ Returns the current value of Creator. =head2 Created -Returns the current value of Created. +Returns the current value of Created. (In the database, Created is stored as datetime.) @@ -242,7 +339,7 @@ Returns the current value of Created. =head2 LastUpdatedBy -Returns the current value of LastUpdatedBy. +Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).) @@ -251,7 +348,7 @@ Returns the current value of LastUpdatedBy. =head2 LastUpdated -Returns the current value of LastUpdated. +Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.) @@ -261,67 +358,31 @@ Returns the current value of LastUpdated. sub _CoreAccessible { { - + id => {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, - Name => + Name => {read => 1, write => 1, sql_type => 12, length => 200, is_blob => 0, is_numeric => 0, type => 'varchar(200)', default => ''}, - Description => + Description => {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''}, - ExecModule => + ExecModule => {read => 1, write => 1, sql_type => 12, length => 60, is_blob => 0, is_numeric => 0, type => 'varchar(60)', default => ''}, - Argument => - {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''}, - ApplicableTransTypes => + Argument => + {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varbinary(255)', default => ''}, + ApplicableTransTypes => {read => 1, write => 1, sql_type => 12, length => 60, is_blob => 0, is_numeric => 0, type => 'varchar(60)', default => ''}, - Creator => + Creator => {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, - Created => + Created => {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, - LastUpdatedBy => + LastUpdatedBy => {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, - LastUpdated => + LastUpdated => {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, } }; - - eval "require RT::ScripCondition_Overlay"; - if ($@ && $@ !~ qr{^Can't locate RT/ScripCondition_Overlay.pm}) { - die $@; - }; - - eval "require RT::ScripCondition_Vendor"; - if ($@ && $@ !~ qr{^Can't locate RT/ScripCondition_Vendor.pm}) { - die $@; - }; - - eval "require RT::ScripCondition_Local"; - if ($@ && $@ !~ qr{^Can't locate RT/ScripCondition_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. - -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::ScripCondition_Overlay, RT::ScripCondition_Vendor, RT::ScripCondition_Local - -=cut - +RT::Base->_ImportOverlays(); 1;