FS/FS/access_group.pm

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