FS/FS/access_group.pm

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