mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2025-12-07 18:18:18 +01:00
d71cd352d5
* Qual: Fix PhanUndeclaredMethod cases * Fix PhanUndeclaredMethod cases * Qual: Remove PhanUndeclaredMethod exceptions * Fix spelling "disacard" * Improve phpdoc, add abstract method to trait for typing * Improve phpdoc typing for PHanUndeclaredMethod * Suppress phan notices for guarded AliasNbPages calls * Fix return value for printFile stub * Fix getting message from Exception * Define dummy getAllByProducts(), typing for it. * Fix typo in comment * Qual: Better typing for apiService (phan) * Test that the Generic OAuth Service is provided * Qual: Fix getSqlArrayForStats typing * Force modTcpdfbarcode * Correct typing hint * Set ModelePDFAsset typehint * Fix ModelePDFUserGroup typing hint * Fix phan typing hints htdocs/core/modules/printing/printgcp.modules.php * Fix write_file in ModelePDFStock* * Update printsheet.php * Adjust typing hint for barcode generator * Update printsheet.php --------- Co-authored-by: Laurent Destailleur <eldy@destailleur.fr>
89 lines
2.8 KiB
PHP
89 lines
2.8 KiB
PHP
<?php
|
|
/* Copyright (C) 2018 Laurent Destailleur <eldy@users.sourceforge.net>
|
|
* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.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/>.
|
|
* or see https://www.gnu.org/
|
|
*/
|
|
|
|
require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
|
|
|
|
/**
|
|
* Parent class for stock models of doc generators
|
|
*/
|
|
abstract class ModelePDFStock extends CommonDocGenerator
|
|
{
|
|
/**
|
|
* @var DoliDB Database handler
|
|
*/
|
|
public $db;
|
|
|
|
/**
|
|
* @var string model name
|
|
*/
|
|
public $name;
|
|
|
|
/**
|
|
* @var string model description (short text)
|
|
*/
|
|
public $description;
|
|
|
|
/**
|
|
* @var string document type
|
|
*/
|
|
public $type;
|
|
|
|
/**
|
|
* @var string Version, possible values are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'''|'development'|'dolibarr'|'experimental' Dolibarr version of the loaded document
|
|
*/
|
|
public $version = 'dolibarr';
|
|
|
|
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
|
|
/**
|
|
* Return list of active generation modules
|
|
*
|
|
* @param DoliDB $db Database handler
|
|
* @param int<0,max> $maxfilenamelength Max length of value to show
|
|
* @return string[]|int<-1,0> List of templates
|
|
*/
|
|
public static function liste_modeles($db, $maxfilenamelength = 0)
|
|
{
|
|
// phpcs:enable
|
|
$type = 'stock';
|
|
$list = array();
|
|
|
|
include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
|
|
$list = getListOfModels($db, $type, $maxfilenamelength);
|
|
|
|
return $list;
|
|
}
|
|
|
|
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
|
|
/**
|
|
* Function to build a document on disk
|
|
*
|
|
* @param Entrepot $object Object source to build document
|
|
* @param Translate $outputlangs Lang output object
|
|
* @param string $srctemplatepath Full path of source filename for generator using a template file
|
|
* @param int<0,1> $hidedetails Do not show line details
|
|
* @param int<0,1> $hidedesc Do not show desc
|
|
* @param int<0,1> $hideref Do not show ref
|
|
* @return int<-1,1> 1 if OK, <=0 if KO
|
|
*/
|
|
abstract public function write_file($object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0);
|
|
// phpcs:enable
|
|
}
|