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;
99 * Get dynamic patterns
101 * @param string $form_name Dynamic form name
102 * @param boolean $legacy Whether to load legacy patterns
106 public function getDynamicPatterns(string $form_name, bool $legacy = true): array
108 $fields = new DynamicFieldsSet($this->zdb
, $this->login
);
109 $dynamic_fields = $fields->getList($form_name);
111 $dynamic_patterns = [];
112 foreach ($dynamic_fields as $dynamic_field) {
113 //no pattern for separators
114 if ($dynamic_field instanceof Separator
) {
117 $key = strtoupper('DYNFIELD_' . $dynamic_field->getId() . '_' . $form_name);
122 if (!($this instanceof Texts
) && ($legacy === true ||
$dynamic_field instanceof Choice
)) {
123 $capabilities[] = 'INPUT';
125 foreach ($capabilities as $capability) {
126 $skey = sprintf('%s_%s', $capability, $key);
127 switch ($capability) {
129 $title = _T('Label for dynamic field "%s"');
132 $title = _T('Form entry for dynamic field "%s"');
137 $title = _T('Value for dynamic field "%s"');
140 $dynamic_patterns[strtolower($skey)] = [
143 $dynamic_field->getName()
145 'pattern' => sprintf('/{%s}/', $skey)
150 $this->dynamic_patterns
[$form_name] = $dynamic_patterns;
151 return $this->dynamic_patterns
[$form_name];
157 * @param array $patterns Patterns to add
161 protected function setPatterns(array $patterns): self
164 foreach ($patterns as $key => $info) {
165 if (is_array($info)) {
166 $toset[$key] = $info['pattern'];
168 $toset[$key] = $info;
172 $this->patterns
= array_merge(
183 * @param array $replaces Replacements to add
187 public function setReplacements(array $replaces): void
189 $this->replaces
= array_merge(
200 protected function getMainPatterns(): array
204 'title' => _T('Your organisation name'),
205 'pattern' => '/{ASSO_NAME}/'
208 'title' => _T('Your organisation slogan'),
209 'pattern' => '/{ASSO_SLOGAN}/'
212 'title' => _T('Your organisation address'),
213 'pattern' => '/{ASSO_ADDRESS}/',
215 'asso_address_multi' => [
216 'title' => sprintf('%s (%s)', _T('Your organisation address'), _T('with break lines')),
217 'pattern' => '/{ASSO_ADDRESS_MULTI}/',
220 'title' => _T('Your organisation website'),
221 'pattern' => '/{ASSO_WEBSITE}/',
224 'title' => _T('Your organisation logo'),
225 'pattern' => '/{ASSO_LOGO}/',
228 'title' => _T('Current date (Y-m-d)'),
229 'pattern' => '/{DATE_NOW}/'
232 'title' => _T("Galette's login URI"),
233 'pattern' => '/{LOGIN_URI}/'
239 * Get patterns for a member
241 * @param boolean $legacy Whether to load legacy patterns
245 protected function getMemberPatterns(bool $legacy = true): array
247 $dynamic_patterns = $this->getDynamicPatterns('adh', $legacy);
250 'title' => _('Title'),
251 'pattern' => '/{TITLE_ADH}/',
254 'title' => _T("Member's ID"),
255 'pattern' => '/{ID_ADH}/',
258 'title' => _T("Name"),
259 'pattern' => '/{NAME_ADH}/',
262 'title' => _T('Last name'),
263 'pattern' => '/{LAST_NAME_ADH}/',
265 'adh_first_name' => [
266 'title' => _T('First name'),
267 'pattern' => '/{FIRST_NAME_ADH}/',
270 'title' => _T('Nickname'),
271 'pattern' => '/{NICKNAME_ADH}/',
274 'title' => _T('Gender'),
275 'pattern' => '/{GENDER_ADH}/',
277 'adh_birth_date' => [
278 'title' => _T('Birth date'),
279 'pattern' => '/{ADH_BIRTH_DATE}/',
281 'adh_birth_place' => [
282 'title' => _T('Birth place'),
283 'pattern' => '/{ADH_BIRTH_PLACE}/',
285 'adh_profession' => [
286 'title' => _T('Profession'),
287 'pattern' => '/{PROFESSION_ADH}/',
290 'title' => _T("Company name"),
291 'pattern' => '/{COMPANY_ADH}/',
294 'title' => _T("Address"),
295 'pattern' => '/{ADDRESS_ADH}/',
298 'title' => _T("Zipcode"),
299 'pattern' => '/{ZIP_ADH}/',
302 'title' => _T("Town"),
303 'pattern' => '/{TOWN_ADH}/',
306 'title' => _T('Country'),
307 'pattern' => '/{COUNTRY_ADH}/',
310 'title' => _T('Phone'),
311 'pattern' => '/{PHONE_ADH}/',
314 'title' => _T('GSM'),
315 'pattern' => '/{MOBILE_ADH}/',
318 'title' => _T('Email'),
319 'pattern' => '/{EMAIL_ADH}/',
322 'title' => _T('Login'),
323 'pattern' => '/{LOGIN_ADH}/',
325 'adh_main_group' => [
326 'title' => _T("Member's main group"),
327 'pattern' => '/{GROUP_ADH}/',
330 'title' => _T("Member's groups (as list)"),
331 'pattern' => '/{GROUPS_ADH}/'
334 'title' => _T('Member state of dues'),
335 'pattern' => '/{ADH_DUES}/'
337 'days_remaining' => [
338 'title' => _T('Membership remaining days'),
339 'pattern' => '/{DAYS_REMAINING}/',
342 'title' => _T('Membership expired since'),
343 'pattern' => '/{DAYS_EXPIRED}/',
347 if ($legacy === true) {
350 'title' => _T("Company name"),
351 'pattern' => '/{COMPANY_NAME_ADH}/',
353 '_adh_last_name' => [
354 'title' => _T('Last name'),
355 'pattern' => '/{LASTNAME_ADH}/',
357 '_adh_first_name' => [
358 'title' => _T('First name'),
359 'pattern' => '/{FIRSTNAME_ADH}/',
362 'title' => _T('Login'),
363 'pattern' => '/{LOGIN}/',
366 'title' => _T('Email'),
367 'pattern' => '/{MAIL_ADH}/',
372 return $m_patterns +
$dynamic_patterns;
376 * Get patterns for a contribution
378 * @param boolean $legacy Whether to load legacy patterns
382 protected function getContributionPatterns($legacy = true): array
384 $dynamic_patterns = $this->getDynamicPatterns('contrib', $legacy);
388 'title' => _T('Contribution label'),
389 'pattern' => '/{CONTRIB_LABEL}/',
391 'contrib_amount' => [
392 'title' => _T('Amount'),
393 'pattern' => '/{CONTRIB_AMOUNT}/',
395 'contrib_amount_letters' => [
396 'title' => _T('Amount (in letters)'),
397 'pattern' => '/{CONTRIB_AMOUNT_LETTERS}/',
400 'title' => _T('Full date'),
401 'pattern' => '/{CONTRIB_DATE}/',
404 'title' => _T('Contribution year'),
405 'pattern' => '/{CONTRIB_YEAR}/',
407 'contrib_comment' => [
408 'title' => _T('Comment'),
409 'pattern' => '/{CONTRIB_COMMENT}/',
412 'title' => _T('Begin date'),
413 'pattern' => '/{CONTRIB_BEGIN_DATE}/',
416 'title' => _T('End date'),
417 'pattern' => '/{CONTRIB_END_DATE}/',
420 'title' => _T('Contribution id'),
421 'pattern' => '/{CONTRIB_ID}/',
423 'contrib_payment' => [
424 'title' => _T('Payment type'),
425 'pattern' => '/{CONTRIB_PAYMENT_TYPE}/'
428 'title' => _T('Contribution information'),
429 'pattern' => '/{CONTRIB_INFO}/'
433 if ($legacy === true) {
434 foreach ($c_patterns as $key => $pattern) {
436 $pattern['pattern'] = str_replace(
441 $c_patterns[$nkey] = $pattern;
444 $c_patterns['__contrib_label'] = [
445 'title' => $c_patterns['contrib_label'],
446 'pattern' => '/{CONTRIB_TYPE}/'
450 //handle DEADLINE alias
452 return $c_patterns +
$dynamic_patterns;
456 * Set main replacements
460 public function setMain(): self
462 $address = $this->preferences
->getPostalAddress();
463 $address_multi = preg_replace("/\n/", "<br>", $address);
466 if ($this->preferences
->pref_website
!== '') {
467 $website = '<a href="' . $this->preferences
->pref_website
. '">' .
468 $this->preferences
->pref_website
. '</a>';
473 ' src="' . $this->preferences
->getURL() . $this->router
->pathFor('logo') . '"' .
474 ' width="' . $logo->getOptimalWidth() . '"' .
475 ' height="' . $logo->getOptimalHeight() . '"' .
478 $this->setReplacements(
480 'asso_name' => $this->preferences
->pref_nom
,
481 'asso_slogan' => $this->preferences
->pref_slogan
,
482 'asso_address' => $address,
483 'asso_address_multi' => $address_multi,
484 'asso_website' => $website,
485 'asso_logo' => $logo_elt,
486 'date_now' => date(_T('Y-m-d')),
487 'login_uri' => $this->preferences
->getURL() . $this->router
->pathFor('login'),
495 * Set contribution and proceed related replacements
499 public function setNoContribution(): self
504 'contrib_label' => null,
505 'contrib_amount' => null,
506 'contrib_amount_letters' => null,
507 'contrib_date' => null,
508 'contrib_year' => null,
509 'contrib_comment' => null,
510 'contrib_bdate' => null,
511 'contrib_edate' => null,
512 'contrib_id' => null,
513 'contrib_payment' => null,
514 'contrib_info' => null
517 foreach ($c_replacements as $key => $replacement) {
519 $c_replacements[$nkey] = $replacement;
521 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
523 //handle DEADLINE alias
525 $this->setReplacements($c_replacements);
527 /** the list of all dynamic fields */
528 $fields = new DynamicFieldsSet($this->zdb
, $login);
529 $dynamic_fields = $fields->getList('contrib');
530 $this->setDynamicFields('contrib', $dynamic_fields, null);
536 * Set contribution and proceed related replacements
538 * @param Contribution $contrib Contribution
542 public function setContribution(Contribution
$contrib): self
544 global $login, $i18n;
546 $formatter = new NumberFormatter($i18n->getID(), NumberFormatter
::SPELLOUT
);
549 'contrib_label' => $contrib->type
->libelle
,
550 'contrib_amount' => $contrib->amount
,
551 'contrib_amount_letters' => $formatter->format($contrib->amount
),
552 'contrib_date' => $contrib->date
,
553 'contrib_year' => $contrib->raw_date
->format('Y'),
554 'contrib_comment' => $contrib->info
,
555 'contrib_bdate' => $contrib->begin_date
,
556 'contrib_edate' => $contrib->end_date
,
557 'contrib_id' => $contrib->id
,
558 'contrib_payment' => $contrib->spayment_type
,
559 'contrib_info' => $contrib->info
562 foreach ($c_replacements as $key => $replacement) {
564 $c_replacements[$nkey] = $replacement;
566 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
568 //handle DEADLINE alias
570 $this->setReplacements($c_replacements);
572 /** the list of all dynamic fields */
573 $fields = new DynamicFieldsSet($this->zdb
, $login);
574 $dynamic_fields = $fields->getList('contrib');
575 $this->setDynamicFields('contrib', $dynamic_fields, $contrib);
581 * Set member and proceed related replacements
583 * @param Adherent $member Member
587 public function setMember(Adherent
$member): self
591 $address = $member->address
;
592 if ($member->address_continuation
!== '') {
593 $address .= '<br/>' . $member->address_continuation
;
596 if ($member->isMan()) {
598 } elseif ($member->isWoman()) {
599 $gender = _T("Woman");
601 $gender = _T("Unspecified");
604 $member_groups = $member->groups
;
605 $main_group = _T("None");
606 $group_list = _T("None");
607 if (is_array($member_groups) && count($member_groups) > 0) {
608 $main_group = $member_groups[0]->getName();
609 $group_list = '<ul>';
610 foreach ($member_groups as $group) {
611 $group_list .= '<li>' . $group->getName() . '</li>';
613 $group_list .= '</ul>';
616 $this->setReplacements(
618 'adh_title' => $member->stitle
,
619 'adh_id' => $member->id
,
620 'adh_name' => $member->sfullname
,
621 'adh_last_name' => $member->name
,
622 'adh_first_name' => $member->surname
,
623 'adh_nickname' => $member->nickname
,
624 'adh_gender' => $gender,
625 'adh_birth_date' => $member->birthdate
,
626 'adh_birth_place' => $member->birth_place
,
627 'adh_profession' => $member->job
,
628 'adh_company' => $member->company_name
,
629 'adh_address' => $address,
630 'adh_zip' => $member->zipcode
,
631 'adh_town' => $member->town
,
632 'adh_country' => $member->country
,
633 'adh_phone' => $member->phone
,
634 'adh_mobile' => $member->gsm
,
635 'adh_email' => $member->email
,
636 'adh_login' => $member->login
,
637 'adh_main_group' => $main_group,
638 'adh_groups' => $group_list,
639 'adh_dues' => $member->getDues(),
640 'days_remaining' => $member->days_remaining
,
641 'days_expired' => ($member->days_remaining
* -1),
642 //Handle COMPANY_NAME_ADH... https://bugs.galette.eu/issues/1530
643 '_adh_company' => $member->company_name
,
644 //Handle old names for variables ... https://bugs.galette.eu/issues/1393
645 '_adh_last_name' => $member->name
,
646 '_adh_first_name' => $member->surname
,
647 '_adh_login' => $member->login
,
648 '_adh_email' => $member->email
652 /** the list of all dynamic fields */
653 $fields = new DynamicFieldsSet($this->zdb
, $login);
654 $dynamic_fields = $fields->getList('adh');
655 $this->setDynamicFields('adh', $dynamic_fields, $member);
661 * Set dynamic fields and proceed related replacements
663 * @param string $form_name Form name
664 * @param array $dynamic_fields Dynamic fields
665 * @param mixed $object Related object (Adherent, Contribution, ...)
669 public function setDynamicFields(string $form_name, array $dynamic_fields, $object): self
671 $uform_name = strtoupper($form_name);
673 $dynamic_patterns = $this->getDynamicPatterns($form_name);
674 foreach ($dynamic_patterns as $dynamic_pattern) {
675 $pattern = trim($dynamic_pattern['pattern'], '/');
676 $key = strtolower(rtrim(ltrim($pattern, '{'), '}'));
679 if (preg_match("/^{LABEL_DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
680 /** dynamic field label */
681 $field_id = $match[1];
682 $value = $dynamic_fields[$field_id]->getName();
684 if (preg_match("/^{(INPUT_|VALUE_)?DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
685 /** dynamic field value */
686 $capacity = trim($match[1], '_');
687 $field_id = $match[2];
688 $field_name = $dynamic_fields[$field_id]->getName();
689 $field_type = $dynamic_fields[$field_id]->getType();
691 if ($object !== null) {
692 $all_values = $object->getDynamicFields()->getValues($field_id);
693 foreach ($all_values as $field_value) {
694 $field_values[$field_value['field_val']] = $field_value['text_val'] ??
$field_value['field_val'];
700 switch ($field_type) {
701 case DynamicField
::CHOICE
:
702 if ($capacity == 'INPUT') {
703 $choice_values = $dynamic_fields[$field_id]->getValues();
704 foreach ($choice_values as $choice_idx => $choice_value) {
705 $value .= '<input type="radio" class="box" name="' . $field_name . '" value="' . $field_id . '"';
706 if (isset($field_values[$choice_idx])) {
707 $value .= ' checked="checked"';
709 $value .= ' disabled="disabled">' . $choice_value . ' ';
712 $value .= implode(' ', $field_values);
715 case DynamicField
::BOOLEAN
:
716 foreach ($field_values as $field_value) {
717 $value .= ($field_value ?
_T("Yes") : _T("No"));
720 case DynamicField
::FILE
:
722 foreach ($field_values as $field_value) {
724 '<a href="%1$s%2$s">%3$s</a>',
725 $this->preferences
->getURL(),
726 $this->router
->pathFor(
731 'name' => $field_value
738 case DynamicField
::TEXT
:
739 case DynamicField
::LINE
:
740 case DynamicField
::DATE
:
741 $value .= implode('<br/>', $field_values);
746 $this->setReplacements(array($key => $value));
747 Analog
::log("adding dynamic replacement $key => $value", Analog
::DEBUG
);
758 public function getLegend(): array
763 'title' => _T('Main information'),
764 'patterns' => $this->getMainPatterns()
767 $legend['member'] = [
768 'title' => _T('Member information'),
769 'patterns' => $this->getMemberPatterns(false)
776 * Get configured replacements
780 public function getReplacements(): array
782 return $this->replaces
;
788 * @param Db $db Db instance
792 public function setDb(Db
$db): self
799 * Set Login dependency
801 * @param Login $login Login instance
805 public function setLogin(Login
$login): self
807 $this->login
= $login;
812 * Set Preferences dependency
814 * @param Preferences $preferences Preferences instance
818 public function setPreferences(Preferences
$preferences): self
820 $this->preferences
= $preferences;
825 * Set Router dependency
827 * @param Router $router Router instance
831 public function setRouter(Router
$router): self
833 $this->router
= $router;
838 * Proceed replacement on given entry
840 * @param string $source Source string
844 protected function proceedReplacements(string $source): string
848 //handle translations
849 $callback = static function ($matches) {
850 return _T($matches[1]);
852 $replaced = preg_replace_callback(
853 '/_T\("([^\"]+)"\)/',
859 ksort($this->patterns
, SORT_NATURAL
);
860 ksort($this->replaces
, SORT_NATURAL
);
862 if (array_keys($this->patterns
) !== array_keys($this->replaces
)) {
863 throw new \
RuntimeException('Patterns and replacements does not match!');
866 //handle replacements
867 $replaced = preg_replace(
873 //handle translations with replacements
874 $repl_callback = static function ($matches) {
881 $replaced = preg_replace_callback(
882 '/str_replace\(\'([^,]+)\', ?\'([^,]+)\', ?\'(.*)\'\)/',
895 public function getPatterns(): array
897 return $this->patterns
;