3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette members controller
10 * Copyright © 2019-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 2019-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 - 2019-12-02
37 namespace Galette\Controllers\Crud
;
39 use Galette\Controllers\CrudController
;
40 use Galette\DynamicFields\Boolean
;
41 use Slim\Http\Request
;
42 use Slim\Http\Response
;
43 use Galette\Core\GaletteMail
;
44 use Galette\Core\Gaptcha
;
45 use Galette\Entity\Adherent
;
46 use Galette\Entity\Contribution
;
47 use Galette\Entity\ContributionsTypes
;
48 use Galette\Entity\DynamicFieldsHandle
;
49 use Galette\Entity\Group
;
50 use Galette\Entity\Status
;
51 use Galette\Entity\FieldsConfig
;
52 use Galette\Filters\AdvancedMembersList
;
53 use Galette\Filters\MembersList
;
55 use Galette\Repository\Groups
;
56 use Galette\Repository\Members
;
57 use Galette\Repository\PaymentTypes
;
58 use Galette\Repository\Titles
;
62 * Galette members controller
64 * @category Controllers
65 * @name GaletteController
67 * @author Johan Cwiklinski <johan@x-tnd.be>
68 * @copyright 2019-2021 The Galette Team
69 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
70 * @link http://galette.tuxfamily.org
71 * @since Available since 0.9.4dev - 2019-12-02
74 class MembersController
extends CrudController
77 private $is_self_membership = false;
84 * @param Request $request PSR Request
85 * @param Response $response PSR Response
89 public function add(Request
$request, Response
$response): Response
91 return $this->edit($request, $response, null, 'add');
97 * @param Request $request PSR Request
98 * @param Response $response PSR Response
102 public function addChild(Request
$request, Response
$response): Response
104 return $this->edit($request, $response, null, 'addchild');
108 * Self subscription page
110 * @param Request $request PSR Request
111 * @param Response $response PSR Response
115 public function selfSubscribe(Request
$request, Response
$response): Response
117 if (!$this->preferences
->pref_bool_selfsubscribe ||
$this->login
->isLogged()) {
120 ->withHeader('Location', $this->router
->pathFor('slash'));
123 if ($this->session
->member
!== null) {
124 $member = $this->session
->member
;
125 $this->session
->member
= null;
127 $member = new Adherent($this->zdb
);
128 $member->enableDep('dynamics');
131 //mark as self membership
132 $member->setSelfMembership();
134 // flagging required fields
135 $fc = $this->fields_config
;
136 $form_elements = $fc->getFormElements($this->login
, true, true);
140 $members = $m->getSelectizedMembers(
142 $member->hasParent() ?
$member->parent
->id
: null
147 'filters' => $m->getFilters(),
148 'count' => $m->getCount()
152 if (count($members)) {
153 $params['members']['list'] = $members;
156 $gaptcha = new Gaptcha($this->i18n
);
157 $this->session
->gaptcha
= $gaptcha;
163 'page_title' => _T("Subscription"),
164 'parent_tpl' => 'public_page.tpl',
167 'autocomplete' => true,
170 'titles_list' => Titles
::getList($this->zdb
),
171 'fieldsets' => $form_elements['fieldsets'],
172 'hidden_elements' => $form_elements['hiddens'],
174 'gaptcha' => $gaptcha
183 * @param Request $request PSR Request
184 * @param Response $response PSR Response
188 public function doAdd(Request
$request, Response
$response): Response
190 return $this->store($request, $response);
194 * Self subscription add action
196 * @param Request $request PSR Request
197 * @param Response $response PSR Response
201 public function doSelfSubscribe(Request
$request, Response
$response): Response
203 $this->setSelfMembership();
204 return $this->doAdd($request, $response);
211 * @param Request $request PSR Request
212 * @param Response $response PSR Response
213 * @param integer $id_adh Member ID to duplicate
217 public function duplicate(Request
$request, Response
$response, int $id_adh): Response
219 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true, 'parent' => true]);
220 $adh->setDuplicate();
222 //store entity in session
223 $this->session
->member
= $adh;
227 ->withHeader('Location', $this->router
->pathFor('addMember'));
234 * Display member card
236 * @param Request $request PSR Request
237 * @param Response $response PSR Response
238 * @param integer $id Member ID
242 public function show(Request
$request, Response
$response, int $id): Response
244 $member = new Adherent($this->zdb
);
249 if (!$member->canShow($this->login
)) {
250 $this->flash
->addMessage(
252 _T("You do not have permission for requested URL.")
259 $this->router
->pathFor('me')
263 if ($member->id
== null) {
264 //member does not exists!
265 $this->flash
->addMessage(
267 str_replace('%id', $id, _T("No member #%id."))
274 $this->router
->pathFor('slash')
278 // flagging fields visibility
279 $fc = $this->fields_config
;
280 $display_elements = $fc->getDisplayElements($this->login
);
287 'page_title' => _T("Member Profile"),
289 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
290 'pref_card_self' => $this->preferences
->pref_card_self
,
291 'groups' => Groups
::getSimpleList(),
293 'display_elements' => $display_elements
302 * @param Request $request PSR Request
303 * @param Response $response PSR Response
307 public function showMe(Request
$request, Response
$response): Response
309 if ($this->login
->isSuperAdmin()) {
312 ->withHeader('Location', $this->router
->pathFor('slash'));
314 return $this->show($request, $response, $this->login
->id
);
318 * Public pages (trombinoscope, public list)
320 * @param Request $request PSR Request
321 * @param Response $response PSR Response
322 * @param string $option One of 'page' or 'order'
323 * @param string|integer $value Value of the option
324 * @param string $type List type (either list or trombi)
328 public function publicList(
335 $varname = 'public_filter_' . $type;
336 if (isset($this->session
->$varname)) {
337 $filters = $this->session
->$varname;
339 $filters = new MembersList();
342 if ($option !== null) {
345 $filters->current_page
= (int)$value;
348 $filters->orderby
= $value;
353 $m = new Members($filters);
354 $members = $m->getPublicList($type === 'trombi');
356 $this->session
->$varname = $filters;
358 //assign pagination variables to the template and add pagination links
359 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
364 ($type === 'list' ?
'liste_membres' : 'trombinoscope') . '.tpl',
366 'page_title' => ($type === 'list' ?
_T("Members list") : _T('Trombinoscope')),
367 'additionnal_html_class' => ($type === 'list' ?
'' : 'trombinoscope'),
369 'members' => $members,
370 'nb_members' => $m->getCount(),
371 'filters' => $filters
378 * Public pages (trombinoscope, public list)
380 * @param Request $request PSR Request
381 * @param Response $response PSR Response
382 * @param string $type Type
386 public function filterPublicList(Request
$request, Response
$response, string $type): Response
388 $post = $request->getParsedBody();
390 $varname = 'public_filter_' . $type;
391 if (isset($this->session
->$varname)) {
392 $filters = $this->session
->$varname;
394 $filters = new MembersList();
397 //reintialize filters
398 if (isset($post['clear_filter'])) {
401 //number of rows to show
402 if (isset($post['nbshow'])) {
403 $filters->show
= (int)$post['nbshow'];
407 $this->session
->$varname = $filters;
411 ->withHeader('Location', $this->router
->pathFor('publicList', ['type' => $type]));
417 * @param Request $request PSR Request
418 * @param Response $response PSR Response
419 * @param integer $id Member ID
420 * @param integer $fid Dynamic fields ID
421 * @param integer $pos Dynamic field position
422 * @param string $name File name
426 public function getDynamicFile(
434 $member = new Adherent($this->zdb
);
437 ->enableDep('dynamics')
441 if (!$member->canShow($this->login
)) {
442 $fields = $member->getDynamicFields()->getFields();
443 if (!isset($fields[$fid])) {
444 //field does not exists or access is forbidden
451 if ($denied === true) {
452 $this->flash
->addMessage(
454 _T("You do not have permission for requested URL.")
461 $this->router
->pathFor(
468 $filename = str_replace(
479 'member_%mid_field_%fid_value_%pos'
482 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
483 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
485 $response = $response->withHeader('Content-Description', 'File Transfer')
486 ->withHeader('Content-Type', $type)
487 ->withHeader('Content-Disposition', 'attachment;filename="' . $name . '"')
488 ->withHeader('Pragma', 'no-cache')
489 ->withHeader('Content-Transfer-Encoding', 'binary')
490 ->withHeader('Expires', '0')
491 ->withHeader('Cache-Control', 'must-revalidate')
492 ->withHeader('Pragma', 'public');
494 $stream = fopen('php://memory', 'r+');
495 fwrite($stream, file_get_contents(GALETTE_FILES_PATH
. $filename));
498 return $response->withBody(new \Slim\Http\
Stream($stream));
501 'A request has been made to get a dynamic file named `' .
502 $filename . '` that does not exists.',
506 $this->flash
->addMessage(
508 _T("The file does not exists or cannot be read :(")
515 $this->router
->pathFor('member', ['id' => $id])
523 * @param Request $request PSR Request
524 * @param Response $response PSR Response
525 * @param string $option One of 'page' or 'order'
526 * @param string|integer $value Value of the option
530 public function list(Request
$request, Response
$response, $option = null, $value = null): Response
532 if (isset($this->session
->filter_members
)) {
533 $filters = $this->session
->filter_members
;
535 $filters = new MembersList();
538 if ($option !== null) {
541 $filters->current_page
= (int)$value;
544 $filters->orderby
= $value;
549 $members = new Members($filters);
551 $members_list = array();
552 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
553 $members_list = $members->getMembersList(true);
555 $members_list = $members->getManagedMembersList(true);
558 $groups = new Groups($this->zdb
, $this->login
);
559 $groups_list = $groups->getList();
561 //assign pagination variables to the template and add pagination links
562 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
563 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
565 $this->session
->filter_members
= $filters;
570 'gestion_adherents.tpl',
572 'page_title' => _T("Members management"),
573 'require_mass' => true,
574 'members' => $members_list,
575 'filter_groups_options' => $groups_list,
576 'nb_members' => $members->getCount(),
577 'filters' => $filters,
578 'adv_filters' => $filters instanceof AdvancedMembersList
,
579 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
588 * @param Request $request PSR Request
589 * @param Response $response PSR Response
593 public function filter(Request
$request, Response
$response): Response
595 $post = $request->getParsedBody();
596 if (isset($this->session
->filter_members
)) {
597 //CAUTION: this one may be simple or advanced, display must change
598 $filters = $this->session
->filter_members
;
600 $filters = new MembersList();
603 //reintialize filters
604 if (isset($post['clear_filter'])) {
605 $filters = new MembersList();
606 } elseif (isset($post['clear_adv_filter'])) {
607 $this->session
->filter_members
= null;
608 unset($this->session
->filter_members
);
612 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
613 } elseif (isset($post['adv_criteria'])) {
616 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
619 if (isset($post['filter_str'])) { //filter search string
620 $filters->filter_str
= stripslashes(
621 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
625 if (isset($post['field_filter'])) {
626 if (is_numeric($post['field_filter'])) {
627 $filters->field_filter
= $post['field_filter'];
630 //membership to filter
631 if (isset($post['membership_filter'])) {
632 if (is_numeric($post['membership_filter'])) {
633 $filters->membership_filter
634 = $post['membership_filter'];
637 //account status to filter
638 if (isset($post['filter_account'])) {
639 if (is_numeric($post['filter_account'])) {
640 $filters->filter_account
= $post['filter_account'];
644 if (isset($post['email_filter'])) {
645 $filters->email_filter
= (int)$post['email_filter'];
649 isset($post['group_filter'])
650 && $post['group_filter'] > 0
652 $filters->group_filter
= (int)$post['group_filter'];
654 //number of rows to show
655 if (isset($post['nbshow'])) {
656 $filters->show
= (int)$post['nbshow'];
659 if (isset($post['advanced_filtering'])) {
660 if (!$filters instanceof AdvancedMembersList
) {
661 $filters = new AdvancedMembersList($filters);
665 unset($post['advanced_filtering']);
667 foreach ($post as $k => $v) {
668 if (strpos($k, 'free_', 0) === 0) {
671 foreach ($post['free_field'] as $f) {
674 && trim($post['free_text'][$i]) !== ''
676 $fs_search = htmlspecialchars($post['free_text'][$i], ENT_QUOTES
);
678 = (int)$post['free_logical_operator'][$i];
680 = (int)$post['free_query_operator'][$i];
681 $type = (int)$post['free_type'][$i];
686 'search' => $fs_search,
690 $filters->free_search
= $fs;
696 } elseif ($k == 'groups_search') {
698 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
699 foreach ($post['groups_search'] as $g) {
700 if (trim($g) !== '') {
705 $filters->groups_search
= $gs;
711 case 'contrib_min_amount':
712 case 'contrib_max_amount':
713 if (trim($v) !== '') {
726 if (isset($post['savesearch'])) {
731 $this->router
->pathFor(
738 $this->session
->filter_members
= $filters;
742 ->withHeader('Location', $this->router
->pathFor('members'));
746 * Advanced search page
748 * @param Request $request PSR Request
749 * @param Response $response PSR Response
753 public function advancedSearch(Request
$request, Response
$response): Response
755 if (isset($this->session
->filter_members
)) {
756 $filters = $this->session
->filter_members
;
757 if (!$filters instanceof AdvancedMembersList
) {
758 $filters = new AdvancedMembersList($filters);
761 $filters = new AdvancedMembersList();
764 $groups = new Groups($this->zdb
, $this->login
);
765 $groups_list = $groups->getList();
767 //we want only visible fields
768 $fields = $this->members_fields
;
769 $fc = $this->fields_config
;
770 $fc->filterVisible($this->login
, $fields);
772 //add status label search
773 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
774 $fields = array_slice($fields, 0, $pos, true) +
775 ['status_label' => ['label' => _T('Status label')]] +
776 array_slice($fields, $pos, count($fields) - 1, true);
780 $member = new Adherent($this->zdb
);
783 ->enableDep('dynamics')
784 ->loadFromLoginOrMail($this->login
->login
);
785 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
787 $contrib = new Contribution($this->zdb
, $this->login
);
788 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
791 $statuts = new Status($this->zdb
);
793 //Contributions types
794 $ct = new ContributionsTypes($this->zdb
);
797 $ptypes = new PaymentTypes(
802 $ptlist = $ptypes->getList();
804 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
809 'advanced_search.tpl',
811 'page_title' => _T("Advanced search"),
812 'filter_groups_options' => $groups_list,
813 'search_fields' => $fields,
814 'adh_dynamics' => $adh_dynamics->getFields(),
815 'contrib_dynamics' => $contrib_dynamics->getFields(),
816 'statuts' => $statuts->getList(),
817 'contributions_types' => $ct->getList(),
818 'filters' => $filters,
819 'payments_types' => $ptlist
826 * Members list for ajax
828 * @param Request $request PSR Request
829 * @param Response $response PSR Response
830 * @param string|null $option One of 'page' or 'order'
831 * @param string|integer $value Value of the option
835 public function ajaxList(Request
$request, Response
$response, string $option = null, $value = null): Response
837 $post = $request->getParsedBody();
839 $filters = $this->session
->ajax_members_filters ??
new MembersList();
841 if ($option == 'page') {
842 $filters->current_page
= (int)$value;
845 //numbers of rows to display
846 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
847 $filters->show
= (int)$post['nbshow'];
850 $members = new Members($filters);
851 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
852 if ($this->login
->isGroupManager()) {
853 $members_list = $members->getManagedMembersList(true);
858 [$this->login
->id
, $this->login
->login
],
859 'Trying to list group members without access from #%id (%login)'
863 throw new \
Exception('Access denied.');
866 $members_list = $members->getMembersList(true);
869 //assign pagination variables to the template and add pagination links
870 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
872 $this->session
->ajax_members_filters
= $filters;
874 $selected_members = null;
875 $unreachables_members = null;
876 if (!isset($post['from'])) {
877 $mailing = $this->session
->mailing
;
878 if (!isset($post['members'])) {
879 $selected_members = $mailing->recipients
;
880 $unreachables_members = $mailing->unreachables
;
883 $selected_members = $m->getArrayList($post['members']);
884 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
885 $unreachables_members = $m->getArrayList($post['unreachables']);
889 switch ($post['from']) {
891 if (!isset($post['gid'])) {
893 'Trying to list group members with no group id provided',
896 throw new \
Exception('A group id is required.');
898 if (!isset($post['members'])) {
899 $group = new Group((int)$post['gid']);
900 $selected_members = array();
901 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
902 $selected_members = $group->getMembers();
903 } elseif ($post['mode'] == 'managers') {
904 $selected_members = $group->getManagers();
907 'Trying to list group members with unknown mode',
910 throw new \
Exception('Unknown mode.');
914 $selected_members = $m->getArrayList($post['members']);
915 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
916 $unreachables_members = $m->getArrayList($post['unreachables']);
921 if (!isset($post['id_adh'])) {
922 throw new \
RuntimeException(
923 'Current selected member must be excluded while attaching!'
931 'filters' => $filters,
932 'members_list' => $members_list,
933 'selected_members' => $selected_members,
934 'unreachables_members' => $unreachables_members
937 if (isset($post['multiple'])) {
938 $params['multiple'] = true;
941 if (isset($post['gid'])) {
942 $params['the_id'] = (int)$post['gid'];
945 if (isset($post['id_adh'])) {
946 $params['excluded'] = (int)$post['id_adh'];
959 * Batch actions handler
961 * @param Request $request PSR Request
962 * @param Response $response PSR Response
966 public function handleBatch(Request
$request, Response
$response): Response
968 $post = $request->getParsedBody();
970 if (isset($post['member_sel'])) {
971 if (isset($this->session
->filter_members
)) {
972 $filters = $this->session
->filter_members
;
974 $filters = new MembersList();
977 $filters->selected
= $post['member_sel'];
978 $this->session
->filter_members
= $filters;
980 if (isset($post['cards'])) {
983 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
986 if (isset($post['labels'])) {
989 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
992 if (isset($post['mailing'])) {
995 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
998 if (isset($post['attendance_sheet'])) {
1001 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
1004 if (isset($post['csv'])) {
1007 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
1010 if (isset($post['delete'])) {
1013 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
1016 if (isset($post['masschange'])) {
1019 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
1022 if (isset($post['masscontributions'])) {
1025 ->withHeader('Location', $this->router
->pathFor('massAddContributionsChooseType'));
1028 throw new \
RuntimeException('Does not know what to batch :(');
1030 $this->flash
->addMessage(
1032 _T("No member was selected, please check at least one name.")
1037 ->withHeader('Location', $this->router
->pathFor('members'));
1047 * @param Request $request PSR Request
1048 * @param Response $response PSR Response
1049 * @param mixed $id Member id/array of members id
1050 * @param string $action null or 'add'
1054 public function edit(
1058 string $action = 'edit'
1060 //instantiate member object
1061 $member = new Adherent($this->zdb
);
1062 $member->enableAllDeps()->load($id);
1064 if ($this->session
->member
!== null) {
1065 //retrieve from session, in add or edit
1066 $member = $this->session
->member
;
1067 $this->session
->member
= null;
1072 //load requested member
1074 $can = $member->canEdit($this->login
);
1076 $can = $member->canCreate($this->login
);
1080 $this->flash
->addMessage(
1082 _T("You do not have permission for requested URL.")
1089 $this->router
->pathFor('me')
1093 //if adding a child, force parent here
1094 if ($action === 'addchild') {
1095 $member->setParent((int)$this->login
->id
);
1098 // flagging required fields
1099 $fc = $this->fields_config
;
1101 // password required if we create a new member
1103 $fc->setNotRequired('mdp_adh');
1106 //handle requirements for parent fields
1107 $parent_fields = $member->getParentFields();
1108 $tpl_parent_fields = []; //for JS when detaching
1109 foreach ($parent_fields as $field) {
1110 if ($fc->isRequired($field)) {
1111 $tpl_parent_fields[] = $field;
1112 if ($member->hasParent()) {
1113 $fc->setNotRequired($field);
1118 // flagging required fields invisible to members
1119 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1120 $fc->setNotRequired('activite_adh');
1121 $fc->setNotRequired('id_statut');
1124 // template variable declaration
1125 $title = _T("Member Profile");
1126 if ($member->id
!= '') {
1127 $title .= ' (' . _T("modification") . ')';
1129 $title .= ' (' . _T("creation") . ')';
1133 $statuts = new Status($this->zdb
);
1136 $groups = new Groups($this->zdb
, $this->login
);
1137 $groups_list = $groups->getSimpleList(true);
1139 $form_elements = $fc->getFormElements(
1147 if ($member->hasParent()) {
1148 $pid = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1150 $members = $m->getSelectizedMembers(
1155 $route_params['members'] = [
1156 'filters' => $m->getFilters(),
1157 'count' => $m->getCount()
1160 if (count($members)) {
1161 $route_params['members']['list'] = $members;
1165 $this->view
->render(
1169 'parent_tpl' => 'page.tpl',
1170 'autocomplete' => true,
1171 'page_title' => $title,
1172 'member' => $member,
1173 'self_adh' => false,
1174 // pseudo random int
1176 'titles_list' => Titles
::getList($this->zdb
),
1177 'statuts' => $statuts->getList(),
1178 'groups' => $groups_list,
1179 'fieldsets' => $form_elements['fieldsets'],
1180 'hidden_elements' => $form_elements['hiddens'],
1181 'parent_fields' => $tpl_parent_fields,
1182 'addchild' => ($action === 'addchild')
1191 * @param Request $request PSR Request
1192 * @param Response $response PSR Response
1193 * @param integer $id Member id
1197 public function doEdit(Request
$request, Response
$response, int $id): Response
1199 return $this->store($request, $response);
1203 * Massive change page
1205 * @param Request $request PSR Request
1206 * @param Response $response PSR Response
1210 public function massChange(Request
$request, Response
$response): Response
1212 $filters = $this->session
->filter_members
;
1215 'id' => $filters->selected
,
1216 'redirect_uri' => $this->router
->pathFor('members')
1219 $fc = $this->fields_config
;
1220 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1223 $member = new Adherent($this->zdb
);
1224 $member->disableAllDeps()->enableDep('dynamics');
1227 $statuts = new Status($this->zdb
);
1230 $this->view
->render(
1232 'mass_change_members.tpl',
1234 'mode' => $request->isXhr() ?
'ajax' : '',
1235 'page_title' => str_replace(
1238 _T('Mass change %count members')
1240 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1241 'cancel_uri' => $this->router
->pathFor('members'),
1243 'member' => $member,
1244 'fieldsets' => $form_elements['fieldsets'],
1245 'titles_list' => Titles
::getList($this->zdb
),
1246 'statuts' => $statuts->getList(),
1247 'require_mass' => true
1254 * Massive changes validation page
1256 * @param Request $request PSR Request
1257 * @param Response $response PSR Response
1261 public function validateMassChange(Request
$request, Response
$response): Response
1263 $post = $request->getParsedBody();
1265 if (!isset($post['confirm'])) {
1266 $this->flash
->addMessage(
1268 _T("Mass changes has not been confirmed!")
1271 //we want only visibles fields
1272 $fc = $this->fields_config
;
1273 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1276 foreach ($form_elements['fieldsets'] as $form_element) {
1277 foreach ($form_element->elements
as $field) {
1279 isset($post['mass_' . $field->field_id
])
1280 && (isset($post[$field->field_id
]) ||
$field->type
=== FieldsConfig
::TYPE_BOOL
)
1282 $changes[$field->field_id
] = [
1283 'label' => $field->label
,
1284 'value' => $post[$field->field_id
] ??
0
1290 //handle dynamic fields
1291 $member = new Adherent($this->zdb
);
1296 $this->members_fields
,
1299 $dynamic_fields = $member->getDynamicFields()->getFields();
1300 foreach ($dynamic_fields as $field) {
1301 $mass_id = 'mass_info_field_' . $field->getId();
1302 $field_id = 'info_field_' . $field->getId() . '_1';
1304 isset($post[$mass_id])
1305 && (isset($post[$field_id]) ||
$field instanceof Boolean
)
1307 $changes[$field_id] = [
1308 'label' => $field->getName(),
1309 'value' => $post[$field_id] ??
0
1315 $filters = $this->session
->filter_members
;
1317 'id' => $filters->selected
,
1318 'redirect_uri' => $this->router
->pathFor('members')
1322 $statuts = new Status($this->zdb
);
1325 $this->view
->render(
1327 'mass_change_members.tpl',
1329 'mode' => $request->isXhr() ?
'ajax' : '',
1330 'page_title' => str_replace(
1333 _T('Review mass change %count members')
1335 'form_url' => $this->router
->pathFor('massstoremembers'),
1336 'cancel_uri' => $this->router
->pathFor('members'),
1338 'titles_list' => Titles
::getList($this->zdb
),
1339 'statuts' => $statuts->getList(),
1340 'changes' => $changes
1347 * Do massive changes
1349 * @param Request $request PSR Request
1350 * @param Response $response PSR Response
1354 public function doMassChange(Request
$request, Response
$response): Response
1356 $post = $request->getParsedBody();
1357 $redirect_url = $post['redirect_uri'];
1358 $error_detected = [];
1360 $dynamic_fields = null;
1362 unset($post['redirect_uri']);
1363 if (!isset($post['confirm'])) {
1364 $error_detected[] = _T("Mass changes has not been confirmed!");
1366 unset($post['confirm']);
1370 $fc = $this->fields_config
;
1371 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1372 $disabled = $this->members_fields
;
1373 foreach (array_keys($post) as $key) {
1375 foreach ($form_elements['fieldsets'] as $fieldset) {
1376 if (isset($fieldset->elements
[$key])) {
1383 //try on dynamic fields
1384 if ($dynamic_fields === null) {
1385 //handle dynamic fields
1386 $member = new Adherent($this->zdb
);
1391 $this->members_fields
,
1394 $dynamic_fields = $member->getDynamicFields()->getFields();
1396 foreach ($dynamic_fields as $field) {
1397 $field_id = 'info_field_' . $field->getId() . '_1';
1398 if ($key == $field_id) {
1407 'Permission issue mass editing field ' . $key,
1412 unset($disabled[$key]);
1416 if (!count($post)) {
1417 $error_detected[] = _T("Nothing to do!");
1419 foreach ($ids as $id) {
1420 $is_manager = !$this->login
->isAdmin()
1421 && !$this->login
->isStaff()
1422 && $this->login
->isGroupManager();
1423 $member = new Adherent($this->zdb
);
1424 $member->disableAllDeps();
1426 $member->enableDep('groups');
1428 $member->load((int)$id);
1429 $member->setDependencies(
1431 $this->members_fields
,
1434 if (!$member->canEdit($this->login
)) {
1438 $valid = $member->check($post, [], $disabled);
1439 if ($valid === true) {
1440 $done = $member->store();
1442 $error_detected[] = _T("An error occurred while storing the member.");
1447 $error_detected = array_merge($error_detected, $valid);
1453 if ($mass == 0 && !count($error_detected)) {
1454 $error_detected[] = _T('Something went wront during mass edition!');
1456 $this->flash
->addMessage(
1461 _T('%count members has been changed successfully!')
1466 if (count($error_detected) > 0) {
1467 foreach ($error_detected as $error) {
1468 $this->flash
->addMessage(
1475 if (!$request->isXhr()) {
1478 ->withHeader('Location', $redirect_url);
1480 return $response->withJson(
1482 'success' => count($error_detected) === 0
1491 * @param Request $request PSR Request
1492 * @param Response $response PSR Response
1496 public function store(Request
$request, Response
$response): Response
1498 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1501 ->withHeader('Location', $this->router
->pathFor('slash'));
1504 $post = $request->getParsedBody();
1505 $member = new Adherent($this->zdb
);
1510 $this->members_fields
,
1514 $success_detected = [];
1515 $warning_detected = [];
1516 $error_detected = [];
1518 if ($this->isSelfMembership() && !isset($post[Adherent
::PK
])) {
1519 //mark as self membership
1520 $member->setSelfMembership();
1523 $gaptcha = $this->session
->gaptcha
;
1524 if (!$gaptcha->check($post['gaptcha'])) {
1525 $error_detected[] = _T('Invalid captcha');
1530 if (isset($post['id_adh'])) {
1531 $member->load((int)$post['id_adh']);
1532 if (!$member->canEdit($this->login
)) {
1533 //redirection should have been done before. Just throw an Exception.
1534 throw new \
RuntimeException(
1538 'No right to store member #%id'
1543 if ($member->id
!= '') {
1544 $member->load($this->login
->id
);
1548 // flagging required fields
1549 $fc = $this->fields_config
;
1551 // password required if we create a new member but not from self subscription
1552 if ($member->id
!= '' ||
$this->isSelfMembership()) {
1553 $fc->setNotRequired('mdp_adh');
1557 $member->hasParent() && !isset($post['detach_parent'])
1558 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1560 $parent_fields = $member->getParentFields();
1561 foreach ($parent_fields as $field) {
1562 if ($fc->isRequired($field)) {
1563 $fc->setNotRequired($field);
1568 // flagging required fields invisible to members
1569 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1570 $fc->setNotRequired('activite_adh');
1571 $fc->setNotRequired('id_statut');
1574 $form_elements = $fc->getFormElements(
1577 $this->isSelfMembership()
1579 $fieldsets = $form_elements['fieldsets'];
1580 $required = array();
1581 $disabled = array();
1583 foreach ($fieldsets as $category) {
1584 foreach ($category->elements
as $field) {
1585 if ($field->required
== true) {
1586 $required[$field->field_id
] = true;
1588 if ($field->disabled
== true) {
1589 $disabled[$field->field_id
] = true;
1590 } elseif (!isset($post[$field->field_id
])) {
1591 switch ($field->field_id
) {
1592 //unchecked booleans are not sent from form
1593 case 'bool_admin_adh':
1594 case 'bool_exempt_adh':
1595 case 'bool_display_info':
1596 $post[$field->field_id
] = 0;
1603 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1606 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1607 if (!count($real_requireds) ||
isset($post[array_shift($real_requireds)])) {
1609 $valid = $member->check($post, $required, $disabled);
1610 if ($valid !== true) {
1611 $error_detected = array_merge($error_detected, $valid);
1614 if (count($error_detected) == 0) {
1615 //all goes well, we can proceed
1618 if ($member->id
== '') {
1622 // send email to member
1623 if ($this->isSelfMembership() ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1624 $member->setSendmail(); //flag to send creation email
1627 $store = $member->store();
1628 if ($store === true) {
1629 //member has been stored :)
1631 if ($this->isSelfMembership()) {
1632 $success_detected[] = _T("Your account has been created!");
1634 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1635 && $member->getEmail() != ''
1637 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1640 $success_detected[] = _T("New member has been successfully added.");
1643 $success_detected[] = _T("Member account has been modified.");
1646 //store requested groups
1647 $groups_adh = $post['groups_adh'] ??
null;
1648 $managed_groups_adh = $post['groups_managed_adh'] ??
null;
1650 //add/remove user from groups
1651 $add_groups = Groups
::addMemberToGroups(
1656 if ($add_groups === false) {
1657 $error_detected[] = _T("An error occurred adding member to its groups.");
1660 //add/remove manager from groups
1661 $add_groups = Groups
::addMemberToGroups(
1663 $managed_groups_adh,
1666 $member->loadGroups();
1668 if ($add_groups === false) {
1669 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1672 //something went wrong :'(
1673 $error_detected[] = _T("An error occurred while storing the member.");
1677 if (count($error_detected) === 0) {
1678 $files_res = $member->handleFiles($_FILES);
1679 if (is_array($files_res)) {
1680 $error_detected = array_merge($error_detected, $files_res);
1683 if (isset($post['del_photo'])) {
1684 if (!$member->picture
->delete($member->id
)) {
1685 $error_detected[] = _T("Delete failed");
1686 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1688 'Unable to delete picture for member ' . $str_adh,
1695 if (count($error_detected) > 0) {
1696 foreach ($error_detected as $error) {
1697 if (strpos($error, '%member_url_') !== false) {
1698 preg_match('/%member_url_(\d+)/', $error, $matches);
1699 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1700 $error = str_replace(
1701 '%member_url_' . $matches[1],
1706 $this->flash
->addMessage(
1713 if (count($warning_detected) > 0) {
1714 foreach ($warning_detected as $warning) {
1715 $this->flash
->addMessage(
1721 if (count($success_detected) > 0) {
1722 foreach ($success_detected as $success) {
1723 $this->flash
->addMessage(
1730 if (count($error_detected) === 0) {
1731 if ($this->isSelfMembership()) {
1732 $redirect_url = $this->router
->pathFor('login');
1734 isset($post['redirect_on_create'])
1735 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1737 switch ($post['redirect_on_create']) {
1738 case Adherent
::AFTER_ADD_TRANS
:
1739 $redirect_url = $this->router
->pathFor('addTransaction');
1741 case Adherent
::AFTER_ADD_NEW
:
1742 $redirect_url = $this->router
->pathFor('addMember');
1744 case Adherent
::AFTER_ADD_SHOW
:
1745 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1747 case Adherent
::AFTER_ADD_LIST
:
1748 $redirect_url = $this->router
->pathFor('members');
1750 case Adherent
::AFTER_ADD_HOME
:
1751 $redirect_url = $this->router
->pathFor('slash');
1754 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1755 $redirect_url = $this->router
->pathFor(
1758 ) . '?id_adh=' . $member->id
;
1760 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1763 //store entity in session
1764 $this->session
->member
= $member;
1766 if ($this->isSelfMembership()) {
1767 $redirect_url = $this->router
->pathFor('subscribe');
1770 $redirect_url = $this->router
->pathFor(
1772 ['id' => $member->id
]
1775 $redirect_url = $this->router
->pathFor('addMember');
1783 ->withHeader('Location', $redirect_url);
1791 * Get redirection URI
1793 * @param array $args Route arguments
1797 public function redirectUri(array $args)
1799 return $this->router
->pathFor('members');
1805 * @param array $args Route arguments
1809 public function formUri(array $args)
1811 return $this->router
->pathFor(
1821 * In simple cases, we get the ID in the route arguments; but for
1822 * batchs, it should be found elsewhere.
1823 * In post values, we look for id key, as well as all {sthing}_sel keys (like members_sel or contrib_sel)
1825 * @param array $args Request arguments
1826 * @param array $post POST values
1828 * @return null|integer|integer[]
1830 protected function getIdsToRemove(&$args, $post)
1832 if (isset($args['id'])) {
1835 $filters = $this->session
->filter_members
;
1836 return $filters->selected
;
1841 * Get confirmation removal page title
1843 * @param array $args Route arguments
1847 public function confirmRemoveTitle(array $args)
1849 if (isset($args['id_adh']) ||
isset($args['id'])) {
1850 //one member removal
1851 $id_adh = $args['id_adh'] ??
$args['id'];
1852 $adh = new Adherent($this->zdb
, (int)$id_adh);
1854 _T('Remove member %1$s'),
1858 //batch members removal
1859 $filters = $this->session
->filter_members
;
1862 count($filters->selected
),
1863 _T('You are about to remove %count members.')
1871 * @param array $args Route arguments
1872 * @param array $post POST values
1876 protected function doDelete(array $args, array $post)
1878 if (isset($this->session
->filter_members
)) {
1879 $filters = $this->session
->filter_members
;
1881 $filters = new MembersList();
1883 $members = new Members($filters);
1885 if (!is_array($post['id'])) {
1886 $ids = (array)$post['id'];
1891 return $members->removeMembers($ids);
1897 * Set self memebrship flag
1899 * @return MembersController
1901 private function setSelfMembership(): MembersController
1903 $this->is_self_membership
= true;
1908 * Is self membership?
1912 private function isSelfMembership(): bool
1914 return $this->is_self_membership
;