|
- <?php
-
- /**
- Copyright La boîte à pain (2018)
-
- contact@laboiteapain.net
-
- Ce logiciel est un programme informatique servant à aider les producteurs
- à distribuer leur production en circuits courts.
-
- Ce logiciel est régi par la licence CeCILL soumise au droit français et
- respectant les principes de diffusion des logiciels libres. Vous pouvez
- utiliser, modifier et/ou redistribuer ce programme sous les conditions
- de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
- sur le site "http://www.cecill.info".
-
- En contrepartie de l'accessibilité au code source et des droits de copie,
- de modification et de redistribution accordés par cette licence, il n'est
- offert aux utilisateurs qu'une garantie limitée. Pour les mêmes raisons,
- seule une responsabilité restreinte pèse sur l'auteur du programme, le
- titulaire des droits patrimoniaux et les concédants successifs.
-
- A cet égard l'attention de l'utilisateur est attirée sur les risques
- associés au chargement, à l'utilisation, à la modification et/ou au
- développement et à la reproduction du logiciel par l'utilisateur étant
- donné sa spécificité de logiciel libre, qui peut le rendre complexe à
- manipuler et qui le réserve donc à des développeurs et des professionnels
- avertis possédant des connaissances informatiques approfondies. Les
- utilisateurs sont donc invités à charger et tester l'adéquation du
- logiciel à leurs besoins dans des conditions permettant d'assurer la
- sécurité de leurs systèmes et ou de leurs données et, plus généralement,
- à l'utiliser et l'exploiter dans les mêmes conditions de sécurité.
-
- Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
- pris connaissance de la licence CeCILL, et que vous en avez accepté les
- termes.
- */
-
- namespace common\models;
-
- use Yii;
- use yii\helpers\Html;
- use common\models\Producer;
- use common\components\ActiveRecordCommon ;
-
- /**
- * This is the model class for table "commande".
- *
- * @property integer $id
- * @property integer $id_user
- * @property string $date
- * @property string $date_update
- * @property integer $id_point_sale
- * @property integer $id_production
- * @property boolean $paiement_automatique
- */
- class Order extends ActiveRecordCommon
- {
- var $amount = 0 ;
- var $paid_amount = 0 ;
- var $Weight = 0 ;
-
- const ORIGIN_AUTO = 'auto';
- const ORIGIN_USER = 'user';
- const ORIGIN_ADMIN = 'admin';
-
- const PAYMENT_PAID = 'paid';
- const PAYMENT_UNPAID = 'unpaid';
- const PAYMENT_SURPLUS = 'surplus';
-
- const AMOUNT_TOTAL = 'total' ;
- const AMOUNT_PAID = 'paid' ;
- const AMOUNT_REMAINING = 'remaining' ;
- const AMOUNT_SURPLUS = 'surplus' ;
-
- const STATE_OPEN = 'open';
- const STATE_PREPARATION = 'preparation';
- const STATE_DELIVERED = 'livree';
-
- /**
- * @inheritdoc
- */
- public static function tableName()
- {
- return 'order';
- }
-
- /*
- * Relations
- */
-
- public function getUser()
- {
- return $this->hasOne(User::className(), ['id' => 'id_user']);
- }
-
- public function getProductOrder()
- {
- return $this->hasMany(ProductOrder::className(),['id_order' => 'id'])
- ->with('product');
- }
-
- public function getProduction()
- {
- return $this->hasOne(Production::className(), ['id' => 'id_production'])
- ->with('producer');
- }
-
- public function getPointSale()
- {
- return $this->hasOne(PointSale::className(), ['id' => 'id_point_sale'])
- ->with('pointSaleUser');
- }
-
- public function getCreditHistory()
- {
- return $this->hasMany(CreditHistory::className(), ['id_order' => 'id']);
- }
-
- /**
- * @inheritdoc
- */
- public function rules()
- {
- return [
- [['id_user', 'date', 'id_point_sale', 'id_production'], 'required', 'message' => ''],
- [['id_user', 'id_point_sale', 'id_production'], 'integer'],
- [['payment_auto'], 'boolean'],
- [['date', 'date_update', 'comment', 'point_sale_comment'], 'safe']
- ];
- }
-
- /**
- * @inheritdoc
- */
- public function attributeLabels()
- {
- return [
- 'id' => 'ID',
- 'id_user' => 'Id User',
- 'date' => 'Date',
- 'date_update' => 'Date de modification',
- 'id_point_sale' => 'Point de vente',
- 'id_production' => 'Date de production',
- ];
- }
-
- /**
- * Initialise le montant total, le montant déjà payé et le poids de la
- * commande.
- */
- public function init()
- {
- $this->initAmount() ;
- $this->initPaidAmount() ;
- }
-
- /**
- * Initialise le montant de la commande.
- *
- */
- public function initAmount() {
- if (isset($this->productOrder)) {
- foreach ($this->productOrder as $p) {
- if ($p->sale_mode == Product::SALE_MODE_UNIT) {
- $this->amount += $p->price * $p->quantity ;
- if(isset($p->product)) {
- $this->weight += ($p->quantity * $p->product->weight) / 1000 ;
- }
- }
- elseif ($p->sale_mode == Product::SALE_MODE_WEIGHT) {
- $this->amount += $p->price * $p->quantity / 1000;
- }
- }
- }
- }
-
- /**
- * Initialise le montant payé de la commande et le retourne.
- *
- * @return float
- */
- public function initPaidAmount()
- {
- $history = CreditHistory::find()
- ->where(['id_order' => $this->id])
- ->all();
-
- $this->paid_amount = 0 ;
-
- if(count($history)) {
- foreach ($history as $ch) {
- if ($ch->type == CreditHistory::TYPE_PAYMENT) {
- $this->paid_amount += $ch->amount;
- }
- elseif ($ch->type == CreditHistory::TYPE_REFUND) {
- $this->paid_amount -= $ch->amount;
- }
- }
- }
- }
-
- /**
- * Retourne le montant de la commande (total, payé, restant, ou en surplus).
- *
- * @param boolean $format
- * @return float
- */
- public function getAmount($type = self::AMOUNT_TOTAL, $format = false)
- {
- switch($type) {
- case self::AMOUNT_TOTAL :
- $amount = $this->amount ;
- break ;
- case self::AMOUNT_PAID :
- $this->initPaidAmount() ;
- $amount = $this->paid_amount ;
- break ;
- case self::AMOUNT_REMAINING :
- $amount = $this->getAmount(self::AMOUNT_TOTAL)
- - $this->getAmount(self::AMOUNT_PAID) ;
- break ;
- case self::AMOUNT_EXCESS :
- $amount = $this->getAmount(self::AMOUNT_PAID)
- - $this->getAmount(self::AMOUNT_TOTAL) ;
- break ;
- }
-
- if ($format) {
- return number_format($amount, 2) . ' €';
- }
- else {
- return $amount;
- }
- }
-
- /**
- * Retourne les informations relatives à la commande au format JSON.
- *
- * @return string
- */
- public function getDataJson()
- {
- $order = Order::findBy(['order.id' => $this->id]) ;
-
- $json_order = [] ;
- if($order) {
- $json_order = [
- 'products' => [],
- 'amount' => $order->montant,
- 'str_amount' => $order->getAmount(self::TYPE_AMOUNT_TOTAL, true),
- 'paid_amount' => $order->getPaidAmount(self::TYPE_AMOUNT_PAID),
- 'comment' => $order->comment,
- ];
-
- foreach ($order->productOrder as $product_order) {
- $json_order['products'][$product_order->id_product] = $product_order->quantity;
- }
- }
-
- return json_encode($json_order);
- }
-
- /**
- * Enregistre un modèle de type CreditHistorique.
- *
- * @param string $type
- * @param float $montant
- * @param integer $id_producer
- * @param integer $id_user
- * @param integer $id_user_action
- */
- public function saveCreditHistory($type, $amount, $id_producer, $id_user, $id_user_action)
- {
- $credit_history = new CreditHistorique;
- $credit_history->id_user = $this->id_user;
- $credit_history->id_order = $this->id;
- $credit_history->amount = $amount;
- $credit_history->type = $type;
- $credit_history->id_producer = $id_producer;
- $credit_history->id_user_action = $id_user_action;
- $credit_history->populateRelation('order', $this) ;
- $credit_history->populateRelation('user', User::find()->where(['id' => $this->id_user])->one()) ;
- $credit_history->save();
- }
-
- /**
- * Retourne le statut de paiement de la commande (payée, surplus, ou impayée).
- *
- * @return string
- */
- public function getPaymentStatus()
- {
- // payé
- if ($this->getAmount() - $this->getAmount(self::TYPE_AMOUNT_PAID) < 0.01 &&
- $this->getAmount() - $this->getAmount(self::TYPE_AMOUNT_PAID) >= 0)
- {
- return self::PAYMENT_PAID ;
- }
- // à rembourser
- elseif ($this->getAmount() - $this->getAmount(self::TYPE_AMOUNT_PAID) <= -0.01) {
- return self::PAYMENT_SURPLUS ;
- }
- // reste à payer
- elseif ($this->getAmount() - $this->getAmount(self::TYPE_AMOUNT_PAID) >= 0.01) {
- return self::PAYMENT_UNPAID ;
- }
- }
-
- /**
- * Retourne le résumé du panier au format HTML.
- *
- * @return string
- */
- public function getCartSummary()
- {
- if (!isset($this->productOrder)) {
- $this->productOrder = productOrder::find()->where(['id_order' => $this->id])->all();
- }
-
- $html = '';
- $count = count($this->productOrder);
- $i = 0;
- foreach ($this->productOrder as $p) {
- if (isset($p->product)) {
- $html .= $p->quantity . ' x ' . Html::encode($p->product->name);
- if (++$i != $count) {
- $html .= '<br />';
- }
- }
- }
-
- return $html;
- }
-
- /**
- * Retourne le résumé du point de vente lié à la commande au format HTML.
- *
- * @return string
- */
- public function getSalePointSummary()
- {
- $html = '';
-
- if (isset($this->salePoint)) {
- $html .= '<span class="nom-point-vente">' .
- Html::encode($this->salePoint->name) .
- '</span>' .
- '<br /><span class="localite">'
- . Html::encode($this->salePoint->locality)
- . '</span>';
-
- if (strlen($this->sale_point_comment)) {
- $html .= '<div class="commentaire"><span>'
- . Html::encode($this->sale_point_comment)
- . '</span></div>';
- }
- } else {
- $html .= 'Point de vente supprimé';
- }
-
- return $html;
- }
-
- /**
- * Retourne le résumé du paiement (montant, statut).
- *
- * @return string
- */
- public function getAmountSummary()
- {
- $html = '';
-
- $html .= $this->getAmount(self::TYPE_AMOUNT_TOTAL, true) . '<br />';
-
- if ($this->paid_amount) {
- if ($this->getPaymentStatus() == Order::PAYMENT_PAID) {
- $html .= '<span class="label label-success">Payée</span>';
- } elseif ($this->getPaymentStatus() == Order::PAYMENT_UNPAID) {
- $html .= '<span class="label label-danger">Non payée</span><br />
- Reste <strong>' . $this->getRemainingAmount(true) . '</strong> à payer';
- } elseif ($this->getPaymentStatus() == Order::PAYMENT_SURPLUS) {
- $html .= '<span class="label label-success">Payée</span>';
- }
- }
- else {
- $html .= '<span class="label label-default">À régler sur place</span>';
- }
-
- return $html;
- }
-
- /**
- * Retourne une chaine de caractère décrivant l'utilisateur lié à la commande.
- *
- * @return string
- */
- public function getStrUser()
- {
- if (isset($this->user)) {
- return Html::encode($this->user->prenom . ' ' . $this->user->nom);
- } elseif (strlen($this->username)) {
- return Html::encode($this->username);
- } else {
- return 'Client introuvable';
- }
- }
-
- /**
- * Retourne l'état de la commande (livrée, modifiable ou en préparation)
- *
- * @return string
- */
- public function getState()
- {
- $order_delay = Producer::getConfig(
- 'order_delay',
- $this->production->id_producer
- );
-
- $order_deadline = Producer::getConfig(
- 'order_deadline',
- $this->production->id_producer
- );
-
- $order_date = strtotime($this->production->date);
- $today = strtotime(date('Y-m-d'));
- $today_hour = date('G');
-
- $nb_days = (int) (($date_order - $today) / (24 * 60 * 60));
-
- if ($nb_days <= 0) {
- return self::STATE_DELIVERED;
- }
- elseif ($nb_days >= $order_delay &&
- ($nb_days != $order_delay ||
- ($nb_days == $order_delay && $today_hour < $order_deadline)))
- {
- return self::STATE_OPEN;
- }
-
- return self::STATE_PREPARATION ;
- }
-
- /**
- * Retourne l'origine de la commande (client, automatique ou admin) sous forme
- * texte ou HTML.
- *
- * @param boolean $with_label
- * @return string
- */
- public function getStrOrigin($with_label = false)
- {
- $class_label = '';
- $str = '';
-
- if ($this->type == self::ORIGIN_USER) {
- $class_label = 'success';
- $str = 'Client';
- }
- elseif ($this->type == self::ORIGIN_AUTO) {
- $class_label = 'default';
- $str = 'Auto';
- }
- elseif ($this->type == self::ORIGIN_ADMIN) {
- $class_label = 'warning';
- $str = 'Vous';
- }
-
- if ($with_label) {
- return '<span class="label label-' . $class_label . '">' . $str . '</span>';
- }
- else {
- return $str;
- }
- }
-
- /**
- * Retourne l'historique de la commande (ajoutée, modifiée, supprimée) au
- * format HTML.
- *
- * @return string
- */
- public function getStrHistory()
- {
- $arr = [
- 'class' => 'create',
- 'glyphicon' => 'plus',
- 'str' => 'Ajoutée',
- 'date' => $this->date
- ] ;
-
- if(!is_null($this->date_update)) {
- $arr = [
- 'class' => 'update',
- 'glyphicon' => 'pencil',
- 'str' => 'Modifiée',
- 'date' => $this->date_update
- ] ;
- }
- if(!is_null($this->date_delete)) {
- $arr = [
- 'class' => 'delete',
- 'glyphicon' => 'remove',
- 'str' => 'Annulée',
- 'date' => $this->date_delete
- ] ;
- }
-
- $html = '<div class="small"><span class="'.$arr['class'].'"><span class="glyphicon glyphicon-'.$arr['glyphicon'].'"></span> '.$arr['str'].'</span> le <strong>'.date('d/m/Y à G\hi', strtotime($arr['date'])).'</strong></div>' ;
-
- return $html ;
- }
-
- /**
- * Retourne une classe identifiant l'historique de la commande (ajoutée,
- * modifiée, supprimée).
- *
- * @return string
- */
- public function getClassHistory()
- {
- if(!is_null($this->date_delete)) {
- return 'commande-delete' ;
- }
- if(!is_null($this->date_update)) {
- return 'commande-update' ;
- }
- return 'commande-create' ;
- }
-
- /**
- * Retourne la quantité d'un produit donné de plusieurs commandes.
- *
- * @param integer $id_produit
- * @param array $commandes
- *
- * @return integer
- */
- public static function getProductQuantity($id_product, $orders)
- {
- $quantity = 0;
-
- if (isset($orders) && is_array($orders) && count($orders)) {
- foreach ($orders as $c) {
- if(is_null($c->date_delete)) {
- foreach ($c->productOrder as $po) {
- if ($po->id_product == $id_product) {
- $quantity += $po->quantity ;
- }
- }
- }
- }
- }
-
- return $quantity ;
- }
-
- /**
- * Recherche des commandes.
- *
- * @param array $params
- * @param array $conditions
- * @param string $orderby
- * @param integer $limit
- * @return array
- */
- public static function findBy($params = [], $conditions = [], $orderby = '', $limit = 0)
- {
- if (!isset($params['production.id_producer']) && !Yii::$app->user->isGuest) {
- $params['production.id_producer'] = Producer::getCurrent();
- }
-
- $orders = parent::findByGeneric(
- 'Order',
- 'order.id',
- ['productOrder', 'creditHistory', 'pointSale'],
- ['production', 'user', 'user.userProducer'],
- $params,
- $conditions,
- strlen($orderby) ? $orderby : 'date ASC',
- $limit
- ) ;
-
- /*
- * Initialisation des commandes
- */
-
- if(is_array($orders)) {
- if(count($orders)) {
- foreach($orders as $order) {
- $order->init() ;
- }
- return $orders ;
- }
- }
- else {
- $order = $orders ;
- $order->init() ;
- return $order ;
- }
-
- return false ;
- }
-
- }
|