3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette members controller
10 * Copyright © 2019-2022 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-2022 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\Entity\Social
;
53 use Galette\Filters\AdvancedMembersList
;
54 use Galette\Filters\MembersList
;
56 use Galette\Repository\Groups
;
57 use Galette\Repository\Members
;
58 use Galette\Repository\PaymentTypes
;
59 use Galette\Repository\Titles
;
63 * Galette members controller
65 * @category Controllers
66 * @name GaletteController
68 * @author Johan Cwiklinski <johan@x-tnd.be>
69 * @copyright 2019-2022 The Galette Team
70 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
71 * @link http://galette.tuxfamily.org
72 * @since Available since 0.9.4dev - 2019-12-02
75 class MembersController
extends CrudController
78 private $is_self_membership = false;
85 * @param Request $request PSR Request
86 * @param Response $response PSR Response
90 public function add(Request
$request, Response
$response): Response
92 return $this->edit($request, $response, null, 'add');
98 * @param Request $request PSR Request
99 * @param Response $response PSR Response
103 public function addChild(Request
$request, Response
$response): Response
105 return $this->edit($request, $response, null, 'addchild');
109 * Self subscription page
111 * @param Request $request PSR Request
112 * @param Response $response PSR Response
116 public function selfSubscribe(Request
$request, Response
$response): Response
118 if (!$this->preferences
->pref_bool_selfsubscribe ||
$this->login
->isLogged()) {
121 ->withHeader('Location', $this->router
->pathFor('slash'));
124 if ($this->session
->member
!== null) {
125 $member = $this->session
->member
;
126 $this->session
->member
= null;
128 $member = new Adherent($this->zdb
);
129 $member->enableDep('dynamics');
132 //mark as self membership
133 $member->setSelfMembership();
135 // flagging required fields
136 $fc = $this->fields_config
;
137 $form_elements = $fc->getFormElements($this->login
, true, true);
141 $members = $m->getSelectizedMembers(
144 $member->hasParent() ?
$member->parent
->id
: null
149 'filters' => $m->getFilters(),
150 'count' => $m->getCount()
154 if (count($members)) {
155 $params['members']['list'] = $members;
158 $gaptcha = new Gaptcha($this->i18n
);
159 $this->session
->gaptcha
= $gaptcha;
163 'pages/member_form.html.twig',
165 'page_title' => _T("Subscription"),
166 'parent_tpl' => 'public_page.html.twig',
169 'autocomplete' => true,
170 'osocials' => new Social($this->zdb
),
173 'titles_list' => Titles
::getList($this->zdb
),
174 'fieldsets' => $form_elements['fieldsets'],
175 'hidden_elements' => $form_elements['hiddens'],
177 'gaptcha' => $gaptcha
186 * @param Request $request PSR Request
187 * @param Response $response PSR Response
191 public function doAdd(Request
$request, Response
$response): Response
193 return $this->store($request, $response);
197 * Self subscription add action
199 * @param Request $request PSR Request
200 * @param Response $response PSR Response
204 public function doSelfSubscribe(Request
$request, Response
$response): Response
206 $this->setSelfMembership();
207 return $this->doAdd($request, $response);
214 * @param Request $request PSR Request
215 * @param Response $response PSR Response
216 * @param integer $id_adh Member ID to duplicate
220 public function duplicate(Request
$request, Response
$response, int $id_adh): Response
222 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true, 'parent' => true]);
223 $adh->setDuplicate();
225 //store entity in session
226 $this->session
->member
= $adh;
230 ->withHeader('Location', $this->router
->pathFor('addMember'));
237 * Display member card
239 * @param Request $request PSR Request
240 * @param Response $response PSR Response
241 * @param integer $id Member ID
245 public function show(Request
$request, Response
$response, int $id): Response
247 $member = new Adherent($this->zdb
);
252 if (!$member->canShow($this->login
)) {
253 $this->flash
->addMessage(
255 _T("You do not have permission for requested URL.")
262 $this->router
->pathFor('me')
266 if ($member->id
== null) {
267 //member does not exists!
268 $this->flash
->addMessage(
270 str_replace('%id', $id, _T("No member #%id."))
276 $this->router
->pathFor('slash')
280 // flagging fields visibility
281 $fc = $this->fields_config
;
282 $display_elements = $fc->getDisplayElements($this->login
);
289 'page_title' => _T("Member Profile"),
291 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
292 'pref_card_self' => $this->preferences
->pref_card_self
,
293 'groups' => Groups
::getSimpleList(),
295 'display_elements' => $display_elements,
296 'osocials' => new Social($this->zdb
)
305 * @param Request $request PSR Request
306 * @param Response $response PSR Response
310 public function showMe(Request
$request, Response
$response): Response
312 if ($this->login
->isSuperAdmin()) {
315 ->withHeader('Location', $this->router
->pathFor('slash'));
317 return $this->show($request, $response, $this->login
->id
);
321 * Public pages (trombinoscope, public list)
323 * @param Request $request PSR Request
324 * @param Response $response PSR Response
325 * @param string $option One of 'page' or 'order'
326 * @param string|integer $value Value of the option
327 * @param string $type List type (either list or trombi)
331 public function publicList(
338 $varname = 'public_filter_' . $type;
339 if (isset($this->session
->$varname)) {
340 $filters = $this->session
->$varname;
342 $filters = new MembersList();
345 if ($option !== null) {
348 $filters->current_page
= (int)$value;
351 $filters->orderby
= $value;
356 $m = new Members($filters);
357 $members = $m->getPublicList($type === 'trombi');
359 $this->session
->$varname = $filters;
361 //assign pagination variables to the template and add pagination links
362 $filters->setSmartyPagination($this->router
, $this->view
, false);
367 ($type === 'list' ?
'liste_membres' : 'trombinoscope') . '.tpl',
369 'page_title' => ($type === 'list' ?
_T("Members list") : _T('Trombinoscope')),
370 'additionnal_html_class' => ($type === 'list' ?
'' : 'trombinoscope'),
372 'members' => $members,
373 'nb_members' => $m->getCount(),
374 'filters' => $filters
381 * Public pages (trombinoscope, public list)
383 * @param Request $request PSR Request
384 * @param Response $response PSR Response
385 * @param string $type Type
389 public function filterPublicList(Request
$request, Response
$response, string $type): Response
391 $post = $request->getParsedBody();
393 $varname = 'public_filter_' . $type;
394 if (isset($this->session
->$varname)) {
395 $filters = $this->session
->$varname;
397 $filters = new MembersList();
400 //reintialize filters
401 if (isset($post['clear_filter'])) {
404 //number of rows to show
405 if (isset($post['nbshow'])) {
406 $filters->show
= (int)$post['nbshow'];
410 $this->session
->$varname = $filters;
414 ->withHeader('Location', $this->router
->pathFor('publicList', ['type' => $type]));
420 * @param Request $request PSR Request
421 * @param Response $response PSR Response
422 * @param integer $id Member ID
423 * @param integer $fid Dynamic fields ID
424 * @param integer $pos Dynamic field position
425 * @param string $name File name
429 public function getDynamicFile(
437 $member = new Adherent($this->zdb
);
440 ->enableDep('dynamics')
444 if (!$member->canShow($this->login
)) {
445 $fields = $member->getDynamicFields()->getFields();
446 if (!isset($fields[$fid])) {
447 //field does not exists or access is forbidden
454 if ($denied === true) {
455 $this->flash
->addMessage(
457 _T("You do not have permission for requested URL.")
463 $this->router
->pathFor(
470 $filename = str_replace(
481 'member_%mid_field_%fid_value_%pos'
484 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
485 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
487 $response = $response->withHeader('Content-Description', 'File Transfer')
488 ->withHeader('Content-Type', $type)
489 ->withHeader('Content-Disposition', 'attachment;filename="' . $name . '"')
490 ->withHeader('Pragma', 'no-cache')
491 ->withHeader('Content-Transfer-Encoding', 'binary')
492 ->withHeader('Expires', '0')
493 ->withHeader('Cache-Control', 'must-revalidate')
494 ->withHeader('Pragma', 'public');
496 $stream = fopen('php://memory', 'r+');
497 fwrite($stream, file_get_contents(GALETTE_FILES_PATH
. $filename));
500 return $response->withBody(new \Slim\Http\
Stream($stream));
503 'A request has been made to get a dynamic file named `' .
504 $filename . '` that does not exists.',
508 $this->flash
->addMessage(
510 _T("The file does not exists or cannot be read :(")
516 $this->router
->pathFor('member', ['id' => $id])
524 * @param Request $request PSR Request
525 * @param Response $response PSR Response
526 * @param string $option One of 'page' or 'order'
527 * @param string|integer $value Value of the option
531 public function list(Request
$request, Response
$response, $option = null, $value = null): Response
533 if (isset($this->session
->filter_members
)) {
534 $filters = $this->session
->filter_members
;
536 $filters = new MembersList();
539 if ($option !== null) {
542 $filters->current_page
= (int)$value;
545 $filters->orderby
= $value;
550 $members = new Members($filters);
552 $members_list = array();
553 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
554 $members_list = $members->getMembersList(true);
556 $members_list = $members->getManagedMembersList(true);
559 $groups = new Groups($this->zdb
, $this->login
);
560 $groups_list = $groups->getList();
562 //assign pagination variables to the template and add pagination links
563 $filters->setSmartyPagination($this->router
, $this->view
, false);
564 $filters->setViewCommonsFilters($this->preferences
, $this->view
);
566 $this->session
->filter_members
= $filters;
571 'pages/members_list.html.twig',
573 'page_title' => _T("Members management"),
574 'require_mass' => true,
575 'members' => $members_list,
576 'filter_groups_options' => $groups_list,
577 'nb_members' => $members->getCount(),
578 'filters' => $filters,
579 'adv_filters' => $filters instanceof AdvancedMembersList
,
580 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
589 * @param Request $request PSR Request
590 * @param Response $response PSR Response
594 public function filter(Request
$request, Response
$response): Response
596 $post = $request->getParsedBody();
597 if (isset($this->session
->filter_members
)) {
598 //CAUTION: this one may be simple or advanced, display must change
599 $filters = $this->session
->filter_members
;
601 $filters = new MembersList();
604 //reintialize filters
605 if (isset($post['clear_filter'])) {
606 $filters = new MembersList();
607 } elseif (isset($post['clear_adv_filter'])) {
608 $this->session
->filter_members
= null;
609 unset($this->session
->filter_members
);
613 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
614 } elseif (isset($post['adv_criteria'])) {
617 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
620 if (isset($post['filter_str'])) { //filter search string
621 $filters->filter_str
= stripslashes(
622 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
626 if (isset($post['field_filter'])) {
627 if (is_numeric($post['field_filter'])) {
628 $filters->field_filter
= $post['field_filter'];
631 //membership to filter
632 if (isset($post['membership_filter'])) {
633 if (is_numeric($post['membership_filter'])) {
634 $filters->membership_filter
635 = $post['membership_filter'];
638 //account status to filter
639 if (isset($post['filter_account'])) {
640 if (is_numeric($post['filter_account'])) {
641 $filters->filter_account
= $post['filter_account'];
645 if (isset($post['email_filter'])) {
646 $filters->email_filter
= (int)$post['email_filter'];
650 isset($post['group_filter'])
651 && $post['group_filter'] > 0
653 $filters->group_filter
= (int)$post['group_filter'];
655 //number of rows to show
656 if (isset($post['nbshow'])) {
657 $filters->show
= (int)$post['nbshow'];
660 if (isset($post['advanced_filtering'])) {
661 if (!$filters instanceof AdvancedMembersList
) {
662 $filters = new AdvancedMembersList($filters);
666 unset($post['advanced_filtering']);
668 foreach ($post as $k => $v) {
669 if (strpos($k, 'free_', 0) === 0) {
672 foreach ($post['free_field'] as $f) {
675 && trim($post['free_text'][$i]) !== ''
677 $fs_search = htmlspecialchars($post['free_text'][$i], ENT_QUOTES
);
679 = (int)$post['free_logical_operator'][$i];
681 = (int)$post['free_query_operator'][$i];
682 $type = (int)$post['free_type'][$i];
687 'search' => $fs_search,
691 $filters->free_search
= $fs;
697 } elseif ($k == 'groups_search') {
699 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
700 foreach ($post['groups_search'] as $g) {
701 if (trim($g) !== '') {
706 $filters->groups_search
= $gs;
712 case 'contrib_min_amount':
713 case 'contrib_max_amount':
714 if (trim($v) !== '') {
727 if (isset($post['savesearch'])) {
732 $this->router
->pathFor(
739 $this->session
->filter_members
= $filters;
743 ->withHeader('Location', $this->router
->pathFor('members'));
747 * Advanced search page
749 * @param Request $request PSR Request
750 * @param Response $response PSR Response
754 public function advancedSearch(Request
$request, Response
$response): Response
756 if (isset($this->session
->filter_members
)) {
757 $filters = $this->session
->filter_members
;
758 if (!$filters instanceof AdvancedMembersList
) {
759 $filters = new AdvancedMembersList($filters);
762 $filters = new AdvancedMembersList();
765 $groups = new Groups($this->zdb
, $this->login
);
766 $groups_list = $groups->getList();
768 //we want only visible fields
769 $fields = $this->members_fields
;
770 $fc = $this->fields_config
;
771 $fc->filterVisible($this->login
, $fields);
773 //add status label search
774 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
775 $fields = array_slice($fields, 0, $pos, true) +
776 ['status_label' => ['label' => _T('Status label')]] +
777 array_slice($fields, $pos, count($fields) - 1, true);
781 $member = new Adherent($this->zdb
);
784 ->enableDep('dynamics')
785 ->loadFromLoginOrMail($this->login
->login
);
786 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
788 $contrib = new Contribution($this->zdb
, $this->login
);
789 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
792 $statuts = new Status($this->zdb
);
794 //Contributions types
795 $ct = new ContributionsTypes($this->zdb
);
798 $ptypes = new PaymentTypes(
803 $ptlist = $ptypes->getList();
805 $filters->setViewCommonsFilters($this->preferences
, $this->view
);
807 $social = new Social($this->zdb
);
808 $types = $member->getMemberRegisteredTypes();
810 foreach ($types as $type) {
811 $social_types[$type] = $social->getSystemType($type);
817 'pages/advanced_search.html.twig',
819 'page_title' => _T("Advanced search"),
820 'filter_groups_options' => $groups_list,
821 'search_fields' => $fields,
822 'adh_dynamics' => $adh_dynamics->getFields(),
823 'contrib_dynamics' => $contrib_dynamics->getFields(),
824 'adh_socials' => $social_types,
825 'statuts' => $statuts->getList(),
826 'contributions_types' => $ct->getList(),
827 'filters' => $filters,
828 'payments_types' => $ptlist
835 * Members list for ajax
837 * @param Request $request PSR Request
838 * @param Response $response PSR Response
839 * @param string|null $option One of 'page' or 'order'
840 * @param string|integer $value Value of the option
844 public function ajaxList(Request
$request, Response
$response, string $option = null, $value = null): Response
846 $post = $request->getParsedBody();
848 $filters = $this->session
->ajax_members_filters ??
new MembersList();
850 if ($option == 'page') {
851 $filters->current_page
= (int)$value;
854 //numbers of rows to display
855 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
856 $filters->show
= (int)$post['nbshow'];
859 $members = new Members($filters);
860 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
861 if ($this->login
->isGroupManager()) {
862 $members_list = $members->getManagedMembersList(true);
867 [$this->login
->id
, $this->login
->login
],
868 'Trying to list group members without access from #%id (%login)'
872 throw new \
Exception('Access denied.');
875 $members_list = $members->getMembersList(true);
878 //assign pagination variables to the template and add pagination links
879 $filters->setSmartyPagination($this->router
, $this->view
, false);
881 $this->session
->ajax_members_filters
= $filters;
883 $selected_members = null;
884 $unreachables_members = null;
885 if (!isset($post['from'])) {
886 $mailing = $this->session
->mailing
;
887 if (!isset($post['members'])) {
888 $selected_members = $mailing->recipients
;
889 $unreachables_members = $mailing->unreachables
;
892 $selected_members = $m->getArrayList($post['members']);
893 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
894 $unreachables_members = $m->getArrayList($post['unreachables']);
898 switch ($post['from']) {
900 if (!isset($post['gid'])) {
902 'Trying to list group members with no group id provided',
905 throw new \
Exception('A group id is required.');
907 if (!isset($post['members'])) {
908 $group = new Group((int)$post['gid']);
909 $selected_members = array();
910 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
911 $selected_members = $group->getMembers();
912 } elseif ($post['mode'] == 'managers') {
913 $selected_members = $group->getManagers();
916 'Trying to list group members with unknown mode',
919 throw new \
Exception('Unknown mode.');
923 $selected_members = $m->getArrayList($post['members']);
924 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
925 $unreachables_members = $m->getArrayList($post['unreachables']);
930 if (!isset($post['id_adh'])) {
931 throw new \
RuntimeException(
932 'Current selected member must be excluded while attaching!'
940 'filters' => $filters,
941 'members_list' => $members_list,
942 'selected_members' => $selected_members,
943 'unreachables_members' => $unreachables_members
946 if (isset($post['multiple'])) {
947 $params['multiple'] = true;
950 if (isset($post['gid'])) {
951 $params['the_id'] = (int)$post['gid'];
954 if (isset($post['id_adh'])) {
955 $params['excluded'] = (int)$post['id_adh'];
968 * Batch actions handler
970 * @param Request $request PSR Request
971 * @param Response $response PSR Response
975 public function handleBatch(Request
$request, Response
$response): Response
977 $post = $request->getParsedBody();
979 if (isset($post['member_sel'])) {
980 if (isset($this->session
->filter_members
)) {
981 $filters = $this->session
->filter_members
;
983 $filters = new MembersList();
986 $filters->selected
= $post['member_sel'];
987 $this->session
->filter_members
= $filters;
989 if (isset($post['cards'])) {
992 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
995 if (isset($post['labels'])) {
998 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
1001 if (isset($post['mailing'])) {
1004 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
1007 if (isset($post['attendance_sheet'])) {
1010 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
1013 if (isset($post['csv'])) {
1016 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
1019 if (isset($post['delete'])) {
1022 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
1025 if (isset($post['masschange'])) {
1028 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
1031 if (isset($post['masscontributions'])) {
1034 ->withHeader('Location', $this->router
->pathFor('massAddContributionsChooseType'));
1037 throw new \
RuntimeException('Does not know what to batch :(');
1039 $this->flash
->addMessage(
1041 _T("No member was selected, please check at least one name.")
1046 ->withHeader('Location', $this->router
->pathFor('members'));
1056 * @param Request $request PSR Request
1057 * @param Response $response PSR Response
1058 * @param mixed $id Member id/array of members id
1059 * @param string $action null or 'add'
1063 public function edit(
1067 string $action = 'edit'
1069 //instantiate member object
1070 $member = new Adherent($this->zdb
);
1072 if ($this->session
->member
!== null) {
1073 //retrieve from session, in add or edit
1074 $member = $this->session
->member
;
1075 $this->session
->member
= null;
1078 $member->enableAllDeps();
1081 //load requested member
1083 $can = $member->canEdit($this->login
);
1085 $can = $member->canCreate($this->login
);
1089 $this->flash
->addMessage(
1091 _T("You do not have permission for requested URL.")
1097 $this->router
->pathFor('me')
1101 //if adding a child, force parent here
1102 if ($action === 'addchild') {
1103 $member->setParent((int)$this->login
->id
);
1106 // flagging required fields
1107 $fc = $this->fields_config
;
1109 // password required if we create a new member
1111 $fc->setNotRequired('mdp_adh');
1114 //handle requirements for parent fields
1115 $parent_fields = $member->getParentFields();
1116 $tpl_parent_fields = []; //for JS when detaching
1117 foreach ($parent_fields as $field) {
1118 if ($fc->isRequired($field)) {
1119 $tpl_parent_fields[] = $field;
1120 if ($member->hasParent()) {
1121 $fc->setNotRequired($field);
1126 // flagging required fields invisible to members
1127 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1128 $fc->setNotRequired('activite_adh');
1129 $fc->setNotRequired('id_statut');
1132 // template variable declaration
1133 $title = _T("Member Profile");
1134 if ($member->id
!= '') {
1135 $title .= ' (' . _T("modification") . ')';
1137 $title .= ' (' . _T("creation") . ')';
1141 $statuts = new Status($this->zdb
);
1144 $groups = new Groups($this->zdb
, $this->login
);
1145 $groups_list = $groups->getSimpleList(true);
1147 $form_elements = $fc->getFormElements(
1155 if ($member->hasParent()) {
1156 $pid = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1158 $members = $m->getSelectizedMembers(
1164 $route_params['members'] = [
1165 'filters' => $m->getFilters(),
1166 'count' => $m->getCount()
1169 if (count($members)) {
1170 $route_params['members']['list'] = $members;
1174 $this->view
->render(
1176 'pages/member_form.html.twig',
1178 'parent_tpl' => 'page.html.twig',
1179 'autocomplete' => true,
1180 'page_title' => $title,
1181 'member' => $member,
1182 'self_adh' => false,
1183 // pseudo random int
1185 'titles_list' => Titles
::getList($this->zdb
),
1186 'statuts' => $statuts->getList(),
1187 'groups' => $groups_list,
1188 'fieldsets' => $form_elements['fieldsets'],
1189 'hidden_elements' => $form_elements['hiddens'],
1190 'parent_fields' => $tpl_parent_fields,
1191 'addchild' => ($action === 'addchild'),
1192 'osocials' => new Social($this->zdb
)
1201 * @param Request $request PSR Request
1202 * @param Response $response PSR Response
1203 * @param integer $id Member id
1207 public function doEdit(Request
$request, Response
$response, int $id): Response
1209 return $this->store($request, $response);
1213 * Massive change page
1215 * @param Request $request PSR Request
1216 * @param Response $response PSR Response
1220 public function massChange(Request
$request, Response
$response): Response
1222 $filters = $this->session
->filter_members
;
1225 'id' => $filters->selected
,
1226 'redirect_uri' => $this->router
->pathFor('members')
1229 $fc = $this->fields_config
;
1230 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1233 $member = new Adherent($this->zdb
);
1234 $member->disableAllDeps()->enableDep('dynamics');
1237 $statuts = new Status($this->zdb
);
1240 $this->view
->render(
1242 'modals/mass_change_members.html.twig',
1244 'mode' => $request->isXhr() ?
'ajax' : '',
1245 'page_title' => str_replace(
1248 _T('Mass change %count members')
1250 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1251 'cancel_uri' => $this->router
->pathFor('members'),
1253 'member' => $member,
1254 'fieldsets' => $form_elements['fieldsets'],
1255 'titles_list' => Titles
::getList($this->zdb
),
1256 'statuts' => $statuts->getList(),
1257 'require_mass' => true
1264 * Massive changes validation page
1266 * @param Request $request PSR Request
1267 * @param Response $response PSR Response
1271 public function validateMassChange(Request
$request, Response
$response): Response
1273 $post = $request->getParsedBody();
1275 if (!isset($post['confirm'])) {
1276 $this->flash
->addMessage(
1278 _T("Mass changes has not been confirmed!")
1281 //we want only visibles fields
1282 $fc = $this->fields_config
;
1283 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1286 foreach ($form_elements['fieldsets'] as $form_element) {
1287 foreach ($form_element->elements
as $field) {
1289 isset($post['mass_' . $field->field_id
])
1290 && (isset($post[$field->field_id
]) ||
$field->type
=== FieldsConfig
::TYPE_BOOL
)
1292 $changes[$field->field_id
] = [
1293 'label' => $field->label
,
1294 'value' => $post[$field->field_id
] ??
0
1300 //handle dynamic fields
1301 $member = new Adherent($this->zdb
);
1306 $this->members_fields
,
1309 $dynamic_fields = $member->getDynamicFields()->getFields();
1310 foreach ($dynamic_fields as $field) {
1311 $mass_id = 'mass_info_field_' . $field->getId();
1312 $field_id = 'info_field_' . $field->getId() . '_1';
1314 isset($post[$mass_id])
1315 && (isset($post[$field_id]) ||
$field instanceof Boolean
)
1317 $changes[$field_id] = [
1318 'label' => $field->getName(),
1319 'value' => $post[$field_id] ??
0
1325 $filters = $this->session
->filter_members
;
1327 'id' => $filters->selected
,
1328 'redirect_uri' => $this->router
->pathFor('members')
1332 $statuts = new Status($this->zdb
);
1335 $this->view
->render(
1337 'modals/mass_change_members.html.twig',
1339 'mode' => $request->isXhr() ?
'ajax' : '',
1340 'page_title' => str_replace(
1343 _T('Review mass change %count members')
1345 'form_url' => $this->router
->pathFor('massstoremembers'),
1346 'cancel_uri' => $this->router
->pathFor('members'),
1348 'titles_list' => Titles
::getList($this->zdb
),
1349 'statuts' => $statuts->getList(),
1350 'changes' => $changes
1357 * Do massive changes
1359 * @param Request $request PSR Request
1360 * @param Response $response PSR Response
1364 public function doMassChange(Request
$request, Response
$response): Response
1366 $post = $request->getParsedBody();
1367 $redirect_url = $post['redirect_uri'];
1368 $error_detected = [];
1370 $dynamic_fields = null;
1372 unset($post['redirect_uri']);
1373 if (!isset($post['confirm'])) {
1374 $error_detected[] = _T("Mass changes has not been confirmed!");
1376 unset($post['confirm']);
1380 $fc = $this->fields_config
;
1381 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1382 $disabled = $this->members_fields
;
1383 foreach (array_keys($post) as $key) {
1385 foreach ($form_elements['fieldsets'] as $fieldset) {
1386 if (isset($fieldset->elements
[$key])) {
1393 //try on dynamic fields
1394 if ($dynamic_fields === null) {
1395 //handle dynamic fields
1396 $member = new Adherent($this->zdb
);
1401 $this->members_fields
,
1404 $dynamic_fields = $member->getDynamicFields()->getFields();
1406 foreach ($dynamic_fields as $field) {
1407 $field_id = 'info_field_' . $field->getId() . '_1';
1408 if ($key == $field_id) {
1417 'Permission issue mass editing field ' . $key,
1422 unset($disabled[$key]);
1426 if (!count($post)) {
1427 $error_detected[] = _T("Nothing to do!");
1429 foreach ($ids as $id) {
1430 $is_manager = !$this->login
->isAdmin()
1431 && !$this->login
->isStaff()
1432 && $this->login
->isGroupManager();
1433 $member = new Adherent($this->zdb
);
1434 $member->disableAllDeps();
1436 $member->enableDep('groups');
1438 $member->load((int)$id);
1439 $member->setDependencies(
1441 $this->members_fields
,
1444 if (!$member->canEdit($this->login
)) {
1448 $valid = $member->check($post, [], $disabled);
1449 if ($valid === true) {
1450 $done = $member->store();
1452 $error_detected[] = _T("An error occurred while storing the member.");
1457 $error_detected = array_merge($error_detected, $valid);
1463 if ($mass == 0 && !count($error_detected)) {
1464 $error_detected[] = _T('Something went wront during mass edition!');
1466 $this->flash
->addMessage(
1471 _T('%count members has been changed successfully!')
1476 if (count($error_detected) > 0) {
1477 foreach ($error_detected as $error) {
1478 $this->flash
->addMessage(
1485 if (!$request->isXhr()) {
1488 ->withHeader('Location', $redirect_url);
1490 return $response->withJson(
1492 'success' => count($error_detected) === 0
1501 * @param Request $request PSR Request
1502 * @param Response $response PSR Response
1506 public function store(Request
$request, Response
$response): Response
1508 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1511 ->withHeader('Location', $this->router
->pathFor('slash'));
1514 $post = $request->getParsedBody();
1515 $member = new Adherent($this->zdb
);
1520 $this->members_fields
,
1524 $success_detected = [];
1525 $warning_detected = [];
1526 $error_detected = [];
1528 if ($this->isSelfMembership() && !isset($post[Adherent
::PK
])) {
1529 //mark as self membership
1530 $member->setSelfMembership();
1533 $gaptcha = $this->session
->gaptcha
;
1534 if (!$gaptcha->check($post['gaptcha'])) {
1535 $error_detected[] = _T('Invalid captcha');
1540 if (isset($post['id_adh'])) {
1541 $member->load((int)$post['id_adh']);
1542 if (!$member->canEdit($this->login
)) {
1543 //redirection should have been done before. Just throw an Exception.
1544 throw new \
RuntimeException(
1548 'No right to store member #%id'
1553 if ($member->id
!= '') {
1554 $member->load($this->login
->id
);
1558 // flagging required fields
1559 $fc = $this->fields_config
;
1561 // password required if we create a new member but not from self subscription
1562 if ($member->id
!= '' ||
$this->isSelfMembership()) {
1563 $fc->setNotRequired('mdp_adh');
1567 $member->hasParent() && !isset($post['detach_parent'])
1568 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1570 $parent_fields = $member->getParentFields();
1571 foreach ($parent_fields as $field) {
1572 if ($fc->isRequired($field)) {
1573 $fc->setNotRequired($field);
1578 // flagging required fields invisible to members
1579 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1580 $fc->setNotRequired('activite_adh');
1581 $fc->setNotRequired('id_statut');
1584 $form_elements = $fc->getFormElements(
1587 $this->isSelfMembership()
1589 $fieldsets = $form_elements['fieldsets'];
1590 $required = array();
1591 $disabled = array();
1593 foreach ($fieldsets as $category) {
1594 foreach ($category->elements
as $field) {
1595 if ($field->required
== true) {
1596 $required[$field->field_id
] = true;
1598 if ($field->disabled
== true) {
1599 $disabled[$field->field_id
] = true;
1600 } elseif (!isset($post[$field->field_id
])) {
1601 switch ($field->field_id
) {
1602 //unchecked booleans are not sent from form
1603 case 'bool_admin_adh':
1604 case 'bool_exempt_adh':
1605 case 'bool_display_info':
1606 $post[$field->field_id
] = 0;
1613 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1616 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1617 if (!count($real_requireds) ||
isset($post[array_shift($real_requireds)])) {
1619 $valid = $member->check($post, $required, $disabled);
1620 if ($valid !== true) {
1621 $error_detected = array_merge($error_detected, $valid);
1624 if (count($error_detected) == 0) {
1625 //all goes well, we can proceed
1628 if ($member->id
== '') {
1632 // send email to member
1633 if ($this->isSelfMembership() ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1634 $member->setSendmail(); //flag to send creation email
1637 $store = $member->store();
1638 if ($store === true) {
1639 //member has been stored :)
1641 if ($this->isSelfMembership()) {
1642 $success_detected[] = _T("Your account has been created!");
1644 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1645 && $member->getEmail() != ''
1647 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1650 $success_detected[] = _T("New member has been successfully added.");
1653 $success_detected[] = _T("Member account has been modified.");
1656 if ($this->login
->isGroupManager()) {
1657 //add/remove user from groups
1658 $groups_adh = $post['groups_adh'] ??
null;
1659 $add_groups = Groups
::addMemberToGroups(
1664 if ($add_groups === false) {
1665 $error_detected[] = _T("An error occurred adding member to its groups.");
1668 if ($this->login
->isSuperAdmin() ||
$this->login
->isAdmin() ||
$this->login
->isStaff()) {
1669 //add/remove manager from groups
1670 $managed_groups_adh = $post['groups_managed_adh'] ??
null;
1671 $add_groups = Groups
::addMemberToGroups(
1673 $managed_groups_adh,
1676 $member->loadGroups();
1678 if ($add_groups === false) {
1679 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1683 //something went wrong :'(
1684 $error_detected[] = _T("An error occurred while storing the member.");
1688 if (count($error_detected) === 0) {
1689 $files_res = $member->handleFiles($_FILES);
1690 if (is_array($files_res)) {
1691 $error_detected = array_merge($error_detected, $files_res);
1694 if (isset($post['del_photo'])) {
1695 if (!$member->picture
->delete($member->id
)) {
1696 $error_detected[] = _T("Delete failed");
1697 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1699 'Unable to delete picture for member ' . $str_adh,
1706 if (count($error_detected) > 0) {
1707 foreach ($error_detected as $error) {
1708 if (strpos($error, '%member_url_') !== false) {
1709 preg_match('/%member_url_(\d+)/', $error, $matches);
1710 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1711 $error = str_replace(
1712 '%member_url_' . $matches[1],
1717 $this->flash
->addMessage(
1724 if (count($warning_detected) > 0) {
1725 foreach ($warning_detected as $warning) {
1726 $this->flash
->addMessage(
1732 if (count($success_detected) > 0) {
1733 foreach ($success_detected as $success) {
1734 $this->flash
->addMessage(
1741 if (count($error_detected) === 0) {
1742 if ($this->isSelfMembership()) {
1743 $redirect_url = $this->router
->pathFor('login');
1745 isset($post['redirect_on_create'])
1746 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1748 switch ($post['redirect_on_create']) {
1749 case Adherent
::AFTER_ADD_TRANS
:
1750 $redirect_url = $this->router
->pathFor('addTransaction');
1752 case Adherent
::AFTER_ADD_NEW
:
1753 $redirect_url = $this->router
->pathFor('addMember');
1755 case Adherent
::AFTER_ADD_SHOW
:
1756 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1758 case Adherent
::AFTER_ADD_LIST
:
1759 $redirect_url = $this->router
->pathFor('members');
1761 case Adherent
::AFTER_ADD_HOME
:
1762 $redirect_url = $this->router
->pathFor('slash');
1765 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1766 $redirect_url = $this->router
->pathFor(
1769 ) . '?id_adh=' . $member->id
;
1771 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1774 //store entity in session
1775 $this->session
->member
= $member;
1777 if ($this->isSelfMembership()) {
1778 $redirect_url = $this->router
->pathFor('subscribe');
1781 $redirect_url = $this->router
->pathFor(
1783 ['id' => $member->id
]
1786 $redirect_url = $this->router
->pathFor((isset($post['addchild']) ?
'addMemberChild' : 'addMember'));
1794 ->withHeader('Location', $redirect_url);
1802 * Get redirection URI
1804 * @param array $args Route arguments
1808 public function redirectUri(array $args)
1810 return $this->router
->pathFor('members');
1816 * @param array $args Route arguments
1820 public function formUri(array $args)
1822 return $this->router
->pathFor(
1832 * In simple cases, we get the ID in the route arguments; but for
1833 * batchs, it should be found elsewhere.
1834 * In post values, we look for id key, as well as all {sthing}_sel keys (like members_sel or contrib_sel)
1836 * @param array $args Request arguments
1837 * @param array $post POST values
1839 * @return null|integer|integer[]
1841 protected function getIdsToRemove(&$args, $post)
1843 if (isset($args['id'])) {
1846 $filters = $this->session
->filter_members
;
1847 return $filters->selected
;
1852 * Get confirmation removal page title
1854 * @param array $args Route arguments
1858 public function confirmRemoveTitle(array $args)
1860 if (isset($args['id_adh']) ||
isset($args['id'])) {
1861 //one member removal
1862 $id_adh = $args['id_adh'] ??
$args['id'];
1863 $adh = new Adherent($this->zdb
, (int)$id_adh);
1865 _T('Remove member %1$s'),
1869 //batch members removal
1870 $filters = $this->session
->filter_members
;
1873 count($filters->selected
),
1874 _T('You are about to remove %count members.')
1882 * @param array $args Route arguments
1883 * @param array $post POST values
1887 protected function doDelete(array $args, array $post)
1889 if (isset($this->session
->filter_members
)) {
1890 $filters = $this->session
->filter_members
;
1892 $filters = new MembersList();
1894 $members = new Members($filters);
1896 if (!is_array($post['id'])) {
1897 $ids = (array)$post['id'];
1902 return $members->removeMembers($ids);
1908 * Set self memebrship flag
1910 * @return MembersController
1912 private function setSelfMembership(): MembersController
1914 $this->is_self_membership
= true;
1919 * Is self membership?
1923 private function isSelfMembership(): bool
1925 return $this->is_self_membership
;