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']['title'],
446 'pattern' => '/{CONTRIB_TYPE}/'
450 //handle DEADLINE alias
451 $c_patterns['deadline'] = [
452 'title' => $c_patterns['contrib_edate']['title'],
453 'pattern' => '/{DEADLINE}/'
456 return $c_patterns +
$dynamic_patterns;
460 * Set main replacements
464 public function setMain(): self
466 $address = $this->preferences
->getPostalAddress();
467 $address_multi = preg_replace("/\n/", "<br>", $address);
470 if ($this->preferences
->pref_website
!== '') {
471 $website = '<a href="' . $this->preferences
->pref_website
. '">' .
472 $this->preferences
->pref_website
. '</a>';
477 ' src="' . $this->preferences
->getURL() . $this->router
->pathFor('logo') . '"' .
478 ' width="' . $logo->getOptimalWidth() . '"' .
479 ' height="' . $logo->getOptimalHeight() . '"' .
482 $this->setReplacements(
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'),
499 * Set contribution and proceed related replacements
503 public function setNoContribution(): self
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
521 foreach ($c_replacements as $key => $replacement) {
523 $c_replacements[$nkey] = $replacement;
525 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
527 //handle DEADLINE alias
528 $c_replacements['deadline'] = null;
530 $this->setReplacements($c_replacements);
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);
541 * Set contribution and proceed related replacements
543 * @param Contribution $contrib Contribution
547 public function setContribution(Contribution
$contrib): self
549 global $login, $i18n;
551 $formatter = new NumberFormatter($i18n->getID(), NumberFormatter
::SPELLOUT
);
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
567 foreach ($c_replacements as $key => $replacement) {
569 $c_replacements[$nkey] = $replacement;
571 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
573 //handle DEADLINE alias
574 $c_replacements['deadline'] = $c_replacements['contrib_edate'];
576 $this->setReplacements($c_replacements);
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);
587 * Set member and proceed related replacements
589 * @param Adherent $member Member
593 public function setMember(Adherent
$member): self
597 $address = $member->getAddress();
598 if ($member->getAddressContinuation() !== '') {
599 $address .= '<br/>' . $member->getAddressContinuation();
602 if ($member->isMan()) {
604 } elseif ($member->isWoman()) {
605 $gender = _T("Woman");
607 $gender = _T("Unspecified");
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>';
619 $group_list .= '</ul>';
622 $this->setReplacements(
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
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);
668 * Set dynamic fields and proceed related replacements
670 * @param string $form_name Form name
671 * @param array $dynamic_fields Dynamic fields
672 * @param mixed $object Related object (Adherent, Contribution, ...)
676 public function setDynamicFields(string $form_name, array $dynamic_fields, $object): self
678 $uform_name = strtoupper($form_name);
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, '{'), '}'));
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();
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();
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'];
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"';
716 $value .= ' disabled="disabled">' . $choice_value . ' ';
719 foreach ($field_values as $field_value) {
720 $value .= $field_value;
724 case DynamicField
::BOOLEAN
:
725 foreach ($field_values as $field_value) {
726 $value .= ($field_value ?
_T("Yes") : _T("No"));
729 case DynamicField
::FILE
:
731 foreach ($field_values as $field_value) {
732 if (empty($field_value)) {
735 $spattern = (($this instanceof Texts
) ?
737 '<a href="%1$s%2$s">%3$s</a>'
741 $this->preferences
->getURL(),
742 $this->router
->pathFor(
748 'name' => $field_value
755 case DynamicField
::TEXT
:
756 case DynamicField
::LINE
:
757 case DynamicField
::DATE
:
758 $value .= implode('<br/>', $field_values);
763 $this->setReplacements(array($key => $value));
764 Analog
::log("adding dynamic replacement $key => $value", Analog
::DEBUG
);
775 public function getLegend(): array
780 'title' => _T('Main information'),
781 'patterns' => $this->getMainPatterns()
784 $legend['member'] = [
785 'title' => _T('Member information'),
786 'patterns' => $this->getMemberPatterns(false)
793 * Get configured replacements
797 public function getReplacements(): array
799 return $this->replaces
;
805 * @param Db $db Db instance
809 public function setDb(Db
$db): self
816 * Set Login dependency
818 * @param Login $login Login instance
822 public function setLogin(Login
$login): self
824 $this->login
= $login;
829 * Set Preferences dependency
831 * @param Preferences $preferences Preferences instance
835 public function setPreferences(Preferences
$preferences): self
837 $this->preferences
= $preferences;
842 * Set Router dependency
844 * @param Router $router Router instance
848 public function setRouter(Router
$router): self
850 $this->router
= $router;
855 * Proceed replacement on given entry
857 * @param string $source Source string
861 protected function proceedReplacements(string $source): string
865 //handle translations
866 $callback = static function ($matches) {
867 return _T($matches[1]);
869 $replaced = preg_replace_callback(
870 '/_T\("([^\"]+)"\)/',
876 ksort($this->patterns
, SORT_NATURAL
);
877 ksort($this->replaces
, SORT_NATURAL
);
879 if (array_keys($this->patterns
) !== array_keys($this->replaces
)) {
880 throw new \
RuntimeException('Patterns and replacements does not match!');
883 //handle replacements
884 $replaced = preg_replace(
890 //handle translations with replacements
891 $repl_callback = static function ($matches) {
898 $replaced = preg_replace_callback(
899 '/str_replace\(\'([^,]+)\', ?\'([^,]+)\', ?\'(.*)\'\)/',
912 public function getPatterns(): array
914 return $this->patterns
;