FS/FS/part_tag.pm

   1 package FS::part_tag;
   2 use base qw( FS::Record );
   3
   4 use strict;
   5 use FS::Record qw( qsearch ); #qsearchs );
   6
   7 =head1 NAME
   8
   9 FS::part_tag - Object methods for part_tag records
  10
  11 =head1 SYNOPSIS
  12
  13   use FS::part_tag;
  14
  15   $record = new FS::part_tag \%hash;
  16   $record = new FS::part_tag { 'column' => 'value' };
  17
  18   $error = $record->insert;
  19
  20   $error = $new_record->replace($old_record);
  21
  22   $error = $record->delete;
  23
  24   $error = $record->check;
  25
  26 =head1 DESCRIPTION
  27
  28 An FS::part_tag object represents a tag.  FS::part_tag inherits from
  29 FS::Record.  The following fields are currently supported:
  30
  31 =over 4
  32
  33 =item tagnum - primary key
  34
  35 =item tagname - tag name
  36
  37 =item tagdesc - description (can be longer than name)
  38
  39 =item tagcolor - HTML-style color to display this tag
  40
  41 =item by_default - 'Y' to enable this tag on new customers
  42
  43 =item disabled
  44
  45 =back
  46
  47 =head1 METHODS
  48
  49 =over 4
  50
  51 =item new HASHREF
  52
  53 Creates a new tag.  To add the tag 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 { 'part_tag'; }
  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 tag.  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('tagnum')
 106     || $self->ut_text('tagname')
 107     || $self->ut_textn('tagdesc')
 108     || $self->ut_textn('tagcolor')
 109     || $self->ut_enum('by_default', [ '', 'Y' ] )
 110     || $self->ut_enum('disabled', [ '', 'Y' ] )
 111   ;
 112   return $error if $error;
 113
 114   $self->SUPER::check;
 115 }
 116
 117 =back
 118
 119 =head1 CLASS METHODS
 120
 121 =over 4
 122
 123 =item default_tags
 124
 125 Returns the tagnums of all tags that have 'by_default' enabled.
 126
 127 =cut
 128
 129 sub default_tags {
 130   my $class = shift;
 131   map { $_->tagnum } qsearch('part_tag', { disabled => '', by_default => 'Y' });
 132 }
 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