dolibarrtriggers.class.php

<?php
/* Copyright (C) 2014 Marcos García         <marcosgdf@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/>.
 */
 
abstract class DolibarrTriggers
{
  protected $db;
 
  public $name = '';
 
  public $description = '';
 
  public $version = self::VERSION_DEVELOPMENT;
 
  public $picto = 'technic';
 
  public $family = '';
 
  public $error = '';
 
  public $errors = array();
 
  const VERSION_DEVELOPMENT = 'development';
 
  const VERSION_EXPERIMENTAL = 'experimental';
 
  const VERSION_DOLIBARR = 'dolibarr';
 
  public function __construct(DoliDB $db)
  {
    $this->db = $db;
 
    if (empty($this->name)) {
      $this->name = preg_replace('/^Interface/i', '', get_class($this));
    }
  }
 
  public function getName()
  {
    return $this->name;
  }
 
  public function getDesc()
  {
    return $this->description;
  }
 
  public function getVersion()
  {
    global $langs;
    $langs->load("admin");
 
    if ($this->version == self::VERSION_DEVELOPMENT) {
      return $langs->trans("VersionDevelopment");
    } elseif ($this->version == self::VERSION_EXPERIMENTAL) {
      return $langs->trans("VersionExperimental");
    } elseif ($this->version == self::VERSION_DOLIBARR) {
      return DOL_VERSION;
    } elseif ($this->version) {
      return $this->version;
    } else {
      return $langs->trans("Unknown");
    }
  }
 
  public function setErrorsFromObject($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);
}