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 background_jobs => 'background_job',
103 background_job_histories => 'background_job_history',
104 ap => 'purchase_invoice',
105 bank_accounts => 'bank_account',
106 bank_transactions => 'bank_transaction',
107 buchungsgruppen => 'buchungsgruppe',
109 business => 'business',
111 contacts => 'contact',
112 customer => 'customer',
113 csv_import_profiles => 'csv_import_profile',
114 csv_import_profile_settings => 'csv_import_profile_setting',
115 csv_import_reports => 'csv_import_report',
116 csv_import_report_rows => 'csv_import_report_row',
117 csv_import_report_status => 'csv_import_report_status',
118 currencies => 'currency',
119 custom_variable_config_partsgroups => 'custom_variable_config_partsgroup',
120 custom_variable_configs => 'custom_variable_config',
121 custom_variables => 'custom_variable',
122 custom_variables_validity => 'custom_variable_validity',
124 defaults => 'default',
125 delivery_orders => 'delivery_order',
126 delivery_order_items => 'delivery_order_item',
127 delivery_order_items_stock => 'delivery_order_items_stock',
128 delivery_terms => 'delivery_term',
129 department => 'department',
131 dunning => 'dunning',
132 dunning_config => 'dunning_config',
133 email_journal => 'EmailJournal',
134 email_journal_attachments => 'EmailJournalAttachment',
135 employee => 'employee',
136 exchangerate => 'exchangerate',
137 finanzamt => 'finanzamt',
138 follow_up_access => 'follow_up_access',
139 follow_up_links => 'follow_up_link',
140 follow_ups => 'follow_up',
141 generic_translations => 'generic_translation',
142 gl => 'GLTransaction',
143 history_erp => 'history',
144 inventory => 'inventory',
145 invoice => 'invoice_item',
146 language => 'language',
148 letter_draft => 'letter_draft',
149 makemodel => 'make_model',
151 orderitems => 'order_item',
154 partsgroup => 'parts_group',
155 payment_terms => 'payment_term',
156 periodic_invoices => 'periodic_invoice',
157 periodic_invoices_configs => 'periodic_invoices_config',
159 price_factors => 'price_factor',
160 price_rules => 'price_rule',
161 price_rule_items => 'price_rule_item',
162 pricegroup => 'pricegroup',
163 printers => 'printer',
164 project => 'project',
165 project_participants => 'project_participant',
166 project_phase_participants => 'project_phase_participant',
167 project_phases => 'project_phase',
168 project_roles => 'project_role',
169 project_statuses => 'project_status',
170 project_types => 'project_type',
171 record_links => 'record_link',
172 reconciliation_links => 'reconciliation_link',
173 requirement_spec_acceptance_statuses => 'RequirementSpecAcceptanceStatus',
174 requirement_spec_complexities => 'RequirementSpecComplexity',
175 requirement_spec_item_dependencies => 'RequirementSpecDependency',
176 requirement_spec_items => 'RequirementSpecItem',
177 requirement_spec_orders => 'RequirementSpecOrder',
178 requirement_spec_parts => 'RequirementSpecPart',
179 requirement_spec_pictures => 'RequirementSpecPicture',
180 requirement_spec_predefined_texts => 'RequirementSpecPredefinedText',
181 requirement_spec_risks => 'RequirementSpecRisk',
182 requirement_spec_statuses => 'RequirementSpecStatus',
183 requirement_spec_text_blocks => 'RequirementSpecTextBlock',
184 requirement_spec_types => 'RequirementSpecType',
185 requirement_spec_versions => 'RequirementSpecVersion',
186 requirement_specs => 'RequirementSpec',
187 sepa_export => 'sepa_export',
188 sepa_export_items => 'sepa_export_item',
189 sepa_export_message_ids => 'SepaExportMessageId',
190 schema_info => 'schema_info',
194 taxkeys => 'tax_key',
195 tax_zones => 'tax_zone',
196 taxzone_charts => 'taxzone_chart',
197 todo_user_config => 'todo_user_config',
198 transfer_type => 'transfer_type',
199 translation => 'translation',
200 trigger_information => 'trigger_information',
202 units_language => 'units_language',
204 warehouse => 'warehouse',
207 my (%kivitendo_tables_to_packages, %kivitendo_tables_to_manager_packages, %kivitendo_packages_to_tables);
210 return KIVITENDO => \@kivitendo_blacklist;
213 sub get_package_names {
214 return KIVITENDO => \%kivitendo_package_names;
217 sub get_name_for_table {
218 return $kivitendo_package_names{ $_[0] };
221 sub get_package_for_table {
222 %kivitendo_tables_to_packages = map { ($_ => "SL::DB::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
223 unless %kivitendo_tables_to_packages;
225 return $kivitendo_tables_to_packages{ $_[0] };
228 sub get_manager_package_for_table {
229 %kivitendo_tables_to_manager_packages = map { ($_ => "SL::DB::Manager::" . camelify($kivitendo_package_names{$_})) } keys %kivitendo_package_names
230 unless %kivitendo_tables_to_manager_packages;
232 return $kivitendo_tables_to_manager_packages{ $_[0] };
235 sub get_table_for_package {
236 get_package_for_table('dummy') if !%kivitendo_tables_to_packages;
237 %kivitendo_packages_to_tables = reverse %kivitendo_tables_to_packages unless %kivitendo_packages_to_tables;
239 my $package = $_[0] =~ m/^SL::DB::/ ? $_[0] : "SL::DB::" . $_[0];
240 return $kivitendo_packages_to_tables{ $package };
245 my $lookup = $kivitendo_package_names{$_[0]} ||
246 plurify($kivitendo_package_names{singlify($_[0])});
248 for my $thing ($string, $lookup) {
250 # best guess? its already the name. like part. camelize it first
251 my $class = "SL::DB::" . camelify($thing);
252 return $class if defined *{ $class. '::' };
254 # next, someone wants a manager and pluralized.
255 my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
256 return $manager if defined *{ $manager . '::' };
259 die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
282 SL::DB::Helper::Mappings - Rose Table <-> Model mapping information
286 use SL::DB::Helper::Mappings qw(@blacklist %table2model);
290 This modul stores table <-> model mappings used by the
291 L<scripts/rose_auto_create_model.pl> script. If you add a new table that has
292 custom mappings, add it here.
300 A special function provided here is C<db>. Without it you'd have to write:
302 my $part = SL::DB::Part->new(id => 1234);
303 my @all_parts = SL::DB::Manager::Part->get_all;
305 with them it becomes:
307 my $part = db('part')->new(id => 123);
308 my @all_parts = db('parts')->get_all;
310 You don't have to care about add that SL::DB:: incantation anymore. Also, a
311 simple s at the end will get you the associated Manager class.
313 db is written to try to make sense of what you give it, but if all fails, it
314 will die with an error.
316 =item C<get_package_for_table $table_name>
318 Returns the package name for a table name:
320 SL::DB::Helper::Mappings::get_package_for_table('oe')
323 =item C<get_manager_package_for_table $table_name>
325 Returns the manager package name for a table name:
327 SL::DB::Helper::Mappings::get_manager_package_for_table('oe')
328 # SL::DB::Manager::Order
330 =item C<get_table_for_package $package_name>
332 Returns the table name for a package name:
334 SL::DB::Helper::Mappings::get_table_for_package('SL::DB::Order')
336 SL::DB::Helper::Mappings::get_table_for_package('Order')
347 L<scripts/rose_auto_create_model.pl>
351 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
352 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>