FS/FS/log_context.pm

   1 package FS::log_context;
   2
   3 use strict;
   4 use base qw( FS::Record );
   5 use FS::Record qw( qsearch qsearchs );
   6
   7 my @contexts = ( qw(
   8   bill_and_collect
   9   FS::cust_main::Billing::bill_and_collect
  10   FS::cust_main::Billing::bill
  11   FS::cust_main::Billing_Realtime::realtime_bop
  12   FS::cust_main::Billing_Realtime::realtime_verify_bop
  13   FS::pay_batch::import_from_gateway
  14   FS::part_pkg
  15   FS::Misc::Geo::standardize_uscensus
  16   Cron::bill
  17   Cron::backup
  18   Cron::upload
  19   spool_upload
  20   daily
  21   queue
  22   upgrade
  23   upgrade_taxable_billpkgnum
  24   freeside-paymentech-upload
  25   freeside-paymentech-download
  26   test
  27 ) );
  28
  29 =head1 NAME
  30
  31 FS::log_context - Object methods for log_context records
  32
  33 =head1 SYNOPSIS
  34
  35   use FS::log_context;
  36
  37   $record = new FS::log_context \%hash;
  38   $record = new FS::log_context { 'column' => 'value' };
  39
  40   $error = $record->insert;
  41
  42   $error = $new_record->replace($old_record);
  43
  44   $error = $record->delete;
  45
  46   $error = $record->check;
  47
  48 =head1 DESCRIPTION
  49
  50 An FS::log_context object represents a context tag attached to a log entry
  51 (L<FS::log>).  FS::log_context inherits from FS::Record.  The following
  52 fields are currently supported:
  53
  54 =over 4
  55
  56 =item logcontextnum - primary key
  57
  58 =item lognum - lognum (L<FS::log> foreign key)
  59
  60 =item context - context
  61
  62 =back
  63
  64 =head1 METHODS
  65
  66 =over 4
  67
  68 =item new HASHREF
  69
  70 Creates a new context tag.  To add the example to the database, see
  71 L<"insert">.
  72
  73 Note that this stores the hash reference, not a distinct copy of the hash it
  74 points to.  You can ask the object for a copy with the I<hash> method.
  75
  76 =cut
  77
  78 sub table { 'log_context'; }
  79
  80 =item insert
  81
  82 Adds this record to the database.  If there is an error, returns the error,
  83 otherwise returns false.
  84
  85 =item delete
  86
  87 Delete this record from the database.
  88
  89 =item replace OLD_RECORD
  90
  91 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  92 returns the error, otherwise returns false.
  93
  94 =item check
  95
  96 Checks all fields to make sure this is a valid example.  If there is
  97 an error, returns the error, otherwise returns false.  Called by the insert
  98 and replace methods.
  99
 100 =cut
 101
 102 sub check {
 103   my $self = shift;
 104
 105   my $error =
 106     $self->ut_numbern('logcontextnum')
 107     || $self->ut_number('lognum')
 108     || $self->ut_text('context') #|| $self->ut_enum('context', \@contexts)
 109   ;
 110   return $error if $error;
 111
 112   $self->SUPER::check;
 113 }
 114
 115 =back
 116
 117 =head1 CLASS METHODS
 118
 119 =over 4
 120
 121 =item contexts
 122
 123 Returns a list of all valid contexts.
 124
 125 =cut
 126
 127 sub contexts { @contexts }
 128
 129 =back
 130
 131 =head1 BUGS
 132
 133 =head1 SEE ALSO
 134
 135 L<FS::Log>, L<FS::Record>, schema.html from the base documentation.
 136
 137 =cut
 138
 139 1;
 140