Wavyzz/dolibarr-fork
2
0
Fork 0
forked from Wavyzz/dolibarr
Code Pull Requests Activity
Files
901b9dab72357dad4e162f94d6b53e1e84d20dd5
dolibarr-fork/htdocs/fourn/class/fournisseur.facture-rec.class.php
MDW ec2a1928ba Qual: Update fields phpdoc to include fields that are defined/used in some cases 
# Qual: Update fields phpdoc to include fields that are defined/used in some cases

comment, copytoclipboard, autofocusoncreated are documented and used in some cases for the
$fields definition
2024-12-05 02:36:50 +01:00

2066 lines
79 KiB
PHP
Raw Blame History

<?php
/* Copyright (C) 2003-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004-2019 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2009-2012 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2010-2011 Juanjo Menent <jmenent@2byte.es>
* Copyright (C) 2012 Cedric Salvador <csalvador@gpcsolutions.fr>
* Copyright (C) 2013 Florian Henry <florian.henry@open-concept.pro>
* Copyright (C) 2015 Marcos García <marcosgdf@gmail.com>
* Copyright (C) 2017-2024 Frédéric France <frederic.france@free.fr>
* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
* Copyright (C) 2023-2024 Nick Fragoulis
*
* 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/>.
*/
/**
* \file htdocs/fourn/facture/class/fournisseur.facture-rec.class.php
* \ingroup invoice
* \brief File for class to manage invoice templates
*/
require_once DOL_DOCUMENT_ROOT.'/core/class/notify.class.php';
require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.facture.class.php';
require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.facture-rec.ligne.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
/**
* Class to manage invoice templates
*/
class FactureFournisseurRec extends CommonInvoice
{
const TRIGGER_PREFIX = 'SUPPLIERBILLREC';
/**
* @var string ID to identify managed object
*/
public $element = 'invoice_supplier_rec';
/**
* @var string Name of table without prefix where object is stored
*/
public $table_element = 'facture_fourn_rec';
/**
* @var string Name of subtable line
*/
public $table_element_line = 'facture_fourn_det_rec';
/**
* @var string Field with ID of parent key if this field has a parent
*/
public $fk_element = 'fk_facture_fourn';
/**
* @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
*/
public $picto = 'bill';
/**
* {@inheritdoc}
*/
protected $table_ref_field = 'titre';
/**
* @var string The label of recurring invoice
* @deprecated Use $title
*/
public $titre;
/**
* @var string The label of recurring invoice
*/
public $title;
/**
* @var string
* @deprecated
*/
public $ref_supplier;
/**
* @var int
*/
public $socid;
/**
* @var int
* @deprecated
*/
public $fk_soc;
/**
* @var int
*/
public $suspended; // status
/**
* @var string Label of invoice
* @deprecated Use $label
*/
public $libelle;
/**
* @var string Label of invoice
*/
public $label;
/**
* @var float $amount
* @deprecated
*/
public $amount;
/**
* @var float
* @deprecated
*/
public $remise;
/**
* @var string
*/
public $vat_src_code;
/**
* @var float
*/
public $localtax1;
/**
* @var float
*/
public $localtax2;
/**
* @var User
*/
public $user_author;
/**
* @var int
*/
public $user_modif;
/**
* @var int
*/
public $fk_project;
/**
* @var int
*/
public $mode_reglement_id;
/**
* @var string
*/
public $mode_reglement_code;
/**
* @var string
*/
public $cond_reglement_code;
/**
* @var string
*/
public $cond_reglement_doc;
/**
* @var int
*/
public $cond_reglement_id;
/**
* @var int Deadline for payment
*/
public $date_lim_reglement;
/**
* @var int<0,1>
*/
public $usenewprice = 0;
/**
* @var int
*/
public $frequency;
/**
* @var string
*/
public $unit_frequency;
/**
* @var ?int
*/
public $date_when;
/**
* @var ?int
*/
public $date_last_gen;
/**
* @var int nb generation done
*/
public $nb_gen_done;
/**
* @var int nb generation max
*/
public $nb_gen_max;
/**
* @var int<0,1> auto validate 0 to create in draft, 1 to create and validate the new invoice
*/
public $auto_validate; //
/**
* @var ?int<0,1>
*/
public $generate_pdf; // 1 to generate PDF on invoice generation (default)
/**
* Invoice lines
* @var CommonInvoiceLine[]
*/
public $lines = array();
/* Override fields in CommonObject
public $entity;
public $total_ht;
public $total_tva;
public $total_ttc;
public $fk_account;
public $mode_reglement;
public $cond_reglement;
public $note_public;
public $note_private;
*/
/**
* 'type' if the field format ('integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter]]', 'varchar(x)', 'double(24,8)', 'real', 'price', 'text', 'html', 'date', 'datetime', 'timestamp', 'duration', 'mail', 'phone', 'url', 'password')
* Note: Filter can be a string like "(t.ref:like:'SO-%') or (t.date_creation:<:'20160101') or (t.nature:is:NULL)"
* 'label' the translation key.
* 'enabled' is a condition when the field must be managed.
* 'position' is the sort order of field.
* 'notnull' is set to 1 if not null in database. Set to -1 if we must set data to null if empty ('' or 0).
* 'visible' says if field is visible in list (Examples: 0=Not visible, 1=Visible on list and create/update/view forms, 2=Visible on list only, 3=Visible on create/update/view form only (not list), 4=Visible on list and update/view form only (not create). 5=Visible on list and view only (not create/not update). Using a negative value means field is not shown by default on list but can be selected for viewing)
* 'noteditable' says if field is not editable (1 or 0)
* 'default' is a default value for creation (can still be overwrote by the Setup of Default Values if field is editable in creation form). Note: If default is set to '(PROV)' and field is 'ref', the default value will be set to '(PROVid)' where id is rowid when a new record is created.
* 'index' if we want an index in database.
* 'foreignkey'=>'tablename.field' if the field is a foreign key (it is recommended to name the field fk_...).
* 'searchall' is 1 if we want to search in this field when making a search from the quick search button.
* 'isameasure' must be set to 1 if you want to have a total on list for this field. Field type must be summable like integer or double(24,8).
* 'css' is the CSS style to use on field. For example: 'maxwidth200'
* 'help' is a string visible as a tooltip on field
* 'showoncombobox' if value of the field must be visible into the label of the combobox that list record
* 'disabled' is 1 if we want to have the field locked by a 'disabled' attribute. In most cases, this is never set into the definition of $fields into class, but is set dynamically by some part of code.
* 'arrayofkeyval' to set list of value if type is a list of predefined values. For example: array("0"=>"Draft","1"=>"Active","-1"=>"Cancel")
* 'comment' is not used. You can store here any text of your choice. It is not used by application.
*
* Note: To have value dynamic, you can set value to 0 in definition and edit the value on the fly into the constructor.
*/
// BEGIN MODULEBUILDER PROPERTIES
/**
* @var array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int<-5,5>|string,alwayseditable?:int<0,1>,noteditable?:int<0,1>,default?:string,index?:int,foreignkey?:string,searchall?:int<0,1>,isameasure?:int<0,1>,css?:string,csslist?:string,help?:string,showoncombobox?:int<0,4>,disabled?:int<0,1>,arrayofkeyval?:array<int|string,string>,autofocusoncreate?:int<0,1>,comment?:string,copytoclipboard?:int<1,2>,validate?:int<0,1>,showonheader?:int<0,1>}> Array with all fields and their property. Do not use it as a static var. It may be modified by constructor.
*/
public $fields = array(
'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 10),
'titre' => array('type' => 'varchar(100)', 'label' => 'Titre', 'enabled' => 1, 'showoncombobox' => 1, 'visible' => -1, 'position' => 15),
'ref_supplier' => array('type' => 'varchar(180)', 'label' => 'RefSupplier', 'enabled' => 1, 'showoncombobox' => 1, 'visible' => -1, 'position' => 20),
'entity' => array('type' => 'integer', 'label' => 'Entity', 'default' => '1', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 25, 'index' => 1),
'fk_soc' => array('type' => 'integer:Societe:societe/class/societe.class.php', 'label' => 'ThirdParty', 'enabled' => 'isModEnabled("societe")', 'visible' => -1, 'notnull' => 1, 'position' => 30),
'datec' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => -1, 'position' => 35),
'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 40),
'suspended' => array('type' => 'integer', 'label' => 'Suspended', 'enabled' => 1, 'visible' => -1, 'position' => 225),
'libelle' => array('type' => 'varchar(100)', 'label' => 'Libelle', 'enabled' => 1, 'showoncombobox' => 0, 'visible' => -1, 'position' => 15),
'localtax1' => array('type' => 'double(24,8)', 'label' => 'Localtax1', 'enabled' => 1, 'visible' => -1, 'position' => 60, 'isameasure' => 1),
'localtax2' => array('type' => 'double(24,8)', 'label' => 'Localtax2', 'enabled' => 1, 'visible' => -1, 'position' => 65, 'isameasure' => 1),
'total_ht' => array('type' => 'double(24,8)', 'label' => 'Total', 'enabled' => 1, 'visible' => -1, 'position' => 70, 'isameasure' => 1),
'total_tva' => array('type' => 'double(24,8)', 'label' => 'Tva', 'enabled' => 1, 'visible' => -1, 'position' => 55, 'isameasure' => 1),
'total_ttc' => array('type' => 'double(24,8)', 'label' => 'Total ttc', 'enabled' => 1, 'visible' => -1, 'position' => 75, 'isameasure' => 1),
'fk_user_author' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'Fk user author', 'enabled' => 1, 'visible' => -1, 'position' => 80),
'fk_user_modif' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserModif', 'enabled' => 1, 'visible' => -2, 'notnull' => -1, 'position' => 210),
'fk_projet' => array('type' => 'integer:Project:projet/class/project.class.php:1:fk_statut=1', 'label' => 'Fk projet', 'enabled' => "isModEnabled('project')", 'visible' => -1, 'position' => 85),
'fk_account' => array('type' => 'integer', 'label' => 'Fk account', 'enabled' => 'isModEnabled("bank")', 'visible' => -1, 'position' => 175),
'fk_cond_reglement' => array('type' => 'integer', 'label' => 'Fk cond reglement', 'enabled' => 1, 'visible' => -1, 'position' => 90),
'fk_mode_reglement' => array('type' => 'integer', 'label' => 'Fk mode reglement', 'enabled' => 1, 'visible' => -1, 'position' => 95),
'date_lim_reglement' => array('type' => 'date', 'label' => 'Date lim reglement', 'enabled' => 1, 'visible' => -1, 'position' => 100),
'note_private' => array('type' => 'html', 'label' => 'NotePublic', 'enabled' => 1, 'visible' => 0, 'position' => 105),
'note_public' => array('type' => 'html', 'label' => 'NotePrivate', 'enabled' => 1, 'visible' => 0, 'position' => 110),
'modelpdf' => array('type' => 'varchar(255)', 'label' => 'Modelpdf', 'enabled' => 1, 'visible' => -1, 'position' => 115),
'fk_multicurrency' => array('type' => 'integer', 'label' => 'Fk multicurrency', 'enabled' => 1, 'visible' => -1, 'position' => 180),
'multicurrency_code' => array('type' => 'varchar(255)', 'label' => 'Multicurrency code', 'enabled' => 1, 'visible' => -1, 'position' => 185),
'multicurrency_tx' => array('type' => 'double(24,8)', 'label' => 'Multicurrency tx', 'enabled' => 1, 'visible' => -1, 'position' => 190, 'isameasure' => 1),
'multicurrency_total_ht' => array('type' => 'double(24,8)', 'label' => 'Multicurrency total ht', 'enabled' => 1, 'visible' => -1, 'position' => 195, 'isameasure' => 1),
'multicurrency_total_tva' => array('type' => 'double(24,8)', 'label' => 'Multicurrency total tva', 'enabled' => 1, 'visible' => -1, 'position' => 200, 'isameasure' => 1),
'multicurrency_total_ttc' => array('type' => 'double(24,8)', 'label' => 'Multicurrency total ttc', 'enabled' => 1, 'visible' => -1, 'position' => 205, 'isameasure' => 1),
'usenewprice' => array('type' => 'integer', 'label' => 'UseNewPrice', 'enabled' => 1, 'visible' => 0, 'position' => 155),
'frequency' => array('type' => 'integer', 'label' => 'Frequency', 'enabled' => 1, 'visible' => -1, 'position' => 150),
'unit_frequency' => array('type' => 'varchar(2)', 'label' => 'Unit frequency', 'enabled' => 1, 'visible' => -1, 'position' => 125),
'date_when' => array('type' => 'datetime', 'label' => 'Date when', 'enabled' => 1, 'visible' => -1, 'position' => 130),
'date_last_gen' => array('type' => 'datetime', 'label' => 'Date last gen', 'enabled' => 1, 'visible' => -1, 'position' => 135),
'nb_gen_done' => array('type' => 'integer', 'label' => 'Nb gen done', 'enabled' => 1, 'visible' => -1, 'position' => 140),
'nb_gen_max' => array('type' => 'integer', 'label' => 'Nb gen max', 'enabled' => 1, 'visible' => -1, 'position' => 145),
'revenuestamp' => array('type' => 'double(24,8)', 'label' => 'RevenueStamp', 'enabled' => 1, 'visible' => -1, 'position' => 160, 'isameasure' => 1),
'auto_validate' => array('type' => 'integer', 'label' => 'Auto validate', 'enabled' => 1, 'visible' => -1, 'position' => 165),
'generate_pdf' => array('type' => 'integer', 'label' => 'Generate pdf', 'enabled' => 1, 'visible' => -1, 'position' => 170),
);
// END MODULEBUILDER PROPERTIES
const STATUS_NOTSUSPENDED = 0;
const STATUS_SUSPENDED = 1;
/**
* Constructor
*
* @param DoliDB $db Database handler
*/
public function __construct($db)
{
$this->db = $db;
}
/**
* Create a predefined supplier invoice
*
* @param User $user User object
* @param int $facFournId Id invoice
* @param int $notrigger No trigger
* @return int Return integer <0 if KO, id of invoice created if OK
*/
public function create($user, $facFournId, $notrigger = 0)
{
global $conf;
$error = 0;
$now = dol_now();
// Clean parameters
$this->titre = empty($this->titre) ? '' : $this->titre; // deprecated
$this->title = empty($this->title) ? '' : $this->title;
$keyforref = $this->table_ref_field;
$this->ref = $this->$keyforref;
$this->ref_supplier = empty($this->ref_supplier) ? '' : $this->ref_supplier;
$this->usenewprice = empty($this->usenewprice) ? 0 : $this->usenewprice;
$this->suspended = empty($this->suspended) ? 0 : $this->suspended;
// No frequency defined then no next date to execution
if (empty($this->frequency)) {
$this->frequency = 0;
$this->date_when = null;
}
$this->frequency = abs($this->frequency);
$this->nb_gen_done = 0;
$this->nb_gen_max = empty($this->nb_gen_max) ? 0 : $this->nb_gen_max;
$this->auto_validate = empty($this->auto_validate) ? 0 : $this->auto_validate;
$this->generate_pdf = empty($this->generate_pdf) ? 0 : $this->generate_pdf;
$this->db->begin();
// On charge la facture fournisseur depuis laquelle on crée la facture fournisseur modèle
$facfourn_src = new FactureFournisseur($this->db);
$result = $facfourn_src->fetch($facFournId);
if ($result > 0) {
$sql = 'INSERT INTO '.MAIN_DB_PREFIX.'facture_fourn_rec (';
$sql .= 'titre';
$sql .= ", subtype";
$sql .= ', ref_supplier';
$sql .= ', entity';
$sql .= ', fk_soc';
$sql .= ', datec';
$sql .= ', suspended';
$sql .= ', libelle';
$sql .= ', total_ttc';
$sql .= ', fk_user_author';
$sql .= ', fk_projet';
$sql .= ', fk_account';
$sql .= ', fk_cond_reglement';
$sql .= ', fk_mode_reglement';
$sql .= ', date_lim_reglement';
$sql .= ', note_private';
$sql .= ', note_public';
$sql .= ', modelpdf';
$sql .= ', fk_multicurrency';
$sql .= ', multicurrency_code';
$sql .= ', multicurrency_tx';
$sql .= ', usenewprice';
$sql .= ', frequency';
$sql .= ', unit_frequency';
$sql .= ', date_when';
$sql .= ', date_last_gen';
$sql .= ', nb_gen_done';
$sql .= ', nb_gen_max';
$sql .= ', auto_validate';
$sql .= ', generate_pdf';
$sql .= ') VALUES (';
$sql .= "'".$this->db->escape($this->title)."'";
$sql .= ", ".($this->subtype ? "'".$this->db->escape($this->subtype)."'" : "null");
$sql .= ", '".$this->db->escape($this->ref_supplier)."'";
$sql .= ", ".((int) $conf->entity);
$sql .= ", ".((int) $facfourn_src->socid);
$sql .= ", '".$this->db->idate($now)."'";
$sql .= ", ".((int) $this->suspended);
$sql .= ", '".$this->db->escape($this->libelle)."'";
$sql .= ", " .(!empty($facfourn_src->total_ttc) ? (float) $facfourn_src->total_ttc : '0'); // amount
$sql .= ", " .((int) $user->id);
$sql .= ", " .(!empty($this->fk_project) ? ((int) $this->fk_project) : 'NULL');
$sql .= ", " .(!empty($facfourn_src->fk_account) ? ((int) $facfourn_src->fk_account) : 'NULL');
$sql .= ", " .($this->cond_reglement_id > 0 ? (int) $this->cond_reglement_id : 'NULL');
$sql .= ", " .($this->mode_reglement_id > 0 ? (int) $this->mode_reglement_id : 'NULL');
$sql .= ", ".($facfourn_src->date_echeance > 0 ? "'".$this->db->idate($facfourn_src->date_echeance)."'" : 'NULL'); // date_lim_reglement
$sql .= ", " .(!empty($this->note_private) ? "'".$this->db->escape($this->note_private)."'" : 'NULL');
$sql .= ", " .(!empty($this->note_public) ? "'".$this->db->escape($this->note_public)."'" : 'NULL');
$sql .= ", " .(!empty($this->model_pdf) ? "'".$this->db->escape($this->model_pdf)."'" : 'NULL');
$sql .= ", " . (int) $facfourn_src->fk_multicurrency;
$sql .= ", '".$this->db->escape($facfourn_src->multicurrency_code)."'";
$sql .= ", " . (float) $facfourn_src->multicurrency_tx;
$sql .= ", " . (int) $this->usenewprice;
$sql .= ", " . (int) $this->frequency;
$sql .= ", '".$this->db->escape($this->unit_frequency)."'";
$sql .= ", " .(!empty($this->date_when) ? "'".$this->db->idate($this->date_when)."'" : 'NULL');
$sql .= ", " .(!empty($this->date_last_gen) ? "'".$this->db->idate($this->date_last_gen)."'" : 'NULL');
$sql .= ", " . (int) $this->nb_gen_done;
$sql .= ", " . (int) $this->nb_gen_max;
$sql .= ", " . (int) $this->auto_validate;
$sql .= ", " . (int) $this->generate_pdf;
$sql .= ')';
if ($this->db->query($sql)) {
$this->id = $this->db->last_insert_id(MAIN_DB_PREFIX. 'facture_fourn_rec');
// Fields used into addline later
$this->fk_multicurrency = $facfourn_src->fk_multicurrency;
$this->multicurrency_code = $facfourn_src->multicurrency_code;
$this->multicurrency_tx = $facfourn_src->multicurrency_tx;
// Add lines
$num = count($facfourn_src->lines);
for ($i = 0; $i < $num; $i++) {
$facfourn_line = $facfourn_src->lines[$i];
'@phan-var-force SupplierInvoiceLine $facfourn_line';
$tva_tx = $facfourn_line->tva_tx;
if (!empty($facfourn_line->vat_src_code) && !preg_match('/\(/', (string) $tva_tx)) {
$tva_tx .= ' ('.$facfourn_line->vat_src_code.')';
}
$result_insert = $this->addline(
$facfourn_line->fk_product,
$facfourn_line->ref_supplier,
$facfourn_line->product_label,
$facfourn_line->desc ? $facfourn_line->desc : $facfourn_line->description,
$facfourn_line->pu_ht,
$facfourn_line->pu_ttc,
$facfourn_line->qty,
$facfourn_line->remise_percent,
$tva_tx,
$facfourn_line->localtax1_tx,
$facfourn_line->localtax2_tx,
'HT',
$facfourn_line->product_type,
$facfourn_line->date_start,
$facfourn_line->date_end,
$facfourn_line->info_bits,
$facfourn_line->special_code,
$facfourn_line->rang,
$facfourn_line->fk_unit
);
if ($result_insert < 0) {
$error++;
} else {
$objectline = new FactureFournisseurLigneRec($this->db);
$result2 = $objectline->fetch($result_insert);
if ($result2 > 0) {
// Extrafields
if (method_exists($facfourn_line, 'fetch_optionals')) {
$facfourn_line->fetch_optionals($facfourn_line->id);
$objectline->array_options = $facfourn_line->array_options;
}
$result = $objectline->insertExtraFields();
if ($result < 0) {
$error++;
}
} elseif ($result2 < 0) {
$this->errors[] = $objectline->error;
$error++;
}
}
}
if (!empty($this->linkedObjectsIds) && empty($this->linked_objects)) { // To use new linkedObjectsIds instead of old linked_objects
$this->linked_objects = $this->linkedObjectsIds; // TODO Replace linked_objects with linkedObjectsIds
}
// Add object linked
if (!$error && $this->id && !empty($this->linked_objects) && is_array($this->linked_objects)) {
foreach ($this->linked_objects as $origin => $tmp_origin_id) {
if (is_array($tmp_origin_id)) { // New behaviour, if linked_object can have several links per type, so is something like array('contract'=>array(id1, id2, ...))
foreach ($tmp_origin_id as $origin_id) {
$ret = $this->add_object_linked($origin, $origin_id);
if (!$ret) {
$this->error = $this->db->lasterror();
$error++;
}
}
} else { // Old behaviour, if linked_object has only one link per type, so is something like array('contract'=>id1))
$origin_id = $tmp_origin_id;
$ret = $this->add_object_linked($origin, $origin_id);
if (!$ret) {
$this->error = $this->db->lasterror();
$error++;
}
}
}
}
if (!$error) {
$result = $this->insertExtraFields();
if ($result < 0) {
$error++;
}
}
if (!$error && !$notrigger) {
// Call trigger
$result = $this->call_trigger('SUPPLIERBILLREC_CREATE', $user);
if ($result < 0) {
$this->db->rollback();
return -2;
}
// End call triggers
}
if ($error) {
$this->db->rollback();
return -3;
} else {
$this->db->commit();
return $this->id;
}
} else {
$this->error = $this->db->lasterror();
$this->db->rollback();
return -2;
}
} else {
$this->db->rollback();
return -1;
}
}
/**
* Update fourn_invoice_rec.
*
* @param User $user User
* @param int $notrigger No trigger
* @return int Return integer <0 if KO, Id of line if OK
*/
public function update(User $user, $notrigger = 0)
{
$error = 0;
$sql = "UPDATE ".MAIN_DB_PREFIX."facture_fourn_rec SET";
$sql .= " titre = '" . (!empty($this->title) ? $this->db->escape($this->title) : "")."'," ;
$sql .= " subtype=".(isset($this->subtype) ? $this->db->escape($this->subtype) : "null").",";
$sql .= " ref_supplier = '". (!empty($this->ref_supplier) ? $this->db->escape($this->ref_supplier) : "")."',";
$sql .= " entity = ". (!empty($this->entity) ? ((int) $this->entity) : 1) . ',';
if (!empty($this->socid) && $this->socid > 0) {
$sql .= " fk_soc = ". ((int) $this->socid). ',';
} elseif (!empty($this->fk_soc) && $this->fk_soc > 0) { // For backward compatibility
$sql .= " fk_soc = ". ((int) $this->fk_soc). ',';
}
$sql .= " suspended = ". (!empty($this->suspended) ? ((int) $this->suspended) : 0) . ',';
$sql .= " libelle = ". (!empty($this->libelle) ? "'".$this->db->escape($this->libelle)."'" : 'NULL') . ",";
$sql .= " vat_src_code = ". (!empty($this->vat_src_code) ? "'".$this->db->escape($this->vat_src_code)."'" : 'NULL') . ',';
$sql .= " localtax1 = ". (!empty($this->localtax1) ? ((float) $this->localtax1) : 0.00) . ',';
$sql .= " localtax2 = ". (!empty($this->localtax2) ? ((float) $this->localtax2) : 0.00) . ',';
$sql .= " total_ht = ". (!empty($this->total_ht) ? ((float) $this->total_ht) : 0.00) . ',';
$sql .= " total_tva = ". (!empty($this->total_tva) ? ((float) $this->total_tva) : 0.00) . ',';
$sql .= " total_ttc = ". (!empty($this->total_ttc) ? ((float) $this->total_ttc) : 0.00) . ',';
$sql .= " fk_user_modif = ". ((int) $user->id) . ',';
$sql .= " fk_projet = ". (!empty($this->fk_project) ? ((int) $this->fk_project) : 'NULL') . ',';
$sql .= " fk_account = ". (!empty($this->fk_account) ? ((int) $this->fk_account) : 'NULL') . ',';
$sql .= " fk_mode_reglement = ". (!empty($this->mode_reglement_id) ? ((int) $this->mode_reglement_id) : 'NULL') . ',';
$sql .= " fk_cond_reglement = ". (!empty($this->cond_reglement_id) ? ((int) $this->cond_reglement_id) : 'NULL') . ',';
$sql .= " date_lim_reglement = ". (!empty($this->date_lim_reglement) ? "'".$this->db->idate($this->date_lim_reglement)."'" : 'NULL') . ',';
$sql .= " note_private = '". (!empty($this->note_private) ? $this->db->escape($this->note_private) : '') . "',";
$sql .= " note_public = '". (!empty($this->note_public) ? $this->db->escape($this->note_public) : '') . "',";
$sql .= " modelpdf = ". (!empty($this->model_pdf) ? "'".$this->db->escape($this->model_pdf)."'" : 'NULL') . ",";
$sql .= " fk_multicurrency = ". (!empty($this->fk_multicurrency) ? ((int) $this->fk_multicurrency) : 'NULL') . ',';
$sql .= " multicurrency_code = ". (!empty($this->multicurrency_code) ? "'".$this->db->escape($this->multicurrency_code)."'" : 'NULL') . ",";
$sql .= " multicurrency_tx = ". (!empty($this->multicurrency_tx) ? ((float) $this->multicurrency_tx) : 1) . ',';
$sql .= " multicurrency_total_ht = ". (!empty($this->multicurrency_total_ht) ? ((float) $this->multicurrency_total_ht) : 0.00) . ',';
$sql .= " multicurrency_total_tva = ". (!empty($this->multicurrency_total_tva) ? ((float) $this->multicurrency_total_tva) : 0.00) . ',';
$sql .= " multicurrency_total_ttc = ". (!empty($this->multicurrency_total_ttc) ? ((float) $this->multicurrency_total_ttc) : 0.00) . ',';
$sql .= " usenewprice = ". (!empty($this->usenewprice) ? ((int) $this->usenewprice) : 0) . ',';
$sql .= " frequency = ". (!empty($this->frequency) ? ((int) $this->frequency) : 0). ',';
$sql .= " unit_frequency = '". (!empty($this->unit_frequency) ? $this->db->escape($this->unit_frequency) : ''). "',";
$sql .= " date_when = ". (!empty($this->date_when) ? "'".$this->db->idate($this->date_when)."'" : 'NULL') . ',';
$sql .= " date_last_gen = ". (!empty($this->date_last_gen) ? "'".$this->db->idate($this->date_last_gen)."'" : 'NULL') . ',';
$sql .= " nb_gen_done = ". (!empty($this->nb_gen_done) ? ((int) $this->nb_gen_done) : 0) . ',';
$sql .= " nb_gen_max = ". (!empty($this->nb_gen_max) ? ((int) $this->nb_gen_max) : 0) . ',';
$sql .= " auto_validate = ". (!empty($this->auto_validate) ? ((int) $this->auto_validate) : 0);
$sql .= " WHERE rowid = ". (int) $this->id;
$this->db->begin();
dol_syslog(get_class($this)."::update", LOG_DEBUG);
$resql = $this->db->query($sql);
if ($resql) {
if (!$error) {
$result = $this->insertExtraFields();
if ($result < 0) {
$error++;
}
}
if (!$error && !$notrigger) {
// Call trigger
$result = $this->call_trigger('SUPPLIERBILLREC_MODIFY', $user);
if ($result < 0) {
$this->db->rollback();
return -2;
}
// End call triggers
}
$this->db->commit();
return 1;
} else {
$this->error = $this->db->lasterror();
$this->db->rollback();
return -2;
}
}
/**
* Load object and lines
*
* @param int $rowid Id of object to load
* @param string $ref Reference of recurring invoice
* @param string $ref_ext External reference of invoice
* @return int >0 if OK, <0 if KO, 0 if not found
*/
public function fetch($rowid, $ref = '', $ref_ext = '')
{
$sql = 'SELECT f.rowid, f.titre as title, f.subtype, f.ref_supplier, f.entity, f.fk_soc';
$sql .= ', f.datec, f.tms, f.suspended';
$sql .= ', f.libelle as label';
$sql .= ', f.vat_src_code, f.localtax1, f.localtax2';
$sql .= ', f.total_tva, f.total_ht, f.total_ttc';
$sql .= ', f.fk_user_author, f.fk_user_modif';
$sql .= ', f.fk_projet as fk_project, f.fk_account';
$sql .= ', f.fk_mode_reglement, p.code as mode_reglement_code, p.libelle as mode_reglement_libelle';
$sql .= ', f.fk_cond_reglement, c.code as cond_reglement_code, c.libelle as cond_reglement_libelle, c.libelle_facture as cond_reglement_libelle_doc';
$sql .= ', f.date_lim_reglement';
$sql .= ', f.note_private, f.note_public, f.modelpdf as model_pdf';
$sql .= ', f.fk_multicurrency, f.multicurrency_code, f.multicurrency_tx, f.multicurrency_total_ht, f.multicurrency_total_tva, f.multicurrency_total_ttc';
$sql .= ', f.usenewprice, f.frequency, f.unit_frequency, f.date_when, f.date_last_gen, f.nb_gen_done, f.nb_gen_max, f.auto_validate';
$sql .= ', f.generate_pdf';
$sql .= ' FROM '.MAIN_DB_PREFIX.'facture_fourn_rec as f';
$sql .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_payment_term as c ON f.fk_cond_reglement = c.rowid';
$sql .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_paiement as p ON f.fk_mode_reglement = p.id';
$sql .= ' WHERE f.entity IN ('.getEntity('invoice').')';
if ($rowid) {
$sql .= ' AND f.rowid='. (int) $rowid;
} elseif ($ref) {
$sql .= " AND f.titre='".$this->db->escape($ref)."'";
} else {
$sql .= ' AND f.rowid = 0';
}
$result = $this->db->query($sql);
if ($result) {
if ($this->db->num_rows($result)) {
$obj = $this->db->fetch_object($result);
$keyforref = $this->table_ref_field;
$this->id = $obj->rowid;
$this->titre = $obj->title;
$this->title = $obj->title;
$this->subtype = $obj->subtype;
$this->ref = $obj->title;
$this->ref_supplier = $obj->ref_supplier;
$this->entity = $obj->entity;
$this->socid = $obj->fk_soc;
$this->date_creation = $obj->datec;
$this->date_modification = $obj->tms;
$this->suspended = $obj->suspended;
$this->libelle = $obj->label;
$this->label = $obj->label;
$this->vat_src_code = $obj->vat_src_code;
$this->total_localtax1 = $obj->localtax1;
$this->total_localtax2 = $obj->localtax2;
$this->total_ht = $obj->total_ht;
$this->total_tva = $obj->total_tva;
$this->total_ttc = $obj->total_ttc;
$this->user_author = $obj->fk_user_author;
$this->user_modif = $obj->fk_user_modif;
$this->fk_project = $obj->fk_project;
$this->fk_account = $obj->fk_account;
$this->mode_reglement_id = $obj->fk_mode_reglement;
$this->mode_reglement_code = $obj->mode_reglement_code;
$this->mode_reglement = $obj->mode_reglement_libelle;
$this->cond_reglement_id = $obj->fk_cond_reglement;
$this->cond_reglement_code = $obj->cond_reglement_code;
$this->cond_reglement = $obj->cond_reglement_libelle;
$this->cond_reglement_doc = $obj->cond_reglement_libelle_doc;
$this->date_lim_reglement = $this->db->jdate($obj->date_lim_reglement);
$this->note_private = $obj->note_private;
$this->note_public = $obj->note_public;
$this->model_pdf = $obj->model_pdf;
// Multicurrency
$this->fk_multicurrency = $obj->fk_multicurrency;
$this->multicurrency_code = $obj->multicurrency_code;
$this->multicurrency_tx = $obj->multicurrency_tx;
$this->multicurrency_total_ht = $obj->multicurrency_total_ht;
$this->multicurrency_total_tva = $obj->multicurrency_total_tva;
$this->multicurrency_total_ttc = $obj->multicurrency_total_ttc;
$this->usenewprice = $obj->usenewprice;
$this->frequency = $obj->frequency;
$this->unit_frequency = $obj->unit_frequency;
$this->date_when = $this->db->jdate($obj->date_when);
$this->date_last_gen = $this->db->jdate($obj->date_last_gen);
$this->nb_gen_done = $obj->nb_gen_done;
$this->nb_gen_max = $obj->nb_gen_max;
$this->auto_validate = $obj->auto_validate;
$this->generate_pdf = $obj->generate_pdf;
// Retrieve all extrafield
// fetch optionals attributes and labels
$this->fetch_optionals();
/*
* Lines
*/
$result = $this->fetch_lines();
if ($result < 0) {
$this->error = $this->db->lasterror();
return -3;
}
return 1;
} else {
$this->error = 'Bill with id '.$rowid.' or ref '.$ref.' not found';
dol_syslog('Facture::Fetch Error '.$this->error, LOG_ERR);
return -2;
}
} else {
$this->error = $this->db->error();
return -1;
}
}
/**
* Create an array of invoice lines
*
* @return int >0 if OK, <0 if KO
*/
public function getLinesArray()
{
return $this->fetch_lines();
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
/**
* Get lines of template invoices into this->lines
*
* @return int 1 if OK, < 0 if KO
*/
public function fetch_lines()
{
// phpcs:enable
$this->lines = array();
// Retrieve all extrafield for line
// fetch optionals attributes and labels
/*if (!is_object($extrafields)) {
require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
$extrafields = new ExtraFields($this->db);
}
$extrafields->fetch_name_optionals_label($this->table_element_line, true);
*/
$sql = 'SELECT l.rowid,';
$sql .= ' l.fk_facture_fourn, l.fk_parent_line, l.fk_product, l.ref, l.label, l.description as line_desc,';
$sql .= ' l.pu_ht, l.pu_ttc, l.qty, l.remise_percent, l.fk_remise_except, l.vat_src_code, l.tva_tx,';
$sql .= ' l.localtax1_tx, l.localtax2_tx, l.localtax1_type, l.localtax2_type,';
$sql .= ' l.total_ht, l.total_tva, l.total_ttc, total_localtax1, total_localtax2,';
$sql .= ' l.product_type, l.date_start, l.date_end,';
$sql .= ' l.info_bits, l.special_code, l.rang,';
$sql .= ' l.fk_unit, l.import_key, l.fk_user_author, l.fk_user_modif,';
$sql .= ' l.fk_multicurrency, l.multicurrency_code, l.multicurrency_subprice, l.multicurrency_total_ht, l.multicurrency_total_tva, l.multicurrency_total_ttc,';
$sql .= ' p.ref as product_ref, p.fk_product_type as fk_product_type, p.label as product_label, p.description as product_desc';
$sql .= ' FROM '.MAIN_DB_PREFIX.'facture_fourn_det_rec as l';
$sql .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product as p ON l.fk_product = p.rowid';
$sql .= ' WHERE l.fk_facture_fourn = '. (int) $this->id;
$sql .= ' ORDER BY l.rang';
dol_syslog('FactureFournisseurRec::fetch_lines', LOG_DEBUG);
$result = $this->db->query($sql);
if ($result) {
$num = $this->db->num_rows($result);
$i = 0;
while ($i < $num) {
$objp = $this->db->fetch_object($result);
$line = new FactureFournisseurLigneRec($this->db);
$line->id = $objp->rowid;
$line->fk_facture_fourn = $objp->fk_facture_fourn;
$line->fk_parent = $objp->fk_parent_line;
$line->fk_product = $objp->fk_product;
$line->ref_supplier = $objp->ref;
$line->label = $objp->label;
$line->description = $objp->line_desc;
$line->desc = $objp->line_desc;
$line->pu_ht = $objp->pu_ht;
$line->pu_ttc = $objp->pu_ttc;
$line->qty = $objp->qty;
$line->remise_percent = $objp->remise_percent;
$line->fk_remise_except = $objp->fk_remise_except;
$line->vat_src_code = $objp->vat_src_code;
$line->tva_tx = $objp->tva_tx;
$line->localtax1_tx = $objp->localtax1_tx;
$line->localtax1_type = $objp->localtax1_type;
$line->localtax2_tx = $objp->localtax2_tx;
$line->localtax2_type = $objp->localtax2_type;
$line->total_ht = $objp->total_ht;
$line->total_tva = $objp->total_tva;
$line->total_localtax1 = $objp->total_localtax1;
$line->total_localtax2 = $objp->total_localtax2;
$line->total_ttc = $objp->total_ttc;
$line->product_type = $objp->product_type;
$line->date_start = $objp->date_start;
$line->date_end = $objp->date_end;
$line->info_bits = $objp->info_bits ;
$line->special_code = $objp->special_code;
$line->rang = $objp->rang;
$line->fk_unit = $objp->fk_unit;
$line->import_key = $objp->import_key;
$line->fk_user_author = $objp->fk_user_author;
$line->fk_user_modif = $objp->fk_user_modif;
$line->fk_multicurrency = $objp->fk_multicurrency;
$line->multicurrency_code = $objp->multicurrency_code;
$line->multicurrency_subprice = $objp->multicurrency_subprice;
$line->multicurrency_total_ht = $objp->multicurrency_total_ht;
$line->multicurrency_total_tva = $objp->multicurrency_total_tva;
$line->multicurrency_total_ttc = $objp->multicurrency_total_ttc;
$line->fetch_optionals();
$this->lines[$i] = $line;
$i++;
}
$this->db->free($result);
return 1;
} else {
$this->error = $this->db->lasterror();
return -3;
}
}
/**
* Delete template invoice
*
* @param User $user User that delete.
* @param int $notrigger 1=Does not execute triggers, 0= execute triggers
* @param int $idwarehouse Id warehouse to use for stock change.
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete(User $user, $notrigger = 0, $idwarehouse = -1)
{
$rowid = $this->id;
dol_syslog(get_class($this)."::delete rowid=".((int) $rowid), LOG_DEBUG);
$error = 0;
$this->db->begin();
$main = MAIN_DB_PREFIX.'facture_fourn_det_rec';
$ef = $main."_extrafields";
$sqlef = "DELETE FROM ".$ef." WHERE fk_object IN (SELECT rowid FROM ".$main." WHERE fk_facture_fourn = ". (int) $rowid .")";
$sql = "DELETE FROM ".MAIN_DB_PREFIX."facture_fourn_det_rec WHERE fk_facture_fourn = ". (int) $rowid;
if ($this->db->query($sqlef) && $this->db->query($sql)) {
$sql = "DELETE FROM ".MAIN_DB_PREFIX."facture_fourn_rec WHERE rowid = ". (int) $rowid;
dol_syslog($sql);
if ($this->db->query($sql)) {
// Delete linked object
$res = $this->deleteObjectLinked();
if ($res < 0) {
$error = -3;
}
// Delete extrafields
$res = $this->deleteExtraFields();
if ($res < 0) {
$error = -4;
}
} else {
$this->error = $this->db->lasterror();
$error = -1;
}
} else {
$this->error = $this->db->lasterror();
$error = -2;
}
if (!$error && !$notrigger) {
// Call trigger
$result = $this->call_trigger('SUPPLIERBILLREC_DELETE', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
if (! $error) {
$this->db->commit();
return 1;
} else {
$this->db->rollback();
return $error;
}
}
/**
* Add a line to recursive supplier invoice
*
* @param int $fk_product Product/Service ID predefined
* @param string $ref Ref
* @param string $label Label
* @param string $desc Description de la ligne
* @param double $pu_ht Unit price
* @param double $pu_ttc Unit price with tax
* @param double $qty Quantity
* @param int $remise_percent Percentage discount of the line
* @param double $txtva Taux de tva force, sinon -1
* @param int $txlocaltax1 Local tax 1 rate (deprecated)
* @param int $txlocaltax2 Local tax 2 rate (deprecated)
* @param string $price_base_type HT or TTC
* @param int $type Type of line (0=product, 1=service)
* @param int $date_start Date start
* @param int $date_end Date end
* @param int $info_bits VAT npr or not ?
* @param int $special_code Special code
* @param int $rang Position of line
* @param string $fk_unit Unit
* @param int $pu_ht_devise Unit price in currency
* @return int Return integer <0 if KO, Id of line if OK
* @throws Exception
*/
public function addline($fk_product, $ref, $label, $desc, $pu_ht, $pu_ttc, $qty, $remise_percent, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $price_base_type = 'HT', $type = 0, $date_start = 0, $date_end = 0, $info_bits = 0, $special_code = 0, $rang = -1, $fk_unit = null, $pu_ht_devise = 0)
{
global $mysoc, $user;
include_once DOL_DOCUMENT_ROOT.'/core/lib/price.lib.php';
$facid = $this->id; //Supplier invoice template ID linked to
dol_syslog(get_class($this)."::addline facid=$facid,desc=$desc,pu_ht=$pu_ht,qty=$qty,txtva=$txtva,txlocaltax1=$txlocaltax1,txlocaltax2=$txlocaltax2,fk_product=$fk_product,remise_percent=$remise_percent,info_bits=$info_bits,price_base_type=$price_base_type,pu_ttc=$pu_ttc,type=$type,fk_unit=$fk_unit,pu_ht_devise=$pu_ht_devise,date_start_fill=$date_start,date_end_fill=$date_end", LOG_DEBUG);
// Check if object of the line is product or service
if ($type < 0) {
return -1;
}
if ($this->suspended == self::STATUS_NOTSUSPENDED) {
$localtaxes_type = getLocalTaxesFromRate($txtva, 0, $this->thirdparty, $mysoc);
// Clean vat code
$reg = array();
$vat_src_code = '';
if (preg_match('/\((.*)\)/', (string) $txtva, $reg)) {
$vat_src_code = $reg[1];
$txtva = preg_replace('/\s*\(.*\)/', '', (string) $txtva); // Remove code into vatrate.
}
// Clean parameters
$fk_product = empty($fk_product) ? 0 : $fk_product;
$label = empty($label) ? '' : $label;
$remise_percent = empty($remise_percent) ? 0 : price2num($remise_percent);
$qty = price2num($qty);
$pu_ht = price2num($pu_ht);
$pu_ttc = price2num($pu_ttc);
if (!preg_match('/\((.*)\)/', $txtva)) {
$txtva = price2num($txtva); // $txtva can have format '5.0(XXX)' or '5'
}
$txlocaltax1 = price2num($txlocaltax1);
$txlocaltax2 = price2num($txlocaltax2);
$txtva = !empty($txtva) ? $txtva : 0;
$txlocaltax1 = !empty($txlocaltax1) ? $txlocaltax1 : 0;
$txlocaltax2 = !empty($txlocaltax2) ? $txlocaltax2 : 0;
$info_bits = !empty($info_bits) ? $info_bits : 0;
$info_bits = !empty($info_bits) ? $info_bits : 0;
$pu = $price_base_type == 'HT' ? $pu_ht : $pu_ttc;
// Calcul du total TTC et de la TVA pour la ligne a partir de qty, pu, remise_percent et txtva
// TRES IMPORTANT: C'est au moment de l'insertion ligne qu'on doit stocker
// la part ht, tva et ttc, et ce au niveau de la ligne qui a son propre taux tva.
$tabprice = calcul_price_total($qty, $pu, $remise_percent, $txtva, $txlocaltax1, $txlocaltax2, 0, $price_base_type, $info_bits, $type, $mysoc, $localtaxes_type, 100, $this->multicurrency_tx, $pu_ht_devise);
$total_ht = $tabprice[0];
$total_tva = $tabprice[1];
$total_ttc = $tabprice[2];
$total_localtax1 = $tabprice[9];
$total_localtax2 = $tabprice[10];
$pu_ht = $tabprice[3];
// MultiCurrency
$multicurrency_total_ht = $tabprice[16];
$multicurrency_total_tva = $tabprice[17];
$multicurrency_total_ttc = $tabprice[18];
$pu_ht_devise = $tabprice[19];
$this->db->begin();
$product_type = $type;
if ($fk_product) {
$product = new Product($this->db);
$result = $product->fetch($fk_product);
if ($result < 0) {
return -1;
}
$product_type = $product->type;
if (empty($label)) {
$label = $product->label;
}
}
$sql = 'INSERT INTO ' . MAIN_DB_PREFIX . 'facture_fourn_det_rec (';
$sql .= 'fk_facture_fourn';
$sql .= ', fk_product';
$sql .= ', ref';
$sql .= ', label';
$sql .= ', description';
$sql .= ', pu_ht';
$sql .= ', pu_ttc';
$sql .= ', qty';
$sql .= ', remise_percent';
$sql .= ', fk_remise_except';
$sql .= ', vat_src_code';
$sql .= ', tva_tx';
$sql .= ', localtax1_tx';
$sql .= ', localtax1_type';
$sql .= ', localtax2_tx';
$sql .= ', localtax2_type';
$sql .= ', total_ht';
$sql .= ', total_tva';
$sql .= ', total_localtax1';
$sql .= ', total_localtax2';
$sql .= ', total_ttc';
$sql .= ', product_type';
$sql .= ', date_start';
$sql .= ', date_end';
$sql .= ', info_bits';
$sql .= ', special_code';
$sql .= ', rang';
$sql .= ', fk_unit';
$sql .= ', fk_user_author';
$sql .= ', fk_multicurrency, multicurrency_code, multicurrency_subprice, multicurrency_total_ht, multicurrency_total_tva, multicurrency_total_ttc';
$sql .= ') VALUES (';
$sql .= ' ' . (int) $facid; // source supplier invoice id
$sql .= ', ' . (!empty($fk_product) ? "'" . $this->db->escape($fk_product) . "'" : 'null');
$sql .= ', ' . (!empty($ref) ? "'" . $this->db->escape($ref) . "'" : 'null');
$sql .= ', ' . (!empty($label) ? "'" . $this->db->escape($label) . "'" : 'null');
$sql .= ", '" . $this->db->escape($desc) . "'";
$sql .= ', ' . price2num($pu_ht);
$sql .= ', ' . price2num($pu_ttc);
$sql .= ', ' . price2num($qty);
$sql .= ', ' . price2num($remise_percent);
$sql .= ', null';
$sql .= ", '" . $this->db->escape($vat_src_code) . "'";
$sql .= ', ' . price2num($txtva);
$sql .= ', ' . price2num($txlocaltax1);
$sql .= ", '" . $this->db->escape(isset($localtaxes_type[0]) ? $localtaxes_type[0] : '') . "'";
$sql .= ', ' . price2num($txlocaltax2);
$sql .= ", '" . $this->db->escape(isset($localtaxes_type[2]) ? $localtaxes_type[2] : '') . "'";
$sql .= ', ' . price2num($total_ht);
$sql .= ', ' . price2num($total_tva);
$sql .= ', ' . price2num($total_localtax1);
$sql .= ', ' . price2num($total_localtax2);
$sql .= ', ' . price2num($total_ttc);
$sql .= ', ' . (int) $product_type;
$sql .= ', ' . ($date_start > 0 ? (int) $date_start : 'NULL');
$sql .= ', ' . ($date_end > 0 ? (int) $date_end : 'NULL');
$sql .= ', ' . (int) $info_bits;
$sql .= ', ' . (int) $special_code;
$sql .= ', ' . (int) $rang;
$sql .= ', ' . ($fk_unit ? (int) $fk_unit : 'NULL');
$sql .= ', ' . (int) $user->id;
$sql .= ', ' . (int) $this->fk_multicurrency;
$sql .= ", '" . $this->db->escape($this->multicurrency_code) . "'";
$sql .= ', ' . price2num($pu_ht_devise, 'CU');
$sql .= ', ' . price2num($multicurrency_total_ht, 'CT');
$sql .= ', ' . price2num($multicurrency_total_tva, 'CT');
$sql .= ', ' . price2num($multicurrency_total_ttc, 'CT');
$sql .= ')';
dol_syslog(get_class($this). '::addline', LOG_DEBUG);
if ($this->db->query($sql)) {
$lineId = $this->db->last_insert_id(MAIN_DB_PREFIX. 'facture_fourn_det_rec');
$this->update_price();
$this->id = $facid;
$this->db->commit();
return $lineId;
} else {
$this->db->rollback();
$this->error = $this->db->lasterror();
return -1;
}
} else {
$this->error = 'Recurring Invoice is suspended. adding lines not allowed.';
return -1;
}
}
/**
* Update a line to supplier invoice template
*
* @param int $rowid ID
* @param int $fk_product Product/Service ID predefined
* @param string $ref Ref
* @param string $label Label of the line
* @param string $desc Description de la ligne
* @param double $pu_ht Unit price HT (> 0 even for credit note)
* @param double $qty Quantity
* @param int $remise_percent Percentage discount of the line
* @param double $txtva VAT rate forced with format '5.0 (XXX)', or -1
* @param int $txlocaltax1 Local tax 1 rate (deprecated)
* @param int $txlocaltax2 Local tax 2 rate (deprecated)
* @param string $price_base_type HT or TTC
* @param int $type Type of line (0=product, 1=service)
* @param int $date_start Date start
* @param int $date_end Date end
* @param int $info_bits Bits of type of lines
* @param int $special_code Special code
* @param int $rang Position of line
* @param string $fk_unit Unit
* @param double $pu_ht_devise Unit price in currency
* @param double $pu_ttc Unit price TTC (> 0 even for credit note)
* @return int Return integer <0 if KO, Id of line if OK
* @throws Exception
*/
public function updateline($rowid, $fk_product, $ref, $label, $desc, $pu_ht, $qty, $remise_percent, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $price_base_type = 'HT', $type = 0, $date_start = 0, $date_end = 0, $info_bits = 0, $special_code = 0, $rang = -1, $fk_unit = null, $pu_ht_devise = 0, $pu_ttc = 0)
{
global $mysoc, $user;
$facid = $this->id;
dol_syslog(get_class($this). '::updateline facid=' .$facid." rowid=$rowid, desc=$desc, pu_ht=$pu_ht, qty=$qty, txtva=$txtva, txlocaltax1=$txlocaltax1, txlocaltax2=$txlocaltax2, fk_product=$fk_product, remise_percent=$remise_percent, info_bits=$info_bits, price_base_type=$price_base_type, pu_ttc=$pu_ttc, type=$type, fk_unit=$fk_unit, pu_ht_devise=$pu_ht_devise", LOG_DEBUG);
include_once DOL_DOCUMENT_ROOT.'/core/lib/price.lib.php';
// Check parameters
if ($type < 0) {
return -1;
}
if ($this->status == self::STATUS_SUSPENDED) {
// Clean parameters
$fk_product = empty($fk_product) ? 0 : $fk_product;
$label = empty($label) ? '' : $label;
$remise_percent = empty($remise_percent) ? 0 : price2num($remise_percent);
$qty = price2num($qty);
$info_bits = empty($info_bits) ? 0 : $info_bits;
$pu_ht = price2num($pu_ht);
$pu_ttc = price2num($pu_ttc);
$pu_ht_devise = price2num($pu_ht_devise);
if (!preg_match('/\((.*)\)/', (string) $txtva)) {
$txtva = price2num($txtva); // $txtva can have format '5.0(XXX)' or '5'
}
$txlocaltax1 = empty($txlocaltax1) ? 0 : price2num($txlocaltax1);
$txlocaltax2 = empty($txlocaltax2) ? 0 : price2num($txlocaltax2);
$this->multicurrency_total_ht = empty($this->multicurrency_total_ht) ? 0 : $this->multicurrency_total_ht;
$this->multicurrency_total_tva = empty($this->multicurrency_total_tva) ? 0 : $this->multicurrency_total_tva;
$this->multicurrency_total_ttc = empty($this->multicurrency_total_ttc) ? 0 : $this->multicurrency_total_ttc;
$pu = $price_base_type == 'HT' ? $pu_ht : $pu_ttc;
// Calculate total with, without tax and tax from qty, pu, remise_percent and txtva
// TRES IMPORTANT: C'est au moment de l'insertion ligne qu'on doit stocker
// la part ht, tva et ttc, et ce au niveau de la ligne qui a son propre taux tva.
$localtaxes_type = getLocalTaxesFromRate($txtva, 0, $this->thirdparty, $mysoc);
// Clean vat code
$vat_src_code = '';
$reg = array();
if (preg_match('/\((.*)\)/', $txtva, $reg)) {
$vat_src_code = $reg[1];
$txtva = preg_replace('/\s*\(.*\)/', '', $txtva); // Remove code into vatrate.
}
$tabprice = calcul_price_total($qty, $pu, $remise_percent, $txtva, $txlocaltax1, $txlocaltax2, 0, $price_base_type, $info_bits, $type, $mysoc, $localtaxes_type, 100, $this->multicurrency_tx, $pu_ht_devise);
$total_ht = $tabprice[0];
$total_tva = $tabprice[1];
$total_ttc = $tabprice[2];
$total_localtax1 = $tabprice[9];
$total_localtax2 = $tabprice[10];
$pu_ht = $tabprice[3];
$pu_tva = $tabprice[4];
$pu_ttc = $tabprice[5];
// MultiCurrency
$multicurrency_total_ht = $tabprice[16];
$multicurrency_total_tva = $tabprice[17];
$multicurrency_total_ttc = $tabprice[18];
$pu_ht_devise = $tabprice[19];
$product_type = $type;
if ($fk_product) {
$product = new Product($this->db);
$result = $product->fetch($fk_product);
$product_type = $product->type;
}
$sql = 'UPDATE ' . MAIN_DB_PREFIX . 'facture_fourn_det_rec SET';
$sql .= ' fk_facture_fourn = ' . ((int) $facid);
$sql .= ', fk_product = ' . ($fk_product > 0 ? ((int) $fk_product) : 'null');
$sql .= ", ref = '" . $this->db->escape($ref) . "'";
$sql .= ", label = '" . $this->db->escape($label) . "'";
$sql .= ", description = '" . $this->db->escape($desc) . "'";
$sql .= ', pu_ht = ' . price2num($pu_ht);
$sql .= ', qty = ' . price2num($qty);
$sql .= ", remise_percent = '" . price2num($remise_percent) . "'";
$sql .= ", vat_src_code = '" . $this->db->escape($vat_src_code) . "'";
$sql .= ', tva_tx = ' . price2num($txtva);
$sql .= ', localtax1_tx = ' . (float) $txlocaltax1;
$sql .= ", localtax1_type = '" . $this->db->escape($localtaxes_type[0]) . "'";
$sql .= ', localtax2_tx = ' . (float) $txlocaltax2;
$sql .= ", localtax2_type = '" . $this->db->escape($localtaxes_type[2]) . "'";
$sql .= ", total_ht = '" . price2num($total_ht) . "'";
$sql .= ", total_tva = '" . price2num($total_tva) . "'";
$sql .= ", total_localtax1 = '" . price2num($total_localtax1) . "'";
$sql .= ", total_localtax2 = '" . price2num($total_localtax2) . "'";
$sql .= ", total_ttc = '" . price2num($total_ttc) . "'";
$sql .= ', product_type = ' . (int) $product_type;
$sql .= ', date_start = ' . (empty($date_start) ? 'NULL' : (int) $date_start);
$sql .= ', date_end = ' . (empty($date_end) ? 'NULL' : (int) $date_end);
$sql .= ', info_bits = ' . (int) $info_bits;
$sql .= ', special_code = ' . (int) $special_code;
$sql .= ', rang = ' . (int) $rang;
$sql .= ', fk_unit = ' . ($fk_unit ? "'" . $this->db->escape($fk_unit) . "'" : 'null');
$sql .= ', fk_user_modif = ' . (int) $user;
$sql .= ', multicurrency_subprice = '.price2num($pu_ht_devise);
$sql .= ', multicurrency_total_ht = '.price2num($multicurrency_total_ht);
$sql .= ', multicurrency_total_tva = '.price2num($multicurrency_total_tva);
$sql .= ', multicurrency_total_ttc = '.price2num($multicurrency_total_ttc);
$sql .= ' WHERE rowid = ' . (int) $rowid;
dol_syslog(get_class($this). '::updateline', LOG_DEBUG);
if ($this->db->query($sql)) {
$this->id = $facid;
$this->update_price();
return 1;
} else {
$this->error = $this->db->lasterror();
return -1;
}
}
return 0;
}
/**
* Return next reference of invoice not already used (or last reference)
*
* @param Societe $soc Thirdparty object
* @param string $mode 'next' for next value or 'last' for last value
* @return string free ref or last ref
*/
public function getNextNumRef($soc, $mode = 'next')
{
// Not used for recurring invoices
return '';
}
/**
* Return the next date of
*
* @return int|false false if KO, timestamp if OK
*/
public function getNextDate()
{
if (empty($this->date_when)) {
return false;
}
return dol_time_plus_duree((int) $this->date_when, $this->frequency, $this->unit_frequency, 1);
}
/**
* Return if maximum number of generation is reached
*
* @return boolean False by default, True if maximum number of generation is reached
*/
public function isMaxNbGenReached()
{
$ret = false;
if ($this->nb_gen_max > 0 && ($this->nb_gen_done >= $this->nb_gen_max)) {
$ret = true;
}
return $ret;
}
/**
* Format string to output with by striking the string if max number of generation was reached
*
* @param string $ret Default value to output
* @return string False by default, True if maximum number of generation is reached
*/
public function strikeIfMaxNbGenReached($ret)
{
// Special case to strike the date
return ($this->isMaxNbGenReached() ? '<strike>' : '').$ret.($this->isMaxNbGenReached() ? '</strike>' : '');
}
/**
* Create all recurrents supplier invoices (for all entities if multicompany is used).
* A result may also be provided into this->output.
*
* WARNING: This method changes temporarily the context $conf->entity to be in correct context for each recurring invoice found.
*
* @param int $restrictioninvoiceid 0=All qualified template invoices found. > 0 = restrict action on invoice ID
* @param int $forcevalidation 1=Force validation of invoice whatever is template auto_validate flag.
* @return int 0 if OK, < 0 if KO (this function is used also by cron so only 0 is OK)
*/
public function createRecurringInvoices($restrictioninvoiceid = 0, $forcevalidation = 0)
{
global $conf, $langs, $db, $user, $hookmanager;
$error = 0;
$nb_create = 0;
// Load translation files required by the page
$langs->loadLangs(array('main', 'bills'));
$now = dol_now();
$tmparray = dol_getdate($now);
$today = dol_mktime(23, 59, 59, $tmparray['mon'], $tmparray['mday'], $tmparray['year']); // Today is last second of current day
dol_syslog('createRecurringInvoices restrictioninvoiceid=' .$restrictioninvoiceid. ' forcevalidation=' .$forcevalidation);
$sql = 'SELECT rowid FROM '.MAIN_DB_PREFIX.'facture_fourn_rec';
$sql .= ' WHERE frequency > 0'; // A recurring supplier invoice is an invoice with a frequency
$sql .= " AND (date_when IS NULL OR date_when <= '".$this->db->idate($today)."')";
$sql .= ' AND (nb_gen_done < nb_gen_max OR nb_gen_max = 0)';
$sql .= ' AND suspended = 0';
$sql .= ' AND entity = '. (int) $conf->entity; // MUST STAY = $conf->entity here
if ($restrictioninvoiceid > 0) {
$sql .= ' AND rowid = '. (int) $restrictioninvoiceid;
}
$sql .= $this->db->order('entity', 'ASC');
//print $sql;exit;
$parameters = array(
'restrictioninvoiceid' => $restrictioninvoiceid,
'forcevalidation' => $forcevalidation,
);
$reshook = $hookmanager->executeHooks('beforeCreationOfRecurringInvoices', $parameters, $sql); // note that $sql might be modified by hooks
$resql = $this->db->query($sql);
if ($resql) {
$i = 0;
$num = $this->db->num_rows($resql);
if ($num) {
$this->output .= $langs->trans('FoundXQualifiedRecurringInvoiceTemplate', $num)."\n";
} else {
$this->output .= $langs->trans('NoQualifiedRecurringInvoiceTemplateFound');
}
$saventity = $conf->entity;
$laststep = "None";
while ($i < $num) { // Loop on each template invoice. If $num = 0, test is false at first pass.
$line = $this->db->fetch_object($resql);
$this->db->begin();
$invoiceidgenerated = 0;
$new_fac_fourn = null;
$facturerec = new FactureFournisseurRec($this->db);
$laststep = "Fetch {$line->rowid}";
$facturerec->fetch($line->rowid);
if ($facturerec->id > 0) {
// Set entity context
$conf->entity = $facturerec->entity;
dol_syslog('createRecurringInvoices Process invoice template id=' .$facturerec->id. ', ref=' .$facturerec->ref. ', entity=' .$facturerec->entity);
$new_fac_fourn = new FactureFournisseur($this->db);
$new_fac_fourn->fac_rec = $facturerec->id; // We will create $facture from this recurring invoice
$new_fac_fourn->fk_fac_rec_source = $facturerec->id; // We will create $facture from this recurring invoice
$new_fac_fourn->type = self::TYPE_STANDARD;
$new_fac_fourn->subtype = $facturerec->subtype;
$new_fac_fourn->statut = self::STATUS_DRAFT; // deprecated
$new_fac_fourn->status = self::STATUS_DRAFT;
$new_fac_fourn->date = empty($facturerec->date_when) ? $now : $facturerec->date_when; // We could also use dol_now here but we prefer date_when so invoice has real date when we would like even if we generate later.
$new_fac_fourn->socid = $facturerec->socid;
$new_fac_fourn->lines = $facturerec->lines;
$new_fac_fourn->ref_supplier = $facturerec->ref_supplier;
$new_fac_fourn->model_pdf = $facturerec->model_pdf;
$new_fac_fourn->fk_project = $facturerec->fk_project;
$new_fac_fourn->label = $facturerec->label;
$new_fac_fourn->libelle = $facturerec->label; // deprecated
$invoiceidgenerated = $new_fac_fourn->create($user);
$laststep = "Create invoiceidgenerated $invoiceidgenerated";
if ($invoiceidgenerated <= 0) {
$this->errors = $new_fac_fourn->errors;
$this->error = $new_fac_fourn->error;
$error++;
}
if (!$error && ($facturerec->auto_validate || $forcevalidation)) {
$result = $new_fac_fourn->validate($user);
$laststep = "Validate by user {$user->login}";
if ($result <= 0) {
$this->errors = $new_fac_fourn->errors;
$this->error = $new_fac_fourn->error;
$error++;
}
}
if (!$error && $facturerec->generate_pdf) {
// We refresh the object in order to have all necessary data (like date_lim_reglement)
$laststep = "Refresh ".$new_fac_fourn->id;
$new_fac_fourn->fetch($new_fac_fourn->id);
$laststep = "GenerateDocument ".$new_fac_fourn->id;
$result = $new_fac_fourn->generateDocument($facturerec->model_pdf, $langs);
if ($result < 0) {
$this->errors = $new_fac_fourn->errors;
$this->error = $new_fac_fourn->error;
$error++;
}
}
} else {
$error++;
$this->error = 'Failed to load invoice template with id=' .$line->rowid. ', entity=' .$conf->entity."\n";
$this->errors[] = 'Failed to load invoice template with id=' .$line->rowid. ', entity=' .$conf->entity;
dol_syslog('createRecurringInvoices Failed to load invoice template with id=' .$line->rowid. ', entity=' .$conf->entity);
}
if (!$error && $invoiceidgenerated >= 0) {
$facturerec->nb_gen_done++;
$facturerec->date_last_gen = dol_now();
$nextDate = $facturerec->getNextDate();
$facturerec->date_when = (($nextDate === false) ? null : $nextDate);
$facturerec->update($user);
$this->db->commit('createRecurringInvoices Process invoice template id=' .$facturerec->id. ', title=' .$facturerec->title);
dol_syslog('createRecurringInvoices Process invoice template ' .$facturerec->title. ' is finished with a success generation');
$nb_create++;
$this->output .= $langs->trans('InvoiceGeneratedFromTemplate', $new_fac_fourn->ref, $facturerec->title)."\n";
} else {
$this->db->rollback('createRecurringInvoices Process invoice template error='.$error.' invoiceidgenerated='.$invoiceidgenerated.' LastStep='.$laststep.' id=' .$facturerec->id. ', title=' .$facturerec->title);
}
$parameters = array(
'cpt' => $i,
'total' => $num,
'errorCount' => $error,
'invoiceidgenerated' => $invoiceidgenerated,
'facturerec' => $facturerec, // it's an object which PHP passes by "reference", so modifiable by hooks.
'this' => $this, // it's an object which PHP passes by "reference", so modifiable by hooks.
);
$reshook = $hookmanager->executeHooks('afterCreationOfRecurringInvoice', $parameters, $new_fac_fourn); // note: $facture can be modified by hooks (warning: $facture can be null)
$i++;
}
$conf->entity = $saventity; // Restore entity context
} else {
dol_print_error($this->db);
}
$this->output = trim($this->output);
return $error ? $error : 0;
}
/**
* Return clickable name (with picto eventually)
*
* @param int $withpicto Add picto into link
* @param string $option Where point the link
* @param int $max Maxlength of ref
* @param int $short 1=Return just URL
* @param string $moretitle Add more text to title tooltip
* @param int $notooltip 1=Disable tooltip
* @param int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
* @return string String with URL
*/
public function getNomUrl($withpicto = 0, $option = '', $max = 0, $short = 0, $moretitle = '', $notooltip = 0, $save_lastsearch_value = -1)
{
global $langs, $hookmanager;
$result = '';
$label = '<u>'.$langs->trans('RepeatableInvoice').'</u>';
if (!empty($this->ref)) {
$label .= '<br><b>'.$langs->trans('Ref').':</b> '.$this->ref;
}
if ($this->frequency > 0) {
$label .= '<br><b>'.$langs->trans('Frequency').':</b> '.$langs->trans('FrequencyPer_'.$this->unit_frequency, $this->frequency);
}
if (!empty($this->date_last_gen)) {
$label .= '<br><b>'.$langs->trans('DateLastGeneration').':</b> '.dol_print_date($this->date_last_gen, 'dayhour');
}
if ($this->frequency > 0) {
if (!empty($this->date_when)) {
$label .= '<br><b>'.$langs->trans('NextDateToExecution').':</b> ';
$label .= (empty($this->suspended) ? '' : '<strike>').dol_print_date($this->date_when, 'day').(empty($this->suspended) ? '' : '</strike>'); // No hour for this property
if (!empty($this->suspended)) {
$label .= ' ('.$langs->trans('Disabled').')';
}
}
}
$url = DOL_URL_ROOT.'/fourn/facture/card-rec.php?facid='.$this->id;
if ($short) {
return $url;
}
if ($option != 'nolink') {
// Add param to save lastsearch_values or not
$add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
if ($save_lastsearch_value == -1 && preg_match('/list\.php/', $_SERVER['PHP_SELF'])) {
$add_save_lastsearch_values = 1;
}
if ($add_save_lastsearch_values) {
$url .= '&save_lastsearch_values=1';
}
}
$linkstart = '<a href="'.$url.'" title="'.dol_escape_htmltag($label, 1).'" class="classfortooltip">';
$linkend = '</a>';
$result .= $linkstart;
if ($withpicto) {
$result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
}
if ($withpicto != 2) {
$result .= $this->ref;
}
$result .= $linkend;
global $action;
$hookmanager->initHooks(array($this->element . 'dao'));
$parameters = array('id' => $this->id, 'getnomurl' => &$result);
$reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
if ($reshook > 0) {
$result = $hookmanager->resPrint;
} else {
$result .= $hookmanager->resPrint;
}
return $result;
}
/**
* Return label of object 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
* @param integer $alreadypaid Not used on recurring invoices
* @return string Label of status
*/
public function getLibStatut($mode = 0, $alreadypaid = -1)
{
return $this->LibStatut($this->frequency ? 1 : 0, $this->suspended, $mode, $alreadypaid, empty($this->type) ? 0 : $this->type);
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
/**
* Return label of a status
*
* @param int $recur Is it a recurring invoice ?
* @param int $status Id status (suspended or not)
* @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
* @param integer $alreadypaid Not used for recurring invoices
* @param int $type Type invoice
* @return string Label of status
*/
public function LibStatut($recur, $status, $mode = 0, $alreadypaid = -1, $type = 0)
{
// phpcs:enable
global $langs;
$langs->load('bills');
$labelStatus = $langs->transnoentitiesnoconv('Active');
$statusType = 'status0';
//print "$recur,$status,$mode,$alreadypaid,$type";
if ($mode == 0) {
if ($recur) {
if ($status == self::STATUS_SUSPENDED) {
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$labelStatus = $langs->transnoentitiesnoconv('Active');
}
} else {
if ($status == self::STATUS_SUSPENDED) {
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$labelStatus = $langs->transnoentitiesnoconv('Draft');
}
}
} elseif ($mode == 1) {
$prefix = 'Short';
if ($recur) {
if ($status == self::STATUS_SUSPENDED) {
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$labelStatus = $langs->transnoentitiesnoconv('Active');
}
} else {
if ($status == self::STATUS_SUSPENDED) {
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$labelStatus = $langs->transnoentitiesnoconv('Draft');
}
}
} elseif ($mode == 2) {
if ($recur) {
if ($status == self::STATUS_SUSPENDED) {
$statusType = 'status6';
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$statusType = 'status4';
$labelStatus = $langs->transnoentitiesnoconv('Active');
}
} else {
if ($status == self::STATUS_SUSPENDED) {
$statusType = 'status6';
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$statusType = 'status0';
$labelStatus = $langs->transnoentitiesnoconv('Draft');
}
}
} elseif ($mode == 3) {
if ($recur) {
$prefix = 'Short';
if ($status == self::STATUS_SUSPENDED) {
$statusType = 'status6';
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$statusType = 'status4';
$labelStatus = $langs->transnoentitiesnoconv('Active');
}
} else {
if ($status == self::STATUS_SUSPENDED) {
$statusType = 'status6';
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$statusType = 'status0';
$labelStatus = $langs->transnoentitiesnoconv('Draft');
}
}
} elseif ($mode == 4) {
$prefix = '';
if ($recur) {
if ($status == self::STATUS_SUSPENDED) {
$statusType = 'status6';
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$statusType = 'status4';
$labelStatus = $langs->transnoentitiesnoconv('Active');
}
} else {
if ($status == self::STATUS_SUSPENDED) {
$statusType = 'status6';
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$statusType = 'status0';
$labelStatus = $langs->transnoentitiesnoconv('Draft');
}
}
} elseif ($mode == 5 || $mode == 6) {
$prefix = '';
if ($mode == 5) {
$prefix = 'Short';
}
if ($recur) {
if ($status == self::STATUS_SUSPENDED) {
$statusType = 'status6';
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$statusType = 'status4';
$labelStatus = $langs->transnoentitiesnoconv('Active');
}
} else {
if ($status == self::STATUS_SUSPENDED) {
$statusType = 'status6';
$labelStatus = $langs->transnoentitiesnoconv('Disabled');
} else {
$statusType = 'status0';
$labelStatus = $langs->transnoentitiesnoconv('Draft');
}
}
}
$labelStatusShort = $labelStatus;
return dolGetStatus($labelStatus, $labelStatusShort, '', $statusType, $mode);
}
/**
* Initialise an instance with random values.
* Used to build previews or test instances.
* id must be 0 if object instance is a specimen.
*
* @param string $option ''=Create a specimen invoice with lines, 'nolines'=No lines
* @return int
*/
public function initAsSpecimen($option = '')
{
global $user, $langs, $conf;
$now = dol_now();
$arraynow = dol_getdate($now);
$nownotime = dol_mktime(0, 0, 0, $arraynow['mon'], $arraynow['mday'], $arraynow['year']);
// Load array of products prodids
$num_prods = 0;
$prodids = array();
$sql = 'SELECT rowid';
$sql .= ' FROM ' .MAIN_DB_PREFIX. 'product';
$sql .= ' WHERE entity IN (' .getEntity('product'). ')';
$sql .= $this->db->plimit(100);
$resql = $this->db->query($sql);
if ($resql) {
$num_prods = $this->db->num_rows($resql);
$i = 0;
while ($i < $num_prods) {
$i++;
$row = $this->db->fetch_row($resql);
$prodids[$i] = $row[0];
}
}
// Initialize parameters
$this->id = 0;
$this->ref = 'SPECIMEN';
$this->title = 'SPECIMEN';
$this->specimen = 1;
$this->socid = 1;
$this->date = $nownotime;
$this->date_lim_reglement = $nownotime + 3600 * 24 * 30;
$this->cond_reglement_id = 1;
$this->cond_reglement_code = 'RECEP';
$this->date_lim_reglement = $this->calculate_date_lim_reglement();
$this->mode_reglement_id = 0; // Not forced to show payment mode CHQ + VIR
$this->mode_reglement_code = ''; // Not forced to show payment mode CHQ + VIR
$this->note_public = 'This is a comment (public)';
$this->note_private = 'This is a comment (private)';
$this->note = 'This is a comment (private)';
$this->fk_incoterms = 0;
$this->location_incoterms = '';
if (empty($option) || $option != 'nolines') {
// Lines
$nbp = min(1000, GETPOSTINT('nblines') ? GETPOSTINT('nblines') : 5); // We can force the nb of lines to test from command line (but not more than 1000)
$xnbp = 0;
while ($xnbp < $nbp) {
$line = new FactureLigne($this->db);
$line->desc = $langs->trans('Description'). ' ' .$xnbp;
$line->qty = 1;
$line->subprice = 100;
$line->tva_tx = 19.6;
$line->localtax1_tx = 0;
$line->localtax2_tx = 0;
$line->remise_percent = 0;
if ($xnbp == 1) { // Qty is negative (product line)
$prodid = mt_rand(1, $num_prods);
$line->fk_product = $prodids[$prodid];
$line->qty = -1;
$line->total_ht = -100;
$line->total_ttc = -119.6;
$line->total_tva = -19.6;
} elseif ($xnbp == 2) { // UP is negative (free line)
$line->subprice = -100;
$line->total_ht = -100;
$line->total_ttc = -119.6;
$line->total_tva = -19.6;
$line->remise_percent = 0;
} elseif ($xnbp == 3) { // Discount is 50% (product line)
$prodid = mt_rand(1, $num_prods);
$line->fk_product = $prodids[$prodid];
$line->total_ht = 50;
$line->total_ttc = 59.8;
$line->total_tva = 9.8;
$line->remise_percent = 50;
} else { // (product line)
$prodid = mt_rand(1, $num_prods);
$line->fk_product = $prodids[$prodid];
$line->total_ht = 100;
$line->total_ttc = 119.6;
$line->total_tva = 19.6;
$line->remise_percent = 00;
}
$this->lines[$xnbp] = $line;
$xnbp++;
$this->total_ht += $line->total_ht;
$this->total_tva += $line->total_tva;
$this->total_ttc += $line->total_ttc;
}
$this->revenuestamp = 0;
// Add a line "offered"
$line = new FactureLigne($this->db);
$line->desc = $langs->trans('Description'). ' (offered line)';
$line->qty = 1;
$line->subprice = 100;
$line->tva_tx = 19.6;
$line->localtax1_tx = 0;
$line->localtax2_tx = 0;
$line->remise_percent = 100;
$line->total_ht = 0;
$line->total_ttc = 0; // 90 * 1.196
$line->total_tva = 0;
$prodid = mt_rand(1, $num_prods);
$line->fk_product = $prodids[$prodid];
$this->lines[$xnbp] = $line;
$xnbp++;
}
$this->usenewprice = 0;
return 1;
}
/**
* Function used to replace a thirdparty id with another one.
*
* @param DoliDB $dbs Database handler, because function is static we name it $dbs not $db to avoid breaking coding test
* @param int $origin_id Old thirdparty id
* @param int $dest_id New thirdparty id
* @return bool
*/
public static function replaceThirdparty(DoliDB $dbs, $origin_id, $dest_id)
{
$tables = array(
'facture_fourn_rec'
);
return CommonObject::commonReplaceThirdparty($dbs, $origin_id, $dest_id, $tables);
}
/**
* Update frequency and unit
*
* @param int $frequency value of frequency
* @param string $unit unit of frequency (d, m, y)
* @return int Return integer <0 if KO, >0 if OK
*/
public function setFrequencyAndUnit($frequency, $unit)
{
if (!$this->table_element) {
dol_syslog(get_class($this). '::setFrequencyAndUnit was called on object with property table_element not defined', LOG_ERR);
return -1;
}
if (!empty($frequency) && empty($unit)) {
dol_syslog(get_class($this). '::setFrequencyAndUnit was called on object with params frequency defined but unit not defined', LOG_ERR);
return -2;
}
$sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
$sql .= " SET frequency = ".($frequency ? ((int) $frequency) : "NULL");
if (!empty($unit)) {
$sql .= ", unit_frequency = '".$this->db->escape($unit)."'";
}
$sql .= " WHERE rowid = ".((int) $this->id);
dol_syslog(get_class($this).'::setFrequencyAndUnit', LOG_DEBUG);
if ($this->db->query($sql)) {
$this->frequency = $frequency;
if (!empty($unit)) {
$this->unit_frequency = $unit;
}
return 1;
} else {
$this->error = $this->db->lasterror();
return -1;
}
}
/**
* Update the next date of execution
*
* @param int $date date of execution
* @param int $increment_nb_gen_done 0 do nothing more, >0 increment nb_gen_done
* @return int Return integer <0 if KO, >0 if OK
*/
public function setNextDate($date, $increment_nb_gen_done = 0)
{
if (!$this->table_element) {
dol_syslog(get_class($this).'::setNextDate was called on object with property table_element not defined', LOG_ERR);
return -1;
}
$sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
$sql .= " SET date_when = " .($date ? "'".$this->db->idate($date)."'" : "NULL");
if ($increment_nb_gen_done > 0) {
$sql .= ", nb_gen_done = nb_gen_done + 1";
}
$sql .= " WHERE rowid = " . (int) $this->id;
dol_syslog(get_class($this).'::setNextDate', LOG_DEBUG);
if ($this->db->query($sql)) {
$this->date_when = $date;
if ($increment_nb_gen_done > 0) {
$this->nb_gen_done++;
}
return 1;
} else {
$this->error = $this->db->lasterror();
return -1;
}
}
/**
* Update the maximum period
*
* @param int $nb number of maximum period
* @return int Return integer <0 if KO, >0 if OK
*/
public function setMaxPeriod($nb)
{
if (!$this->table_element) {
dol_syslog(get_class($this).'::setMaxPeriod was called on object with property table_element not defined', LOG_ERR);
return -1;
}
if (empty($nb)) {
$nb = 0;
}
$sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
$sql .= " SET nb_gen_max = ". (int) $nb;
$sql .= " WHERE rowid = " . (int) $this->id;
dol_syslog(get_class($this).'::setMaxPeriod', LOG_DEBUG);
if ($this->db->query($sql)) {
$this->nb_gen_max = $nb;
return 1;
} else {
dol_print_error($this->db);
return -1;
}
}
/**
* Update the auto validate flag of invoice
*
* @param int $validate 0 to create in draft, 1 to create and validate invoice
* @return int Return integer <0 if KO, >0 if OK
*/
public function setAutoValidate($validate)
{
if (!$this->table_element) {
dol_syslog(get_class($this).'::setAutoValidate was called on object with property table_element not defined', LOG_ERR);
return -1;
}
$sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
$sql .= " SET auto_validate = ".((int) $validate);
$sql .= " WHERE rowid = " . (int) $this->id;
dol_syslog(get_class($this).'::setAutoValidate', LOG_DEBUG);
if ($this->db->query($sql)) {
$this->auto_validate = $validate;
return 1;
} else {
dol_print_error($this->db);
return -1;
}
}
/**
* Update the auto generate documents
*
* @param int $validate 0 no document, 1 to generate document
* @return int Return integer <0 if KO, >0 if OK
*/
public function setGeneratePdf($validate)
{
if (!$this->table_element) {
dol_syslog(get_class($this).'::setGeneratePdf was called on object with property table_element not defined', LOG_ERR);
return -1;
}
$sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
$sql .= " SET generate_pdf = ". (int) $validate;
$sql .= " WHERE rowid = " . (int) $this->id;
dol_syslog(get_class($this).'::setGeneratePdf', LOG_DEBUG);
if ($this->db->query($sql)) {
$this->generate_pdf = $validate;
return 1;
} else {
dol_print_error($this->db);
return -1;
}
}
/**
* Update the model for documents
*
* @param string $model model of document generator
* @return int Return integer <0 if KO, >0 if OK
*/
public function setModelPdf($model)
{
if (!$this->table_element) {
dol_syslog(get_class($this).'::setModelPdf was called on object with property table_element not defined', LOG_ERR);
return -1;
}
$sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
$sql .= " SET modelpdf = '".$this->db->escape($model)."'";
$sql .= " WHERE rowid = " . (int) $this->id;
dol_syslog(get_class($this).'::setModelPdf', LOG_DEBUG);
if ($this->db->query($sql)) {
$this->model_pdf = $model;
return 1;
} else {
dol_print_error($this->db);
return -1;
}
}
}
View Git Blame Copy Permalink