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