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\Authentication
;
44 use Galette\Core\GaletteMail
;
45 use Galette\Core\Gaptcha
;
46 use Galette\Core\Password
;
47 use Galette\Core\Picture
;
48 use Galette\Entity\Adherent
;
49 use Galette\Entity\Contribution
;
50 use Galette\Entity\ContributionsTypes
;
51 use Galette\Entity\DynamicFieldsHandle
;
52 use Galette\Entity\Group
;
53 use Galette\Entity\Status
;
54 use Galette\Entity\FieldsConfig
;
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-2021 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
81 private $is_self_membership = false;
88 * @param Request $request PSR Request
89 * @param Response $response PSR Response
93 public function add(Request
$request, Response
$response): Response
95 return $this->edit($request, $response, null, 'add');
101 * @param Request $request PSR Request
102 * @param Response $response PSR Response
106 public function addChild(Request
$request, Response
$response): Response
108 return $this->edit($request, $response, null, 'addchild');
112 * Self subscription page
114 * @param Request $request PSR Request
115 * @param Response $response PSR Response
119 public function selfSubscribe(Request
$request, Response
$response): Response
121 if (!$this->preferences
->pref_bool_selfsubscribe ||
$this->login
->isLogged()) {
124 ->withHeader('Location', $this->router
->pathFor('slash'));
127 if ($this->session
->member
!== null) {
128 $member = $this->session
->member
;
129 $this->session
->member
= null;
134 $member = new Adherent($this->zdb
, null, $deps);
137 //mark as self membership
138 $member->setSelfMembership();
140 // flagging required fields
141 $fc = $this->fields_config
;
142 $form_elements = $fc->getFormElements($this->login
, true, true);
146 $members = $m->getSelectizedMembers(
148 $member->hasParent() ?
$member->parent
->id
: null
153 'filters' => $m->getFilters(),
154 'count' => $m->getCount()
158 if (count($members)) {
159 $params['members']['list'] = $members;
162 $gaptcha = new Gaptcha($this->i18n
);
163 $this->session
->gaptcha
= $gaptcha;
169 'page_title' => _T("Subscription"),
170 'parent_tpl' => 'public_page.tpl',
173 'autocomplete' => true,
176 'titles_list' => Titles
::getList($this->zdb
),
177 'fieldsets' => $form_elements['fieldsets'],
178 'hidden_elements' => $form_elements['hiddens'],
180 'gaptcha' => $gaptcha
189 * @param Request $request PSR Request
190 * @param Response $response PSR Response
194 public function doAdd(Request
$request, Response
$response): Response
196 return $this->store($request, $response);
200 * Self subscription add action
202 * @param Request $request PSR Request
203 * @param Response $response PSR Response
207 public function doSelfSubscribe(Request
$request, Response
$response): Response
209 $this->setSelfMembership();
210 return $this->doAdd($request, $response);
217 * @param Request $request PSR Request
218 * @param Response $response PSR Response
219 * @param integer $id_adh Member ID to duplicate
223 public function duplicate(Request
$request, Response
$response, int $id_adh): Response
225 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true, 'parent' => true]);
226 $adh->setDuplicate();
228 //store entity in session
229 $this->session
->member
= $adh;
233 ->withHeader('Location', $this->router
->pathFor('addMember'));
240 * Display member card
242 * @param Request $request PSR Request
243 * @param Response $response PSR Response
244 * @param integer $id Member ID
248 public function show(Request
$request, Response
$response, int $id): Response
258 $member = new Adherent($this->zdb
, $id, $deps);
260 if (!$member->canShow($this->login
)) {
261 $this->flash
->addMessage(
263 _T("You do not have permission for requested URL.")
270 $this->router
->pathFor('me')
274 if ($member->id
== null) {
275 //member does not exists!
276 $this->flash
->addMessage(
278 str_replace('%id', $id, _T("No member #%id."))
285 $this->router
->pathFor('slash')
289 // flagging fields visibility
290 $fc = $this->fields_config
;
291 $display_elements = $fc->getDisplayElements($this->login
);
298 'page_title' => _T("Member Profile"),
300 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
301 'pref_card_self' => $this->preferences
->pref_card_self
,
302 'groups' => Groups
::getSimpleList(),
304 'display_elements' => $display_elements
313 * @param Request $request PSR Request
314 * @param Response $response PSR Response
318 public function showMe(Request
$request, Response
$response): Response
320 if ($this->login
->isSuperAdmin()) {
323 ->withHeader('Location', $this->router
->pathFor('slash'));
325 return $this->show($request, $response, $this->login
->id
);
329 * Public pages (trombinoscope, public list)
331 * @param Request $request PSR Request
332 * @param Response $response PSR Response
333 * @param string $option One of 'page' or 'order'
334 * @param string|integer $value Value of the option
335 * @param string $type List type (either list or trombi)
339 public function publicList(
346 $varname = 'public_filter_' . $type;
347 if (isset($this->session
->$varname)) {
348 $filters = $this->session
->$varname;
350 $filters = new MembersList();
353 if ($option !== null) {
356 $filters->current_page
= (int)$value;
359 $filters->orderby
= $value;
364 $m = new Members($filters);
365 $members = $m->getPublicList($type === 'trombi');
367 $this->session
->$varname = $filters;
369 //assign pagination variables to the template and add pagination links
370 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
375 ($type === 'list' ?
'liste_membres' : 'trombinoscope') . '.tpl',
377 'page_title' => ($type === 'list' ?
_T("Members list") : _T('Trombinoscope')),
378 'additionnal_html_class' => ($type === 'list' ?
'' : 'trombinoscope'),
380 'members' => $members,
381 'nb_members' => $m->getCount(),
382 'filters' => $filters
389 * Public pages (trombinoscope, public list)
391 * @param Request $request PSR Request
392 * @param Response $response PSR Response
393 * @param string $type Type
397 public function filterPublicList(Request
$request, Response
$response, string $type): Response
399 $post = $request->getParsedBody();
401 $varname = 'public_filter_' . $type;
402 if (isset($this->session
->$varname)) {
403 $filters = $this->session
->$varname;
405 $filters = new MembersList();
408 //reintialize filters
409 if (isset($post['clear_filter'])) {
412 //number of rows to show
413 if (isset($post['nbshow'])) {
414 $filters->show
= (int)$post['nbshow'];
418 $this->session
->$varname = $filters;
422 ->withHeader('Location', $this->router
->pathFor('publicList', ['type' => $type]));
428 * @param Request $request PSR Request
429 * @param Response $response PSR Response
430 * @param integer $id Member ID
431 * @param integer $fid Dynamic fields ID
432 * @param integer $pos Dynamic field position
433 * @param string $name File name
437 public function getDynamicFile(
453 $member = new Adherent($this->zdb
, $id, $deps);
456 if (!$member->canShow($this->login
)) {
457 $fields = $member->getDynamicFields()->getFields();
458 if (!isset($fields[$fid])) {
459 //field does not exists or access is forbidden
466 if ($denied === true) {
467 $this->flash
->addMessage(
469 _T("You do not have permission for requested URL.")
476 $this->router
->pathFor(
483 $filename = str_replace(
494 'member_%mid_field_%fid_value_%pos'
497 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
498 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
500 $response = $response->withHeader('Content-Description', 'File Transfer')
501 ->withHeader('Content-Type', $type)
502 ->withHeader('Content-Disposition', 'attachment;filename="' . $name . '"')
503 ->withHeader('Pragma', 'no-cache')
504 ->withHeader('Content-Transfer-Encoding', 'binary')
505 ->withHeader('Expires', '0')
506 ->withHeader('Cache-Control', 'must-revalidate')
507 ->withHeader('Pragma', 'public');
509 $stream = fopen('php://memory', 'r+');
510 fwrite($stream, file_get_contents(GALETTE_FILES_PATH
. $filename));
513 return $response->withBody(new \Slim\Http\
Stream($stream));
516 'A request has been made to get a dynamic file named `' .
517 $filename . '` that does not exists.',
521 $this->flash
->addMessage(
523 _T("The file does not exists or cannot be read :(")
530 $this->router
->pathFor('member', ['id' => $id])
538 * @param Request $request PSR Request
539 * @param Response $response PSR Response
540 * @param string $option One of 'page' or 'order'
541 * @param string|integer $value Value of the option
545 public function list(Request
$request, Response
$response, $option = null, $value = null): Response
547 if (isset($this->session
->filter_members
)) {
548 $filters = $this->session
->filter_members
;
550 $filters = new MembersList();
553 if ($option !== null) {
556 $filters->current_page
= (int)$value;
559 $filters->orderby
= $value;
564 $members = new Members($filters);
566 $members_list = array();
567 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
568 $members_list = $members->getMembersList(true);
570 $members_list = $members->getManagedMembersList(true);
573 $groups = new Groups($this->zdb
, $this->login
);
574 $groups_list = $groups->getList();
576 //assign pagination variables to the template and add pagination links
577 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
578 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
580 $this->session
->filter_members
= $filters;
585 'gestion_adherents.tpl',
587 'page_title' => _T("Members management"),
588 'require_mass' => true,
589 'members' => $members_list,
590 'filter_groups_options' => $groups_list,
591 'nb_members' => $members->getCount(),
592 'filters' => $filters,
593 'adv_filters' => $filters instanceof AdvancedMembersList
,
594 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
603 * @param Request $request PSR Request
604 * @param Response $response PSR Response
608 public function filter(Request
$request, Response
$response): Response
610 $post = $request->getParsedBody();
611 if (isset($this->session
->filter_members
)) {
612 //CAUTION: this one may be simple or advanced, display must change
613 $filters = $this->session
->filter_members
;
615 $filters = new MembersList();
618 //reintialize filters
619 if (isset($post['clear_filter'])) {
620 $filters = new MembersList();
621 } elseif (isset($post['clear_adv_filter'])) {
622 $this->session
->filter_members
= null;
623 unset($this->session
->filter_members
);
627 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
628 } elseif (isset($post['adv_criteria'])) {
631 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
634 if (isset($post['filter_str'])) { //filter search string
635 $filters->filter_str
= stripslashes(
636 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
640 if (isset($post['field_filter'])) {
641 if (is_numeric($post['field_filter'])) {
642 $filters->field_filter
= $post['field_filter'];
645 //membership to filter
646 if (isset($post['membership_filter'])) {
647 if (is_numeric($post['membership_filter'])) {
648 $filters->membership_filter
649 = $post['membership_filter'];
652 //account status to filter
653 if (isset($post['filter_account'])) {
654 if (is_numeric($post['filter_account'])) {
655 $filters->filter_account
= $post['filter_account'];
659 if (isset($post['email_filter'])) {
660 $filters->email_filter
= (int)$post['email_filter'];
664 isset($post['group_filter'])
665 && $post['group_filter'] > 0
667 $filters->group_filter
= (int)$post['group_filter'];
669 //number of rows to show
670 if (isset($post['nbshow'])) {
671 $filters->show
= (int)$post['nbshow'];
674 if (isset($post['advanced_filtering'])) {
675 if (!$filters instanceof AdvancedMembersList
) {
676 $filters = new AdvancedMembersList($filters);
680 unset($post['advanced_filtering']);
682 foreach ($post as $k => $v) {
683 if (strpos($k, 'free_', 0) === 0) {
686 foreach ($post['free_field'] as $f) {
689 && trim($post['free_text'][$i]) !== ''
691 $fs_search = htmlspecialchars($post['free_text'][$i], ENT_QUOTES
);
693 = (int)$post['free_logical_operator'][$i];
695 = (int)$post['free_query_operator'][$i];
696 $type = (int)$post['free_type'][$i];
701 'search' => $fs_search,
705 $filters->free_search
= $fs;
711 } elseif ($k == 'groups_search') {
713 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
714 foreach ($post['groups_search'] as $g) {
715 if (trim($g) !== '') {
720 $filters->groups_search
= $gs;
726 case 'contrib_min_amount':
727 case 'contrib_max_amount':
728 if (trim($v) !== '') {
741 if (isset($post['savesearch'])) {
746 $this->router
->pathFor(
753 $this->session
->filter_members
= $filters;
757 ->withHeader('Location', $this->router
->pathFor('members'));
761 * Advanced search page
763 * @param Request $request PSR Request
764 * @param Response $response PSR Response
768 public function advancedSearch(Request
$request, Response
$response): Response
770 if (isset($this->session
->filter_members
)) {
771 $filters = $this->session
->filter_members
;
772 if (!$filters instanceof AdvancedMembersList
) {
773 $filters = new AdvancedMembersList($filters);
776 $filters = new AdvancedMembersList();
779 $groups = new Groups($this->zdb
, $this->login
);
780 $groups_list = $groups->getList();
782 //we want only visibles fields
783 $fields = $this->members_fields
;
784 $fc = $this->fields_config
;
785 $fc->filterVisible($this->login
, $fields);
787 //add status label search
788 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
789 $fields = array_slice($fields, 0, $pos, true) +
790 ['status_label' => ['label' => _T('Status label')]] +
791 array_slice($fields, $pos, count($fields) - 1, true);
803 $member = new Adherent($this->zdb
, $this->login
->login
, $deps);
804 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
806 $contrib = new Contribution($this->zdb
, $this->login
);
807 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
810 $statuts = new Status($this->zdb
);
812 //Contributions types
813 $ct = new ContributionsTypes($this->zdb
);
816 $ptypes = new PaymentTypes(
821 $ptlist = $ptypes->getList();
823 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
828 'advanced_search.tpl',
830 'page_title' => _T("Advanced search"),
831 'filter_groups_options' => $groups_list,
832 'search_fields' => $fields,
833 'adh_dynamics' => $adh_dynamics->getFields(),
834 'contrib_dynamics' => $contrib_dynamics->getFields(),
835 'statuts' => $statuts->getList(),
836 'contributions_types' => $ct->getList(),
837 'filters' => $filters,
838 'payments_types' => $ptlist
845 * Members list for ajax
847 * @param Request $request PSR Request
848 * @param Response $response PSR Response
849 * @param string $option One of 'page' or 'order'
850 * @param string|integer $value Value of the option
854 public function ajaxList(Request
$request, Response
$response, string $option = null, $value = null): Response
856 $post = $request->getParsedBody();
858 if (isset($this->session
->ajax_members_filters
)) {
859 $filters = $this->session
->ajax_members_filters
;
861 $filters = new MembersList();
864 if ($option == 'page') {
865 $filters->current_page
= (int)$value;
868 //numbers of rows to display
869 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
870 $filters->show
= (int)$post['nbshow'];
873 $members = new Members($filters);
874 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
875 if ($this->login
->isGroupManager()) {
876 $members_list = $members->getManagedMembersList(true);
881 [$this->login
->id
, $this->login
->login
],
882 'Trying to list group members without access from #%id (%login)'
886 throw new \
Exception('Access denied.');
889 $members_list = $members->getMembersList(true);
892 //assign pagination variables to the template and add pagination links
893 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
895 $this->session
->ajax_members_filters
= $filters;
897 $selected_members = null;
898 $unreachables_members = null;
899 if (!isset($post['from'])) {
900 $mailing = $this->session
->mailing
;
901 if (!isset($post['members'])) {
902 $selected_members = $mailing->recipients
;
903 $unreachables_members = $mailing->unreachables
;
906 $selected_members = $m->getArrayList($post['members']);
907 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
908 $unreachables_members = $m->getArrayList($post['unreachables']);
912 switch ($post['from']) {
914 if (!isset($post['gid'])) {
916 'Trying to list group members with no group id provided',
919 throw new \
Exception('A group id is required.');
921 if (!isset($post['members'])) {
922 $group = new Group((int)$post['gid']);
923 $selected_members = array();
924 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
925 $selected_members = $group->getMembers();
926 } elseif ($post['mode'] == 'managers') {
927 $selected_members = $group->getManagers();
930 'Trying to list group members with unknown mode',
933 throw new \
Exception('Unknown mode.');
937 $selected_members = $m->getArrayList($post['members']);
938 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
939 $unreachables_members = $m->getArrayList($post['unreachables']);
944 if (!isset($post['id_adh'])) {
945 throw new \
RuntimeException(
946 'Current selected member must be excluded while attaching!'
954 'filters' => $filters,
955 'members_list' => $members_list,
956 'selected_members' => $selected_members,
957 'unreachables_members' => $unreachables_members
960 if (isset($post['multiple'])) {
961 $params['multiple'] = true;
964 if (isset($post['gid'])) {
965 $params['the_id'] = (int)$post['gid'];
968 if (isset($post['id_adh'])) {
969 $params['excluded'] = (int)$post['id_adh'];
982 * Batch actions handler
984 * @param Request $request PSR Request
985 * @param Response $response PSR Response
989 public function handleBatch(Request
$request, Response
$response): Response
991 $post = $request->getParsedBody();
993 if (isset($post['member_sel'])) {
994 if (isset($this->session
->filter_members
)) {
995 $filters = $this->session
->filter_members
;
997 $filters = new MembersList();
1000 $filters->selected
= $post['member_sel'];
1001 $this->session
->filter_members
= $filters;
1003 if (isset($post['cards'])) {
1006 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
1009 if (isset($post['labels'])) {
1012 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
1015 if (isset($post['mailing'])) {
1018 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
1021 if (isset($post['attendance_sheet'])) {
1024 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
1027 if (isset($post['csv'])) {
1030 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
1033 if (isset($post['delete'])) {
1036 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
1039 if (isset($post['masschange'])) {
1042 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
1045 if (isset($post['masscontributions'])) {
1048 ->withHeader('Location', $this->router
->pathFor('massAddContributionsChooseType'));
1051 throw new \
RuntimeException('Does not know what to batch :(');
1053 $this->flash
->addMessage(
1055 _T("No member was selected, please check at least one name.")
1060 ->withHeader('Location', $this->router
->pathFor('members'));
1070 * @param Request $request PSR Request
1071 * @param Response $response PSR Response
1072 * @param mixed $id Member id/array of members id
1073 * @param string $action null or 'add'
1077 public function edit(
1081 string $action = 'edit'
1092 //instantiate member object
1093 $member = new Adherent($this->zdb
, $id, $deps);
1095 if ($this->session
->member
!== null) {
1096 //retrieve from session, in add or edit
1097 $member = $this->session
->member
;
1098 $this->session
->member
= null;
1103 //load requested member
1105 $can = $member->canEdit($this->login
);
1107 $can = $member->canCreate($this->login
);
1111 $this->flash
->addMessage(
1113 _T("You do not have permission for requested URL.")
1120 $this->router
->pathFor('me')
1124 //if adding a child, force parent here
1125 if ($action === 'addchild') {
1126 $member->setParent((int)$this->login
->id
);
1129 // flagging required fields
1130 $fc = $this->fields_config
;
1132 // password required if we create a new member
1134 $fc->setNotRequired('mdp_adh');
1137 //handle requirements for parent fields
1138 $parent_fields = $member->getParentFields();
1139 $tpl_parent_fields = []; //for JS when detaching
1140 foreach ($parent_fields as $field) {
1141 if ($fc->isRequired($field)) {
1142 $tpl_parent_fields[] = $field;
1143 if ($member->hasParent()) {
1144 $fc->setNotRequired($field);
1149 // flagging required fields invisible to members
1150 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1151 $fc->setNotRequired('activite_adh');
1152 $fc->setNotRequired('id_statut');
1155 // template variable declaration
1156 $title = _T("Member Profile");
1157 if ($member->id
!= '') {
1158 $title .= ' (' . _T("modification") . ')';
1160 $title .= ' (' . _T("creation") . ')';
1164 $statuts = new Status($this->zdb
);
1167 $groups = new Groups($this->zdb
, $this->login
);
1168 $groups_list = $groups->getSimpleList(true);
1170 $form_elements = $fc->getFormElements(
1178 if ($member->hasParent()) {
1179 $pid = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1181 $members = $m->getSelectizedMembers(
1186 $route_params['members'] = [
1187 'filters' => $m->getFilters(),
1188 'count' => $m->getCount()
1191 if (count($members)) {
1192 $route_params['members']['list'] = $members;
1196 $this->view
->render(
1200 'parent_tpl' => 'page.tpl',
1201 'autocomplete' => true,
1202 'page_title' => $title,
1203 'member' => $member,
1204 'self_adh' => false,
1205 // pseudo random int
1207 'titles_list' => Titles
::getList($this->zdb
),
1208 'statuts' => $statuts->getList(),
1209 'groups' => $groups_list,
1210 'fieldsets' => $form_elements['fieldsets'],
1211 'hidden_elements' => $form_elements['hiddens'],
1212 'parent_fields' => $tpl_parent_fields,
1213 'addchild' => ($action === 'addchild')
1222 * @param Request $request PSR Request
1223 * @param Response $response PSR Response
1224 * @param integer $id Member id
1228 public function doEdit(Request
$request, Response
$response, int $id): Response
1230 return $this->store($request, $response);
1234 * Massive change page
1236 * @param Request $request PSR Request
1237 * @param Response $response PSR Response
1241 public function massChange(Request
$request, Response
$response): Response
1243 $filters = $this->session
->filter_members
;
1246 'id' => $filters->selected
,
1247 'redirect_uri' => $this->router
->pathFor('members')
1250 $fc = $this->fields_config
;
1251 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1259 'children' => false,
1262 $member = new Adherent($this->zdb
, null, $deps);
1265 $statuts = new Status($this->zdb
);
1268 $this->view
->render(
1270 'mass_change_members.tpl',
1272 'mode' => $request->isXhr() ?
'ajax' : '',
1273 'page_title' => str_replace(
1276 _T('Mass change %count members')
1278 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1279 'cancel_uri' => $this->router
->pathFor('members'),
1281 'member' => $member,
1282 'fieldsets' => $form_elements['fieldsets'],
1283 'titles_list' => Titles
::getList($this->zdb
),
1284 'statuts' => $statuts->getList(),
1285 'require_mass' => true
1292 * Massive changes validation page
1294 * @param Request $request PSR Request
1295 * @param Response $response PSR Response
1299 public function validateMassChange(Request
$request, Response
$response): Response
1301 $post = $request->getParsedBody();
1303 if (!isset($post['confirm'])) {
1304 $this->flash
->addMessage(
1306 _T("Mass changes has not been confirmed!")
1309 //we want only visibles fields
1310 $fc = $this->fields_config
;
1311 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1314 foreach ($form_elements['fieldsets'] as $form_element) {
1315 foreach ($form_element->elements
as $field) {
1317 isset($post['mass_' . $field->field_id
])
1318 && (isset($post[$field->field_id
]) ||
$field->type
=== FieldsConfig
::TYPE_BOOL
)
1320 $changes[$field->field_id
] = [
1321 'label' => $field->label
,
1322 'value' => $post[$field->field_id
] ??
0
1328 //handle dynamic fields
1337 $member = new Adherent($this->zdb
, null, $deps);
1338 $member->setDependencies(
1340 $this->members_fields
,
1343 $dynamic_fields = $member->getDynamicFields()->getFields();
1344 foreach ($dynamic_fields as $field) {
1345 $mass_id = 'mass_info_field_' . $field->getId();
1346 $field_id = 'info_field_' . $field->getId() . '_1';
1348 isset($post[$mass_id])
1349 && (isset($post[$field_id]) ||
$field instanceof Boolean
)
1351 $changes[$field_id] = [
1352 'label' => $field->getName(),
1353 'value' => $post[$field_id] ??
0
1359 $filters = $this->session
->filter_members
;
1361 'id' => $filters->selected
,
1362 'redirect_uri' => $this->router
->pathFor('members')
1366 $statuts = new Status($this->zdb
);
1369 $this->view
->render(
1371 'mass_change_members.tpl',
1373 'mode' => $request->isXhr() ?
'ajax' : '',
1374 'page_title' => str_replace(
1377 _T('Review mass change %count members')
1379 'form_url' => $this->router
->pathFor('massstoremembers'),
1380 'cancel_uri' => $this->router
->pathFor('members'),
1382 'titles_list' => Titles
::getList($this->zdb
),
1383 'statuts' => $statuts->getList(),
1384 'changes' => $changes
1391 * Do massive changes
1393 * @param Request $request PSR Request
1394 * @param Response $response PSR Response
1398 public function doMassChange(Request
$request, Response
$response): Response
1400 $post = $request->getParsedBody();
1401 $redirect_url = $post['redirect_uri'];
1402 $error_detected = [];
1404 $dynamic_fields = null;
1406 unset($post['redirect_uri']);
1407 if (!isset($post['confirm'])) {
1408 $error_detected[] = _T("Mass changes has not been confirmed!");
1410 unset($post['confirm']);
1414 $fc = $this->fields_config
;
1415 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1416 $disabled = $this->members_fields
;
1417 foreach (array_keys($post) as $key) {
1419 foreach ($form_elements['fieldsets'] as $fieldset) {
1420 if (isset($fieldset->elements
[$key])) {
1427 //try on dynamic fields
1428 if ($dynamic_fields === null) {
1429 //handle dynamic fields
1438 $member = new Adherent($this->zdb
, null, $deps);
1439 $member->setDependencies(
1441 $this->members_fields
,
1444 $dynamic_fields = $member->getDynamicFields()->getFields();
1446 foreach ($dynamic_fields as $field) {
1447 $field_id = 'info_field_' . $field->getId() . '_1';
1448 if ($key == $field_id) {
1457 'Permission issue mass editing field ' . $key,
1462 unset($disabled[$key]);
1466 if (!count($post)) {
1467 $error_detected[] = _T("Nothing to do!");
1469 foreach ($ids as $id) {
1470 $is_manager = !$this->login
->isAdmin()
1471 && !$this->login
->isStaff()
1472 && $this->login
->isGroupManager();
1475 'groups' => $is_manager,
1478 'children' => false,
1481 $member = new Adherent($this->zdb
, (int)$id, $deps);
1482 $member->setDependencies(
1484 $this->members_fields
,
1487 if (!$member->canEdit($this->login
)) {
1491 $valid = $member->check($post, [], $disabled);
1492 if ($valid === true) {
1493 $done = $member->store();
1495 $error_detected[] = _T("An error occurred while storing the member.");
1500 $error_detected = array_merge($error_detected, $valid);
1506 if ($mass == 0 && !count($error_detected)) {
1507 $error_detected[] = _T('Something went wront during mass edition!');
1509 $this->flash
->addMessage(
1514 _T('%count members has been changed successfully!')
1519 if (count($error_detected) > 0) {
1520 foreach ($error_detected as $error) {
1521 $this->flash
->addMessage(
1528 if (!$request->isXhr()) {
1531 ->withHeader('Location', $redirect_url);
1533 return $response->withJson(
1535 'success' => count($error_detected) === 0
1544 * @param Request $request PSR Request
1545 * @param Response $response PSR Response
1549 public function store(Request
$request, Response
$response): Response
1551 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1554 ->withHeader('Location', $this->router
->pathFor('slash'));
1557 $post = $request->getParsedBody();
1566 $member = new Adherent($this->zdb
, null, $deps);
1567 $member->setDependencies(
1569 $this->members_fields
,
1573 $success_detected = [];
1574 $warning_detected = [];
1575 $error_detected = [];
1577 if ($this->isSelfMembership() && !isset($post[Adherent
::PK
])) {
1578 //mark as self membership
1579 $member->setSelfMembership();
1582 $gaptcha = $this->session
->gaptcha
;
1583 if (!$gaptcha->check($post['gaptcha'])) {
1584 $error_detected[] = _T('Invalid captcha');
1589 if (isset($post['id_adh'])) {
1590 $member->load((int)$post['id_adh']);
1591 if (!$member->canEdit($this->login
)) {
1592 //redirection should have been done before. Just throw an Exception.
1593 throw new \
RuntimeException(
1597 'No right to store member #%id'
1602 if ($member->id
!= '') {
1603 $member->load($this->login
->id
);
1607 // flagging required fields
1608 $fc = $this->fields_config
;
1610 // password required if we create a new member but not from self subscription
1611 if ($member->id
!= '' ||
$this->isSelfMembership()) {
1612 $fc->setNotRequired('mdp_adh');
1616 $member->hasParent() && !isset($post['detach_parent'])
1617 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1619 $parent_fields = $member->getParentFields();
1620 foreach ($parent_fields as $field) {
1621 if ($fc->isRequired($field)) {
1622 $fc->setNotRequired($field);
1627 // flagging required fields invisible to members
1628 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1629 $fc->setNotRequired('activite_adh');
1630 $fc->setNotRequired('id_statut');
1633 $form_elements = $fc->getFormElements(
1636 $this->isSelfMembership()
1638 $fieldsets = $form_elements['fieldsets'];
1639 $required = array();
1640 $disabled = array();
1642 foreach ($fieldsets as $category) {
1643 foreach ($category->elements
as $field) {
1644 if ($field->required
== true) {
1645 $required[$field->field_id
] = true;
1647 if ($field->disabled
== true) {
1648 $disabled[$field->field_id
] = true;
1649 } elseif (!isset($post[$field->field_id
])) {
1650 switch ($field->field_id
) {
1651 //unchecked booleans are not sent from form
1652 case 'bool_admin_adh':
1653 case 'bool_exempt_adh':
1654 case 'bool_display_info':
1655 $post[$field->field_id
] = 0;
1662 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1665 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1666 if (!count($real_requireds) ||
isset($post[array_shift($real_requireds)])) {
1668 $valid = $member->check($post, $required, $disabled);
1669 if ($valid !== true) {
1670 $error_detected = array_merge($error_detected, $valid);
1673 if (count($error_detected) == 0) {
1674 //all goes well, we can proceed
1677 if ($member->id
== '') {
1681 // send email to member
1682 if ($this->isSelfMembership() ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1683 $member->setSendmail(); //flag to send creation email
1686 $store = $member->store();
1687 if ($store === true) {
1688 //member has been stored :)
1690 if ($this->isSelfMembership()) {
1691 $success_detected[] = _T("Your account has been created!");
1693 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1694 && $member->getEmail() != ''
1696 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1699 $success_detected[] = _T("New member has been successfully added.");
1702 $success_detected[] = _T("Member account has been modified.");
1705 //store requested groups
1706 $groups_adh = $post['groups_adh'] ??
null;
1707 $managed_groups_adh = $post['groups_managed_adh'] ??
null;
1709 //add/remove user from groups
1710 $add_groups = Groups
::addMemberToGroups(
1715 if ($add_groups === false) {
1716 $error_detected[] = _T("An error occurred adding member to its groups.");
1719 //add/remove manager from groups
1720 $add_groups = Groups
::addMemberToGroups(
1722 $managed_groups_adh,
1725 $member->loadGroups();
1727 if ($add_groups === false) {
1728 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1731 //something went wrong :'(
1732 $error_detected[] = _T("An error occurred while storing the member.");
1736 if (count($error_detected) === 0) {
1737 $files_res = $member->handleFiles($_FILES);
1738 if (is_array($files_res)) {
1739 $error_detected = array_merge($error_detected, $files_res);
1742 if (isset($post['del_photo'])) {
1743 if (!$member->picture
->delete($member->id
)) {
1744 $error_detected[] = _T("Delete failed");
1745 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1747 'Unable to delete picture for member ' . $str_adh,
1754 if (count($error_detected) > 0) {
1755 foreach ($error_detected as $error) {
1756 if (strpos($error, '%member_url_') !== false) {
1757 preg_match('/%member_url_(\d+)/', $error, $matches);
1758 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1759 $error = str_replace(
1760 '%member_url_' . $matches[1],
1765 $this->flash
->addMessage(
1772 if (count($warning_detected) > 0) {
1773 foreach ($warning_detected as $warning) {
1774 $this->flash
->addMessage(
1780 if (count($success_detected) > 0) {
1781 foreach ($success_detected as $success) {
1782 $this->flash
->addMessage(
1789 if (count($error_detected) === 0) {
1790 if ($this->isSelfMembership()) {
1791 $redirect_url = $this->router
->pathFor('login');
1793 isset($post['redirect_on_create'])
1794 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1796 switch ($post['redirect_on_create']) {
1797 case Adherent
::AFTER_ADD_TRANS
:
1798 $redirect_url = $this->router
->pathFor('addTransaction');
1800 case Adherent
::AFTER_ADD_NEW
:
1801 $redirect_url = $this->router
->pathFor('addMember');
1803 case Adherent
::AFTER_ADD_SHOW
:
1804 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1806 case Adherent
::AFTER_ADD_LIST
:
1807 $redirect_url = $this->router
->pathFor('members');
1809 case Adherent
::AFTER_ADD_HOME
:
1810 $redirect_url = $this->router
->pathFor('slash');
1813 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1814 $redirect_url = $this->router
->pathFor(
1817 ) . '?id_adh=' . $member->id
;
1819 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1822 //store entity in session
1823 $this->session
->member
= $member;
1825 if ($this->isSelfMembership()) {
1826 $redirect_url = $this->router
->pathFor('subscribe');
1829 $redirect_url = $this->router
->pathFor(
1831 ['id' => $member->id
]
1834 $redirect_url = $this->router
->pathFor('addMember');
1842 ->withHeader('Location', $redirect_url);
1850 * Get redirection URI
1852 * @param array $args Route arguments
1856 public function redirectUri(array $args)
1858 return $this->router
->pathFor('members');
1864 * @param array $args Route arguments
1868 public function formUri(array $args)
1870 return $this->router
->pathFor(
1880 * In simple cases, we get the ID in the route arguments; but for
1881 * batchs, it should be found elsewhere.
1882 * In post values, we look for id key, as well as all {sthing}_sel keys (like members_sel or contrib_sel)
1884 * @param array $args Request arguments
1885 * @param array $post POST values
1887 * @return null|integer|integer[]
1889 protected function getIdsToRemove(&$args, $post)
1891 if (isset($args['id'])) {
1894 $filters = $this->session
->filter_members
;
1895 return $filters->selected
;
1900 * Get confirmation removal page title
1902 * @param array $args Route arguments
1906 public function confirmRemoveTitle(array $args)
1908 if (isset($args['id_adh']) ||
isset($args['id'])) {
1909 //one member removal
1910 $id_adh = $args['id_adh'] ??
$args['id'];
1911 $adh = new Adherent($this->zdb
, (int)$id_adh);
1913 _T('Remove member %1$s'),
1917 //batch members removal
1918 $filters = $this->session
->filter_members
;
1921 count($filters->selected
),
1922 _T('You are about to remove %count members.')
1930 * @param array $args Route arguments
1931 * @param array $post POST values
1935 protected function doDelete(array $args, array $post)
1937 if (isset($this->session
->filter_members
)) {
1938 $filters = $this->session
->filter_members
;
1940 $filters = new MembersList();
1942 $members = new Members($filters);
1944 if (!is_array($post['id'])) {
1945 $ids = (array)$post['id'];
1950 return $members->removeMembers($ids);
1956 * Set self memebrship flag
1958 * @return MembersController
1960 private function setSelfMembership(): MembersController
1962 $this->is_self_membership
= true;
1967 * Is self membership?
1971 private function isSelfMembership(): bool
1973 return $this->is_self_membership
;