3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette members controller
10 * Copyright © 2019-2023 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-2023 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 Galette\Features\BatchList
;
42 use Slim\Psr7\Request
;
43 use Slim\Psr7\Response
;
44 use Galette\Core\GaletteMail
;
45 use Galette\Core\Gaptcha
;
46 use Galette\Entity\Adherent
;
47 use Galette\Entity\Contribution
;
48 use Galette\Entity\ContributionsTypes
;
49 use Galette\Entity\DynamicFieldsHandle
;
50 use Galette\Entity\Group
;
51 use Galette\Entity\Status
;
52 use Galette\Entity\FieldsConfig
;
53 use Galette\Entity\Social
;
54 use Galette\Filters\AdvancedMembersList
;
55 use Galette\Filters\MembersList
;
57 use Galette\Repository\Groups
;
58 use Galette\Repository\Members
;
59 use Galette\Repository\PaymentTypes
;
60 use Galette\Repository\Titles
;
64 * Galette members controller
66 * @category Controllers
67 * @name GaletteController
69 * @author Johan Cwiklinski <johan@x-tnd.be>
70 * @copyright 2019-2023 The Galette Team
71 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
72 * @link http://galette.tuxfamily.org
73 * @since Available since 0.9.4dev - 2019-12-02
76 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->routeparser
->urlFor('slash'));
127 if ($this->session
->member
!== null) {
128 $member = $this->session
->member
;
129 $this->session
->member
= null;
131 $member = new Adherent($this->zdb
);
132 $member->enableDep('dynamics');
135 //mark as self membership
136 $member->setSelfMembership();
138 // flagging required fields
139 $fc = $this->fields_config
;
140 $form_elements = $fc->getFormElements($this->login
, true, true);
144 $members = $m->getDropdownMembers(
147 $member->hasParent() ?
$member->parent
->id
: null
152 'filters' => $m->getFilters(),
153 'count' => $m->getCount()
157 if (count($members)) {
158 $params['members']['list'] = $members;
161 $gaptcha = new Gaptcha($this->i18n
);
162 $this->session
->gaptcha
= $gaptcha;
164 $titles = new Titles($this->zdb
);
169 'pages/member_form.html.twig',
171 'page_title' => _T("Subscription"),
172 'parent_tpl' => 'public_page.html.twig',
175 'autocomplete' => true,
176 'osocials' => new Social($this->zdb
),
179 'titles_list' => $titles->getList(),
180 'fieldsets' => $form_elements['fieldsets'],
181 'hidden_elements' => $form_elements['hiddens'],
183 'gaptcha' => $gaptcha
192 * @param Request $request PSR Request
193 * @param Response $response PSR Response
197 public function doAdd(Request
$request, Response
$response): Response
199 return $this->store($request, $response);
203 * Self subscription add action
205 * @param Request $request PSR Request
206 * @param Response $response PSR Response
210 public function doSelfSubscribe(Request
$request, Response
$response): Response
212 $this->setSelfMembership();
213 return $this->doAdd($request, $response);
220 * @param Request $request PSR Request
221 * @param Response $response PSR Response
222 * @param integer $id_adh Member ID to duplicate
226 public function duplicate(Request
$request, Response
$response, int $id_adh): Response
228 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true, 'parent' => true]);
229 $adh->setDuplicate();
231 //store entity in session
232 $this->session
->member
= $adh;
236 ->withHeader('Location', $this->routeparser
->urlFor('addMember'));
243 * Display member card
245 * @param Request $request PSR Request
246 * @param Response $response PSR Response
247 * @param integer $id Member ID
251 public function show(Request
$request, Response
$response, int $id): Response
253 $member = new Adherent($this->zdb
);
258 if (!$member->canShow($this->login
)) {
259 $this->flash
->addMessage(
261 _T("You do not have permission for requested URL.")
268 $this->routeparser
->urlFor('me')
272 if ($member->id
== null) {
273 //member does not exist!
274 $this->flash
->addMessage(
276 str_replace('%id', $id, _T("No member #%id."))
282 $this->routeparser
->urlFor('slash')
286 // flagging fields visibility
287 $fc = $this->fields_config
;
288 $display_elements = $fc->getDisplayElements($this->login
);
293 'pages/member_show.html.twig',
295 'page_title' => _T("Member Profile"),
297 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
298 'pref_card_self' => $this->preferences
->pref_card_self
,
299 'groups' => Groups
::getSimpleList(),
301 'display_elements' => $display_elements,
302 'osocials' => new Social($this->zdb
),
303 'navigate' => $this->handleNavigationLinks($member->id
)
312 * @param Request $request PSR Request
313 * @param Response $response PSR Response
317 public function showMe(Request
$request, Response
$response): Response
319 if ($this->login
->isSuperAdmin()) {
322 ->withHeader('Location', $this->routeparser
->urlFor('slash'));
324 return $this->show($request, $response, $this->login
->id
);
328 * Public pages (trombinoscope, public list)
330 * @param Request $request PSR Request
331 * @param Response $response PSR Response
332 * @param string $option One of 'page' or 'order'
333 * @param string|integer $value Value of the option
334 * @param string $type List type (either list or trombi)
338 public function publicList(
345 $varname = 'public_filter_' . $type;
346 if (isset($this->session
->$varname)) {
347 $filters = $this->session
->$varname;
349 $filters = new MembersList();
352 if ($option !== null) {
355 $filters->current_page
= (int)$value;
358 $filters->orderby
= $value;
363 $m = new Members($filters);
364 $members = $m->getPublicList($type === 'trombi');
366 $this->session
->$varname = $filters;
368 //assign pagination variables to the template and add pagination links
369 $filters->setViewPagination($this->routeparser
, $this->view
, false);
374 ($type === 'list' ?
'pages/members_public_list' : 'pages/members_public_gallery') . '.html.twig',
376 'page_title' => ($type === 'list' ?
_T("Members list") : _T('Trombinoscope')),
377 'additionnal_html_class' => ($type === 'list' ?
'' : 'trombinoscope'),
379 'members' => $members,
380 'nb_members' => $m->getCount(),
381 'filters' => $filters,
390 * Public pages (trombinoscope, public list)
392 * @param Request $request PSR Request
393 * @param Response $response PSR Response
394 * @param string $type Type
398 public function filterPublicList(Request
$request, Response
$response, string $type): Response
400 $post = $request->getParsedBody();
402 $varname = 'public_filter_' . $type;
403 if (isset($this->session
->$varname)) {
404 $filters = $this->session
->$varname;
406 $filters = new MembersList();
409 //reintialize filters
410 if (isset($post['clear_filter'])) {
413 //number of rows to show
414 if (isset($post['nbshow'])) {
415 $filters->show
= (int)$post['nbshow'];
419 $this->session
->$varname = $filters;
423 ->withHeader('Location', $this->routeparser
->urlFor('publicList', ['type' => $type]));
429 * @param Request $request PSR Request
430 * @param Response $response PSR Response
431 * @param integer $id Member ID
432 * @param integer $fid Dynamic fields ID
433 * @param integer $pos Dynamic field position
434 * @param string $name File name
438 public function getDynamicFile(
446 $member = new Adherent($this->zdb
);
449 ->enableDep('dynamics')
453 if (!$member->canShow($this->login
)) {
454 $fields = $member->getDynamicFields()->getFields();
455 if (!isset($fields[$fid])) {
456 //field does not exist or access is forbidden
463 if ($denied === true) {
464 $this->flash
->addMessage(
466 _T("You do not have permission for requested URL.")
472 $this->routeparser
->urlFor(
479 $filename = str_replace(
490 'member_%mid_field_%fid_value_%pos'
493 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
494 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
496 $response = $response->withHeader('Content-Description', 'File Transfer')
497 ->withHeader('Content-Type', $type)
498 ->withHeader('Content-Disposition', 'attachment;filename="' . $name . '"')
499 ->withHeader('Pragma', 'no-cache')
500 ->withHeader('Content-Transfer-Encoding', 'binary')
501 ->withHeader('Expires', '0')
502 ->withHeader('Cache-Control', 'must-revalidate')
503 ->withHeader('Pragma', 'public');
505 $stream = fopen('php://memory', 'r+');
506 fwrite($stream, file_get_contents(GALETTE_FILES_PATH
. $filename));
509 return $response->withBody(new \Slim\Psr7\
Stream($stream));
512 'A request has been made to get a dynamic file named `' .
513 $filename . '` that does not exists.',
517 $this->flash
->addMessage(
519 _T("The file does not exists or cannot be read :(")
525 $this->routeparser
->urlFor('member', ['id' => $id])
533 * @param Request $request PSR Request
534 * @param Response $response PSR Response
535 * @param string $option One of 'page' or 'order'
536 * @param string|integer $value Value of the option
540 public function list(Request
$request, Response
$response, $option = null, $value = null): Response
542 if (isset($this->session
->filter_members
)) {
543 $filters = $this->session
->filter_members
;
545 $filters = new MembersList();
548 if ($option !== null) {
551 $filters->current_page
= (int)$value;
554 $filters->orderby
= $value;
559 $members = new Members($filters);
561 $members_list = array();
562 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
563 $members_list = $members->getMembersList(true);
565 $members_list = $members->getManagedMembersList(true);
568 $groups = new Groups($this->zdb
, $this->login
);
569 $groups_list = $groups->getList();
571 //assign pagination variables to the template and add pagination links
572 $filters->setViewPagination($this->routeparser
, $this->view
, false);
573 $filters->setViewCommonsFilters($this->preferences
, $this->view
);
575 $this->session
->filter_members
= $filters;
580 'pages/members_list.html.twig',
582 'page_title' => _T("Members management"),
583 'require_mass' => true,
584 'members' => $members_list,
585 'filter_groups_options' => $groups_list,
586 'nb_members' => $members->getCount(),
587 'filters' => $filters,
588 'adv_filters' => $filters instanceof AdvancedMembersList
,
589 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
598 * @param Request $request PSR Request
599 * @param Response $response PSR Response
603 public function filter(Request
$request, Response
$response): Response
605 $post = $request->getParsedBody();
606 if (isset($this->session
->filter_members
)) {
607 //CAUTION: this one may be simple or advanced, display must change
608 $filters = $this->session
->filter_members
;
610 $filters = new MembersList();
613 //reintialize filters
614 if (isset($post['clear_filter'])) {
615 $filters = new MembersList();
616 } elseif (isset($post['clear_adv_filter'])) {
617 $this->session
->filter_members
= null;
618 unset($this->session
->filter_members
);
622 ->withHeader('Location', $this->routeparser
->urlFor('advanced-search'));
623 } elseif (isset($post['adv_criteria'])) {
626 ->withHeader('Location', $this->routeparser
->urlFor('advanced-search'));
629 if (isset($post['filter_str'])) { //filter search string
630 $filters->filter_str
= stripslashes(
631 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
635 if (isset($post['field_filter'])) {
636 if (is_numeric($post['field_filter'])) {
637 $filters->field_filter
= $post['field_filter'];
640 //membership to filter
641 if (isset($post['membership_filter'])) {
642 if (is_numeric($post['membership_filter'])) {
643 $filters->membership_filter
644 = $post['membership_filter'];
647 //account status to filter
648 if (isset($post['filter_account'])) {
649 if (is_numeric($post['filter_account'])) {
650 $filters->filter_account
= $post['filter_account'];
654 if (isset($post['email_filter'])) {
655 $filters->email_filter
= (int)$post['email_filter'];
659 isset($post['group_filter'])
660 && $post['group_filter'] > 0
662 $filters->group_filter
= (int)$post['group_filter'];
664 //number of rows to show
665 if (isset($post['nbshow'])) {
666 $filters->show
= (int)$post['nbshow'];
669 if (isset($post['advanced_filtering'])) {
670 if (!$filters instanceof AdvancedMembersList
) {
671 $filters = new AdvancedMembersList($filters);
675 unset($post['advanced_filtering']);
677 foreach ($post as $k => $v) {
678 if (strpos($k, 'free_', 0) === 0) {
681 foreach ($post['free_field'] as $f) {
684 && trim($post['free_text'][$i]) !== ''
686 $fs_search = htmlspecialchars($post['free_text'][$i], ENT_QUOTES
);
688 = (int)$post['free_logical_operator'][$i];
690 = (int)$post['free_query_operator'][$i];
691 $type = (int)$post['free_type'][$i];
696 'search' => $fs_search,
700 $filters->free_search
= $fs;
706 } elseif ($k == 'groups_search') {
708 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
709 foreach ($post['groups_search'] as $g) {
710 if (trim($g) !== '') {
715 $filters->groups_search
= $gs;
721 case 'contrib_min_amount':
722 case 'contrib_max_amount':
723 if (trim($v) !== '') {
736 if (isset($post['savesearch'])) {
741 $this->routeparser
->urlFor(
748 $this->session
->filter_members
= $filters;
752 ->withHeader('Location', $this->routeparser
->urlFor('members'));
756 * Advanced search page
758 * @param Request $request PSR Request
759 * @param Response $response PSR Response
763 public function advancedSearch(Request
$request, Response
$response): Response
765 if (isset($this->session
->filter_members
)) {
766 $filters = $this->session
->filter_members
;
767 if (!$filters instanceof AdvancedMembersList
) {
768 $filters = new AdvancedMembersList($filters);
771 $filters = new AdvancedMembersList();
774 $groups = new Groups($this->zdb
, $this->login
);
775 $groups_list = $groups->getList();
777 //we want only visible fields
778 $fields = $this->members_fields
;
779 $fc = $this->fields_config
;
780 $fc->filterVisible($this->login
, $fields);
782 //add status label search
783 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
784 $fields = array_slice($fields, 0, $pos, true) +
785 ['status_label' => ['label' => _T('Status label')]] +
786 array_slice($fields, $pos, count($fields) - 1, true);
790 $member = new Adherent($this->zdb
);
793 ->enableDep('dynamics')
794 ->loadFromLoginOrMail($this->login
->login
);
795 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
797 $contrib = new Contribution($this->zdb
, $this->login
);
798 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
801 $statuts = new Status($this->zdb
);
803 //Contributions types
804 $ct = new ContributionsTypes($this->zdb
);
807 $ptypes = new PaymentTypes(
812 $ptlist = $ptypes->getList();
814 $filters->setViewCommonsFilters($this->preferences
, $this->view
);
816 $social = new Social($this->zdb
);
817 $types = $member->getMemberRegisteredTypes();
819 foreach ($types as $type) {
820 $social_types[$type] = $social->getSystemType($type);
826 'pages/advanced_search.html.twig',
828 'page_title' => _T("Advanced search"),
829 'filter_groups_options' => $groups_list,
830 'search_fields' => $fields,
831 'adh_dynamics' => $adh_dynamics->getFields(),
832 'contrib_dynamics' => $contrib_dynamics->getFields(),
833 'adh_socials' => $social_types,
834 'statuts' => $statuts->getList(),
835 'contributions_types' => $ct->getList(),
836 'filters' => $filters,
837 'payments_types' => $ptlist
844 * Members list for ajax
846 * @param Request $request PSR Request
847 * @param Response $response PSR Response
848 * @param string|null $option One of 'page' or 'order'
849 * @param string|integer $value Value of the option
853 public function ajaxList(Request
$request, Response
$response, string $option = null, $value = null): Response
855 $post = $request->getParsedBody();
857 $filters = $this->session
->ajax_members_filters ??
new MembersList();
859 if ($option == 'page') {
860 $filters->current_page
= (int)$value;
863 //numbers of rows to display
864 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
865 $filters->show
= (int)$post['nbshow'];
868 $members = new Members($filters);
869 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
870 if ($this->login
->isGroupManager()) {
871 $members_list = $members->getManagedMembersList(true);
876 [$this->login
->id
, $this->login
->login
],
877 'Trying to list group members without access from #%id (%login)'
881 throw new \
Exception('Access denied.');
884 $members_list = $members->getMembersList(true);
887 //assign pagination variables to the template and add pagination links
888 $filters->setViewPagination($this->routeparser
, $this->view
, false);
890 $this->session
->ajax_members_filters
= $filters;
892 $selected_members = null;
893 $unreachables_members = null;
894 if (!isset($post['from'])) {
895 $mailing = $this->session
->mailing
;
896 if (!isset($post['members'])) {
897 $selected_members = $mailing->recipients
;
898 $unreachables_members = $mailing->unreachables
;
901 $selected_members = $m->getArrayList($post['members']);
902 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
903 $unreachables_members = $m->getArrayList($post['unreachables']);
907 switch ($post['from']) {
909 if (!isset($post['gid'])) {
911 'Trying to list group members with no group id provided',
914 throw new \
Exception('A group id is required.');
916 if (!isset($post['members'])) {
917 $group = new Group((int)$post['gid']);
918 $selected_members = array();
919 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
920 $selected_members = $group->getMembers();
921 } elseif ($post['mode'] == 'managers') {
922 $selected_members = $group->getManagers();
925 'Trying to list group members with unknown mode',
928 throw new \
Exception('Unknown mode.');
932 $selected_members = $m->getArrayList($post['members']);
933 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
934 $unreachables_members = $m->getArrayList($post['unreachables']);
939 if (!isset($post['id_adh'])) {
940 throw new \
RuntimeException(
941 'Current selected member must be excluded while attaching!'
949 'filters' => $filters,
950 'members_list' => $members_list,
951 'selected_members' => $selected_members,
952 'unreachables_members' => $unreachables_members
955 if (isset($post['multiple'])) {
956 $params['multiple'] = true;
959 if (isset($post['gid'])) {
960 $params['the_id'] = (int)$post['gid'];
963 if (isset($post['id_adh'])) {
964 $params['excluded'] = (int)$post['id_adh'];
970 'elements/ajax_members.html.twig',
977 * Batch actions handler
979 * @param Request $request PSR Request
980 * @param Response $response PSR Response
984 public function handleBatch(Request
$request, Response
$response): Response
986 $post = $request->getParsedBody();
988 if (isset($post['entries_sel'])) {
989 if (isset($this->session
->filter_members
)) {
990 $filters = $this->session
->filter_members
;
992 $filters = new MembersList();
995 $filters->selected
= $post['entries_sel'];
996 $this->session
->filter_members
= $filters;
998 if (isset($post['cards'])) {
1001 ->withHeader('Location', $this->routeparser
->urlFor('pdf-members-cards'));
1004 if (isset($post['labels'])) {
1007 ->withHeader('Location', $this->routeparser
->urlFor('pdf-members-labels'));
1010 if (isset($post['sendmail'])) {
1013 ->withHeader('Location', $this->routeparser
->urlFor('mailing') . '?mailing_new=new');
1016 if (isset($post['attendance_sheet'])) {
1019 ->withHeader('Location', $this->routeparser
->urlFor('attendance_sheet_details'));
1022 if (isset($post['csv'])) {
1025 ->withHeader('Location', $this->routeparser
->urlFor('csv-memberslist'));
1028 if (isset($post['delete'])) {
1031 ->withHeader('Location', $this->routeparser
->urlFor('removeMembers'));
1034 if (isset($post['masschange'])) {
1037 ->withHeader('Location', $this->routeparser
->urlFor('masschangeMembers'));
1040 if (isset($post['masscontributions'])) {
1043 ->withHeader('Location', $this->routeparser
->urlFor('massAddContributionsChooseType'));
1046 throw new \
RuntimeException('Does not know what to batch :(');
1048 $this->flash
->addMessage(
1050 _T("No member was selected, please check at least one name.")
1055 ->withHeader('Location', $this->routeparser
->urlFor('members'));
1065 * @param Request $request PSR Request
1066 * @param Response $response PSR Response
1067 * @param integer $id Member id/array of members id
1068 * @param string $action null or 'add'
1072 public function edit(
1076 string $action = 'edit'
1078 //instantiate member object
1079 $member = new Adherent($this->zdb
);
1081 if ($this->session
->member
!== null) {
1082 //retrieve from session, in add or edit
1083 $member = $this->session
->member
;
1084 $this->session
->member
= null;
1087 $member->enableAllDeps();
1090 //load requested member
1092 $can = $member->canEdit($this->login
);
1094 $can = $member->canCreate($this->login
);
1098 $this->flash
->addMessage(
1100 _T("You do not have permission for requested URL.")
1106 $this->routeparser
->urlFor('me')
1110 //if adding a child, force parent here
1111 if ($action === 'addchild') {
1112 $member->setParent((int)$this->login
->id
);
1115 // flagging required fields
1116 $fc = $this->fields_config
;
1118 // password required if we create a new member
1120 $fc->setNotRequired('mdp_adh');
1123 //handle requirements for parent fields
1124 $parent_fields = $member->getParentFields();
1125 $tpl_parent_fields = []; //for JS when detaching
1126 foreach ($parent_fields as $field) {
1127 if ($fc->isRequired($field)) {
1128 $tpl_parent_fields[] = $field;
1129 if ($member->hasParent()) {
1130 $fc->setNotRequired($field);
1135 // flagging required fields invisible to members
1136 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1137 $fc->setNotRequired('activite_adh');
1138 $fc->setNotRequired('id_statut');
1141 // template variable declaration
1142 $title = _T("Member Profile");
1143 if ($member->id
!= '') {
1144 $title .= ' (' . _T("modification") . ')';
1146 $title .= ' (' . _T("creation") . ')';
1150 $statuts = new Status($this->zdb
);
1152 $titles = new Titles($this->zdb
);
1155 $groups = new Groups($this->zdb
, $this->login
);
1156 $groups_list = $groups->getSimpleList(true);
1158 $form_elements = $fc->getFormElements(
1166 if ($member->hasParent()) {
1167 $pid = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1169 $members = $m->getDropdownMembers(
1175 $route_params['members'] = [
1176 'filters' => $m->getFilters(),
1177 'count' => $m->getCount()
1180 if (count($members)) {
1181 $route_params['members']['list'] = $members;
1184 if ($action === 'edit') {
1185 $route_params['navigate'] = $this->handleNavigationLinks($member->id
);
1189 $this->view
->render(
1191 'pages/member_form.html.twig',
1193 'parent_tpl' => 'page.html.twig',
1194 'autocomplete' => true,
1195 'page_title' => $title,
1196 'member' => $member,
1197 'self_adh' => false,
1198 // pseudo random int
1200 'titles_list' => $titles->getList(),
1201 'statuts' => $statuts->getList(),
1202 'groups' => $groups_list,
1203 'fieldsets' => $form_elements['fieldsets'],
1204 'hidden_elements' => $form_elements['hiddens'],
1205 'parent_fields' => $tpl_parent_fields,
1206 'addchild' => ($action === 'addchild'),
1207 'osocials' => new Social($this->zdb
)
1216 * @param Request $request PSR Request
1217 * @param Response $response PSR Response
1218 * @param integer $id Member id
1222 public function doEdit(Request
$request, Response
$response, int $id): Response
1224 return $this->store($request, $response);
1228 * Massive change page
1230 * @param Request $request PSR Request
1231 * @param Response $response PSR Response
1235 public function massChange(Request
$request, Response
$response): Response
1237 $filters = $this->session
->filter_members
;
1240 'id' => $filters->selected
,
1241 'redirect_uri' => $this->routeparser
->urlFor('members')
1244 $fc = $this->fields_config
;
1245 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1248 $member = new Adherent($this->zdb
);
1249 $member->disableAllDeps()->enableDep('dynamics');
1252 $statuts = new Status($this->zdb
);
1254 $titles = new Titles($this->zdb
);
1257 $this->view
->render(
1259 'modals/mass_change_members.html.twig',
1261 'mode' => ($request->getHeaderLine('X-Requested-With') === 'XMLHttpRequest') ?
'ajax' : '',
1262 'page_title' => str_replace(
1265 _T('Mass change %count members')
1267 'form_url' => $this->routeparser
->urlFor('masschangeMembersReview'),
1268 'cancel_uri' => $this->routeparser
->urlFor('members'),
1270 'member' => $member,
1271 'fieldsets' => $form_elements['fieldsets'],
1272 'titles_list' => $titles->getList(),
1273 'statuts' => $statuts->getList(),
1274 'require_mass' => true
1281 * Massive changes validation page
1283 * @param Request $request PSR Request
1284 * @param Response $response PSR Response
1288 public function validateMassChange(Request
$request, Response
$response): Response
1290 $post = $request->getParsedBody();
1293 if (!isset($post['confirm'])) {
1294 $this->flash
->addMessage(
1296 _T("Mass changes has not been confirmed!")
1299 //we want only visibles fields
1300 $fc = $this->fields_config
;
1301 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1303 foreach ($form_elements['fieldsets'] as $form_element) {
1304 foreach ($form_element->elements
as $field) {
1306 isset($post['mass_' . $field->field_id
])
1307 && (isset($post[$field->field_id
]) ||
$field->type
=== FieldsConfig
::TYPE_BOOL
)
1309 $changes[$field->field_id
] = [
1310 'label' => $field->label
,
1311 'value' => $post[$field->field_id
] ??
0
1317 //handle dynamic fields
1318 $member = new Adherent($this->zdb
);
1323 $this->members_fields
,
1326 $dynamic_fields = $member->getDynamicFields()->getFields();
1327 foreach ($dynamic_fields as $field) {
1328 $mass_id = 'mass_info_field_' . $field->getId();
1329 $field_id = 'info_field_' . $field->getId() . '_1';
1331 isset($post[$mass_id])
1332 && (isset($post[$field_id]) ||
$field instanceof Boolean
)
1334 $changes[$field_id] = [
1335 'label' => $field->getName(),
1336 'value' => $post[$field_id] ??
0
1342 $filters = $this->session
->filter_members
;
1344 'id' => $filters->selected
,
1345 'redirect_uri' => $this->routeparser
->urlFor('members')
1349 $statuts = new Status($this->zdb
);
1351 $titles = new Titles($this->zdb
);
1354 $this->view
->render(
1356 'modals/mass_change_members.html.twig',
1358 'mode' => ($request->getHeaderLine('X-Requested-With') === 'XMLHttpRequest') ?
'ajax' : '',
1359 'page_title' => str_replace(
1362 _T('Review mass change %count members')
1364 'form_url' => $this->routeparser
->urlFor('massstoremembers'),
1365 'cancel_uri' => $this->routeparser
->urlFor('members'),
1367 'titles_list' => $titles->getList(),
1368 'statuts' => $statuts->getList(),
1369 'changes' => $changes
1376 * Do massive changes
1378 * @param Request $request PSR Request
1379 * @param Response $response PSR Response
1383 public function doMassChange(Request
$request, Response
$response): Response
1385 $post = $request->getParsedBody();
1386 $redirect_url = $post['redirect_uri'];
1387 $error_detected = [];
1389 $dynamic_fields = null;
1391 unset($post['redirect_uri']);
1392 if (!isset($post['confirm'])) {
1393 $error_detected[] = _T("Mass changes has not been confirmed!");
1395 unset($post['confirm']);
1399 $fc = $this->fields_config
;
1400 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1401 $disabled = $this->members_fields
;
1402 foreach (array_keys($post) as $key) {
1404 foreach ($form_elements['fieldsets'] as $fieldset) {
1405 if (isset($fieldset->elements
[$key])) {
1412 //try on dynamic fields
1413 if ($dynamic_fields === null) {
1414 //handle dynamic fields
1415 $member = new Adherent($this->zdb
);
1420 $this->members_fields
,
1423 $dynamic_fields = $member->getDynamicFields()->getFields();
1425 foreach ($dynamic_fields as $field) {
1426 $field_id = 'info_field_' . $field->getId() . '_1';
1427 if ($key == $field_id) {
1436 'Permission issue mass editing field ' . $key,
1441 unset($disabled[$key]);
1445 if (!count($post)) {
1446 $error_detected[] = _T("Nothing to do!");
1448 foreach ($ids as $id) {
1449 $is_manager = !$this->login
->isAdmin()
1450 && !$this->login
->isStaff()
1451 && $this->login
->isGroupManager();
1452 $member = new Adherent($this->zdb
);
1453 $member->disableAllDeps();
1455 $member->enableDep('groups');
1457 $member->load((int)$id);
1458 $member->setDependencies(
1460 $this->members_fields
,
1463 if (!$member->canEdit($this->login
)) {
1467 $valid = $member->check($post, [], $disabled);
1468 if ($valid === true) {
1469 $done = $member->store();
1471 $error_detected[] = _T("An error occurred while storing the member.");
1476 $error_detected = array_merge($error_detected, $valid);
1482 if ($mass == 0 && !count($error_detected)) {
1483 $error_detected[] = _T('Something went wront during mass edition!');
1485 $this->flash
->addMessage(
1490 _T('%count members has been changed successfully!')
1495 if (count($error_detected) > 0) {
1496 foreach ($error_detected as $error) {
1497 $this->flash
->addMessage(
1504 if (!($request->getHeaderLine('X-Requested-With') === 'XMLHttpRequest')) {
1507 ->withHeader('Location', $redirect_url);
1509 return $this->withJson(
1512 'success' => count($error_detected) === 0
1521 * @param Request $request PSR Request
1522 * @param Response $response PSR Response
1526 public function store(Request
$request, Response
$response): Response
1528 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1531 ->withHeader('Location', $this->routeparser
->urlFor('slash'));
1534 $post = $request->getParsedBody();
1535 $member = new Adherent($this->zdb
);
1540 $this->members_fields
,
1544 $success_detected = [];
1545 $warning_detected = [];
1546 $error_detected = [];
1548 if ($this->isSelfMembership() && !isset($post[Adherent
::PK
])) {
1549 //mark as self membership
1550 $member->setSelfMembership();
1553 $gaptcha = $this->session
->gaptcha
;
1554 if (!$gaptcha->check($post['gaptcha'])) {
1555 $error_detected[] = _T('Invalid captcha');
1560 if (isset($post['id_adh'])) {
1561 $member->load((int)$post['id_adh']);
1562 if (!$member->canEdit($this->login
)) {
1563 //redirection should have been done before. Just throw an Exception.
1564 throw new \
RuntimeException(
1568 'No right to store member #%id'
1573 if ($member->id
!= '') {
1574 $member->load($this->login
->id
);
1578 // flagging required fields
1579 $fc = $this->fields_config
;
1581 // password required if we create a new member but not from self subscription
1582 if ($member->id
!= '' ||
$this->isSelfMembership()) {
1583 $fc->setNotRequired('mdp_adh');
1587 $member->hasParent() && !isset($post['detach_parent'])
1588 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1590 $parent_fields = $member->getParentFields();
1591 foreach ($parent_fields as $field) {
1592 if ($fc->isRequired($field)) {
1593 $fc->setNotRequired($field);
1598 // flagging required fields invisible to members
1599 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1600 $fc->setNotRequired('activite_adh');
1601 $fc->setNotRequired('id_statut');
1604 $form_elements = $fc->getFormElements(
1607 $this->isSelfMembership()
1609 $fieldsets = $form_elements['fieldsets'];
1610 $required = array();
1611 $disabled = array();
1613 foreach ($fieldsets as $category) {
1614 foreach ($category->elements
as $field) {
1615 if ($field->required
== true) {
1616 $required[$field->field_id
] = true;
1618 if ($field->disabled
== true) {
1619 $disabled[$field->field_id
] = true;
1620 } elseif (!isset($post[$field->field_id
])) {
1621 switch ($field->field_id
) {
1622 //unchecked booleans are not sent from form
1623 case 'bool_admin_adh':
1624 case 'bool_exempt_adh':
1625 case 'bool_display_info':
1626 $post[$field->field_id
] = 0;
1633 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1635 // send email to member
1636 if ($this->isSelfMembership() ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1637 $member->setSendmail(); //flag to send creation email
1641 $redirect_url = $this->routeparser
->urlFor('member', ['id' => $member->id
]);
1642 if (!count($real_requireds) ||
isset($post[array_shift($real_requireds)])) {
1644 $valid = $member->check($post, $required, $disabled);
1645 if ($valid !== true) {
1646 $error_detected = array_merge($error_detected, $valid);
1649 if (count($error_detected) == 0) {
1650 //all goes well, we can proceed
1653 if ($member->id
== '') {
1657 $store = $member->store();
1658 if ($store === true) {
1659 //member has been stored :)
1661 if ($this->isSelfMembership()) {
1662 $success_detected[] = _T("Your account has been created!");
1664 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1665 && $member->getEmail() != ''
1667 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1670 $success_detected[] = _T("New member has been successfully added.");
1673 $success_detected[] = _T("Member account has been modified.");
1676 if ($this->login
->isGroupManager()) {
1677 //add/remove user from groups
1678 $groups_adh = $post['groups_adh'] ??
null;
1679 $add_groups = Groups
::addMemberToGroups(
1684 if ($add_groups === false) {
1685 $error_detected[] = _T("An error occurred adding member to its groups.");
1688 if ($this->login
->isSuperAdmin() ||
$this->login
->isAdmin() ||
$this->login
->isStaff()) {
1689 //add/remove manager from groups
1690 $managed_groups_adh = $post['groups_managed_adh'] ??
null;
1691 $add_groups = Groups
::addMemberToGroups(
1693 $managed_groups_adh,
1696 $member->loadGroups();
1698 if ($add_groups === false) {
1699 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1703 //something went wrong :'(
1704 $error_detected[] = _T("An error occurred while storing the member.");
1708 if (count($error_detected) === 0) {
1709 $files_res = $member->handleFiles($_FILES);
1710 if (is_array($files_res)) {
1711 $error_detected = array_merge($error_detected, $files_res);
1714 if (isset($post['del_photo'])) {
1715 if (!$member->picture
->delete($member->id
)) {
1716 $error_detected[] = _T("Delete failed");
1717 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1719 'Unable to delete picture for member ' . $str_adh,
1726 if (count($error_detected) > 0) {
1727 foreach ($error_detected as $error) {
1728 if (strpos($error, '%member_url_') !== false) {
1729 preg_match('/%member_url_(\d+)/', $error, $matches);
1730 $url = $this->routeparser
->urlFor('member', ['id' => $matches[1]]);
1731 $error = str_replace(
1732 '%member_url_' . $matches[1],
1737 $this->flash
->addMessage(
1744 if (count($warning_detected) > 0) {
1745 foreach ($warning_detected as $warning) {
1746 $this->flash
->addMessage(
1752 if (count($success_detected) > 0) {
1753 foreach ($success_detected as $success) {
1754 $this->flash
->addMessage(
1761 if (count($error_detected) === 0) {
1762 if ($this->isSelfMembership()) {
1763 $redirect_url = $this->routeparser
->urlFor('login');
1765 isset($post['redirect_on_create'])
1766 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1768 switch ($post['redirect_on_create']) {
1769 case Adherent
::AFTER_ADD_TRANS
:
1770 $redirect_url = $this->routeparser
->urlFor('addTransaction');
1772 case Adherent
::AFTER_ADD_NEW
:
1773 $redirect_url = $this->routeparser
->urlFor('addMember');
1775 case Adherent
::AFTER_ADD_SHOW
:
1776 $redirect_url = $this->routeparser
->urlFor('member', ['id' => $member->id
]);
1778 case Adherent
::AFTER_ADD_LIST
:
1779 $redirect_url = $this->routeparser
->urlFor('members');
1781 case Adherent
::AFTER_ADD_HOME
:
1782 $redirect_url = $this->routeparser
->urlFor('slash');
1785 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1786 $redirect_url = $this->routeparser
->urlFor(
1789 ) . '?id_adh=' . $member->id
;
1791 $redirect_url = $this->routeparser
->urlFor('member', ['id' => $member->id
]);
1794 //store entity in session
1795 $this->session
->member
= $member;
1797 if ($this->isSelfMembership()) {
1798 $redirect_url = $this->routeparser
->urlFor('subscribe');
1801 $redirect_url = $this->routeparser
->urlFor(
1803 ['id' => $member->id
]
1806 $redirect_url = $this->routeparser
->urlFor((isset($post['addchild']) ?
'addMemberChild' : 'addMember'));
1814 ->withHeader('Location', $redirect_url);
1822 * Get redirection URI
1824 * @param array $args Route arguments
1828 public function redirectUri(array $args)
1830 return $this->routeparser
->urlFor('members');
1836 * @param array $args Route arguments
1840 public function formUri(array $args)
1842 return $this->routeparser
->urlFor(
1849 * Get confirmation removal page title
1851 * @param array $args Route arguments
1855 public function confirmRemoveTitle(array $args)
1857 if (isset($args['id_adh']) ||
isset($args['id'])) {
1858 //one member removal
1859 $id_adh = $args['id_adh'] ??
$args['id'];
1860 $adh = new Adherent($this->zdb
, (int)$id_adh);
1862 _T('Remove member %1$s'),
1866 //batch members removal
1867 $filters = $this->session
->filter_members
;
1870 count($filters->selected
),
1871 _T('You are about to remove %count members.')
1879 * @param array $args Route arguments
1880 * @param array $post POST values
1884 protected function doDelete(array $args, array $post)
1886 if (isset($this->session
->filter_members
)) {
1887 $filters = $this->session
->filter_members
;
1889 $filters = new MembersList();
1891 $members = new Members($filters);
1893 if (!is_array($post['id'])) {
1894 $ids = (array)$post['id'];
1899 return $members->removeMembers($ids);
1905 * Set self memebrship flag
1907 * @return MembersController
1909 private function setSelfMembership(): MembersController
1911 $this->is_self_membership
= true;
1916 * Is self membership?
1920 private function isSelfMembership(): bool
1922 return $this->is_self_membership
;
1926 * Handle navigation links
1928 * @param int $id_adh Current member ID
1932 private function handleNavigationLinks(int $id_adh): array
1934 $navigate = array();
1936 if (isset($this->session
->filter_members
)) {
1937 $filters = $this->session
->filter_members
;
1939 $filters = new MembersList();
1941 //we must navigate between all members
1945 $this->login
->isAdmin()
1946 ||
$this->login
->isStaff()
1947 ||
$this->login
->isGroupManager()
1949 $m = new Members($filters);
1952 $fields = [Adherent
::PK
, 'nom_adh', 'prenom_adh'];
1953 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1954 $ids = $m->getMembersList(false, $fields);
1956 $ids = $m->getManagedMembersList(false, $fields);
1959 $ids = $ids->toArray();
1960 foreach ($ids as $k => $m) {
1961 if ($m['id_adh'] == $id_adh) {
1963 'cur' => $m['id_adh'],
1964 'count' => $filters->counter
,
1968 $navigate['prev'] = $ids[$k - 1]['id_adh'];
1970 if ($k < count($ids) - 1) {
1971 $navigate['next'] = $ids[$k +
1]['id_adh'];
1982 * Get filter name in session
1984 * @param array|null $args Route arguments
1988 public function getFilterName(array $args = null): string
1990 return 'filter_members';