customer tags, RT#9192

8 files changed, 301 insertions, 0 deletions

diff --git a/FS/FS.pm b/FS/FS.pm
index 8613c71f0..07b31b3b5 100644
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -272,6 +272,10 @@ L<FS::cust_class> - Customer classification class
 
 L<FS::cust_category> - Customer category class
 
+L<FS::cust_tag> - Customer tag class
+
+L<FS::part_tag> - Tag definition class
+
 L<FS::cust_main_exemption> - Customer tax exemption class
 
 L<FS::cust_main_note> - Customer note class
diff --git a/FS/FS/Mason.pm b/FS/FS/Mason.pm
index 20748dc1d..5d860f2de 100644
--- a/FS/FS/Mason.pm
+++ b/FS/FS/Mason.pm
@@ -247,6 +247,7 @@ if ( -e $addl_handler_use_file ) {
   use FS::rate_time;
   use FS::rate_time_interval;
   use FS::msg_template;
+  use FS::part_tag;
   # Sammath Naur
 
   if ( $FS::Mason::addl_handler_use ) {
diff --git a/FS/FS/Schema.pm b/FS/FS/Schema.pm
index 1bfce613c..1aefbd044 100644
--- a/FS/FS/Schema.pm
+++ b/FS/FS/Schema.pm
@@ -960,6 +960,30 @@ sub tables_hashref {
       'unique' => [],
       'index' => [ ['disabled'] ],
     },
+ 
+    'cust_tag' => {
+      'columns' => [
+        'custtagnum', 'serial', '', '', '', '',
+        'custnum',       'int', '', '', '', '',
+        'tagnum',        'int', '', '', '', '',
+      ],
+      'primary_key' => 'custtagnum',
+      'unique'      => [ [ 'custnum', 'tagnum' ] ],
+      'index'       => [ [ 'custnum' ] ],
+    },
+
+    'part_tag' => {
+      'columns' => [
+        'tagnum',    'serial',     '',      '', '', '',
+        'tagname',  'varchar',     '', $char_d, '', '',
+        'tagdesc',  'varchar', 'NULL', $char_d, '', '',
+        'tagcolor', 'varchar', 'NULL',       6, '', '',
+        'disabled',    'char', 'NULL',       1, '', '', 
+      ],
+      'primary_key' => 'tagnum',
+      'unique'      => [], #[ [ 'tagname' ] ], #?
+      'index'       => [ [ 'disabled' ] ],
+    },
 
     'cust_main_exemption' => {
       'columns' => [
diff --git a/FS/FS/cust_tag.pm b/FS/FS/cust_tag.pm
new file mode 100644
index 000000000..1d174d127
--- /dev/null
+++ b/FS/FS/cust_tag.pm
@@ -0,0 +1,126 @@
+package FS::cust_tag;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::cust_tag - Object methods for cust_tag records
+
+=head1 SYNOPSIS
+
+  use FS::cust_tag;
+
+  $record = new FS::cust_tag \%hash;
+  $record = new FS::cust_tag { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::cust_tag object represents a customer tag.  FS::cust_tag inherits from
+FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item custtagnum
+
+primary key
+
+=item custnum
+
+custnum
+
+=item tagnum
+
+tagnum
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new customer tag.  To add the tag to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'cust_tag'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid customer tag.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+# the check method should currently be supplied - FS::Record contains some
+# data checking routines
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('custtagnum')
+    || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
+    || $self->ut_foreign_key('tagnum',  'part_tag',  'tagnum' )
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/FS/part_tag.pm b/FS/FS/part_tag.pm
new file mode 100644
index 000000000..0229e3aaa
--- /dev/null
+++ b/FS/FS/part_tag.pm
@@ -0,0 +1,132 @@
+package FS::part_tag;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::part_tag - Object methods for part_tag records
+
+=head1 SYNOPSIS
+
+  use FS::part_tag;
+
+  $record = new FS::part_tag \%hash;
+  $record = new FS::part_tag { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::part_tag object represents a tag.  FS::part_tag inherits from
+FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item tagnum
+
+primary key
+
+=item tagname
+
+tagname
+
+=item tagdesc
+
+tagdesc
+
+=item tagcolor
+
+tagcolor
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new tag.  To add the tag to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'part_tag'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid tag.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+# the check method should currently be supplied - FS::Record contains some
+# data checking routines
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('tagnum')
+    || $self->ut_text('tagname')
+    || $self->ut_textn('tagdesc')
+    || $self->ut_textn('tagcolor')
+    || $self->ut_enum('disabled', [ '', 'Y' ] )
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/MANIFEST b/FS/MANIFEST
index f2c3362ab..7685f85f9 100644
--- a/FS/MANIFEST
+++ b/FS/MANIFEST
@@ -522,3 +522,7 @@ FS/cgp_rule_action.pm
 t/cgp_rule_action.t
 FS/msg_template.pm
 t/msg_template.t
+FS/cust_tag.pm
+t/cust_tag.t
+FS/part_tag.pm
+t/part_tag.t
diff --git a/FS/t/cust_tag.t b/FS/t/cust_tag.t
new file mode 100644
index 000000000..d81042ca2
--- /dev/null
+++ b/FS/t/cust_tag.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::cust_tag;
+$loaded=1;
+print "ok 1\n";
diff --git a/FS/t/part_tag.t b/FS/t/part_tag.t
new file mode 100644
index 000000000..12b7b6533
--- /dev/null
+++ b/FS/t/part_tag.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::part_tag;
+$loaded=1;
+print "ok 1\n";