dolibarr/htdocs/core/modules/project/modules_project.php
2024-09-06 20:28:06 +08:00

103 lines
3.1 KiB
PHP

<?php
/* Copyright (C) 2010-2014 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2014 Marcos García <marcosgdf@gmail.com>
* 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/project/modules_project.php
* \ingroup project
* \brief File that contain parent class for projects models
* and parent class for projects numbering models
*/
require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/commonnumrefgenerator.class.php';
/**
* Parent class for projects models
*/
abstract class ModelePDFProjects extends CommonDocGenerator
{
/**
* @var DoliDB Database handler
*/
public $db;
/**
* @var string model description (short text)
*/
public $description;
// 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 = 'project';
$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 pdf project onto disk
*
* @param Project $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
* @return int<-1,1> 1 if OK, <=0 if KO
*/
abstract public function write_file($object, $outputlangs, $srctemplatepath = '');
// phpcs:enable
}
/**
* Class mere des modeles de numerotation des references de projects
*/
abstract class ModeleNumRefProjects extends CommonNumRefGenerator
{
/**
* Return next value
*
* @param Societe $objsoc Object third party
* @param Project $project Object project
* @return string|int<-1,0> Value if OK, 0 if KO
*/
abstract public function getNextValue($objsoc, $project);
/**
* Return an example of numbering
*
* @return string Example
*/
abstract public function getExample();
}