]> git.agnieray.net Git - galette.git/blob - galette/lib/Galette/Features/Replacements.php
Fix serialization issue when Replacements feature is used
[galette.git] / galette / lib / Galette / Features / Replacements.php
1 <?php
2
3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
4
5 /**
6 * Replacements feature
7 *
8 * PHP version 5
9 *
10 * Copyright © 2020-2021 The Galette Team
11 *
12 * This file is part of Galette (http://galette.tuxfamily.org).
13 *
14 * Galette is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
18 *
19 * Galette is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with Galette. If not, see <http://www.gnu.org/licenses/>.
26 *
27 * @category Features
28 * @package Galette
29 *
30 * @author Johan Cwiklinski <johan@x-tnd.be>
31 * @copyright 2020-2021 The Galette Team
32 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
33 * @link http://galette.eu
34 * @since 2020-12-20
35 */
36
37 namespace Galette\Features;
38
39 use Galette\Core\Db;
40 use Galette\Core\Login;
41 use Galette\Core\Logo;
42 use Galette\Core\Preferences;
43 use Galette\DynamicFields\Choice;
44 use Galette\DynamicFields\Separator;
45 use Galette\Entity\Adherent;
46 use Galette\Entity\Contribution;
47 use Galette\Entity\PdfModel;
48 use Galette\Entity\Texts;
49 use Galette\Repository\DynamicFieldsSet;
50 use Galette\DynamicFields\DynamicField;
51 use Analog\Analog;
52 use NumberFormatter;
53 use Slim\Router;
54
55 /**
56 * Replacements feature
57 *
58 * @category Features
59 * @name Replacements
60 * @package Galette
61 * @author Johan Cwiklinski <johan@x-tnd.be>
62 * @copyright 2020-2021 The Galette Team
63 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
64 * @link http://galette.eu
65 * @since 2020-12-20
66 */
67
68 trait Replacements
69 {
70 private $patterns = [];
71 private $replaces = [];
72 private $dynamic_patterns = [];
73
74 /**
75 * @Inject("zdb")
76 * @var Db
77 */
78 protected $zdb;
79
80 /**
81 * @Inject("login")
82 * @var Login
83 */
84 protected $login;
85
86 /**
87 * @Inject("preferences")
88 * @var Preferences
89 */
90 protected $preferences;
91
92 /**
93 * @var Router
94 */
95 protected $router;
96
97 /**
98 * Get dynamic patterns
99 *
100 * @param string $form_name Dynamic form name
101 * @param boolean $legacy Whether to load legacy patterns
102 *
103 * @return array
104 */
105 public function getDynamicPatterns(string $form_name, bool $legacy = true): array
106 {
107 $fields = new DynamicFieldsSet($this->zdb, $this->login);
108 $dynamic_fields = $fields->getList($form_name);
109
110 $dynamic_patterns = [];
111 foreach ($dynamic_fields as $dynamic_field) {
112 //no pattern for separators
113 if ($dynamic_field instanceof Separator) {
114 continue;
115 }
116 $key = strtoupper('DYNFIELD_' . $dynamic_field->getId() . '_' . $form_name);
117 $capabilities = [
118 'LABEL',
119 ''
120 ];
121 if (!($this instanceof Texts) && ($legacy === true || $dynamic_field instanceof Choice)) {
122 $capabilities[] = 'INPUT';
123 }
124 foreach ($capabilities as $capability) {
125 $skey = sprintf('%s_%s', $capability, $key);
126 switch ($capability) {
127 case 'LABEL':
128 $title = _T('Label for dynamic field "%s"');
129 break;
130 case 'INPUT':
131 $title = _T('Form entry for dynamic field "%s"');
132 break;
133 case '':
134 case 'VALUE':
135 $skey = $key;
136 $title = _T('Value for dynamic field "%s"');
137 break;
138 }
139 $dynamic_patterns[strtolower($skey)] = [
140 'title' => sprintf(
141 $title,
142 $dynamic_field->getName()
143 ),
144 'pattern' => sprintf('/{%s}/', $skey)
145 ];
146 }
147 }
148
149 $this->dynamic_patterns[$form_name] = $dynamic_patterns;
150 return $this->dynamic_patterns[$form_name];
151 }
152
153 /**
154 * Set patterns
155 *
156 * @param array $patterns Patterns to add
157 *
158 * @return $this
159 */
160 protected function setPatterns(array $patterns): self
161 {
162 $toset = [];
163 foreach ($patterns as $key => $info) {
164 if (is_array($info)) {
165 $toset[$key] = $info['pattern'];
166 } else {
167 $toset[$key] = $info;
168 }
169 }
170
171 $this->patterns = array_merge(
172 $this->patterns,
173 $toset
174 );
175
176 return $this;
177 }
178
179 /**
180 * Set replacements
181 *
182 * @param array $replaces Replacements to add
183 *
184 * @return void
185 */
186 public function setReplacements(array $replaces): void
187 {
188 $this->replaces = array_merge(
189 $this->replaces,
190 $replaces
191 );
192 }
193
194 /**
195 * Get main patterns
196 *
197 * @return array
198 */
199 protected function getMainPatterns(): array
200 {
201 return [
202 'asso_name' => [
203 'title' => _T('Your organisation name'),
204 'pattern' => '/{ASSO_NAME}/'
205 ],
206 'asso_slogan' => [
207 'title' => _T('Your organisation slogan'),
208 'pattern' => '/{ASSO_SLOGAN}/'
209 ],
210 'asso_address' => [
211 'title' => _T('Your organisation address'),
212 'pattern' => '/{ASSO_ADDRESS}/',
213 ],
214 'asso_address_multi' => [
215 'title' => sprintf('%s (%s)', _T('Your organisation address'), _T('with break lines')),
216 'pattern' => '/{ASSO_ADDRESS_MULTI}/',
217 ],
218 'asso_website' => [
219 'title' => _T('Your organisation website'),
220 'pattern' => '/{ASSO_WEBSITE}/',
221 ],
222 'asso_logo' => [
223 'title' => _T('Your organisation logo'),
224 'pattern' => '/{ASSO_LOGO}/',
225 ],
226 'date_now' => [
227 'title' => _T('Current date (Y-m-d)'),
228 'pattern' => '/{DATE_NOW}/'
229 ],
230 'login_uri' => [
231 'title' => _T("Galette's login URI"),
232 'pattern' => '/{LOGIN_URI}/'
233 ]
234 ];
235 }
236
237 /**
238 * Get patterns for a member
239 *
240 * @param boolean $legacy Whether to load legacy patterns
241 *
242 * @return array
243 */
244 protected function getMemberPatterns(bool $legacy = true): array
245 {
246 $dynamic_patterns = $this->getDynamicPatterns('adh', $legacy);
247 $m_patterns = [
248 'adh_title' => [
249 'title' => _('Title'),
250 'pattern' => '/{TITLE_ADH}/',
251 ],
252 'adh_id' => [
253 'title' => _T("Member's ID"),
254 'pattern' => '/{ID_ADH}/',
255 ],
256 'adh_num' => [
257 'title' => _T("Member number"),
258 'pattern' => '/{NUM_ADH}/',
259 ],
260 'adh_name' => [
261 'title' => _T("Name"),
262 'pattern' => '/{NAME_ADH}/',
263 ],
264 'adh_last_name' => [
265 'title' => _T('Last name'),
266 'pattern' => '/{LAST_NAME_ADH}/',
267 ],
268 'adh_first_name' => [
269 'title' => _T('First name'),
270 'pattern' => '/{FIRST_NAME_ADH}/',
271 ],
272 'adh_nickname' => [
273 'title' => _T('Nickname'),
274 'pattern' => '/{NICKNAME_ADH}/',
275 ],
276 'adh_gender' => [
277 'title' => _T('Gender'),
278 'pattern' => '/{GENDER_ADH}/',
279 ],
280 'adh_birth_date' => [
281 'title' => _T('Birth date'),
282 'pattern' => '/{ADH_BIRTH_DATE}/',
283 ],
284 'adh_birth_place' => [
285 'title' => _T('Birth place'),
286 'pattern' => '/{ADH_BIRTH_PLACE}/',
287 ],
288 'adh_profession' => [
289 'title' => _T('Profession'),
290 'pattern' => '/{PROFESSION_ADH}/',
291 ],
292 'adh_company' => [
293 'title' => _T("Company name"),
294 'pattern' => '/{COMPANY_ADH}/',
295 ],
296 'adh_address' => [
297 'title' => _T("Address"),
298 'pattern' => '/{ADDRESS_ADH}/',
299 ],
300 'adh_zip' => [
301 'title' => _T("Zipcode"),
302 'pattern' => '/{ZIP_ADH}/',
303 ],
304 'adh_town' => [
305 'title' => _T("Town"),
306 'pattern' => '/{TOWN_ADH}/',
307 ],
308 'adh_country' => [
309 'title' => _T('Country'),
310 'pattern' => '/{COUNTRY_ADH}/',
311 ],
312 'adh_phone' => [
313 'title' => _T('Phone'),
314 'pattern' => '/{PHONE_ADH}/',
315 ],
316 'adh_mobile' => [
317 'title' => _T('GSM'),
318 'pattern' => '/{MOBILE_ADH}/',
319 ],
320 'adh_email' => [
321 'title' => _T('Email'),
322 'pattern' => '/{EMAIL_ADH}/',
323 ],
324 'adh_login' => [
325 'title' => _T('Login'),
326 'pattern' => '/{LOGIN_ADH}/',
327 ],
328 'adh_main_group' => [
329 'title' => _T("Member's main group"),
330 'pattern' => '/{GROUP_ADH}/',
331 ],
332 'adh_groups' => [
333 'title' => _T("Member's groups (as list)"),
334 'pattern' => '/{GROUPS_ADH}/'
335 ],
336 'adh_dues' => [
337 'title' => _T('Member state of dues'),
338 'pattern' => '/{ADH_DUES}/'
339 ],
340 'days_remaining' => [
341 'title' => _T('Membership remaining days'),
342 'pattern' => '/{DAYS_REMAINING}/',
343 ],
344 'days_expired' => [
345 'title' => _T('Membership expired since'),
346 'pattern' => '/{DAYS_EXPIRED}/',
347 ]
348 ];
349
350 if ($legacy === true) {
351 $m_patterns += [
352 '_adh_company' => [
353 'title' => _T("Company name"),
354 'pattern' => '/{COMPANY_NAME_ADH}/',
355 ],
356 '_adh_last_name' => [
357 'title' => _T('Last name'),
358 'pattern' => '/{LASTNAME_ADH}/',
359 ],
360 '_adh_first_name' => [
361 'title' => _T('First name'),
362 'pattern' => '/{FIRSTNAME_ADH}/',
363 ],
364 '_adh_login' => [
365 'title' => _T('Login'),
366 'pattern' => '/{LOGIN}/',
367 ],
368 '_adh_email' => [
369 'title' => _T('Email'),
370 'pattern' => '/{MAIL_ADH}/',
371 ],
372 ];
373 }
374
375 return $m_patterns + $dynamic_patterns;
376 }
377
378 /**
379 * Get patterns for a contribution
380 *
381 * @param boolean $legacy Whether to load legacy patterns
382 *
383 * @return array
384 */
385 protected function getContributionPatterns($legacy = true): array
386 {
387 $dynamic_patterns = $this->getDynamicPatterns('contrib', $legacy);
388
389 $c_patterns = [
390 'contrib_label' => [
391 'title' => _T('Contribution label'),
392 'pattern' => '/{CONTRIB_LABEL}/',
393 ],
394 'contrib_amount' => [
395 'title' => _T('Amount'),
396 'pattern' => '/{CONTRIB_AMOUNT}/',
397 ],
398 'contrib_amount_letters' => [
399 'title' => _T('Amount (in letters)'),
400 'pattern' => '/{CONTRIB_AMOUNT_LETTERS}/',
401 ],
402 'contrib_date' => [
403 'title' => _T('Full date'),
404 'pattern' => '/{CONTRIB_DATE}/',
405 ],
406 'contrib_year' => [
407 'title' => _T('Contribution year'),
408 'pattern' => '/{CONTRIB_YEAR}/',
409 ],
410 'contrib_comment' => [
411 'title' => _T('Comment'),
412 'pattern' => '/{CONTRIB_COMMENT}/',
413 ],
414 'contrib_bdate' => [
415 'title' => _T('Begin date'),
416 'pattern' => '/{CONTRIB_BEGIN_DATE}/',
417 ],
418 'contrib_edate' => [
419 'title' => _T('End date'),
420 'pattern' => '/{CONTRIB_END_DATE}/',
421 ],
422 'contrib_id' => [
423 'title' => _T('Contribution id'),
424 'pattern' => '/{CONTRIB_ID}/',
425 ],
426 'contrib_payment' => [
427 'title' => _T('Payment type'),
428 'pattern' => '/{CONTRIB_PAYMENT_TYPE}/'
429 ],
430 'contrib_info' => [
431 'title' => _T('Contribution information'),
432 'pattern' => '/{CONTRIB_INFO}/'
433 ]
434 ];
435
436 if ($legacy === true) {
437 foreach ($c_patterns as $key => $pattern) {
438 $nkey = '_' . $key;
439 $pattern['pattern'] = str_replace(
440 'CONTRIB_',
441 'CONTRIBUTION_',
442 $pattern['pattern']
443 );
444 $c_patterns[$nkey] = $pattern;
445 }
446
447 $c_patterns['__contrib_label'] = [
448 'title' => $c_patterns['contrib_label']['title'],
449 'pattern' => '/{CONTRIB_TYPE}/'
450 ];
451 }
452
453 //handle DEADLINE alias
454 $c_patterns['deadline'] = [
455 'title' => $c_patterns['contrib_edate']['title'],
456 'pattern' => '/{DEADLINE}/'
457 ];
458
459 return $c_patterns + $dynamic_patterns;
460 }
461
462 /**
463 * Set main replacements
464 *
465 * @return $this
466 */
467 public function setMain(): self
468 {
469 $address = $this->preferences->getPostalAddress();
470 $address_multi = preg_replace("/\n/", "<br>", $address);
471
472 $website = '';
473 if ($this->preferences->pref_website !== '') {
474 $website = '<a href="' . $this->preferences->pref_website . '">' .
475 $this->preferences->pref_website . '</a>';
476 }
477
478 $logo = new Logo();
479 $logo_elt = '<img' .
480 ' src="' . $this->preferences->getURL() . $this->router->pathFor('logo') . '"' .
481 ' width="' . $logo->getOptimalWidth() . '"' .
482 ' height="' . $logo->getOptimalHeight() . '"' .
483 '/>';
484
485 $this->setReplacements(
486 array(
487 'asso_name' => $this->preferences->pref_nom,
488 'asso_slogan' => $this->preferences->pref_slogan,
489 'asso_address' => $address,
490 'asso_address_multi' => $address_multi,
491 'asso_website' => $website,
492 'asso_logo' => $logo_elt,
493 'date_now' => date(_T('Y-m-d')),
494 'login_uri' => $this->preferences->getURL() . $this->router->pathFor('login'),
495 )
496 );
497
498 return $this;
499 }
500
501 /**
502 * Set contribution and proceed related replacements
503 *
504 * @return $this
505 */
506 public function setNoContribution(): self
507 {
508 global $login;
509
510 $c_replacements = [
511 'contrib_label' => null,
512 'contrib_amount' => null,
513 'contrib_amount_letters' => null,
514 'contrib_date' => null,
515 'contrib_year' => null,
516 'contrib_comment' => null,
517 'contrib_bdate' => null,
518 'contrib_edate' => null,
519 'contrib_id' => null,
520 'contrib_payment' => null,
521 'contrib_info' => null
522 ];
523
524 foreach ($c_replacements as $key => $replacement) {
525 $nkey = '_' . $key;
526 $c_replacements[$nkey] = $replacement;
527 }
528 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
529
530 //handle DEADLINE alias
531 $c_replacements['deadline'] = null;
532
533 $this->setReplacements($c_replacements);
534
535 /** the list of all dynamic fields */
536 $fields = new DynamicFieldsSet($this->zdb, $login);
537 $dynamic_fields = $fields->getList('contrib');
538 $this->setDynamicFields('contrib', $dynamic_fields, null);
539
540 return $this;
541 }
542
543 /**
544 * Set contribution and proceed related replacements
545 *
546 * @param Contribution $contrib Contribution
547 *
548 * @return PdfModel
549 */
550 public function setContribution(Contribution $contrib): self
551 {
552 global $login, $i18n;
553
554 $formatter = new NumberFormatter($i18n->getID(), NumberFormatter::SPELLOUT);
555
556 $c_replacements = [
557 'contrib_label' => $contrib->type->libelle,
558 'contrib_amount' => $contrib->amount,
559 'contrib_amount_letters' => $formatter->format($contrib->amount),
560 'contrib_date' => $contrib->date,
561 'contrib_year' => $contrib->raw_date->format('Y'),
562 'contrib_comment' => $contrib->info,
563 'contrib_bdate' => $contrib->begin_date,
564 'contrib_edate' => $contrib->end_date,
565 'contrib_id' => $contrib->id,
566 'contrib_payment' => $contrib->spayment_type,
567 'contrib_info' => $contrib->info
568 ];
569
570 foreach ($c_replacements as $key => $replacement) {
571 $nkey = '_' . $key;
572 $c_replacements[$nkey] = $replacement;
573 }
574 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
575
576 //handle DEADLINE alias
577 $c_replacements['deadline'] = $c_replacements['contrib_edate'];
578
579 $this->setReplacements($c_replacements);
580
581 /** the list of all dynamic fields */
582 $fields = new DynamicFieldsSet($this->zdb, $login);
583 $dynamic_fields = $fields->getList('contrib');
584 $this->setDynamicFields('contrib', $dynamic_fields, $contrib);
585
586 return $this;
587 }
588
589 /**
590 * Set member and proceed related replacements
591 *
592 * @param Adherent $member Member
593 *
594 * @return PdfModel
595 */
596 public function setMember(Adherent $member): self
597 {
598 global $login;
599
600 $address = $member->getAddress();
601 if ($member->getAddressContinuation() !== '') {
602 $address .= '<br/>' . $member->getAddressContinuation();
603 }
604
605 if ($member->isMan()) {
606 $gender = _T("Man");
607 } elseif ($member->isWoman()) {
608 $gender = _T("Woman");
609 } else {
610 $gender = _T("Unspecified");
611 }
612
613 $member_groups = $member->groups;
614 $main_group = _T("None");
615 $group_list = _T("None");
616 if (is_array($member_groups) && count($member_groups) > 0) {
617 $main_group = $member_groups[0]->getName();
618 $group_list = '<ul>';
619 foreach ($member_groups as $group) {
620 $group_list .= '<li>' . $group->getName() . '</li>';
621 }
622 $group_list .= '</ul>';
623 }
624
625 $this->setReplacements(
626 array(
627 'adh_title' => $member->stitle,
628 'adh_id' => $member->id,
629 'adh_num' => $member->number,
630 'adh_name' => $member->sfullname,
631 'adh_last_name' => $member->name,
632 'adh_first_name' => $member->surname,
633 'adh_nickname' => $member->nickname,
634 'adh_gender' => $gender,
635 'adh_birth_date' => $member->birthdate,
636 'adh_birth_place' => $member->birth_place,
637 'adh_profession' => $member->job,
638 'adh_company' => $member->company_name,
639 'adh_address' => $address,
640 'adh_zip' => $member->getZipcode(),
641 'adh_town' => $member->getTown(),
642 'adh_country' => $member->getCountry(),
643 'adh_phone' => $member->phone,
644 'adh_mobile' => $member->gsm,
645 //always take current member email, to be sure.
646 'adh_email' => $member->email,
647 'adh_login' => $member->login,
648 'adh_main_group' => $main_group,
649 'adh_groups' => $group_list,
650 'adh_dues' => $member->getDues(),
651 'days_remaining' => $member->days_remaining,
652 'days_expired' => ($member->days_remaining * -1),
653 //Handle COMPANY_NAME_ADH... https://bugs.galette.eu/issues/1530
654 '_adh_company' => $member->company_name,
655 //Handle old names for variables ... https://bugs.galette.eu/issues/1393
656 '_adh_last_name' => $member->name,
657 '_adh_first_name' => $member->surname,
658 '_adh_login' => $member->login,
659 '_adh_email' => $member->email
660 )
661 );
662
663 /** the list of all dynamic fields */
664 $fields = new DynamicFieldsSet($this->zdb, $login);
665 $dynamic_fields = $fields->getList('adh');
666 $this->setDynamicFields('adh', $dynamic_fields, $member);
667
668 return $this;
669 }
670
671 /**
672 * Set dynamic fields and proceed related replacements
673 *
674 * @param string $form_name Form name
675 * @param array $dynamic_fields Dynamic fields
676 * @param mixed $object Related object (Adherent, Contribution, ...)
677 *
678 * @return PdfModel
679 */
680 public function setDynamicFields(string $form_name, array $dynamic_fields, $object): self
681 {
682 $uform_name = strtoupper($form_name);
683
684 $dynamic_patterns = $this->getDynamicPatterns($form_name);
685 foreach ($dynamic_patterns as $dynamic_pattern) {
686 $pattern = trim($dynamic_pattern['pattern'], '/');
687 $key = strtolower(rtrim(ltrim($pattern, '{'), '}'));
688 $value = '';
689
690 if (preg_match("/^{LABEL_DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
691 /** dynamic field label */
692 $field_id = $match[1];
693 $value = $dynamic_fields[$field_id]->getName();
694 }
695 if (preg_match("/^{(INPUT_|VALUE_)?DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
696 /** dynamic field value */
697 $capacity = trim($match[1], '_');
698 $field_id = $match[2];
699 $field_name = $dynamic_fields[$field_id]->getName();
700 $field_type = $dynamic_fields[$field_id]->getType();
701 $field_values = [];
702 if ($object !== null) {
703 $all_values = $object->getDynamicFields()->getValues($field_id);
704 foreach ($all_values as $field_value) {
705 $field_values[$field_value['field_val']] = $field_value['text_val'] ?? $field_value['field_val'];
706 }
707 } else {
708 $field_values = [];
709 }
710
711 switch ($field_type) {
712 case DynamicField::CHOICE:
713 $choice_values = $dynamic_fields[$field_id]->getValues();
714 if ($capacity == 'INPUT') {
715 foreach ($choice_values as $choice_idx => $choice_value) {
716 $value .= '<input type="radio" class="box" name="' . $field_name . '" value="' . $field_id . '"';
717 if (isset($field_values[$choice_idx])) {
718 $value .= ' checked="checked"';
719 }
720 $value .= ' disabled="disabled">' . $choice_value . '&nbsp;';
721 }
722 } else {
723 foreach ($field_values as $field_value) {
724 $value .= $field_value;
725 }
726 }
727 break;
728 case DynamicField::BOOLEAN:
729 foreach ($field_values as $field_value) {
730 $value .= ($field_value ? _T("Yes") : _T("No"));
731 }
732 break;
733 case DynamicField::FILE:
734 $pos = 0;
735 foreach ($field_values as $field_value) {
736 if (empty($field_value)) {
737 continue;
738 }
739 $spattern = (($this instanceof Texts) ?
740 '%3$s (%1$s%2$s)' :
741 '<a href="%1$s%2$s">%3$s</a>'
742 );
743 $value .= sprintf(
744 $spattern,
745 $this->preferences->getURL(),
746 $this->router->pathFor(
747 'getDynamicFile',
748 [
749 'id' => $object->id,
750 'fid' => $field_id,
751 'pos' => ++$pos,
752 'name' => $field_value
753 ]
754 ),
755 $field_value
756 );
757 }
758 break;
759 case DynamicField::TEXT:
760 case DynamicField::LINE:
761 case DynamicField::DATE:
762 $value .= implode('<br/>', $field_values);
763 break;
764 }
765 }
766
767 $this->setReplacements(array($key => $value));
768 Analog::log("adding dynamic replacement $key => $value", Analog::DEBUG);
769 }
770
771 return $this;
772 }
773
774 /**
775 * Build legend array
776 *
777 * @return array
778 */
779 public function getLegend(): array
780 {
781 $legend = [];
782
783 $legend['main'] = [
784 'title' => _T('Main information'),
785 'patterns' => $this->getMainPatterns()
786 ];
787
788 $legend['member'] = [
789 'title' => _T('Member information'),
790 'patterns' => $this->getMemberPatterns(false)
791 ];
792
793 return $legend;
794 }
795
796 /**
797 * Get configured replacements
798 *
799 * @return array
800 */
801 public function getReplacements(): array
802 {
803 return $this->replaces;
804 }
805
806 /**
807 * Set Db dependency
808 *
809 * @param Db $db Db instance
810 *
811 * @return $this
812 */
813 public function setDb(Db $db): self
814 {
815 $this->zdb = $db;
816 return $this;
817 }
818
819 /**
820 * Set Login dependency
821 *
822 * @param Login $login Login instance
823 *
824 * @return $this
825 */
826 public function setLogin(Login $login): self
827 {
828 $this->login = $login;
829 return $this;
830 }
831
832 /**
833 * Set Preferences dependency
834 *
835 * @param Preferences $preferences Preferences instance
836 *
837 * @return $this
838 */
839 public function setPreferences(Preferences $preferences): self
840 {
841 $this->preferences = $preferences;
842 return $this;
843 }
844
845 /**
846 * Set Router dependency
847 *
848 * @param Router $router Router instance
849 *
850 * @return $this
851 */
852 public function setRouter(Router $router): self
853 {
854 $this->router = $router;
855 return $this;
856 }
857
858 /**
859 * Proceed replacement on given entry
860 *
861 * @param string $source Source string
862 *
863 * @return string
864 */
865 protected function proceedReplacements(string $source): string
866 {
867 $replaced = $source;
868
869 //handle translations
870 $callback = static function ($matches) {
871 return _T($matches[1]);
872 };
873 $replaced = preg_replace_callback(
874 '/_T\("([^\"]+)"\)/',
875 $callback,
876 $source
877 );
878
879 //order matters
880 ksort($this->patterns, SORT_NATURAL);
881 ksort($this->replaces, SORT_NATURAL);
882
883 if (array_keys($this->patterns) !== array_keys($this->replaces)) {
884 throw new \RuntimeException('Patterns and replacements does not match!');
885 }
886
887 //handle replacements
888 $replaced = preg_replace(
889 $this->patterns,
890 $this->replaces,
891 $replaced
892 );
893
894 //handle translations with replacements
895 $repl_callback = static function ($matches) {
896 return str_replace(
897 $matches[1],
898 $matches[2],
899 $matches[3]
900 );
901 };
902 $replaced = preg_replace_callback(
903 '/str_replace\(\'([^,]+)\', ?\'([^,]+)\', ?\'(.*)\'\)/',
904 $repl_callback,
905 $replaced
906 );
907
908 return $replaced;
909 }
910
911 /**
912 * Get patterns
913 *
914 * @return array
915 */
916 public function getPatterns(): array
917 {
918 return $this->patterns;
919 }
920 }