You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

350 lines
9.8KB

  1. <?php
  2. /**
  3. Copyright La boîte à pain (2018)
  4. contact@laboiteapain.net
  5. Ce logiciel est un programme informatique servant à aider les producteurs
  6. à distribuer leur production en circuits courts.
  7. Ce logiciel est régi par la licence CeCILL soumise au droit français et
  8. respectant les principes de diffusion des logiciels libres. Vous pouvez
  9. utiliser, modifier et/ou redistribuer ce programme sous les conditions
  10. de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
  11. sur le site "http://www.cecill.info".
  12. En contrepartie de l'accessibilité au code source et des droits de copie,
  13. de modification et de redistribution accordés par cette licence, il n'est
  14. offert aux utilisateurs qu'une garantie limitée. Pour les mêmes raisons,
  15. seule une responsabilité restreinte pèse sur l'auteur du programme, le
  16. titulaire des droits patrimoniaux et les concédants successifs.
  17. A cet égard l'attention de l'utilisateur est attirée sur les risques
  18. associés au chargement, à l'utilisation, à la modification et/ou au
  19. développement et à la reproduction du logiciel par l'utilisateur étant
  20. donné sa spécificité de logiciel libre, qui peut le rendre complexe à
  21. manipuler et qui le réserve donc à des développeurs et des professionnels
  22. avertis possédant des connaissances informatiques approfondies. Les
  23. utilisateurs sont donc invités à charger et tester l'adéquation du
  24. logiciel à leurs besoins dans des conditions permettant d'assurer la
  25. sécurité de leurs systèmes et ou de leurs données et, plus généralement,
  26. à l'utiliser et l'exploiter dans les mêmes conditions de sécurité.
  27. Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
  28. pris connaissance de la licence CeCILL, et que vous en avez accepté les
  29. termes.
  30. */
  31. namespace common\models;
  32. use Yii;
  33. use yii\db\ActiveRecord;
  34. use common\models\User;
  35. use common\models\Order;
  36. use yii\helpers\Html;
  37. /**
  38. * This is the model class for table "credit_historique".
  39. *
  40. * @property integer $id
  41. * @property integer $id_user
  42. * @property integer $id_order
  43. * @property string $date
  44. * @property double $amount
  45. * @property string $type
  46. * @property integer $id_producer
  47. * @property string $means_payement
  48. */
  49. class CreditHistory extends ActiveRecord
  50. {
  51. const TYPE_INITIAL_CREDIT = 'initial-credit';
  52. const TYPE_CREDIT = 'credit';
  53. const TYPE_PAYMENT = 'payment';
  54. const TYPE_REFUND = 'refund';
  55. const TYPE_DEBIT = 'debit';
  56. const MEANS_PAYMENT_CREDIT_CARD = 'credit-card';
  57. const MEANS_PAYMENT_MONEY = 'money';
  58. const MEANS_PAYMENT_CHEQUE = 'cheque';
  59. const MEANS_PAYMENT_OTHER = 'other';
  60. /**
  61. * @inheritdoc
  62. */
  63. public static function tableName()
  64. {
  65. return 'credit_history';
  66. }
  67. /**
  68. * @inheritdoc
  69. */
  70. public function rules()
  71. {
  72. return [
  73. [['montant'], 'required'],
  74. [['id_user', 'id_user_action', 'id_order', 'id_producer'], 'integer'],
  75. [['date'], 'safe'],
  76. [['amount'], 'double'],
  77. [['type', 'means_payment', 'comment'], 'string', 'max' => 255],
  78. ];
  79. }
  80. /**
  81. * @inheritdoc
  82. */
  83. public function attributeLabels()
  84. {
  85. return [
  86. 'id' => 'ID',
  87. 'id_user' => 'Utilisateur',
  88. 'id_user_action' => 'Utilisateur',
  89. 'id_order' => 'Commande',
  90. 'date' => 'Date',
  91. 'amount' => 'Montant',
  92. 'type' => 'Type',
  93. 'id_producer' => 'Producteur',
  94. 'means_payment' => 'Moyen de paiement',
  95. 'comment' => 'Commentaire',
  96. ];
  97. }
  98. /*
  99. * Relations
  100. */
  101. public function getUser()
  102. {
  103. return $this->hasOne(User::className(), ['id' => 'id_user']);
  104. }
  105. public function getUserAction()
  106. {
  107. return $this->hasOne(User::className(), ['id' => 'id_user_action']);
  108. }
  109. public function getOrder()
  110. {
  111. return $this->hasOne(Order::className(), ['id' => 'id_order']);
  112. }
  113. /**
  114. * Retourne les options de base nécessaires à la fonction de recherche.
  115. *
  116. * @return array
  117. */
  118. public static function defaultOptionsSearch() {
  119. return [
  120. 'with' => [],
  121. 'join_with' => [],
  122. 'orderby' => self::tableName().'.date ASc',
  123. 'attribute_id_producer' => self::tableName().'.id_producer'
  124. ] ;
  125. }
  126. /**
  127. * Retourne le type de CreditHistorique (paiement, remboursement ou débit).
  128. *
  129. * @return string
  130. */
  131. public function getStrType()
  132. {
  133. switch ($this->type) {
  134. case self::TYPE_PAYMENT:
  135. return 'Paiement';
  136. break;
  137. case self::TYPE_REFUND:
  138. return 'Remboursement';
  139. break;
  140. case self::TYPE_DEBIT:
  141. return 'Débit';
  142. break;
  143. }
  144. }
  145. /**
  146. * Enregistre le modèle.
  147. *
  148. * @param boolean $runValidation
  149. * @param array $attributeNames
  150. */
  151. public function save($runValidation = true, $attributeNames = NULL)
  152. {
  153. // initialisation du commentaire avant sauvegarde
  154. $this->comment .= $this->getStrComment() ;
  155. parent::save($runValidation, $attributeNames);
  156. // mise à jour du crédit au niveau de UserEtablissement
  157. $userProducer = UserProducer::searchOne([
  158. 'id_user' => $this->id_user,
  159. 'id_producer' => $this->id_producer
  160. ]) ;
  161. if ($userProducer) {
  162. if ($this->isTypeCredit()) {
  163. $userProducer->credit += $this->amount;
  164. } elseif ($this->isTypeDebit()) {
  165. $userProducer->credit -= $this->amount;
  166. }
  167. $userProducer->save();
  168. }
  169. }
  170. /**
  171. * Retourne si le CreditHistorique est un débit ou non.
  172. *
  173. * @return boolean
  174. */
  175. public function isTypeDebit()
  176. {
  177. return in_array($this->type, [
  178. self::TYPE_DEBIT,
  179. self::TYPE_PAIEMENT,
  180. ]) ;
  181. }
  182. /**
  183. * Retourne si le CreditHistorique est un crédit ou non.
  184. *
  185. * @return boolean
  186. */
  187. public function isTypeCredit()
  188. {
  189. return in_array($this->type, [
  190. self::TYPE_CREDIT,
  191. self::TYPE_CREDIT_INITIAL,
  192. self::TYPE_REMBOURSEMENT
  193. ]) ;
  194. }
  195. /**
  196. * Retourne le montant.
  197. *
  198. * @param boolean $format
  199. * @return float
  200. */
  201. public function getAmount($format = false)
  202. {
  203. if($format)
  204. return number_format($this->amount,2) .' €' ;
  205. else
  206. return $this->amount ;
  207. }
  208. /**
  209. * Retourne le libellé du CreditHistory informant de son type et
  210. * éventuellement de la date de sa commande associée.
  211. *
  212. * @return string
  213. */
  214. public function getStrWording()
  215. {
  216. $str = '' ;
  217. if($this->type == self::TYPE_CREDIT_INITIAL) {
  218. $str = 'Crédit initial' ;
  219. }
  220. elseif($this->type == self::TYPE_CREDIT) {
  221. $str = 'Crédit' ;
  222. }
  223. elseif($this->type == self::TYPE_PAIEMENT) {
  224. $str = 'Paiement' ;
  225. }
  226. elseif($this->type == self::TYPE_REMBOURSEMENT) {
  227. $str = 'Remboursement' ;
  228. }
  229. elseif($this->type == self::TYPE_DEBIT) {
  230. $str = 'Débit' ;
  231. }
  232. if($this->type == self::TYPE_PAIEMENT || $this->type == self::TYPE_REMBOURSEMENT) {
  233. if(isset($this->commande)) {
  234. $str .= '<br />Commande : '.date('d/m/Y',strtotime($this->commande->production->date)) ;
  235. }
  236. else {
  237. $str .= '<br />Commande supprimée' ;
  238. }
  239. }
  240. return $str ;
  241. }
  242. /**
  243. * Retourne les informations à ajouter au commentaire du CreditHistorique
  244. * (libellé, montant, client, action) au format HTML.
  245. *
  246. * @return string
  247. */
  248. public function getStrComment()
  249. {
  250. $str = '' ;
  251. if(strlen($this->comment)) {
  252. $str .= '<br />' ;
  253. }
  254. $str .= $this->getStrWording() ;
  255. if(isset($this->order)) {
  256. $str .= '<br />Montant de la commande : '.$this->order->getAmount(Order::AMOUNT_TOTAL, true) ;
  257. }
  258. if(isset($this->user)) {
  259. $str .= '<br />Client : '.Html::encode($this->user->name. ' '.$this->user->lastname) ;
  260. }
  261. if(isset($this->userAction)) {
  262. $str .= '<br />Action : '.Html::encode($this->userAction->name. ' '.$this->userAction->lastname) ;
  263. }
  264. return $str ;
  265. }
  266. /**
  267. * Retourne la date.
  268. *
  269. * @param boolean $format
  270. * @return string
  271. */
  272. public function getDate($format = false)
  273. {
  274. if($format)
  275. return date('d/m/Y à H:i:s',strtotime($this->date)) ;
  276. else
  277. return $this->date ;
  278. }
  279. /**
  280. * Retourne le moyen de paiement.
  281. *
  282. * @return string
  283. */
  284. public function getStrMeansPayment()
  285. {
  286. switch($this->means_payment) {
  287. case CreditHistory::MEANS_PAYMENT_MONEY : return 'Espèces' ;
  288. case CreditHistory::MEANS_PAYMENT_CHEQUE : return 'Chèque' ;
  289. case CreditHistory::MEANS_PAYMENT_CREDIT_CARD : return 'Carte bancaire' ;
  290. case CreditHistory::MEANS_PAYMENT_OTHER : return 'Autre' ;
  291. default: return 'Crédit pain' ;
  292. }
  293. }
  294. /**
  295. * Retourne le libellé de l'utilisateur ayant initié l'action.
  296. *
  297. * @return string
  298. */
  299. public function strUserAction()
  300. {
  301. if($this->userAction) {
  302. return $this->userAction->name . ' ' . $this->userAction->lastname ;
  303. }
  304. else {
  305. return 'Système' ;
  306. }
  307. }
  308. }