FS/FS/access_usergroup.pm

   1 package FS::access_usergroup;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs );
   6 use FS::access_user;
   7 use FS::access_group;
   8
   9 @ISA = qw(FS::Record);
  10
  11 =head1 NAME
  12
  13 FS::access_usergroup - Object methods for access_usergroup records
  14
  15 =head1 SYNOPSIS
  16
  17   use FS::access_usergroup;
  18
  19   $record = new FS::access_usergroup \%hash;
  20   $record = new FS::access_usergroup { 'column' => 'value' };
  21
  22   $error = $record->insert;
  23
  24   $error = $new_record->replace($old_record);
  25
  26   $error = $record->delete;
  27
  28   $error = $record->check;
  29
  30 =head1 DESCRIPTION
  31
  32 An FS::access_usergroup object represents an internal access user's membership
  33 in a group.  FS::access_usergroup inherits from FS::Record.  The following
  34 fields are currently supported:
  35
  36 =over 4
  37
  38 =item usergroupnum - primary key
  39
  40 =item usernum -
  41
  42 =item groupnum -
  43
  44
  45 =back
  46
  47 =head1 METHODS
  48
  49 =over 4
  50
  51 =item new HASHREF
  52
  53 Creates a new record.  To add the record to the database, see L<"insert">.
  54
  55 Note that this stores the hash reference, not a distinct copy of the hash it
  56 points to.  You can ask the object for a copy with the I<hash> method.
  57
  58 =cut
  59
  60 # the new method can be inherited from FS::Record, if a table method is defined
  61
  62 sub table { 'access_usergroup'; }
  63
  64 =item insert
  65
  66 Adds this record to the database.  If there is an error, returns the error,
  67 otherwise returns false.
  68
  69 =cut
  70
  71 # the insert method can be inherited from FS::Record
  72
  73 =item delete
  74
  75 Delete this record from the database.
  76
  77 =cut
  78
  79 # the delete method can be inherited from FS::Record
  80
  81 =item replace OLD_RECORD
  82
  83 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  84 returns the error, otherwise returns false.
  85
  86 =cut
  87
  88 # the replace method can be inherited from FS::Record
  89
  90 =item check
  91
  92 Checks all fields to make sure this is a valid record.  If there is
  93 an error, returns the error, otherwise returns false.  Called by the insert
  94 and replace methods.
  95
  96 =cut
  97
  98 # the check method should currently be supplied - FS::Record contains some
  99 # data checking routines
 100
 101 sub check {
 102   my $self = shift;
 103
 104   my $error =
 105     $self->ut_numbern('usergroupnum')
 106     || $self->ut_number('usernum')
 107     || $self->ut_number('groupnum')
 108   ;
 109   return $error if $error;
 110
 111   $self->SUPER::check;
 112 }
 113
 114 =item access_user
 115
 116 =cut
 117
 118 sub access_user {
 119   my $self = shift;
 120   qsearchs( 'access_user', { 'usernum' => $self->usernum } );
 121 }
 122
 123 =item access_group
 124
 125 =cut
 126
 127 sub access_group {
 128   my $self = shift;
 129   qsearchs( 'access_group', { 'groupnum' => $self->groupnum } );
 130 }
 131
 132 =back
 133
 134 =head1 BUGS
 135
 136 =head1 SEE ALSO
 137
 138 L<FS::Record>, schema.html from the base documentation.
 139
 140 =cut
 141
 142 1;
 143