Opendistrib/common/models/Order.php

<?php

/** 
Copyright distrib (2018) 

contact@opendistrib.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 "order".
 *
 * @property integer $id
 * @property integer $id_user
 * @property string $date
 * @property string $date_update
 * @property integer $id_point_sale
 * @property integer $id_distribution
 * @property boolean $auto_payment
 * @property integer $id_subscription
 */
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   = 'delivered';
    
    /**
     * @inheritdoc
     */
    public static function tableName() 
    {
        return 'order';
    }
    
    /**
     * @inheritdoc
     */
    public function rules() 
    {
        return [
            [['id_user', 'date', 'id_point_sale', 'id_distribution'], 'required', 'message' => ''],
            [['id_user', 'id_point_sale', 'id_distribution','id_subscription'], 'integer'],
            [['auto_payment'], 'boolean'],
            [['date', 'date_update', 'comment', 'comment_point_sale'], '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_distribution' => 'Date de distribution',
            'id_subscription' => 'Abonnement',
        ];
    }

    /*
     * 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 getDistribution() 
    {
        return $this->hasOne(Distribution::className(), ['id' => 'id_distribution'])
            ->with('producer');
    }

    public function getPointSale() 
    {
        return $this->hasOne(PointSale::className(), ['id' => 'id_point_sale'])
            ->with('userPointSale');
    }

    public function getCreditHistory() 
    {
        return $this->hasMany(CreditHistory::className(), ['id_order' => 'id']);
    }
    
    public function getSubscription() 
    {
        return $this->hasOne(Subscription::className(), ['id' => 'id_subscription'])
            ->with('productSubscription');
    }

    /**
     * Retourne les options de base nécessaires à la fonction de recherche.
     * 
     * @return array
     */
    public static function defaultOptionsSearch() {
        return [
            'with' => ['productOrder', 'creditHistory','creditHistory.userAction' , 'pointSale'],
            'join_with' => ['distribution', 'user', 'user.userProducer'],
            'orderby' => 'order.date ASC',
            'attribute_id_producer' => 'distribution.id_producer'
        ] ;
    }
    
    /**
     * Initialise le montant total, le montant déjà payé et le poids de la 
     * commande.
     */
    public function init() 
    {
        $this->initAmount() ;
        $this->initPaidAmount() ;
        
        return $this ;
    }
    
    /**
     * Initialise le montant de la commande.
     * 
     */
    public function initAmount() {
        if (isset($this->productOrder)) {
            foreach ($this->productOrder as $productOrder) {
                if ($productOrder->sale_mode == Product::SALE_MODE_UNIT) {
                    $this->amount += $productOrder->price * $productOrder->quantity ;
                    if(isset($productOrder->product)) {
                        $this->weight += ($productOrder->quantity * $productOrder->product->weight) / 1000 ;
                    }
                } 
                elseif ($productOrder->sale_mode == Product::SALE_MODE_WEIGHT) {
                    $this->amount += $productOrder->price * $productOrder->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_SURPLUS :
                $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::searchOne(['order.id' => $this->id]) ;

        $jsonOrder = [] ;
        if($order) {
            $jsonOrder = [
                'products' => [],
                'amount' => $order->amount,
                'str_amount' => $order->getAmount(self::AMOUNT_TOTAL, true),
                'paid_amount' => $order->getAmount(self::AMOUNT_PAID),
                'comment' => $order->comment,
            ];

            foreach ($order->productOrder as $productOrder) {
                $jsonOrder['products'][$productOrder->id_product] = $productOrder->quantity;
            }
        }

        return json_encode($jsonOrder);
    }

    /**
     * Enregistre un modèle de type CreditHistory.
     * 
     * @param string $type
     * @param float $montant
     * @param integer $idProducer
     * @param integer $idUser
     * @param integer $idUserAction
     */
    public function saveCreditHistory($type, $amount, $idProducer, $idUser, $idUserAction) 
    {
        $creditHistory = new CreditHistory;
        $creditHistory->id_user = $this->id_user;
        $creditHistory->id_order = $this->id;
        $creditHistory->amount = $amount;
        $creditHistory->type = $type;
        $creditHistory->id_producer = $idProducer;
        $creditHistory->id_user_action = $idUserAction;
        $creditHistory->populateRelation('order', $this) ;
        $creditHistory->populateRelation('user', User::find()->where(['id' => $this->id_user])->one()) ;
        $creditHistory->save();
    }
    
    /**
     * Ajuste le crédit pour que la commande soit payée.
     * 
     * @return boolean
     */
    public function processCredit()
    {
        if($this->id_user) {
            $paymentStatus = $this->getPaymentStatus() ;

            if($paymentStatus == self::PAYMENT_PAID) {
                return true; 
            }
            elseif($paymentStatus == self::PAYMENT_SURPLUS) {
                $type = CreditHistory::TYPE_REFUND ;
                $amount = $this->getAmount(self::AMOUNT_SURPLUS) ;
            }
            elseif($paymentStatus == self::PAYMENT_UNPAID) {
                $type = CreditHistory::TYPE_PAYMENT ;
                $amount = $this->getAmount(self::AMOUNT_REMAINING) ;
            }

            $this->saveCreditHistory(
                $type, 
                $amount, 
                Producer::getId(), 
                $this->id_user,
                User::getCurrentId()
            );
        }
    }

    /**
     * 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::AMOUNT_PAID) < 0.01 && 
            $this->getAmount() - $this->getAmount(self::AMOUNT_PAID) > -0.01) 
        {
            return self::PAYMENT_PAID ;
        }
        // à rembourser
        elseif ($this->getAmount() - $this->getAmount(self::AMOUNT_PAID) <= -0.01) {
            return self::PAYMENT_SURPLUS ;
        }
        // reste à payer
        elseif ($this->getAmount() - $this->getAmount(self::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 getPointSaleSummary() 
    {
        $html = '';

        if (isset($this->pointSale)) {
            $html .= '<span class="name-point-sale">' . 
                        Html::encode($this->pointSale->name) . 
                      '</span>' .
                      '<br /><span class="locality">' 
                          . Html::encode($this->pointSale->locality) 
                      . '</span>';
            
            if (strlen($this->comment_point_sale)) {
                $html .= '<div class="comment"><span>' 
                            . Html::encode($this->comment_point_sale) 
                         . '</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::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->getAmount(Order::AMOUNT_REMAINING, 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">Non réglé</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->name . ' ' . $this->user->lastname);
        } 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() 
    {
        $orderDelay = Producer::getConfig(
            'order_delay', 
            $this->distribution->id_producer
        );
        
        $orderDeadline = Producer::getConfig(
            'order_deadline', 
            $this->distribution->id_producer
        );

        $orderDate = strtotime($this->distribution->date);
        $today = strtotime(date('Y-m-d'));
        $todayHour = date('G');

        $nbDays = (int) (($orderDate - $today) / (24 * 60 * 60));

        if ($nbDays <= 0) {
            return self::STATE_DELIVERED;
        } 
        elseif ($nbDays >= $orderDelay &&
                ($nbDays != $orderDelay ||
                ($nbDays == $orderDelay && $todayHour < $orderDeadline))) 
        {
            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($withLabel = false) 
    {
        $classLabel = '';
        $str = '';

        if ($this->origin == self::ORIGIN_USER) {
            $classLabel = 'success';
            $str = 'Client';
        } 
        elseif ($this->origin == self::ORIGIN_AUTO) {
            $classLabel = 'default';
            $str = 'Auto';
        } 
        elseif ($this->origin == self::ORIGIN_ADMIN) {
            $classLabel = 'warning';
            $str = 'Vous';
        }

        if ($withLabel) {
            return '<span class="label label-' . $classLabel . '">' 
                    . $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 $idProduct
     * @param array $orders
     * @param boolean $ignoreCancel
     * 
     * @return integer 
     */
    public static function getProductQuantity($idProduct, $orders, $ignoreCancel = false)
    {   
        $quantity = 0;
        
        if (isset($orders) && is_array($orders) && count($orders)) {
            foreach ($orders as $c) {
                if(is_null($c->date_delete) || $ignoreCancel) {
                    foreach ($c->productOrder as $po) {
                        if ($po->id_product == $idProduct) {
                            $quantity += $po->quantity ;
                        }
                    }    
                }
            }
        }

        return $quantity ;
    }
    
    /**
     * Recherche et initialise des commandes.
     * 
     * @param array $params
     * @param array $conditions
     * @param string $orderby
     * @param integer $limit
     * @return array
     */
    public static function searchBy($params = [], $options = []) 
    {
        $orders = parent::searchBy($params, $options) ;
        
        /*
         * Initialisation des commandes
         */
        
        if(is_array($orders)) {
            if(count($orders)) {
                foreach($orders as $order) {
                    $order->init() ;
                }
                return $orders ;
            }
        }
        else {
            $order = $orders ;
            if(is_a($order, 'common\models\Order')) {
                return $order->init() ;
            }
            // count
            else {
                return $order ;
            }
        }
        
        return false ;
    }
    
    /**
     * Retourne le nombre de produits commandés
     * 
     * @return integer
     */
    public function countProducts() 
    {
        $count = 0 ;
        if($this->productOrder && is_array($this->productOrder)) {
            foreach($this->productOrder as $productOrder) {
                $count += $productOrder->quantity ;
            }
        }
        return $count ;
    }
    
    /**
     * Retourne un bloc html présentant une date.
     * 
     * @return string
     */
    public function getBlockDate() 
    {
        return '<div class="block-date">
                    <div class="day">'.strftime('%A', strtotime($this->distribution->date)).'</div>
                    <div class="num">'.date('d', strtotime($this->distribution->date)).'</div>
                    <div class="month">'.strftime('%B', strtotime($this->distribution->date)).'</div>
                </div>' ;
    }
    
}