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