3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette contributions controller
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/>.
27 * @category Controllers
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.tuxfamily.org
34 * @since Available since 0.9.4dev - 2020-05-08
37 namespace Galette\Controllers\Crud
;
41 use Galette\Controllers\CrudController
;
42 use Slim\Http\Request
;
43 use Slim\Http\Response
;
44 use Galette\Entity\Adherent
;
45 use Galette\Entity\Contribution
;
46 use Galette\Entity\Transaction
;
47 use Galette\Repository\Members
;
48 use Galette\Entity\ContributionsTypes
;
49 use Galette\Repository\PaymentTypes
;
52 * Galette contributions controller
54 * @category Controllers
55 * @name ContributionsController
57 * @author Johan Cwiklinski <johan@x-tnd.be>
58 * @copyright 2020-2021 The Galette Team
59 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
60 * @link http://galette.tuxfamily.org
61 * @since Available since 0.9.4dev - 2020-05-02
64 class ContributionsController
extends CrudController
71 * Only a few things changes in add and edit pages,
72 * boths methods will use this common one.
74 * @param Request $request PSR Request
75 * @param Response $response PSR Response
76 * @param string $type Contribution type
77 * @param Contribution $contrib Contribution instance
81 public function addEditPage(
88 $ct = new ContributionsTypes($this->zdb
);
89 $contributions_types = $ct->getList($type === Contribution
::TYPE_FEE
);
91 // template variable declaration
93 if ($type === Contribution
::TYPE_FEE
) {
94 $title = _T("Membership fee");
96 $title = _T("Donation");
99 if ($contrib->id
!= '') {
100 $title .= ' (' . _T("modification") . ')';
102 $title .= ' (' . _T("creation") . ')';
106 'page_title' => $title,
107 'required' => $contrib->getRequired(),
108 'contribution' => $contrib,
109 'adh_selected' => $contrib->member
,
113 // contribution types
114 $params['type_cotis_options'] = $contributions_types;
118 $members = $m->getSelectizedMembers(
120 $contrib->member
> 0 ?
$contrib->member
: null
123 $params['members'] = [
124 'filters' => $m->getFilters(),
125 'count' => $m->getCount()
128 if (count($members)) {
129 $params['members']['list'] = $members;
132 $ext_membership = '';
133 if ($contrib->isFee() ||
!isset($contrib) && $type === Contribution
::TYPE_FEE
) {
134 $ext_membership = $this->preferences
->pref_membership_ext
;
136 $params['pref_membership_ext'] = $ext_membership;
137 $params['autocomplete'] = true;
142 'ajouter_contribution.tpl',
151 * @param Request $request PSR Request
152 * @param Response $response PSR Response
153 * @param string|null $type Contribution type
157 public function add(Request
$request, Response
$response, string $type = null): Response
159 if ($this->session
->contribution
!== null) {
160 $contrib = $this->session
->contribution
;
161 $this->session
->contribution
= null;
163 $get = $request->getQueryParams();
165 $ct = new ContributionsTypes($this->zdb
);
166 $contributions_types = $ct->getList($type === Contribution
::TYPE_FEE
);
168 $cparams = ['type' => array_keys($contributions_types)[0]];
171 if (isset($get[Adherent
::PK
]) && $get[Adherent
::PK
] > 0) {
172 $cparams['adh'] = (int)$get[Adherent
::PK
];
176 if (isset($get[Transaction
::PK
]) && $get[Transaction
::PK
] > 0) {
177 $cparams['trans'] = $get[Transaction
::PK
];
180 $contrib = new Contribution(
183 (count($cparams) > 0 ?
$cparams : null)
186 if (isset($cparams['adh'])) {
187 $contrib->member
= $cparams['adh'];
190 if (isset($get['montant_cotis']) && $get['montant_cotis'] > 0) {
191 $contrib->amount
= $get['montant_cotis'];
195 return $this->addEditPage($request, $response, $type, $contrib);
201 * @param Request $request PSR Request
202 * @param Response $response PSR Response
203 * @param string|null $type Contribution type
207 public function doAdd(Request
$request, Response
$response, string $type = null): Response
209 return $this->store($request, $response, 'add', $type);
213 * Choose contribution type to mass add contribution
215 * @param Request $request PSR Request
216 * @param Response $response PSR Response
220 public function massAddChooseType(Request
$request, Response
$response): Response
222 $filters = $this->session
->filter_members
;
224 'id' => $filters->selected
,
225 'redirect_uri' => $this->router
->pathFor('members')
231 'mass_choose_type.tpl',
233 'mode' => $request->isXhr() ?
'ajax' : '',
234 'page_title' => str_replace(
237 _T('Mass add contribution on %count members')
240 'form_url' => $this->router
->pathFor('massAddContributions'),
241 'cancel_uri' => $this->router
->pathFor('members')
248 * Massive change page
250 * @param Request $request PSR Request
251 * @param Response $response PSR Response
255 public function massAddContributions(Request
$request, Response
$response): Response
257 $post = $request->getParsedBody();
258 $filters = $this->session
->filter_members
;
259 $contribution = new Contribution($this->zdb
, $this->login
);
261 $type = $post['type'];
263 'id' => $filters->selected
,
264 'redirect_uri' => $this->router
->pathFor('members'),
268 // contribution types
269 $ct = new ContributionsTypes($this->zdb
);
270 $contributions_types = $ct->getList($type === Contribution
::TYPE_FEE
);
275 'mass_add_contribution.tpl',
277 'mode' => $request->isXhr() ?
'ajax' : '',
278 'page_title' => str_replace(
281 _T('Mass add contribution on %count members')
283 'form_url' => $this->router
->pathFor('doMassAddContributions'),
284 'cancel_uri' => $this->router
->pathFor('members'),
286 'contribution' => $contribution,
288 'require_mass' => true,
289 'required' => $contribution->getRequired(),
290 'type_cotis_options' => $contributions_types
297 * Do massive contribution add
299 * @param Request $request PSR Request
300 * @param Response $response PSR Response
304 public function doMassAddContributions(Request
$request, Response
$response): Response
306 $post = $request->getParsedBody();
307 $members_ids = $post['id'];
310 $error_detected = [];
312 // flagging required fields for first step only
317 foreach ($members_ids as $member_id) {
318 $post[Adherent
::PK
] = (int)$member_id;
319 $contrib = new Contribution($this->zdb
, $this->login
);
322 $valid = $contrib->check($post, $contrib->getRequired(), $disabled);
323 if ($valid !== true) {
324 $error_detected = array_merge($error_detected, $valid);
327 //all goes well, we can proceed
328 if (count($error_detected) == 0) {
329 $store = $contrib->store();
330 if ($store === true) {
332 $files_res = $contrib->handleFiles($_FILES);
333 if (is_array($files_res)) {
334 $error_detected = array_merge($error_detected, $files_res);
342 if (count($error_detected) == 0) {
343 $redirect_url = $this->router
->pathFor('members');
345 //something went wrong.
346 //store entity in session
347 $redirect_url = $this->router
->pathFor('massAddContributions');
349 foreach ($error_detected as $error) {
350 $this->flash
->addMessage(
357 //redirect to calling action
360 ->withHeader('Location', $redirect_url);
369 * @param Request $request PSR Request
370 * @param Response $response PSR Response
371 * @param string $option One of 'page' or 'order'
372 * @param string|integer $value Value of the option
373 * @param string $type One of 'transactions' or 'contributions'
377 public function list(Request
$request, Response
$response, $option = null, $value = null, $type = null): Response
380 $get = $request->getQueryParams();
384 ||
isset($get['ajax'])
385 && $get['ajax'] == 'true'
394 $raw_type = 'transactions';
396 case 'contributions':
397 $raw_type = 'contributions';
401 $filter_name = 'filter_' . $raw_type;
403 if (isset($this->session
->$filter_name) && $ajax === false) {
404 $filters = $this->session
->$filter_name;
406 $filter_class = '\\Galette\\Filters\\' . ucwords($raw_type . 'List');
407 $filters = new $filter_class();
411 if (isset($get[Adherent
::PK
]) && $get[Adherent
::PK
] > 0) {
412 $filters->filtre_cotis_adh
= (int)$get[Adherent
::PK
];
415 $filters->filtre_transactions
= false;
416 if (isset($request->getQueryParams()['max_amount'])) {
417 $filters->filtre_transactions
= true;
418 $filters->max_amount
= (int)$request->getQueryParams()['max_amount'];
421 if ($option !== null) {
424 $filters->current_page
= (int)$value;
427 $filters->orderby
= $value;
430 $filters->filtre_cotis_adh
= ($value === 'all' ?
null : $value);
435 if (!$this->login
->isAdmin() && !$this->login
->isStaff() && $value != $this->login
->id
) {
436 if ($value == 'all') {
438 $filters->filtre_cotis_children
= $this->login
->id
;
440 $member = new Adherent(
451 !$member->hasParent() ||
452 $member->hasParent() && $member->parent
->id
!= $this->login
->id
454 $value = $this->login
->id
;
456 'Trying to display contributions for member #' . $value .
457 ' without appropriate ACLs',
462 $filters->filtre_cotis_children
= $value;
465 $class = '\\Galette\\Repository\\' . ucwords($raw_type);
466 $contrib = new $class($this->zdb
, $this->login
, $filters);
467 $contribs_list = $contrib->getList(true);
469 //store filters into session
470 if ($ajax === false) {
471 $this->session
->$filter_name = $filters;
474 //assign pagination variables to the template and add pagination links
475 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty());
478 'page_title' => $raw_type === 'contributions' ?
479 _T("Contributions management") : _T("Transactions management"),
480 'contribs' => $contrib,
481 'list' => $contribs_list,
482 'nb' => $contrib->getCount(),
483 'filters' => $filters,
484 'mode' => ($ajax === true ?
'ajax' : 'std')
487 if ($filters->filtre_cotis_adh
!= null) {
488 $member = new Adherent($this->zdb
);
489 $member->load($filters->filtre_cotis_adh
);
490 $tpl_vars['member'] = $member;
493 if ($filters->filtre_cotis_children
!= false) {
494 $member = new Adherent(
496 $filters->filtre_cotis_children
,
504 $tpl_vars['pmember'] = $member;
510 'gestion_' . $raw_type . '.tpl',
519 * @param Request $request PSR Request
520 * @param Response $response PSR Response
521 * @param string|null $type Contribution type
525 public function filter(Request
$request, Response
$response, string $type = null): Response
530 $raw_type = 'transactions';
532 case 'contributions':
533 $raw_type = 'contributions';
537 $type = 'filter_' . $raw_type;
538 $post = $request->getParsedBody();
539 $error_detected = [];
541 if ($this->session
->$type !== null) {
542 $filters = $this->session
->$type;
544 $filter_class = '\\Galette\\Filters\\' . ucwords($raw_type) . 'List';
545 $filters = new $filter_class();
548 if (isset($post['clear_filter'])) {
551 if (isset($post['max_amount'])) {
552 $filters->max_amount
= null;
556 (isset($post['nbshow']) && is_numeric($post['nbshow']))
558 $filters->show
= $post['nbshow'];
561 if (isset($post['end_date_filter']) ||
isset($post['start_date_filter'])) {
563 if (isset($post['start_date_filter'])) {
564 $filters->start_date_filter
= $post['start_date_filter'];
566 if (isset($post['end_date_filter'])) {
567 $filters->end_date_filter
= $post['end_date_filter'];
569 } catch (Throwable
$e) {
570 $error_detected[] = $e->getMessage();
574 if (isset($post['payment_type_filter'])) {
575 $ptf = (int)$post['payment_type_filter'];
576 $ptypes = new PaymentTypes(
581 $ptlist = $ptypes->getList();
582 if (isset($ptlist[$ptf])) {
583 $filters->payment_type_filter
= $ptf;
584 } elseif ($ptf == -1) {
585 $filters->payment_type_filter
= null;
587 $error_detected[] = _T("- Unknown payment type!");
592 $this->session
->$type = $filters;
594 if (count($error_detected) > 0) {
596 foreach ($error_detected as $error) {
597 $this->flash
->addMessage(
606 ->withHeader('Location', $this->router
->pathFor('contributions', ['type' => $raw_type]));
615 * @param Request $request PSR Request
616 * @param Response $response PSR Response
617 * @param int $id Contribution id
618 * @param string|null $type Contribution type
622 public function edit(Request
$request, Response
$response, int $id, string $type = null): Response
624 if ($this->session
->contribution
!== null) {
625 $contrib = $this->session
->contribution
;
626 $this->session
->contribution
= null;
628 $contrib = new Contribution($this->zdb
, $this->login
, $id);
629 if ($contrib->id
== '') {
630 //not possible to load contribution, exit
631 $this->flash
->addMessage(
636 _T("Unable to load contribution #%id!")
641 ->withHeader('Location', $this->router
->pathFor(
643 ['type' => 'contributions']
648 return $this->addEditPage($request, $response, $type, $contrib);
654 * @param Request $request PSR Request
655 * @param Response $response PSR Response
656 * @param integer $id Contribution id
657 * @param string|null $type Contribution type
661 public function doEdit(Request
$request, Response
$response, int $id, string $type = null): Response
663 return $this->store($request, $response, 'edit', $type, $id);
667 * Store contribution (new or existing)
669 * @param Request $request PSR Request
670 * @param Response $response PSR Response
671 * @param string $action Action ('edit' or 'add')
672 * @param string $type Contribution type
673 * @param integer $id Contribution id
677 public function store(Request
$request, Response
$response, $action, string $type, $id = null): Response
679 $post = $request->getParsedBody();
688 if ($action == 'edit' && isset($post['btnreload'])) {
689 $redirect_url = $this->router
->pathFor($action . 'Contribution', $args);
690 $redirect_url .= '?' . Adherent
::PK
. '=' . $post[Adherent
::PK
] . '&' .
691 ContributionsTypes
::PK
. '=' . $post[ContributionsTypes
::PK
] . '&' .
692 'montant_cotis=' . $post['montant_cotis'];
695 ->withHeader('Location', $redirect_url);
698 $error_detected = [];
700 if ($this->session
->contribution
!== null) {
701 $contrib = $this->session
->contribution
;
702 $this->session
->contribution
= null;
705 $contrib = new Contribution($this->zdb
, $this->login
);
707 $contrib = new Contribution($this->zdb
, $this->login
, $id);
714 $valid = $contrib->check($post, $contrib->getRequired(), $disabled);
715 if ($valid !== true) {
716 $error_detected = array_merge($error_detected, $valid);
719 //all goes well, we can proceed
720 if (count($error_detected) == 0) {
721 // send email to member
722 if (isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
723 $contrib->setSendmail(); //flag to send creation email
726 $store = $contrib->store();
727 if ($store === true) {
728 $this->flash
->addMessage(
730 _T('Contribution has been successfully stored')
733 //something went wrong :'(
734 $error_detected[] = _T("An error occurred while storing the contribution.");
738 if (count($error_detected) === 0) {
739 $files_res = $contrib->handleFiles($_FILES);
740 if (is_array($files_res)) {
741 $error_detected = array_merge($error_detected, $files_res);
745 if (count($error_detected) == 0) {
746 $this->session
->contribution
= null;
747 if ($contrib->isTransactionPart() && $contrib->transaction
->getMissingAmount() > 0) {
749 $redirect_url = $this->router
->pathFor(
752 'type' => $post['contrib_type']
754 ) . '?' . Transaction
::PK
. '=' . $contrib->transaction
->id
.
755 '&' . Adherent
::PK
. '=' . $contrib->member
;
757 //contributions list for member
758 $redirect_url = $this->router
->pathFor(
761 'type' => 'contributions'
763 ) . '?' . Adherent
::PK
. '=' . $contrib->member
;
766 //something went wrong.
767 //store entity in session
768 $this->session
->contribution
= $contrib;
769 $redirect_url = $this->router
->pathFor($action . 'Contribution', $args);
772 foreach ($error_detected as $error) {
773 $this->flash
->addMessage(
780 //redirect to calling action
783 ->withHeader('Location', $redirect_url);
790 * Get redirection URI
792 * @param array $args Route arguments
796 public function redirectUri(array $args)
798 return $this->router
->pathFor('contributions', ['type' => $args['type']]);
804 * @param array $args Route arguments
808 public function formUri(array $args)
810 return $this->router
->pathFor(
811 'doRemoveContribution',
817 * Get confirmation removal page title
819 * @param array $args Route arguments
823 public function confirmRemoveTitle(array $args)
827 switch ($args['type']) {
829 $raw_type = 'transactions';
831 case 'contributions':
832 $raw_type = 'contributions';
836 if (isset($args['ids'])) {
838 _T('Remove %1$s %2$s'),
840 ($raw_type === 'contributions') ?
_T('contributions') : _T('transactions')
844 _T('Remove %1$s #%2$s'),
845 ($raw_type === 'contributions') ?
_T('contribution') : _T('transaction'),
854 * @param array $args Route arguments
855 * @param array $post POST values
859 protected function doDelete(array $args, array $post)
862 switch ($args['type']) {
864 $raw_type = 'transactions';
866 case 'contributions':
867 $raw_type = 'contributions';
871 $class = '\\Galette\Repository\\' . ucwords($raw_type);
872 $contribs = new $class($this->zdb
, $this->login
);
873 $rm = $contribs->remove($args['ids'] ??
$args['id'], $this->history
);