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\Entity\Adherent
;
44 use Galette\Entity\Contribution
;
45 use Galette\Entity\PdfModel
;
46 use Galette\Repository\DynamicFieldsSet
;
47 use Galette\DynamicFields\DynamicField
;
53 * Replacements feature
58 * @author Johan Cwiklinski <johan@x-tnd.be>
59 * @copyright 2020-2021 The Galette Team
60 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
61 * @link http://galette.eu
67 public static $RENDER_TXT = 0;
68 public static $RENDER_HTML = 1;
69 private $patterns = [];
70 private $replaces = [];
71 private $dynamic_patterns = [];
86 * @Inject("preferences")
89 protected $preferences;
98 * Get dynamic patterns
100 * @param string $form_name Dynamic form name
104 public function getDynamicPatterns(string $form_name): array
106 if (isset($this->dynamic_patterns
[$form_name])) {
107 return $this->dynamic_patterns
[$form_name];
110 $fields = new DynamicFieldsSet($this->zdb
, $this->login
);
111 $dynamic_fields = $fields->getList($form_name);
113 $dynamic_patterns = [];
114 foreach ($dynamic_fields as $dynamic_field) {
115 $key = strtoupper('_DYNFIELD_' . $dynamic_field->getId() . '_' . $form_name);
116 foreach (['LABEL', 'INPUT'] as $capability) {
117 $dynamic_patterns[strtolower($capability . $key)] = [
119 ($capability == 'LABEL' ?
_T('Label for dynamic field "%s"')
120 : _T('Input for dynamic field "%s"')),
121 $dynamic_field->getName()
123 'pattern' => sprintf(
132 $this->dynamic_patterns
[$form_name] = $dynamic_patterns;
133 return $this->dynamic_patterns
[$form_name];
139 * @param array $patterns Patterns to add
143 protected function setPatterns(array $patterns): self
146 foreach ($patterns as $key => $info) {
147 if (is_array($info)) {
148 $toset[$key] = $info['pattern'];
150 $toset[$key] = $info;
154 $this->patterns
= array_merge(
165 * @param array $replaces Replacements to add
169 public function setReplacements(array $replaces): void
171 $this->replaces
= array_merge(
182 protected function getMainPatterns(): array
186 'title' => _T('Your organisation name'),
187 'pattern' => '/{ASSO_NAME}/'
190 'title' => _T('Your organisation slogan'),
191 'pattern' => '/{ASSO_SLOGAN}/'
194 'title' => _T('Your organisation address'),
195 'pattern' => '/{ASSO_ADDRESS}/',
197 'asso_address_multi' => [
198 'title' => sprintf('%s (%s)', _T('Your organisation address'), _T('with break lines')),
199 'pattern' => '/{ASSO_ADDRESS_MULTI}/',
202 'title' => _T('Your organisation website'),
203 'pattern' => '/{ASSO_WEBSITE}/',
206 'title' => _T('Your organisation logo'),
207 'pattern' => '/{ASSO_LOGO}/',
210 'title' => _T('Current date (Y-m-d)'),
211 'pattern' => '/{DATE_NOW}/'
214 'title' => _T("Galette's login URI"),
215 'pattern' => '/{LOGIN_URI}/'
221 * Get patterns for a member
223 * @param boolean $legacy Whether to load legacy patterns
227 protected function getMemberPatterns(bool $legacy = true): array
229 $dynamic_patterns = $this->getDynamicPatterns('adh');
232 'title' => _('Title'),
233 'pattern' => '/{TITLE_ADH}/',
236 'title' => _T("Member's ID"),
237 'pattern' => '/{ID_ADH}/',
240 'title' => _T("Name"),
241 'pattern' => '/{NAME_ADH}/',
244 'title' => _T('Last name'),
245 'pattern' => '/{LAST_NAME_ADH}/',
247 'adh_first_name' => [
248 'title' => _T('First name'),
249 'pattern' => '/{FIRST_NAME_ADH}/',
252 'title' => _T('Nickname'),
253 'pattern' => '/{NICKNAME_ADH}/',
256 'title' => _T('Gender'),
257 'pattern' => '/{GENDER_ADH}/',
259 'adh_birth_date' => [
260 'title' => _T('Birth date'),
261 'pattern' => '/{ADH_BIRTH_DATE}/',
263 'adh_birth_place' => [
264 'title' => _T('Birth place'),
265 'pattern' => '/{ADH_BIRTH_PLACE}/',
267 'adh_profession' => [
268 'title' => _T('Profession'),
269 'pattern' => '/{PROFESSION_ADH}/',
272 'title' => _T("Company name"),
273 'pattern' => '/{COMPANY_ADH}/',
276 'title' => _T("Address"),
277 'pattern' => '/{ADDRESS_ADH}/',
280 'title' => _T("Zipcode"),
281 'pattern' => '/{ZIP_ADH}/',
284 'title' => _T("Town"),
285 'pattern' => '/{TOWN_ADH}/',
288 'title' => _T('Country'),
289 'pattern' => '/{COUNTRY_ADH}/',
292 'title' => _T('Phone'),
293 'pattern' => '/{PHONE_ADH}/',
296 'title' => _T('GSM'),
297 'pattern' => '/{MOBILE_ADH}/',
300 'title' => _T('Email'),
301 'pattern' => '/{EMAIL_ADH}/',
304 'title' => _T('Login'),
305 'pattern' => '/{LOGIN_ADH}/',
307 'adh_main_group' => [
308 'title' => _T("Member's main group"),
309 'pattern' => '/{GROUP_ADH}/',
312 'title' => _T("Member's groups (as list)"),
313 'pattern' => '/{GROUPS_ADH}/'
316 'title' => _T('Member state of dues'),
317 'pattern' => '/{ADH_DUES}/'
319 'days_remaining' => [
320 'title' => _T('Membership remaining days'),
321 'pattern' => '/{DAYS_REMAINING}/',
324 'title' => _T('Membership expired since'),
325 'pattern' => '/{DAYS_EXPIRED}/',
329 if ($legacy === true) {
332 'title' => _T("Company name"),
333 'pattern' => '/{COMPANY_NAME_ADH}/',
335 '_adh_last_name' => [
336 'title' => _T('Last name'),
337 'pattern' => '/{LASTNAME_ADH}/',
339 '_adh_first_name' => [
340 'title' => _T('First name'),
341 'pattern' => '/{FIRSTNAME_ADH}/',
344 'title' => _T('Login'),
345 'pattern' => '/{LOGIN}/',
348 'title' => _T('Email'),
349 'pattern' => '/{MAIL_ADH}/',
354 return $m_patterns +
$dynamic_patterns;
358 * Get patterns for a contribution
360 * @param boolean $legacy Whether to load legacy patterns
364 protected function getContributionPatterns($legacy = true): array
366 $dynamic_patterns = $this->getDynamicPatterns('contrib');
370 'title' => _T('Contribution label'),
371 'pattern' => '/{CONTRIB_LABEL}/',
373 'contrib_amount' => [
374 'title' => _T('Amount'),
375 'pattern' => '/{CONTRIB_AMOUNT}/',
377 'contrib_amount_letters' => [
378 'title' => _T('Amount (in letters)'),
379 'pattern' => '/{CONTRIB_AMOUNT_LETTERS}/',
382 'title' => _T('Full date'),
383 'pattern' => '/{CONTRIB_DATE}/',
386 'title' => _T('Contribution year'),
387 'pattern' => '/{CONTRIB_YEAR}/',
389 'contrib_comment' => [
390 'title' => _T('Comment'),
391 'pattern' => '/{CONTRIB_COMMENT}/',
394 'title' => _T('Begin date'),
395 'pattern' => '/{CONTRIB_BEGIN_DATE}/',
398 'title' => _T('End date'),
399 'pattern' => '/{CONTRIB_END_DATE}/',
402 'title' => _T('Contribution id'),
403 'pattern' => '/{CONTRIB_ID}/',
405 'contrib_payment' => [
406 'title' => _T('Payment type'),
407 'pattern' => '/{CONTRIB_PAYMENT_TYPE}/'
410 'title' => _T('Contribution information'),
411 'pattern' => '/{CONTRIB_INFO}/'
415 if ($legacy === true) {
416 foreach ($c_patterns as $key => $pattern) {
418 $pattern['pattern'] = str_replace(
423 $c_patterns[$nkey] = $pattern;
426 $c_patterns['__contrib_label'] = [
427 'title' => $c_patterns['contrib_label'],
428 'pattern' => '/{CONTRIB_TYPE}/'
432 //handle DEADLINE alias
434 return $c_patterns +
$dynamic_patterns;
438 * Set main replacements
442 public function setMain(): self
444 $address = $this->preferences
->getPostalAddress();
445 $address_multi = preg_replace("/\n/", "<br>", $address);
448 if ($this->preferences
->pref_website
!== '') {
449 $website = '<a href="' . $this->preferences
->pref_website
. '">' .
450 $this->preferences
->pref_website
. '</a>';
455 ' src="' . $this->preferences
->getURL() . $this->router
->pathFor('logo') . '"' .
456 ' width="' . $logo->getOptimalWidth() . '"' .
457 ' height="' . $logo->getOptimalHeight() . '"' .
460 $this->setReplacements(
462 'asso_name' => $this->preferences
->pref_nom
,
463 'asso_slogan' => $this->preferences
->pref_slogan
,
464 'asso_address' => $address,
465 'asso_address_multi' => $address_multi,
466 'asso_website' => $website,
467 'asso_logo' => $logo_elt,
468 'date_now' => date(_T('Y-m-d')),
469 'login_uri' => $this->preferences
->getURL() . $this->router
->pathFor('login'),
477 * Set contribution and proceed related replacements
481 public function setNoContribution(): self
486 'contrib_label' => null,
487 'contrib_amount' => null,
488 'contrib_amount_letters' => null,
489 'contrib_date' => null,
490 'contrib_year' => null,
491 'contrib_comment' => null,
492 'contrib_bdate' => null,
493 'contrib_edate' => null,
494 'contrib_id' => null,
495 'contrib_payment' => null,
496 'contrib_info' => null
499 foreach ($c_replacements as $key => $replacement) {
501 $c_replacements[$nkey] = $replacement;
503 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
505 //handle DEADLINE alias
507 $this->setReplacements($c_replacements);
509 /** the list of all dynamic fields */
510 $fields = new DynamicFieldsSet($this->zdb
, $login);
511 $dynamic_fields = $fields->getList('contrib');
512 $this->setDynamicFields('contrib', $dynamic_fields, null);
518 * Set contribution and proceed related replacements
520 * @param Contribution $contrib Contribution
524 public function setContribution(Contribution
$contrib): self
526 global $login, $i18n;
528 $formatter = new NumberFormatter($i18n->getID(), NumberFormatter
::SPELLOUT
);
531 'contrib_label' => $contrib->type
->libelle
,
532 'contrib_amount' => $contrib->amount
,
533 'contrib_amount_letters' => $formatter->format($contrib->amount
),
534 'contrib_date' => $contrib->date
,
535 'contrib_year' => $contrib->raw_date
->format('Y'),
536 'contrib_comment' => $contrib->info
,
537 'contrib_bdate' => $contrib->begin_date
,
538 'contrib_edate' => $contrib->end_date
,
539 'contrib_id' => $contrib->id
,
540 'contrib_payment' => $contrib->spayment_type
,
541 'contrib_info' => $contrib->info
544 foreach ($c_replacements as $key => $replacement) {
546 $c_replacements[$nkey] = $replacement;
548 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
550 //handle DEADLINE alias
552 $this->setReplacements($c_replacements);
554 /** the list of all dynamic fields */
555 $fields = new DynamicFieldsSet($this->zdb
, $login);
556 $dynamic_fields = $fields->getList('contrib');
557 $this->setDynamicFields('contrib', $dynamic_fields, $contrib);
563 * Set member and proceed related replacements
565 * @param Adherent $member Member
569 public function setMember(Adherent
$member): self
573 $address = $member->address
;
574 if ($member->address_continuation
!== '') {
575 $address .= '<br/>' . $member->address_continuation
;
578 if ($member->isMan()) {
580 } elseif ($member->isWoman()) {
581 $gender = _T("Woman");
583 $gender = _T("Unspecified");
586 $member_groups = $member->groups
;
587 $main_group = _T("None");
588 $group_list = _T("None");
589 if (is_array($member_groups) && count($member_groups) > 0) {
590 $main_group = $member_groups[0]->getName();
591 $group_list = '<ul>';
592 foreach ($member_groups as $group) {
593 $group_list .= '<li>' . $group->getName() . '</li>';
595 $group_list .= '</ul>';
598 $this->setReplacements(
600 'adh_title' => $member->stitle
,
601 'adh_id' => $member->id
,
602 'adh_name' => $member->sfullname
,
603 'adh_last_name' => $member->name
,
604 'adh_first_name' => $member->surname
,
605 'adh_nickname' => $member->nickname
,
606 'adh_gender' => $gender,
607 'adh_birth_date' => $member->birthdate
,
608 'adh_birth_place' => $member->birth_place
,
609 'adh_profession' => $member->job
,
610 'adh_company' => $member->company_name
,
611 'adh_address' => $address,
612 'adh_zip' => $member->zipcode
,
613 'adh_town' => $member->town
,
614 'adh_country' => $member->country
,
615 'adh_phone' => $member->phone
,
616 'adh_mobile' => $member->gsm
,
617 'adh_email' => $member->email
,
618 'adh_login' => $member->login
,
619 'adh_main_group' => $main_group,
620 'adh_groups' => $group_list,
621 'adh_dues' => $member->getDues(),
622 'days_remaining' => $member->days_remaining
,
623 'days_expired' => ($member->days_remaining
* -1),
624 //Handle COMPANY_NAME_ADH... https://bugs.galette.eu/issues/1530
625 '_adh_company' => $member->company_name
,
626 //Handle old names for variables ... https://bugs.galette.eu/issues/1393
627 '_adh_last_name' => $member->name
,
628 '_adh_first_name' => $member->surname
,
629 '_adh_login' => $member->login
,
630 '_adh_email' => $member->email
634 /** the list of all dynamic fields */
635 $fields = new DynamicFieldsSet($this->zdb
, $login);
636 $dynamic_fields = $fields->getList('adh');
637 $this->setDynamicFields('adh', $dynamic_fields, $member);
643 * Set dynamic fields and proceed related replacements
645 * @param string $form_name Form name
646 * @param array $dynamic_fields Dynamic fields
647 * @param mixed $object Related object (Adherent, Contribution, ...)
651 public function setDynamicFields(string $form_name, array $dynamic_fields, $object): self
653 $uform_name = strtoupper($form_name);
654 $render = ($this instanceof PdfModel
&& ($object->id
== null) ? self
::$RENDER_HTML : self
::$RENDER_TXT);
656 $dynamic_patterns = $this->getDynamicPatterns($form_name);
657 foreach ($dynamic_patterns as $dynamic_pattern) {
658 $pattern = trim($dynamic_pattern['pattern'], '/');
659 $key = strtolower(rtrim(ltrim($pattern, '{'), '}'));
661 if (preg_match("/^{DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
662 /** dynamic field first value */
663 $field_id = $match[1];
664 if ($object !== null) {
665 $values = $object->getDynamicFields()->getValues($field_id);
671 if (preg_match("/^{LABEL_DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
672 /** dynamic field label */
673 $field_id = $match[1];
674 $value = $dynamic_fields[$field_id]->getName();
676 if (preg_match("/^{INPUT_DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
677 /** dynamic field input form element */
678 $field_id = $match[1];
679 $field_name = $dynamic_fields[$field_id]->getName();
680 $field_type = $dynamic_fields[$field_id]->getType();
681 if ($object !== null) {
682 $field_values = $object->getDynamicFields()->getValues($field_id);
683 $field_value = $field_values[0]['field_val'];
688 switch ($field_type) {
689 case DynamicField
::TEXT
:
690 if ($render == self
::$RENDER_HTML) {
691 $value .= '<textarea' .
692 ' id="' . $field_name . '"' .
693 ' name="' . $field_name . '"' .
694 ' value="' . $field_value . '"' .
697 $value .= $field_value;
700 case DynamicField
::LINE
:
701 if ($render == self
::$RENDER_HTML) {
702 $value .= '<input type="text"' .
703 ' id="' . $field_name . '"' .
704 ' name="' . $field_name . '"' .
705 ' value="' . $field_value . '"' .
706 ' size="20" maxlength="30"/>';
708 $value .= $field_value;
711 case DynamicField
::CHOICE
:
712 $choice_values = $dynamic_fields[$field_id]->getValues();
713 foreach ($choice_values as $choice_idx => $choice_value) {
714 if ($render == self
::$RENDER_HTML) {
715 $value .= '<input type="radio"' .
716 ' id="' . $field_name . '"' .
717 ' name="' . $field_name . '"' .
718 ' value="' . $choice_value . '"';
719 if ($choice_idx == $field_value) {
720 $value .= ' checked="checked"';
723 $value .= $choice_value;
726 $value .= $choice_value;
731 case DynamicField
::DATE
:
732 if ($render == self
::$RENDER_HTML) {
733 $value .= '<input type="text" name="' .
734 $field_name . '" value="' .
738 $value .= $field_value;
741 case DynamicField
::BOOLEAN
:
742 if ($render == self
::$RENDER_HTML) {
743 $value .= '<input type="checkbox"' .
744 ' name="' . $field_name . '"' .
746 if ($field_value == 1) {
747 $value .= ' checked="checked"';
751 $value .= $field_value;
754 case DynamicField
::FILE
:
755 if ($render == self
::$RENDER_HTML) {
756 $value .= '<input type="text" name="' .
757 $field_name . '" value="' .
758 $field_value . '" />';
760 $value .= $field_value;
766 $this->setReplacements(array($key => $value));
767 Analog
::log("adding dynamic replacement $key => $value", Analog
::DEBUG
);
778 public function getLegend(): array
783 'title' => _T('Main information'),
784 'patterns' => $this->getMainPatterns()
787 $legend['member'] = [
788 'title' => _T('Member information'),
789 'patterns' => $this->getMemberPatterns(false)
796 * Get configured replacements
800 public function getReplacements(): array
802 return $this->replaces
;
808 * @param Db $db Db instance
812 public function setDb(Db
$db): self
819 * Set Login dependency
821 * @param Login $login Login instance
825 public function setLogin(Login
$login): self
827 $this->login
= $login;
832 * Set Preferences dependency
834 * @param Preferences $preferences Preferences instance
838 public function setPreferences(Preferences
$preferences): self
840 $this->preferences
= $preferences;
845 * Set Router dependency
847 * @param Router $router Router instance
851 public function setRouter(Router
$router): self
853 $this->router
= $router;
858 * Proceed replacement on given entry
860 * @param string $source Source string
864 protected function proceedReplacements(string $source): string
868 //handle translations
869 $callback = static function ($matches) {
870 return _T($matches[1]);
872 $replaced = preg_replace_callback(
873 '/_T\("([^\"]+)"\)/',
879 ksort($this->patterns
, SORT_NATURAL
);
880 ksort($this->replaces
, SORT_NATURAL
);
882 if (array_keys($this->patterns
) !== array_keys($this->replaces
)) {
883 throw new \
RuntimeException('Patterns and replacements does not match!');
886 //handle replacements
887 $replaced = preg_replace(
893 //handle translations with replacements
894 $repl_callback = static function ($matches) {
901 $replaced = preg_replace_callback(
902 '/str_replace\(\'([^,]+)\', ?\'([^,]+)\', ?\'(.*)\'\)/',
915 public function getPatterns(): array
917 return $this->patterns
;