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