3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
10 * Copyright © 2020-2021 The Galette Team
12 * This file is part of Galette (http://galette.tuxfamily.org).
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.
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.
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/>.
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
37 namespace Galette\Features
;
40 use Galette\Core\Login
;
41 use Galette\Core\Logo
;
42 use Galette\Core\Preferences
;
43 use Galette\DynamicFields\Choice
;
44 use Galette\Entity\Adherent
;
45 use Galette\Entity\Contribution
;
46 use Galette\Entity\PdfModel
;
47 use Galette\Repository\DynamicFieldsSet
;
48 use Galette\DynamicFields\DynamicField
;
54 * Replacements feature
59 * @author Johan Cwiklinski <johan@x-tnd.be>
60 * @copyright 2020-2021 The Galette Team
61 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
62 * @link http://galette.eu
68 private $patterns = [];
69 private $replaces = [];
70 private $dynamic_patterns = [];
85 * @Inject("preferences")
88 protected $preferences;
97 * Get dynamic patterns
99 * @param string $form_name Dynamic form name
100 * @param boolean $legacy Whether to load legacy patterns
104 public function getDynamicPatterns(string $form_name, bool $legacy = true): array
106 $fields = new DynamicFieldsSet($this->zdb
, $this->login
);
107 $dynamic_fields = $fields->getList($form_name);
109 $dynamic_patterns = [];
110 foreach ($dynamic_fields as $dynamic_field) {
111 $key = strtoupper('DYNFIELD_' . $dynamic_field->getId() . '_' . $form_name);
116 if ($legacy === true ||
$dynamic_field instanceof Choice
) {
117 $capabilities[] = 'INPUT';
119 foreach ($capabilities as $capability) {
120 $skey = sprintf('%s_%s', $capability, $key);
121 switch ($capability) {
123 $title = _T('Label for dynamic field "%s"');
126 $title = _T('Form entry for dynamic field "%s"');
131 $title = _T('Value for dynamic field "%s"');
134 $dynamic_patterns[strtolower($skey)] = [
137 $dynamic_field->getName()
139 'pattern' => sprintf('/{%s}/', $skey)
144 $this->dynamic_patterns
[$form_name] = $dynamic_patterns;
145 return $this->dynamic_patterns
[$form_name];
151 * @param array $patterns Patterns to add
155 protected function setPatterns(array $patterns): self
158 foreach ($patterns as $key => $info) {
159 if (is_array($info)) {
160 $toset[$key] = $info['pattern'];
162 $toset[$key] = $info;
166 $this->patterns
= array_merge(
177 * @param array $replaces Replacements to add
181 public function setReplacements(array $replaces): void
183 $this->replaces
= array_merge(
194 protected function getMainPatterns(): array
198 'title' => _T('Your organisation name'),
199 'pattern' => '/{ASSO_NAME}/'
202 'title' => _T('Your organisation slogan'),
203 'pattern' => '/{ASSO_SLOGAN}/'
206 'title' => _T('Your organisation address'),
207 'pattern' => '/{ASSO_ADDRESS}/',
209 'asso_address_multi' => [
210 'title' => sprintf('%s (%s)', _T('Your organisation address'), _T('with break lines')),
211 'pattern' => '/{ASSO_ADDRESS_MULTI}/',
214 'title' => _T('Your organisation website'),
215 'pattern' => '/{ASSO_WEBSITE}/',
218 'title' => _T('Your organisation logo'),
219 'pattern' => '/{ASSO_LOGO}/',
222 'title' => _T('Current date (Y-m-d)'),
223 'pattern' => '/{DATE_NOW}/'
226 'title' => _T("Galette's login URI"),
227 'pattern' => '/{LOGIN_URI}/'
233 * Get patterns for a member
235 * @param boolean $legacy Whether to load legacy patterns
239 protected function getMemberPatterns(bool $legacy = true): array
241 $dynamic_patterns = $this->getDynamicPatterns('adh', $legacy);
244 'title' => _('Title'),
245 'pattern' => '/{TITLE_ADH}/',
248 'title' => _T("Member's ID"),
249 'pattern' => '/{ID_ADH}/',
252 'title' => _T("Name"),
253 'pattern' => '/{NAME_ADH}/',
256 'title' => _T('Last name'),
257 'pattern' => '/{LAST_NAME_ADH}/',
259 'adh_first_name' => [
260 'title' => _T('First name'),
261 'pattern' => '/{FIRST_NAME_ADH}/',
264 'title' => _T('Nickname'),
265 'pattern' => '/{NICKNAME_ADH}/',
268 'title' => _T('Gender'),
269 'pattern' => '/{GENDER_ADH}/',
271 'adh_birth_date' => [
272 'title' => _T('Birth date'),
273 'pattern' => '/{ADH_BIRTH_DATE}/',
275 'adh_birth_place' => [
276 'title' => _T('Birth place'),
277 'pattern' => '/{ADH_BIRTH_PLACE}/',
279 'adh_profession' => [
280 'title' => _T('Profession'),
281 'pattern' => '/{PROFESSION_ADH}/',
284 'title' => _T("Company name"),
285 'pattern' => '/{COMPANY_ADH}/',
288 'title' => _T("Address"),
289 'pattern' => '/{ADDRESS_ADH}/',
292 'title' => _T("Zipcode"),
293 'pattern' => '/{ZIP_ADH}/',
296 'title' => _T("Town"),
297 'pattern' => '/{TOWN_ADH}/',
300 'title' => _T('Country'),
301 'pattern' => '/{COUNTRY_ADH}/',
304 'title' => _T('Phone'),
305 'pattern' => '/{PHONE_ADH}/',
308 'title' => _T('GSM'),
309 'pattern' => '/{MOBILE_ADH}/',
312 'title' => _T('Email'),
313 'pattern' => '/{EMAIL_ADH}/',
316 'title' => _T('Login'),
317 'pattern' => '/{LOGIN_ADH}/',
319 'adh_main_group' => [
320 'title' => _T("Member's main group"),
321 'pattern' => '/{GROUP_ADH}/',
324 'title' => _T("Member's groups (as list)"),
325 'pattern' => '/{GROUPS_ADH}/'
328 'title' => _T('Member state of dues'),
329 'pattern' => '/{ADH_DUES}/'
331 'days_remaining' => [
332 'title' => _T('Membership remaining days'),
333 'pattern' => '/{DAYS_REMAINING}/',
336 'title' => _T('Membership expired since'),
337 'pattern' => '/{DAYS_EXPIRED}/',
341 if ($legacy === true) {
344 'title' => _T("Company name"),
345 'pattern' => '/{COMPANY_NAME_ADH}/',
347 '_adh_last_name' => [
348 'title' => _T('Last name'),
349 'pattern' => '/{LASTNAME_ADH}/',
351 '_adh_first_name' => [
352 'title' => _T('First name'),
353 'pattern' => '/{FIRSTNAME_ADH}/',
356 'title' => _T('Login'),
357 'pattern' => '/{LOGIN}/',
360 'title' => _T('Email'),
361 'pattern' => '/{MAIL_ADH}/',
366 return $m_patterns +
$dynamic_patterns;
370 * Get patterns for a contribution
372 * @param boolean $legacy Whether to load legacy patterns
376 protected function getContributionPatterns($legacy = true): array
378 $dynamic_patterns = $this->getDynamicPatterns('contrib', $legacy);
382 'title' => _T('Contribution label'),
383 'pattern' => '/{CONTRIB_LABEL}/',
385 'contrib_amount' => [
386 'title' => _T('Amount'),
387 'pattern' => '/{CONTRIB_AMOUNT}/',
389 'contrib_amount_letters' => [
390 'title' => _T('Amount (in letters)'),
391 'pattern' => '/{CONTRIB_AMOUNT_LETTERS}/',
394 'title' => _T('Full date'),
395 'pattern' => '/{CONTRIB_DATE}/',
398 'title' => _T('Contribution year'),
399 'pattern' => '/{CONTRIB_YEAR}/',
401 'contrib_comment' => [
402 'title' => _T('Comment'),
403 'pattern' => '/{CONTRIB_COMMENT}/',
406 'title' => _T('Begin date'),
407 'pattern' => '/{CONTRIB_BEGIN_DATE}/',
410 'title' => _T('End date'),
411 'pattern' => '/{CONTRIB_END_DATE}/',
414 'title' => _T('Contribution id'),
415 'pattern' => '/{CONTRIB_ID}/',
417 'contrib_payment' => [
418 'title' => _T('Payment type'),
419 'pattern' => '/{CONTRIB_PAYMENT_TYPE}/'
422 'title' => _T('Contribution information'),
423 'pattern' => '/{CONTRIB_INFO}/'
427 if ($legacy === true) {
428 foreach ($c_patterns as $key => $pattern) {
430 $pattern['pattern'] = str_replace(
435 $c_patterns[$nkey] = $pattern;
438 $c_patterns['__contrib_label'] = [
439 'title' => $c_patterns['contrib_label'],
440 'pattern' => '/{CONTRIB_TYPE}/'
444 //handle DEADLINE alias
446 return $c_patterns +
$dynamic_patterns;
450 * Set main replacements
454 public function setMain(): self
456 $address = $this->preferences
->getPostalAddress();
457 $address_multi = preg_replace("/\n/", "<br>", $address);
460 if ($this->preferences
->pref_website
!== '') {
461 $website = '<a href="' . $this->preferences
->pref_website
. '">' .
462 $this->preferences
->pref_website
. '</a>';
467 ' src="' . $this->preferences
->getURL() . $this->router
->pathFor('logo') . '"' .
468 ' width="' . $logo->getOptimalWidth() . '"' .
469 ' height="' . $logo->getOptimalHeight() . '"' .
472 $this->setReplacements(
474 'asso_name' => $this->preferences
->pref_nom
,
475 'asso_slogan' => $this->preferences
->pref_slogan
,
476 'asso_address' => $address,
477 'asso_address_multi' => $address_multi,
478 'asso_website' => $website,
479 'asso_logo' => $logo_elt,
480 'date_now' => date(_T('Y-m-d')),
481 'login_uri' => $this->preferences
->getURL() . $this->router
->pathFor('login'),
489 * Set contribution and proceed related replacements
493 public function setNoContribution(): self
498 'contrib_label' => null,
499 'contrib_amount' => null,
500 'contrib_amount_letters' => null,
501 'contrib_date' => null,
502 'contrib_year' => null,
503 'contrib_comment' => null,
504 'contrib_bdate' => null,
505 'contrib_edate' => null,
506 'contrib_id' => null,
507 'contrib_payment' => null,
508 'contrib_info' => null
511 foreach ($c_replacements as $key => $replacement) {
513 $c_replacements[$nkey] = $replacement;
515 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
517 //handle DEADLINE alias
519 $this->setReplacements($c_replacements);
521 /** the list of all dynamic fields */
522 $fields = new DynamicFieldsSet($this->zdb
, $login);
523 $dynamic_fields = $fields->getList('contrib');
524 $this->setDynamicFields('contrib', $dynamic_fields, null);
530 * Set contribution and proceed related replacements
532 * @param Contribution $contrib Contribution
536 public function setContribution(Contribution
$contrib): self
538 global $login, $i18n;
540 $formatter = new NumberFormatter($i18n->getID(), NumberFormatter
::SPELLOUT
);
543 'contrib_label' => $contrib->type
->libelle
,
544 'contrib_amount' => $contrib->amount
,
545 'contrib_amount_letters' => $formatter->format($contrib->amount
),
546 'contrib_date' => $contrib->date
,
547 'contrib_year' => $contrib->raw_date
->format('Y'),
548 'contrib_comment' => $contrib->info
,
549 'contrib_bdate' => $contrib->begin_date
,
550 'contrib_edate' => $contrib->end_date
,
551 'contrib_id' => $contrib->id
,
552 'contrib_payment' => $contrib->spayment_type
,
553 'contrib_info' => $contrib->info
556 foreach ($c_replacements as $key => $replacement) {
558 $c_replacements[$nkey] = $replacement;
560 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
562 //handle DEADLINE alias
564 $this->setReplacements($c_replacements);
566 /** the list of all dynamic fields */
567 $fields = new DynamicFieldsSet($this->zdb
, $login);
568 $dynamic_fields = $fields->getList('contrib');
569 $this->setDynamicFields('contrib', $dynamic_fields, $contrib);
575 * Set member and proceed related replacements
577 * @param Adherent $member Member
581 public function setMember(Adherent
$member): self
585 $address = $member->address
;
586 if ($member->address_continuation
!== '') {
587 $address .= '<br/>' . $member->address_continuation
;
590 if ($member->isMan()) {
592 } elseif ($member->isWoman()) {
593 $gender = _T("Woman");
595 $gender = _T("Unspecified");
598 $member_groups = $member->groups
;
599 $main_group = _T("None");
600 $group_list = _T("None");
601 if (is_array($member_groups) && count($member_groups) > 0) {
602 $main_group = $member_groups[0]->getName();
603 $group_list = '<ul>';
604 foreach ($member_groups as $group) {
605 $group_list .= '<li>' . $group->getName() . '</li>';
607 $group_list .= '</ul>';
610 $this->setReplacements(
612 'adh_title' => $member->stitle
,
613 'adh_id' => $member->id
,
614 'adh_name' => $member->sfullname
,
615 'adh_last_name' => $member->name
,
616 'adh_first_name' => $member->surname
,
617 'adh_nickname' => $member->nickname
,
618 'adh_gender' => $gender,
619 'adh_birth_date' => $member->birthdate
,
620 'adh_birth_place' => $member->birth_place
,
621 'adh_profession' => $member->job
,
622 'adh_company' => $member->company_name
,
623 'adh_address' => $address,
624 'adh_zip' => $member->zipcode
,
625 'adh_town' => $member->town
,
626 'adh_country' => $member->country
,
627 'adh_phone' => $member->phone
,
628 'adh_mobile' => $member->gsm
,
629 'adh_email' => $member->email
,
630 'adh_login' => $member->login
,
631 'adh_main_group' => $main_group,
632 'adh_groups' => $group_list,
633 'adh_dues' => $member->getDues(),
634 'days_remaining' => $member->days_remaining
,
635 'days_expired' => ($member->days_remaining
* -1),
636 //Handle COMPANY_NAME_ADH... https://bugs.galette.eu/issues/1530
637 '_adh_company' => $member->company_name
,
638 //Handle old names for variables ... https://bugs.galette.eu/issues/1393
639 '_adh_last_name' => $member->name
,
640 '_adh_first_name' => $member->surname
,
641 '_adh_login' => $member->login
,
642 '_adh_email' => $member->email
646 /** the list of all dynamic fields */
647 $fields = new DynamicFieldsSet($this->zdb
, $login);
648 $dynamic_fields = $fields->getList('adh');
649 $this->setDynamicFields('adh', $dynamic_fields, $member);
655 * Set dynamic fields and proceed related replacements
657 * @param string $form_name Form name
658 * @param array $dynamic_fields Dynamic fields
659 * @param mixed $object Related object (Adherent, Contribution, ...)
663 public function setDynamicFields(string $form_name, array $dynamic_fields, $object): self
665 $uform_name = strtoupper($form_name);
667 $dynamic_patterns = $this->getDynamicPatterns($form_name);
668 foreach ($dynamic_patterns as $dynamic_pattern) {
669 $pattern = trim($dynamic_pattern['pattern'], '/');
670 $key = strtolower(rtrim(ltrim($pattern, '{'), '}'));
673 if (preg_match("/^{LABEL_DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
674 /** dynamic field label */
675 $field_id = $match[1];
676 $value = $dynamic_fields[$field_id]->getName();
678 if (preg_match("/^{(INPUT_|VALUE_)?DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
679 /** dynamic field value */
680 $capacity = trim($match[1], '_');
681 $field_id = $match[2];
682 $field_name = $dynamic_fields[$field_id]->getName();
683 $field_type = $dynamic_fields[$field_id]->getType();
685 if ($object !== null) {
686 $all_values = $object->getDynamicFields()->getValues($field_id);
687 foreach ($all_values as $field_value) {
688 $field_values[$field_value['field_val']] = $field_value['text_val'] ??
$field_value['field_val'];
694 switch ($field_type) {
695 case DynamicField
::CHOICE
:
696 if ($capacity == 'INPUT') {
697 $choice_values = $dynamic_fields[$field_id]->getValues();
698 foreach ($choice_values as $choice_idx => $choice_value) {
699 $value .= '<input type="radio" class="box" name="' . $field_name . '" value="' . $field_id . '"';
700 if (isset($field_values[$choice_idx])) {
701 $value .= ' checked="checked"';
703 $value .= ' disabled="disabled">' . $choice_value . ' ';
706 $value .= implode(' ', $field_values);
709 case DynamicField
::FILE
:
711 case DynamicField
::TEXT
:
712 case DynamicField
::LINE
:
713 case DynamicField
::DATE
:
714 //TODO: ensure display
715 case DynamicField
::BOOLEAN
:
716 //TODO: ensure display
717 $value .= implode('<br/>', $field_values);
722 $this->setReplacements(array($key => $value));
723 Analog
::log("adding dynamic replacement $key => $value", Analog
::DEBUG
);
734 public function getLegend(): array
739 'title' => _T('Main information'),
740 'patterns' => $this->getMainPatterns()
743 $legend['member'] = [
744 'title' => _T('Member information'),
745 'patterns' => $this->getMemberPatterns(false)
752 * Get configured replacements
756 public function getReplacements(): array
758 return $this->replaces
;
764 * @param Db $db Db instance
768 public function setDb(Db
$db): self
775 * Set Login dependency
777 * @param Login $login Login instance
781 public function setLogin(Login
$login): self
783 $this->login
= $login;
788 * Set Preferences dependency
790 * @param Preferences $preferences Preferences instance
794 public function setPreferences(Preferences
$preferences): self
796 $this->preferences
= $preferences;
801 * Set Router dependency
803 * @param Router $router Router instance
807 public function setRouter(Router
$router): self
809 $this->router
= $router;
814 * Proceed replacement on given entry
816 * @param string $source Source string
820 protected function proceedReplacements(string $source): string
824 //handle translations
825 $callback = static function ($matches) {
826 return _T($matches[1]);
828 $replaced = preg_replace_callback(
829 '/_T\("([^\"]+)"\)/',
835 ksort($this->patterns
, SORT_NATURAL
);
836 ksort($this->replaces
, SORT_NATURAL
);
838 if (array_keys($this->patterns
) !== array_keys($this->replaces
)) {
839 throw new \
RuntimeException('Patterns and replacements does not match!');
842 //handle replacements
843 $replaced = preg_replace(
849 //handle translations with replacements
850 $repl_callback = static function ($matches) {
857 $replaced = preg_replace_callback(
858 '/str_replace\(\'([^,]+)\', ?\'([^,]+)\', ?\'(.*)\'\)/',
871 public function getPatterns(): array
873 return $this->patterns
;