3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Members list filters and paginator
10 * Copyright © 2009-2014 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/>.
30 * @author Johan Cwiklinski <johan@x-tnd.be>
31 * @copyright 2009-2014 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 march, 3rd 2009
37 namespace Galette\Filters
;
40 use Galette\Core\Pagination
;
41 use Galette\Entity\Group
;
42 use Galette\Repository\Members
;
45 * Members list filters and paginator
51 * @author Johan Cwiklinski <johan@x-tnd.be>
52 * @copyright 2009-2014 The Galette Team
53 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
54 * @link http://galette.tuxfamily.org
57 class MembersList
extends Pagination
61 private $_field_filter;
62 private $_membership_filter;
63 private $_filter_account;
64 private $_email_filter;
65 private $_group_filter;
68 private $_unreachable;
72 protected $memberslist_fields = array(
87 public function __construct()
93 * Returns the field we want to default set order to
95 * @return string field name
97 protected function getDefaultOrder()
103 * Reinit default parameters
107 public function reinit()
112 $this->_filter_str
= null;
113 $this->_field_filter
= null;
114 $this->_membership_filter
= null;
115 $this->_filter_account
= $preferences->pref_filter_account
;
116 $this->_email_filter
= Members
::FILTER_DC_EMAIL
;
117 $this->_group_filter
= null;
118 $this->_selected
= array();
122 * Global getter method
124 * @param string $name name of the property we want to retrive
126 * @return object the called property
128 public function __get($name)
130 if (in_array($name, $this->pagination_fields
)) {
131 return parent
::__get($name);
133 if (in_array($name, $this->memberslist_fields
)) {
134 if ($name === 'query') {
142 '[MembersList] Unable to get proprety `' . $name . '`',
150 * Global setter method
152 * @param string $name name of the property we want to assign a value to
153 * @param object $value a relevant value for the property
157 public function __set($name, $value)
159 if (in_array($name, $this->pagination_fields
)) {
160 parent
::__set($name, $value);
163 '[MembersList] Setting property `' . $name . '`',
170 if (is_array($value)) {
172 $this->$name = $value;
173 } elseif ($value !== null) {
175 '[MembersList] Value for property `' . $name .
176 '` should be an array (' . gettype($value) . ' given)',
183 $this->$name = $value;
186 case 'membership_filter':
187 case 'filter_account':
188 if (is_numeric($value)) {
190 $this->$name = $value;
191 } elseif ($value !== null) {
193 '[MembersList] Value for property `' . $name .
194 '` should be an integer (' . gettype($value) . ' given)',
201 case Members
::FILTER_DC_EMAIL
:
202 case Members
::FILTER_W_EMAIL
:
203 case Members
::FILTER_WO_EMAIL
:
204 $this->_email_filter
= $value;
208 '[MembersList] Value for email filter should be either ' .
209 Members
::FILTER_DC_EMAIL
. ', ' .
210 Members
::FILTER_W_EMAIL
. ' or ' .
211 Members
::FILTER_WO_EMAIL
. ' (' . $value . ' given)',
218 if (is_numeric($value) && $value > 0) {
219 //check group existence
221 $res = $g->load($value);
223 $this->_group_filter
= $value;
226 'Group #' . $value . ' does not exists!',
230 } elseif ($value !== null && $value !== '0') {
232 '[MembersList] Value for group filter should be an '
233 . 'integer (' . gettype($value) . ' given)',
239 $this->$name = $value;
243 '[MembersList] Unable to set proprety `' . $name . '`',
252 * Set commons filters for templates
254 * @param Preferences $prefs Preferences instance
255 * @param Smarty $view Smarty template reference
259 public function setViewCommonsFilters($prefs, \Smarty
$view)
261 $filter_options = array(
262 Members
::FILTER_NAME
=> _T("Name"),
263 Members
::FILTER_COMPANY_NAME
=> _T("Company name"),
264 Members
::FILTER_ADDRESS
=> _T("Address"),
265 Members
::FILTER_MAIL
=> _T("Email,URL,IM"),
266 Members
::FILTER_JOB
=> _T("Job"),
267 Members
::FILTER_INFOS
=> _T("Infos")
270 if ($prefs->pref_show_id
) {
271 $filter_options[Members
::FILTER_NUMBER
] = _T("Member number");
275 'field_filter_options',
280 'membership_filter_options',
282 Members
::MEMBERSHIP_ALL
=> _T("All members"),
283 Members
::MEMBERSHIP_UP2DATE
=> _T("Up to date members"),
284 Members
::MEMBERSHIP_NEARLY
=> _T("Close expiries"),
285 Members
::MEMBERSHIP_LATE
=> _T("Latecomers"),
286 Members
::MEMBERSHIP_NEVER
=> _T("Never contributed"),
287 Members
::MEMBERSHIP_STAFF
=> _T("Staff members"),
288 Members
::MEMBERSHIP_ADMIN
=> _T("Administrators"),
289 Members
::MEMBERSHIP_NONE
=> _T("Non members")
294 'filter_accounts_options',
296 Members
::ALL_ACCOUNTS
=> _T("All accounts"),
297 Members
::ACTIVE_ACCOUNT
=> _T("Active accounts"),
298 Members
::INACTIVE_ACCOUNT
=> _T("Inactive accounts")