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
);
287 'pages/member_show.html.twig',
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' ?
'pages/members_public_list' : 'pages/members_public_gallery') . '.html.twig',
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,
383 * Public pages (trombinoscope, public list)
385 * @param Request $request PSR Request
386 * @param Response $response PSR Response
387 * @param string $type Type
391 public function filterPublicList(Request
$request, Response
$response, string $type): Response
393 $post = $request->getParsedBody();
395 $varname = 'public_filter_' . $type;
396 if (isset($this->session
->$varname)) {
397 $filters = $this->session
->$varname;
399 $filters = new MembersList();
402 //reintialize filters
403 if (isset($post['clear_filter'])) {
406 //number of rows to show
407 if (isset($post['nbshow'])) {
408 $filters->show
= (int)$post['nbshow'];
412 $this->session
->$varname = $filters;
416 ->withHeader('Location', $this->router
->pathFor('publicList', ['type' => $type]));
422 * @param Request $request PSR Request
423 * @param Response $response PSR Response
424 * @param integer $id Member ID
425 * @param integer $fid Dynamic fields ID
426 * @param integer $pos Dynamic field position
427 * @param string $name File name
431 public function getDynamicFile(
439 $member = new Adherent($this->zdb
);
442 ->enableDep('dynamics')
446 if (!$member->canShow($this->login
)) {
447 $fields = $member->getDynamicFields()->getFields();
448 if (!isset($fields[$fid])) {
449 //field does not exists or access is forbidden
456 if ($denied === true) {
457 $this->flash
->addMessage(
459 _T("You do not have permission for requested URL.")
465 $this->router
->pathFor(
472 $filename = str_replace(
483 'member_%mid_field_%fid_value_%pos'
486 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
487 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
489 $response = $response->withHeader('Content-Description', 'File Transfer')
490 ->withHeader('Content-Type', $type)
491 ->withHeader('Content-Disposition', 'attachment;filename="' . $name . '"')
492 ->withHeader('Pragma', 'no-cache')
493 ->withHeader('Content-Transfer-Encoding', 'binary')
494 ->withHeader('Expires', '0')
495 ->withHeader('Cache-Control', 'must-revalidate')
496 ->withHeader('Pragma', 'public');
498 $stream = fopen('php://memory', 'r+');
499 fwrite($stream, file_get_contents(GALETTE_FILES_PATH
. $filename));
502 return $response->withBody(new \Slim\Http\
Stream($stream));
505 'A request has been made to get a dynamic file named `' .
506 $filename . '` that does not exists.',
510 $this->flash
->addMessage(
512 _T("The file does not exists or cannot be read :(")
518 $this->router
->pathFor('member', ['id' => $id])
526 * @param Request $request PSR Request
527 * @param Response $response PSR Response
528 * @param string $option One of 'page' or 'order'
529 * @param string|integer $value Value of the option
533 public function list(Request
$request, Response
$response, $option = null, $value = null): Response
535 if (isset($this->session
->filter_members
)) {
536 $filters = $this->session
->filter_members
;
538 $filters = new MembersList();
541 if ($option !== null) {
544 $filters->current_page
= (int)$value;
547 $filters->orderby
= $value;
552 $members = new Members($filters);
554 $members_list = array();
555 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
556 $members_list = $members->getMembersList(true);
558 $members_list = $members->getManagedMembersList(true);
561 $groups = new Groups($this->zdb
, $this->login
);
562 $groups_list = $groups->getList();
564 //assign pagination variables to the template and add pagination links
565 $filters->setSmartyPagination($this->router
, $this->view
, false);
566 $filters->setViewCommonsFilters($this->preferences
, $this->view
);
568 $this->session
->filter_members
= $filters;
573 'pages/members_list.html.twig',
575 'page_title' => _T("Members management"),
576 'require_mass' => true,
577 'members' => $members_list,
578 'filter_groups_options' => $groups_list,
579 'nb_members' => $members->getCount(),
580 'filters' => $filters,
581 'adv_filters' => $filters instanceof AdvancedMembersList
,
582 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
591 * @param Request $request PSR Request
592 * @param Response $response PSR Response
596 public function filter(Request
$request, Response
$response): Response
598 $post = $request->getParsedBody();
599 if (isset($this->session
->filter_members
)) {
600 //CAUTION: this one may be simple or advanced, display must change
601 $filters = $this->session
->filter_members
;
603 $filters = new MembersList();
606 //reintialize filters
607 if (isset($post['clear_filter'])) {
608 $filters = new MembersList();
609 } elseif (isset($post['clear_adv_filter'])) {
610 $this->session
->filter_members
= null;
611 unset($this->session
->filter_members
);
615 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
616 } elseif (isset($post['adv_criteria'])) {
619 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
622 if (isset($post['filter_str'])) { //filter search string
623 $filters->filter_str
= stripslashes(
624 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
628 if (isset($post['field_filter'])) {
629 if (is_numeric($post['field_filter'])) {
630 $filters->field_filter
= $post['field_filter'];
633 //membership to filter
634 if (isset($post['membership_filter'])) {
635 if (is_numeric($post['membership_filter'])) {
636 $filters->membership_filter
637 = $post['membership_filter'];
640 //account status to filter
641 if (isset($post['filter_account'])) {
642 if (is_numeric($post['filter_account'])) {
643 $filters->filter_account
= $post['filter_account'];
647 if (isset($post['email_filter'])) {
648 $filters->email_filter
= (int)$post['email_filter'];
652 isset($post['group_filter'])
653 && $post['group_filter'] > 0
655 $filters->group_filter
= (int)$post['group_filter'];
657 //number of rows to show
658 if (isset($post['nbshow'])) {
659 $filters->show
= (int)$post['nbshow'];
662 if (isset($post['advanced_filtering'])) {
663 if (!$filters instanceof AdvancedMembersList
) {
664 $filters = new AdvancedMembersList($filters);
668 unset($post['advanced_filtering']);
670 foreach ($post as $k => $v) {
671 if (strpos($k, 'free_', 0) === 0) {
674 foreach ($post['free_field'] as $f) {
677 && trim($post['free_text'][$i]) !== ''
679 $fs_search = htmlspecialchars($post['free_text'][$i], ENT_QUOTES
);
681 = (int)$post['free_logical_operator'][$i];
683 = (int)$post['free_query_operator'][$i];
684 $type = (int)$post['free_type'][$i];
689 'search' => $fs_search,
693 $filters->free_search
= $fs;
699 } elseif ($k == 'groups_search') {
701 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
702 foreach ($post['groups_search'] as $g) {
703 if (trim($g) !== '') {
708 $filters->groups_search
= $gs;
714 case 'contrib_min_amount':
715 case 'contrib_max_amount':
716 if (trim($v) !== '') {
729 if (isset($post['savesearch'])) {
734 $this->router
->pathFor(
741 $this->session
->filter_members
= $filters;
745 ->withHeader('Location', $this->router
->pathFor('members'));
749 * Advanced search page
751 * @param Request $request PSR Request
752 * @param Response $response PSR Response
756 public function advancedSearch(Request
$request, Response
$response): Response
758 if (isset($this->session
->filter_members
)) {
759 $filters = $this->session
->filter_members
;
760 if (!$filters instanceof AdvancedMembersList
) {
761 $filters = new AdvancedMembersList($filters);
764 $filters = new AdvancedMembersList();
767 $groups = new Groups($this->zdb
, $this->login
);
768 $groups_list = $groups->getList();
770 //we want only visible fields
771 $fields = $this->members_fields
;
772 $fc = $this->fields_config
;
773 $fc->filterVisible($this->login
, $fields);
775 //add status label search
776 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
777 $fields = array_slice($fields, 0, $pos, true) +
778 ['status_label' => ['label' => _T('Status label')]] +
779 array_slice($fields, $pos, count($fields) - 1, true);
783 $member = new Adherent($this->zdb
);
786 ->enableDep('dynamics')
787 ->loadFromLoginOrMail($this->login
->login
);
788 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
790 $contrib = new Contribution($this->zdb
, $this->login
);
791 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
794 $statuts = new Status($this->zdb
);
796 //Contributions types
797 $ct = new ContributionsTypes($this->zdb
);
800 $ptypes = new PaymentTypes(
805 $ptlist = $ptypes->getList();
807 $filters->setViewCommonsFilters($this->preferences
, $this->view
);
809 $social = new Social($this->zdb
);
810 $types = $member->getMemberRegisteredTypes();
812 foreach ($types as $type) {
813 $social_types[$type] = $social->getSystemType($type);
819 'pages/advanced_search.html.twig',
821 'page_title' => _T("Advanced search"),
822 'filter_groups_options' => $groups_list,
823 'search_fields' => $fields,
824 'adh_dynamics' => $adh_dynamics->getFields(),
825 'contrib_dynamics' => $contrib_dynamics->getFields(),
826 'adh_socials' => $social_types,
827 'statuts' => $statuts->getList(),
828 'contributions_types' => $ct->getList(),
829 'filters' => $filters,
830 'payments_types' => $ptlist
837 * Members list for ajax
839 * @param Request $request PSR Request
840 * @param Response $response PSR Response
841 * @param string|null $option One of 'page' or 'order'
842 * @param string|integer $value Value of the option
846 public function ajaxList(Request
$request, Response
$response, string $option = null, $value = null): Response
848 $post = $request->getParsedBody();
850 $filters = $this->session
->ajax_members_filters ??
new MembersList();
852 if ($option == 'page') {
853 $filters->current_page
= (int)$value;
856 //numbers of rows to display
857 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
858 $filters->show
= (int)$post['nbshow'];
861 $members = new Members($filters);
862 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
863 if ($this->login
->isGroupManager()) {
864 $members_list = $members->getManagedMembersList(true);
869 [$this->login
->id
, $this->login
->login
],
870 'Trying to list group members without access from #%id (%login)'
874 throw new \
Exception('Access denied.');
877 $members_list = $members->getMembersList(true);
880 //assign pagination variables to the template and add pagination links
881 $filters->setSmartyPagination($this->router
, $this->view
, false);
883 $this->session
->ajax_members_filters
= $filters;
885 $selected_members = null;
886 $unreachables_members = null;
887 if (!isset($post['from'])) {
888 $mailing = $this->session
->mailing
;
889 if (!isset($post['members'])) {
890 $selected_members = $mailing->recipients
;
891 $unreachables_members = $mailing->unreachables
;
894 $selected_members = $m->getArrayList($post['members']);
895 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
896 $unreachables_members = $m->getArrayList($post['unreachables']);
900 switch ($post['from']) {
902 if (!isset($post['gid'])) {
904 'Trying to list group members with no group id provided',
907 throw new \
Exception('A group id is required.');
909 if (!isset($post['members'])) {
910 $group = new Group((int)$post['gid']);
911 $selected_members = array();
912 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
913 $selected_members = $group->getMembers();
914 } elseif ($post['mode'] == 'managers') {
915 $selected_members = $group->getManagers();
918 'Trying to list group members with unknown mode',
921 throw new \
Exception('Unknown mode.');
925 $selected_members = $m->getArrayList($post['members']);
926 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
927 $unreachables_members = $m->getArrayList($post['unreachables']);
932 if (!isset($post['id_adh'])) {
933 throw new \
RuntimeException(
934 'Current selected member must be excluded while attaching!'
942 'filters' => $filters,
943 'members_list' => $members_list,
944 'selected_members' => $selected_members,
945 'unreachables_members' => $unreachables_members
948 if (isset($post['multiple'])) {
949 $params['multiple'] = true;
952 if (isset($post['gid'])) {
953 $params['the_id'] = (int)$post['gid'];
956 if (isset($post['id_adh'])) {
957 $params['excluded'] = (int)$post['id_adh'];
963 'elements/ajax_members.html.twig',
970 * Batch actions handler
972 * @param Request $request PSR Request
973 * @param Response $response PSR Response
977 public function handleBatch(Request
$request, Response
$response): Response
979 $post = $request->getParsedBody();
981 if (isset($post['member_sel'])) {
982 if (isset($this->session
->filter_members
)) {
983 $filters = $this->session
->filter_members
;
985 $filters = new MembersList();
988 $filters->selected
= $post['member_sel'];
989 $this->session
->filter_members
= $filters;
991 if (isset($post['cards'])) {
994 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
997 if (isset($post['labels'])) {
1000 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
1003 if (isset($post['mailing'])) {
1006 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
1009 if (isset($post['attendance_sheet'])) {
1012 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
1015 if (isset($post['csv'])) {
1018 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
1021 if (isset($post['delete'])) {
1024 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
1027 if (isset($post['masschange'])) {
1030 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
1033 if (isset($post['masscontributions'])) {
1036 ->withHeader('Location', $this->router
->pathFor('massAddContributionsChooseType'));
1039 throw new \
RuntimeException('Does not know what to batch :(');
1041 $this->flash
->addMessage(
1043 _T("No member was selected, please check at least one name.")
1048 ->withHeader('Location', $this->router
->pathFor('members'));
1058 * @param Request $request PSR Request
1059 * @param Response $response PSR Response
1060 * @param mixed $id Member id/array of members id
1061 * @param string $action null or 'add'
1065 public function edit(
1069 string $action = 'edit'
1071 //instantiate member object
1072 $member = new Adherent($this->zdb
);
1074 if ($this->session
->member
!== null) {
1075 //retrieve from session, in add or edit
1076 $member = $this->session
->member
;
1077 $this->session
->member
= null;
1080 $member->enableAllDeps();
1083 //load requested member
1085 $can = $member->canEdit($this->login
);
1087 $can = $member->canCreate($this->login
);
1091 $this->flash
->addMessage(
1093 _T("You do not have permission for requested URL.")
1099 $this->router
->pathFor('me')
1103 //if adding a child, force parent here
1104 if ($action === 'addchild') {
1105 $member->setParent((int)$this->login
->id
);
1108 // flagging required fields
1109 $fc = $this->fields_config
;
1111 // password required if we create a new member
1113 $fc->setNotRequired('mdp_adh');
1116 //handle requirements for parent fields
1117 $parent_fields = $member->getParentFields();
1118 $tpl_parent_fields = []; //for JS when detaching
1119 foreach ($parent_fields as $field) {
1120 if ($fc->isRequired($field)) {
1121 $tpl_parent_fields[] = $field;
1122 if ($member->hasParent()) {
1123 $fc->setNotRequired($field);
1128 // flagging required fields invisible to members
1129 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1130 $fc->setNotRequired('activite_adh');
1131 $fc->setNotRequired('id_statut');
1134 // template variable declaration
1135 $title = _T("Member Profile");
1136 if ($member->id
!= '') {
1137 $title .= ' (' . _T("modification") . ')';
1139 $title .= ' (' . _T("creation") . ')';
1143 $statuts = new Status($this->zdb
);
1146 $groups = new Groups($this->zdb
, $this->login
);
1147 $groups_list = $groups->getSimpleList(true);
1149 $form_elements = $fc->getFormElements(
1157 if ($member->hasParent()) {
1158 $pid = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1160 $members = $m->getSelectizedMembers(
1166 $route_params['members'] = [
1167 'filters' => $m->getFilters(),
1168 'count' => $m->getCount()
1171 if (count($members)) {
1172 $route_params['members']['list'] = $members;
1176 $this->view
->render(
1178 'pages/member_form.html.twig',
1180 'parent_tpl' => 'page.html.twig',
1181 'autocomplete' => true,
1182 'page_title' => $title,
1183 'member' => $member,
1184 'self_adh' => false,
1185 // pseudo random int
1187 'titles_list' => Titles
::getList($this->zdb
),
1188 'statuts' => $statuts->getList(),
1189 'groups' => $groups_list,
1190 'fieldsets' => $form_elements['fieldsets'],
1191 'hidden_elements' => $form_elements['hiddens'],
1192 'parent_fields' => $tpl_parent_fields,
1193 'addchild' => ($action === 'addchild'),
1194 'osocials' => new Social($this->zdb
)
1203 * @param Request $request PSR Request
1204 * @param Response $response PSR Response
1205 * @param integer $id Member id
1209 public function doEdit(Request
$request, Response
$response, int $id): Response
1211 return $this->store($request, $response);
1215 * Massive change page
1217 * @param Request $request PSR Request
1218 * @param Response $response PSR Response
1222 public function massChange(Request
$request, Response
$response): Response
1224 $filters = $this->session
->filter_members
;
1227 'id' => $filters->selected
,
1228 'redirect_uri' => $this->router
->pathFor('members')
1231 $fc = $this->fields_config
;
1232 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1235 $member = new Adherent($this->zdb
);
1236 $member->disableAllDeps()->enableDep('dynamics');
1239 $statuts = new Status($this->zdb
);
1242 $this->view
->render(
1244 'modals/mass_change_members.html.twig',
1246 'mode' => $request->isXhr() ?
'ajax' : '',
1247 'page_title' => str_replace(
1250 _T('Mass change %count members')
1252 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1253 'cancel_uri' => $this->router
->pathFor('members'),
1255 'member' => $member,
1256 'fieldsets' => $form_elements['fieldsets'],
1257 'titles_list' => Titles
::getList($this->zdb
),
1258 'statuts' => $statuts->getList(),
1259 'require_mass' => true
1266 * Massive changes validation page
1268 * @param Request $request PSR Request
1269 * @param Response $response PSR Response
1273 public function validateMassChange(Request
$request, Response
$response): Response
1275 $post = $request->getParsedBody();
1277 if (!isset($post['confirm'])) {
1278 $this->flash
->addMessage(
1280 _T("Mass changes has not been confirmed!")
1283 //we want only visibles fields
1284 $fc = $this->fields_config
;
1285 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1288 foreach ($form_elements['fieldsets'] as $form_element) {
1289 foreach ($form_element->elements
as $field) {
1291 isset($post['mass_' . $field->field_id
])
1292 && (isset($post[$field->field_id
]) ||
$field->type
=== FieldsConfig
::TYPE_BOOL
)
1294 $changes[$field->field_id
] = [
1295 'label' => $field->label
,
1296 'value' => $post[$field->field_id
] ??
0
1302 //handle dynamic fields
1303 $member = new Adherent($this->zdb
);
1308 $this->members_fields
,
1311 $dynamic_fields = $member->getDynamicFields()->getFields();
1312 foreach ($dynamic_fields as $field) {
1313 $mass_id = 'mass_info_field_' . $field->getId();
1314 $field_id = 'info_field_' . $field->getId() . '_1';
1316 isset($post[$mass_id])
1317 && (isset($post[$field_id]) ||
$field instanceof Boolean
)
1319 $changes[$field_id] = [
1320 'label' => $field->getName(),
1321 'value' => $post[$field_id] ??
0
1327 $filters = $this->session
->filter_members
;
1329 'id' => $filters->selected
,
1330 'redirect_uri' => $this->router
->pathFor('members')
1334 $statuts = new Status($this->zdb
);
1337 $this->view
->render(
1339 'modals/mass_change_members.html.twig',
1341 'mode' => $request->isXhr() ?
'ajax' : '',
1342 'page_title' => str_replace(
1345 _T('Review mass change %count members')
1347 'form_url' => $this->router
->pathFor('massstoremembers'),
1348 'cancel_uri' => $this->router
->pathFor('members'),
1350 'titles_list' => Titles
::getList($this->zdb
),
1351 'statuts' => $statuts->getList(),
1352 'changes' => $changes
1359 * Do massive changes
1361 * @param Request $request PSR Request
1362 * @param Response $response PSR Response
1366 public function doMassChange(Request
$request, Response
$response): Response
1368 $post = $request->getParsedBody();
1369 $redirect_url = $post['redirect_uri'];
1370 $error_detected = [];
1372 $dynamic_fields = null;
1374 unset($post['redirect_uri']);
1375 if (!isset($post['confirm'])) {
1376 $error_detected[] = _T("Mass changes has not been confirmed!");
1378 unset($post['confirm']);
1382 $fc = $this->fields_config
;
1383 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1384 $disabled = $this->members_fields
;
1385 foreach (array_keys($post) as $key) {
1387 foreach ($form_elements['fieldsets'] as $fieldset) {
1388 if (isset($fieldset->elements
[$key])) {
1395 //try on dynamic fields
1396 if ($dynamic_fields === null) {
1397 //handle dynamic fields
1398 $member = new Adherent($this->zdb
);
1403 $this->members_fields
,
1406 $dynamic_fields = $member->getDynamicFields()->getFields();
1408 foreach ($dynamic_fields as $field) {
1409 $field_id = 'info_field_' . $field->getId() . '_1';
1410 if ($key == $field_id) {
1419 'Permission issue mass editing field ' . $key,
1424 unset($disabled[$key]);
1428 if (!count($post)) {
1429 $error_detected[] = _T("Nothing to do!");
1431 foreach ($ids as $id) {
1432 $is_manager = !$this->login
->isAdmin()
1433 && !$this->login
->isStaff()
1434 && $this->login
->isGroupManager();
1435 $member = new Adherent($this->zdb
);
1436 $member->disableAllDeps();
1438 $member->enableDep('groups');
1440 $member->load((int)$id);
1441 $member->setDependencies(
1443 $this->members_fields
,
1446 if (!$member->canEdit($this->login
)) {
1450 $valid = $member->check($post, [], $disabled);
1451 if ($valid === true) {
1452 $done = $member->store();
1454 $error_detected[] = _T("An error occurred while storing the member.");
1459 $error_detected = array_merge($error_detected, $valid);
1465 if ($mass == 0 && !count($error_detected)) {
1466 $error_detected[] = _T('Something went wront during mass edition!');
1468 $this->flash
->addMessage(
1473 _T('%count members has been changed successfully!')
1478 if (count($error_detected) > 0) {
1479 foreach ($error_detected as $error) {
1480 $this->flash
->addMessage(
1487 if (!$request->isXhr()) {
1490 ->withHeader('Location', $redirect_url);
1492 return $response->withJson(
1494 'success' => count($error_detected) === 0
1503 * @param Request $request PSR Request
1504 * @param Response $response PSR Response
1508 public function store(Request
$request, Response
$response): Response
1510 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1513 ->withHeader('Location', $this->router
->pathFor('slash'));
1516 $post = $request->getParsedBody();
1517 $member = new Adherent($this->zdb
);
1522 $this->members_fields
,
1526 $success_detected = [];
1527 $warning_detected = [];
1528 $error_detected = [];
1530 if ($this->isSelfMembership() && !isset($post[Adherent
::PK
])) {
1531 //mark as self membership
1532 $member->setSelfMembership();
1535 $gaptcha = $this->session
->gaptcha
;
1536 if (!$gaptcha->check($post['gaptcha'])) {
1537 $error_detected[] = _T('Invalid captcha');
1542 if (isset($post['id_adh'])) {
1543 $member->load((int)$post['id_adh']);
1544 if (!$member->canEdit($this->login
)) {
1545 //redirection should have been done before. Just throw an Exception.
1546 throw new \
RuntimeException(
1550 'No right to store member #%id'
1555 if ($member->id
!= '') {
1556 $member->load($this->login
->id
);
1560 // flagging required fields
1561 $fc = $this->fields_config
;
1563 // password required if we create a new member but not from self subscription
1564 if ($member->id
!= '' ||
$this->isSelfMembership()) {
1565 $fc->setNotRequired('mdp_adh');
1569 $member->hasParent() && !isset($post['detach_parent'])
1570 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1572 $parent_fields = $member->getParentFields();
1573 foreach ($parent_fields as $field) {
1574 if ($fc->isRequired($field)) {
1575 $fc->setNotRequired($field);
1580 // flagging required fields invisible to members
1581 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1582 $fc->setNotRequired('activite_adh');
1583 $fc->setNotRequired('id_statut');
1586 $form_elements = $fc->getFormElements(
1589 $this->isSelfMembership()
1591 $fieldsets = $form_elements['fieldsets'];
1592 $required = array();
1593 $disabled = array();
1595 foreach ($fieldsets as $category) {
1596 foreach ($category->elements
as $field) {
1597 if ($field->required
== true) {
1598 $required[$field->field_id
] = true;
1600 if ($field->disabled
== true) {
1601 $disabled[$field->field_id
] = true;
1602 } elseif (!isset($post[$field->field_id
])) {
1603 switch ($field->field_id
) {
1604 //unchecked booleans are not sent from form
1605 case 'bool_admin_adh':
1606 case 'bool_exempt_adh':
1607 case 'bool_display_info':
1608 $post[$field->field_id
] = 0;
1615 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1618 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1619 if (!count($real_requireds) ||
isset($post[array_shift($real_requireds)])) {
1621 $valid = $member->check($post, $required, $disabled);
1622 if ($valid !== true) {
1623 $error_detected = array_merge($error_detected, $valid);
1626 if (count($error_detected) == 0) {
1627 //all goes well, we can proceed
1630 if ($member->id
== '') {
1634 // send email to member
1635 if ($this->isSelfMembership() ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1636 $member->setSendmail(); //flag to send creation email
1639 $store = $member->store();
1640 if ($store === true) {
1641 //member has been stored :)
1643 if ($this->isSelfMembership()) {
1644 $success_detected[] = _T("Your account has been created!");
1646 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1647 && $member->getEmail() != ''
1649 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1652 $success_detected[] = _T("New member has been successfully added.");
1655 $success_detected[] = _T("Member account has been modified.");
1658 if ($this->login
->isGroupManager()) {
1659 //add/remove user from groups
1660 $groups_adh = $post['groups_adh'] ??
null;
1661 $add_groups = Groups
::addMemberToGroups(
1666 if ($add_groups === false) {
1667 $error_detected[] = _T("An error occurred adding member to its groups.");
1670 if ($this->login
->isSuperAdmin() ||
$this->login
->isAdmin() ||
$this->login
->isStaff()) {
1671 //add/remove manager from groups
1672 $managed_groups_adh = $post['groups_managed_adh'] ??
null;
1673 $add_groups = Groups
::addMemberToGroups(
1675 $managed_groups_adh,
1678 $member->loadGroups();
1680 if ($add_groups === false) {
1681 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1685 //something went wrong :'(
1686 $error_detected[] = _T("An error occurred while storing the member.");
1690 if (count($error_detected) === 0) {
1691 $files_res = $member->handleFiles($_FILES);
1692 if (is_array($files_res)) {
1693 $error_detected = array_merge($error_detected, $files_res);
1696 if (isset($post['del_photo'])) {
1697 if (!$member->picture
->delete($member->id
)) {
1698 $error_detected[] = _T("Delete failed");
1699 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1701 'Unable to delete picture for member ' . $str_adh,
1708 if (count($error_detected) > 0) {
1709 foreach ($error_detected as $error) {
1710 if (strpos($error, '%member_url_') !== false) {
1711 preg_match('/%member_url_(\d+)/', $error, $matches);
1712 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1713 $error = str_replace(
1714 '%member_url_' . $matches[1],
1719 $this->flash
->addMessage(
1726 if (count($warning_detected) > 0) {
1727 foreach ($warning_detected as $warning) {
1728 $this->flash
->addMessage(
1734 if (count($success_detected) > 0) {
1735 foreach ($success_detected as $success) {
1736 $this->flash
->addMessage(
1743 if (count($error_detected) === 0) {
1744 if ($this->isSelfMembership()) {
1745 $redirect_url = $this->router
->pathFor('login');
1747 isset($post['redirect_on_create'])
1748 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1750 switch ($post['redirect_on_create']) {
1751 case Adherent
::AFTER_ADD_TRANS
:
1752 $redirect_url = $this->router
->pathFor('addTransaction');
1754 case Adherent
::AFTER_ADD_NEW
:
1755 $redirect_url = $this->router
->pathFor('addMember');
1757 case Adherent
::AFTER_ADD_SHOW
:
1758 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1760 case Adherent
::AFTER_ADD_LIST
:
1761 $redirect_url = $this->router
->pathFor('members');
1763 case Adherent
::AFTER_ADD_HOME
:
1764 $redirect_url = $this->router
->pathFor('slash');
1767 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1768 $redirect_url = $this->router
->pathFor(
1771 ) . '?id_adh=' . $member->id
;
1773 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1776 //store entity in session
1777 $this->session
->member
= $member;
1779 if ($this->isSelfMembership()) {
1780 $redirect_url = $this->router
->pathFor('subscribe');
1783 $redirect_url = $this->router
->pathFor(
1785 ['id' => $member->id
]
1788 $redirect_url = $this->router
->pathFor((isset($post['addchild']) ?
'addMemberChild' : 'addMember'));
1796 ->withHeader('Location', $redirect_url);
1804 * Get redirection URI
1806 * @param array $args Route arguments
1810 public function redirectUri(array $args)
1812 return $this->router
->pathFor('members');
1818 * @param array $args Route arguments
1822 public function formUri(array $args)
1824 return $this->router
->pathFor(
1834 * In simple cases, we get the ID in the route arguments; but for
1835 * batchs, it should be found elsewhere.
1836 * In post values, we look for id key, as well as all {sthing}_sel keys (like members_sel or contrib_sel)
1838 * @param array $args Request arguments
1839 * @param array $post POST values
1841 * @return null|integer|integer[]
1843 protected function getIdsToRemove(&$args, $post)
1845 if (isset($args['id'])) {
1848 $filters = $this->session
->filter_members
;
1849 return $filters->selected
;
1854 * Get confirmation removal page title
1856 * @param array $args Route arguments
1860 public function confirmRemoveTitle(array $args)
1862 if (isset($args['id_adh']) ||
isset($args['id'])) {
1863 //one member removal
1864 $id_adh = $args['id_adh'] ??
$args['id'];
1865 $adh = new Adherent($this->zdb
, (int)$id_adh);
1867 _T('Remove member %1$s'),
1871 //batch members removal
1872 $filters = $this->session
->filter_members
;
1875 count($filters->selected
),
1876 _T('You are about to remove %count members.')
1884 * @param array $args Route arguments
1885 * @param array $post POST values
1889 protected function doDelete(array $args, array $post)
1891 if (isset($this->session
->filter_members
)) {
1892 $filters = $this->session
->filter_members
;
1894 $filters = new MembersList();
1896 $members = new Members($filters);
1898 if (!is_array($post['id'])) {
1899 $ids = (array)$post['id'];
1904 return $members->removeMembers($ids);
1910 * Set self memebrship flag
1912 * @return MembersController
1914 private function setSelfMembership(): MembersController
1916 $this->is_self_membership
= true;
1921 * Is self membership?
1925 private function isSelfMembership(): bool
1927 return $this->is_self_membership
;