api_variouspayments.class.php

<?php
/*
 * Copyright (C) 2026 Xabier Trigo Losada <xabi@galicloud.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/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/paymentvarious.class.php';
 
class VariousPayments extends DolibarrApi
{
  public static $FIELDS = array(
    'datep',
    'amount',
    'label',
  );
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'lire')) {
      throw new RestException(403);
    }
 
    $payment = new PaymentVarious($this->db);
    $result = $payment->fetch($id);
    // PaymentVarious::fetch() returns 1 even when the record does not exist,
    // so also check that the id was actually loaded.
    if ($result <= 0 || empty($payment->id)) {
      throw new RestException(404, 'Various payment not found');
    }
 
    return $this->_cleanObjectDatas($payment);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '', $properties = '', $pagination_data = false)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'lire')) {
      throw new RestException(403);
    }
 
    $obj_ret = array();
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."payment_various AS t";
    $sql .= " WHERE t.entity IN (".getEntity('payment_various').")";
 
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    // This query will count total records matching the filters (before pagination)
    $sqlTotals = str_replace('SELECT t.rowid', 'SELECT count(t.rowid) as total', $sql);
 
    $sql .= $this->db->order($sortfield, $sortorder);
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit + 1, $offset);
    }
 
    dol_syslog("API Rest request");
    $result = $this->db->query($sql);
 
    if (!$result) {
      throw new RestException(503, 'Error when retrieving list of various payments: '.$this->db->lasterror());
    }
 
    $num = $this->db->num_rows($result);
    $min = min($num, ($limit <= 0 ? $num : $limit));
    for ($i = 0; $i < $min; $i++) {
      $obj = $this->db->fetch_object($result);
      $payment = new PaymentVarious($this->db);
      if ($payment->fetch($obj->rowid) > 0) {
        $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($payment), $properties);
      }
    }
 
    // If $pagination_data is true, the response will contain the element data with all values
    // and the element pagination with pagination data (total, page, page_count, limit)
    if ($pagination_data) {
      $totalsResult = $this->db->query($sqlTotals);
      $total = $this->db->fetch_object($totalsResult)->total;
 
      $tmp = $obj_ret;
      $obj_ret = array();
 
      $obj_ret['data'] = $tmp;
      $obj_ret['pagination'] = array(
        'total' => (int) $total,
        'page' => $page, // count starts from 0
        'page_count' => ($limit > 0 ? (int) ceil((int) $total / $limit) : 1),
        'limit' => $limit
      );
    }
 
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'modifier')) {
      throw new RestException(403);
    }
 
    // Check mandatory fields
    $this->_validate($request_data);
 
    $payment = new PaymentVarious($this->db);
    foreach ($request_data as $field => $value) {
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $payment->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $payment->$field = $this->_checkValForAPI($field, $value, $payment);
    }
 
    if ($payment->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error when creating various payment: '.$payment->errorsToString());
    }
 
    return $payment->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'modifier')) {
      throw new RestException(403);
    }
 
    $payment = new PaymentVarious($this->db);
    $result = $payment->fetch($id);
    // PaymentVarious::fetch() returns 1 even when the record does not exist,
    // so also check that the id was actually loaded.
    if ($result <= 0 || empty($payment->id)) {
      throw new RestException(404, 'Various payment not found');
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $payment->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $payment->array_options[$index] = $this->_checkValExtrafieldsForAPI($index, $val, $payment);
        }
        continue;
      }
 
      $payment->$field = $this->_checkValForAPI($field, $value, $payment);
    }
 
    if ($payment->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, 'Error when updating various payment: '.$payment->errorsToString());
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('banque', 'modifier')) {
      throw new RestException(403);
    }
 
    $payment = new PaymentVarious($this->db);
    $result = $payment->fetch($id);
    // PaymentVarious::fetch() returns 1 even when the record does not exist,
    // so also check that the id was actually loaded.
    if ($result <= 0 || empty($payment->id)) {
      throw new RestException(404, 'Various payment not found');
    }
 
    if ($payment->delete(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error when deleting various payment: '.$payment->errorsToString());
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Various payment deleted'
      )
    );
  }
 
  private function _validate($data)
  {
    if ($data === null) {
      $data = array();
    }
    $payment = array();
    foreach (VariousPayments::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $payment[$field] = $data[$field];
    }
    return $payment;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->statut);   // Not used for various payments
    unset($object->labelStatus);
    unset($object->labelStatusShort);
    unset($object->accountid);  // Deprecated, use fk_account
 
    return $object;
  }
}