No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.

393 líneas
11KB

  1. <?php
  2. /**
  3. Copyright distrib (2018)
  4. contact@opendistrib.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 common\components\ActiveRecordCommon ;
  34. use yii\db\ActiveRecord;
  35. use common\models\User;
  36. use common\models\Order;
  37. use common\models\Producer;
  38. use yii\helpers\Html;
  39. /**
  40. * This is the model class for table "credit_historique".
  41. *
  42. * @property integer $id
  43. * @property integer $id_user
  44. * @property integer $id_order
  45. * @property string $date
  46. * @property double $amount
  47. * @property string $type
  48. * @property integer $id_producer
  49. * @property string $mean_payment
  50. */
  51. class CreditHistory extends ActiveRecordCommon
  52. {
  53. const TYPE_INITIAL_CREDIT = 'initial-credit';
  54. const TYPE_CREDIT = 'credit';
  55. const TYPE_PAYMENT = 'payment';
  56. const TYPE_REFUND = 'refund';
  57. const TYPE_DEBIT = 'debit';
  58. const MEAN_PAYMENT_CREDIT_CARD = 'credit-card';
  59. const MEAN_PAYMENT_MONEY = 'money';
  60. const MEAN_PAYMENT_CHEQUE = 'cheque';
  61. const MEAN_PAYMENT_TRANSFER = 'transfer';
  62. const MEAN_PAYMENT_OTHER = 'other';
  63. /**
  64. * @inheritdoc
  65. */
  66. public static function tableName()
  67. {
  68. return 'credit_history';
  69. }
  70. /**
  71. * @inheritdoc
  72. */
  73. public function rules()
  74. {
  75. return [
  76. [['amount'], 'required'],
  77. [['id_user', 'id_user_action', 'id_order', 'id_producer'], 'integer'],
  78. [['date'], 'safe'],
  79. [['amount'], 'double'],
  80. [['type', 'mean_payment', 'comment'], 'string', 'max' => 255],
  81. ];
  82. }
  83. /**
  84. * @inheritdoc
  85. */
  86. public function attributeLabels()
  87. {
  88. return [
  89. 'id' => 'ID',
  90. 'id_user' => 'Utilisateur',
  91. 'id_user_action' => 'Utilisateur',
  92. 'id_order' => 'Commande',
  93. 'date' => 'Date',
  94. 'amount' => 'Montant',
  95. 'type' => 'Type',
  96. 'id_producer' => 'Producteur',
  97. 'mean_payment' => 'Moyen de paiement',
  98. 'comment' => 'Commentaire',
  99. ];
  100. }
  101. /*
  102. * Relations
  103. */
  104. public function getUser()
  105. {
  106. return $this->hasOne(User::className(), ['id' => 'id_user']);
  107. }
  108. public function getUserAction()
  109. {
  110. return $this->hasOne(User::className(), ['id' => 'id_user_action']);
  111. }
  112. public function getOrder()
  113. {
  114. return $this->hasOne(Order::className(), ['id' => 'id_order']);
  115. }
  116. /**
  117. * Retourne les options de base nécessaires à la fonction de recherche.
  118. *
  119. * @return array
  120. */
  121. public static function defaultOptionsSearch() {
  122. return [
  123. 'with' => [],
  124. 'join_with' => [],
  125. 'orderby' => self::tableName().'.date ASc',
  126. 'attribute_id_producer' => self::tableName().'.id_producer'
  127. ] ;
  128. }
  129. /**
  130. * Retourne le type de CreditHistorique (paiement, remboursement ou débit).
  131. *
  132. * @return string
  133. */
  134. public function getStrType()
  135. {
  136. switch ($this->type) {
  137. case self::TYPE_PAYMENT:
  138. return 'Paiement';
  139. break;
  140. case self::TYPE_REFUND:
  141. return 'Remboursement';
  142. break;
  143. case self::TYPE_DEBIT:
  144. return 'Débit';
  145. break;
  146. }
  147. }
  148. /**
  149. * Enregistre le modèle.
  150. *
  151. * @param boolean $runValidation
  152. * @param array $attributeNames
  153. */
  154. public function save($runValidation = true, $attributeNames = NULL)
  155. {
  156. // initialisation du commentaire avant sauvegarde
  157. $this->comment .= $this->getStrComment() ;
  158. parent::save($runValidation, $attributeNames);
  159. // mise à jour du crédit au niveau de UserProducer
  160. $userProducer = UserProducer::searchOne([
  161. 'id_user' => $this->id_user,
  162. 'id_producer' => $this->id_producer
  163. ]) ;
  164. $creditLimitReminder = Producer::getConfig('credit_limit_reminder') ;
  165. $oldCredit = $userProducer->credit ;
  166. if ($userProducer) {
  167. if ($this->isTypeCredit()) {
  168. $userProducer->credit += $this->amount;
  169. } elseif ($this->isTypeDebit()) {
  170. $userProducer->credit -= $this->amount;
  171. }
  172. $newCredit = $userProducer->credit ;
  173. if(!is_null($creditLimitReminder) &&
  174. $oldCredit > $creditLimitReminder && $newCredit <= $creditLimitReminder) {
  175. $user = User::findOne($this->id_user) ;
  176. $producer = Producer::findOne($this->id_producer) ;
  177. Yii::$app->mailer->compose(
  178. [
  179. 'html' => 'creditLimitReminder-html',
  180. 'text' => 'creditLimitReminder-text'
  181. ],
  182. [
  183. 'user' => $user,
  184. 'producer' => $producer,
  185. 'credit' => $newCredit
  186. ]
  187. )
  188. ->setTo($user->email)
  189. ->setFrom(['contact@opendistrib.net' => 'distrib'])
  190. ->setSubject('[distrib] Seuil limite de crédit dépassé')
  191. ->send();
  192. }
  193. $userProducer->save();
  194. }
  195. }
  196. /**
  197. * Retourne si le CreditHistorique est un débit ou non.
  198. *
  199. * @return boolean
  200. */
  201. public function isTypeDebit()
  202. {
  203. return in_array($this->type, [
  204. self::TYPE_DEBIT,
  205. self::TYPE_PAYMENT,
  206. ]) ;
  207. }
  208. /**
  209. * Retourne si le CreditHistorique est un crédit ou non.
  210. *
  211. * @return boolean
  212. */
  213. public function isTypeCredit()
  214. {
  215. return in_array($this->type, [
  216. self::TYPE_CREDIT,
  217. self::TYPE_INITIAL_CREDIT,
  218. self::TYPE_REFUND
  219. ]) ;
  220. }
  221. /**
  222. * Retourne le montant.
  223. *
  224. * @param boolean $format
  225. * @return float
  226. */
  227. public function getAmount($format = false)
  228. {
  229. if($format) {
  230. return number_format($this->amount,2) .'&nbsp;€' ;
  231. }
  232. else {
  233. return $this->amount ;
  234. }
  235. }
  236. /**
  237. * Retourne le libellé du CreditHistory informant de son type et
  238. * éventuellement de la date de sa commande associée.
  239. *
  240. * @return string
  241. */
  242. public function getStrWording()
  243. {
  244. $str = '' ;
  245. if($this->type == self::TYPE_INITIAL_CREDIT) {
  246. $str = 'Crédit initial' ;
  247. }
  248. elseif($this->type == self::TYPE_CREDIT) {
  249. $str = 'Crédit' ;
  250. }
  251. elseif($this->type == self::TYPE_PAYMENT) {
  252. $str = 'Paiement' ;
  253. }
  254. elseif($this->type == self::TYPE_REFUND) {
  255. $str = 'Remboursement' ;
  256. }
  257. elseif($this->type == self::TYPE_DEBIT) {
  258. $str = 'Débit' ;
  259. }
  260. if($this->type == self::TYPE_PAYMENT || $this->type == self::TYPE_REFUND) {
  261. if(isset($this->order)) {
  262. $str .= '<br />Commande : '.date('d/m/Y',strtotime($this->order->distribution->date)) ;
  263. }
  264. else {
  265. $str .= '<br />Commande supprimée' ;
  266. }
  267. }
  268. return $str ;
  269. }
  270. /**
  271. * Retourne les informations à ajouter au commentaire du CreditHistorique
  272. * (libellé, montant, client, action) au format HTML.
  273. *
  274. * @return string
  275. */
  276. public function getStrComment()
  277. {
  278. $str = '' ;
  279. if(strlen($this->comment)) {
  280. $str .= '<br />' ;
  281. }
  282. $str .= $this->getStrWording() ;
  283. if(isset($this->order)) {
  284. $str .= '<br />Montant de la commande : '.$this->order->getAmount(Order::AMOUNT_TOTAL, true) ;
  285. }
  286. if(isset($this->user)) {
  287. $str .= '<br />Client : '.Html::encode($this->user->name. ' '.$this->user->lastname) ;
  288. }
  289. if(isset($this->userAction)) {
  290. $str .= '<br />Action : '.Html::encode($this->userAction->name. ' '.$this->userAction->lastname) ;
  291. }
  292. return $str ;
  293. }
  294. /**
  295. * Retourne la date.
  296. *
  297. * @param boolean $format
  298. * @return string
  299. */
  300. public function getDate($format = false)
  301. {
  302. if($format)
  303. return date('d/m/Y à H:i:s',strtotime($this->date)) ;
  304. else
  305. return $this->date ;
  306. }
  307. /**
  308. * Retourne le libellé du moyen de paiement du CreditHistory courant.
  309. *
  310. * @return string
  311. */
  312. public function getStrMeanPayment()
  313. {
  314. return self::getStrMeanPaymentBy($this->mean_payment) ;
  315. }
  316. /**
  317. * Retourne le libellé du moyen de paiement.
  318. *
  319. * @param string $meanPayment
  320. * @return string
  321. */
  322. public static function getStrMeanPaymentBy($meanPayment)
  323. {
  324. switch($meanPayment) {
  325. case CreditHistory::MEAN_PAYMENT_MONEY : return 'Espèces' ;
  326. case CreditHistory::MEAN_PAYMENT_CHEQUE : return 'Chèque' ;
  327. case CreditHistory::MEAN_PAYMENT_CREDIT_CARD : return 'Carte bancaire' ;
  328. case CreditHistory::MEAN_PAYMENT_TRANSFER : return 'Virement' ;
  329. case CreditHistory::MEAN_PAYMENT_OTHER : return 'Autre' ;
  330. default: return 'Crédit' ;
  331. }
  332. }
  333. /**
  334. * Retourne le libellé de l'utilisateur ayant initié l'action.
  335. *
  336. * @return string
  337. */
  338. public function strUserAction()
  339. {
  340. if($this->userAction) {
  341. return $this->userAction->name . ' ' . $this->userAction->lastname ;
  342. }
  343. else {
  344. return 'Système' ;
  345. }
  346. }
  347. }