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