Deplacement

Complexity

Total Complexity

47

Size/Duplication

Total Lines	433
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getNomUrl()	0	23	5
C	create()	0	67	12
A	listOfTypes()	0	25	4
C	update()	0	46	12
A	getLibStatut()	0	3	1
A	delete()	0	17	2
A	LibStatut()	0	20	3
A	fetch()	0	34	3
A	__construct()	0	5	1

<?php

/* Copyright (C) 2003       Rodolphe Quiedeville        <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2011	Laurent Destailleur		    <eldy@users.sourceforge.net>
 * Copyright (C) 2009-2012	Regis Houssin			    <regis.houssin@inodbox.com>
 * Copyright (C) 2013       Florian Henry		  	    <florian.henry@open-concept.pro>
 * Copyright (C) 2019-2024	Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024       Rafael San José             <rsanjose@alxarafe.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace Dolibarr\Code\Compta\Classes;

/**
 *      \file       htdocs/compta/deplacement/class/deplacement.class.php
 *      \ingroup    deplacement
 *      \brief      File of class to manage trips
 */

use Dolibarr\Core\Base\CommonObject;
use DoliDB;

/**
 *      Class to manage trips and working credit notes
 */
class Deplacement extends CommonObject
{
    /**
     * @var string ID to identify managed object
     */
    public $element = 'deplacement';

    /**
     * @var string Name of table without prefix where object is stored
     */
    public $table_element = 'deplacement';

    /**
     * @var string    Name of subtable line
     */
    public $table_element_line = '';

    /**
     * @var string Fieldname with ID of parent key if this field has a parent
     */
    public $fk_element = '';

    public $fk_soc;
    public $date;
    public $type;

    /**
     * Date creation record (datec)
     *
     * @var integer
     */
    public $datec;

    /**
     * Date (dated)
     *
     * @var integer
     */
    public $dated;

    /**
     * @var int ID
     */
    public $fk_user_author;

    /**
     * @var int User ID
     */
    public $fk_user;

    /**
     * @var float km value formatted
     */
    public $km;

    /**
     * @var int Thirdparty id
     */
    public $socid;

    /**
     * @var int Status 0=draft, 1=validated, 2=Refunded
     */
    public $statut;
    public $extraparams = array();


    /**
     * Draft status
     */
    const STATUS_DRAFT = 0;

    /**
     * Validated status
     */
    const STATUS_VALIDATED = 1;

    /**
     * Refunded status
     */
    const STATUS_REFUNDED = 2;

    /**
     * Constructor
     *
     * @param   DoliDB      $db     Database handler
     */
    public function __construct(DoliDB $db)
    {
        $this->db = $db;

        $this->ismultientitymanaged = 0;
    }

