-
Notifications
You must be signed in to change notification settings - Fork 0
/
settings.php
1027 lines (995 loc) · 59.6 KB
/
settings.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?
/* ======================================================================================================== */
// These $CUSTOM_VARIABLES entries are helper variables
$CUSTOM_VARIABLES['islam_months'] = array(
1 => '1. Muḥarram',
2 => '2. Ṣafar',
3 => '3. Rabīʿ I',
4 => '4. Rabīʿ II',
5 => '5. Ǧumādā I',
6 => '6. Ǧumādā II',
7 => '7. Raǧab' ,
8 => '8. Šaʿbān',
9 => '9. Ramaḍān',
10 => '10. Šawwāl',
11 => '11. Ḏū ‘l-qaʿda',
12 => '12. Ḏū ‘l-ḥiǧǧa'
);
$CUSTOM_VARIABLES['person_name_display'] = array(
'columns' => array('lastname_translit', 'forename_translit', 'byname_translit'),
'expression' => "concat_ws(', ', %1, %2, %3)"
);
$CUSTOM_VARIABLES['all_actions'] = array(MODE_EDIT, MODE_NEW, MODE_VIEW, MODE_LIST, MODE_DELETE, MODE_LINK);
$CUSTOM_VARIABLES['history'] = array(
'edit_note' => array('label' => 'Editing Note', 'type' => T_TEXT_AREA, 'reset' => false /* not sure */, 'help' => 'This is an informal field that you can use to leave personal editoral comments and notes (e.g. what you are unclear about)'),
'edit_status' => array('label' => 'Editing Status', 'type' => T_ENUM, 'required' => true, 'default' => 'editing', 'help' => 'While you are editing the document set the status to <b>Editing</b>. When you are done editing and feel the record is ready for review, set to <b>Editing finished</b>. If you are unclear about any field or information set the status to <b>Unclear</b> and put an explanatory comment or note in the <i>Editing note</i> field. The status <b>Approved</b> should only be set by the seminar leaders.',
'values' => array('editing' => 'Editing', 'editing_finished' => 'Editing finished', 'unclear' => 'Unclear', 'approved' => 'Approved', 'imported' => 'Imported')),
'edit_user' => array('label' => 'Last Editor', 'type' => T_LOOKUP, 'editable' => false, 'default' => REPLACE_DYNAMIC_SESSION_USER, 'lookup' => array('cardinality' => CARDINALITY_SINGLE, 'table' => 'users', 'field' => 'id', 'display' => 'name'))
);
// note: for all these tables, an after_insert hook will be automatically added in alhamra_menu_complete
$CUSTOM_VARIABLES['tables_with_history'] = array(
'bibliographic_references',
'countries_and_regions',
'document_recipients',
'document_persons',
'document_to_document_references',
'documents',
'keywords',
'person_groups',
'person_places',
'person_relatives',
'persons',
'places',
'scans',
'sources',
'users',
'document_scans',
'document_keywords',
'document_places',
'document_primary_agents',
'document_primary_agent_groups',
'person_of_group',
'person_group_places'
);
$CUSTOM_VARIABLES['help_details_edit'] = 'Details of each assignment can be edited by clicking the <span class="glyphicon glyphicon-th-list"></span> icon.';
$CUSTOM_VARIABLES['arabic_dates'] = 'These are Islamic dates. If available, fill in the <i>Year</i>, <i>Month</i>, and <i>Day</i> fields. If none of those are available, try to provide a date range by filling in the <i>Year From</i> and/or the <i>Year To</i> fields.';
$CUSTOM_VARIABLES['arabic_dates_fromto'] = 'These are Islamic dates. If available provide a date range by filling in the either or both of the <i>From Year</i> and the <i>To Year</i> fields.';
$CUSTOM_VARIABLES['fk'] = array(
'document' => array('cardinality' => CARDINALITY_SINGLE, 'table' => 'documents', 'field' => 'id', 'display' => 'signature'),
'scan' => array('cardinality' => CARDINALITY_SINGLE, 'table' => 'scans', 'field' => 'id', 'display' => 'filename'),
'person' => array('cardinality' => CARDINALITY_SINGLE, 'table' => 'persons', 'field' => 'id', 'display' => $CUSTOM_VARIABLES['person_name_display']),
'person_group' => array('cardinality' => CARDINALITY_SINGLE, 'table' => 'person_groups', 'field' => 'id', 'display' => 'name_translit'),
'place' => array('cardinality' => CARDINALITY_SINGLE, 'table' => 'places', 'field' => 'id', 'display' => 'name_translit'),
'keyword' => array('cardinality' => CARDINALITY_SINGLE, 'table' => 'keywords', 'field' => 'id', 'display' => 'keyword'),
);
// only for admins
$CUSTOM_VARIABLES['extra_tables'] = array(
'view_changes_by_user' => array(
'actions' => array(MODE_LIST),
'global_search' => array('include_table' => false),
'display_name' => 'Changes By User',
'description' => '',
'item_name' => 'Change By User',
'primary_key' => array('auto' => false, 'columns' => array('user_id')),
'sort' => array('num_changes' => 'desc'),
'show_in_related' => false,
'fields' => array(
'user_id' => array('label' => 'User', 'type' => T_LOOKUP,
'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'users',
'field' => 'id',
'display' => 'name')),
'num_changes' => array('label' => '# Changes', 'type' => T_TEXT_LINE),
'user_role' => array('label' => 'Role', 'type' => T_ENUM, 'values' => array('user' => 'User', 'admin' => 'Admin')),
'first_change' => array('label' => 'First Change', 'type' => T_TEXT_LINE),
'last_change' => array('label' => 'Last Change', 'type' => T_TEXT_LINE)
)
),
'recent_changes_list' => array(
'actions' => array(MODE_LIST),
'global_search' => array('include_table' => false),
'display_name' => 'All Recent Changes',
'description' => 'Recent changes made by users in the database. Actions are either INSERT (new record), UPDATE (edited record) and DELETE (removed record). To see details of each change, please go to the editing history of the table mentioned in the "History Table" column.',
'item_name' => 'Change',
'primary_key' => array('auto' => false, 'columns' => array('table_name', 'history_id')),
'sort' => array('timestamp' => 'desc'),
'custom_actions' => array(
array('mode' => MODE_LIST, 'handler' => 'alhamra_recent_changes_item_view')
),
'show_in_related' => false,
'fields' => array(
'timestamp' => array('label' => 'Timestamp', 'type' => T_TEXT_LINE),
'user_id' => array('label' => 'Editor', 'type' => T_LOOKUP,
'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'users',
'field' => 'id',
'display' => 'name')),
'action' => array('label' => 'Action', 'type' => T_TEXT_LINE),
'table_name' => array('label' => 'History Table', 'type' => T_TEXT_LINE),
'history_id' => array('label' => 'History ID', 'type' => T_NUMBER)
)
)
);
/* ======================================================================================================== */
$APP = array(
'bootstrap_css' => 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css',
'plugins' => array(
'alhamra.php',
'calendar.php',
'import.php'),
'page_icon' => 'images/uni-tuebingen.ico',
'title' => 'ʿAbrīyīn Archive',
'view_display_null_fields' => false,
'page_size' => 10,
'max_text_len' => 125,
'pages_prevnext' => 2,
'mainmenu_tables_autosort' => true,
'search_lookup_resolve' => true,
'timezone' => 'Europe/Berlin',
'search_string_transformation' => 'dmg_plain((%s)::text)',
'null_label' => "<span class='nowrap' title='If you check this box, no value will be stored for this field. This may reflect missing, unknown, unspecified or inapplicable information. Note that no value (missing information) is different to providing an empty value: an empty value is a value.'>No Value</span>",
'menu_complete_proc' => 'alhamra_menu_complete',
'render_main_page_proc' => 'alhamra_render_main_page',
'list_mincolwidth_max' => 300,
'list_mincolwidth_pxperchar' => 6,
'custom_related_list_proc' => 'alhamra_custom_related_list',
'preprocess_html_func' => 'alhamra_preprocess_html',
'additional_callable_plugin_functions' => array('import_render'),
'querypage_stored_queries_table' => 'stored_queries',
'querypage_permission_func' => 'alhamra_querypage_check_permission',
'cache_dir' => 'cache',
'global_search' => array(
'include_table' => true,
'max_detail_results' => 50,
'transliterator_rules' => ':: Any-Latin; :: Latin-ASCII; :: NFD; :: [:Nonspacing Mark:] Remove; :: Lower(); :: NFC;'
),
'is_table_relevant_for_merge_func' => 'alhamra_is_table_relevant_for_merge'
);
/* ======================================================================================================== */
require_once 'db/db.php';
/* ======================================================================================================== */
$LOGIN = array(
'users_table' => 'users',
'primary_key' => 'id',
'username_field' => 'email',
'password_field' => 'password',
'name_field' => 'name',
'password_hash_func' => 'md5',
'allow_change_password' => true,
'form' => array('username' => 'Email', 'password' => 'Password'),
'initializer_proc' => 'alhamra_permissions',
'login_success_proc' => 'alhamra_login_success'
);
/* ======================================================================================================== */
$TABLES = array(
// ----------------------------------------------------------------------------------------------------
'users' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Users',
'description' => 'A <b>user</b> can log into the ʿAbrīyīn Archive and perform actions based on his/her assigned role.',
'item_name' => 'User',
'primary_key' => array('auto' => true, 'columns' => array('id'), 'sequence_name' => 'unique_object_id_seq'),
'sort' => array('name' => 'asc'),
'fields' => array(
'id' => array('label' => 'ID', 'type' => T_NUMBER, 'editable' => false),
'name' => array('label' => 'Name', 'type' => T_TEXT_LINE, 'len' => 50, 'required' => true, 'help' => 'This should be the user\'s real full name'),
'role' => array('label' => 'Role', 'type' => T_ENUM, 'required' => true, 'default' => 'user', 'values' => array('user' => 'Normal User', 'admin' => 'Admin'), 'help' => 'Normal users can create new records, edit and delete existing records (except user accounts). Admins can additionally manage user accounts and browse editing histories.'),
'email' => array('label' => 'Email', 'type' => T_TEXT_LINE, 'len' => 100, 'required' => true, 'help' => 'The email address is used for logging in.'),
'password' => array('label' => 'Password', 'type' => T_PASSWORD, 'len' => 32, 'required' => true, 'min_len' => 3, 'help' => 'The password must have at least 3 characters'),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'scans' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Scans',
'description' => 'A <b>scan</b> is a photo or scan of a document (or a document page). Scans can be assigned to documents. The maximum photo file size is 10 MB. <b>Note:</b> Uploaded media are not being backed up, so please make sure to retain a copy of the media you are uploading.',
'item_name' => 'Scan',
'primary_key' => array('auto' => true, 'columns' => array('id'), 'sequence_name' => 'unique_object_id_seq'),
'sort' => array('filename' => 'asc'),
'hooks' => array(
'before_insert' => 'alhamra_before_insert_or_update',
'before_update' => 'alhamra_before_insert_or_update'),
'render_links' => array(
array('icon' => 'eye-open', 'field' => 'filepath', 'href_format' => '%s', 'title' => 'Show this scan')
),
'fields' => array(
'id' => array('label' => 'ID', 'type' => T_NUMBER, 'editable' => false),
'filename' => array('label' => 'File', 'type' => T_UPLOAD, 'required' => true, 'max_size' => 10485760, 'location' => 'scans', 'store' => STORE_FOLDER /*could be extended to STORE_DB to store the file binary in database*/, 'allowed_ext' => array('jpg', 'jpeg'), 'help' => 'Upload <i>.jpg</i> or <i>.jpeg</i> images only. The filename must be unique and reflect the signature of the document.'),
'filepath' => array('label' => 'Path', 'type' => T_TEXT_LINE, 'len' => 1000, 'editable' => false),
'filesize' => array('label' => 'Size', 'type' => T_NUMBER, 'editable' => false),
'filetype' => array('label' => 'Type', 'type' => T_TEXT_LINE, 'len' => 100, 'editable' => false),
'information' => array('label' => 'Information', 'type' => T_TEXT_AREA, 'help' => 'Use this field to specify any additional factual information that is not reflected in any other field'),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'documents' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Documents',
'description' => 'A <b>document</b> reflects a letter or other kind of document in the archive and its associated data.',
'item_name' => 'Document',
'primary_key' => array('auto' => true, 'columns' => array('id'), 'sequence_name' => 'unique_object_id_seq'),
'sort' => array('signature' => 'asc'),
'hooks' => array(
'before_insert' => 'alhamra_before_insert_or_update',
'before_update' => 'alhamra_before_insert_or_update'),
'fields' => array(
'signature' => array('label' => 'Signature', 'type' => T_TEXT_LINE, 'len' => 7, 'required' => true, 'sort_expr' => 'naturalsort(%s)',
'help' => '<p>The signature consists of a maximum of 7 characters, including a hyphen. '.
'There are max. 4 signs <b>before</b> the hyphen, thereof when indicated one letter, '.
'e.g., <code>A1</code>, <code>B13</code>, <code>D148</code>. '.
'<b>After</b> the hyphen there can be max. 2 characters; these indicate the number of picture on the film.</p>'.
'<p>Examples:<ul style="padding-left:1em">'.
'<li><code>34-16</code>: film 34, picture 16</li>'.
'<li><code>A1-13</code>: film A1, picture 13</li>'.
'<li><code>B12-23</code>: film B12, picture 23</li>'.
'<li><code>D120-27</code>: film D120, picture 27</li>'.
'<li><code>E18-3</code>: film E18, picture 3</li>'.
'</ul></p>'.
'<p><b>Attention!</b> The number figuring between the film number and the number of the pictures indicates the '.
'"<b>bundle</b>" to which the document belongs. This concerns only some of the documents.</p>'),
'pack_nr' => array('label' => 'Bundle Number', 'type' => T_NUMBER, 'help' => 'Number of the bundle, without leading zeros.'),
'id' => array('label' => 'ID', 'type' => T_NUMBER, 'editable' => false),
'scans' => array('label' => 'Scan Images', 'required' => false, 'type' => T_LOOKUP,
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'scans',
'field' => 'id',
'display' => 'filename',
'related_label' => 'Document Captured By This Scan'
),
'linkage' => array(
'table' => 'document_scans',
'fk_self' => 'document',
'fk_other' => 'scan',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'type' => array('label' => 'Type', 'type' => T_ENUM, 'required' => true, 'default' => 'letter', 'values' => array('letter' => 'Letter', 'sales_contract' => 'Sales Contract', 'authorization' => 'Authorization', 'other' => 'Other'), 'help' => 'The type of document determines the kind person assigned in the <i>Primary Agents</i>, <i>Primary Agent Groups</i>, and <i>Recipients</i> fields'),
'physical_location' => array('label' => 'Physical Location', 'type' => T_LOOKUP, 'required' => true,
'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'places',
'field' => 'id',
'display' => 'name_translit',
'default' => 30,
'related_label' => 'Documents Physically Located At This Place'
)
),
'primary_agents' => array('label' => 'Primary Agents', 'required' => false, 'type' => T_LOOKUP,
'help' => 'The kind of primary agent of a document varies by document type. In a letter the primary agents are the senders; in a sales contract they are sellers; in an authorization document they are the principals. If a person group acts as primary agent of a document, pick this person group in the following field.',
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'persons',
'field' => 'id',
'display' => $CUSTOM_VARIABLES['person_name_display'],
'related_label' => 'Documents This Person Has Sent'
),
'linkage' => array(
'table' => 'document_primary_agents',
'fk_self' => 'document',
'fk_other' => 'person',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER)),
'conditional_form_label' => array(
'controlled_by' => 'type',
'mapping' => array(
'sales_contract' => 'Primary Agents<br /><span class="small text-muted">Sellers</span>',
'authorization' => 'Primary Agents<br /><span class="small text-muted">Principals</span>',
'letter' => 'Primary Agents<br /><span class="small text-muted">Senders</span>'
)
)
),
'primary_agent_groups' => array('label' => 'Primary Agent Groups', 'required' => false, 'type' => T_LOOKUP,
'help' => '<b>Attention</b>: This field is only to be filled in if a person group is the actual primary agent of a document. It is <b>not</b> to be filled to indicate the group affiliation of an individual agent.',
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'person_groups',
'field' => 'id',
'display' => 'name_translit',
'related_label' => 'Documents This Person Group Has Sent'),
'linkage' => array(
'table' => 'document_primary_agent_groups',
'fk_self' => 'document',
'fk_other' => 'person_group',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER)),
'conditional_form_label' => array(
'controlled_by' => 'type',
'mapping' => array(
'sales_contract' => 'Primary Agent Groups<br /><span class="small text-muted">Seller Groups</span>',
'authorization' => 'Primary Agent Groups<br /><span class="small text-muted">Principal Groups</span>',
'letter' => 'Primary Agent Groups<br /><span class="small text-muted">Sender Groups</span>'
)
)
),
'recipients' => array('label' => 'Recipients', 'type' => T_LOOKUP,
'help' => 'The kind of recipient of a document varies by document type. In a letter the recipients are the addressees; in a sales contract they are buyers; in an authorization document they are the agents. These assignments are stored in a separate table <a href="?table=document_recipients">Document Recipients</a>. ' . $CUSTOM_VARIABLES['help_details_edit'],
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'persons',
'field' => 'id',
'display' => $CUSTOM_VARIABLES['person_name_display'],
'related_label' => 'Documents Where This Person Is A Recipient'),
'linkage' => array(
'table' => 'document_recipients',
'fk_self' => 'document',
'fk_other' => 'person',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER)),
'conditional_form_label' => array(
'controlled_by' => 'type',
'mapping' => array(
'sales_contract' => 'Recipients<br /><span class="small text-muted">Buyers</span>',
'authorization' => 'Recipients<br /><span class="small text-muted">Authorized Agents</span>',
'letter' => 'Recipients<br /><span class="small text-muted">Addressees</span>'
)
)
),
'date_year' => array('label' => 'Date: Year', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'date_month' => array('label' => 'Date: Month', 'type' => T_ENUM, 'values' => $CUSTOM_VARIABLES['islam_months'], 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'date_day' => array('label' => 'Date: Day', 'type' => T_NUMBER , 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'date_year_from' => array('label' => 'Date: Year From', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'date_year_to' => array('label' => 'Date: Year To', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'gregorian_year_lower' => array('label' => 'Gregorian Year (Lower)', 'type' => T_NUMBER, 'editable' => false),
'gregorian_year_upper' => array('label' => 'Gregorian Year (Upper)', 'type' => T_NUMBER, 'editable' => false),
'other_places' => array('label' => 'Other Places', 'type' => T_LOOKUP,
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'places',
'field' => 'id',
'display' => 'name_translit',
'related_label' => 'Documents That Mention This Place'),
'linkage' => array(
'table' => 'document_places',
'fk_self' => 'document',
'fk_other' => 'place',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'related_persons' => array('label' => 'Related Persons', 'type' => T_LOOKUP,
'help' => 'Use this field to assign persons occurring in some role in this document. These assignments are stored in a separate table <a href="?table=document_persons">Persons in Documents</a>. ' . $CUSTOM_VARIABLES['help_details_edit'],
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'persons',
'field' => 'id',
'display' => $CUSTOM_VARIABLES['person_name_display'],
'related_label' => 'Documents Where This Person Played A Particular Role'),
'linkage' => array(
'table' => 'document_persons',
'fk_self' => 'document',
'fk_other' => 'person',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'document_to_document_references' => array('label' => 'Referenced Documents', 'type' => T_LOOKUP,
'help' => 'Use this field to specify which other documents in the archive are referenced by this one. These are stored in a separate table <a href="?table=document_to_document_references">Document-to-Document References</a>. ' . $CUSTOM_VARIABLES['help_details_edit'],
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'documents',
'field' => 'id',
'display' => 'signature',
'related_label' => 'Documents That Reference This Document'),
'linkage' => array(
'table' => 'document_to_document_references',
'fk_self' => 'source_doc',
'fk_other' => 'target_doc',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'keywords' => array('label' => 'Keywords', 'type' => T_LOOKUP,
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'keywords',
'field' => 'id',
'display' => 'keyword',
'related_label' => 'Documents Tagged With This Keyword'),
'linkage' => array(
'table' => 'document_keywords',
'fk_self' => 'document',
'fk_other' => 'keyword',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'bibliographic_references' => array('label' => 'Bibliographic References', 'type' => T_LOOKUP,
'help' => 'Use this field to assign <a href="?table=sources">sources</a> as references for this document. These assignments are stored in a separate table <a href="?table=bibliographic_references">Bibliographic References</a>. ' . $CUSTOM_VARIABLES['help_details_edit'],
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'sources',
'field' => 'id',
'display' => 'short_title',
'related_label' => 'Documents With Bibliographic References To This Source'),
'linkage' => array(
'table' => 'bibliographic_references',
'fk_self' => 'object',
'fk_other' => 'source',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
//'content' => array('label' => 'Content (XML)', 'type' => T_TEXT_AREA),
'summary' => array('label' => 'Summary', 'type' => T_TEXT_AREA),
'translation' => array('label' => 'English Translation', 'type' => T_TEXT_AREA),
'edit_note' => array('label' => 'Editing Note', 'type' => T_TEXT_AREA, 'help' => 'Remarks about<ul><li>unclear / illegible words, unclear vocalization (i.e. personal name)</li><li>“relative dates”, i.e. date deduced from affiliation to a bundle and / or with regards to content (events, people involved).</li><li>possible errors (e.g. unclear reading of dates etc.)</li><li>If editing status is <code>Imported</code>, this field shows details of the scans used to create this document</li></ul>'),
'edit_status' => $CUSTOM_VARIABLES['history']['edit_status'],
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
),
'additional_steps' => array(
'document_persons' => array('label' => 'Person In Document', 'foreign_key' => 'document'),
'document_to_document_references' => array('label' => 'Reference To Other Document', 'foreign_key' => 'source_doc'),
'document_recipients' => array('label' => 'Document Recipient Details', 'foreign_key' => 'document'),
'bibliographic_references' => array('label' => 'Bibliographic Reference', 'foreign_key' => 'object')
)
),
// ----------------------------------------------------------------------------------------------------
'document_recipients' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Document Recipients Details',
'description' => '<b>Document recipient details</b> specifies details of each recipient of a document, i.e. destination address of a document and whether a recipient address was a forwarding address. These details can also be set in the <i>Recipients</i> field of the document editing form.',
'item_name' => 'Document Recipient Details',
'primary_key' => array('auto' => false, 'columns' => array('document', 'person')),
'sort' => array('document' => 'asc', 'person' => 'asc'),
'fields' => array(
'document' => array('label' => 'Document', 'type' => T_LOOKUP, 'required' => true, 'help' => 'The document for which you want to specify an addressee and destination place', 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'documents',
'field' => 'id',
'display' => 'signature',
'related_label' => 'Document Recipient Details')
),
'person' => array('label' => 'Recipient', 'type' => T_LOOKUP, 'required' => true, 'help' => 'A person who is an addressee of the selected document', 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'persons',
'field' => 'id',
'display' => $CUSTOM_VARIABLES['person_name_display'],
'related_label' => 'Document Recipient Details Where This Person Appears')
),
'place' => array('label' => 'Address/Place', 'type' => T_LOOKUP, 'required' => false, 'help' => 'The destination address of the document for the selected person', 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'places',
'field' => 'id',
'display' => 'name_translit',
'related_label' => 'Document Recipient Details Where This Place Appears')
),
'has_forwarded' => array('label' => 'Forwarding Address?', 'type' => T_BOOLEAN, 'required' => true, 'help' => 'Specify whether this recipient was only forwarding, i.e. the recipient acted as an intermediary in the delivery of the document', 'default' => 'off', 'options' => array('onstyle' => 'success')),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'persons' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Persons',
'description' => 'A <b>person</b> record captures personal data of people occurring in the archive. Persons are <a href="?table=document_persons">associated with documents</a> (e.g. as scribes, attestors, etc.), with <a href="?table=person_places">places where they live</a>, with <a href="?table=person_relatives">their relatives</a> (e.g. father, brother, etc.), and with <a href="?table=person_groups">person groups to which they belong</a> (e.g. their tribal unit).',
'item_name' => 'Person',
'primary_key' => array('auto' => true, 'columns' => array('id'), 'sequence_name' => 'unique_object_id_seq'),
'sort' => array('lastname_translit' => 'asc', 'forename_translit' => 'asc'),
'hooks' => array(
'before_insert' => 'alhamra_before_insert_or_update',
'before_update' => 'alhamra_before_insert_or_update'),
'fields' => array(
'lastname_translit' => array('label' => 'Family name (translit.)', 'type' => T_TEXT_LINE, 'len' => 500, 'required' => false,
'help' => 'If the family name is missing, please enter "Unknown" here. If the family name is illegible, please enter "Unclear" and make an explanatory note in the field <i>Information</i>'),
'forename_translit' => array('label' => 'First name (translit.)', 'type' => T_TEXT_LINE, 'len' => 500, 'required' => true),
'byname_translit' => array('label' => 'Byname (translit.)', 'type' => T_TEXT_LINE, 'len' => 500),
'id' => array('label' => 'ID', 'type' => T_NUMBER, 'editable' => false),
'sex' => array('label' => 'Gender', 'type' => T_ENUM, 'required' => true, 'default' => 'm', 'values' => array('m' => 'Male', 'f' => 'Female')),
'lastname_arabic' => array('label' => 'Family name (Arabic)', 'type' => T_TEXT_LINE, 'len' => 500),
'forename_arabic' => array('label' => 'First name (Arabic)', 'type' => T_TEXT_LINE, 'len' => 500),
'byname_arabic' => array('label' => 'Byname (Arabic)', 'type' => T_TEXT_LINE, 'len' => 500),
'title' => array('label' => 'Title', 'type' => T_ENUM, 'values' => array('imām' => 'imām', 'sayyid' => 'sayyid', 'šayḫ' => 'šayḫ', 'wālī' => 'wālī')),
'group_memberships' => array('label' => 'Person\'s Groups', 'type' => T_LOOKUP,
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'person_groups',
'field' => 'id',
'display' => 'name_translit',
'related_label' => 'Persons of This Group'),
'linkage' => array(
'table' => 'person_of_group',
'fk_self' => 'person',
'fk_other' => 'person_group',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'birth_year' => array('label' => 'Birth Date: Year', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'birth_month' => array('label' => 'Birth Date: Month', 'type' => T_ENUM, 'values' => $CUSTOM_VARIABLES['islam_months'], 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'birth_day' => array('label' => 'Birth Date: Day', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'birth_year_from' => array('label' => 'Birth Date: Year From', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates'], 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'birth_year_to' => array('label' => 'Birth Date: Year To', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'gregorian_birth_year_lower' => array('label' => 'Gregorian Birth Year (Lower)', 'type' => T_NUMBER, 'editable' => false),
'gregorian_birth_year_upper' => array('label' => 'Gregorian Birth Year (Upper)', 'type' => T_NUMBER, 'editable' => false),
'death_year' => array('label' => 'Death Date: Year', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'death_month' => array('label' => 'Death Date: Month', 'type' => T_ENUM, 'values' => $CUSTOM_VARIABLES['islam_months'], 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'death_day' => array('label' => 'Death Date: Day', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'death_year_from' => array('label' => 'Death Date: Year From', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'death_year_to' => array('label' => 'Death Date: Year To', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates']),
'gregorian_death_year_lower' => array('label' => 'Gregorian Death Year (Lower)', 'type' => T_NUMBER, 'editable' => false),
'gregorian_death_year_upper' => array('label' => 'Gregorian Death Year (Upper)', 'type' => T_NUMBER, 'editable' => false),
/*'person_documents' => array('label' => 'Related Documents', 'type' => T_LOOKUP, 'editable' => false,
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'documents',
'field' => 'id',
'display' => 'signature'),
'linkage' => array(
'table' => 'document_persons',
'fk_self' => 'person',
'fk_other' => 'document')
),*/
'places_locations' => array('label' => 'Places/Locations', 'required' => false, 'type' => T_LOOKUP,
'help' => 'Use this field to assign this person to places. These assignments are stored in a separate table <a href="?table=person_places">Places of Persons</a>. ' . $CUSTOM_VARIABLES['help_details_edit'],
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'places',
'field' => 'id',
'display' => 'name_translit',
'related_label' => 'Persons Associated With This Place'),
'linkage' => array(
'table' => 'person_places',
'fk_self' => 'person',
'fk_other' => 'place',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'bibliographic_references' => array('label' => 'Bibliographic References', 'type' => T_LOOKUP,
'help' => 'Use this field to assign <a href="?table=sources">sources</a> as references for this person. These assignments are stored in a separate table <a href="?table=bibliographic_references">Bibliographic References</a>. ' . $CUSTOM_VARIABLES['help_details_edit'],
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'sources',
'field' => 'id',
'display' => 'short_title',
'related_label' => 'Persons With Bibliographic References To This Source'),
'linkage' => array(
'table' => 'bibliographic_references',
'fk_self' => 'object',
'fk_other' => 'source',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'information' => array('label' => 'Information', 'type' => T_TEXT_AREA, 'help' => 'Use this field to specify any additional factual information that is not reflected in any other field'),
'edit_note' => array('label' => 'Editing Note', 'type' => T_TEXT_AREA, 'help' => 'Remarks about<ul><li>kinship (e.g. son / brother / uncle of…)</li><li>social / political position (e.g. governor (wālī) of…)</li><li>ALSO: murdered by…; varying dates of birth / death</li></ul>'),
'edit_status' => $CUSTOM_VARIABLES['history']['edit_status'],
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
),
'additional_steps' => array(
'person_places' => array('label' => 'Places', 'foreign_key' => 'person'),
'person_relatives' => array('label' => 'Relatives', 'foreign_key' => 'person'),
'document_persons' => array('label' => 'Related To A Document', 'foreign_key' => 'person'),
'document_recipients' => array('label' => 'Recipient Of A Document', 'foreign_key' => 'person'),
'bibliographic_references' => array('label' => 'Bibliographic Reference', 'foreign_key' => 'object')
)
),
// ----------------------------------------------------------------------------------------------------
'person_places' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Places of Persons',
'description' => 'A <b>place of a person</b> reflects an association between a person and a place, usually reflecting that the person lived in that place for the specified time frame. The same association can also be defined in the <i>Places/Locations</i> field of the person editing form',
'item_name' => 'Place of Person',
'primary_key' => array('auto' => false, 'columns' => array('person', 'place')),
'sort' => array('person' => 'asc', 'place' => 'asc'),
'fields' => array(
'person' => array('label' => 'Person', 'type' => T_LOOKUP, 'required' => true, 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'persons',
'field' => 'id',
'display' => $CUSTOM_VARIABLES['person_name_display'],
'related_label' => 'Details Of Place Associations Of This Person')
),
'place' => array('label' => 'Place', 'type' => T_LOOKUP, 'required' => true, 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'places',
'field' => 'id',
'display' => 'name_translit',
'related_label' => 'Details Of Person Associations With This Place')
),
'from_year' => array('label' => 'From Year', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates_fromto']),
'to_year' => array('label' => 'To Year', 'type' => T_NUMBER, 'help' => $CUSTOM_VARIABLES['arabic_dates_fromto']),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'person_relatives' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Relatives of Persons',
'description' => 'A <b>relative of person</b> establishes a kinship between two persons.',
'item_name' => 'Relative of Person',
'primary_key' => array('auto' => false, 'columns' => array('person', 'relative')),
'sort' => array('person' => 'asc', 'relative' => 'asc'),
'fields' => array(
'person' => array('label' => 'Person', 'type' => T_LOOKUP, 'required' => true, 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'persons',
'field' => 'id',
'display' => $CUSTOM_VARIABLES['person_name_display'],
'related_label' => 'Details Of Family Relationships Where This Is The Relating Person')
),
'relative' => array('label' => 'Relative', 'type' => T_LOOKUP, 'required' => true, 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'persons',
'field' => 'id',
'display' => $CUSTOM_VARIABLES['person_name_display'],
'related_label' => 'Details Of Family Relationships Where This Is The Related Person')
),
'type' => array('label' => 'Kinship', 'type' => T_ENUM, 'required' => true, 'default' => 'unknown', 'values' => array('mother' => 'Mother', 'father' => 'Father', 'child' => 'Child', 'sibling' => 'Sibling', 'other' => 'Other', 'unknown' => 'Unknown'), 'help' => 'Select the role of the <i>Person</i> in the kinship with the <i>Relative</i>'),
'information' => array('label' => 'Information', 'type' => T_TEXT_AREA, 'help' => 'Use this field to specify any additional factual information that is not reflected in any other field'),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'document_persons' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Persons in Documents',
'description' => 'A <b>person in document</b> reflects a person who occurs related to a document as an attestor, a scribe, or who is sending/receiving greetings or being mentioned in any other way. These associations can also be defined in the <i>Related Persons</i> field of the document editing form',
'item_name' => 'Person in Document',
'primary_key' => array('auto' => false, 'columns' => array('document', 'person')),
'sort' => array('document' => 'asc', 'person' => 'asc'),
'fields' => array(
'document' => array('label' => 'Document', 'type' => T_LOOKUP, 'required' => true, 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'documents',
'field' => 'id',
'display' => 'signature',
'related_label' => 'Details Of Person Associations With This Document')
),
'person' => array('label' => 'Person', 'type' => T_LOOKUP, 'required' => true, 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'persons',
'field' => 'id',
'display' => $CUSTOM_VARIABLES['person_name_display'],
'related_label' => 'Details Of Associations of This Person With Documents')
),
'type' => array('label' => 'Role', 'type' => T_ENUM, 'required' => true, 'default' => 'other', 'values' => array('attestor' => 'Attestor', 'scribe' => 'Scribe', 'sending_greetings' => 'Sending greetings', 'receiving_greetings' => 'Receiving greetings', 'secondary_recipient' => 'Secondary Recipient', 'other' => 'Other'), 'help' => 'In what role does the person occur in relation to the document?'),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'document_to_document_references' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Document-to-Document References',
'description' => 'A <b>document-to-document reference</b> establishes a any kind of direct reference from one document (the referencing document) to another document (the referenced document). The same association can also be defined in the <i>Referenced Documents</i> field of the document editing form.',
'item_name' => 'Document-to-Document Reference',
'primary_key' => array('auto' => false, 'columns' => array('source_doc', 'target_doc')),
'sort' => array('source_doc' => 'asc', 'target_doc' => 'asc'),
'fields' => array(
'source_doc' => array('label' => 'Referencing Document', 'type' => T_LOOKUP, 'required' => true, 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'documents',
'field' => 'id',
'display' => 'signature',
'related_label' => 'Details Of References Where This Is A Referencing Document')
),
'target_doc' => array('label' => 'Referenced Document (Target)', 'type' => T_LOOKUP, 'required' => true, 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'documents',
'field' => 'id',
'display' => 'signature',
'related_label' => 'Details Of References Where This Is A Referenced Document')
),
'comment' => array('label' => 'Comment', 'type' => T_TEXT_AREA),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'places' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Places',
'description' => 'A <b>place</b> represents any settlement or other place of relevance to documents, persons, and person groups.',
'item_name' => 'Place',
'primary_key' => array('auto' => true, 'columns' => array('id'), 'sequence_name' => 'unique_object_id_seq'),
'sort' => array('name_translit' => 'asc'),
'fields' => array(
'name_translit' => array('label' => 'Transliterated Name', 'type' => T_TEXT_LINE, 'len' => 50, 'required' => true),
'id' => array('label' => 'ID', 'type' => T_NUMBER, 'editable' => false),
'type' => array('label' => 'Type', 'type' => T_ENUM, 'required' => true, 'values' => array('settlement' => 'Settlement', 'other' => 'Other'), 'default' => 'settlement'),
'name_arabic' => array('label' => 'Arabic Name', 'type' => T_TEXT_LINE, 'len' => 50),
'information' => array('label' => 'Information', 'type' => T_TEXT_AREA, 'help' => 'Use this field to specify any additional factual information that is not reflected in any other field'),
'coordinates' => array(
'label' => 'Coordinates',
'type' => T_POSTGIS_GEOM,
'SRID' => '32640',
'map_picker' => array(
'script' => 'alhamra_map_picker.js',
'map_options' => array('attributionControl' => false),
'draw_options' => array('circle' => false)
),
'help' => '<p>Select a location from the map by clicking the <code><span class="glyphicon glyphicon-map-marker"></span> Map</code> button, or manually enter the <a href="https://en.wikipedia.org/wiki/Well-known_text">well-known text (WKT)</a> representation of any POINT geometry, e.g. <code>POINT(501760.32 4649776.22)</code>. See also <a href="http://postgis.net/docs/ST_GeomFromText.html" target="_blank">here</a> for help. The spatial reference system is <a href="https://epsg.io/32640">EPSG:32640 (WGS 84 / UTM zone 40N)</a>.'
),
'country_region' => array('label' => 'Country/Region', 'type' => T_LOOKUP, 'required' => true, 'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'countries_and_regions',
'field' => 'id',
'display' => 'name',
'default' => 7,
'related_label' => 'Places In This Country/Region')
),
'bibliographic_references' => array('label' => 'Bibliographic References', 'type' => T_LOOKUP,
'help' => 'Use this field to assign <a href="?table=sources">sources</a> as references for this place. These assignments are stored in a separate table <a href="?table=bibliographic_references">Bibliographic References</a>. ' . $CUSTOM_VARIABLES['help_details_edit'],
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'sources',
'field' => 'id',
'display' => 'short_title',
'related_label' => 'Places With Bibliographic References To This Source'),
'linkage' => array(
'table' => 'bibliographic_references',
'fk_self' => 'object',
'fk_other' => 'source',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'edit_note' => $CUSTOM_VARIABLES['history']['edit_note'],
'edit_status' => $CUSTOM_VARIABLES['history']['edit_status'],
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
),
'additional_steps' => array(
'person_places' => array('label' => 'Persons Associated With This Place', 'foreign_key' => 'place'),
'document_recipients' => array('label' => 'Document Recipient At This Place', 'foreign_key' => 'place'),
'bibliographic_references' => array('label' => 'Bibliographic Reference', 'foreign_key' => 'object')
)
),
// ----------------------------------------------------------------------------------------------------
'person_groups' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Person Groups',
'description' => 'A <b>person group</b> represents a tribe, tribal unit and other groupings of <a href="?table=persons">persons</a>.',
'item_name' => 'Person Group',
'primary_key' => array('auto' => true, 'columns' => array('id'), 'sequence_name' => 'unique_object_id_seq'),
'sort' => array('name_translit' => 'asc'),
'fields' => array(
'name_translit' => array('label' => 'Name (transliterated)', 'type' => T_TEXT_LINE, 'len' => 50, 'required' => true),
'id' => array('label' => 'ID', 'type' => T_NUMBER, 'editable' => false),
'type' => array('label' => 'Type', 'type' => T_ENUM, 'required' => true, 'default' => 'other', 'values' => array('tribe' => 'Tribe', 'tribal_unit' => 'Tribal unit', 'other' => 'Other')),
'name_arabic' => array('label' => 'Name (Arabic)', 'type' => T_TEXT_LINE, 'len' => 50),
'places' => array('label' => 'Place(s)', 'type' => T_LOOKUP,
'help' => 'Places associated with this person group',
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'places',
'field' => 'id',
'display' => 'name_translit',
'related_label' => 'Person Groups At This Place'
),
'linkage' => array(
'table' => 'person_group_places',
'fk_self' => 'person_group',
'fk_other' => 'place',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'members' => array('label' => 'Group Members', 'type' => T_LOOKUP, 'help' => 'All persons belonging to this person group',
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'persons',
'field' => 'id',
'display' => $CUSTOM_VARIABLES['person_name_display'],
'related_label' => 'Person Groups This Person Belongs To'),
'linkage' => array(
'table' => 'person_of_group',
'fk_self' => 'person_group',
'fk_other' => 'person',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'bibliographic_references' => array('label' => 'Bibliographic References', 'type' => T_LOOKUP,
'help' => 'Use this field to assign <a href="?table=sources">sources</a> as references for this person group. These assignments are stored in a separate table <a href="?table=bibliographic_references">Bibliographic References</a>. ' . $CUSTOM_VARIABLES['help_details_edit'],
'lookup' => array(
'cardinality' => CARDINALITY_MULTIPLE,
'table' => 'sources',
'field' => 'id',
'display' => 'short_title',
'related_label' => 'Person Groups With Bibliographic References To This Source'),
'linkage' => array(
'table' => 'bibliographic_references',
'fk_self' => 'object',
'fk_other' => 'source',
'defaults' => array('edit_user' => REPLACE_DYNAMIC_SESSION_USER))
),
'information' => array('label' => 'Information', 'type' => T_TEXT_AREA, 'help' => 'Use this field to specify any additional factual information that is not reflected in any other field'),
'edit_note' => $CUSTOM_VARIABLES['history']['edit_note'],
'edit_status' => $CUSTOM_VARIABLES['history']['edit_status'],
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
),
'additional_steps' => array(
'bibliographic_references' => array('label' => 'Bibliographic Reference', 'foreign_key' => 'object')
)
),
// ----------------------------------------------------------------------------------------------------
'countries_and_regions' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Countries/Regions',
'description' => 'A <b>country or region</b> is a regional container for the places of relevance in the archive.',
'item_name' => 'Country/Region',
'primary_key' => array('auto' => true, 'columns' => array('id'), 'sequence_name' => 'unique_object_id_seq'),
'sort' => array('name' => 'asc'),
'fields' => array(
'name' => array('label' => 'Name', 'type' => T_TEXT_LINE, 'len' => 50, 'required' => true),
'id' => array('label' => 'ID', 'type' => T_NUMBER, 'editable' => false),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
),
'additional_steps' => array(
'places' => array('label' => 'Place In This Region', 'foreign_key' => 'country_region'),
)
),
// ----------------------------------------------------------------------------------------------------
'keywords' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Keywords',
'description' => 'A <b>keyword</b> is a word used to tag documents of the archive.',
'item_name' => 'Keyword',
'primary_key' => array('auto' => true, 'columns' => array('id'), 'sequence_name' => 'unique_object_id_seq'),
'sort' => array('keyword' => 'asc'),
'fields' => array(
'keyword' => array('label' => 'Keyword', 'type' => T_TEXT_LINE, 'len' => 50, 'required' => true),
'id' => array('label' => 'ID', 'type' => T_NUMBER, 'editable' => false),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'sources' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Sources',
'description' => 'A <b>source</b> represents as a bibliographic reference for documents, places, persons and person groups in the archive.',
'item_name' => 'Source',
'primary_key' => array('auto' => true, 'columns' => array('id'), 'sequence_name' => 'unique_object_id_seq'),
'sort' => array('id' => 'asc'),
'fields' => array(
'short_title' => array('label' => 'Short Title', 'type' => T_TEXT_LINE, 'len' => 100, 'required' => true, 'help' => '<ul><li>Secondary literature: Author date (e.g. Hoffmann-Ruf 2008)</li><li>Primary source: Author, Short title (e.g. al-ʿAbri, Tabaṣṣurāt)</li></ul>'),
'full_title' => array('label' => 'Full Title', 'type' => T_TEXT_AREA, 'len' => 1000, 'required' => true, 'help' => '<ul><li>Secondary literature: Hoffmann-Ruf, Michaela, Scheich Muḥsin b. Zahrān al-ʿAbrī: Tribale Macht im Oman des 19. Jahrhunderts, Berlin 2008.</li><li>Primary source: ʿAbrī, Ibrāhīm b. Saʿīd al-, Tabaṣṣurāt al-muʿtabirīn fī tārīḫ al-ʿAbrīyīn (manuscript) 1959.</li></ul>'),
'id' => array('label' => 'ID', 'type' => T_NUMBER, 'editable' => false),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'bibliographic_references' => array(
'actions' => $CUSTOM_VARIABLES['all_actions'],
'display_name' => 'Bibliographic References',
'description' => 'A <b>bibliographic reference</b> connects places, persons, person groups and documents to bibliographic <a href="?table=sources">sources</a>.',
'item_name' => 'Bibliographic Reference',
'primary_key' => array('auto' => false, 'columns' => array('object', 'source')),
'sort' => array('object' => 'asc', 'source' => 'asc'),
'fields' => array(
'object' => array('label' => 'Object', 'type' => T_LOOKUP, 'required' => true, 'allow-create' => false, 'help' => 'Select the place, person, person group or document to link to a source',
'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'citing_objects',
'field' => 'id',
'display' => 'name',
'related_label' => 'Details Of Bibliographic References Of This Object'
)
),
'source' => array('label' => 'Source', 'type' => T_LOOKUP, 'required' => true,
'lookup' => array(
'cardinality' => CARDINALITY_SINGLE,
'table' => 'sources',
'field' => 'id',
'display' => 'short_title',
'related_label' => 'Details Of Bibliographic References To This Source'
)
),
'volume' => array('label' => 'Volume(s)', 'type' => T_TEXT_LINE, 'len' => 100),
'page' => array('label' => 'Page(s)', 'type' => T_TEXT_LINE, 'len' => 100),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
// ----------------------------------------------------------------------------------------------------
'stored_queries' => array(
'actions' => array(MODE_LINK, MODE_VIEW, MODE_EDIT, MODE_LIST, MODE_DELETE), // these are updated based on user role in alhamra.php plugin
'display_name' => 'Stored Queries',
'description' => 'A <b>stored query</b> allows you to view a live visualization of a database query result based on current data.',
'sort' => array('title' => 'asc'),
'item_name' => 'Stored Query',
'show_in_related' => false,
'primary_key' => array('auto' => false, 'columns' => array('id')),
'render_links' => array(
array('icon' => 'eye-open', 'field' => 'id', 'href_format' => '?mode=query&navbar=on&id=%s', 'title' => 'Show visualization of stored query')
),
'fields' => array(
'title' => array('label' => 'Title', 'type' => T_TEXT_LINE),
'description' => array('label' => 'Description', 'type' => T_TEXT_AREA),
'id' => array('label' => 'ID', 'type' => T_TEXT_LINE, 'editable' => false),
'params_json' => array('label' => 'JSON Params', 'type' => T_TEXT_AREA),
'create_time' => array('label' => 'Timestamp', 'type' => T_TEXT_LINE, 'editable' => false)
)
),
// ----------------------------------------------------------------------------------------------------
// n:m tables that will only be visible in history mode
// ----------------------------------------------------------------------------------------------------
'document_scans' => array(
'actions' => array(),
'global_search' => array('include_table' => false),
'display_name' => 'Document Scans',
'description' => 'Document Scans',
'item_name' => 'Document Scans',
'show_in_related' => false,
'primary_key' => array('auto' => false, 'columns' => array('document', 'scan')),
'fields' => array(
'document' => array('label' => 'Document', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['document']),
'scan' => array('label' => 'Scan Image', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['scan']),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
'document_keywords' => array(
'actions' => array(),
'global_search' => array('include_table' => false),
'display_name' => 'Document Keywords',
'description' => '',
'item_name' => 'Document Keywords',
'show_in_related' => false,
'primary_key' => array('auto' => false, 'columns' => array('document', 'keyword')),
'fields' => array(
'document' => array('label' => 'Document', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['document']),
'keyword' => array('label' => 'Keyword', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['keyword']),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
'document_places' => array(
'actions' => array(),
'global_search' => array('include_table' => false),
'display_name' => 'Places in Documents',
'description' => '',
'item_name' => 'Places in Documents',
'show_in_related' => false,
'primary_key' => array('auto' => false, 'columns' => array('document', 'place')),
'fields' => array(
'document' => array('label' => 'Document', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['document']),
'place' => array('label' => 'Place', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['place']),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
'document_primary_agents' => array(
'actions' => array(),
'global_search' => array('include_table' => false),
'display_name' => 'Primary Agents of Documents',
'description' => '',
'item_name' => 'Primary Agents of Documents',
'show_in_related' => false,
'primary_key' => array('auto' => false, 'columns' => array('document', 'person')),
'fields' => array(
'document' => array('label' => 'Document', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['document']),
'person' => array('label' => 'Primary Agent', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['person']),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
'document_primary_agent_groups' => array(
'actions' => array(),
'global_search' => array('include_table' => false),
'display_name' => 'Primary Agent Groups of Documents',
'description' => '',
'item_name' => 'Primary Agent Groups of Documents',
'show_in_related' => false,
'primary_key' => array('auto' => false, 'columns' => array('document', 'person_group')),
'fields' => array(
'document' => array('label' => 'Document', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['document']),
'person_group' => array('label' => 'Primary Agent Group', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['person_group']),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
'person_of_group' => array(
'actions' => array(),
'global_search' => array('include_table' => false),
'display_name' => 'Person Group Memberships',
'description' => '',
'item_name' => 'Person Group Memberships',
'show_in_related' => false,
'primary_key' => array('auto' => false, 'columns' => array('person', 'person_group')),
'fields' => array(
'person' => array('label' => 'Person', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['person']),
'person_group' => array('label' => 'Person Group', 'type' => T_LOOKUP, 'lookup' => $CUSTOM_VARIABLES['fk']['person_group']),
'edit_user' => $CUSTOM_VARIABLES['history']['edit_user']
)
),
'person_group_places' => array(
'actions' => array(),