92 lines
2.9 KiB
PHP
92 lines
2.9 KiB
PHP
<?php
|
|
/* Copyright (C) 2018-2020 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/
|
|
*/
|
|
|
|
/**
|
|
* \file htdocs/core/modules/movement/modules_movement.php
|
|
* \ingroup stock
|
|
* \brief File with parent class for generating PDF of a stock movements
|
|
*/
|
|
|
|
require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
|
|
|
|
|
|
/**
|
|
* Parent class to manage warehouse movement document templates
|
|
*/
|
|
abstract class ModelePDFMovement extends CommonDocGenerator
|
|
{
|
|
/**
|
|
* @var DoliDB Database handler
|
|
*/
|
|
public $db;
|
|
|
|
/**
|
|
* @var string model description (short text)
|
|
*/
|
|
public $description;
|
|
|
|
/**
|
|
* @var string document type
|
|
*/
|
|
public $type;
|
|
|
|
/**
|
|
* Dolibarr version of the loaded document
|
|
* @var string Version, possible values are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'''|'development'|'dolibarr'|'experimental'
|
|
*/
|
|
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 = 'movement';
|
|
$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 document
|
|
*
|
|
* @param MouvementStock $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
|
|
}
|