    /**
     * Create object in database
     * TODO Add ref number
     *
     * @param   User    $user   User that creates
     * @return  int             Return integer <0 if KO, >0 if OK
     */
    public function create($user)
    {
        global $conf;

        // Check parameters
        if (empty($this->type) || $this->type < 0) {
            $this->error = 'ErrorBadParameter';
            return -1;
        }
        if (empty($this->fk_user) || $this->fk_user < 0) {
            $this->error = 'ErrorBadParameter';
            return -1;
        }

        $now = dol_now();

        $this->db->begin();

        $sql = "INSERT INTO " . MAIN_DB_PREFIX . "deplacement (";
        $sql .= "datec";
        //$sql.= ", dated";
        $sql .= ", entity";
        $sql .= ", fk_user_author";
        $sql .= ", fk_user";
        $sql .= ", type";
        $sql .= ", note_private";
        $sql .= ", note_public";
        $sql .= ", fk_projet";
        $sql .= ", fk_soc";
        $sql .= ") VALUES (";
        $sql .= " '" . $this->db->idate($now) . "'";
        $sql .= ", " . ((int) $conf->entity);
        $sql .= ", " . ((int) $user->id);
        $sql .= ", " . ((int) $this->fk_user);
        $sql .= ", '" . $this->db->escape($this->type) . "'";
        $sql .= ", " . ($this->note_private ? "'" . $this->db->escape($this->note_private) . "'" : "null");
        $sql .= ", " . ($this->note_public ? "'" . $this->db->escape($this->note_public) . "'" : "null");
        $sql .= ", " . ($this->fk_project > 0 ? ((int) $this->fk_project) : 0);
        $sql .= ", " . ($this->fk_soc > 0 ? ((int) $this->fk_soc) : "null");
        $sql .= ")";

        dol_syslog(get_class($this) . "::create", LOG_DEBUG);
        $result = $this->db->query($sql);
        if ($result) {
            $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX . "deplacement");

            // Call trigger
            $result = $this->call_trigger('DEPLACEMENT_CREATE', $user);
            if ($result < 0) {
                $this->db->rollback();
                return -2;
            }
            // End call triggers

            $result = $this->update($user);
            if ($result > 0) {
                $this->db->commit();
                return $this->id;
            } else {
                $this->error = $this->db->error();
                $this->db->rollback();
                return $result;
            }
        } else {
            $this->error = $this->db->error() . " sql=" . $sql;
            $this->db->rollback();
            return -1;
        }
    }

    /**
     *  Update record
     *
     *  @param  User    $user       User making update
     *  @return int                 Return integer <0 if KO, >0 if OK
     */
    public function update($user)
    {
        // Clean parameters
        $this->km = (float) price2num($this->km);

        // Check parameters
        if (!is_numeric($this->km)) {
            $this->km = 0;
        }
        if (empty($this->date)) {
            $this->error = 'ErrorBadParameter';
            return -1;
        }
        if (empty($this->type) || $this->type < 0) {
            $this->error = 'ErrorBadParameter';
            return -1;
        }
        if (empty($this->fk_user) || $this->fk_user < 0) {
            $this->error = 'ErrorBadParameter';
            return -1;
        }

        $this->db->begin();

        $sql = "UPDATE " . MAIN_DB_PREFIX . "deplacement ";
        $sql .= " SET km = " . ((float) $this->km); // This is a distance or amount
        $sql .= " , dated = '" . $this->db->idate($this->date) . "'";
        $sql .= " , type = '" . $this->db->escape($this->type) . "'";
        $sql .= " , fk_statut = '" . $this->db->escape($this->statut) . "'";
        $sql .= " , fk_user = " . ((int) $this->fk_user);
        $sql .= " , fk_user_modif = " . ((int) $user->id);
        $sql .= " , fk_soc = " . ($this->socid > 0 ? $this->socid : 'null');
        $sql .= " , note_private = " . ($this->note_private ? "'" . $this->db->escape($this->note_private) . "'" : "null");
        $sql .= " , note_public = " . ($this->note_public ? "'" . $this->db->escape($this->note_public) . "'" : "null");
        $sql .= " , fk_projet = " . ($this->fk_project > 0 ? $this->fk_project : 0);
        $sql .= " WHERE rowid = " . ((int) $this->id);

        dol_syslog(get_class($this) . "::update", LOG_DEBUG);
        $result = $this->db->query($sql);
        if ($result) {
            $this->db->commit();
            return 1;
        } else {
            $this->error = $this->db->lasterror();
            $this->db->rollback();
            return -1;
        }
    }

    /**
     * Load an object from database
     *
     * @param   int     $id     Id of record to load
     * @param   string  $ref    Ref of record
     * @return  int             Return integer <0 if KO, >0 if OK
     */
    public function fetch($id, $ref = '')
    {
        $sql = "SELECT rowid, fk_user, type, fk_statut, km, fk_soc, dated, note_private, note_public, fk_projet as fk_project, extraparams";
        $sql .= " FROM " . MAIN_DB_PREFIX . "deplacement";
        $sql .= " WHERE entity IN (" . getEntity('deplacement') . ")";
        if ($ref) {
            $sql .= " AND ref ='" . $this->db->escape($ref) . "'";
        } else {
            $sql .= " AND rowid = " . ((int) $id);
        }

        dol_syslog(get_class($this) . "::fetch", LOG_DEBUG);
        $result = $this->db->query($sql);
        if ($result) {
            $obj = $this->db->fetch_object($result);

            $this->id = $obj->rowid;
            $this->ref = $obj->rowid;
            $this->date         = $this->db->jdate($obj->dated);
            $this->fk_user = $obj->fk_user;
            $this->socid        = $obj->fk_soc;
            $this->km = $obj->km;
            $this->type         = $obj->type;
            $this->statut       = $obj->fk_statut;
            $this->note_private = $obj->note_private;
            $this->note_public  = $obj->note_public;
            $this->fk_project   = $obj->fk_project;

            $this->extraparams  = (array) json_decode($obj->extraparams, true);

            return 1;
        } else {
            $this->error = $this->db->error();
            return -1;
        }
    }

    /**
     *  Delete record
     *
     *  @param  User    $user       USer that Delete
     *  @return int             Return integer <0 if KO, >0 if OK
     */
    public function delete($user)
    {
        $this->db->begin();

        $id = $this->id;

        $sql = "DELETE FROM " . MAIN_DB_PREFIX . "deplacement WHERE rowid = " . ((int) $id);

        dol_syslog(get_class($this) . "::delete", LOG_DEBUG);
        $result = $this->db->query($sql);
        if ($result) {
            $this->db->commit();
            return 1;
        } else {
            $this->error = $this->db->error();
            $this->db->rollback();
            return -1;
        }
    }


    /**
     *  Return the label of the status
     *
     *  @param  int     $mode          0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
     *  @return string                 Label of status
     */
    public function getLibStatut($mode = 0)
    {
        return $this->LibStatut($this->statut, $mode);
    }

	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
    /**
     *  Return the label of a given status
     *
     *  @param  int     $status        Id status
     *  @param  int     $mode          0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
     *  @return string                 Label of status
     */
    public function LibStatut($status, $mode = 0)
    {
		// phpcs:enable
        global $langs;

        if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
            global $langs;
            //$langs->load("mymodule@mymodule");
            $this->labelStatus[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
            $this->labelStatus[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Validated');
            $this->labelStatus[self::STATUS_REFUNDED] = $langs->transnoentitiesnoconv('Refunded');
            $this->labelStatusShort[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
            $this->labelStatusShort[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Validated');
            $this->labelStatusShort[self::STATUS_REFUNDED] = $langs->transnoentitiesnoconv('Refunded');
        }

        $status_logo = array(0 => 'status0', 1 => 'status4', 2 => 'status1', 4 => 'status6', 5 => 'status4', 6 => 'status6', 99 => 'status5');
        $statusType = $status_logo[$status];

        return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
    }

    /**
     *  Return clicable name (with picto eventually)
     *
     *  @param      int     $withpicto      0=No picto, 1=Include picto into link, 2=Only picto
     *  @return     string                  Chaine avec URL
     */
    public function getNomUrl($withpicto = 0)
    {
        global $langs;

        $result = '';
        $label = $langs->trans("Show") . ': ' . $this->ref;

        $link = '<a href="' . constant('BASE_URL') . '/compta/deplacement/card.php?id=' . $this->id . '" title="' . dol_escape_htmltag($label, 1) . '" class="classfortooltip">';
        $linkend = '</a>';

        $picto = 'trip';


        if ($withpicto) {
            $result .= ($link . img_object($label, $picto, 'class="classfortooltip"') . $linkend);
        }
        if ($withpicto && $withpicto != 2) {
            $result .= ' ';
        }
        if ($withpicto != 2) {
            $result .= $link . $this->ref . $linkend;
        }
        return $result;
    }


    /**
     * List of types
     *
     * @param   int     $active     Active or not
     * @return  array
     */
    public function listOfTypes($active = 1)
    {
        global $langs;

        $ret = array();

        $sql = "SELECT id, code, label";
        $sql .= " FROM " . MAIN_DB_PREFIX . "c_type_fees";
        $sql .= " WHERE active = " . ((int) $active);

        dol_syslog(get_class($this) . "::listOfTypes", LOG_DEBUG);
        $result = $this->db->query($sql);
        if ($result) {
            $num = $this->db->num_rows($result);
            $i = 0;
            while ($i < $num) {
                $obj = $this->db->fetch_object($result);
                $ret[$obj->code] = (($langs->trans($obj->code) != $obj->code) ? $langs->trans($obj->code) : $obj->label);
                $i++;
            }
        } else {
            dol_print_error($this->db);
        }

        return $ret;
    }

    /**
     * Information on record
     *
     * @param   int     $id      Id of record
     * @return  void
     */
    public function info($id)
    {
        $sql = 'SELECT c.rowid, c.datec, c.fk_user_author, c.fk_user_modif,';
        $sql .= ' c.tms as datem';
        $sql .= ' FROM ' . MAIN_DB_PREFIX . 'deplacement as c';
        $sql .= ' WHERE c.rowid = ' . ((int) $id);

        dol_syslog(get_class($this) . '::info', LOG_DEBUG);
        $result = $this->db->query($sql);

        if ($result) {
            if ($this->db->num_rows($result)) {
                $obj = $this->db->fetch_object($result);

                $this->id = $obj->rowid;

                $this->user_creation_id = $obj->fk_user_author;
                $this->user_modification_id = $obj->fk_user_modif;
                $this->date_creation     = $this->db->jdate($obj->datec);
                $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
            }
            $this->db->free($result);
        } else {
            dol_print_error($this->db);
        }
    }
}