From 130c7801e718d55c500e9f777112f51905cad060 Mon Sep 17 00:00:00 2001 From: ivan Date: Thu, 15 Jul 2010 21:46:31 +0000 Subject: [PATCH] customer tags, RT#9192 --- FS/FS.pm | 4 ++ FS/FS/Mason.pm | 1 + FS/FS/Schema.pm | 24 +++++++ FS/FS/cust_tag.pm | 126 ++++++++++++++++++++++++++++++++ FS/FS/part_tag.pm | 132 ++++++++++++++++++++++++++++++++++ FS/MANIFEST | 4 ++ FS/t/cust_tag.t | 5 ++ FS/t/part_tag.t | 5 ++ httemplate/browse/part_tag.html | 23 ++++++ httemplate/edit/part_tag.html | 23 ++++++ httemplate/edit/process/part_tag.html | 11 +++ httemplate/elements/menu.html | 5 +- 12 files changed, 362 insertions(+), 1 deletion(-) create mode 100644 FS/FS/cust_tag.pm create mode 100644 FS/FS/part_tag.pm create mode 100644 FS/t/cust_tag.t create mode 100644 FS/t/part_tag.t create mode 100644 httemplate/browse/part_tag.html create mode 100644 httemplate/edit/part_tag.html create mode 100644 httemplate/edit/process/part_tag.html 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 - Customer classification class L - Customer category class +L - Customer tag class + +L - Tag definition class + L - Customer tax exemption class L - 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 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, 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 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, 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"; diff --git a/httemplate/browse/part_tag.html b/httemplate/browse/part_tag.html new file mode 100644 index 000000000..3bb166199 --- /dev/null +++ b/httemplate/browse/part_tag.html @@ -0,0 +1,23 @@ +<% include( 'elements/browse.html', + 'title' => 'Tags', + 'name_singular' => 'tag', + 'menubar' => [ 'Add a new tag' => + $p.'edit/part_tag.html', + ], + 'query' => { 'table' => 'part_tag', }, + 'count_query' => 'SELECT COUNT(*) FROM part_tag', + 'header' => [ 'Tag', 'Description', 'Color' ], + 'fields' => [ 'tagname', 'tagdesc', 'tagcolor' ], + 'links' => [ $link, '', '' ], + 'disableable' => 1, + 'disabled_statuspos' => 1, + ) +%> +<%init> + +die "access denied" + unless $FS::CurrentUser::CurrentUser->access_right('Configuration'); + +my $link = [ "${p}edit/part_tag.html?", 'tagnum' ]; + + diff --git a/httemplate/edit/part_tag.html b/httemplate/edit/part_tag.html new file mode 100644 index 000000000..938e34256 --- /dev/null +++ b/httemplate/edit/part_tag.html @@ -0,0 +1,23 @@ +<% include( 'elements/edit.html', + 'table' => 'part_tag', + 'name_singular' => 'tag', + 'fields' => [ 'tagname', + { field=>'disabled', type=>'checkbox', value=>'Y' }, + 'tagdesc', + 'tagcolor' + ], + 'labels' => { 'tagnum' => 'Tag #', + 'tagname' => 'Tag', + 'tagdesc' => 'Description', + 'tagcolor' => 'Highlight Color', + 'disabled' => 'Disabled', + }, + 'viewall_dir' => 'browse', + ) +%> +<%init> + +die "access denied" + unless $FS::CurrentUser::CurrentUser->access_right('Configuration'); + + diff --git a/httemplate/edit/process/part_tag.html b/httemplate/edit/process/part_tag.html new file mode 100644 index 000000000..077dc4cd9 --- /dev/null +++ b/httemplate/edit/process/part_tag.html @@ -0,0 +1,11 @@ +<% include( 'elements/process.html', + 'table' => 'part_tag', + 'viewall_dir' => 'browse', + ) +%> +<%init> + +die "access denied" + unless $FS::CurrentUser::CurrentUser->access_right('Configuration'); + + diff --git a/httemplate/elements/menu.html b/httemplate/elements/menu.html index 190455772..1eaefe231 100644 --- a/httemplate/elements/menu.html +++ b/httemplate/elements/menu.html @@ -475,6 +475,8 @@ tie my %config_misc, 'Tie::IxHash'; $config_misc{'Message templates'} = [ $fsurl.'browse/msg_template.html', 'Templates for customer notices' ] if $curuser->access_right('Edit templates') || $curuser->access_right('Edit global templates'); +$config_misc{'Tags'} = [ $fsurl.'browse/part_tag.html', '' ] + if $curuser->access_right('Configuration'); $config_misc{'Advertising sources'} = [ $fsurl.'browse/part_referral.html', 'Where a customer heard about your service.' ] if $curuser->access_right('Edit advertising sources') || $curuser->access_right('Edit global advertising sources'); @@ -518,7 +520,8 @@ $config_menu{'Broadband'} = [ \%config_broadband, '' ] $config_menu{'Phone'} = [ \%config_phone, '' ] if ( $curuser->access_right('Configuration') ); $config_menu{'Miscellaneous'} = [ \%config_misc, '' ] - if $curuser->access_right('Edit advertising sources') + if $curuser->access_right('Configuration' ) + || $curuser->access_right('Edit advertising sources') || $curuser->access_right('Edit global advertising sources'); -- 2.11.0