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