lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

NEW Add API to get a tempalte invoice

Browse Source
This commit is contained in:
Laurent Destailleur 2022-02-28 10:37:03 +01:00
parent b598671484
commit 99ddef0530
1 changed files with 100 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
htdocs/compta/facture/class/api_invoices.class.php
View File

@ -19,6 +19,8 @@
use Luracast\Restler\RestException; use Luracast\Restler\RestException;
require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php'; require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture-rec.class.php';
/** /**
* API class for invoices * API class for invoices
@ -39,7 +41,13 @@ class Invoices extends DolibarrApi
/** /**
* @var Facture $invoice {@type Facture} * @var Facture $invoice {@type Facture}
*/ */
public $invoice; private $invoice;
/**
* @var FactureRec $templte_invoice {@type FactureRec}
*/
private $template_invoice;
/** /**
* Constructor * Constructor
@ -49,6 +57,7 @@ class Invoices extends DolibarrApi
global $db, $conf; global $db, $conf;
$this->db = $db; $this->db = $db;
$this->invoice = new Facture($this->db); $this->invoice = new Facture($this->db);
$this->template_invoice = new FactureRec($this->db);
} }
/** /**
@ -57,7 +66,7 @@ class Invoices extends DolibarrApi
* Return an array with invoice informations * Return an array with invoice informations
* *
* @param int $id ID of invoice * @param int $id ID of invoice
* @param int $contact_list 0:Return array contains all properties, 1:Return array contains just id * @param int $contact_list 0:Return array contains all properties, 1:Return array contains just id, -1: Do not return contacts/adddesses
* @return array|mixed data without useless information * @return array|mixed data without useless information
* *
* @throws RestException * @throws RestException
@ -73,7 +82,7 @@ class Invoices extends DolibarrApi
* Return an array with invoice informations * Return an array with invoice informations
* *
* @param string $ref Ref of object * @param string $ref Ref of object
* @param int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id * @param int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses
* @return array|mixed data without useless information * @return array|mixed data without useless information
* *
* @url GET ref/{ref} * @url GET ref/{ref}
@ -91,7 +100,7 @@ class Invoices extends DolibarrApi
* Return an array with invoice informations * Return an array with invoice informations
* *
* @param string $ref_ext External reference of object * @param string $ref_ext External reference of object
* @param int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id * @param int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses
* @return array|mixed data without useless information * @return array|mixed data without useless information
* *
* @url GET ref_ext/{ref_ext} * @url GET ref_ext/{ref_ext}
@ -108,10 +117,10 @@ class Invoices extends DolibarrApi
* *
* Return an array with invoice informations * Return an array with invoice informations
* *
* @param int $id ID of order * @param int $id ID of order
* @param string $ref Ref of object * @param string $ref Ref of object
* @param string $ref_ext External reference of object * @param string $ref_ext External reference of object
* @param int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id * @param int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses
* @return array|mixed data without useless information * @return array|mixed data without useless information
* *
* @throws RestException * @throws RestException
@ -138,9 +147,12 @@ class Invoices extends DolibarrApi
} }
// Add external contacts ids // Add external contacts ids
$this->invoice->contacts_ids = $this->invoice->liste_contact(-1, 'external', $contact_list); if ($contact_list > -1) {
$this->invoice->contacts_ids = $this->invoice->liste_contact(-1, 'external', $contact_list);
}
$this->invoice->fetchObjectLinked(); $this->invoice->fetchObjectLinked();
return $this->_cleanObjectDatas($this->invoice); return $this->_cleanObjectDatas($this->invoice);
} }
@ -1681,6 +1693,7 @@ class Invoices extends DolibarrApi
unset($object->barcode_type_code); unset($object->barcode_type_code);
unset($object->barcode_type_label); unset($object->barcode_type_label);
unset($object->barcode_type_coder); unset($object->barcode_type_coder);
unset($object->canvas);
return $object; return $object;
} }
@ -1704,4 +1717,84 @@ class Invoices extends DolibarrApi
} }
return $invoice; return $invoice;
} }
/**
* Get properties of a template invoice object
*
* Return an array with invoice informations
*
* @param int $id ID of template invoice
* @param int $contact_list 0:Return array contains all properties, 1:Return array contains just id, 1: Return array contains just id, -1: Do not return contacts/adddesses
* @return array|mixed data without useless information
*
* @url GET templates/{id}
*
* @throws RestException
*/
public function getTemplateInvoice($id, $contact_list = 1)
{
return $this->_fetchTemplateInvoice($id, '', '', $contact_list);
}
/**
* Get properties of an invoice object
*
* Return an array with invoice informations
*
* @param int $id ID of order
* @param string $ref Ref of object
* @param string $ref_ext External reference of object
* @param int $contact_list 0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses
* @return array|mixed data without useless information
*
* @throws RestException
*/
private function _fetchTemplateInvoice($id, $ref = '', $ref_ext = '', $contact_list = 1)
{
if (!DolibarrApiAccess::$user->rights->facture->lire) {
throw new RestException(401);
}
$result = $this->template_invoice->fetch($id, $ref, $ref_ext);
if (!$result) {
throw new RestException(404, 'Template invoice not found');
}
if (!DolibarrApi::_checkAccessToResource('facturerec', $this->template_invoice->id)) {
throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
// Add external contacts ids
if ($contact_list > -1) {
$this->template_invoice->contacts_ids = $this->template_invoice->liste_contact(-1, 'external', $contact_list);
}
$this->template_invoice->fetchObjectLinked();
return $this->_cleanTemplateObjectDatas($this->template_invoice);
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
/**
* Clean sensible object datas
*
* @param Object $object Object to clean
* @return Object Object with cleaned properties
*/
protected function _cleanTemplateObjectDatas($object)
{
// phpcs:enable
$object = parent::_cleanObjectDatas($object);
unset($object->note);
unset($object->address);
unset($object->barcode_type);
unset($object->barcode_type_code);
unset($object->barcode_type_label);
unset($object->barcode_type_coder);
unset($object->canvas);
return $object;
}
} }