kivitendo/SL/DB/Helpers/Mappings.pm @ 3cc8ad87
| 82515b2d | Sven Schöling | package SL::DB::Helpers::Mappings;
|
||
use strict;
|
||||
| 3cc8ad87 | Sven Schöling | use Exporter qw(import);
|
||
our @EXPORT_OK = qw(db);
|
||||
| 4fd22b56 | Sven Schöling | # these will not be managed as Rose::DB models, because they are not normalized
|
||
| 82515b2d | Sven Schöling | # significant changes are needed to get them done.
|
||
my @lxoffice_blacklist_permanent = qw(
|
||||
acc_trans audittrail customertax datev defaults department dpt_trans
|
||||
exchangerate finanzamt follow_up_access gifi inventory leads licenseinvoice
|
||||
makemodel partsgroup partstax prices record_links rmaitems status tax_zones
|
||||
todo_user_config translation translation_payment_terms units_language
|
||||
vendortax);
|
||||
# these are not managed _yet_, but will hopefully at some point.
|
||||
# if you are confident that one of these works, remove it here.
|
||||
my @lxoffice_blacklist_temp = qw(
|
||||
);
|
||||
my @lxoffice_blacklist = (@lxoffice_blacklist_permanent, @lxoffice_blacklist_temp);
|
||||
# map table names to their models.
|
||||
# unlike rails we have no singular<->plural magic.
|
||||
# remeber: tables should be named as the plural of the model name.
|
||||
my %lxoffice_package_names = (
|
||||
ar => 'invoice',
|
||||
ap => 'purchase_invoice',
|
||||
| 4fd22b56 | Sven Schöling | bank_accounts => 'bank_account',
|
||
buchungsgruppen => 'buchungsgruppe',
|
||||
contacts => 'contact',
|
||||
custom_variable_configs => 'custom_variable_config',
|
||||
custom_variables => 'custom_variable',
|
||||
custom_variables_validity => 'custom_variable_validity',
|
||||
| 82515b2d | Sven Schöling | delivery_orders => 'delivery_order',
|
||
delivery_order_items => 'delivery_order_item',
|
||||
| 4fd22b56 | Sven Schöling | drafts => 'draft',
|
||
dunning => 'dunning',
|
||||
dunning_config => 'dunning_config',
|
||||
employee => 'employee',
|
||||
follow_up_links => 'follow_up_link',
|
||||
follow_ups => 'follow_up',
|
||||
generic_translations => 'generic_translation',
|
||||
| 82515b2d | Sven Schöling | gl => 'GLTransaction',
|
||
| 4fd22b56 | Sven Schöling | history_erp => 'history',
|
||
| 82515b2d | Sven Schöling | invoice => 'invoice_item',
|
||
| 4fd22b56 | Sven Schöling | language => 'language',
|
||
license => 'licemse',
|
||||
notes => 'note',
|
||||
| 82515b2d | Sven Schöling | orderitems => 'order_item',
|
||
oe => 'order',
|
||||
parts => 'part',
|
||||
| 4fd22b56 | Sven Schöling | payment_terms => 'payment_term',
|
||
| 82515b2d | Sven Schöling | price_factors => 'price_factor',
|
||
| 4fd22b56 | Sven Schöling | pricegroup => 'pricegroup',
|
||
| 82515b2d | Sven Schöling | printers => 'Printer',
|
||
| 4fd22b56 | Sven Schöling | rma => 'RMA',
|
||
sepa_export => 'sepa_export',
|
||||
sepa_export_items => 'sepa_export_item',
|
||||
| 85da554f | Sven Schöling | schema_info => 'schema_info',
|
||
| 4fd22b56 | Sven Schöling | tax => 'tax',
|
||
taxkeys => 'taxkey',
|
||||
| 82515b2d | Sven Schöling | units => 'unit',
|
||
);
|
||||
sub get_blacklist {
|
||||
return LXOFFICE => \@lxoffice_blacklist;
|
||||
}
|
||||
sub get_package_names {
|
||||
return LXOFFICE => \%lxoffice_package_names;
|
||||
}
|
||||
| 3cc8ad87 | Sven Schöling | sub db {
|
||
my $string = $_[0];
|
||||
my $lookup = $lxoffice_package_names{$_[0]} ||
|
||||
plurify($lxoffice_package_names{singlify($_[0])});
|
||||
for my $thing ($string, $lookup) {
|
||||
# best guess? its already the name. like part. camelize it first
|
||||
my $class = "SL::DB::" . camelify($thing);
|
||||
return $class if defined *{ $class. '::' };
|
||||
# next, someone wants a manager and pluralized.
|
||||
my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
|
||||
return $manager if defined *{ $manager . '::' };
|
||||
}
|
||||
die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
|
||||
}
|
||||
sub camelify {
|
||||
my ($str) = @_;
|
||||
$str =~ s/_+(.)/uc($1)/ge;
|
||||
ucfirst $str;
|
||||
}
|
||||
sub snakify {
|
||||
my ($str) = @_;
|
||||
$str =~ s/(?<!^)\u(.)/'_' . lc($1)/ge;
|
||||
lcfirst $str;
|
||||
}
|
||||
sub plurify {
|
||||
my ($str) = @_;
|
||||
$str . 's';
|
||||
}
|
||||
sub singlify {
|
||||
my ($str) = @_;
|
||||
local $/ = 's';
|
||||
chomp $str;
|
||||
$str;
|
||||
}
|
||||
| 82515b2d | Sven Schöling | 1;
|
||
__END__
|
||||
=head1 NAME
|
||||
SL::DB::Helpers::Mappings - Rose Table <-> Model mapping information
|
||||
=head1 SYNOPSIS
|
||||
use SL::DB::Helpers::Mappings qw(@blacklist %table2model);
|
||||
=head1 DESCRIPTION
|
||||
This modul stores table <-> model mappings used by the
|
||||
L<scripts/rose_auto_create_model.pl> script. If you add a new table that has
|
||||
custom mappings, add it here.
|
||||
| 3cc8ad87 | Sven Schöling | =head2 db
|
||
A special function provided here is E<db>. Without it you'd have to write:
|
||||
my $part = SL::DB::Part->new(id => 1234);
|
||||
my @all_parts = SL::DB::Manager::Part->get_all;
|
||||
with them it becomes:
|
||||
my $part = db('part')->new(id => 123);
|
||||
my @all_parts = db('parts')->get_all;
|
||||
You don't have to care about add that SL::DB:: incantation anymore. Also, a
|
||||
simple s at the end will get you the associated Manager class.
|
||||
db is written to try to make sense of what you give it, but if all fails, it
|
||||
will die with an error.
|
||||
| 82515b2d | Sven Schöling | =head1 BUGS
|
||
nothing yet
|
||||
=head1 SEE ALSO
|
||||
L<scripts/rose_auto_create_model.pl>
|
||||
=head1 AUTHOR
|
||||
Sven Sch?ling <s.schoeling@linet-services.de>
|
||||
=cut
|