3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette contributions controller
10 * Copyright © 2020-2022 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-2022 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
;
39 use Galette\Filters\ContributionsList
;
42 use Galette\Controllers\CrudController
;
43 use Slim\Http\Request
;
44 use Slim\Http\Response
;
45 use Galette\Entity\Adherent
;
46 use Galette\Entity\Contribution
;
47 use Galette\Entity\Transaction
;
48 use Galette\Repository\Members
;
49 use Galette\Entity\ContributionsTypes
;
50 use Galette\Repository\PaymentTypes
;
53 * Galette contributions controller
55 * @category Controllers
56 * @name ContributionsController
58 * @author Johan Cwiklinski <johan@x-tnd.be>
59 * @copyright 2020-2022 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.tuxfamily.org
62 * @since Available since 0.9.4dev - 2020-05-02
65 class ContributionsController
extends CrudController
72 * Only a few things changes in add and edit pages,
73 * boths methods will use this common one.
75 * @param Request $request PSR Request
76 * @param Response $response PSR Response
77 * @param string $type Contribution type
78 * @param Contribution $contrib Contribution instance
82 public function addEditPage(
89 $ct = new ContributionsTypes($this->zdb
);
90 $contributions_types = $ct->getList($type === Contribution
::TYPE_FEE
);
92 // template variable declaration
94 if ($type === Contribution
::TYPE_FEE
) {
95 $title = _T("Membership fee");
97 $title = _T("Donation");
100 if ($contrib->id
!= '') {
101 $title .= ' (' . _T("modification") . ')';
103 $title .= ' (' . _T("creation") . ')';
107 'page_title' => $title,
108 'required' => $contrib->getRequired(),
109 'contribution' => $contrib,
110 'adh_selected' => $contrib->member
,
114 // contribution types
115 $params['type_cotis_options'] = $contributions_types;
119 $members = $m->getSelectizedMembers(
122 $contrib->member
> 0 ?
$contrib->member
: null
125 $params['members'] = [
126 'filters' => $m->getFilters(),
127 'count' => $m->getCount()
130 if (count($members)) {
131 $params['members']['list'] = $members;
134 $ext_membership = '';
135 if ($contrib->isFee() ||
!isset($contrib) && $type === Contribution
::TYPE_FEE
) {
136 $ext_membership = $this->preferences
->pref_membership_ext
;
138 $params['pref_membership_ext'] = $ext_membership;
139 $params['autocomplete'] = true;
144 'ajouter_contribution.tpl',
153 * @param Request $request PSR Request
154 * @param Response $response PSR Response
155 * @param string|null $type Contribution type
159 public function add(Request
$request, Response
$response, string $type = null): Response
161 if ($this->session
->contribution
!== null) {
162 $contrib = $this->session
->contribution
;
163 $this->session
->contribution
= null;
165 $get = $request->getQueryParams();
167 $ct = new ContributionsTypes($this->zdb
);
168 $contributions_types = $ct->getList($type === Contribution
::TYPE_FEE
);
170 $cparams = ['type' => array_keys($contributions_types)[0]];
173 if (isset($get[Adherent
::PK
]) && $get[Adherent
::PK
] > 0) {
174 $cparams['adh'] = (int)$get[Adherent
::PK
];
178 if (isset($get[Transaction
::PK
]) && $get[Transaction
::PK
] > 0) {
179 $cparams['trans'] = $get[Transaction
::PK
];
182 $contrib = new Contribution(
185 (count($cparams) > 0 ?
$cparams : null)
188 if (isset($cparams['adh'])) {
189 $contrib->member
= $cparams['adh'];
192 if (isset($get['montant_cotis']) && $get['montant_cotis'] > 0) {
193 $contrib->amount
= $get['montant_cotis'];
197 return $this->addEditPage($request, $response, $type, $contrib);
203 * @param Request $request PSR Request
204 * @param Response $response PSR Response
205 * @param string|null $type Contribution type
209 public function doAdd(Request
$request, Response
$response, string $type = null): Response
211 return $this->store($request, $response, 'add', $type);
215 * Choose contribution type to mass add contribution
217 * @param Request $request PSR Request
218 * @param Response $response PSR Response
222 public function massAddChooseType(Request
$request, Response
$response): Response
224 $filters = $this->session
->filter_members
;
226 'id' => $filters->selected
,
227 'redirect_uri' => $this->router
->pathFor('members')
233 'mass_choose_type.tpl',
235 'mode' => $request->isXhr() ?
'ajax' : '',
236 'page_title' => str_replace(
239 _T('Mass add contribution on %count members')
242 'form_url' => $this->router
->pathFor('massAddContributions'),
243 'cancel_uri' => $this->router
->pathFor('members')
250 * Massive change page
252 * @param Request $request PSR Request
253 * @param Response $response PSR Response
257 public function massAddContributions(Request
$request, Response
$response): Response
259 $post = $request->getParsedBody();
260 $filters = $this->session
->filter_members
;
261 $contribution = new Contribution($this->zdb
, $this->login
);
263 $type = $post['type'];
265 'id' => $filters->selected
,
266 'redirect_uri' => $this->router
->pathFor('members'),
270 // contribution types
271 $ct = new ContributionsTypes($this->zdb
);
272 $contributions_types = $ct->getList($type === Contribution
::TYPE_FEE
);
277 'mass_add_contribution.tpl',
279 'mode' => $request->isXhr() ?
'ajax' : '',
280 'page_title' => str_replace(
283 _T('Mass add contribution on %count members')
285 'form_url' => $this->router
->pathFor('doMassAddContributions'),
286 'cancel_uri' => $this->router
->pathFor('members'),
288 'contribution' => $contribution,
290 'require_mass' => true,
291 'required' => $contribution->getRequired(),
292 'type_cotis_options' => $contributions_types
299 * Do massive contribution add
301 * @param Request $request PSR Request
302 * @param Response $response PSR Response
306 public function doMassAddContributions(Request
$request, Response
$response): Response
308 $post = $request->getParsedBody();
309 $members_ids = $post['id'];
312 $error_detected = [];
314 // flagging required fields for first step only
319 foreach ($members_ids as $member_id) {
320 $post[Adherent
::PK
] = (int)$member_id;
321 $contrib = new Contribution($this->zdb
, $this->login
);
324 $valid = $contrib->check($post, $contrib->getRequired(), $disabled);
325 if ($valid !== true) {
326 $error_detected = array_merge($error_detected, $valid);
329 //all goes well, we can proceed
330 if (count($error_detected) == 0) {
331 $store = $contrib->store();
332 if ($store === true) {
334 $files_res = $contrib->handleFiles($_FILES);
335 if (is_array($files_res)) {
336 $error_detected = array_merge($error_detected, $files_res);
344 if (count($error_detected) == 0) {
345 $redirect_url = $this->router
->pathFor('members');
347 //something went wrong.
348 //store entity in session
349 $redirect_url = $this->router
->pathFor('massAddContributions');
351 foreach ($error_detected as $error) {
352 $this->flash
->addMessage(
359 //redirect to calling action
362 ->withHeader('Location', $redirect_url);
371 * @param Request $request PSR Request
372 * @param Response $response PSR Response
373 * @param string $option One of 'page' or 'order'
374 * @param string|integer $value Value of the option
375 * @param string $type One of 'transactions' or 'contributions'
379 public function list(Request
$request, Response
$response, $option = null, $value = null, $type = null): Response
382 $get = $request->getQueryParams();
386 ||
isset($get['ajax'])
387 && $get['ajax'] == 'true'
394 $raw_type = 'transactions';
396 case 'contributions':
397 $raw_type = 'contributions';
401 'Trying to load unknown contribution type ' . $type,
408 $this->router
->pathFor('me')
412 $filter_name = 'filter_' . $raw_type;
414 if (isset($this->session
->$filter_name) && $ajax === false) {
415 $filters = $this->session
->$filter_name;
417 $filter_class = '\\Galette\\Filters\\' . ucwords($raw_type . 'List');
418 $filters = new $filter_class();
422 if (isset($get[Adherent
::PK
]) && $get[Adherent
::PK
] > 0) {
423 $filters->filtre_cotis_adh
= (int)$get[Adherent
::PK
];
426 $filters->filtre_transactions
= false;
427 if (isset($request->getQueryParams()['max_amount'])) {
428 $filters->filtre_transactions
= true;
429 $filters->max_amount
= (int)$request->getQueryParams()['max_amount'];
432 if ($option !== null) {
435 $filters->current_page
= (int)$value;
438 $filters->orderby
= $value;
441 $filters->filtre_cotis_adh
= ($value === 'all' ?
null : $value);
446 if (!$this->login
->isAdmin() && !$this->login
->isStaff() && $value != $this->login
->id
) {
447 if ($value === 'all' ||
empty($value)) {
448 $value = $this->login
->id
;
450 $member = new Adherent(
461 !$member->hasParent() ||
462 $member->hasParent() && $member->parent
->id
!= $this->login
->id
464 $value = $this->login
->id
;
466 'Trying to display contributions for member #' . $value .
467 ' without appropriate ACLs',
472 $filters->filtre_cotis_children
= $value;
475 $class = '\\Galette\\Entity\\' . ucwords(trim($raw_type, 's'));
476 $contrib = new $class($this->zdb
, $this->login
);
478 if (!$contrib->canShow($this->login
)) {
480 'Trying to display contributions without appropriate ACLs',
487 $this->router
->pathFor('me')
491 $class = '\\Galette\\Repository\\' . ucwords($raw_type);
492 $contrib = new $class($this->zdb
, $this->login
, $filters);
493 $contribs_list = $contrib->getList(true);
495 //store filters into session
496 if ($ajax === false) {
497 $this->session
->$filter_name = $filters;
500 //assign pagination variables to the template and add pagination links
501 $filters->setSmartyPagination($this->router
, $this->view
);
504 'page_title' => $raw_type === 'contributions' ?
505 _T("Contributions management") : _T("Transactions management"),
506 'contribs' => $contrib,
507 'list' => $contribs_list,
508 'nb' => $contrib->getCount(),
509 'filters' => $filters,
510 'mode' => ($ajax === true ?
'ajax' : 'std')
513 if ($filters->filtre_cotis_adh
!= null) {
514 $member = new Adherent($this->zdb
);
515 $member->load($filters->filtre_cotis_adh
);
516 $tpl_vars['member'] = $member;
519 if ($filters->filtre_cotis_children
!= false) {
520 $member = new Adherent(
522 $filters->filtre_cotis_children
,
530 $tpl_vars['pmember'] = $member;
536 'gestion_' . $raw_type . '.tpl',
545 * @param Request $request PSR Request
546 * @param Response $response PSR Response
547 * @param string|null $type One of 'transactions' or 'contributions'
551 public function filter(Request
$request, Response
$response, string $type = null): Response
553 $filter_name = 'filter_' . $type;
554 $post = $request->getParsedBody();
555 $error_detected = [];
557 if ($this->session
->$filter_name !== null) {
558 $filters = $this->session
->$filter_name;
560 $filter_class = '\\Galette\\Filters\\' . ucwords($type) . 'List';
561 $filters = new $filter_class();
564 if (isset($post['clear_filter'])) {
567 if (isset($post['max_amount'])) {
568 $filters->max_amount
= null;
572 (isset($post['nbshow']) && is_numeric($post['nbshow']))
574 $filters->show
= $post['nbshow'];
577 if (isset($post['end_date_filter']) ||
isset($post['start_date_filter'])) {
579 if (isset($post['start_date_filter'])) {
580 $filters->start_date_filter
= $post['start_date_filter'];
582 if (isset($post['end_date_filter'])) {
583 $filters->end_date_filter
= $post['end_date_filter'];
585 } catch (Throwable
$e) {
586 $error_detected[] = $e->getMessage();
590 if (isset($post['payment_type_filter'])) {
591 $ptf = (int)$post['payment_type_filter'];
592 $ptypes = new PaymentTypes(
597 $ptlist = $ptypes->getList();
598 if (isset($ptlist[$ptf])) {
599 $filters->payment_type_filter
= $ptf;
600 } elseif ($ptf == -1) {
601 $filters->payment_type_filter
= null;
603 $error_detected[] = _T("- Unknown payment type!");
608 $this->session
->$filter_name = $filters;
610 if (count($error_detected) > 0) {
612 foreach ($error_detected as $error) {
613 $this->flash
->addMessage(
622 ->withHeader('Location', $this->router
->pathFor('contributions', ['type' => $type]));
626 * Batch actions handler
628 * @param Request $request PSR Request
629 * @param Response $response PSR Response
630 * @param string $type One of 'transactions' or 'contributions'
634 public function handleBatch(Request
$request, Response
$response, string $type): Response
636 $filter_name = 'filter_' . $type;
637 $post = $request->getParsedBody();
639 if (isset($post['contrib_sel'])) {
640 if (isset($this->session
->$filter_name)) {
641 $filters = $this->session
->$filter_name;
643 $filters = new ContributionsList();
646 $filters->selected
= $post['contrib_sel'];
647 $this->session
->$filter_name = $filters;
649 if (isset($post['csv'])) {
652 ->withHeader('Location', $this->router
->pathFor('csv-contributionslist', ['type' => $type]));
655 if (isset($post['delete'])) {
658 ->withHeader('Location', $this->router
->pathFor('removeContributions'));
661 throw new \
RuntimeException('Does not know what to batch :(');
663 $this->flash
->addMessage(
665 _T("No contribution was selected, please check at least one.")
670 ->withHeader('Location', $this->router
->pathFor('contributions', ['type' => $type]));
680 * @param Request $request PSR Request
681 * @param Response $response PSR Response
682 * @param int $id Contribution id
683 * @param string|null $type Contribution type
687 public function edit(Request
$request, Response
$response, int $id, string $type = null): Response
689 if ($this->session
->contribution
!== null) {
690 $contrib = $this->session
->contribution
;
691 $this->session
->contribution
= null;
693 $contrib = new Contribution($this->zdb
, $this->login
, $id);
694 if ($contrib->id
== '') {
695 //not possible to load contribution, exit
696 $this->flash
->addMessage(
701 _T("Unable to load contribution #%id!")
706 ->withHeader('Location', $this->router
->pathFor(
708 ['type' => 'contributions']
713 return $this->addEditPage($request, $response, $type, $contrib);
719 * @param Request $request PSR Request
720 * @param Response $response PSR Response
721 * @param integer $id Contribution id
722 * @param string|null $type Contribution type
726 public function doEdit(Request
$request, Response
$response, int $id, string $type = null): Response
728 return $this->store($request, $response, 'edit', $type, $id);
732 * Store contribution (new or existing)
734 * @param Request $request PSR Request
735 * @param Response $response PSR Response
736 * @param string $action Action ('edit' or 'add')
737 * @param string $type Contribution type
738 * @param integer $id Contribution id
742 public function store(Request
$request, Response
$response, $action, string $type, $id = null): Response
744 $post = $request->getParsedBody();
753 if ($action == 'edit' && isset($post['btnreload'])) {
754 $redirect_url = $this->router
->pathFor($action . 'Contribution', $args);
755 $redirect_url .= '?' . Adherent
::PK
. '=' . $post[Adherent
::PK
] . '&' .
756 ContributionsTypes
::PK
. '=' . $post[ContributionsTypes
::PK
] . '&' .
757 'montant_cotis=' . $post['montant_cotis'];
760 ->withHeader('Location', $redirect_url);
763 $error_detected = [];
765 if ($this->session
->contribution
!== null) {
766 $contrib = $this->session
->contribution
;
767 $this->session
->contribution
= null;
770 $contrib = new Contribution($this->zdb
, $this->login
);
772 $contrib = new Contribution($this->zdb
, $this->login
, $id);
779 $valid = $contrib->check($post, $contrib->getRequired(), $disabled);
780 if ($valid !== true) {
781 $error_detected = array_merge($error_detected, $valid);
784 //all goes well, we can proceed
785 if (count($error_detected) == 0) {
786 // send email to member
787 if (isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
788 $contrib->setSendmail(); //flag to send creation email
791 $store = $contrib->store();
792 if ($store === true) {
793 $this->flash
->addMessage(
795 _T('Contribution has been successfully stored')
798 //something went wrong :'(
799 $error_detected[] = _T("An error occurred while storing the contribution.");
803 if (count($error_detected) === 0) {
804 $files_res = $contrib->handleFiles($_FILES);
805 if (is_array($files_res)) {
806 $error_detected = array_merge($error_detected, $files_res);
810 if (count($error_detected) == 0) {
811 $this->session
->contribution
= null;
812 if ($contrib->isTransactionPart() && $contrib->transaction
->getMissingAmount() > 0) {
814 $redirect_url = $this->router
->pathFor(
817 'type' => $post['contrib_type']
819 ) . '?' . Transaction
::PK
. '=' . $contrib->transaction
->id
.
820 '&' . Adherent
::PK
. '=' . $contrib->member
;
822 //contributions list for member
823 $redirect_url = $this->router
->pathFor(
826 'type' => 'contributions'
828 ) . '?' . Adherent
::PK
. '=' . $contrib->member
;
831 //something went wrong.
832 //store entity in session
833 $this->session
->contribution
= $contrib;
834 $redirect_url = $this->router
->pathFor($action . 'Contribution', $args);
837 foreach ($error_detected as $error) {
838 $this->flash
->addMessage(
845 //redirect to calling action
848 ->withHeader('Location', $redirect_url);
855 * Get redirection URI
857 * @param array $args Route arguments
861 public function redirectUri(array $args)
863 return $this->router
->pathFor('contributions', ['type' => $args['type']]);
869 * @param array $args Route arguments
873 public function formUri(array $args)
875 return $this->router
->pathFor(
876 'doRemoveContribution',
882 * Get confirmation removal page title
884 * @param array $args Route arguments
888 public function confirmRemoveTitle(array $args)
892 switch ($args['type']) {
894 $raw_type = 'transactions';
896 case 'contributions':
897 $raw_type = 'contributions';
901 if (isset($args['ids'])) {
903 _T('Remove %1$s %2$s'),
905 ($raw_type === 'contributions') ?
_T('contributions') : _T('transactions')
909 _T('Remove %1$s #%2$s'),
910 ($raw_type === 'contributions') ?
_T('contribution') : _T('transaction'),
919 * @param array $args Route arguments
920 * @param array $post POST values
924 protected function doDelete(array $args, array $post)
927 switch ($args['type']) {
929 $raw_type = 'transactions';
931 case 'contributions':
932 $raw_type = 'contributions';
936 $class = '\\Galette\Repository\\' . ucwords($raw_type);
937 $contribs = new $class($this->zdb
, $this->login
);
938 $rm = $contribs->remove($args['ids'] ??
$args['id'], $this->history
);