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