api_subscriptions.class.php

<?php
/* Copyright (C) 2016   Xebax Christy           <xebax@wanadoo.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/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/adherents/class/subscription.class.php';
 
class Subscriptions extends DolibarrApi
{
  public static $FIELDS = array(
    'fk_adherent',
    'dateh',
    'datef',
    'amount',
  );
 
  public $subscription;
 
  public function __construct()
  {
    global $db, $conf;
    $this->db = $db;
    $this->subscription = new Subscription($this->db);
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('adherent', 'cotisation', 'lire')) {
      throw new RestException(403);
    }
 
    $result = $this->subscription->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Subscription not found');
    }
 
    // A subscription has no entity, the entity is the one of its member
    if (!DolibarrApi::_checkAccessToResource('adherent', $this->subscription->fk_adherent)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $this->subscription->fetchObjectLinked();
 
    return $this->_cleanObjectDatas($this->subscription);
  }
 
  public function index($sortfield = "dateadh", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '', $properties = '', $pagination_data = false)
  {
    global $conf;
 
    $obj_ret = array();
 
    if (!DolibarrApiAccess::$user->hasRight('adherent', 'cotisation', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."subscription as t";
    $sql .= ' WHERE 1 = 1';
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(503, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    //this query will return total orders with the filters given
    $sqlTotals = str_replace('SELECT rowid', 'SELECT count(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);
    }
 
    $result = $this->db->query($sql);
    if ($result) {
      $i = 0;
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $subscription = new Subscription($this->db);
        if ($subscription->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($subscription), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve subscription list : '.$this->db->lasterror());
    }
 
    //if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
    if ($pagination_data) {
      $totalsResult = $this->db->query($sqlTotals);
      $total = $this->db->fetch_object($totalsResult)->total;
 
      $tmp = $obj_ret;
      $obj_ret = [];
 
      $obj_ret['data'] = $tmp;
      $obj_ret['pagination'] = [
        'total' => (int) $total,
        'page' => $page, //count starts from 0
        'page_count' => ceil((int) $total / $limit),
        'limit' => $limit
      ];
    }
 
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('adherent', 'cotisation', 'creer')) {
      throw new RestException(403);
    }
    // Check mandatory fields
    $result = $this->_validate($request_data);
 
    // The member of the new subscription must be a member of an entity the user can access
    if (!empty($request_data['fk_adherent']) && !DolibarrApi::_checkAccessToResource('adherent', (int) $request_data['fk_adherent'])) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $subscription = new Subscription($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
        $subscription->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $subscription->$field = $this->_checkValForAPI($field, $value, $subscription);
    }
    if ($subscription->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error when creating subscription', array_merge(array($subscription->error), $subscription->errors));
    }
    return $subscription->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('adherent', 'creer')) {
      throw new RestException(403);
    }
 
    $subscription = new Subscription($this->db);
    $result = $subscription->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Subscription not found');
    }
 
    // A subscription has no entity, the entity is the one of its member
    if (!DolibarrApi::_checkAccessToResource('adherent', $subscription->fk_adherent)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    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
        $subscription->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $subscription->array_options[$index] = $this->_checkValForAPI($field, $val, $subscription);
        }
        continue;
      }
      $subscription->$field = $this->_checkValForAPI($field, $value, $subscription);
    }
 
    if ($subscription->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, 'Error when updating contribution: '.$subscription->error);
    }
  }
 
  public function delete($id)
  {
    // The right to delete a subscription comes with the right to create one.
    if (!DolibarrApiAccess::$user->hasRight('adherent', 'cotisation', 'creer')) {
      throw new RestException(403);
    }
    $subscription = new Subscription($this->db);
    $result = $subscription->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Subscription not found');
    }
 
    // A subscription has no entity, the entity is the one of its member
    if (!DolibarrApi::_checkAccessToResource('adherent', $subscription->fk_adherent)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $res = $subscription->delete(DolibarrApiAccess::$user);
    if ($res < 0) {
      throw new RestException(500, "Can't delete, error occurs");
    } elseif ($res == 0) {
      throw new RestException(409, "No subscription whas deleted");
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Subscription deleted'
      )
    );
  }
 
  private function _validate($data)
  {
    $subscription = array();
    foreach (Subscriptions::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $subscription[$field] = $data[$field];
    }
    return $subscription;
  }
}