1 package SL::DB::Helper::Mappings;
7 our @ISA = qw(Exporter);
8 our @EXPORT_OK = qw(get_table_for_package get_package_for_table get_package_names);
10 # these will not be managed as Rose::DB models, because they are not normalized,
11 # significant changes are needed to get them done, or they were done by CRM.
12 my @lxoffice_blacklist_permanent = qw(
16 # these are not managed _yet_, but will hopefully at some point.
17 # if you are confident that one of these works, remove it here.
18 my @lxoffice_blacklist_temp = qw(
21 my @lxoffice_blacklist = (@lxoffice_blacklist_permanent, @lxoffice_blacklist_temp);
23 # map table names to their models.
24 # unlike rails we have no singular<->plural magic.
25 # remeber: tables should be named as the plural of the model name.
26 my %lxoffice_package_names = (
27 acc_trans => 'acc_transaction',
28 audittrail => 'audit_trail',
29 auth_group => 'auth_groups',
30 auth_group_right => 'auth_group_rights',
31 auth_user => 'auth_users',
32 auth_user_config => 'auth_user_configs',
33 auth_user_group => 'auth_user_groups',
35 ap => 'purchase_invoice',
36 background_jobs => 'background_job',
37 background_job_histories => 'background_job_history',
38 ap => 'purchase_invoice',
39 bank_accounts => 'bank_account',
40 buchungsgruppen => 'buchungsgruppe',
41 contacts => 'contact',
42 csv_import_profiles => 'csv_import_profile',
43 csv_import_profile_settings => 'csv_import_profile_setting',
44 custom_variable_configs => 'custom_variable_config',
45 custom_variables => 'custom_variable',
46 custom_variables_validity => 'custom_variable_validity',
47 customertax => 'customer_tax',
49 defaults => 'default',
50 delivery_orders => 'delivery_order',
51 delivery_order_items => 'delivery_order_item',
52 department => 'department',
53 dpt_trans => 'dpt_trans',
56 dunning_config => 'dunning_config',
57 employee => 'employee',
58 exchangerate => 'exchangerate',
59 finanzamt => 'finanzamt',
60 follow_up_access => 'follow_up_access',
61 follow_up_links => 'follow_up_link',
62 follow_ups => 'follow_up',
63 generic_translations => 'generic_translation',
65 gl => 'GLTransaction',
66 history_erp => 'history',
67 inventory => 'inventory',
68 invoice => 'invoice_item',
69 language => 'language',
71 licenseinvoice => 'license_invoice',
72 makemodel => 'make_model',
74 orderitems => 'order_item',
77 partsgroup => 'parts_group',
78 partstax => 'parts_tax',
79 payment_terms => 'payment_term',
80 periodic_invoices => 'periodic_invoice',
81 periodic_invoices_configs => 'periodic_invoices_config',
83 price_factors => 'price_factor',
84 pricegroup => 'pricegroup',
85 printers => 'Printer',
86 record_links => 'record_link',
88 rmaitems => 'RMA_item',
89 sepa_export => 'sepa_export',
90 sepa_export_items => 'sepa_export_item',
91 schema_info => 'schema_info',
95 tax_zones => 'tax_zone',
96 todo_user_config => 'todo_user_config',
97 translation => 'translation',
98 translation_payment_terms => 'translation_payment_term',
100 units_language => 'units_language',
101 vendortax => 'vendor_tax',
104 my (%lxoffice_tables_to_packages, %lxoffice_tables_to_manager_packages, %lxoffice_packages_to_tables);
107 return LXOFFICE => \@lxoffice_blacklist;
110 sub get_package_names {
111 return LXOFFICE => \%lxoffice_package_names;
114 sub get_package_for_table {
115 %lxoffice_tables_to_packages = map { ($_ => "SL::DB::" . camelify($lxoffice_package_names{$_})) } keys %lxoffice_package_names
116 unless %lxoffice_tables_to_packages;
118 return $lxoffice_tables_to_packages{ $_[0] };
121 sub get_manager_package_for_table {
122 %lxoffice_tables_to_manager_packages = map { ($_ => "SL::DB::Manager::" . camelify($lxoffice_package_names{$_})) } keys %lxoffice_package_names
123 unless %lxoffice_tables_to_manager_packages;
125 return $lxoffice_tables_to_manager_packages{ $_[0] };
128 sub get_table_for_package {
129 get_package_for_table('dummy') if !%lxoffice_tables_to_packages;
130 %lxoffice_packages_to_tables = reverse %lxoffice_tables_to_packages unless %lxoffice_packages_to_tables;
132 my $package = $_[0] =~ m/^SL::DB::/ ? $_[0] : "SL::DB::" . $_[0];
133 return $lxoffice_packages_to_tables{ $package };
138 my $lookup = $lxoffice_package_names{$_[0]} ||
139 plurify($lxoffice_package_names{singlify($_[0])});
141 for my $thing ($string, $lookup) {
143 # best guess? its already the name. like part. camelize it first
144 my $class = "SL::DB::" . camelify($thing);
145 return $class if defined *{ $class. '::' };
147 # next, someone wants a manager and pluralized.
148 my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
149 return $manager if defined *{ $manager . '::' };
152 die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
157 $str =~ s/_+(.)/uc($1)/ge;
163 $str =~ s/(?<!^)\u(.)/'_' . lc($1)/ge;
187 SL::DB::Helper::Mappings - Rose Table <-> Model mapping information
191 use SL::DB::Helper::Mappings qw(@blacklist %table2model);
195 This modul stores table <-> model mappings used by the
196 L<scripts/rose_auto_create_model.pl> script. If you add a new table that has
197 custom mappings, add it here.
205 A special function provided here is C<db>. Without it you'd have to write:
207 my $part = SL::DB::Part->new(id => 1234);
208 my @all_parts = SL::DB::Manager::Part->get_all;
210 with them it becomes:
212 my $part = db('part')->new(id => 123);
213 my @all_parts = db('parts')->get_all;
215 You don't have to care about add that SL::DB:: incantation anymore. Also, a
216 simple s at the end will get you the associated Manager class.
218 db is written to try to make sense of what you give it, but if all fails, it
219 will die with an error.
221 =item C<get_package_for_table $table_name>
223 Returns the package name for a table name:
225 SL::DB::Helper::Mappings::get_package_for_table('oe')
228 =item C<get_manager_package_for_table $table_name>
230 Returns the manager package name for a table name:
232 SL::DB::Helper::Mappings::get_manager_package_for_table('oe')
233 # SL::DB::Manager::Order
235 =item C<get_table_for_package $package_name>
237 Returns the table name for a package name:
239 SL::DB::Helper::Mappings::get_table_for_package('SL::DB::Order')
241 SL::DB::Helper::Mappings::get_table_for_package('Order')
252 L<scripts/rose_auto_create_model.pl>
256 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
257 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>