price_global_variable.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2012 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2014    Juanjo Menent    <jmenent@2byte.es>
/* Copyright (C) 2015      Ion Agorria          <ion@agorria.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 PriceGlobalVariable
{
  public $db;

  public $error = '';

  public $errors = array();

  public $id;

  public $code;

  public $description;

  public $value;

  public $table_element = "c_price_global_variable";

  public function __construct($db)
  {
    $this->db = $db;
  }


  public function create($user, $notrigger = 0)
  {
    $error = 0;

    $this->checkParameters();

    // Insert request
    $sql = "INSERT INTO ".MAIN_DB_PREFIX.$this->table_element." (";
    $sql .= "code, description, value";
    $sql .= ") VALUES (";
    $sql .= " ".(isset($this->code) ? "'".$this->db->escape($this->code)."'" : "''").",";
    $sql .= " ".(isset($this->description) ? "'".$this->db->escape($this->description)."'" : "''").",";
    $sql .= " ".$this->value;
    $sql .= ")";

    $this->db->begin();

    dol_syslog(__METHOD__);
    $resql = $this->db->query($sql);
    if (!$resql) { $error++; $this->errors[] = "Error ".$this->db->lasterror(); }

    if (!$error)
    {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX.$this->table_element);

      if (!$notrigger)
      {
        // Uncomment this and change MYOBJECT to your own tag if you
        // want this action calls a trigger.

        //$result=$this->call_trigger('MYOBJECT_CREATE',$user);
        //if ($result < 0) { $error++; //Do also what you must do to rollback action if trigger fail}
      }
    }

    // Commit or rollback
    if ($error)
    {
      foreach ($this->errors as $errmsg)
      {
        dol_syslog(__METHOD__." ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return $this->id;
    }
  }


  public function fetch($id)
  {
    $sql = "SELECT code, description, value";
    $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element;
    $sql .= " WHERE rowid = ".$id;

    dol_syslog(__METHOD__);
    $resql = $this->db->query($sql);
    if ($resql)
    {
      $obj = $this->db->fetch_object($resql);
      if ($obj)
      {
        $this->id = $id;
        $this->code     = $obj->code;
        $this->description = $obj->description;
        $this->value    = $obj->value;
        $this->checkParameters();
        return 1;
      } else {
        return 0;
      }
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }

  public function update($user = 0, $notrigger = 0)
  {
    $error = 0;

    $this->checkParameters();

    // Update request
    $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element." SET";
    $sql .= " code = ".(isset($this->code) ? "'".$this->db->escape($this->code)."'" : "''").",";
    $sql .= " description = ".(isset($this->description) ? "'".$this->db->escape($this->description)."'" : "''").",";
    $sql .= " value = ".$this->value;
    $sql .= " WHERE rowid = ".$this->id;

    $this->db->begin();

    dol_syslog(__METHOD__);
    $resql = $this->db->query($sql);
    if (!$resql) { $error++; $this->errors[] = "Error ".$this->db->lasterror(); }

    // if (! $error)
    // {
    //     if (! $notrigger)
    //     {
    //         // Uncomment this and change MYOBJECT to your own tag if you
    //         // want this action calls a trigger.

    //         //// Call triggers
    //         //$result=$this->call_trigger('MYOBJECT_MODIFY',$user);
    //         //if ($result < 0) { $error++; //Do also what you must do to rollback action if trigger fail}
    //         //// End call triggers
    //     }
    // }

    // Commit or rollback
    if ($error)
    {
      foreach ($this->errors as $errmsg)
      {
        dol_syslog(__METHOD__." ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return 1;
    }
  }


  public function delete($rowid, $user, $notrigger = 0)
  {
    $error = 0;

    $this->db->begin();

    if (!$error)
    {
      if (!$notrigger)
      {
        // Uncomment this and change MYOBJECT to your own tag if you
        // want this action calls a trigger.

        //$result=$this->call_trigger('MYOBJECT_DELETE',$user);
        //if ($result < 0) { $error++; //Do also what you must do to rollback action if trigger fail}
      }
    }

    if (!$error)
    {
      $sql = "DELETE FROM ".MAIN_DB_PREFIX.$this->table_element;
      $sql .= " WHERE rowid = ".$rowid;

      dol_syslog(__METHOD__);
      $resql = $this->db->query($sql);
      if (!$resql) { $error++; $this->errors[] = "Error ".$this->db->lasterror(); }
    }

    // Commit or rollback
    if ($error)
    {
      foreach ($this->errors as $errmsg)
      {
        dol_syslog(__METHOD__." ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return 1;
    }
  }

  public function initAsSpecimen()
  {
    $this->id = 0;
    $this->code = '';
    $this->description = '';
    $this->value = '';
  }

  public function checkParameters()
  {
    // Clean parameters
    if (isset($this->code)) $this->code = trim($this->code);
    if (isset($this->description)) $this->description = trim($this->description);

    // Check parameters
    if (empty($this->value) || !is_numeric($this->value)) $this->value = 0;
  }

  public function listGlobalVariables()
  {
    $sql = "SELECT rowid, code, description, value";
    $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element;
    $sql .= " ORDER BY code";

    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql)
    {
      $retarray = array();

      while ($record = $this->db->fetch_array($resql))
      {
        $variable_obj = new PriceGlobalVariable($this->db);
        $variable_obj->id = $record["rowid"];
        $variable_obj->code = $record["code"];
        $variable_obj->description = $record["description"];
        $variable_obj->value = $record["value"];
        $variable_obj->checkParameters();
        $retarray[] = $variable_obj;
      }

      $this->db->free($resql);
      return $retarray;
    } else {
      $this->error = $this->db->error();
      return -1;
    }
  }
}