3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette members controller
10 * Copyright © 2019-2020 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 2019-2020 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 - 2019-12-02
37 namespace Galette\Controllers\Crud
;
39 use Galette\Controllers\CrudController
;
40 use Slim\Http\Request
;
41 use Slim\Http\Response
;
42 use Galette\Core\Authentication
;
43 use Galette\Core\GaletteMail
;
44 use Galette\Core\Password
;
45 use Galette\Core\PasswordImage
;
46 use Galette\Core\Picture
;
47 use Galette\Entity\Adherent
;
48 use Galette\Entity\Contribution
;
49 use Galette\Entity\ContributionsTypes
;
50 use Galette\Entity\DynamicFieldsHandle
;
51 use Galette\Entity\Group
;
52 use Galette\Entity\Status
;
53 use Galette\Entity\FieldsConfig
;
54 use Galette\Entity\Texts
;
55 use Galette\Filters\AdvancedMembersList
;
56 use Galette\Filters\MembersList
;
58 use Galette\IO\MembersCsv
;
59 use Galette\Repository\Groups
;
60 use Galette\Repository\Members
;
61 use Galette\Repository\PaymentTypes
;
62 use Galette\Repository\Titles
;
66 * Galette members controller
68 * @category Controllers
69 * @name GaletteController
71 * @author Johan Cwiklinski <johan@x-tnd.be>
72 * @copyright 2019-2020 The Galette Team
73 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
74 * @link http://galette.tuxfamily.org
75 * @since Available since 0.9.4dev - 2019-12-02
78 class MembersController
extends CrudController
85 * @param Request $request PSR Request
86 * @param Response $response PSR Response
87 * @param array $args Request arguments
91 public function add(Request
$request, Response
$response, array $args = []): Response
93 $args['action'] = 'add';
94 return $this->edit($request, $response, $args);
98 * Self subscription page
100 * @param Request $request PSR Request
101 * @param Response $response PSR Response
102 * @param array $args Request arguments
106 public function selfSubscribe(Request
$request, Response
$response, array $args = []): Response
108 if (!$this->preferences
->pref_bool_selfsubscribe ||
$this->login
->isLogged()) {
111 ->withHeader('Location', $this->router
->pathFor('slash'));
114 if ($this->session
->member
!== null) {
115 $member = $this->session
->member
;
116 $this->session
->member
= null;
121 $member = new Adherent($this->zdb
, null, $deps);
124 //mark as self membership
125 $member->setSelfMembership();
127 // flagging required fields
128 $fc = $this->fields_config
;
129 $form_elements = $fc->getFormElements($this->login
, true, true);
131 //image to defeat mass filling forms
132 $spam = new PasswordImage();
133 $spam_pass = $spam->newImage();
134 $spam_img = $spam->getImage();
138 $members = $m->getSelectizedMembers(
140 $member->hasParent() ?
$member->parent
->id
: null
145 'filters' => $m->getFilters(),
146 'count' => $m->getCount()
150 if (count($members)) {
151 $params['members']['list'] = $members;
159 'page_title' => _T("Subscription"),
160 'parent_tpl' => 'public_page.tpl',
163 'autocomplete' => true,
166 'titles_list' => Titles
::getList($this->zdb
),
168 'spam_pass' => $spam_pass,
169 'spam_img' => $spam_img,
170 'fieldsets' => $form_elements['fieldsets'],
171 'hidden_elements' => $form_elements['hiddens']
180 * @param Request $request PSR Request
181 * @param Response $response PSR Response
182 * @param array $args Request arguments
186 public function doAdd(Request
$request, Response
$response, array $args = []): Response
188 return $this->store($request, $response, $args);
194 * @param Request $request PSR Request
195 * @param Response $response PSR Response
196 * @param array $args Request arguments
200 public function duplicate(Request
$request, Response
$response, array $args = []): Response
202 $id_adh = (int)$args[Adherent
::PK
];
203 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true, 'parent' => true]);
204 $adh->setDuplicate();
206 //store entity in session
207 $this->session
->member
= $adh;
211 ->withHeader('Location', $this->router
->pathFor('addMember'));
218 * Display member card
220 * @param Request $request PSR Request
221 * @param Response $response PSR Response
222 * @param array $args Request arguments
226 public function show(Request
$request, Response
$response, array $args): Response
228 $id = (int)$args['id'];
238 $member = new Adherent($this->zdb
, $id, $deps);
240 if (!$member->canEdit($this->login
)) {
241 $this->flash
->addMessage(
243 _T("You do not have permission for requested URL.")
250 $this->router
->pathFor('me')
254 if ($member->id
== null) {
255 //member does not exists!
256 $this->flash
->addMessage(
258 str_replace('%id', $args['id'], _T("No member #%id."))
265 $this->router
->pathFor('slash')
269 // flagging fields visibility
270 $fc = $this->fields_config
;
271 $display_elements = $fc->getDisplayElements($this->login
);
278 'page_title' => _T("Member Profile"),
280 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
281 'pref_card_self' => $this->preferences
->pref_card_self
,
282 'groups' => Groups
::getSimpleList(),
284 'display_elements' => $display_elements
293 * @param Request $request PSR Request
294 * @param Response $response PSR Response
295 * @param array $args Request arguments
299 public function showMe(Request
$request, Response
$response, array $args = []): Response
301 if ($this->login
->isSuperAdmin()) {
304 ->withHeader('Location', $this->router
->pathFor('slash'));
306 $args['show_me'] = true;
307 $args['id'] = $this->login
->id
;
308 return $this->show($request, $response, $args);
312 * Public pages (trombinoscope, public list)
314 * @param Request $request PSR Request
315 * @param Response $response PSR Response
316 * @param array $args Request arguments
320 public function publicList(Request
$request, Response
$response, array $args = []): Response
323 $type = $args['type'];
324 if (isset($args['option'])) {
325 $option = $args['option'];
328 if (isset($args['value'])) {
329 $value = $args['value'];
332 $varname = 'public_filter_' . $type;
333 if (isset($this->session
->$varname)) {
334 $filters = $this->session
->$varname;
336 $filters = new MembersList();
339 if ($option !== null) {
342 $filters->current_page
= (int)$value;
345 $filters->orderby
= $value;
350 $m = new Members($filters);
351 $members = $m->getPublicList($type === 'trombi');
353 $this->session
->$varname = $filters;
355 //assign pagination variables to the template and add pagination links
356 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
361 ($type === 'list' ?
'liste_membres' : 'trombinoscope') . '.tpl',
363 'page_title' => ($type === 'list' ?
_T("Members list") : _T('Trombinoscope')),
364 'additionnal_html_class' => ($type === 'list' ?
'' : 'trombinoscope'),
366 'members' => $members,
367 'nb_members' => $m->getCount(),
368 'filters' => $filters
375 * Public pages (trombinoscope, public list)
377 * @param Request $request PSR Request
378 * @param Response $response PSR Response
379 * @param array $args Request arguments
383 public function filterPublicList(Request
$request, Response
$response, array $args = []): Response
385 $type = $args['type'];
386 $post = $request->getParsedBody();
388 $varname = 'public_filter_' . $type;
389 if (isset($this->session
->$varname)) {
390 $filters = $this->session
->$varname;
392 $filters = new MembersList();
395 //reintialize filters
396 if (isset($post['clear_filter'])) {
399 //number of rows to show
400 if (isset($post['nbshow'])) {
401 $filters->show
= $post['nbshow'];
405 $this->session
->$varname = $filters;
409 ->withHeader('Location', $this->router
->pathFor('publicList', ['type' => $type]));
415 * @param Request $request PSR Request
416 * @param Response $response PSR Response
417 * @param array $args Request arguments
421 public function getDynamicFile(Request
$request, Response
$response, array $args): Response
423 $id = (int)$args['id'];
432 $member = new Adherent($this->zdb
, $id, $deps);
435 if (!$member->canEdit($this->login
)) {
436 $fields = $member->getDynamicFields()->getFields();
437 if (!isset($fields[$args['fid']])) {
438 //field does not exists or access is forbidden
445 if ($denied === true) {
446 $this->flash
->addMessage(
448 _T("You do not have permission for requested URL.")
455 $this->router
->pathFor(
462 $filename = str_replace(
473 'member_%mid_field_%fid_value_%pos'
476 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
477 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
478 $response = $response
479 ->withHeader('Content-Type', $type)
480 ->withHeader('Content-Disposition', 'attachment;filename="' . $args['name'] . '"')
481 ->withHeader('Pragma', 'no-cache');
482 $response->write(readfile(GALETTE_FILES_PATH
. $filename));
486 'A request has been made to get an exported file named `' .
487 $filename . '` that does not exists.',
491 $this->flash
->addMessage(
493 _T("The file does not exists or cannot be read :(")
500 $this->router
->pathFor('member', ['id' => $args['id']])
508 * @param Request $request PSR Request
509 * @param Response $response PSR Response
510 * @param array $args Request arguments
514 public function list(Request
$request, Response
$response, array $args = []): Response
516 $option = $args['option'] ??
null;
517 $value = $args['value'] ??
null;
519 if (isset($this->session
->filter_members
)) {
520 $filters = $this->session
->filter_members
;
522 $filters = new MembersList();
525 if ($option !== null) {
528 $filters->current_page
= (int)$value;
531 $filters->orderby
= $value;
536 $members = new Members($filters);
538 $members_list = array();
539 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
540 $members_list = $members->getMembersList(true);
542 $members_list = $members->getManagedMembersList(true);
545 $groups = new Groups($this->zdb
, $this->login
);
546 $groups_list = $groups->getList();
548 //assign pagination variables to the template and add pagination links
549 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
550 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
552 $this->session
->filter_members
= $filters;
557 'gestion_adherents.tpl',
559 'page_title' => _T("Members management"),
560 'require_mass' => true,
561 'members' => $members_list,
562 'filter_groups_options' => $groups_list,
563 'nb_members' => $members->getCount(),
564 'filters' => $filters,
565 'adv_filters' => $filters instanceof AdvancedMembersList
,
566 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
575 * @param Request $request PSR Request
576 * @param Response $response PSR Response
580 public function filter(Request
$request, Response
$response): Response
582 $post = $request->getParsedBody();
583 if (isset($this->session
->filter_members
)) {
584 //CAUTION: this one may be simple or advanced, display must change
585 $filters = $this->session
->filter_members
;
587 $filters = new MembersList();
590 //reintialize filters
591 if (isset($post['clear_filter'])) {
592 $filters = new MembersList();
593 } elseif (isset($post['clear_adv_filter'])) {
594 $this->session
->filter_members
= null;
595 unset($this->session
->filter_members
);
599 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
600 } elseif (isset($post['adv_criteria'])) {
603 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
606 if (isset($post['filter_str'])) { //filter search string
607 $filters->filter_str
= stripslashes(
608 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
612 if (isset($post['field_filter'])) {
613 if (is_numeric($post['field_filter'])) {
614 $filters->field_filter
= $post['field_filter'];
617 //membership to filter
618 if (isset($post['membership_filter'])) {
619 if (is_numeric($post['membership_filter'])) {
620 $filters->membership_filter
621 = $post['membership_filter'];
624 //account status to filter
625 if (isset($post['filter_account'])) {
626 if (is_numeric($post['filter_account'])) {
627 $filters->filter_account
= $post['filter_account'];
631 if (isset($post['email_filter'])) {
632 $filters->email_filter
= (int)$post['email_filter'];
636 isset($post['group_filter'])
637 && $post['group_filter'] > 0
639 $filters->group_filter
= (int)$post['group_filter'];
641 //number of rows to show
642 if (isset($post['nbshow'])) {
643 $filters->show
= $post['nbshow'];
646 if (isset($post['advanced_filtering'])) {
647 if (!$filters instanceof AdvancedMembersList
) {
648 $filters = new AdvancedMembersList($filters);
652 unset($post['advanced_filtering']);
654 foreach ($post as $k => $v) {
655 if (strpos($k, 'free_', 0) === 0) {
658 foreach ($post['free_field'] as $f) {
661 && trim($post['free_text'][$i]) !== ''
663 $fs_search = $post['free_text'][$i];
665 = (int)$post['free_logical_operator'][$i];
667 = (int)$post['free_query_operator'][$i];
668 $type = (int)$post['free_type'][$i];
673 'search' => $fs_search,
677 $filters->free_search
= $fs;
683 } elseif ($k == 'groups_search') {
685 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
686 foreach ($post['groups_search'] as $g) {
687 if (trim($g) !== '') {
692 $filters->groups_search
= $gs;
698 case 'contrib_min_amount':
699 case 'contrib_max_amount':
700 if (trim($v) !== '') {
713 if (isset($post['savesearch'])) {
718 $this->router
->pathFor(
725 $this->session
->filter_members
= $filters;
729 ->withHeader('Location', $this->router
->pathFor('members'));
733 * Advanced search page
735 * @param Request $request PSR Request
736 * @param Response $response PSR Response
740 public function advancedSearch(Request
$request, Response
$response): Response
742 if (isset($this->session
->filter_members
)) {
743 $filters = $this->session
->filter_members
;
744 if (!$filters instanceof AdvancedMembersList
) {
745 $filters = new AdvancedMembersList($filters);
748 $filters = new AdvancedMembersList();
751 $groups = new Groups($this->zdb
, $this->login
);
752 $groups_list = $groups->getList();
754 //we want only visibles fields
755 $fields = $this->members_fields
;
756 $fc = $this->fields_config
;
757 $visibles = $fc->getVisibilities();
758 $access_level = $this->login
->getAccessLevel();
760 //remove not searchable fields
761 unset($fields['mdp_adh']);
763 foreach ($fields as $k => $f) {
765 $visibles[$k] == FieldsConfig
::NOBODY ||
766 ($visibles[$k] == FieldsConfig
::ADMIN
&&
767 $access_level < Authentication
::ACCESS_ADMIN
) ||
768 ($visibles[$k] == FieldsConfig
::STAFF
&&
769 $access_level < Authentication
::ACCESS_STAFF
) ||
770 ($visibles[$k] == FieldsConfig
::MANAGER
&&
771 $access_level < Authentication
::ACCESS_MANAGER
)
777 //add status label search
778 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
779 $fields = array_slice($fields, 0, $pos, true) +
780 ['status_label' => ['label' => _T('Status label')]] +
781 array_slice($fields, $pos, count($fields) - 1, true);
793 $member = new Adherent($this->zdb
, $this->login
->login
, $deps);
794 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
796 $contrib = new Contribution($this->zdb
, $this->login
);
797 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
800 $statuts = new Status($this->zdb
);
802 //Contributions types
803 $ct = new ContributionsTypes($this->zdb
);
806 $ptypes = new PaymentTypes(
811 $ptlist = $ptypes->getList();
813 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
818 'advanced_search.tpl',
820 'page_title' => _T("Advanced search"),
821 'filter_groups_options' => $groups_list,
822 'search_fields' => $fields,
823 'adh_dynamics' => $adh_dynamics->getFields(),
824 'contrib_dynamics' => $contrib_dynamics->getFields(),
825 'statuts' => $statuts->getList(),
826 'contributions_types' => $ct->getList(),
827 'filters' => $filters,
828 'payments_types' => $ptlist
835 * Members list for ajax
837 * @param Request $request PSR Request
838 * @param Response $response PSR Response
839 * @param array $args Request arguments
843 public function ajaxList(Request
$request, Response
$response, array $args = []): Response
845 $post = $request->getParsedBody();
847 if (isset($this->session
->ajax_members_filters
)) {
848 $filters = $this->session
->ajax_members_filters
;
850 $filters = new MembersList();
853 if (isset($args['option']) && $args['option'] == 'page') {
854 $filters->current_page
= (int)$args['value'];
857 //numbers of rows to display
858 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
859 $filters->show
= $post['nbshow'];
862 $members = new Members($filters);
863 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
864 if ($this->login
->isGroupManager()) {
865 $members_list = $members->getManagedMembersList(true);
870 [$this->login
->id
, $this->login
->login
],
871 'Trying to list group members without access from #%id (%login)'
875 throw new \
Exception('Access denied.');
878 $members_list = $members->getMembersList(true);
881 //assign pagination variables to the template and add pagination links
882 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
884 $this->session
->ajax_members_filters
= $filters;
886 $selected_members = null;
887 $unreachables_members = null;
888 if (!isset($post['from'])) {
889 $mailing = $this->session
->mailing
;
890 if (!isset($post['members'])) {
891 $selected_members = $mailing->recipients
;
892 $unreachables_members = $mailing->unreachables
;
895 $selected_members = $m->getArrayList($post['members']);
896 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
897 $unreachables_members = $m->getArrayList($post['unreachables']);
901 switch ($post['from']) {
903 if (!isset($post['gid'])) {
905 'Trying to list group members with no group id provided',
908 throw new \
Exception('A group id is required.');
911 if (!isset($post['members'])) {
912 $group = new Group((int)$post['gid']);
913 $selected_members = array();
914 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
915 $selected_members = $group->getMembers();
916 } elseif ($post['mode'] == 'managers') {
917 $selected_members = $group->getManagers();
920 'Trying to list group members with unknown mode',
923 throw new \
Exception('Unknown mode.');
928 $selected_members = $m->getArrayList($post['members']);
929 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
930 $unreachables_members = $m->getArrayList($post['unreachables']);
935 if (!isset($post['id_adh'])) {
936 throw new \
RuntimeException(
937 'Current selected member must be excluded while attaching!'
946 'filters' => $filters,
947 'members_list' => $members_list,
948 'selected_members' => $selected_members,
949 'unreachables_members' => $unreachables_members
952 if (isset($post['multiple'])) {
953 $params['multiple'] = true;
956 if (isset($post['gid'])) {
957 $params['the_id'] = $post['gid'];
960 if (isset($post['id_adh'])) {
961 $params['excluded'] = $post['id_adh'];
974 * Batch actions handler
976 * @param Request $request PSR Request
977 * @param Response $response PSR Response
981 public function handleBatch(Request
$request, Response
$response): Response
983 $post = $request->getParsedBody();
985 if (isset($post['member_sel'])) {
986 if (isset($this->session
->filter_members
)) {
987 $filters = $this->session
->filter_members
;
989 $filters = new MembersList();
992 $filters->selected
= $post['member_sel'];
993 $this->session
->filter_members
= $filters;
995 if (isset($post['cards'])) {
998 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
1001 if (isset($post['labels'])) {
1004 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
1007 if (isset($post['mailing'])) {
1010 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
1013 if (isset($post['attendance_sheet'])) {
1016 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
1019 if (isset($post['csv'])) {
1022 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
1025 if (isset($post['delete'])) {
1028 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
1031 if (isset($post['masschange'])) {
1034 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
1037 throw new \
RuntimeException('Does not know what to batch :(');
1039 $this->flash
->addMessage(
1041 _T("No member was selected, please check at least one name.")
1046 ->withHeader('Location', $this->router
->pathFor('members'));
1056 * @param Request $request PSR Request
1057 * @param Response $response PSR Response
1058 * @param array $args Request arguments
1062 public function edit(Request
$request, Response
$response, array $args = []): Response
1064 $action = $args['action'] ??
'edit';
1066 if (isset($args['id'])) {
1067 $id = (int)$args['id'];
1079 if ($this->session
->member
!== null) {
1080 $member = $this->session
->member
;
1081 $this->session
->member
= null;
1083 $member = new Adherent($this->zdb
, $id, $deps);
1088 if (!$member->canEdit($this->login
)) {
1089 $this->flash
->addMessage(
1091 _T("You do not have permission for requested URL.")
1098 $this->router
->pathFor('me')
1102 if ($member->id
!= $id) {
1103 $member->load($this->login
->id
);
1107 // flagging required fields
1108 $fc = $this->fields_config
;
1110 // password required if we create a new member
1111 if ($member->id
!= '') {
1112 $fc->setNotRequired('mdp_adh');
1115 //handle requirements for parent fields
1116 $parent_fields = $member->getParentFields();
1117 $tpl_parent_fields = []; //for JS when detaching
1118 foreach ($parent_fields as $field) {
1119 if ($fc->isRequired($field)) {
1120 $tpl_parent_fields[] = $field;
1121 if ($member->hasParent()) {
1122 $fc->setNotRequired($field);
1127 // flagging required fields invisible to members
1128 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1129 $fc->setNotRequired('activite_adh');
1130 $fc->setNotRequired('id_statut');
1133 // template variable declaration
1134 $title = _T("Member Profile");
1135 if ($member->id
!= '') {
1136 $title .= ' (' . _T("modification") . ')';
1138 $title .= ' (' . _T("creation") . ')';
1142 $statuts = new Status($this->zdb
);
1145 $groups = new Groups($this->zdb
, $this->login
);
1146 $groups_list = $groups->getSimpleList(true);
1148 $form_elements = $fc->getFormElements(
1156 if ($member->hasParent()) {
1157 $id = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1159 $members = $m->getSelectizedMembers(
1164 $route_params['members'] = [
1165 'filters' => $m->getFilters(),
1166 'count' => $m->getCount()
1169 if (count($members)) {
1170 $route_params['members']['list'] = $members;
1174 $this->view
->render(
1178 'parent_tpl' => 'page.tpl',
1179 'autocomplete' => true,
1180 'page_title' => $title,
1181 'member' => $member,
1182 'self_adh' => false,
1183 // pseudo random int
1185 'titles_list' => Titles
::getList($this->zdb
),
1186 'statuts' => $statuts->getList(),
1187 'groups' => $groups_list,
1188 'fieldsets' => $form_elements['fieldsets'],
1189 'hidden_elements' => $form_elements['hiddens'],
1190 'parent_fields' => $tpl_parent_fields
1199 * @param Request $request PSR Request
1200 * @param Response $response PSR Response
1201 * @param array $args Request arguments
1205 public function doEdit(Request
$request, Response
$response, array $args = []): Response
1207 return $this->store($request, $response, $args);
1211 * Massive change page
1213 * @param Request $request PSR Request
1214 * @param Response $response PSR Response
1215 * @param array $args Request arguments
1219 public function massChange(Request
$request, Response
$response, array $args = []): Response
1221 $filters = $this->session
->filter_members
;
1224 'id' => $filters->selected
,
1225 'redirect_uri' => $this->router
->pathFor('members')
1228 $fc = $this->fields_config
;
1229 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1237 'children' => false,
1240 $member = new Adherent($this->zdb
, null, $deps);
1243 $statuts = new Status($this->zdb
);
1246 $this->view
->render(
1248 'mass_change_members.tpl',
1250 'mode' => $request->isXhr() ?
'ajax' : '',
1251 'page_title' => str_replace(
1254 _T('Mass change %count members')
1256 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1257 'cancel_uri' => $this->router
->pathFor('members'),
1259 'member' => $member,
1260 'fieldsets' => $form_elements['fieldsets'],
1261 'titles_list' => Titles
::getList($this->zdb
),
1262 'statuts' => $statuts->getList(),
1263 'require_mass' => true
1270 * Massive changes validation page
1272 * @param Request $request PSR Request
1273 * @param Response $response PSR Response
1274 * @param array $args Request arguments
1278 public function validateMassChange(Request
$request, Response
$response, array $args = []): Response
1280 $post = $request->getParsedBody();
1282 if (!isset($post['confirm'])) {
1283 $this->flash
->addMessage(
1285 _T("Mass changes has not been confirmed!")
1288 //we want only visibles fields
1289 $fc = $this->fields_config
;
1290 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1293 foreach ($form_elements['fieldsets'] as $form_element) {
1294 foreach ($form_element->elements
as $field) {
1296 isset($post['mass_' . $field->field_id
])
1297 && (isset($post[$field->field_id
]) ||
$field->type
=== FieldsConfig
::TYPE_BOOL
)
1299 $changes[$field->field_id
] = [
1300 'label' => $field->label
,
1301 'value' => $post[$field->field_id
] ??
0
1308 $filters = $this->session
->filter_members
;
1310 'id' => $filters->selected
,
1311 'redirect_uri' => $this->router
->pathFor('members')
1315 $statuts = new Status($this->zdb
);
1318 $this->view
->render(
1320 'mass_change_members.tpl',
1322 'mode' => $request->isXhr() ?
'ajax' : '',
1323 'page_title' => str_replace(
1326 _T('Review mass change %count members')
1328 'form_url' => $this->router
->pathFor('massstoremembers'),
1329 'cancel_uri' => $this->router
->pathFor('members'),
1331 'titles_list' => Titles
::getList($this->zdb
),
1332 'statuts' => $statuts->getList(),
1333 'changes' => $changes
1340 * Do massive changes
1342 * @param Request $request PSR Request
1343 * @param Response $response PSR Response
1344 * @param array $args Request arguments
1348 public function doMassChange(Request
$request, Response
$response, array $args = []): Response
1350 $post = $request->getParsedBody();
1351 $redirect_url = $post['redirect_uri'];
1352 $error_detected = [];
1355 unset($post['redirect_uri']);
1356 if (!isset($post['confirm'])) {
1357 $error_detected[] = _T("Mass changes has not been confirmed!");
1359 unset($post['confirm']);
1363 $fc = $this->fields_config
;
1364 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1365 $disabled = $this->members_fields
;
1366 foreach (array_keys($post) as $key) {
1368 foreach ($form_elements['fieldsets'] as $fieldset) {
1369 if (isset($fieldset->elements
[$key])) {
1376 'Permission issue mass editing field ' . $key,
1381 unset($disabled[$key]);
1385 if (!count($post)) {
1386 $error_detected[] = _T("Nothing to do!");
1388 foreach ($ids as $id) {
1389 $is_manager = !$this->login
->isAdmin()
1390 && !$this->login
->isStaff()
1391 && $this->login
->isGroupManager();
1394 'groups' => $is_manager,
1397 'children' => false,
1400 $member = new Adherent($this->zdb
, (int)$id, $deps);
1401 $member->setDependencies(
1403 $this->members_fields
,
1406 if (!$member->canEdit($this->login
)) {
1410 $valid = $member->check($post, [], $disabled);
1411 if ($valid === true) {
1412 $done = $member->store();
1414 $error_detected[] = _T("An error occurred while storing the member.");
1419 $error_detected = array_merge($error_detected, $valid);
1425 if ($mass == 0 && !count($error_detected)) {
1426 $error_detected[] = _T('Something went wront during mass edition!');
1428 $this->flash
->addMessage(
1433 _T('%count members has been changed successfully!')
1438 if (count($error_detected) > 0) {
1439 foreach ($error_detected as $error) {
1440 $this->flash
->addMessage(
1447 if (!$request->isXhr()) {
1450 ->withHeader('Location', $redirect_url);
1452 return $response->withJson(
1454 'success' => count($error_detected) === 0
1463 * @param Request $request PSR Request
1464 * @param Response $response PSR Response
1465 * @param array $args Request arguments
1469 public function store(Request
$request, Response
$response, array $args = []): Response
1471 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1474 ->withHeader('Location', $this->router
->pathFor('slash'));
1477 $post = $request->getParsedBody();
1486 $member = new Adherent($this->zdb
, null, $deps);
1487 $member->setDependencies(
1489 $this->members_fields
,
1492 if (isset($args['self'])) {
1493 //mark as self membership
1494 $member->setSelfMembership();
1497 $success_detected = [];
1498 $warning_detected = [];
1499 $error_detected = [];
1502 if (isset($args['self'])) {
1505 ||
!$post['mdp_adh']
1506 ||
!crypt($post['mdp_adh'], $post['mdp_crypt']) == $post['mdp_crypt']
1508 $error_detected[] = __('Please repeat in the field the password shown in the image.');
1510 unset($post['mdp_adh']);
1511 unset($post['mdp_crypt']);
1516 $adherent['id_adh'] = get_numeric_form_value('id_adh', '');
1517 if ($this->login
->isAdmin() ||
$this->login
->isStaff() ||
$this->login
->isGroupManager()) {
1518 if ($adherent['id_adh']) {
1519 $member->load((int)$adherent['id_adh']);
1520 if (!$member->canEdit($this->login
)) {
1521 //redirection should have been done before. Just throw an Exception.
1522 throw new \
RuntimeException(
1526 'No right to store member #%id'
1532 $member->load($this->login
->id
);
1533 $adherent['id_adh'] = $this->login
->id
;
1536 // flagging required fields
1537 $fc = $this->fields_config
;
1539 // password required if we create a new member but not from self subscription
1540 if ($member->id
!= '' ||
isset($args['self'])) {
1541 $fc->setNotRequired('mdp_adh');
1545 $member->hasParent() && !isset($post['detach_parent'])
1546 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1548 $parent_fields = $member->getParentFields();
1549 foreach ($parent_fields as $field) {
1550 if ($fc->isRequired($field)) {
1551 $fc->setNotRequired($field);
1556 // flagging required fields invisible to members
1557 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1558 $fc->setNotRequired('activite_adh');
1559 $fc->setNotRequired('id_statut');
1562 $form_elements = $fc->getFormElements(
1565 isset($args['self'])
1567 $fieldsets = $form_elements['fieldsets'];
1568 $required = array();
1569 $disabled = array();
1571 foreach ($fieldsets as $category) {
1572 foreach ($category->elements
as $field) {
1573 if ($field->required
== true) {
1574 $required[$field->field_id
] = true;
1576 if ($field->disabled
== true) {
1577 $disabled[$field->field_id
] = true;
1578 } elseif (!isset($post[$field->field_id
])) {
1579 switch ($field->field_id
) {
1580 //unchecked booleans are not sent from form
1581 case 'bool_admin_adh':
1582 case 'bool_exempt_adh':
1583 case 'bool_display_info':
1584 $post[$field->field_id
] = 0;
1591 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1594 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1595 if (isset($post[array_shift($real_requireds)])) {
1597 $valid = $member->check($post, $required, $disabled);
1598 if ($valid !== true) {
1599 $error_detected = array_merge($error_detected, $valid);
1602 if (count($error_detected) == 0) {
1603 //all goes well, we can proceed
1606 if ($member->id
== '') {
1610 // send email to member
1611 if (isset($args['self']) ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1612 $member->setSendmail(); //flag to send creation email
1615 $store = $member->store();
1616 if ($store === true) {
1617 //member has been stored :)
1619 if (isset($args['self'])) {
1620 $success_detected[] = _T("Your account has been created!");
1622 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1623 && $member->getEmail() != ''
1625 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1628 $success_detected[] = _T("New member has been successfully added.");
1631 $success_detected[] = _T("Member account has been modified.");
1634 //store requested groups
1637 $managed_groups_adh = null;
1639 //add/remove user from groups
1640 if (isset($post['groups_adh'])) {
1641 $groups_adh = $post['groups_adh'];
1643 $add_groups = Groups
::addMemberToGroups(
1648 if ($add_groups === false) {
1649 $error_detected[] = _T("An error occurred adding member to its groups.");
1652 //add/remove manager from groups
1653 if (isset($post['groups_managed_adh'])) {
1654 $managed_groups_adh = $post['groups_managed_adh'];
1656 $add_groups = Groups
::addMemberToGroups(
1658 $managed_groups_adh,
1661 $member->loadGroups();
1663 if ($add_groups === false) {
1664 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1667 //something went wrong :'(
1668 $error_detected[] = _T("An error occurred while storing the member.");
1672 if (count($error_detected) === 0) {
1673 $files_res = $member->handleFiles($_FILES);
1674 if (is_array($files_res)) {
1675 $error_detected = array_merge($error_detected, $files_res);
1678 if (isset($post['del_photo'])) {
1679 if (!$member->picture
->delete($member->id
)) {
1680 $error_detected[] = _T("Delete failed");
1681 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1683 'Unable to delete picture for member ' . $str_adh,
1690 if (count($error_detected) > 0) {
1691 foreach ($error_detected as $error) {
1692 if (strpos($error, '%member_url_') !== false) {
1693 preg_match('/%member_url_(\d+)/', $error, $matches);
1694 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1695 $error = str_replace(
1696 '%member_url_' . $matches[1],
1701 $this->flash
->addMessage(
1708 if (count($warning_detected) > 0) {
1709 foreach ($warning_detected as $warning) {
1710 $this->flash
->addMessage(
1716 if (count($success_detected) > 0) {
1717 foreach ($success_detected as $success) {
1718 $this->flash
->addMessage(
1725 if (count($error_detected) === 0) {
1726 if (isset($args['self'])) {
1727 $redirect_url = $this->router
->pathFor('login');
1729 isset($post['redirect_on_create'])
1730 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1732 switch ($post['redirect_on_create']) {
1733 case Adherent
::AFTER_ADD_TRANS
:
1734 $redirect_url = $this->router
->pathFor('addTransaction');
1736 case Adherent
::AFTER_ADD_NEW
:
1737 $redirect_url = $this->router
->pathFor('addMember');
1739 case Adherent
::AFTER_ADD_SHOW
:
1740 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1742 case Adherent
::AFTER_ADD_LIST
:
1743 $redirect_url = $this->router
->pathFor('members');
1745 case Adherent
::AFTER_ADD_HOME
:
1746 $redirect_url = $this->router
->pathFor('slash');
1749 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1750 $redirect_url = $this->router
->pathFor(
1753 ) . '?id_adh=' . $member->id
;
1755 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1758 //store entity in session
1759 $this->session
->member
= $member;
1761 if (isset($args['self'])) {
1762 $redirect_url = $this->router
->pathFor('subscribe');
1765 $redirect_url = $this->router
->pathFor(
1767 ['id' => $member->id
]
1770 $redirect_url = $this->router
->pathFor('addMember');
1778 ->withHeader('Location', $redirect_url);
1786 * Get redirection URI
1788 * @param array $args Route arguments
1792 public function redirectUri(array $args = [])
1794 return $this->router
->pathFor('members');
1800 * @param array $args Route arguments
1804 public function formUri(array $args = [])
1806 return $this->router
->pathFor(
1816 * In simple cases, we get the ID in the route arguments; but for
1817 * batchs, it should be found elsewhere.
1818 * In post values, we look for id key, as well as all {sthing}_sel keys (like members_sel or contrib_sel)
1820 * @param array $args Request arguments
1821 * @param array $post POST values
1823 * @return null|integer|integer[]
1825 protected function getIdsToRemove(&$args, $post)
1827 if (isset($args['id'])) {
1830 $filters = $this->session
->filter_members
;
1831 return $filters->selected
;
1836 * Get confirmation removal page title
1838 * @param array $args Route arguments
1842 public function confirmRemoveTitle(array $args = [])
1844 if (isset($args['id_adh'])) {
1845 //one member removal
1846 $adh = new Adherent($this->zdb
, (int)$args['id_adh']);
1848 _T('Remove member %1$s'),
1852 //batch members removal
1853 $filters = $this->session
->filter_members
;
1856 count($filters->selected
),
1857 _T('You are about to remove %count members.')
1865 * @param array $args Route arguments
1866 * @param array $post POST values
1870 protected function doDelete(array $args, array $post)
1872 if (isset($this->session
->filter_members
)) {
1873 $filters = $this->session
->filter_members
;
1875 $filters = new MembersList();
1877 $members = new Members($filters);
1879 if (!is_array($post['id'])) {
1880 $ids = (array)$post['id'];
1885 return $members->removeMembers($ids);