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