]> git.agnieray.net Git - galette.git/blob - galette/lib/Galette/Controllers/Crud/ContributionsController.php
171e1e79b2c44046fd350b2e67ee3a1d6fb00d9c
[galette.git] / galette / lib / Galette / Controllers / Crud / ContributionsController.php
1 <?php
2
3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
4
5 /**
6 * Galette contributions controller
7 *
8 * PHP version 5
9 *
10 * Copyright © 2020-2021 The Galette Team
11 *
12 * This file is part of Galette (http://galette.tuxfamily.org).
13 *
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.
18 *
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.
23 *
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/>.
26 *
27 * @category Controllers
28 * @package Galette
29 *
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
35 */
36
37 namespace Galette\Controllers\Crud;
38
39 use Throwable;
40 use Analog\Analog;
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;
50
51 /**
52 * Galette contributions controller
53 *
54 * @category Controllers
55 * @name ContributionsController
56 * @package Galette
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
62 */
63
64 class ContributionsController extends CrudController
65 {
66 // CRUD - Create
67
68 /**
69 * Add/Edit page
70 *
71 * Only a few things changes in add and edit pages,
72 * boths methods will use this common one.
73 *
74 * @param Request $request PSR Request
75 * @param Response $response PSR Response
76 * @param string $type Contribution type
77 * @param Contribution $contrib Contribution instance
78 *
79 * @return Response
80 */
81 public function addEditPage(
82 Request $request,
83 Response $response,
84 string $type,
85 Contribution $contrib
86 ): Response {
87 // contribution types
88 $ct = new ContributionsTypes($this->zdb);
89 $contributions_types = $ct->getList($type === Contribution::TYPE_FEE);
90
91 // template variable declaration
92 $title = null;
93 if ($type === Contribution::TYPE_FEE) {
94 $title = _T("Membership fee");
95 } else {
96 $title = _T("Donation");
97 }
98
99 if ($contrib->id != '') {
100 $title .= ' (' . _T("modification") . ')';
101 } else {
102 $title .= ' (' . _T("creation") . ')';
103 }
104
105 $params = [
106 'page_title' => $title,
107 'required' => $contrib->getRequired(),
108 'contribution' => $contrib,
109 'adh_selected' => $contrib->member,
110 'type' => $type
111 ];
112
113 // contribution types
114 $params['type_cotis_options'] = $contributions_types;
115
116 // members
117 $m = new Members();
118 $members = $m->getSelectizedMembers(
119 $this->zdb,
120 $contrib->member > 0 ? $contrib->member : null
121 );
122
123 $params['members'] = [
124 'filters' => $m->getFilters(),
125 'count' => $m->getCount()
126 ];
127
128 if (count($members)) {
129 $params['members']['list'] = $members;
130 }
131
132 $ext_membership = '';
133 if ($contrib->isFee() || !isset($contrib) && $type === Contribution::TYPE_FEE) {
134 $ext_membership = $this->preferences->pref_membership_ext;
135 }
136 $params['pref_membership_ext'] = $ext_membership;
137 $params['autocomplete'] = true;
138
139 // display page
140 $this->view->render(
141 $response,
142 'ajouter_contribution.tpl',
143 $params
144 );
145 return $response;
146 }
147
148 /**
149 * Add page
150 *
151 * @param Request $request PSR Request
152 * @param Response $response PSR Response
153 * @param string|null $type Contribution type
154 *
155 * @return Response
156 */
157 public function add(Request $request, Response $response, string $type = null): Response
158 {
159 if ($this->session->contribution !== null) {
160 $contrib = $this->session->contribution;
161 $this->session->contribution = null;
162 } else {
163 $get = $request->getQueryParams();
164
165 $ct = new ContributionsTypes($this->zdb);
166 $contributions_types = $ct->getList($type === Contribution::TYPE_FEE);
167
168 $cparams = ['type' => array_keys($contributions_types)[0]];
169
170 //member id
171 if (isset($get[Adherent::PK]) && $get[Adherent::PK] > 0) {
172 $cparams['adh'] = (int)$get[Adherent::PK];
173 }
174
175 //transaction id
176 if (isset($get[Transaction::PK]) && $get[Transaction::PK] > 0) {
177 $cparams['trans'] = $get[Transaction::PK];
178 }
179
180 $contrib = new Contribution(
181 $this->zdb,
182 $this->login,
183 (count($cparams) > 0 ? $cparams : null)
184 );
185
186 if (isset($cparams['adh'])) {
187 $contrib->member = $cparams['adh'];
188 }
189
190 if (isset($get['montant_cotis']) && $get['montant_cotis'] > 0) {
191 $contrib->amount = $get['montant_cotis'];
192 }
193 }
194
195 return $this->addEditPage($request, $response, $type, $contrib);
196 }
197
198 /**
199 * Add action
200 *
201 * @param Request $request PSR Request
202 * @param Response $response PSR Response
203 * @param string|null $type Contribution type
204 *
205 * @return Response
206 */
207 public function doAdd(Request $request, Response $response, string $type = null): Response
208 {
209 return $this->store($request, $response, 'add', $type);
210 }
211
212 /**
213 * Choose contribution type to mass add contribution
214 *
215 * @param Request $request PSR Request
216 * @param Response $response PSR Response
217 *
218 * @return Response
219 */
220 public function massAddChooseType(Request $request, Response $response): Response
221 {
222 $filters = $this->session->filter_members;
223 $data = [
224 'id' => $filters->selected,
225 'redirect_uri' => $this->router->pathFor('members')
226 ];
227
228 // display page
229 $this->view->render(
230 $response,
231 'mass_choose_type.tpl',
232 array(
233 'mode' => $request->isXhr() ? 'ajax' : '',
234 'page_title' => str_replace(
235 '%count',
236 count($data['id']),
237 _T('Mass add contribution on %count members')
238 ),
239 'data' => $data,
240 'form_url' => $this->router->pathFor('massAddContributions'),
241 'cancel_uri' => $this->router->pathFor('members')
242 )
243 );
244 return $response;
245 }
246
247 /**
248 * Massive change page
249 *
250 * @param Request $request PSR Request
251 * @param Response $response PSR Response
252 *
253 * @return Response
254 */
255 public function massAddContributions(Request $request, Response $response): Response
256 {
257 $post = $request->getParsedBody();
258 $filters = $this->session->filter_members;
259 $contribution = new Contribution($this->zdb, $this->login);
260
261 $type = $post['type'];
262 $data = [
263 'id' => $filters->selected,
264 'redirect_uri' => $this->router->pathFor('members'),
265 'type' => $type
266 ];
267
268 // contribution types
269 $ct = new ContributionsTypes($this->zdb);
270 $contributions_types = $ct->getList($type === Contribution::TYPE_FEE);
271
272 // display page
273 $this->view->render(
274 $response,
275 'mass_add_contribution.tpl',
276 array(
277 'mode' => $request->isXhr() ? 'ajax' : '',
278 'page_title' => str_replace(
279 '%count',
280 count($data['id']),
281 _T('Mass add contribution on %count members')
282 ),
283 'form_url' => $this->router->pathFor('doMassAddContributions'),
284 'cancel_uri' => $this->router->pathFor('members'),
285 'data' => $data,
286 'contribution' => $contribution,
287 'type' => $type,
288 'require_mass' => true,
289 'required' => $contribution->getRequired(),
290 'type_cotis_options' => $contributions_types
291 )
292 );
293 return $response;
294 }
295
296 /**
297 * Do massive contribution add
298 *
299 * @param Request $request PSR Request
300 * @param Response $response PSR Response
301 *
302 * @return Response
303 */
304 public function doMassAddContributions(Request $request, Response $response): Response
305 {
306 $post = $request->getParsedBody();
307 $members_ids = $post['id'];
308 unset($post['id']);
309
310 $error_detected = [];
311
312 // flagging required fields for first step only
313 $disabled = [];
314 $success = 0;
315 $errors = 0;
316
317 foreach ($members_ids as $member_id) {
318 $post[Adherent::PK] = (int)$member_id;
319 $contrib = new Contribution($this->zdb, $this->login);
320
321 // regular fields
322 $valid = $contrib->check($post, $contrib->getRequired(), $disabled);
323 if ($valid !== true) {
324 $error_detected = array_merge($error_detected, $valid);
325 }
326
327 //all goes well, we can proceed
328 if (count($error_detected) == 0) {
329 $store = $contrib->store();
330 if ($store === true) {
331 ++$success;
332 $files_res = $contrib->handleFiles($_FILES);
333 if (is_array($files_res)) {
334 $error_detected = array_merge($error_detected, $files_res);
335 }
336 } else {
337 ++$errors;
338 }
339 }
340 }
341
342 if (count($error_detected) == 0) {
343 $redirect_url = $this->router->pathFor('members');
344 } else {
345 //something went wrong.
346 //store entity in session
347 $redirect_url = $this->router->pathFor('massAddContributions');
348 //report errors
349 foreach ($error_detected as $error) {
350 $this->flash->addMessage(
351 'error_detected',
352 $error
353 );
354 }
355 }
356
357 //redirect to calling action
358 return $response
359 ->withStatus(301)
360 ->withHeader('Location', $redirect_url);
361 }
362
363 // /CRUD - Create
364 // CRUD - Read
365
366 /**
367 * List page
368 *
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'
374 *
375 * @return Response
376 */
377 public function list(Request $request, Response $response, $option = null, $value = null, $type = null): Response
378 {
379 $ajax = false;
380 $get = $request->getQueryParams();
381
382 if (
383 $request->isXhr()
384 || isset($get['ajax'])
385 && $get['ajax'] == 'true'
386 ) {
387 $ajax = true;
388 }
389
390 $raw_type = null;
391
392 switch ($type) {
393 case 'transactions':
394 $raw_type = 'transactions';
395 break;
396 case 'contributions':
397 $raw_type = 'contributions';
398 break;
399 }
400
401 $filter_name = 'filter_' . $raw_type;
402
403 if (isset($this->session->$filter_name) && $ajax === false) {
404 $filters = $this->session->$filter_name;
405 } else {
406 $filter_class = '\\Galette\\Filters\\' . ucwords($raw_type . 'List');
407 $filters = new $filter_class();
408 }
409
410 //member id
411 if (isset($get[Adherent::PK]) && $get[Adherent::PK] > 0) {
412 $filters->filtre_cotis_adh = (int)$get[Adherent::PK];
413 }
414
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'];
419 }
420
421 if ($option !== null) {
422 switch ($option) {
423 case 'page':
424 $filters->current_page = (int)$value;
425 break;
426 case 'order':
427 $filters->orderby = $value;
428 break;
429 case 'member':
430 $filters->filtre_cotis_adh = ($value === 'all' ? null : $value);
431 break;
432 }
433 }
434
435 if (!$this->login->isAdmin() && !$this->login->isStaff() && $value != $this->login->id) {
436 if ($value == 'all') {
437 $value = null;
438 $filters->filtre_cotis_children = $this->login->id;
439 } else {
440 $member = new Adherent(
441 $this->zdb,
442 (int)$value,
443 [
444 'picture' => false,
445 'groups' => false,
446 'dues' => false,
447 'parent' => true
448 ]
449 );
450 if (
451 !$member->hasParent() ||
452 $member->hasParent() && $member->parent->id != $this->login->id
453 ) {
454 $value = $this->login->id;
455 Analog::log(
456 'Trying to display contributions for member #' . $value .
457 ' without appropriate ACLs',
458 Analog::WARNING
459 );
460 }
461 }
462 $filters->filtre_cotis_children = $value;
463 }
464
465 $class = '\\Galette\\Repository\\' . ucwords($raw_type);
466 $contrib = new $class($this->zdb, $this->login, $filters);
467 $contribs_list = $contrib->getList(true);
468
469 //store filters into session
470 if ($ajax === false) {
471 $this->session->$filter_name = $filters;
472 }
473
474 //assign pagination variables to the template and add pagination links
475 $filters->setSmartyPagination($this->router, $this->view->getSmarty());
476
477 $tpl_vars = [
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')
485 ];
486
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;
491 }
492
493 if ($filters->filtre_cotis_children != false) {
494 $member = new Adherent(
495 $this->zdb,
496 $filters->filtre_cotis_children,
497 [
498 'picture' => false,
499 'groups' => false,
500 'dues' => false,
501 'parent' => true
502 ]
503 );
504 $tpl_vars['pmember'] = $member;
505 }
506
507 // display page
508 $this->view->render(
509 $response,
510 'gestion_' . $raw_type . '.tpl',
511 $tpl_vars
512 );
513 return $response;
514 }
515
516 /**
517 * Filtering
518 *
519 * @param Request $request PSR Request
520 * @param Response $response PSR Response
521 * @param string|null $type Contribution type
522 *
523 * @return Response
524 */
525 public function filter(Request $request, Response $response, string $type = null): Response
526 {
527 $raw_type = null;
528 switch ($type) {
529 case 'transactions':
530 $raw_type = 'transactions';
531 break;
532 case 'contributions':
533 $raw_type = 'contributions';
534 break;
535 }
536
537 $type = 'filter_' . $raw_type;
538 $post = $request->getParsedBody();
539 $error_detected = [];
540
541 if ($this->session->$type !== null) {
542 $filters = $this->session->$type;
543 } else {
544 $filter_class = '\\Galette\\Filters\\' . ucwords($raw_type) . 'List';
545 $filters = new $filter_class();
546 }
547
548 if (isset($post['clear_filter'])) {
549 $filters->reinit();
550 } else {
551 if (isset($post['max_amount'])) {
552 $filters->max_amount = null;
553 }
554
555 if (
556 (isset($post['nbshow']) && is_numeric($post['nbshow']))
557 ) {
558 $filters->show = $post['nbshow'];
559 }
560
561 if (isset($post['end_date_filter']) || isset($post['start_date_filter'])) {
562 try {
563 if (isset($post['start_date_filter'])) {
564 $filters->start_date_filter = $post['start_date_filter'];
565 }
566 if (isset($post['end_date_filter'])) {
567 $filters->end_date_filter = $post['end_date_filter'];
568 }
569 } catch (Throwable $e) {
570 $error_detected[] = $e->getMessage();
571 }
572 }
573
574 if (isset($post['payment_type_filter'])) {
575 $ptf = (int)$post['payment_type_filter'];
576 $ptypes = new PaymentTypes(
577 $this->zdb,
578 $this->preferences,
579 $this->login
580 );
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;
586 } else {
587 $error_detected[] = _T("- Unknown payment type!");
588 }
589 }
590 }
591
592 $this->session->$type = $filters;
593
594 if (count($error_detected) > 0) {
595 //report errors
596 foreach ($error_detected as $error) {
597 $this->flash->addMessage(
598 'error_detected',
599 $error
600 );
601 }
602 }
603
604 return $response
605 ->withStatus(301)
606 ->withHeader('Location', $this->router->pathFor('contributions', ['type' => $raw_type]));
607 }
608
609 // /CRUD - Read
610 // CRUD - Update
611
612 /**
613 * Edit page
614 *
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
619 *
620 * @return Response
621 */
622 public function edit(Request $request, Response $response, int $id, string $type = null): Response
623 {
624 if ($this->session->contribution !== null) {
625 $contrib = $this->session->contribution;
626 $this->session->contribution = null;
627 } else {
628 $contrib = new Contribution($this->zdb, $this->login, $id);
629 if ($contrib->id == '') {
630 //not possible to load contribution, exit
631 $this->flash->addMessage(
632 'error_detected',
633 str_replace(
634 '%id',
635 $id,
636 _T("Unable to load contribution #%id!")
637 )
638 );
639 return $response
640 ->withStatus(301)
641 ->withHeader('Location', $this->router->pathFor(
642 'contributions',
643 ['type' => 'contributions']
644 ));
645 }
646 }
647
648 return $this->addEditPage($request, $response, $type, $contrib);
649 }
650
651 /**
652 * Edit action
653 *
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
658 *
659 * @return Response
660 */
661 public function doEdit(Request $request, Response $response, int $id, string $type = null): Response
662 {
663 return $this->store($request, $response, 'edit', $type, $id);
664 }
665
666 /**
667 * Store contribution (new or existing)
668 *
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
674 *
675 * @return Response
676 */
677 public function store(Request $request, Response $response, $action, string $type, $id = null): Response
678 {
679 $post = $request->getParsedBody();
680 $args = [
681 'action' => $action,
682 'type' => $type
683 ];
684 if ($id !== null) {
685 $args['id'] = $id;
686 }
687
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'];
693 return $response
694 ->withStatus(301)
695 ->withHeader('Location', $redirect_url);
696 }
697
698 $error_detected = [];
699
700 if ($this->session->contribution !== null) {
701 $contrib = $this->session->contribution;
702 $this->session->contribution = null;
703 } else {
704 if ($id === null) {
705 $contrib = new Contribution($this->zdb, $this->login);
706 } else {
707 $contrib = new Contribution($this->zdb, $this->login, $id);
708 }
709 }
710
711 $disabled = [];
712
713 // regular fields
714 $valid = $contrib->check($post, $contrib->getRequired(), $disabled);
715 if ($valid !== true) {
716 $error_detected = array_merge($error_detected, $valid);
717 }
718
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
724 }
725
726 $store = $contrib->store();
727 if ($store === true) {
728 $this->flash->addMessage(
729 'success_detected',
730 _T('Contribution has been successfully stored')
731 );
732 } else {
733 //something went wrong :'(
734 $error_detected[] = _T("An error occurred while storing the contribution.");
735 }
736 }
737
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);
742 }
743 }
744
745 if (count($error_detected) == 0) {
746 $this->session->contribution = null;
747 if ($contrib->isTransactionPart() && $contrib->transaction->getMissingAmount() > 0) {
748 //new contribution
749 $redirect_url = $this->router->pathFor(
750 'addContribution',
751 [
752 'type' => $post['contrib_type']
753 ]
754 ) . '?' . Transaction::PK . '=' . $contrib->transaction->id .
755 '&' . Adherent::PK . '=' . $contrib->member;
756 } else {
757 //contributions list for member
758 $redirect_url = $this->router->pathFor(
759 'contributions',
760 [
761 'type' => 'contributions'
762 ]
763 ) . '?' . Adherent::PK . '=' . $contrib->member;
764 }
765 } else {
766 //something went wrong.
767 //store entity in session
768 $this->session->contribution = $contrib;
769 $redirect_url = $this->router->pathFor($action . 'Contribution', $args);
770
771 //report errors
772 foreach ($error_detected as $error) {
773 $this->flash->addMessage(
774 'error_detected',
775 $error
776 );
777 }
778 }
779
780 //redirect to calling action
781 return $response
782 ->withStatus(301)
783 ->withHeader('Location', $redirect_url);
784 }
785
786 // /CRUD - Update
787 // CRUD - Delete
788
789 /**
790 * Get redirection URI
791 *
792 * @param array $args Route arguments
793 *
794 * @return string
795 */
796 public function redirectUri(array $args)
797 {
798 return $this->router->pathFor('contributions', ['type' => $args['type']]);
799 }
800
801 /**
802 * Get form URI
803 *
804 * @param array $args Route arguments
805 *
806 * @return string
807 */
808 public function formUri(array $args)
809 {
810 return $this->router->pathFor(
811 'doRemoveContribution',
812 $args
813 );
814 }
815
816 /**
817 * Get confirmation removal page title
818 *
819 * @param array $args Route arguments
820 *
821 * @return string
822 */
823 public function confirmRemoveTitle(array $args)
824 {
825 $raw_type = null;
826
827 switch ($args['type']) {
828 case 'transactions':
829 $raw_type = 'transactions';
830 break;
831 case 'contributions':
832 $raw_type = 'contributions';
833 break;
834 }
835
836 if (isset($args['ids'])) {
837 return sprintf(
838 _T('Remove %1$s %2$s'),
839 count($args['ids']),
840 ($raw_type === 'contributions') ? _T('contributions') : _T('transactions')
841 );
842 } else {
843 return sprintf(
844 _T('Remove %1$s #%2$s'),
845 ($raw_type === 'contributions') ? _T('contribution') : _T('transaction'),
846 $args['id']
847 );
848 }
849 }
850
851 /**
852 * Remove object
853 *
854 * @param array $args Route arguments
855 * @param array $post POST values
856 *
857 * @return boolean
858 */
859 protected function doDelete(array $args, array $post)
860 {
861 $raw_type = null;
862 switch ($args['type']) {
863 case 'transactions':
864 $raw_type = 'transactions';
865 break;
866 case 'contributions':
867 $raw_type = 'contributions';
868 break;
869 }
870
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);
874 return $rm;
875 }
876
877 // /CRUD - Delete
878 // /CRUD
879 }