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