mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2026-01-04 16:12:39 +01:00
90 lines
4.2 KiB
PHP
90 lines
4.2 KiB
PHP
<?php
|
|
/* Copyright (C) 2006-2015 Laurent Destailleur <eldy@users.sourceforge.net>
|
|
* Copyright (C) 2005-2013 Regis Houssin <regis.houssin@inodbox.com>
|
|
* Copyright (C) 2010-2020 Juanjo Menent <jmenent@2byte.es>
|
|
* Copyright (C) 2012-2013 Christophe Battarel <christophe.battarel@altairis.fr>
|
|
* Copyright (C) 2011-2022 Philippe Grand <philippe.grand@atoo-net.com>
|
|
* Copyright (C) 2012-2015 Marcos García <marcosgdf@gmail.com>
|
|
* Copyright (C) 2012-2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
|
|
* Copyright (C) 2012 Cedric Salvador <csalvador@gpcsolutions.fr>
|
|
* Copyright (C) 2015-2022 Alexandre Spangaro <aspangaro@open-dsi.fr>
|
|
* Copyright (C) 2016 Bahfir abbes <bafbes@gmail.com>
|
|
* Copyright (C) 2017 ATM Consulting <support@atm-consulting.fr>
|
|
* Copyright (C) 2017-2019 Nicolas ZABOURI <info@inovea-conseil.com>
|
|
* Copyright (C) 2017 Rui Strecht <rui.strecht@aliartalentos.com>
|
|
* Copyright (C) 2018-2025 Frédéric France <frederic.france@free.fr>
|
|
* Copyright (C) 2018 Josep Lluís Amador <joseplluis@lliuretic.cat>
|
|
* Copyright (C) 2023 Gauthier VERDOL <gauthier.verdol@atm-consulting.fr>
|
|
* Copyright (C) 2021 Grégory Blémand <gregory.blemand@atm-consulting.fr>
|
|
* Copyright (C) 2023 Lenin Rivas <lenin.rivas777@gmail.com>
|
|
* Copyright (C) 2024-2025 MDW <mdeweerd@users.noreply.github.com>
|
|
* Copyright (C) 2024 William Mead <william.mead@manchenumerique.fr>
|
|
* Copyright (C) 2025 Alexandre Janniaux <alexandre.janniaux@gmail.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/>.
|
|
*/
|
|
|
|
|
|
/**
|
|
* Parent class of all other business classes (invoices, contracts, proposals, orders, ...)
|
|
*
|
|
* @phan-forbid-undeclared-magic-properties
|
|
*/
|
|
trait CommonTrigger
|
|
{
|
|
const TRIGGER_PREFIX = ''; // to be overridden in child class implementations, i.e. 'BILL', 'TASK', 'PROPAL', etc.
|
|
|
|
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
|
|
/**
|
|
* Call trigger based on this instance.
|
|
* Some context information may also be provided into array property this->context.
|
|
* NB: Error from trigger are stacked in interface->errors
|
|
* NB2: If return code of triggers are < 0, action calling trigger should cancel all transaction.
|
|
*
|
|
* @param string $triggerName trigger's name to execute
|
|
* @param User $user Object user
|
|
* @return int Result of run_triggers
|
|
*/
|
|
public function call_trigger($triggerName, $user)
|
|
{
|
|
// phpcs:enable
|
|
global $langs, $conf;
|
|
|
|
if (!empty(self::TRIGGER_PREFIX) && strpos($triggerName, self::TRIGGER_PREFIX . '_') !== 0) {
|
|
dol_print_error(null, 'The trigger "' . $triggerName . '" does not start with "' . self::TRIGGER_PREFIX . '_" as required.');
|
|
exit;
|
|
}
|
|
if (!is_object($langs)) { // If lang was not defined, we set it. It is required by run_triggers().
|
|
dol_syslog("call_trigger was called with no langs variable defined".getCallerInfoString(), LOG_WARNING);
|
|
include_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php';
|
|
$langs = new Translate('', $conf);
|
|
$langs->load("main");
|
|
}
|
|
|
|
include_once DOL_DOCUMENT_ROOT.'/core/class/interfaces.class.php';
|
|
$interface = new Interfaces($this->db);
|
|
$result = $interface->run_triggers($triggerName, $this, $user, $langs, $conf);
|
|
|
|
if ($result < 0) {
|
|
if (!empty($this->errors)) {
|
|
$this->errors = array_unique(array_merge($this->errors, $interface->errors)); // We use array_unique because when a trigger call another trigger on same object, this->errors is added twice.
|
|
} else {
|
|
$this->errors = $interface->errors;
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
}
|