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\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
;
56 * Replacements feature
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
70 private $patterns = [];
71 private $replaces = [];
72 private $dynamic_patterns = [];
87 * @Inject("preferences")
90 protected $preferences;
98 * Get dynamic patterns
100 * @param string $form_name Dynamic form name
101 * @param boolean $legacy Whether to load legacy patterns
105 public function getDynamicPatterns(string $form_name, bool $legacy = true): array
107 $fields = new DynamicFieldsSet($this->zdb
, $this->login
);
108 $dynamic_fields = $fields->getList($form_name);
110 $dynamic_patterns = [];
111 foreach ($dynamic_fields as $dynamic_field) {
112 //no pattern for separators
113 if ($dynamic_field instanceof Separator
) {
116 $key = strtoupper('DYNFIELD_' . $dynamic_field->getId() . '_' . $form_name);
121 if (!($this instanceof Texts
) && ($legacy === true ||
$dynamic_field instanceof Choice
)) {
122 $capabilities[] = 'INPUT';
124 foreach ($capabilities as $capability) {
125 $skey = sprintf('%s_%s', $capability, $key);
126 switch ($capability) {
128 $title = _T('Label for dynamic field "%s"');
131 $title = _T('Form entry for dynamic field "%s"');
136 $title = _T('Value for dynamic field "%s"');
139 $dynamic_patterns[strtolower($skey)] = [
142 $dynamic_field->getName()
144 'pattern' => sprintf('/{%s}/', $skey)
149 $this->dynamic_patterns
[$form_name] = $dynamic_patterns;
150 return $this->dynamic_patterns
[$form_name];
156 * @param array $patterns Patterns to add
160 protected function setPatterns(array $patterns): self
163 foreach ($patterns as $key => $info) {
164 if (is_array($info)) {
165 $toset[$key] = $info['pattern'];
167 $toset[$key] = $info;
171 $this->patterns
= array_merge(
182 * @param array $replaces Replacements to add
186 public function setReplacements(array $replaces): void
188 $this->replaces
= array_merge(
199 protected function getMainPatterns(): array
203 'title' => _T('Your organisation name'),
204 'pattern' => '/{ASSO_NAME}/'
207 'title' => _T('Your organisation slogan'),
208 'pattern' => '/{ASSO_SLOGAN}/'
211 'title' => _T('Your organisation address'),
212 'pattern' => '/{ASSO_ADDRESS}/',
214 'asso_address_multi' => [
215 'title' => sprintf('%s (%s)', _T('Your organisation address'), _T('with break lines')),
216 'pattern' => '/{ASSO_ADDRESS_MULTI}/',
219 'title' => _T('Your organisation website'),
220 'pattern' => '/{ASSO_WEBSITE}/',
223 'title' => _T('Your organisation logo'),
224 'pattern' => '/{ASSO_LOGO}/',
227 'title' => _T('Current date (Y-m-d)'),
228 'pattern' => '/{DATE_NOW}/'
231 'title' => _T("Galette's login URI"),
232 'pattern' => '/{LOGIN_URI}/'
238 * Get patterns for a member
240 * @param boolean $legacy Whether to load legacy patterns
244 protected function getMemberPatterns(bool $legacy = true): array
246 $dynamic_patterns = $this->getDynamicPatterns('adh', $legacy);
249 'title' => _('Title'),
250 'pattern' => '/{TITLE_ADH}/',
253 'title' => _T("Member's ID"),
254 'pattern' => '/{ID_ADH}/',
257 'title' => _T("Member number"),
258 'pattern' => '/{NUM_ADH}/',
261 'title' => _T("Name"),
262 'pattern' => '/{NAME_ADH}/',
265 'title' => _T('Last name'),
266 'pattern' => '/{LAST_NAME_ADH}/',
268 'adh_first_name' => [
269 'title' => _T('First name'),
270 'pattern' => '/{FIRST_NAME_ADH}/',
273 'title' => _T('Nickname'),
274 'pattern' => '/{NICKNAME_ADH}/',
277 'title' => _T('Gender'),
278 'pattern' => '/{GENDER_ADH}/',
280 'adh_birth_date' => [
281 'title' => _T('Birth date'),
282 'pattern' => '/{ADH_BIRTH_DATE}/',
284 'adh_birth_place' => [
285 'title' => _T('Birth place'),
286 'pattern' => '/{ADH_BIRTH_PLACE}/',
288 'adh_profession' => [
289 'title' => _T('Profession'),
290 'pattern' => '/{PROFESSION_ADH}/',
293 'title' => _T("Company name"),
294 'pattern' => '/{COMPANY_ADH}/',
297 'title' => _T("Address"),
298 'pattern' => '/{ADDRESS_ADH}/',
300 'adh_address_multi' => [
301 'title' => sprintf('%s (%s)', _T('Address'), _T('with break lines')),
302 'pattern' => '/{ADDRESS_ADH_MULTI}/',
305 'title' => _T("Zipcode"),
306 'pattern' => '/{ZIP_ADH}/',
309 'title' => _T("Town"),
310 'pattern' => '/{TOWN_ADH}/',
313 'title' => _T('Country'),
314 'pattern' => '/{COUNTRY_ADH}/',
317 'title' => _T('Phone'),
318 'pattern' => '/{PHONE_ADH}/',
321 'title' => _T('GSM'),
322 'pattern' => '/{MOBILE_ADH}/',
325 'title' => _T('Email'),
326 'pattern' => '/{EMAIL_ADH}/',
329 'title' => _T('Login'),
330 'pattern' => '/{LOGIN_ADH}/',
332 'adh_main_group' => [
333 'title' => _T("Member's main group"),
334 'pattern' => '/{GROUP_ADH}/',
337 'title' => _T("Member's groups (as list)"),
338 'pattern' => '/{GROUPS_ADH}/'
341 'title' => _T('Member state of dues'),
342 'pattern' => '/{ADH_DUES}/'
344 'days_remaining' => [
345 'title' => _T('Membership remaining days'),
346 'pattern' => '/{DAYS_REMAINING}/',
349 'title' => _T('Membership expired since'),
350 'pattern' => '/{DAYS_EXPIRED}/',
354 if ($legacy === true) {
357 'title' => _T("Company name"),
358 'pattern' => '/{COMPANY_NAME_ADH}/',
360 '_adh_last_name' => [
361 'title' => _T('Last name'),
362 'pattern' => '/{LASTNAME_ADH}/',
364 '_adh_first_name' => [
365 'title' => _T('First name'),
366 'pattern' => '/{FIRSTNAME_ADH}/',
369 'title' => _T('Login'),
370 'pattern' => '/{LOGIN}/',
373 'title' => _T('Email'),
374 'pattern' => '/{MAIL_ADH}/',
379 return $m_patterns +
$dynamic_patterns;
383 * Get patterns for a contribution
385 * @param boolean $legacy Whether to load legacy patterns
389 protected function getContributionPatterns($legacy = true): array
391 $dynamic_patterns = $this->getDynamicPatterns('contrib', $legacy);
395 'title' => _T('Contribution label'),
396 'pattern' => '/{CONTRIB_LABEL}/',
398 'contrib_amount' => [
399 'title' => _T('Amount'),
400 'pattern' => '/{CONTRIB_AMOUNT}/',
402 'contrib_amount_letters' => [
403 'title' => _T('Amount (in letters)'),
404 'pattern' => '/{CONTRIB_AMOUNT_LETTERS}/',
407 'title' => _T('Full date'),
408 'pattern' => '/{CONTRIB_DATE}/',
411 'title' => _T('Contribution year'),
412 'pattern' => '/{CONTRIB_YEAR}/',
414 'contrib_comment' => [
415 'title' => _T('Comment'),
416 'pattern' => '/{CONTRIB_COMMENT}/',
419 'title' => _T('Begin date'),
420 'pattern' => '/{CONTRIB_BEGIN_DATE}/',
423 'title' => _T('End date'),
424 'pattern' => '/{CONTRIB_END_DATE}/',
427 'title' => _T('Contribution id'),
428 'pattern' => '/{CONTRIB_ID}/',
430 'contrib_payment' => [
431 'title' => _T('Payment type'),
432 'pattern' => '/{CONTRIB_PAYMENT_TYPE}/'
435 'title' => _T('Contribution information'),
436 'pattern' => '/{CONTRIB_INFO}/'
440 if ($legacy === true) {
441 foreach ($c_patterns as $key => $pattern) {
443 $pattern['pattern'] = str_replace(
448 $c_patterns[$nkey] = $pattern;
451 $c_patterns['__contrib_label'] = [
452 'title' => $c_patterns['contrib_label']['title'],
453 'pattern' => '/{CONTRIB_TYPE}/'
457 //handle DEADLINE alias
458 $c_patterns['deadline'] = [
459 'title' => $c_patterns['contrib_edate']['title'],
460 'pattern' => '/{DEADLINE}/'
463 return $c_patterns +
$dynamic_patterns;
467 * Set main replacements
471 public function setMain(): self
473 $address = $this->preferences
->getPostalAddress();
474 $address_multi = preg_replace("/\n/", "<br>", $address);
477 if ($this->preferences
->pref_website
!== '') {
478 $website = '<a href="' . $this->preferences
->pref_website
. '">' .
479 $this->preferences
->pref_website
. '</a>';
484 ' src="' . $this->preferences
->getURL() . $this->router
->pathFor('logo') . '"' .
485 ' width="' . $logo->getOptimalWidth() . '"' .
486 ' height="' . $logo->getOptimalHeight() . '"' .
489 $this->setReplacements(
491 'asso_name' => $this->preferences
->pref_nom
,
492 'asso_slogan' => $this->preferences
->pref_slogan
,
493 'asso_address' => $address,
494 'asso_address_multi' => $address_multi,
495 'asso_website' => $website,
496 'asso_logo' => $logo_elt,
497 'date_now' => date(_T('Y-m-d')),
498 'login_uri' => $this->preferences
->getURL() . $this->router
->pathFor('login'),
506 * Set contribution and proceed related replacements
510 public function setNoContribution(): self
515 'contrib_label' => null,
516 'contrib_amount' => null,
517 'contrib_amount_letters' => null,
518 'contrib_date' => null,
519 'contrib_year' => null,
520 'contrib_comment' => null,
521 'contrib_bdate' => null,
522 'contrib_edate' => null,
523 'contrib_id' => null,
524 'contrib_payment' => null,
525 'contrib_info' => null
528 foreach ($c_replacements as $key => $replacement) {
530 $c_replacements[$nkey] = $replacement;
532 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
534 //handle DEADLINE alias
535 $c_replacements['deadline'] = null;
537 $this->setReplacements($c_replacements);
539 /** the list of all dynamic fields */
540 $fields = new DynamicFieldsSet($this->zdb
, $login);
541 $dynamic_fields = $fields->getList('contrib');
542 $this->setDynamicFields('contrib', $dynamic_fields, null);
548 * Set contribution and proceed related replacements
550 * @param Contribution $contrib Contribution
554 public function setContribution(Contribution
$contrib): self
556 global $login, $i18n;
558 $formatter = new NumberFormatter($i18n->getID(), NumberFormatter
::SPELLOUT
);
561 'contrib_label' => $contrib->type
->libelle
,
562 'contrib_amount' => $contrib->amount
,
563 'contrib_amount_letters' => $formatter->format($contrib->amount
),
564 'contrib_date' => $contrib->date
,
565 'contrib_year' => $contrib->raw_date
->format('Y'),
566 'contrib_comment' => $contrib->info
,
567 'contrib_bdate' => $contrib->begin_date
,
568 'contrib_edate' => $contrib->end_date
,
569 'contrib_id' => $contrib->id
,
570 'contrib_payment' => $contrib->spayment_type
,
571 'contrib_info' => $contrib->info
574 foreach ($c_replacements as $key => $replacement) {
576 $c_replacements[$nkey] = $replacement;
578 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
580 //handle DEADLINE alias
581 $c_replacements['deadline'] = $c_replacements['contrib_edate'];
583 $this->setReplacements($c_replacements);
585 /** the list of all dynamic fields */
586 $fields = new DynamicFieldsSet($this->zdb
, $login);
587 $dynamic_fields = $fields->getList('contrib');
588 $this->setDynamicFields('contrib', $dynamic_fields, $contrib);
594 * Set member and proceed related replacements
596 * @param Adherent $member Member
600 public function setMember(Adherent
$member): self
604 $address = $member->getAddress();
605 $address_multi = preg_replace("/\n/", "<br>", $address);
607 if ($member->isMan()) {
609 } elseif ($member->isWoman()) {
610 $gender = _T("Woman");
612 $gender = _T("Unspecified");
615 $member_groups = $member->groups
;
616 $main_group = _T("None");
617 $group_list = _T("None");
618 if (is_array($member_groups) && count($member_groups) > 0) {
619 $main_group = $member_groups[0]->getName();
620 $group_list = '<ul>';
621 foreach ($member_groups as $group) {
622 $group_list .= '<li>' . $group->getName() . '</li>';
624 $group_list .= '</ul>';
627 $this->setReplacements(
629 'adh_title' => $member->stitle
,
630 'adh_id' => $member->id
,
631 'adh_num' => $member->number
,
632 'adh_name' => $member->sfullname
,
633 'adh_last_name' => $member->name
,
634 'adh_first_name' => $member->surname
,
635 'adh_nickname' => $member->nickname
,
636 'adh_gender' => $gender,
637 'adh_birth_date' => $member->birthdate
,
638 'adh_birth_place' => $member->birth_place
,
639 'adh_profession' => $member->job
,
640 'adh_company' => $member->company_name
,
641 'adh_address' => $address,
642 'adh_address_multi' => $address_multi,
643 'adh_zip' => $member->getZipcode(),
644 'adh_town' => $member->getTown(),
645 'adh_country' => $member->getCountry(),
646 'adh_phone' => $member->phone
,
647 'adh_mobile' => $member->gsm
,
648 //always take current member email, to be sure.
649 'adh_email' => $member->email
,
650 'adh_login' => $member->login
,
651 'adh_main_group' => $main_group,
652 'adh_groups' => $group_list,
653 'adh_dues' => $member->getDues(),
654 'days_remaining' => $member->days_remaining
,
655 'days_expired' => $member->days_remaining +
1,
656 //Handle COMPANY_NAME_ADH... https://bugs.galette.eu/issues/1530
657 '_adh_company' => $member->company_name
,
658 //Handle old names for variables ... https://bugs.galette.eu/issues/1393
659 '_adh_last_name' => $member->name
,
660 '_adh_first_name' => $member->surname
,
661 '_adh_login' => $member->login
,
662 '_adh_email' => $member->email
666 /** the list of all dynamic fields */
667 $fields = new DynamicFieldsSet($this->zdb
, $login);
668 $dynamic_fields = $fields->getList('adh');
669 $this->setDynamicFields('adh', $dynamic_fields, $member);
675 * Set dynamic fields and proceed related replacements
677 * @param string $form_name Form name
678 * @param array $dynamic_fields Dynamic fields
679 * @param mixed $object Related object (Adherent, Contribution, ...)
683 public function setDynamicFields(string $form_name, array $dynamic_fields, $object): self
685 $uform_name = strtoupper($form_name);
687 $dynamic_patterns = $this->getDynamicPatterns($form_name);
688 foreach ($dynamic_patterns as $dynamic_pattern) {
689 $pattern = trim($dynamic_pattern['pattern'], '/');
690 $key = strtolower(rtrim(ltrim($pattern, '{'), '}'));
693 if (preg_match("/^{LABEL_DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
694 /** dynamic field label */
695 $field_id = $match[1];
696 $value = $dynamic_fields[$field_id]->getName();
698 if (preg_match("/^{(INPUT_|VALUE_)?DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
699 /** dynamic field value */
700 $capacity = trim($match[1], '_');
701 $field_id = $match[2];
702 $field_name = $dynamic_fields[$field_id]->getName();
703 $field_type = $dynamic_fields[$field_id]->getType();
705 if ($object !== null) {
706 $all_values = $object->getDynamicFields()->getValues($field_id);
707 foreach ($all_values as $field_value) {
708 $field_values[$field_value['field_val']] = $field_value['text_val'] ??
$field_value['field_val'];
714 switch ($field_type) {
715 case DynamicField
::CHOICE
:
716 $choice_values = $dynamic_fields[$field_id]->getValues();
717 if ($capacity == 'INPUT') {
718 foreach ($choice_values as $choice_idx => $choice_value) {
719 $value .= '<input type="radio" class="box" name="' . $field_name . '" value="' . $field_id . '"';
720 if (isset($field_values[$choice_idx])) {
721 $value .= ' checked="checked"';
723 $value .= ' disabled="disabled">' . $choice_value . ' ';
726 foreach ($field_values as $field_value) {
727 $value .= $field_value;
731 case DynamicField
::BOOLEAN
:
732 foreach ($field_values as $field_value) {
733 $value .= ($field_value ?
_T("Yes") : _T("No"));
736 case DynamicField
::FILE
:
738 foreach ($field_values as $field_value) {
739 if (empty($field_value)) {
742 $spattern = (($this instanceof Texts
) ?
744 '<a href="%1$s%2$s">%3$s</a>'
748 $this->preferences
->getURL(),
749 $this->router
->pathFor(
755 'name' => $field_value
762 case DynamicField
::TEXT
:
763 case DynamicField
::LINE
:
764 case DynamicField
::DATE
:
765 $value .= implode('<br/>', $field_values);
770 $this->setReplacements(array($key => $value));
771 Analog
::log("adding dynamic replacement $key => $value", Analog
::DEBUG
);
782 public function getLegend(): array
787 'title' => _T('Main information'),
788 'patterns' => $this->getMainPatterns()
791 $legend['member'] = [
792 'title' => _T('Member information'),
793 'patterns' => $this->getMemberPatterns(false)
800 * Get configured replacements
804 public function getReplacements(): array
806 return $this->replaces
;
812 * @param Db $db Db instance
816 public function setDb(Db
$db): self
823 * Set Login dependency
825 * @param Login $login Login instance
829 public function setLogin(Login
$login): self
831 $this->login
= $login;
836 * Set Preferences dependency
838 * @param Preferences $preferences Preferences instance
842 public function setPreferences(Preferences
$preferences): self
844 $this->preferences
= $preferences;
849 * Set Router dependency
851 * @param Router $router Router instance
855 public function setRouter(Router
$router): self
857 $this->router
= $router;
862 * Proceed replacement on given entry
864 * @param string $source Source string
868 protected function proceedReplacements(string $source): string
872 //handle translations
873 $callback = static function ($matches) {
874 return _T($matches[1]);
876 $replaced = preg_replace_callback(
877 '/_T\("([^\"]+)"\)/',
883 ksort($this->patterns
, SORT_NATURAL
);
884 ksort($this->replaces
, SORT_NATURAL
);
886 if (array_keys($this->patterns
) !== array_keys($this->replaces
)) {
887 throw new \
RuntimeException('Patterns and replacements does not match!');
890 //handle replacements
891 $replaced = preg_replace(
897 //handle translations with replacements
898 $repl_callback = static function ($matches) {
905 $replaced = preg_replace_callback(
906 '/str_replace\(\'([^,]+)\', ?\'([^,]+)\', ?\'(.*)\'\)/',
919 public function getPatterns(): array
921 return $this->patterns
;