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
34 * @link http://galette.tuxfamily.org
35 * @since march, 3rd 2009
38 namespace Galette\Filters
;
41 use Galette\Core\Pagination
;
42 use Galette\Entity\Group
;
43 use Galette\Repository\Members
;
46 * Members list filters and paginator
52 * @author Johan Cwiklinski <johan@x-tnd.be>
53 * @copyright 2009-2014 The Galette Team
54 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
55 * @link http://galette.tuxfamily.org
58 class MembersList
extends Pagination
62 private $_field_filter;
63 private $_membership_filter;
64 private $_account_status_filter;
65 private $_email_filter;
66 private $_group_filter;
69 private $_unreachable;
73 protected $memberslist_fields = array(
77 'account_status_filter',
88 public function __construct()
94 * Returns the field we want to default set order to
96 * @return string field name
98 protected function getDefaultOrder()
104 * Reinit default parameters
108 public function reinit()
111 $this->_filter_str
= null;
112 $this->_field_filter
= null;
113 $this->_membership_filter
= null;
114 $this->_account_status_filter
= null;
115 $this->_email_filter
= Members
::FILTER_DC_EMAIL
;
116 $this->_group_filter
= null;
117 $this->_selected
= array();
121 * Global getter method
123 * @param string $name name of the property we want to retrive
125 * @return object the called property
127 public function __get($name)
131 '[MembersList] Getting property `' . $name . '`',
135 if (in_array($name, $this->pagination_fields
)) {
136 return parent
::__get($name);
138 if (in_array($name, $this->memberslist_fields
)) {
139 if ($name === 'query') {
147 '[MembersList] Unable to get proprety `' .$name . '`',
155 * Global setter method
157 * @param string $name name of the property we want to assign a value to
158 * @param object $value a relevant value for the property
162 public function __set($name, $value)
164 if (in_array($name, $this->pagination_fields
)) {
165 parent
::__set($name, $value);
168 '[MembersList] Setting property `' . $name . '`',
175 if (is_array($value)) {
177 $this->$name = $value;
178 } elseif ($value !== null) {
180 '[MembersList] Value for property `' . $name .
181 '` should be an array (' . gettype($value) . ' given)',
188 $this->$name = $value;
191 case 'membership_filter':
192 case 'account_status_filter':
193 if (is_numeric($value)) {
195 $this->$name = $value;
196 } elseif ($value !== null) {
198 '[MembersList] Value for property `' . $name .
199 '` should be an integer (' . gettype($value) . ' given)',
206 case Members
::FILTER_DC_EMAIL
:
207 case Members
::FILTER_W_EMAIL
:
208 case Members
::FILTER_WO_EMAIL
:
209 $this->_email_filter
= $value;
213 '[MembersList] Value for email filter should be either ' .
214 Members
::FILTER_DC_EMAIL
. ', ' .
215 Members
::FILTER_W_EMAIL
. ' or ' .
216 Members
::FILTER_WO_EMAIL
. ' (' . $value . ' given)',
223 if (is_numeric($value) && $value > 0) {
224 //check group existence
226 $res = $g->load($value);
228 $this->_group_filter
= $value;
231 'Group #' . $value . ' does not exists!',
235 } elseif ($value !== null && $value !== '0') {
237 '[MembersList] Value for group filter should be an '
238 .'integer (' . gettype($value) . ' given)',
244 $this->$name = $value;
248 '[MembersList] Unable to set proprety `' . $name . '`',
259 * @param Select $select Original select
263 public function setLimit($select)
265 return $this->setLimits($select);
271 * @param int $c Count
275 public function setCounter($c)
277 $this->counter
= (int)$c;
282 * Set commons filters for templates
284 * @param Preferences $prefs Preferences instance
285 * @param Smarty $view Smarty template reference
289 public function setViewCommonsFilters($prefs, \Smarty
$view)
291 $filter_options = array(
292 Members
::FILTER_NAME
=> _T("Name"),
293 Members
::FILTER_COMPANY_NAME
=> _T("Company name"),
294 Members
::FILTER_ADDRESS
=> _T("Address"),
295 Members
::FILTER_MAIL
=> _T("Email,URL,IM"),
296 Members
::FILTER_JOB
=> _T("Job"),
297 Members
::FILTER_INFOS
=> _T("Infos")
300 if ($prefs->pref_show_id
) {
301 $filter_options[Members
::FILTER_NUMBER
] = _T("Member number");
305 'filter_field_options',
310 'filter_membership_options',
312 Members
::MEMBERSHIP_ALL
=> _T("All members"),
313 Members
::MEMBERSHIP_UP2DATE
=> _T("Up to date members"),
314 Members
::MEMBERSHIP_NEARLY
=> _T("Close expiries"),
315 Members
::MEMBERSHIP_LATE
=> _T("Latecomers"),
316 Members
::MEMBERSHIP_NEVER
=> _T("Never contributed"),
317 Members
::MEMBERSHIP_STAFF
=> _T("Staff members"),
318 Members
::MEMBERSHIP_ADMIN
=> _T("Administrators"),
319 Members
::MEMBERSHIP_NONE
=> _T("Non members")
324 'filter_accounts_options',
326 Members
::ALL_ACCOUNTS
=> _T("All accounts"),
327 Members
::ACTIVE_ACCOUNT
=> _T("Active accounts"),
328 Members
::INACTIVE_ACCOUNT
=> _T("Inactive accounts")