galette/lib/Galette/Filters/MembersList.php

   1 <?php
   2
   3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
   4
   5 /**
   6  * Members list filters and paginator
   7  *
   8  * PHP version 5
   9  *
  10  * Copyright © 2009-2014 The Galette Team
  11  *
  12  * This file is part of Galette (http://galette.tuxfamily.org).
  13  *
  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.
  18  *
  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.
  23  *
  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/>.
  26  *
  27  * @category  Filters
  28  * @package   Galette
  29  *
  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  * @version   SVN: $Id$
  34  * @link      http://galette.tuxfamily.org
  35  * @since     march, 3rd 2009
  36  */
  37
  38 namespace Galette\Filters;
  39
  40 use Analog\Analog;
  41 use Galette\Core\Pagination;
  42 use Galette\Entity\Group;
  43 use Galette\Repository\Members;
  44
  45 /**
  46  * Members list filters and paginator
  47  *
  48  * @name      MembersList
  49  * @category  Filters
  50  * @package   Galette
  51  *
  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
  56  */
  57
  58 class MembersList extends Pagination
  59 {
  60     //filters
  61     private $_filter_str;
  62     private $_field_filter;
  63     private $_membership_filter;
  64     private $_filter_account;
  65     private $_email_filter;
  66     private $_group_filter;
  67
  68     private $_selected;
  69     private $_unreachable;
  70
  71     protected $query;
  72
  73     protected $memberslist_fields = array(
  74         'filter_str',
  75         'field_filter',
  76         'membership_filter',
  77         'filter_account',
  78         'email_filter',
  79         'group_filter',
  80         'selected',
  81         'unreachable',
  82         'query'
  83     );
  84
  85     /**
  86      * Default constructor
  87      */
  88     public function __construct()
  89     {
  90         $this->reinit();
  91     }
  92
  93     /**
  94      * Returns the field we want to default set order to
  95      *
  96      * @return string field name
  97      */
  98     protected function getDefaultOrder()
  99     {
 100         return 'nom_adh';
 101     }
 102
 103     /**
 104      * Reinit default parameters
 105      *
 106      * @return void
 107      */
 108     public function reinit()
 109     {
 110         global $preferences;
 111
 112         parent::reinit();
 113         $this->_filter_str = null;
 114         $this->_field_filter = null;
 115         $this->_membership_filter = null;
 116         $this->_filter_account = $preferences->pref_filter_account;
 117         $this->_email_filter = Members::FILTER_DC_EMAIL;
 118         $this->_group_filter = null;
 119         $this->_selected = array();
 120     }
 121
 122     /**
 123      * Global getter method
 124      *
 125      * @param string $name name of the property we want to retrive
 126      *
 127      * @return object the called property
 128      */
 129     public function __get($name)
 130     {
 131         if (in_array($name, $this->pagination_fields)) {
 132             return parent::__get($name);
 133         } else {
 134             if (in_array($name, $this->memberslist_fields)) {
 135                 if ($name === 'query') {
 136                     return $this->$name;
 137                 } else {
 138                     $name = '_' . $name;
 139                     return $this->$name;
 140                 }
 141             } else {
 142                 Analog::log(
 143                     '[MembersList] Unable to get proprety `' . $name . '`',
 144                     Analog::WARNING
 145                 );
 146             }
 147         }
 148     }
 149
 150     /**
 151      * Global setter method
 152      *
 153      * @param string $name  name of the property we want to assign a value to
 154      * @param object $value a relevant value for the property
 155      *
 156      * @return void
 157      */
 158     public function __set($name, $value)
 159     {
 160         if (in_array($name, $this->pagination_fields)) {
 161             parent::__set($name, $value);
 162         } else {
 163             Analog::log(
 164                 '[MembersList] Setting property `' . $name . '`',
 165                 Analog::DEBUG
 166             );
 167
 168             switch ($name) {
 169                 case 'selected':
 170                 case 'unreachable':
 171                     if (is_array($value)) {
 172                         $name = '_' . $name;
 173                         $this->$name = $value;
 174                     } elseif ($value !== null) {
 175                         Analog::log(
 176                             '[MembersList] Value for property `' . $name .
 177                             '` should be an array (' . gettype($value) . ' given)',
 178                             Analog::WARNING
 179                         );
 180                     }
 181                     break;
 182                 case 'filter_str':
 183                     $name = '_' . $name;
 184                     $this->$name = $value;
 185                     break;
 186                 case 'field_filter':
 187                 case 'membership_filter':
 188                 case 'filter_account':
 189                     if (is_numeric($value)) {
 190                         $name = '_' . $name;
 191                         $this->$name = $value;
 192                     } elseif ($value !== null) {
 193                         Analog::log(
 194                             '[MembersList] Value for property `' . $name .
 195                             '` should be an integer (' . gettype($value) . ' given)',
 196                             Analog::WARNING
 197                         );
 198                     }
 199                     break;
 200                 case 'email_filter':
 201                     switch ($value) {
 202                         case Members::FILTER_DC_EMAIL:
 203                         case Members::FILTER_W_EMAIL:
 204                         case Members::FILTER_WO_EMAIL:
 205                             $this->_email_filter = $value;
 206                             break;
 207                         default:
 208                             Analog::log(
 209                                 '[MembersList] Value for email filter should be either ' .
 210                                 Members::FILTER_DC_EMAIL . ', ' .
 211                                 Members::FILTER_W_EMAIL . ' or ' .
 212                                 Members::FILTER_WO_EMAIL . ' (' . $value . ' given)',
 213                                 Analog::WARNING
 214                             );
 215                             break;
 216                     }
 217                     break;
 218                 case 'group_filter':
 219                     if (is_numeric($value) && $value > 0) {
 220                         //check group existence
 221                         $g = new Group();
 222                         $res = $g->load($value);
 223                         if ($res === true) {
 224                             $this->_group_filter = $value;
 225                         } else {
 226                             Analog::log(
 227                                 'Group #' . $value . ' does not exists!',
 228                                 Analog::WARNING
 229                             );
 230                         }
 231                     } elseif ($value !== null && $value !== '0') {
 232                         Analog::log(
 233                             '[MembersList] Value for group filter should be an '
 234                             .'integer (' . gettype($value) . ' given)',
 235                             Analog::WARNING
 236                         );
 237                     }
 238                     break;
 239                 case 'query':
 240                     $this->$name = $value;
 241                     break;
 242                 default:
 243                     Analog::log(
 244                         '[MembersList] Unable to set proprety `' . $name . '`',
 245                         Analog::WARNING
 246                     );
 247                     break;
 248             }
 249         }
 250     }
 251
 252     /**
 253      * Set commons filters for templates
 254      *
 255      * @param Preferences $prefs Preferences instance
 256      * @param Smarty      $view  Smarty template reference
 257      *
 258      * @return void
 259      */
 260     public function setViewCommonsFilters($prefs, \Smarty $view)
 261     {
 262         $filter_options = array(
 263             Members::FILTER_NAME            => _T("Name"),
 264             Members::FILTER_COMPANY_NAME    => _T("Company name"),
 265             Members::FILTER_ADDRESS         => _T("Address"),
 266             Members::FILTER_MAIL            => _T("Email,URL,IM"),
 267             Members::FILTER_JOB             => _T("Job"),
 268             Members::FILTER_INFOS           => _T("Infos")
 269         );
 270
 271         if ($prefs->pref_show_id) {
 272             $filter_options[Members::FILTER_NUMBER] = _T("Member number");
 273         }
 274
 275         $view->assign(
 276             'field_filter_options',
 277             $filter_options
 278         );
 279
 280         $view->assign(
 281             'membership_filter_options',
 282             array(
 283                 Members::MEMBERSHIP_ALL     => _T("All members"),
 284                 Members::MEMBERSHIP_UP2DATE => _T("Up to date members"),
 285                 Members::MEMBERSHIP_NEARLY  => _T("Close expiries"),
 286                 Members::MEMBERSHIP_LATE    => _T("Latecomers"),
 287                 Members::MEMBERSHIP_NEVER   => _T("Never contributed"),
 288                 Members::MEMBERSHIP_STAFF   => _T("Staff members"),
 289                 Members::MEMBERSHIP_ADMIN   => _T("Administrators"),
 290                 Members::MEMBERSHIP_NONE    => _T("Non members")
 291             )
 292         );
 293
 294         $view->assign(
 295             'filter_accounts_options',
 296             array(
 297                 Members::ALL_ACCOUNTS       => _T("All accounts"),
 298                 Members::ACTIVE_ACCOUNT     => _T("Active accounts"),
 299                 Members::INACTIVE_ACCOUNT   => _T("Inactive accounts")
 300             )
 301         );
 302     }
 303 }