galette/lib/Galette/Entity/Contribution.php

   1 <?php
   2
   3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
   4
   5 /**
   6  * Contribution class for galette
   7  *
   8  * PHP version 5
   9  *
  10  * Copyright © 2010-2021 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  Entity
  28  * @package   Galette
  29  *
  30  * @author    Johan Cwiklinski <johan@x-tnd.be>
  31  * @copyright 2010-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.7dev - 2010-03-11
  35  */
  36
  37 namespace Galette\Entity;
  38
  39 use Throwable;
  40 use Analog\Analog;
  41 use Laminas\Db\Sql\Expression;
  42 use Galette\Core\Db;
  43 use Galette\Core\Login;
  44 use Galette\IO\ExternalScript;
  45 use Galette\IO\PdfContribution;
  46 use Galette\Repository\PaymentTypes;
  47
  48 /**
  49  * Contribution class for galette
  50  *
  51  * @category  Entity
  52  * @name      Contribution
  53  * @package   Galette
  54  * @author    Johan Cwiklinski <johan@x-tnd.be>
  55  * @copyright 2010-2021 The Galette Team
  56  * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
  57  * @link      http://galette.tuxfamily.org
  58  * @since     Available since 0.7dev - 2010-03-11
  59  */
  60 class Contribution
  61 {
  62     use DynamicsTrait;
  63
  64     public const TABLE = 'cotisations';
  65     public const PK = 'id_cotis';
  66
  67     private $_id;
  68     private $_date;
  69     private $_member;
  70     private $_type;
  71     private $_amount;
  72     private $_payment_type;
  73     private $_orig_amount;
  74     private $_info;
  75     private $_begin_date;
  76     private $_end_date;
  77     private $_transaction = null;
  78     private $_is_cotis;
  79     private $_extension;
  80
  81     //fields list and their translation
  82     private $_fields;
  83
  84     private $zdb;
  85     private $login;
  86
  87     private $errors;
  88
  89     private $sendmail = false;
  90
  91     /**
  92      * Default constructor
  93      *
  94      * @param Db                 $zdb   Database
  95      * @param Login              $login Login instance
  96      * @param null|int|ResultSet $args  Either a ResultSet row to load
  97      *                                  a specific contribution, or an type id
  98      *                                  to just instanciate object
  99      */
 100     public function __construct(Db $zdb, Login $login, $args = null)
 101     {
 102         $this->zdb = $zdb;
 103         $this->login = $login;
 104
 105         /*
 106          * Fields configuration. Each field is an array and must reflect:
 107          * array(
 108          *   (string)label,
 109          *   (string) propname
 110          * )
 111          *
 112          * I'd prefer a static private variable for this...
 113          * But call to the _T function does not seem to be allowed there :/
 114          */
 115         $this->_fields = array(
 116             'id_cotis'            => array(
 117                 'label'    => null, //not a field in the form
 118                 'propname' => 'id'
 119             ),
 120             Adherent::PK          => array(
 121                 'label'    => _T("Contributor:"),
 122                 'propname' => 'member'
 123             ),
 124             ContributionsTypes::PK => array(
 125                 'label'    => _T("Contribution type:"),
 126                 'propname' => 'type'
 127             ),
 128             'montant_cotis'       => array(
 129                 'label'    => _T("Amount:"),
 130                 'propname' => 'amount'
 131             ),
 132             'type_paiement_cotis' => array(
 133                 'label'    => _T("Payment type:"),
 134                 'propname' => 'payment_type'
 135             ),
 136             'info_cotis'          => array(
 137                 'label'    => _T("Comments:"),
 138                 'propname' => 'info'
 139             ),
 140             'date_enreg'          => array(
 141                 'label'    => null, //not a field in the form
 142                 'propname' => 'date'
 143             ),
 144             'date_debut_cotis'    => array(
 145                 'label'    => _T("Date of contribution:"),
 146                 'cotlabel' => _T("Start date of membership:"), //if contribution is a cotisation, label differs
 147                 'propname' => 'begin_date'
 148             ),
 149             'date_fin_cotis'      => array(
 150                 'label'    => _T("End date of membership:"),
 151                 'propname' => 'end_date'
 152             ),
 153             Transaction::PK       => array(
 154                 'label'    => null, //not a field in the form
 155                 'propname' => 'transaction'
 156             ),
 157             //this one is not really a field, but is required in some cases...
 158             //adding it here make simplier to check required fields
 159             'duree_mois_cotis'    => array(
 160                 'label'    => _T("Membership extension:"),
 161                 'propname' => 'extension'
 162             )
 163         );
 164         if (is_int($args)) {
 165             $this->load($args);
 166         } elseif (is_array($args)) {
 167             $this->_date = date("Y-m-d");
 168             if (isset($args['adh']) && $args['adh'] != '') {
 169                 $this->_member = (int)$args['adh'];
 170             }
 171             if (isset($args['trans'])) {
 172                 $this->_transaction = new Transaction($this->zdb, $this->login, (int)$args['trans']);
 173                 if (!isset($this->_member)) {
 174                     $this->_member = (int)$this->_transaction->member;
 175                 }
 176                 $this->_amount = $this->_transaction->getMissingAmount();
 177             }
 178             $this->type = (int)$args['type'];
 179             //calculate begin date for cotisation
 180             $this->_begin_date = $this->_date;
 181             if ($this->_is_cotis) {
 182                 $curend = self::getDueDate($this->zdb, $this->_member);
 183                 if ($curend != '') {
 184                     $dend = new \DateTime($curend);
 185                     $now = date('Y-m-d');
 186                     $dnow = new \DateTime($now);
 187                     if ($dend < $dnow) {
 188                         // Member didn't renew on time
 189                         $this->_begin_date = $now;
 190                     } else {
 191                         $this->_begin_date = $curend;
 192                     }
 193                 }
 194                 $this->retrieveEndDate();
 195             }
 196             if (isset($args['payment_type'])) {
 197                 $this->_payment_type = $args['payment_type'];
 198             }
 199         } elseif (is_object($args)) {
 200             $this->loadFromRS($args);
 201         }
 202
 203         $this->loadDynamicFields();
 204     }
 205
 206     /**
 207      * Sets end contribution date
 208      *
 209      * @return void
 210      */
 211     private function retrieveEndDate()
 212     {
 213         global $preferences;
 214
 215         $bdate = new \DateTime($this->_begin_date);
 216         if ($preferences->pref_beg_membership != '') {
 217             //case beginning of membership
 218             list($j, $m) = explode('/', $preferences->pref_beg_membership);
 219             $edate = new \DateTime($bdate->format('Y') . '-' . $m . '-' . $j);
 220             while ($edate <= $bdate) {
 221                 $edate->modify('+1 year');
 222             }
 223
 224             if ($preferences->pref_membership_offermonths > 0) {
 225                 //count days until end of membership date
 226                 $diff1 = (int)$bdate->diff($edate)->format('%a');
 227
 228                 //count days beetween end of membership date and offered months
 229                 $tdate = clone $edate;
 230                 $tdate->modify('-' . $preferences->pref_membership_offermonths . ' month');
 231                 $diff2 = (int)$edate->diff($tdate)->format('%a');
 232
 233                 //when number of days until end of membership is less than for offered months, it's free :)
 234                 if ($diff1 <= $diff2) {
 235                     $edate->modify('+1 year');
 236                 }
 237             }
 238
 239             $this->_end_date = $edate->format('Y-m-d');
 240         } elseif ($preferences->pref_membership_ext != '') {
 241             //case membership extension
 242             if ($this->_extension == null) {
 243                 $this->_extension = $preferences->pref_membership_ext;
 244             }
 245             $dext = new \DateInterval('P' . $this->_extension . 'M');
 246             $edate = $bdate->add($dext);
 247             $this->_end_date = $edate->format('Y-m-d');
 248         } else {
 249             throw new \RuntimeException(
 250                 'Unable to define end date; none of pref_beg_membership nor pref_membership_ext are defined!'
 251             );
 252         }
 253     }
 254
 255     /**
 256      * Loads a contribution from its id
 257      *
 258      * @param int $id the identifiant for the contribution to load
 259      *
 260      * @return bool true if query succeed, false otherwise
 261      */
 262     public function load($id)
 263     {
 264         try {
 265             $select = $this->zdb->select(self::TABLE);
 266             $select->where(self::PK . ' = ' . $id);
 267             //restrict query on current member id if he's not admin nor staff member
 268             if (!$this->login->isAdmin() && !$this->login->isStaff()) {
 269                 $select->where(Adherent::PK . ' = ' . $this->login->id);
 270             }
 271
 272             $results = $this->zdb->execute($select);
 273             if ($results->count() > 0) {
 274                 $row = $results->current();
 275                 $this->loadFromRS($row);
 276                 return true;
 277             } else {
 278                 throw new \Exception(
 279                     'No contribution #' . $id . ' (user ' . $this->login->id . ')'
 280                 );
 281             }
 282         } catch (Throwable $e) {
 283             Analog::log(
 284                 'An error occurred attempting to load contribution #' . $id .
 285                 $e->getMessage(),
 286                 Analog::ERROR
 287             );
 288             return false;
 289         }
 290     }
 291
 292     /**
 293      * Populate object from a resultset row
 294      *
 295      * @param ResultSet $r the resultset row
 296      *
 297      * @return void
 298      */
 299     private function loadFromRS($r)
 300     {
 301         $pk = self::PK;
 302         $this->_id = (int)$r->$pk;
 303         $this->_date = $r->date_enreg;
 304         $this->_amount = $r->montant_cotis;
 305         //save original amount, we need it for transactions parts calulations
 306         $this->_orig_amount = $r->montant_cotis;
 307         $this->_payment_type = $r->type_paiement_cotis;
 308         $this->_info = $r->info_cotis;
 309         $this->_begin_date = $r->date_debut_cotis;
 310         $enddate = $r->date_fin_cotis;
 311         //do not work with knows bad dates...
 312         //the one with BC comes from 0.63/pgsl demo... Why the hell a so
 313         //strange date? dont know :(
 314         if (
 315             $enddate !== '0000-00-00'
 316             && $enddate !== '1901-01-01'
 317             && $enddate !== '0001-01-01 BC'
 318         ) {
 319             $this->_end_date = $r->date_fin_cotis;
 320         }
 321         $adhpk = Adherent::PK;
 322         $this->_member = (int)$r->$adhpk;
 323
 324         $transpk = Transaction::PK;
 325         if ($r->$transpk != '') {
 326             $this->_transaction = new Transaction($this->zdb, $this->login, (int)$r->$transpk);
 327         }
 328
 329         $this->type = (int)$r->id_type_cotis;
 330         $this->loadDynamicFields();
 331     }
 332
 333     /**
 334      * Check posted values validity
 335      *
 336      * @param array $values   All values to check, basically the $_POST array
 337      *                        after sending the form
 338      * @param array $required Array of required fields
 339      * @param array $disabled Array of disabled fields
 340      *
 341      * @return true|array
 342      */
 343     public function check($values, $required, $disabled)
 344     {
 345         global $preferences;
 346         $this->errors = array();
 347
 348         $fields = array_keys($this->_fields);
 349         foreach ($fields as $key) {
 350             //first of all, let's sanitize values
 351             $key = strtolower($key);
 352             $prop = '_' . $this->_fields[$key]['propname'];
 353
 354             if (isset($values[$key])) {
 355                 $value = trim($values[$key]);
 356             } else {
 357                 $value = '';
 358             }
 359
 360             // if the field is enabled, check it
 361             if (!isset($disabled[$key])) {
 362                 // fill up the adherent structure
 363                 //$this->$prop = stripslashes($value); //not relevant here!
 364
 365                 // now, check validity
 366                 switch ($key) {
 367                     // dates
 368                     case 'date_enreg':
 369                     case 'date_debut_cotis':
 370                     case 'date_fin_cotis':
 371                         if ($value != '') {
 372                             try {
 373                                 $d = \DateTime::createFromFormat(__("Y-m-d"), $value);
 374                                 if ($d === false) {
 375                                     throw new \Exception('Incorrect format');
 376                                 }
 377                                 $this->$prop = $d->format('Y-m-d');
 378                             } catch (Throwable $e) {
 379                                 Analog::log(
 380                                     'Wrong date format. field: ' . $key .
 381                                     ', value: ' . $value . ', expected fmt: ' .
 382                                     __("Y-m-d") . ' | ' . $e->getMessage(),
 383                                     Analog::INFO
 384                                 );
 385                                 $this->errors[] = str_replace(
 386                                     array(
 387                                         '%date_format',
 388                                         '%field'
 389                                     ),
 390                                     array(
 391                                         __("Y-m-d"),
 392                                         $this->_fields[$key]['label']
 393                                     ),
 394                                     _T("- Wrong date format (%date_format) for %field!")
 395                                 );
 396                             }
 397                         }
 398                         break;
 399                     case Adherent::PK:
 400                         if ($value != '') {
 401                             $this->_member = (int)$value;
 402                         }
 403                         break;
 404                     case ContributionsTypes::PK:
 405                         if ($value != '') {
 406                             $this->type = (int)$value;
 407                         }
 408                         break;
 409                     case 'montant_cotis':
 410                         $this->_amount = $value;
 411                         $value = strtr($value, ',', '.');
 412                         if (!is_numeric($value) && $value !== '') {
 413                             $this->errors[] = _T("- The amount must be an integer!");
 414                         }
 415                         break;
 416                     case 'type_paiement_cotis':
 417                         $ptypes = new PaymentTypes(
 418                             $this->zdb,
 419                             $preferences,
 420                             $this->login
 421                         );
 422                         $ptlist = $ptypes->getList();
 423                         if (isset($ptlist[$value])) {
 424                             $this->_payment_type = $value;
 425                         } else {
 426                             $this->errors[] = _T("- Unknown payment type");
 427                         }
 428                         break;
 429                     case 'info_cotis':
 430                         $this->_info = $value;
 431                         break;
 432                     case Transaction::PK:
 433                         if ($value != '') {
 434                             $this->_transaction = new Transaction($this->zdb, $this->login, (int)$value);
 435                         }
 436                         break;
 437                     case 'duree_mois_cotis':
 438                         if ($value != '') {
 439                             if (!is_numeric($value) || $value <= 0) {
 440                                 $this->errors[] = _T("- The duration must be a positive integer!");
 441                             }
 442                             $this->$prop = $value;
 443                             $this->retrieveEndDate();
 444                         }
 445                         break;
 446                 }
 447             }
 448         }
 449
 450         // missing required fields?
 451         foreach ($required as $key => $val) {
 452             if ($val === 1) {
 453                 $prop = '_' . $this->_fields[$key]['propname'];
 454                 if (
 455                     !isset($disabled[$key])
 456                     && (!isset($this->$prop)
 457                     || (!is_object($this->$prop) && trim($this->$prop) == '')
 458                     || (is_object($this->$prop) && trim($this->$prop->id) == ''))
 459                 ) {
 460                     $this->errors[] = str_replace(
 461                         '%field',
 462                         '<a href="#' . $key . '">' . $this->getFieldLabel($key) . '</a>',
 463                         _T("- Mandatory field %field empty.")
 464                     );
 465                 }
 466             }
 467         }
 468
 469         if ($this->_transaction != null && $this->_amount != null) {
 470             $missing = $this->_transaction->getMissingAmount();
 471             //calculate new missing amount
 472             $missing = $missing + $this->_orig_amount - $this->_amount;
 473             if ($missing < 0) {
 474                 $this->errors[] = _T("- Sum of all contributions exceed corresponding transaction amount.");
 475             }
 476         }
 477
 478         if ($this->isCotis() && count($this->errors) == 0) {
 479             $overlap = $this->checkOverlap();
 480             if ($overlap !== true) {
 481                 if ($overlap === false) {
 482                     $this->errors[] = _T("An error occurred checking overlaping fees :(");
 483                 } else {
 484                     //method directly return error message
 485                     $this->errors[] = $overlap;
 486                 }
 487             }
 488         }
 489
 490         $this->dynamicsCheck($values, $required, $disabled);
 491
 492         if (count($this->errors) > 0) {
 493             Analog::log(
 494                 'Some errors has been throwed attempting to edit/store a contribution' .
 495                 print_r($this->errors, true),
 496                 Analog::ERROR
 497             );
 498             return $this->errors;
 499         } else {
 500             Analog::log(
 501                 'Contribution checked successfully.',
 502                 Analog::DEBUG
 503             );
 504             return true;
 505         }
 506     }
 507
 508     /**
 509      * Check that membership fees does not overlap
 510      *
 511      * @return boolean|string True if all is ok, false if error,
 512      * error message if overlap
 513      */
 514     public function checkOverlap()
 515     {
 516         try {
 517             $select = $this->zdb->select(self::TABLE, 'c');
 518             $select->columns(
 519                 array('date_debut_cotis', 'date_fin_cotis')
 520             )->join(
 521                 array('ct' => PREFIX_DB . ContributionsTypes::TABLE),
 522                 'c.' . ContributionsTypes::PK . '=ct.' . ContributionsTypes::PK,
 523                 array()
 524             )->where(Adherent::PK . ' = ' . $this->_member)
 525                 ->where(array('cotis_extension' => new Expression('true')))
 526                 ->where->nest->nest
 527                 ->greaterThanOrEqualTo('date_debut_cotis', $this->_begin_date)
 528                 ->lessThan('date_debut_cotis', $this->_end_date)
 529                 ->unnest
 530                 ->or->nest
 531                 ->greaterThan('date_fin_cotis', $this->_begin_date)
 532                 ->lessThanOrEqualTo('date_fin_cotis', $this->_end_date);
 533
 534             if ($this->id != '') {
 535                 $select->where(self::PK . ' != ' . $this->id);
 536             }
 537
 538             $results = $this->zdb->execute($select);
 539             if ($results->count() > 0) {
 540                 $result = $results->current();
 541                 $d = new \DateTime($result->date_debut_cotis);
 542
 543                 return _T("- Membership period overlaps period starting at ") .
 544                     $d->format(__("Y-m-d"));
 545             }
 546             return true;
 547         } catch (Throwable $e) {
 548             Analog::log(
 549                 'An error occurred checking overlaping fee. ' . $e->getMessage(),
 550                 Analog::ERROR
 551             );
 552             return false;
 553         }
 554     }
 555
 556     /**
 557      * Store the contribution
 558      *
 559      * @return boolean
 560      */
 561     public function store()
 562     {
 563         global $hist, $emitter;
 564
 565         $event = null;
 566
 567         if (count($this->errors) > 0) {
 568             throw new \RuntimeException(
 569                 'Existing errors prevents storing contribution: ' .
 570                 print_r($this->errors, true)
 571             );
 572         }
 573
 574         try {
 575             $this->zdb->connection->beginTransaction();
 576             $values = array();
 577             $fields = self::getDbFields($this->zdb);
 578             foreach ($fields as $field) {
 579                 $prop = '_' . $this->_fields[$field]['propname'];
 580                 switch ($field) {
 581                     case ContributionsTypes::PK:
 582                     case Transaction::PK:
 583                         if (isset($this->$prop)) {
 584                             $values[$field] = $this->$prop->id;
 585                         }
 586                         break;
 587                     default:
 588                         $values[$field] = $this->$prop;
 589                         break;
 590                 }
 591             }
 592
 593             //no end date, let's take database defaults
 594             if (!$this->isCotis() && !$this->_end_date) {
 595                 unset($values['date_fin_cotis']);
 596             }
 597
 598             $success = false;
 599             if (!isset($this->_id) || $this->_id == '') {
 600                 //we're inserting a new contribution
 601                 unset($values[self::PK]);
 602
 603                 $insert = $this->zdb->insert(self::TABLE);
 604                 $insert->values($values);
 605                 $add = $this->zdb->execute($insert);
 606
 607                 if ($add->count() > 0) {
 608                     $this->_id = $this->zdb->getLastGeneratedValue($this);
 609
 610                     // logging
 611                     $hist->add(
 612                         _T("Contribution added"),
 613                         Adherent::getSName($this->zdb, $this->_member)
 614                     );
 615                     $success = true;
 616                     $event = 'contribution.add';
 617                 } else {
 618                     $hist->add(_T("Fail to add new contribution."));
 619                     throw new \Exception(
 620                         'An error occurred inserting new contribution!'
 621                     );
 622                 }
 623             } else {
 624                 //we're editing an existing contribution
 625                 $update = $this->zdb->update(self::TABLE);
 626                 $update->set($values)->where(
 627                     self::PK . '=' . $this->_id
 628                 );
 629                 $edit = $this->zdb->execute($update);
 630
 631                 //edit == 0 does not mean there were an error, but that there
 632                 //were nothing to change
 633                 if ($edit->count() > 0) {
 634                     $hist->add(
 635                         _T("Contribution updated"),
 636                         Adherent::getSName($this->zdb, $this->_member)
 637                     );
 638                 }
 639
 640                 if ($edit === false) {
 641                     throw new \Exception(
 642                         'An error occurred updating contribution # ' . $this->_id . '!'
 643                     );
 644                 }
 645                 $success = true;
 646                 $event = 'contribution.edit';
 647             }
 648             //update deadline
 649             if ($this->isCotis()) {
 650                 $deadline = $this->updateDeadline();
 651                 if ($deadline !== true) {
 652                     //if something went wrong, we rollback transaction
 653                     throw new \Exception('An error occurred updating member\'s deadline');
 654                 }
 655             }
 656
 657             //dynamic fields
 658             if ($success) {
 659                 $success = $this->dynamicsStore(true);
 660             }
 661
 662             $this->zdb->connection->commit();
 663             $this->_orig_amount = $this->_amount;
 664
 665             //send event at the end of process, once all has been stored
 666             if ($event !== null) {
 667                 $emitter->emit($event, $this);
 668             }
 669
 670             return true;
 671         } catch (Throwable $e) {
 672
 673             if ($this->zdb->connection->inTransaction()) {
 674                 $this->zdb->connection->rollBack();
 675             }
 676             return false;
 677         }
 678     }
 679
 680     /**
 681      * Update member dead line
 682      *
 683      * @return boolean
 684      */
 685     private function updateDeadline()
 686     {
 687         try {
 688             $due_date = self::getDueDate($this->zdb, $this->_member);
 689
 690             if ($due_date != '') {
 691                 $date_fin_update = $due_date;
 692             } else {
 693                 $date_fin_update = new Expression('NULL');
 694             }
 695
 696             $update = $this->zdb->update(Adherent::TABLE);
 697             $update->set(
 698                 array('date_echeance' => $date_fin_update)
 699             )->where(
 700                 Adherent::PK . '=' . $this->_member
 701             );
 702             $this->zdb->execute($update);
 703             return true;
 704         } catch (Throwable $e) {
 705             Analog::log(
 706                 'An error occurred updating member ' . $this->_member .
 707                 '\'s deadline |' .
 708                 $e->getMessage(),
 709                 Analog::ERROR
 710             );
 711             return false;
 712         }
 713     }
 714
 715     /**
 716      * Remove contribution from database
 717      *
 718      * @param boolean $transaction Activate transaction mode (defaults to true)
 719      *
 720      * @return boolean
 721      */
 722     public function remove($transaction = true)
 723     {
 724         global $emitter;
 725
 726         try {
 727             if ($transaction) {
 728                 $this->zdb->connection->beginTransaction();
 729             }
 730
 731             $delete = $this->zdb->delete(self::TABLE);
 732             $delete->where(self::PK . ' = ' . $this->_id);
 733             $del = $this->zdb->execute($delete);
 734             if ($del->count() > 0) {
 735                 $this->updateDeadline();
 736                 $this->dynamicsRemove(true);
 737             } else {
 738                 throw new \RuntimeException(
 739                     'Contribution has not been removed!'
 740                 );
 741             }
 742             if ($transaction) {
 743                 $this->zdb->connection->commit();
 744             }
 745             $emitter->emit('contribution.remove', $this);
 746             return true;
 747         } catch (Throwable $e) {
 748             if ($transaction) {
 749                 $this->zdb->connection->rollBack();
 750             }
 751             Analog::log(
 752                 'An error occurred trying to remove contribution #' .
 753                 $this->_id . ' | ' . $e->getMessage(),
 754                 Analog::ERROR
 755             );
 756             return false;
 757         }
 758     }
 759
 760     /**
 761      * Get field label
 762      *
 763      * @param string $field Field name
 764      *
 765      * @return string
 766      */
 767     public function getFieldLabel($field)
 768     {
 769         $label = $this->_fields[$field]['label'];
 770         if ($this->isCotis() && $field == 'date_debut_cotis') {
 771             $label = $this->_fields[$field]['cotlabel'];
 772         }
 773         //replace "&nbsp;"
 774         $label = str_replace('&nbsp;', ' ', $label);
 775         //remove trailing ':' and then trim
 776         $label = trim(trim($label, ':'));
 777         return $label;
 778     }
 779
 780     /**
 781      * Retrieve fields from database
 782      *
 783      * @param Db $zdb Database instance
 784      *
 785      * @return array
 786      */
 787     public static function getDbFields(Db $zdb)
 788     {
 789         $columns = $zdb->getColumns(self::TABLE);
 790         $fields = array();
 791         foreach ($columns as $col) {
 792             $fields[] = $col->getName();
 793         }
 794         return $fields;
 795     }
 796
 797     /**
 798      * Get the relevant CSS class for current contribution
 799      *
 800      * @return string current contribution row class
 801      */
 802     public function getRowClass()
 803     {
 804         return ($this->_end_date != $this->_begin_date && $this->_is_cotis) ?
 805             'cotis-normal' : 'cotis-give';
 806     }
 807
 808     /**
 809      * Retrieve member due date
 810      *
 811      * @param Db      $zdb       Database instance
 812      * @param integer $member_id Member identifier
 813      *
 814      * @return date
 815      */
 816     public static function getDueDate(Db $zdb, $member_id)
 817     {
 818         if (!$member_id) {
 819             return '';
 820         }
 821         try {
 822             $select = $zdb->select(self::TABLE, 'c');
 823             $select->columns(
 824                 array(
 825                     'max_date' => new Expression('MAX(date_fin_cotis)')
 826                 )
 827             )->join(
 828                 array('ct' => PREFIX_DB . ContributionsTypes::TABLE),
 829                 'c.' . ContributionsTypes::PK . '=ct.' . ContributionsTypes::PK,
 830                 array()
 831             )->where(
 832                 Adherent::PK . ' = ' . $member_id
 833             )->where(
 834                 array('cotis_extension' => new Expression('true'))
 835             );
 836
 837             $results = $zdb->execute($select);
 838             $result = $results->current();
 839             $due_date = $result->max_date;
 840
 841             //avoid bad dates in postgres and bad mysql return from zenddb
 842             if ($due_date == '0001-01-01 BC' || $due_date == '1901-01-01') {
 843                 $due_date = '';
 844             }
 845             return $due_date;
 846         } catch (Throwable $e) {
 847             Analog::log(
 848                 'An error occurred trying to retrieve member\'s due date',
 849                 Analog::ERROR
 850             );
 851             return false;
 852         }
 853     }
 854
 855     /**
 856      * Detach a contribution from a transaction
 857      *
 858      * @param Db    $zdb        Database instance
 859      * @param Login $login      Login instance
 860      * @param int   $trans_id   Transaction identifier
 861      * @param int   $contrib_id Contribution identifier
 862      *
 863      * @return boolean
 864      */
 865     public static function unsetTransactionPart(Db $zdb, Login $login, $trans_id, $contrib_id)
 866     {
 867         try {
 868             //first, we check if contribution is part of transaction
 869             $c = new Contribution($zdb, $login, (int)$contrib_id);
 870             if ($c->isTransactionPartOf($trans_id)) {
 871                 $update = $zdb->update(self::TABLE);
 872                 $update->set(
 873                     array(Transaction::PK => null)
 874                 )->where(
 875                     self::PK . ' = ' . $contrib_id
 876                 );
 877                 $zdb->execute($update);
 878                 return true;
 879             } else {
 880                 Analog::log(
 881                     'Contribution #' . $contrib_id .
 882                     ' is not actually part of transaction #' . $trans_id,
 883                     Analog::WARNING
 884                 );
 885                 return false;
 886             }
 887         } catch (Throwable $e) {
 888             Analog::log(
 889                 'Unable to detach contribution #' . $contrib_id .
 890                 ' to transaction #' . $trans_id . ' | ' . $e->getMessage(),
 891                 Analog::ERROR
 892             );
 893             return false;
 894         }
 895     }
 896
 897     /**
 898      * Set a contribution as a transaction part
 899      *
 900      * @param Db  $zdb        Database instance
 901      * @param int $trans_id   Transaction identifier
 902      * @param int $contrib_id Contribution identifier
 903      *
 904      * @return boolean
 905      */
 906     public static function setTransactionPart(Db $zdb, $trans_id, $contrib_id)
 907     {
 908         try {
 909             $update = $zdb->update(self::TABLE);
 910             $update->set(
 911                 array(Transaction::PK => $trans_id)
 912             )->where(self::PK . ' = ' . $contrib_id);
 913
 914             $zdb->execute($update);
 915             return true;
 916         } catch (Throwable $e) {
 917             Analog::log(
 918                 'Unable to attach contribution #' . $contrib_id .
 919                 ' to transaction #' . $trans_id . ' | ' . $e->getMessage(),
 920                 Analog::ERROR
 921             );
 922             return false;
 923         }
 924     }
 925
 926     /**
 927      * Is current contribution a cotisation
 928      *
 929      * @return boolean
 930      */
 931     public function isCotis()
 932     {
 933         return $this->_is_cotis;
 934     }
 935
 936     /**
 937      * Is current contribution part of specified transaction
 938      *
 939      * @param int $id Transaction identifier
 940      *
 941      * @return boolean
 942      */
 943     public function isTransactionPartOf($id)
 944     {
 945         if ($this->isTransactionPart()) {
 946             return $id == $this->_transaction->id;
 947         } else {
 948             return false;
 949         }
 950     }
 951
 952     /**
 953      * Is current contribution part of transaction
 954      *
 955      * @return boolean
 956      */
 957     public function isTransactionPart()
 958     {
 959         return $this->_transaction != null;
 960     }
 961
 962     /**
 963      * Execute post contribution script
 964      *
 965      * @param ExternalScript $es     External script to execute
 966      * @param array          $extra  Extra information on contribution
 967      *                               Defaults to null
 968      * @param array          $pextra Extra information on payment
 969      *                               Defaults to null
 970      *
 971      * @return mixed Script return value on success, values and script output on fail
 972      */
 973     public function executePostScript(
 974         ExternalScript $es,
 975         $extra = null,
 976         $pextra = null
 977     ) {
 978         global $preferences;
 979
 980         $payment = array(
 981             'type'  => $this->getPaymentType()
 982         );
 983
 984         if ($pextra !== null && is_array($pextra)) {
 985             $payment = array_merge($payment, $pextra);
 986         }
 987
 988         if (!file_exists(GALETTE_CACHE_DIR . '/pdf_contribs')) {
 989             @mkdir(GALETTE_CACHE_DIR . '/pdf_contribs');
 990         }
 991
 992         $voucher_path = null;
 993         if ($this->_id !== null) {
 994             $voucher = new PdfContribution($this, $this->zdb, $preferences);
 995             $voucher->store(GALETTE_CACHE_DIR . '/pdf_contribs');
 996             $voucher_path = $voucher->getPath();
 997         }
 998
 999         $contrib = array(
1000             'id'        => (int)$this->_id,
1001             'date'      => $this->_date,
1002             'type'      => $this->getRawType(),
1003             'amount'    => $this->amount,
1004             'voucher'   => $voucher_path,
1005             'category'  => array(
1006                 'id'    => $this->type->id,
1007                 'label' => $this->type->libelle
1008             ),
1009             'payment'   => $payment
1010         );
1011
1012         if ($this->_member !== null) {
1013             $m = new Adherent($this->zdb, (int)$this->_member);
1014             $member = array(
1015                 'id'            => (int)$this->_member,
1016                 'name'          => $m->sfullname,
1017                 'email'         => $m->email,
1018                 'organization'  => ($m->isCompany() ? 1 : 0),
1019                 'status'        => array(
1020                     'id'    => $m->status,
1021                     'label' => $m->sstatus
1022                 ),
1023                 'country'       => $m->country
1024             );
1025
1026             if ($m->isCompany()) {
1027                 $member['organization_name'] = $m->company_name;
1028             }
1029
1030             $contrib['member'] = $member;
1031         }
1032
1033         if ($extra !== null && is_array($extra)) {
1034             $contrib = array_merge($contrib, $extra);
1035         }
1036
1037         $res = $es->send($contrib);
1038
1039         if ($res !== true) {
1040             Analog::log(
1041                 'An error occurred calling post contribution ' .
1042                 "script:\n" . $es->getOutput(),
1043                 Analog::ERROR
1044             );
1045             $res = _T("Contribution information") . "\n";
1046             $res .= print_r($contrib, true);
1047             $res .= "\n\n" . _T("Script output") . "\n";
1048             $res .= $es->getOutput();
1049         }
1050
1051         return $res;
1052     }
1053     /**
1054      * Get raw contribution type
1055      *
1056      * @return string
1057      */
1058     public function getRawType()
1059     {
1060         if ($this->isCotis()) {
1061             return 'membership';
1062         } else {
1063             return 'donation';
1064         }
1065     }
1066
1067     /**
1068      * Get contribution type label
1069      *
1070      * @return string
1071      */
1072     public function getTypeLabel()
1073     {
1074         if ($this->isCotis()) {
1075             return _T("Membership");
1076         } else {
1077             return _T("Donation");
1078         }
1079     }
1080
1081     /**
1082      * Get payment type label
1083      *
1084      * @return string
1085      */
1086     public function getPaymentType()
1087     {
1088         if ($this->_payment_type === null) {
1089             return '-';
1090         }
1091
1092         $ptype = new PaymentType($this->zdb, (int)$this->payment_type);
1093         return $ptype->getName(false);
1094     }
1095
1096     /**
1097      * Global getter method
1098      *
1099      * @param string $name name of the property we want to retrive
1100      *
1101      * @return false|object the called property
1102      */
1103     public function __get($name)
1104     {
1105
1106         $forbidden = array('is_cotis');
1107         $virtuals = array('duration', 'spayment_type', 'model', 'raw_date',
1108             'raw_begin_date', 'raw_end_date'
1109         );
1110
1111         $rname = '_' . $name;
1112
1113         if (in_array($name, $forbidden)) {
1114             Analog::log(
1115                 "Call to __get for '$name' is forbidden!",
1116                 Analog::WARNING
1117             );
1118
1119             switch ($name) {
1120                 case 'is_cotis':
1121                     return $this->isCotis();
1122                     break;
1123                 default:
1124                     throw new \RuntimeException("Call to __get for '$name' is forbidden!");
1125             }
1126         } elseif (
1127             property_exists($this, $rname)
1128             || in_array($name, $virtuals)
1129         ) {
1130             switch ($name) {
1131                 case 'raw_date':
1132                 case 'raw_begin_date':
1133                 case 'raw_end_date':
1134                     $rname = '_' . substr($name, 4);
1135                     if ($this->$rname != '') {
1136                         try {
1137                             $d = new \DateTime($this->$rname);
1138                             return $d;
1139                         } catch (Throwable $e) {
1140                             //oops, we've got a bad date :/
1141                             Analog::log(
1142                                 'Bad date (' . $this->$rname . ') | ' .
1143                                 $e->getMessage(),
1144                                 Analog::INFO
1145                             );
1146                             throw $e;
1147                         }
1148                     }
1149                     break;
1150                 case 'date':
1151                 case 'begin_date':
1152                 case 'end_date':
1153                     if ($this->$rname != '') {
1154                         try {
1155                             $d = new \DateTime($this->$rname);
1156                             return $d->format(__("Y-m-d"));
1157                         } catch (Throwable $e) {
1158                             //oops, we've got a bad date :/
1159                             Analog::log(
1160                                 'Bad date (' . $this->$rname . ') | ' .
1161                                 $e->getMessage(),
1162                                 Analog::INFO
1163                             );
1164                             return $this->$rname;
1165                         }
1166                     }
1167                     break;
1168                 case 'duration':
1169                     if ($this->_is_cotis) {
1170                         $date_end = new \DateTime($this->_end_date);
1171                         $date_start = new \DateTime($this->_begin_date);
1172                         $diff = $date_end->diff($date_start);
1173                         return $diff->format('%y') * 12 + $diff->format('%m');
1174                     } else {
1175                         return '';
1176                     }
1177                     break;
1178                 case 'spayment_type':
1179                     if ($this->_payment_type === null) {
1180                         return '-';
1181                     }
1182
1183                     $ptype = new PaymentType($this->zdb, (int)$this->payment_type);
1184                     return $ptype->getName();
1185
1186                     break;
1187                 case 'model':
1188                     if ($this->_is_cotis === null) {
1189                         return null;
1190                     }
1191                     return ($this->isCotis()) ?
1192                         PdfModel::INVOICE_MODEL : PdfModel::RECEIPT_MODEL;
1193                     break;
1194                 default:
1195                     return $this->$rname;
1196                     break;
1197             }
1198         } else {
1199             Analog::log(
1200                 "Unknown property '$rname'",
1201                 Analog::WARNING
1202             );
1203             return null;
1204         }
1205     }
1206
1207     /**
1208      * Global setter method
1209      *
1210      * @param string $name  name of the property we want to assign a value to
1211      * @param object $value a relevant value for the property
1212      *
1213      * @return void
1214      */
1215     public function __set($name, $value)
1216     {
1217         global $preferences;
1218
1219         $forbidden = array('fields', 'is_cotis', 'end_date');
1220
1221         if (!in_array($name, $forbidden)) {
1222             $rname = '_' . $name;
1223             switch ($name) {
1224                 case 'transaction':
1225                     if (is_int($value)) {
1226                         $this->$rname = new Transaction($this->zdb, $this->login, $value);
1227                     } else {
1228                         Analog::log(
1229                             'Trying to set a transaction from an id that is not an integer.',
1230                             Analog::WARNING
1231                         );
1232                     }
1233                     break;
1234                 case 'type':
1235                     if (is_int($value)) {
1236                         //set type
1237                         $this->$rname = new ContributionsTypes($this->zdb, $value);
1238                         //set is_cotis according to type
1239                         if ($this->$rname->extension == 1) {
1240                             $this->_is_cotis = true;
1241                         } else {
1242                             $this->_is_cotis = false;
1243                         }
1244                     } else {
1245                         Analog::log(
1246                             'Trying to set a type from an id that is not an integer.',
1247                             Analog::WARNING
1248                         );
1249                     }
1250                     break;
1251                 case 'begin_date':
1252                     try {
1253                         $d = \DateTime::createFromFormat(__("Y-m-d"), $value);
1254                         if ($d === false) {
1255                             throw new \Exception('Incorrect format');
1256                         }
1257                         $this->_begin_date = $d->format('Y-m-d');
1258                     } catch (Throwable $e) {
1259                         Analog::log(
1260                             'Wrong date format. field: ' . $name .
1261                             ', value: ' . $value . ', expected fmt: ' .
1262                             __("Y-m-d") . ' | ' . $e->getMessage(),
1263                             Analog::INFO
1264                         );
1265                         $this->errors[] = str_replace(
1266                             array(
1267                                 '%date_format',
1268                                 '%field'
1269                             ),
1270                             array(
1271                                 __("Y-m-d"),
1272                                 $this->_fields['date_debut_cotis']['label']
1273                             ),
1274                             _T("- Wrong date format (%date_format) for %field!")
1275                         );
1276                     }
1277                     break;
1278                 case 'amount':
1279                     if (is_numeric($value) && $value > 0) {
1280                         $this->$rname = $value;
1281                     } else {
1282                         Analog::log(
1283                             'Trying to set an amount with a non numeric value, ' .
1284                             'or with a zero value',
1285                             Analog::WARNING
1286                         );
1287                     }
1288                     break;
1289                 case 'member':
1290                     if (is_int($value)) {
1291                         //set type
1292                         $this->$rname = $value;
1293                     }
1294                     break;
1295                 case 'payment_type':
1296                     $ptypes = new PaymentTypes(
1297                         $this->zdb,
1298                         $preferences,
1299                         $this->login
1300                     );
1301                     $list = $ptypes->getList();
1302                     if (isset($list[$value])) {
1303                         $this->_payment_type = $value;
1304                     } else {
1305                         Analog::log(
1306                             'Unknown payment type ' . $value,
1307                             Analog::WARNING
1308                         );
1309                     }
1310                     break;
1311                 default:
1312                     Analog::log(
1313                         '[' . __CLASS__ . ']: Trying to set an unknown property (' .
1314                         $name . ')',
1315                         Analog::WARNING
1316                     );
1317                     break;
1318             }
1319         }
1320     }
1321
1322     /**
1323      * Flag creation mail sending
1324      *
1325      * @param boolean $send True (default) to send creation email
1326      *
1327      * @return Contribution
1328      */
1329     public function setSendmail($send = true)
1330     {
1331         $this->sendmail = $send;
1332         return $this;
1333     }
1334
1335     /**
1336      * Should we send administrative emails to member?
1337      *
1338      * @return boolean
1339      */
1340     public function sendEMail()
1341     {
1342         return $this->sendmail;
1343     }
1344
1345     /**
1346      * Handle files (dynamics files)
1347      *
1348      * @param array $files Files sent
1349      *
1350      * @return array|true
1351      */
1352     public function handleFiles($files)
1353     {
1354         $this->errors = [];
1355
1356         $this->dynamicsFiles($files);
1357
1358         if (count($this->errors) > 0) {
1359             Analog::log(
1360                 'Some errors has been throwed attempting to edit/store a contribution files' . "\n" .
1361                 print_r($this->errors, true),
1362                 Analog::ERROR
1363             );
1364             return $this->errors;
1365         } else {
1366             return true;
1367         }
1368     }
1369 }