dolibarrtriggers.class.php

<?php
/* Copyright (C) 2014   Marcos García     <marcosgdf@gmail.com>
 * Copyright (C) 2023-2024  William Mead      <william.mead@manchenumerique.fr>
 *
 * 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/>.
 */
 
abstract class DolibarrTriggers
{
  protected $db;
 
  public $name;
 
  public $description;
 
  public $version;
 
  public $picto;
 
  public $family;
 
  public $error;
 
  public $errors;
 
  const VERSION_DEVELOPMENT = 'development';
 
  const VERSION_EXPERIMENTAL = 'experimental';
 
  const VERSION_DOLIBARR = 'dolibarr';
 
  const VERSIONS = [
    'dev' => 'development',
    'exp' => 'experimental',
    'prod' => 'dolibarr'
  ];
 
  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 = [];
  }
 
  public function getName()
  {
    return $this->name;
  }
 
  public function getDesc()
  {
    return $this->description;
  }
 
  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;
    }
  }
 
  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);
    }
  }
 
  abstract public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf);
}