Conditions | 180 |
Paths | > 20000 |
Total Lines | 542 |
Code Lines | 480 |
Lines | 0 |
Ratio | 0 % |
Changes | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
1 | <?php |
||
46 | public static function reformatRecord($rec, Tree $tree) |
||
47 | { |
||
48 | // Strip out UTF8 formatting characters |
||
49 | $rec = str_replace(array(WT_UTF8_BOM, WT_UTF8_LRM, WT_UTF8_RLM), '', $rec); |
||
50 | |||
51 | // Strip out mac/msdos line endings |
||
52 | $rec = preg_replace("/[\r\n]+/", "\n", $rec); |
||
53 | |||
54 | // Extract lines from the record; lines consist of: level + optional xref + tag + optional data |
||
55 | $num_matches = preg_match_all('/^[ \t]*(\d+)[ \t]*(@[^@]*@)?[ \t]*(\w+)[ \t]?(.*)$/m', $rec, $matches, PREG_SET_ORDER); |
||
56 | |||
57 | // Process the record line-by-line |
||
58 | $newrec = ''; |
||
59 | foreach ($matches as $n => $match) { |
||
60 | list(, $level, $xref, $tag, $data) = $match; |
||
61 | $tag = strtoupper($tag); // Tags should always be upper case |
||
62 | switch ($tag) { |
||
63 | // Convert PhpGedView tags to WT |
||
64 | case '_PGVU': |
||
65 | $tag = '_WT_USER'; |
||
66 | break; |
||
67 | case '_PGV_OBJS': |
||
68 | $tag = '_WT_OBJE_SORT'; |
||
69 | break; |
||
70 | // Convert FTM-style "TAG_FORMAL_NAME" into "TAG". |
||
71 | case 'ABBREVIATION': |
||
72 | $tag = 'ABBR'; |
||
73 | break; |
||
74 | case 'ADDRESS': |
||
75 | $tag = 'ADDR'; |
||
76 | break; |
||
77 | case 'ADDRESS1': |
||
78 | $tag = 'ADR1'; |
||
79 | break; |
||
80 | case 'ADDRESS2': |
||
81 | $tag = 'ADR2'; |
||
82 | break; |
||
83 | case 'ADDRESS3': |
||
84 | $tag = 'ADR3'; |
||
85 | break; |
||
86 | case 'ADOPTION': |
||
87 | $tag = 'ADOP'; |
||
88 | break; |
||
89 | case 'ADULT_CHRISTENING': |
||
90 | $tag = 'CHRA'; |
||
91 | break; |
||
92 | case 'AFN': |
||
93 | // AFN values are upper case |
||
94 | $data = strtoupper($data); |
||
95 | break; |
||
96 | case 'AGENCY': |
||
97 | $tag = 'AGNC'; |
||
98 | break; |
||
99 | case 'ALIAS': |
||
100 | $tag = 'ALIA'; |
||
101 | break; |
||
102 | case 'ANCESTORS': |
||
103 | $tag = 'ANCE'; |
||
104 | break; |
||
105 | case 'ANCES_INTEREST': |
||
106 | $tag = 'ANCI'; |
||
107 | break; |
||
108 | case 'ANNULMENT': |
||
109 | $tag = 'ANUL'; |
||
110 | break; |
||
111 | case 'ASSOCIATES': |
||
112 | $tag = 'ASSO'; |
||
113 | break; |
||
114 | case 'AUTHOR': |
||
115 | $tag = 'AUTH'; |
||
116 | break; |
||
117 | case 'BAPTISM': |
||
118 | $tag = 'BAPM'; |
||
119 | break; |
||
120 | case 'BAPTISM_LDS': |
||
121 | $tag = 'BAPL'; |
||
122 | break; |
||
123 | case 'BAR_MITZVAH': |
||
124 | $tag = 'BARM'; |
||
125 | break; |
||
126 | case 'BAS_MITZVAH': |
||
127 | $tag = 'BASM'; |
||
128 | break; |
||
129 | case 'BIRTH': |
||
130 | $tag = 'BIRT'; |
||
131 | break; |
||
132 | case 'BLESSING': |
||
133 | $tag = 'BLES'; |
||
134 | break; |
||
135 | case 'BURIAL': |
||
136 | $tag = 'BURI'; |
||
137 | break; |
||
138 | case 'CALL_NUMBER': |
||
139 | $tag = 'CALN'; |
||
140 | break; |
||
141 | case 'CASTE': |
||
142 | $tag = 'CAST'; |
||
143 | break; |
||
144 | case 'CAUSE': |
||
145 | $tag = 'CAUS'; |
||
146 | break; |
||
147 | case 'CENSUS': |
||
148 | $tag = 'CENS'; |
||
149 | break; |
||
150 | case 'CHANGE': |
||
151 | $tag = 'CHAN'; |
||
152 | break; |
||
153 | case 'CHARACTER': |
||
154 | $tag = 'CHAR'; |
||
155 | break; |
||
156 | case 'CHILD': |
||
157 | $tag = 'CHIL'; |
||
158 | break; |
||
159 | case 'CHILDREN_COUNT': |
||
160 | $tag = 'NCHI'; |
||
161 | break; |
||
162 | case 'CHRISTENING': |
||
163 | $tag = 'CHR'; |
||
164 | break; |
||
165 | case 'CONCATENATION': |
||
166 | $tag = 'CONC'; |
||
167 | break; |
||
168 | case 'CONFIRMATION': |
||
169 | $tag = 'CONF'; |
||
170 | break; |
||
171 | case 'CONFIRMATION_LDS': |
||
172 | $tag = 'CONL'; |
||
173 | break; |
||
174 | case 'CONTINUED': |
||
175 | $tag = 'CONT'; |
||
176 | break; |
||
177 | case 'COPYRIGHT': |
||
178 | $tag = 'COPR'; |
||
179 | break; |
||
180 | case 'CORPORATE': |
||
181 | $tag = 'CORP'; |
||
182 | break; |
||
183 | case 'COUNTRY': |
||
184 | $tag = 'CTRY'; |
||
185 | break; |
||
186 | case 'CREMATION': |
||
187 | $tag = 'CREM'; |
||
188 | break; |
||
189 | case 'DATE': |
||
190 | // Preserve text from INT dates |
||
191 | if (strpos($data, '(') !== false) { |
||
192 | list($date, $text) = explode('(', $data, 2); |
||
193 | $text = ' (' . $text; |
||
194 | } else { |
||
195 | $date = $data; |
||
196 | $text = ''; |
||
197 | } |
||
198 | // Capitals |
||
199 | $date = strtoupper($date); |
||
200 | // Temporarily add leading/trailing spaces, to allow efficient matching below |
||
201 | $date = " {$date} "; |
||
202 | // Ensure space digits and letters |
||
203 | $date = preg_replace('/([A-Z])(\d)/', '$1 $2', $date); |
||
204 | $date = preg_replace('/(\d)([A-Z])/', '$1 $2', $date); |
||
205 | // Ensure space before/after calendar escapes |
||
206 | $date = preg_replace('/@#[^@]+@/', ' $0 ', $date); |
||
207 | // "BET." => "BET" |
||
208 | $date = preg_replace('/(\w\w)\./', '$1', $date); |
||
209 | // "CIR" => "ABT" |
||
210 | $date = str_replace(' CIR ', ' ABT ', $date); |
||
211 | $date = str_replace(' APX ', ' ABT ', $date); |
||
212 | // B.C. => BC (temporarily, to allow easier handling of ".") |
||
213 | $date = str_replace(' B.C. ', ' BC ', $date); |
||
214 | // "BET X - Y " => "BET X AND Y" |
||
215 | $date = preg_replace('/^(.* BET .+) - (.+)/', '$1 AND $2', $date); |
||
216 | $date = preg_replace('/^(.* FROM .+) - (.+)/', '$1 TO $2', $date); |
||
217 | // "@#ESC@ FROM X TO Y" => "FROM @#ESC@ X TO @#ESC@ Y" |
||
218 | $date = preg_replace('/^ +(@#[^@]+@) +FROM +(.+) +TO +(.+)/', ' FROM $1 $2 TO $1 $3', $date); |
||
219 | $date = preg_replace('/^ +(@#[^@]+@) +BET +(.+) +AND +(.+)/', ' BET $1 $2 AND $1 $3', $date); |
||
220 | // "@#ESC@ AFT X" => "AFT @#ESC@ X" |
||
221 | $date = preg_replace('/^ +(@#[^@]+@) +(FROM|BET|TO|AND|BEF|AFT|CAL|EST|INT|ABT) +(.+)/', ' $2 $1 $3', $date); |
||
222 | // Ignore any remaining punctuation, e.g. "14-MAY, 1900" => "14 MAY 1900" |
||
223 | // (don't change "/" - it is used in NS/OS dates) |
||
224 | $date = preg_replace('/[.,:;-]/', ' ', $date); |
||
225 | // BC => B.C. |
||
226 | $date = str_replace(' BC ', ' B.C. ', $date); |
||
227 | // Append the "INT" text |
||
228 | $data = $date . $text; |
||
229 | break; |
||
230 | case 'DEATH': |
||
231 | $tag = 'DEAT'; |
||
232 | break; |
||
233 | case '_DEATH_OF_SPOUSE': |
||
234 | $tag = '_DETS'; |
||
235 | break; |
||
236 | case '_DEGREE': |
||
237 | $tag = '_DEG'; |
||
238 | break; |
||
239 | case 'DESCENDANTS': |
||
240 | $tag = 'DESC'; |
||
241 | break; |
||
242 | case 'DESCENDANT_INT': |
||
243 | $tag = 'DESI'; |
||
244 | break; |
||
245 | case 'DESTINATION': |
||
246 | $tag = 'DEST'; |
||
247 | break; |
||
248 | case 'DIVORCE': |
||
249 | $tag = 'DIV'; |
||
250 | break; |
||
251 | case 'DIVORCE_FILED': |
||
252 | $tag = 'DIVF'; |
||
253 | break; |
||
254 | case 'EDUCATION': |
||
255 | $tag = 'EDUC'; |
||
256 | break; |
||
257 | case 'EMIGRATION': |
||
258 | $tag = 'EMIG'; |
||
259 | break; |
||
260 | case 'ENDOWMENT': |
||
261 | $tag = 'ENDL'; |
||
262 | break; |
||
263 | case 'ENGAGEMENT': |
||
264 | $tag = 'ENGA'; |
||
265 | break; |
||
266 | case 'EVENT': |
||
267 | $tag = 'EVEN'; |
||
268 | break; |
||
269 | case 'FACSIMILE': |
||
270 | $tag = 'FAX'; |
||
271 | break; |
||
272 | case 'FAMILY': |
||
273 | $tag = 'FAM'; |
||
274 | break; |
||
275 | case 'FAMILY_CHILD': |
||
276 | $tag = 'FAMC'; |
||
277 | break; |
||
278 | case 'FAMILY_FILE': |
||
279 | $tag = 'FAMF'; |
||
280 | break; |
||
281 | case 'FAMILY_SPOUSE': |
||
282 | $tag = 'FAMS'; |
||
283 | break; |
||
284 | case 'FIRST_COMMUNION': |
||
285 | $tag = 'FCOM'; |
||
286 | break; |
||
287 | case '_FILE': |
||
288 | $tag = 'FILE'; |
||
289 | break; |
||
290 | case 'FORMAT': |
||
291 | $tag = 'FORM'; |
||
|
|||
292 | case 'FORM': |
||
293 | // Consistent commas |
||
294 | $data = preg_replace('/ *, */', ', ', $data); |
||
295 | break; |
||
296 | case 'GEDCOM': |
||
297 | $tag = 'GEDC'; |
||
298 | break; |
||
299 | case 'GIVEN_NAME': |
||
300 | $tag = 'GIVN'; |
||
301 | break; |
||
302 | case 'GRADUATION': |
||
303 | $tag = 'GRAD'; |
||
304 | break; |
||
305 | case 'HEADER': |
||
306 | $tag = 'HEAD'; |
||
307 | case 'HEAD': |
||
308 | // HEAD records don't have an XREF or DATA |
||
309 | if ($level == '0') { |
||
310 | $xref = ''; |
||
311 | $data = ''; |
||
312 | } |
||
313 | break; |
||
314 | case 'HUSBAND': |
||
315 | $tag = 'HUSB'; |
||
316 | break; |
||
317 | case 'IDENT_NUMBER': |
||
318 | $tag = 'IDNO'; |
||
319 | break; |
||
320 | case 'IMMIGRATION': |
||
321 | $tag = 'IMMI'; |
||
322 | break; |
||
323 | case 'INDIVIDUAL': |
||
324 | $tag = 'INDI'; |
||
325 | break; |
||
326 | case 'LANGUAGE': |
||
327 | $tag = 'LANG'; |
||
328 | break; |
||
329 | case 'LATITUDE': |
||
330 | $tag = 'LATI'; |
||
331 | break; |
||
332 | case 'LONGITUDE': |
||
333 | $tag = 'LONG'; |
||
334 | break; |
||
335 | case 'MARRIAGE': |
||
336 | $tag = 'MARR'; |
||
337 | break; |
||
338 | case 'MARRIAGE_BANN': |
||
339 | $tag = 'MARB'; |
||
340 | break; |
||
341 | case 'MARRIAGE_COUNT': |
||
342 | $tag = 'NMR'; |
||
343 | break; |
||
344 | case 'MARRIAGE_CONTRACT': |
||
345 | $tag = 'MARC'; |
||
346 | break; |
||
347 | case 'MARRIAGE_LICENSE': |
||
348 | $tag = 'MARL'; |
||
349 | break; |
||
350 | case 'MARRIAGE_SETTLEMENT': |
||
351 | $tag = 'MARS'; |
||
352 | break; |
||
353 | case 'MEDIA': |
||
354 | $tag = 'MEDI'; |
||
355 | break; |
||
356 | case '_MEDICAL': |
||
357 | $tag = '_MDCL'; |
||
358 | break; |
||
359 | case '_MILITARY_SERVICE': |
||
360 | $tag = '_MILT'; |
||
361 | break; |
||
362 | case 'NAME': |
||
363 | // Tidy up whitespace |
||
364 | $data = preg_replace('/ +/', ' ', trim($data)); |
||
365 | break; |
||
366 | case 'NAME_PREFIX': |
||
367 | $tag = 'NPFX'; |
||
368 | break; |
||
369 | case 'NAME_SUFFIX': |
||
370 | $tag = 'NSFX'; |
||
371 | break; |
||
372 | case 'NATIONALITY': |
||
373 | $tag = 'NATI'; |
||
374 | break; |
||
375 | case 'NATURALIZATION': |
||
376 | $tag = 'NATU'; |
||
377 | break; |
||
378 | case 'NICKNAME': |
||
379 | $tag = 'NICK'; |
||
380 | break; |
||
381 | case 'OBJECT': |
||
382 | $tag = 'OBJE'; |
||
383 | break; |
||
384 | case 'OCCUPATION': |
||
385 | $tag = 'OCCU'; |
||
386 | break; |
||
387 | case 'ORDINANCE': |
||
388 | $tag = 'ORDI'; |
||
389 | break; |
||
390 | case 'ORDINATION': |
||
391 | $tag = 'ORDN'; |
||
392 | break; |
||
393 | case 'PEDIGREE': |
||
394 | $tag = 'PEDI'; |
||
395 | case 'PEDI': |
||
396 | // PEDI values are lower case |
||
397 | $data = strtolower($data); |
||
398 | break; |
||
399 | case 'PHONE': |
||
400 | $tag = 'PHON'; |
||
401 | break; |
||
402 | case 'PHONETIC': |
||
403 | $tag = 'FONE'; |
||
404 | break; |
||
405 | case 'PHY_DESCRIPTION': |
||
406 | $tag = 'DSCR'; |
||
407 | break; |
||
408 | case 'PLACE': |
||
409 | $tag = 'PLAC'; |
||
410 | case 'PLAC': |
||
411 | // Consistent commas |
||
412 | $data = preg_replace('/ *(،|,) */', ', ', $data); |
||
413 | // The Master Genealogist stores LAT/LONG data in the PLAC field, e.g. Pennsylvania, USA, 395945N0751013W |
||
414 | if (preg_match('/(.*), (\d\d)(\d\d)(\d\d)([NS])(\d\d\d)(\d\d)(\d\d)([EW])$/', $data, $match)) { |
||
415 | $data = |
||
416 | $match[1] . "\n" . |
||
417 | ($level + 1) . " MAP\n" . |
||
418 | ($level + 2) . " LATI " . ($match[5] . (round($match[2] + ($match[3] / 60) + ($match[4] / 3600), 4))) . "\n" . |
||
419 | ($level + 2) . " LONG " . ($match[9] . (round($match[6] + ($match[7] / 60) + ($match[8] / 3600), 4))); |
||
420 | } |
||
421 | break; |
||
422 | case 'POSTAL_CODE': |
||
423 | $tag = 'POST'; |
||
424 | break; |
||
425 | case 'PROBATE': |
||
426 | $tag = 'PROB'; |
||
427 | break; |
||
428 | case 'PROPERTY': |
||
429 | $tag = 'PROP'; |
||
430 | break; |
||
431 | case 'PUBLICATION': |
||
432 | $tag = 'PUBL'; |
||
433 | break; |
||
434 | case 'QUALITY_OF_DATA': |
||
435 | $tag = 'QUAL'; |
||
436 | break; |
||
437 | case 'REC_FILE_NUMBER': |
||
438 | $tag = 'RFN'; |
||
439 | break; |
||
440 | case 'REC_ID_NUMBER': |
||
441 | $tag = 'RIN'; |
||
442 | break; |
||
443 | case 'REFERENCE': |
||
444 | $tag = 'REFN'; |
||
445 | break; |
||
446 | case 'RELATIONSHIP': |
||
447 | $tag = 'RELA'; |
||
448 | break; |
||
449 | case 'RELIGION': |
||
450 | $tag = 'RELI'; |
||
451 | break; |
||
452 | case 'REPOSITORY': |
||
453 | $tag = 'REPO'; |
||
454 | break; |
||
455 | case 'RESIDENCE': |
||
456 | $tag = 'RESI'; |
||
457 | break; |
||
458 | case 'RESTRICTION': |
||
459 | $tag = 'RESN'; |
||
460 | case 'RESN': |
||
461 | // RESN values are lower case (confidential, privacy, locked, none) |
||
462 | $data = strtolower($data); |
||
463 | if ($data == 'invisible') { |
||
464 | $data = 'confidential'; // From old versions of Legacy. |
||
465 | } |
||
466 | break; |
||
467 | case 'RETIREMENT': |
||
468 | $tag = 'RETI'; |
||
469 | break; |
||
470 | case 'ROMANIZED': |
||
471 | $tag = 'ROMN'; |
||
472 | break; |
||
473 | case 'SEALING_CHILD': |
||
474 | $tag = 'SLGC'; |
||
475 | break; |
||
476 | case 'SEALING_SPOUSE': |
||
477 | $tag = 'SLGS'; |
||
478 | break; |
||
479 | case 'SOC_SEC_NUMBER': |
||
480 | $tag = 'SSN'; |
||
481 | break; |
||
482 | case 'SEX': |
||
483 | $data = strtoupper($data); |
||
484 | break; |
||
485 | case 'SOURCE': |
||
486 | $tag = 'SOUR'; |
||
487 | break; |
||
488 | case 'STATE': |
||
489 | $tag = 'STAE'; |
||
490 | break; |
||
491 | case 'STATUS': |
||
492 | $tag = 'STAT'; |
||
493 | case 'STAT': |
||
494 | if ($data == 'CANCELLED') { |
||
495 | // PhpGedView mis-spells this tag - correct it. |
||
496 | $data = 'CANCELED'; |
||
497 | } |
||
498 | break; |
||
499 | case 'SUBMISSION': |
||
500 | $tag = 'SUBN'; |
||
501 | break; |
||
502 | case 'SUBMITTER': |
||
503 | $tag = 'SUBM'; |
||
504 | break; |
||
505 | case 'SURNAME': |
||
506 | $tag = 'SURN'; |
||
507 | break; |
||
508 | case 'SURN_PREFIX': |
||
509 | $tag = 'SPFX'; |
||
510 | break; |
||
511 | case 'TEMPLE': |
||
512 | $tag = 'TEMP'; |
||
513 | case 'TEMP': |
||
514 | // Temple codes are upper case |
||
515 | $data = strtoupper($data); |
||
516 | break; |
||
517 | case 'TITLE': |
||
518 | $tag = 'TITL'; |
||
519 | break; |
||
520 | case 'TRAILER': |
||
521 | $tag = 'TRLR'; |
||
522 | case 'TRLR': |
||
523 | // TRLR records don't have an XREF or DATA |
||
524 | if ($level == '0') { |
||
525 | $xref = ''; |
||
526 | $data = ''; |
||
527 | } |
||
528 | break; |
||
529 | case 'VERSION': |
||
530 | $tag = 'VERS'; |
||
531 | break; |
||
532 | case 'WEB': |
||
533 | $tag = 'WWW'; |
||
534 | break; |
||
535 | } |
||
536 | // Suppress "Y", for facts/events with a DATE or PLAC |
||
537 | if ($data == 'y') { |
||
538 | $data = 'Y'; |
||
539 | } |
||
540 | if ($level == '1' && $data == 'Y') { |
||
541 | for ($i = $n + 1; $i < $num_matches - 1 && $matches[$i][1] != '1'; ++$i) { |
||
542 | if ($matches[$i][3] == 'DATE' || $matches[$i][3] == 'PLAC') { |
||
543 | $data = ''; |
||
544 | break; |
||
545 | } |
||
546 | } |
||
547 | } |
||
548 | // Reassemble components back into a single line |
||
549 | switch ($tag) { |
||
550 | default: |
||
551 | // Remove tabs and multiple/leading/trailing spaces |
||
552 | if (strpos($data, "\t") !== false) { |
||
553 | $data = str_replace("\t", ' ', $data); |
||
554 | } |
||
555 | if (substr($data, 0, 1) == ' ' || substr($data, -1, 1) == ' ') { |
||
556 | $data = trim($data); |
||
557 | } |
||
558 | while (strpos($data, ' ')) { |
||
559 | $data = str_replace(' ', ' ', $data); |
||
560 | } |
||
561 | $newrec .= ($newrec ? "\n" : '') . $level . ' ' . ($level == '0' && $xref ? $xref . ' ' : '') . $tag . ($data === '' && $tag != "NOTE" ? '' : ' ' . $data); |
||
562 | break; |
||
563 | case 'NOTE': |
||
564 | case 'TEXT': |
||
565 | case 'DATA': |
||
566 | case 'CONT': |
||
567 | $newrec .= ($newrec ? "\n" : '') . $level . ' ' . ($level == '0' && $xref ? $xref . ' ' : '') . $tag . ($data === '' && $tag != "NOTE" ? '' : ' ' . $data); |
||
568 | break; |
||
569 | case 'FILE': |
||
570 | // Strip off the user-defined path prefix |
||
571 | $GEDCOM_MEDIA_PATH = $tree->getPreference('GEDCOM_MEDIA_PATH'); |
||
572 | if ($GEDCOM_MEDIA_PATH && strpos($data, $GEDCOM_MEDIA_PATH) === 0) { |
||
573 | $data = substr($data, strlen($GEDCOM_MEDIA_PATH)); |
||
574 | } |
||
575 | // convert backslashes in filenames to forward slashes |
||
576 | $data = preg_replace("/\\\/", "/", $data); |
||
577 | |||
578 | $newrec .= ($newrec ? "\n" : '') . $level . ' ' . ($level == '0' && $xref ? $xref . ' ' : '') . $tag . ($data === '' && $tag != "NOTE" ? '' : ' ' . $data); |
||
579 | break; |
||
580 | case 'CONC': |
||
581 | // Merge CONC lines, to simplify access later on. |
||
582 | $newrec .= ($tree->getPreference('WORD_WRAPPED_NOTES') ? ' ' : '') . $data; |
||
583 | break; |
||
584 | } |
||
585 | } |
||
586 | |||
587 | return $newrec; |
||
588 | } |
||
1167 |