mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2025-12-07 10:08:27 +01:00
a0f515ef12
* Qual: Add abstract write_file to ModeleDon And update phpdoc for derived classes * Qual: Add abstract write_file to ModeleChequeReceipts And update phpdoc for derived classes * Qual: Add abstract write_file to ModelePDFRecruitmentCandidature And update phpdoc for derived classes * Qual: Add abstract write_file to ModelePDFStock & ModelePDFStockTransfer And update phpdoc for derived classes * Qual: Update phpdoc write_file for CommonStickerGenerator classes --------- Co-authored-by: Laurent Destailleur <eldy@destailleur.fr>
79 lines
2.6 KiB
PHP
79 lines
2.6 KiB
PHP
<?php
|
|
/* Copyright (C) 2003-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
|
|
* Copyright (C) 2004-2008 Laurent Destailleur <eldy@users.sourceforge.net>
|
|
* Copyright (C) 2004 Eric Seigne <eric.seigne@ryxeo.com>
|
|
* Copyright (C) 2005 Regis Houssin <regis.houssin@inodbox.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/dons/modules_don.php
|
|
* \ingroup donations
|
|
* \brief File of class to manage donation document generation
|
|
*/
|
|
require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
|
|
require_once DOL_DOCUMENT_ROOT.'/core/class/commonnumrefgenerator.class.php';
|
|
require_once DOL_DOCUMENT_ROOT.'/don/class/don.class.php';
|
|
|
|
|
|
|
|
/**
|
|
* Parent class of subscription templates
|
|
*/
|
|
abstract class ModeleDon extends CommonDocGenerator
|
|
{
|
|
// 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 = 'donation';
|
|
$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
|
|
/**
|
|
* Write the object to document file to disk
|
|
*
|
|
* @param Don $don Donation object
|
|
* @param Translate $outputlangs Lang object for output language
|
|
* @param string $currency Currency code
|
|
* @return int<-1,1> >0 if OK, <0 if KO
|
|
*/
|
|
abstract public function write_file($don, $outputlangs, $currency = '');
|
|
}
|
|
|
|
|
|
/**
|
|
* Parent class of donation numbering templates
|
|
*/
|
|
abstract class ModeleNumRefDons extends CommonNumRefGenerator
|
|
{
|
|
// No overload code
|
|
}
|