dolibarr/htdocs/core/triggers/dolibarrtriggers.class.php

<?php
/* Copyright (C) 2014		Marcos García			<marcosgdf@gmail.com>
 * Copyright (C) 2023-2024	William Mead			<william.mead@manchenumerique.fr>
 * 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/>.
 */

/**
 * Class that all triggers must inherit
 */
abstract class DolibarrTriggers
{
	/**
	 * Database handler
	 * @var DoliDB
	 */
	protected $db;

	/**
	 * Name of the trigger
	 * @var mixed|string
	 */
	public $name;

	/**
	 * Description of the trigger
	 * @var string
	 */
	public $description;

	/**
	 * Version of the trigger
	 * @var ''|'development'|'dolibarr'|'experimental'
	 */
	public $version;

	/**
	 * Image of the trigger
	 * @var string
	 */
	public $picto;

	/**
	 * Category of the trigger
	 * @var string
	 */
	public $family;

	/**
	 * Error reported by the trigger
	 * @var string
	 * @deprecated Use $this->errors
	 * @see $errors
	 */
	public $error;

	/**
	 * Errors reported by the trigger
	 * @var array
	 */
	public $errors;

	/**
	 * @var string module is in development
	 * @deprecated Use self::VERSIONS
	 * @see self::VERSIONS
	 */
	const VERSION_DEVELOPMENT = 'development';

	/**
	 * @var string module is experimental
	 * @deprecated Use self::VERSIONS
	 * @see self::VERSIONS
	 */
	const VERSION_EXPERIMENTAL = 'experimental';

	/**
	 * @var string module is dolibarr ready
	 * @deprecated Use self::VERSIONS
	 * @see self::VERSIONS
	 */
	const VERSION_DOLIBARR = 'dolibarr';

	/**
	 * @var array dictionary of possible module states
	 */
	const VERSIONS = [
		'dev' => 'development',
		'exp' => 'experimental',
		'prod' => 'dolibarr'
	];

	/**
	 * Constructor
	 *
	 * @param DoliDB $db Database handler
	 */
	public function __construct(DoliDB $db)
	{
		$this->db = $db;
		$this->name = preg_replace('/^Interface/i', '', get_class($this));
		$this->description = '';
		$this->version = self::VERSIONS['dev'];
		$this->picto = 'technic';
		$this->family = '';
		$this->error = '';
		$this->errors = [];
	}

	/**
	 * Returns the name of the trigger file
	 *
	 * @return string
	 */
	public function getName()
	{
		return $this->name;
	}

	/**
	 * Returns the description of trigger file
	 *
	 * @return string
	 */
	public function getDesc()
	{
		return $this->description;
	}

	/**
	 * Returns the version of the trigger file
	 *
	 * @return string Version of trigger file
	 */
	public function getVersion()
	{
		global $langs;
		$langs->load("admin");
		switch ($this->version) { // TODO use a match expression @ Dolibarr minimum PHP v8.0
			case self::VERSIONS['dev']:
				return $langs->trans("VersionDevelopment");
			case self::VERSIONS['exp']:
				return $langs->trans("VersionExperimental");
			case self::VERSIONS['prod']:
				return DOL_VERSION;
			default:
				return $this->version;
		}
	}

	/**
	 * setErrorsFromObject
	 *
	 * @param	CommonObject	$object		Object
	 * @return	void
	 */
	public function setErrorsFromObject(CommonObject $object)
	{
		if (!empty($object->error)) {
			$this->errors = array_merge($this->errors, array($object->error));
		}
		if (!empty($object->errors)) {
			$this->errors = array_merge($this->errors, $object->errors);
		}
	}

	/**
	 *  Function called when a Dolibarr business event is done.
	 *  All functions "runTrigger" are triggered if file is inside directory htdocs/core/triggers or htdocs/module/code/triggers (and declared)
	 *
	 *  @param string       $action     Event action code
	 *  @param Object       $object     Object
	 *  @param User         $user       Object user
	 *  @param Translate    $langs      Object langs
	 *  @param conf         $conf       Object conf
	 *  @return int                     if KO: <0 || if no trigger ran: 0 || if OK: >0
	 */
	abstract public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf);
}