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