3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette members controller
10 * Copyright © 2019-2021 The Galette Team
12 * This file is part of Galette (http://galette.tuxfamily.org).
14 * Galette is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * Galette is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with Galette. If not, see <http://www.gnu.org/licenses/>.
27 * @category Controllers
30 * @author Johan Cwiklinski <johan@x-tnd.be>
31 * @copyright 2019-2021 The Galette Team
32 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
33 * @link http://galette.tuxfamily.org
34 * @since Available since 0.9.4dev - 2019-12-02
37 namespace Galette\Controllers\Crud
;
39 use Galette\Controllers\CrudController
;
40 use Galette\DynamicFields\Boolean
;
41 use Slim\Http\Request
;
42 use Slim\Http\Response
;
43 use Galette\Core\GaletteMail
;
44 use Galette\Core\Gaptcha
;
45 use Galette\Entity\Adherent
;
46 use Galette\Entity\Contribution
;
47 use Galette\Entity\ContributionsTypes
;
48 use Galette\Entity\DynamicFieldsHandle
;
49 use Galette\Entity\Group
;
50 use Galette\Entity\Status
;
51 use Galette\Entity\FieldsConfig
;
52 use Galette\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-2021 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(
143 $member->hasParent() ?
$member->parent
->id
: null
148 'filters' => $m->getFilters(),
149 'count' => $m->getCount()
153 if (count($members)) {
154 $params['members']['list'] = $members;
157 $gaptcha = new Gaptcha($this->i18n
);
158 $this->session
->gaptcha
= $gaptcha;
164 'page_title' => _T("Subscription"),
165 'parent_tpl' => 'public_page.tpl',
168 'autocomplete' => true,
169 'osocials' => new Social($this->zdb
),
172 'titles_list' => Titles
::getList($this->zdb
),
173 'fieldsets' => $form_elements['fieldsets'],
174 'hidden_elements' => $form_elements['hiddens'],
176 'gaptcha' => $gaptcha
185 * @param Request $request PSR Request
186 * @param Response $response PSR Response
190 public function doAdd(Request
$request, Response
$response): Response
192 return $this->store($request, $response);
196 * Self subscription add action
198 * @param Request $request PSR Request
199 * @param Response $response PSR Response
203 public function doSelfSubscribe(Request
$request, Response
$response): Response
205 $this->setSelfMembership();
206 return $this->doAdd($request, $response);
213 * @param Request $request PSR Request
214 * @param Response $response PSR Response
215 * @param integer $id_adh Member ID to duplicate
219 public function duplicate(Request
$request, Response
$response, int $id_adh): Response
221 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true, 'parent' => true]);
222 $adh->setDuplicate();
224 //store entity in session
225 $this->session
->member
= $adh;
229 ->withHeader('Location', $this->router
->pathFor('addMember'));
236 * Display member card
238 * @param Request $request PSR Request
239 * @param Response $response PSR Response
240 * @param integer $id Member ID
244 public function show(Request
$request, Response
$response, int $id): Response
246 $member = new Adherent($this->zdb
);
251 if (!$member->canShow($this->login
)) {
252 $this->flash
->addMessage(
254 _T("You do not have permission for requested URL.")
261 $this->router
->pathFor('me')
265 if ($member->id
== null) {
266 //member does not exists!
267 $this->flash
->addMessage(
269 str_replace('%id', $id, _T("No member #%id."))
275 $this->router
->pathFor('slash')
279 // flagging fields visibility
280 $fc = $this->fields_config
;
281 $display_elements = $fc->getDisplayElements($this->login
);
288 'page_title' => _T("Member Profile"),
290 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
291 'pref_card_self' => $this->preferences
->pref_card_self
,
292 'groups' => Groups
::getSimpleList(),
294 'display_elements' => $display_elements,
295 'osocials' => new Social($this->zdb
)
304 * @param Request $request PSR Request
305 * @param Response $response PSR Response
309 public function showMe(Request
$request, Response
$response): Response
311 if ($this->login
->isSuperAdmin()) {
314 ->withHeader('Location', $this->router
->pathFor('slash'));
316 return $this->show($request, $response, $this->login
->id
);
320 * Public pages (trombinoscope, public list)
322 * @param Request $request PSR Request
323 * @param Response $response PSR Response
324 * @param string $option One of 'page' or 'order'
325 * @param string|integer $value Value of the option
326 * @param string $type List type (either list or trombi)
330 public function publicList(
337 $varname = 'public_filter_' . $type;
338 if (isset($this->session
->$varname)) {
339 $filters = $this->session
->$varname;
341 $filters = new MembersList();
344 if ($option !== null) {
347 $filters->current_page
= (int)$value;
350 $filters->orderby
= $value;
355 $m = new Members($filters);
356 $members = $m->getPublicList($type === 'trombi');
358 $this->session
->$varname = $filters;
360 //assign pagination variables to the template and add pagination links
361 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
366 ($type === 'list' ?
'liste_membres' : 'trombinoscope') . '.tpl',
368 'page_title' => ($type === 'list' ?
_T("Members list") : _T('Trombinoscope')),
369 'additionnal_html_class' => ($type === 'list' ?
'' : 'trombinoscope'),
371 'members' => $members,
372 'nb_members' => $m->getCount(),
373 'filters' => $filters
380 * Public pages (trombinoscope, public list)
382 * @param Request $request PSR Request
383 * @param Response $response PSR Response
384 * @param string $type Type
388 public function filterPublicList(Request
$request, Response
$response, string $type): Response
390 $post = $request->getParsedBody();
392 $varname = 'public_filter_' . $type;
393 if (isset($this->session
->$varname)) {
394 $filters = $this->session
->$varname;
396 $filters = new MembersList();
399 //reintialize filters
400 if (isset($post['clear_filter'])) {
403 //number of rows to show
404 if (isset($post['nbshow'])) {
405 $filters->show
= (int)$post['nbshow'];
409 $this->session
->$varname = $filters;
413 ->withHeader('Location', $this->router
->pathFor('publicList', ['type' => $type]));
419 * @param Request $request PSR Request
420 * @param Response $response PSR Response
421 * @param integer $id Member ID
422 * @param integer $fid Dynamic fields ID
423 * @param integer $pos Dynamic field position
424 * @param string $name File name
428 public function getDynamicFile(
436 $member = new Adherent($this->zdb
);
439 ->enableDep('dynamics')
443 if (!$member->canShow($this->login
)) {
444 $fields = $member->getDynamicFields()->getFields();
445 if (!isset($fields[$fid])) {
446 //field does not exists or access is forbidden
453 if ($denied === true) {
454 $this->flash
->addMessage(
456 _T("You do not have permission for requested URL.")
462 $this->router
->pathFor(
469 $filename = str_replace(
480 'member_%mid_field_%fid_value_%pos'
483 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
484 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
486 $response = $response->withHeader('Content-Description', 'File Transfer')
487 ->withHeader('Content-Type', $type)
488 ->withHeader('Content-Disposition', 'attachment;filename="' . $name . '"')
489 ->withHeader('Pragma', 'no-cache')
490 ->withHeader('Content-Transfer-Encoding', 'binary')
491 ->withHeader('Expires', '0')
492 ->withHeader('Cache-Control', 'must-revalidate')
493 ->withHeader('Pragma', 'public');
495 $stream = fopen('php://memory', 'r+');
496 fwrite($stream, file_get_contents(GALETTE_FILES_PATH
. $filename));
499 return $response->withBody(new \Slim\Http\
Stream($stream));
502 'A request has been made to get a dynamic file named `' .
503 $filename . '` that does not exists.',
507 $this->flash
->addMessage(
509 _T("The file does not exists or cannot be read :(")
515 $this->router
->pathFor('member', ['id' => $id])
523 * @param Request $request PSR Request
524 * @param Response $response PSR Response
525 * @param string $option One of 'page' or 'order'
526 * @param string|integer $value Value of the option
530 public function list(Request
$request, Response
$response, $option = null, $value = null): Response
532 if (isset($this->session
->filter_members
)) {
533 $filters = $this->session
->filter_members
;
535 $filters = new MembersList();
538 if ($option !== null) {
541 $filters->current_page
= (int)$value;
544 $filters->orderby
= $value;
549 $members = new Members($filters);
551 $members_list = array();
552 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
553 $members_list = $members->getMembersList(true);
555 $members_list = $members->getManagedMembersList(true);
558 $groups = new Groups($this->zdb
, $this->login
);
559 $groups_list = $groups->getList();
561 //assign pagination variables to the template and add pagination links
562 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
563 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
565 $this->session
->filter_members
= $filters;
570 'gestion_adherents.tpl',
572 'page_title' => _T("Members management"),
573 'require_mass' => true,
574 'members' => $members_list,
575 'filter_groups_options' => $groups_list,
576 'nb_members' => $members->getCount(),
577 'filters' => $filters,
578 'adv_filters' => $filters instanceof AdvancedMembersList
,
579 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
588 * @param Request $request PSR Request
589 * @param Response $response PSR Response
593 public function filter(Request
$request, Response
$response): Response
595 $post = $request->getParsedBody();
596 if (isset($this->session
->filter_members
)) {
597 //CAUTION: this one may be simple or advanced, display must change
598 $filters = $this->session
->filter_members
;
600 $filters = new MembersList();
603 //reintialize filters
604 if (isset($post['clear_filter'])) {
605 $filters = new MembersList();
606 } elseif (isset($post['clear_adv_filter'])) {
607 $this->session
->filter_members
= null;
608 unset($this->session
->filter_members
);
612 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
613 } elseif (isset($post['adv_criteria'])) {
616 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
619 if (isset($post['filter_str'])) { //filter search string
620 $filters->filter_str
= stripslashes(
621 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
625 if (isset($post['field_filter'])) {
626 if (is_numeric($post['field_filter'])) {
627 $filters->field_filter
= $post['field_filter'];
630 //membership to filter
631 if (isset($post['membership_filter'])) {
632 if (is_numeric($post['membership_filter'])) {
633 $filters->membership_filter
634 = $post['membership_filter'];
637 //account status to filter
638 if (isset($post['filter_account'])) {
639 if (is_numeric($post['filter_account'])) {
640 $filters->filter_account
= $post['filter_account'];
644 if (isset($post['email_filter'])) {
645 $filters->email_filter
= (int)$post['email_filter'];
649 isset($post['group_filter'])
650 && $post['group_filter'] > 0
652 $filters->group_filter
= (int)$post['group_filter'];
654 //number of rows to show
655 if (isset($post['nbshow'])) {
656 $filters->show
= (int)$post['nbshow'];
659 if (isset($post['advanced_filtering'])) {
660 if (!$filters instanceof AdvancedMembersList
) {
661 $filters = new AdvancedMembersList($filters);
665 unset($post['advanced_filtering']);
667 foreach ($post as $k => $v) {
668 if (strpos($k, 'free_', 0) === 0) {
671 foreach ($post['free_field'] as $f) {
674 && trim($post['free_text'][$i]) !== ''
676 $fs_search = htmlspecialchars($post['free_text'][$i], ENT_QUOTES
);
678 = (int)$post['free_logical_operator'][$i];
680 = (int)$post['free_query_operator'][$i];
681 $type = (int)$post['free_type'][$i];
686 'search' => $fs_search,
690 $filters->free_search
= $fs;
696 } elseif ($k == 'groups_search') {
698 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
699 foreach ($post['groups_search'] as $g) {
700 if (trim($g) !== '') {
705 $filters->groups_search
= $gs;
711 case 'contrib_min_amount':
712 case 'contrib_max_amount':
713 if (trim($v) !== '') {
726 if (isset($post['savesearch'])) {
731 $this->router
->pathFor(
738 $this->session
->filter_members
= $filters;
742 ->withHeader('Location', $this->router
->pathFor('members'));
746 * Advanced search page
748 * @param Request $request PSR Request
749 * @param Response $response PSR Response
753 public function advancedSearch(Request
$request, Response
$response): Response
755 if (isset($this->session
->filter_members
)) {
756 $filters = $this->session
->filter_members
;
757 if (!$filters instanceof AdvancedMembersList
) {
758 $filters = new AdvancedMembersList($filters);
761 $filters = new AdvancedMembersList();
764 $groups = new Groups($this->zdb
, $this->login
);
765 $groups_list = $groups->getList();
767 //we want only visible fields
768 $fields = $this->members_fields
;
769 $fc = $this->fields_config
;
770 $fc->filterVisible($this->login
, $fields);
772 //add status label search
773 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
774 $fields = array_slice($fields, 0, $pos, true) +
775 ['status_label' => ['label' => _T('Status label')]] +
776 array_slice($fields, $pos, count($fields) - 1, true);
780 $member = new Adherent($this->zdb
);
783 ->enableDep('dynamics')
784 ->loadFromLoginOrMail($this->login
->login
);
785 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
787 $contrib = new Contribution($this->zdb
, $this->login
);
788 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
791 $statuts = new Status($this->zdb
);
793 //Contributions types
794 $ct = new ContributionsTypes($this->zdb
);
797 $ptypes = new PaymentTypes(
802 $ptlist = $ptypes->getList();
804 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
806 $social = new Social($this->zdb
);
807 $types = $member->getMemberRegisteredTypes();
809 foreach ($types as $type) {
810 $social_types[$type] = $social->getSystemType($type);
816 'advanced_search.tpl',
818 'page_title' => _T("Advanced search"),
819 'filter_groups_options' => $groups_list,
820 'search_fields' => $fields,
821 'adh_dynamics' => $adh_dynamics->getFields(),
822 'contrib_dynamics' => $contrib_dynamics->getFields(),
823 'adh_socials' => $social_types,
824 'statuts' => $statuts->getList(),
825 'contributions_types' => $ct->getList(),
826 'filters' => $filters,
827 'payments_types' => $ptlist
834 * Members list for ajax
836 * @param Request $request PSR Request
837 * @param Response $response PSR Response
838 * @param string|null $option One of 'page' or 'order'
839 * @param string|integer $value Value of the option
843 public function ajaxList(Request
$request, Response
$response, string $option = null, $value = null): Response
845 $post = $request->getParsedBody();
847 $filters = $this->session
->ajax_members_filters ??
new MembersList();
849 if ($option == 'page') {
850 $filters->current_page
= (int)$value;
853 //numbers of rows to display
854 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
855 $filters->show
= (int)$post['nbshow'];
858 $members = new Members($filters);
859 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
860 if ($this->login
->isGroupManager()) {
861 $members_list = $members->getManagedMembersList(true);
866 [$this->login
->id
, $this->login
->login
],
867 'Trying to list group members without access from #%id (%login)'
871 throw new \
Exception('Access denied.');
874 $members_list = $members->getMembersList(true);
877 //assign pagination variables to the template and add pagination links
878 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
880 $this->session
->ajax_members_filters
= $filters;
882 $selected_members = null;
883 $unreachables_members = null;
884 if (!isset($post['from'])) {
885 $mailing = $this->session
->mailing
;
886 if (!isset($post['members'])) {
887 $selected_members = $mailing->recipients
;
888 $unreachables_members = $mailing->unreachables
;
891 $selected_members = $m->getArrayList($post['members']);
892 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
893 $unreachables_members = $m->getArrayList($post['unreachables']);
897 switch ($post['from']) {
899 if (!isset($post['gid'])) {
901 'Trying to list group members with no group id provided',
904 throw new \
Exception('A group id is required.');
906 if (!isset($post['members'])) {
907 $group = new Group((int)$post['gid']);
908 $selected_members = array();
909 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
910 $selected_members = $group->getMembers();
911 } elseif ($post['mode'] == 'managers') {
912 $selected_members = $group->getManagers();
915 'Trying to list group members with unknown mode',
918 throw new \
Exception('Unknown mode.');
922 $selected_members = $m->getArrayList($post['members']);
923 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
924 $unreachables_members = $m->getArrayList($post['unreachables']);
929 if (!isset($post['id_adh'])) {
930 throw new \
RuntimeException(
931 'Current selected member must be excluded while attaching!'
939 'filters' => $filters,
940 'members_list' => $members_list,
941 'selected_members' => $selected_members,
942 'unreachables_members' => $unreachables_members
945 if (isset($post['multiple'])) {
946 $params['multiple'] = true;
949 if (isset($post['gid'])) {
950 $params['the_id'] = (int)$post['gid'];
953 if (isset($post['id_adh'])) {
954 $params['excluded'] = (int)$post['id_adh'];
967 * Batch actions handler
969 * @param Request $request PSR Request
970 * @param Response $response PSR Response
974 public function handleBatch(Request
$request, Response
$response): Response
976 $post = $request->getParsedBody();
978 if (isset($post['member_sel'])) {
979 if (isset($this->session
->filter_members
)) {
980 $filters = $this->session
->filter_members
;
982 $filters = new MembersList();
985 $filters->selected
= $post['member_sel'];
986 $this->session
->filter_members
= $filters;
988 if (isset($post['cards'])) {
991 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
994 if (isset($post['labels'])) {
997 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
1000 if (isset($post['mailing'])) {
1003 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
1006 if (isset($post['attendance_sheet'])) {
1009 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
1012 if (isset($post['csv'])) {
1015 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
1018 if (isset($post['delete'])) {
1021 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
1024 if (isset($post['masschange'])) {
1027 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
1030 if (isset($post['masscontributions'])) {
1033 ->withHeader('Location', $this->router
->pathFor('massAddContributionsChooseType'));
1036 throw new \
RuntimeException('Does not know what to batch :(');
1038 $this->flash
->addMessage(
1040 _T("No member was selected, please check at least one name.")
1045 ->withHeader('Location', $this->router
->pathFor('members'));
1055 * @param Request $request PSR Request
1056 * @param Response $response PSR Response
1057 * @param mixed $id Member id/array of members id
1058 * @param string $action null or 'add'
1062 public function edit(
1066 string $action = 'edit'
1068 //instantiate member object
1069 $member = new Adherent($this->zdb
);
1070 $member->enableAllDeps()->load($id);
1072 if ($this->session
->member
!== null) {
1073 //retrieve from session, in add or edit
1074 $member = $this->session
->member
;
1075 $this->session
->member
= null;
1080 //load requested member
1082 $can = $member->canEdit($this->login
);
1084 $can = $member->canCreate($this->login
);
1088 $this->flash
->addMessage(
1090 _T("You do not have permission for requested URL.")
1096 $this->router
->pathFor('me')
1100 //if adding a child, force parent here
1101 if ($action === 'addchild') {
1102 $member->setParent((int)$this->login
->id
);
1105 // flagging required fields
1106 $fc = $this->fields_config
;
1108 // password required if we create a new member
1110 $fc->setNotRequired('mdp_adh');
1113 //handle requirements for parent fields
1114 $parent_fields = $member->getParentFields();
1115 $tpl_parent_fields = []; //for JS when detaching
1116 foreach ($parent_fields as $field) {
1117 if ($fc->isRequired($field)) {
1118 $tpl_parent_fields[] = $field;
1119 if ($member->hasParent()) {
1120 $fc->setNotRequired($field);
1125 // flagging required fields invisible to members
1126 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1127 $fc->setNotRequired('activite_adh');
1128 $fc->setNotRequired('id_statut');
1131 // template variable declaration
1132 $title = _T("Member Profile");
1133 if ($member->id
!= '') {
1134 $title .= ' (' . _T("modification") . ')';
1136 $title .= ' (' . _T("creation") . ')';
1140 $statuts = new Status($this->zdb
);
1143 $groups = new Groups($this->zdb
, $this->login
);
1144 $groups_list = $groups->getSimpleList(true);
1146 $form_elements = $fc->getFormElements(
1154 if ($member->hasParent()) {
1155 $pid = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1157 $members = $m->getSelectizedMembers(
1162 $route_params['members'] = [
1163 'filters' => $m->getFilters(),
1164 'count' => $m->getCount()
1167 if (count($members)) {
1168 $route_params['members']['list'] = $members;
1172 $this->view
->render(
1176 'parent_tpl' => 'page.tpl',
1177 'autocomplete' => true,
1178 'page_title' => $title,
1179 'member' => $member,
1180 'self_adh' => false,
1181 // pseudo random int
1183 'titles_list' => Titles
::getList($this->zdb
),
1184 'statuts' => $statuts->getList(),
1185 'groups' => $groups_list,
1186 'fieldsets' => $form_elements['fieldsets'],
1187 'hidden_elements' => $form_elements['hiddens'],
1188 'parent_fields' => $tpl_parent_fields,
1189 'addchild' => ($action === 'addchild'),
1190 'osocials' => new Social($this->zdb
)
1199 * @param Request $request PSR Request
1200 * @param Response $response PSR Response
1201 * @param integer $id Member id
1205 public function doEdit(Request
$request, Response
$response, int $id): Response
1207 return $this->store($request, $response);
1211 * Massive change page
1213 * @param Request $request PSR Request
1214 * @param Response $response PSR Response
1218 public function massChange(Request
$request, Response
$response): Response
1220 $filters = $this->session
->filter_members
;
1223 'id' => $filters->selected
,
1224 'redirect_uri' => $this->router
->pathFor('members')
1227 $fc = $this->fields_config
;
1228 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1231 $member = new Adherent($this->zdb
);
1232 $member->disableAllDeps()->enableDep('dynamics');
1235 $statuts = new Status($this->zdb
);
1238 $this->view
->render(
1240 'mass_change_members.tpl',
1242 'mode' => $request->isXhr() ?
'ajax' : '',
1243 'page_title' => str_replace(
1246 _T('Mass change %count members')
1248 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1249 'cancel_uri' => $this->router
->pathFor('members'),
1251 'member' => $member,
1252 'fieldsets' => $form_elements['fieldsets'],
1253 'titles_list' => Titles
::getList($this->zdb
),
1254 'statuts' => $statuts->getList(),
1255 'require_mass' => true
1262 * Massive changes validation page
1264 * @param Request $request PSR Request
1265 * @param Response $response PSR Response
1269 public function validateMassChange(Request
$request, Response
$response): Response
1271 $post = $request->getParsedBody();
1273 if (!isset($post['confirm'])) {
1274 $this->flash
->addMessage(
1276 _T("Mass changes has not been confirmed!")
1279 //we want only visibles fields
1280 $fc = $this->fields_config
;
1281 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1284 foreach ($form_elements['fieldsets'] as $form_element) {
1285 foreach ($form_element->elements
as $field) {
1287 isset($post['mass_' . $field->field_id
])
1288 && (isset($post[$field->field_id
]) ||
$field->type
=== FieldsConfig
::TYPE_BOOL
)
1290 $changes[$field->field_id
] = [
1291 'label' => $field->label
,
1292 'value' => $post[$field->field_id
] ??
0
1298 //handle dynamic fields
1299 $member = new Adherent($this->zdb
);
1304 $this->members_fields
,
1307 $dynamic_fields = $member->getDynamicFields()->getFields();
1308 foreach ($dynamic_fields as $field) {
1309 $mass_id = 'mass_info_field_' . $field->getId();
1310 $field_id = 'info_field_' . $field->getId() . '_1';
1312 isset($post[$mass_id])
1313 && (isset($post[$field_id]) ||
$field instanceof Boolean
)
1315 $changes[$field_id] = [
1316 'label' => $field->getName(),
1317 'value' => $post[$field_id] ??
0
1323 $filters = $this->session
->filter_members
;
1325 'id' => $filters->selected
,
1326 'redirect_uri' => $this->router
->pathFor('members')
1330 $statuts = new Status($this->zdb
);
1333 $this->view
->render(
1335 'mass_change_members.tpl',
1337 'mode' => $request->isXhr() ?
'ajax' : '',
1338 'page_title' => str_replace(
1341 _T('Review mass change %count members')
1343 'form_url' => $this->router
->pathFor('massstoremembers'),
1344 'cancel_uri' => $this->router
->pathFor('members'),
1346 'titles_list' => Titles
::getList($this->zdb
),
1347 'statuts' => $statuts->getList(),
1348 'changes' => $changes
1355 * Do massive changes
1357 * @param Request $request PSR Request
1358 * @param Response $response PSR Response
1362 public function doMassChange(Request
$request, Response
$response): Response
1364 $post = $request->getParsedBody();
1365 $redirect_url = $post['redirect_uri'];
1366 $error_detected = [];
1368 $dynamic_fields = null;
1370 unset($post['redirect_uri']);
1371 if (!isset($post['confirm'])) {
1372 $error_detected[] = _T("Mass changes has not been confirmed!");
1374 unset($post['confirm']);
1378 $fc = $this->fields_config
;
1379 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1380 $disabled = $this->members_fields
;
1381 foreach (array_keys($post) as $key) {
1383 foreach ($form_elements['fieldsets'] as $fieldset) {
1384 if (isset($fieldset->elements
[$key])) {
1391 //try on dynamic fields
1392 if ($dynamic_fields === null) {
1393 //handle dynamic fields
1394 $member = new Adherent($this->zdb
);
1399 $this->members_fields
,
1402 $dynamic_fields = $member->getDynamicFields()->getFields();
1404 foreach ($dynamic_fields as $field) {
1405 $field_id = 'info_field_' . $field->getId() . '_1';
1406 if ($key == $field_id) {
1415 'Permission issue mass editing field ' . $key,
1420 unset($disabled[$key]);
1424 if (!count($post)) {
1425 $error_detected[] = _T("Nothing to do!");
1427 foreach ($ids as $id) {
1428 $is_manager = !$this->login
->isAdmin()
1429 && !$this->login
->isStaff()
1430 && $this->login
->isGroupManager();
1431 $member = new Adherent($this->zdb
);
1432 $member->disableAllDeps();
1434 $member->enableDep('groups');
1436 $member->load((int)$id);
1437 $member->setDependencies(
1439 $this->members_fields
,
1442 if (!$member->canEdit($this->login
)) {
1446 $valid = $member->check($post, [], $disabled);
1447 if ($valid === true) {
1448 $done = $member->store();
1450 $error_detected[] = _T("An error occurred while storing the member.");
1455 $error_detected = array_merge($error_detected, $valid);
1461 if ($mass == 0 && !count($error_detected)) {
1462 $error_detected[] = _T('Something went wront during mass edition!');
1464 $this->flash
->addMessage(
1469 _T('%count members has been changed successfully!')
1474 if (count($error_detected) > 0) {
1475 foreach ($error_detected as $error) {
1476 $this->flash
->addMessage(
1483 if (!$request->isXhr()) {
1486 ->withHeader('Location', $redirect_url);
1488 return $response->withJson(
1490 'success' => count($error_detected) === 0
1499 * @param Request $request PSR Request
1500 * @param Response $response PSR Response
1504 public function store(Request
$request, Response
$response): Response
1506 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1509 ->withHeader('Location', $this->router
->pathFor('slash'));
1512 $post = $request->getParsedBody();
1513 $member = new Adherent($this->zdb
);
1518 $this->members_fields
,
1522 $success_detected = [];
1523 $warning_detected = [];
1524 $error_detected = [];
1526 if ($this->isSelfMembership() && !isset($post[Adherent
::PK
])) {
1527 //mark as self membership
1528 $member->setSelfMembership();
1531 $gaptcha = $this->session
->gaptcha
;
1532 if (!$gaptcha->check($post['gaptcha'])) {
1533 $error_detected[] = _T('Invalid captcha');
1538 if (isset($post['id_adh'])) {
1539 $member->load((int)$post['id_adh']);
1540 if (!$member->canEdit($this->login
)) {
1541 //redirection should have been done before. Just throw an Exception.
1542 throw new \
RuntimeException(
1546 'No right to store member #%id'
1551 if ($member->id
!= '') {
1552 $member->load($this->login
->id
);
1556 // flagging required fields
1557 $fc = $this->fields_config
;
1559 // password required if we create a new member but not from self subscription
1560 if ($member->id
!= '' ||
$this->isSelfMembership()) {
1561 $fc->setNotRequired('mdp_adh');
1565 $member->hasParent() && !isset($post['detach_parent'])
1566 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1568 $parent_fields = $member->getParentFields();
1569 foreach ($parent_fields as $field) {
1570 if ($fc->isRequired($field)) {
1571 $fc->setNotRequired($field);
1576 // flagging required fields invisible to members
1577 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1578 $fc->setNotRequired('activite_adh');
1579 $fc->setNotRequired('id_statut');
1582 $form_elements = $fc->getFormElements(
1585 $this->isSelfMembership()
1587 $fieldsets = $form_elements['fieldsets'];
1588 $required = array();
1589 $disabled = array();
1591 foreach ($fieldsets as $category) {
1592 foreach ($category->elements
as $field) {
1593 if ($field->required
== true) {
1594 $required[$field->field_id
] = true;
1596 if ($field->disabled
== true) {
1597 $disabled[$field->field_id
] = true;
1598 } elseif (!isset($post[$field->field_id
])) {
1599 switch ($field->field_id
) {
1600 //unchecked booleans are not sent from form
1601 case 'bool_admin_adh':
1602 case 'bool_exempt_adh':
1603 case 'bool_display_info':
1604 $post[$field->field_id
] = 0;
1611 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1614 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1615 if (!count($real_requireds) ||
isset($post[array_shift($real_requireds)])) {
1617 $valid = $member->check($post, $required, $disabled);
1618 if ($valid !== true) {
1619 $error_detected = array_merge($error_detected, $valid);
1622 if (count($error_detected) == 0) {
1623 //all goes well, we can proceed
1626 if ($member->id
== '') {
1630 // send email to member
1631 if ($this->isSelfMembership() ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1632 $member->setSendmail(); //flag to send creation email
1635 $store = $member->store();
1636 if ($store === true) {
1637 //member has been stored :)
1639 if ($this->isSelfMembership()) {
1640 $success_detected[] = _T("Your account has been created!");
1642 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1643 && $member->getEmail() != ''
1645 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1648 $success_detected[] = _T("New member has been successfully added.");
1651 $success_detected[] = _T("Member account has been modified.");
1654 if ($this->login
->isGroupManager()) {
1655 //store requested groups
1656 $groups_adh = $post['groups_adh'] ??
null;
1657 $managed_groups_adh = $post['groups_managed_adh'] ??
null;
1659 //add/remove user from groups
1660 $add_groups = Groups
::addMemberToGroups(
1665 if ($add_groups === false) {
1666 $error_detected[] = _T("An error occurred adding member to its groups.");
1669 //add/remove manager from groups
1670 $add_groups = Groups
::addMemberToGroups(
1672 $managed_groups_adh,
1675 $member->loadGroups();
1677 if ($add_groups === false) {
1678 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1682 //something went wrong :'(
1683 $error_detected[] = _T("An error occurred while storing the member.");
1687 if (count($error_detected) === 0) {
1688 $files_res = $member->handleFiles($_FILES);
1689 if (is_array($files_res)) {
1690 $error_detected = array_merge($error_detected, $files_res);
1693 if (isset($post['del_photo'])) {
1694 if (!$member->picture
->delete($member->id
)) {
1695 $error_detected[] = _T("Delete failed");
1696 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1698 'Unable to delete picture for member ' . $str_adh,
1705 if (count($error_detected) > 0) {
1706 foreach ($error_detected as $error) {
1707 if (strpos($error, '%member_url_') !== false) {
1708 preg_match('/%member_url_(\d+)/', $error, $matches);
1709 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1710 $error = str_replace(
1711 '%member_url_' . $matches[1],
1716 $this->flash
->addMessage(
1723 if (count($warning_detected) > 0) {
1724 foreach ($warning_detected as $warning) {
1725 $this->flash
->addMessage(
1731 if (count($success_detected) > 0) {
1732 foreach ($success_detected as $success) {
1733 $this->flash
->addMessage(
1740 if (count($error_detected) === 0) {
1741 if ($this->isSelfMembership()) {
1742 $redirect_url = $this->router
->pathFor('login');
1744 isset($post['redirect_on_create'])
1745 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1747 switch ($post['redirect_on_create']) {
1748 case Adherent
::AFTER_ADD_TRANS
:
1749 $redirect_url = $this->router
->pathFor('addTransaction');
1751 case Adherent
::AFTER_ADD_NEW
:
1752 $redirect_url = $this->router
->pathFor('addMember');
1754 case Adherent
::AFTER_ADD_SHOW
:
1755 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1757 case Adherent
::AFTER_ADD_LIST
:
1758 $redirect_url = $this->router
->pathFor('members');
1760 case Adherent
::AFTER_ADD_HOME
:
1761 $redirect_url = $this->router
->pathFor('slash');
1764 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1765 $redirect_url = $this->router
->pathFor(
1768 ) . '?id_adh=' . $member->id
;
1770 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1773 //store entity in session
1774 $this->session
->member
= $member;
1776 if ($this->isSelfMembership()) {
1777 $redirect_url = $this->router
->pathFor('subscribe');
1780 $redirect_url = $this->router
->pathFor(
1782 ['id' => $member->id
]
1785 $redirect_url = $this->router
->pathFor((isset($post['addchild']) ?
'addMemberChild' : 'addMember'));
1793 ->withHeader('Location', $redirect_url);
1801 * Get redirection URI
1803 * @param array $args Route arguments
1807 public function redirectUri(array $args)
1809 return $this->router
->pathFor('members');
1815 * @param array $args Route arguments
1819 public function formUri(array $args)
1821 return $this->router
->pathFor(
1831 * In simple cases, we get the ID in the route arguments; but for
1832 * batchs, it should be found elsewhere.
1833 * In post values, we look for id key, as well as all {sthing}_sel keys (like members_sel or contrib_sel)
1835 * @param array $args Request arguments
1836 * @param array $post POST values
1838 * @return null|integer|integer[]
1840 protected function getIdsToRemove(&$args, $post)
1842 if (isset($args['id'])) {
1845 $filters = $this->session
->filter_members
;
1846 return $filters->selected
;
1851 * Get confirmation removal page title
1853 * @param array $args Route arguments
1857 public function confirmRemoveTitle(array $args)
1859 if (isset($args['id_adh']) ||
isset($args['id'])) {
1860 //one member removal
1861 $id_adh = $args['id_adh'] ??
$args['id'];
1862 $adh = new Adherent($this->zdb
, (int)$id_adh);
1864 _T('Remove member %1$s'),
1868 //batch members removal
1869 $filters = $this->session
->filter_members
;
1872 count($filters->selected
),
1873 _T('You are about to remove %count members.')
1881 * @param array $args Route arguments
1882 * @param array $post POST values
1886 protected function doDelete(array $args, array $post)
1888 if (isset($this->session
->filter_members
)) {
1889 $filters = $this->session
->filter_members
;
1891 $filters = new MembersList();
1893 $members = new Members($filters);
1895 if (!is_array($post['id'])) {
1896 $ids = (array)$post['id'];
1901 return $members->removeMembers($ids);
1907 * Set self memebrship flag
1909 * @return MembersController
1911 private function setSelfMembership(): MembersController
1913 $this->is_self_membership
= true;
1918 * Is self membership?
1922 private function isSelfMembership(): bool
1924 return $this->is_self_membership
;