1 package SL::DB::Helper::Mappings;
6 use SL::Util qw(camelify);
9 our @ISA = qw(Exporter);
10 our @EXPORT_OK = qw(get_table_for_package get_package_for_table get_package_names);
12 # these will not be managed as Rose::DB models, because they are not normalized,
13 # significant changes are needed to get them done, or they were done by CRM.
14 my @kivitendo_blacklist_permanent = qw(
18 # these are not managed _yet_, but will hopefully at some point.
19 # if you are confident that one of these works, remove it here.
20 my @kivitendo_blacklist_temp = qw(
23 # tables created by crm module
24 my @crm_blacklist = qw(
74 # tables created by cash register
75 my @cash_register_blacklist = qw(
76 ekartikel ekbon ekkunde ektext erptasten
79 my @kivitendo_blacklist = (@kivitendo_blacklist_permanent, @kivitendo_blacklist_temp, @crm_blacklist, @cash_register_blacklist);
81 # map table names to their models.
82 # unlike rails we have no singular<->plural magic.
83 # remeber: tables should be named as the plural of the model name.
84 my %kivitendo_package_names = (
85 # TABLE # MODEL (given in C style)
86 acc_trans => 'acc_transaction',
87 'auth.clients' => 'auth_client',
88 'auth.clients_users' => 'auth_client_user',
89 'auth.clients_groups' => 'auth_client_group',
90 'auth.group' => 'auth_group',
91 'auth.group_rights' => 'auth_group_right',
92 'auth.master_rights' => 'auth_master_right',
93 'auth.schema_info' => 'auth_schema_info',
94 'auth.session' => 'auth_session',
95 'auth.session_content' => 'auth_session_content',
96 'auth.user' => 'auth_user',
97 'auth.user_config' => 'auth_user_config',
98 'auth.user_group' => 'auth_user_group',
100 ap => 'purchase_invoice',
101 assembly => 'assembly',
102 assortment_items => 'assortment_item',
103 background_jobs => 'background_job',
104 background_job_histories => 'background_job_history',
105 ap => 'purchase_invoice',
106 bank_accounts => 'bank_account',
107 bank_transactions => 'bank_transaction',
108 bank_transaction_acc_trans => 'bank_transaction_acc_trans',
109 buchungsgruppen => 'buchungsgruppe',
111 business => 'business',
113 contact_titles => 'contact_title',
114 contacts => 'contact',
115 customer => 'customer',
116 csv_import_profiles => 'csv_import_profile',
117 csv_import_profile_settings => 'csv_import_profile_setting',
118 csv_import_reports => 'csv_import_report',
119 csv_import_report_rows => 'csv_import_report_row',
120 csv_import_report_status => 'csv_import_report_status',
121 currencies => 'currency',
122 custom_data_export_queries => 'CustomDataExportQuery',
123 custom_data_export_query_parameters => 'CustomDataExportQueryParameter',
124 custom_variable_config_partsgroups => 'custom_variable_config_partsgroup',
125 custom_variable_configs => 'custom_variable_config',
126 custom_variables => 'custom_variable',
127 custom_variables_validity => 'custom_variable_validity',
129 defaults => 'default',
130 delivery_orders => 'delivery_order',
131 delivery_order_items => 'delivery_order_item',
132 delivery_order_items_stock => 'delivery_order_items_stock',
133 delivery_terms => 'delivery_term',
134 department => 'department',
136 dunning => 'dunning',
137 dunning_config => 'dunning_config',
138 email_journal => 'EmailJournal',
139 email_journal_attachments => 'EmailJournalAttachment',
140 employee => 'employee',
141 employee_project_invoices => 'EmployeeProjectInvoices',
142 exchangerate => 'exchangerate',
144 finanzamt => 'finanzamt',
145 follow_up_access => 'follow_up_access',
146 follow_up_links => 'follow_up_link',
147 follow_ups => 'follow_up',
148 generic_translations => 'generic_translation',
149 gl => 'GLTransaction',
150 greetings => 'greeting',
151 history_erp => 'history',
152 inventory => 'inventory',
153 invoice => 'invoice_item',
154 language => 'language',
156 letter_draft => 'letter_draft',
157 makemodel => 'make_model',
159 orderitems => 'order_item',
162 partsgroup => 'parts_group',
163 part_classifications => 'PartClassification',
164 part_customer_prices => 'PartCustomerPrice',
165 parts_price_history => 'PartsPriceHistory',
166 payment_terms => 'payment_term',
167 periodic_invoices => 'periodic_invoice',
168 periodic_invoices_configs => 'periodic_invoices_config',
170 price_factors => 'price_factor',
171 price_rules => 'price_rule',
172 price_rule_items => 'price_rule_item',
173 pricegroup => 'pricegroup',
174 printers => 'printer',
175 project => 'project',
176 project_participants => 'project_participant',
177 project_phase_participants => 'project_phase_participant',
178 project_phases => 'project_phase',
179 project_roles => 'project_role',
180 project_statuses => 'project_status',
181 project_types => 'project_type',
182 reconciliation_links => 'reconciliation_link',
183 record_links => 'record_link',
184 record_templates => 'record_template',
185 record_template_items => 'record_template_item',
186 requirement_spec_acceptance_statuses => 'RequirementSpecAcceptanceStatus',
187 requirement_spec_complexities => 'RequirementSpecComplexity',
188 requirement_spec_item_dependencies => 'RequirementSpecDependency',
189 requirement_spec_items => 'RequirementSpecItem',
190 requirement_spec_orders => 'RequirementSpecOrder',
191 requirement_spec_parts => 'RequirementSpecPart',
192 requirement_spec_pictures => 'RequirementSpecPicture',
193 requirement_spec_predefined_texts => 'RequirementSpecPredefinedText',
194 requirement_spec_risks => 'RequirementSpecRisk',
195 requirement_spec_statuses => 'RequirementSpecStatus',
196 requirement_spec_text_blocks => 'RequirementSpecTextBlock',
197 requirement_spec_types => 'RequirementSpecType',
198 requirement_spec_versions => 'RequirementSpecVersion',
199 requirement_specs => 'RequirementSpec',
200 sepa_export => 'sepa_export',
201 sepa_export_items => 'sepa_export_item',
202 sepa_export_message_ids => 'SepaExportMessageId',
203 schema_info => 'schema_info',
206 shop_images => 'shop_image',
207 shop_orders => 'shop_order',
208 shop_order_items => 'shop_order_item',
209 shop_parts => 'shop_part',
211 stocktakings => 'stocktaking',
213 taxkeys => 'tax_key',
214 tax_zones => 'tax_zone',
215 taxzone_charts => 'taxzone_chart',
216 todo_user_config => 'todo_user_config',
217 transfer_type => 'transfer_type',
218 translation => 'translation',
219 trigger_information => 'trigger_information',
221 units_language => 'units_language',
222 user_preferences => 'user_preference',
224 warehouse => 'warehouse',
227 my (%kivitendo_tables_to_packages, %kivitendo_tables_to_manager_packages, %kivitendo_packages_to_tables);
230 return KIVITENDO => \@kivitendo_blacklist;
233 sub get_package_names {
234 return KIVITENDO => \%kivitendo_package_names;
237 sub get_name_for_table {
238 return $kivitendo_package_names{ $_[0] };
241 sub get_package_for_table {
242 %kivitendo_tables_to_packages = map { ($_ => "SL::DB::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
243 unless %kivitendo_tables_to_packages;
245 return $kivitendo_tables_to_packages{ $_[0] };
248 sub get_manager_package_for_table {
249 %kivitendo_tables_to_manager_packages = map { ($_ => "SL::DB::Manager::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
250 unless %kivitendo_tables_to_manager_packages;
252 return $kivitendo_tables_to_manager_packages{ $_[0] };
255 sub get_table_for_package {
256 get_package_for_table('dummy') if !%kivitendo_tables_to_packages;
257 %kivitendo_packages_to_tables = reverse %kivitendo_tables_to_packages unless %kivitendo_packages_to_tables;
259 my $package = $_[0] =~ m/^SL::DB::/ ? $_[0] : "SL::DB::" . $_[0];
260 return $kivitendo_packages_to_tables{ $package };
265 my $lookup = $kivitendo_package_names{$_[0]} ||
266 plurify($kivitendo_package_names{singlify($_[0])});
268 for my $thing ($string, $lookup) {
270 # best guess? its already the name. like part. camelize it first
271 my $class = "SL::DB::" . camelify($thing);
272 return $class if defined *{ $class. '::' };
274 # next, someone wants a manager and pluralized.
275 my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
276 return $manager if defined *{ $manager . '::' };
279 die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
302 SL::DB::Helper::Mappings - Rose Table <-> Model mapping information
306 use SL::DB::Helper::Mappings qw(@blacklist %table2model);
310 This modul stores table <-> model mappings used by the
311 L<scripts/rose_auto_create_model.pl> script. If you add a new table that has
312 custom mappings, add it here.
320 A special function provided here is C<db>. Without it you'd have to write:
322 my $part = SL::DB::Part->new(id => 1234);
323 my @all_parts = SL::DB::Manager::Part->get_all;
325 with them it becomes:
327 my $part = db('part')->new(id => 123);
328 my @all_parts = db('parts')->get_all;
330 You don't have to care about add that SL::DB:: incantation anymore. Also, a
331 simple s at the end will get you the associated Manager class.
333 db is written to try to make sense of what you give it, but if all fails, it
334 will die with an error.
336 =item C<get_package_for_table $table_name>
338 Returns the package name for a table name:
340 SL::DB::Helper::Mappings::get_package_for_table('oe')
343 =item C<get_manager_package_for_table $table_name>
345 Returns the manager package name for a table name:
347 SL::DB::Helper::Mappings::get_manager_package_for_table('oe')
348 # SL::DB::Manager::Order
350 =item C<get_table_for_package $package_name>
352 Returns the table name for a package name:
354 SL::DB::Helper::Mappings::get_table_for_package('SL::DB::Order')
356 SL::DB::Helper::Mappings::get_table_for_package('Order')
367 L<scripts/rose_auto_create_model.pl>
371 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
372 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>