?iť?
Current Path : /home/s/c/g/scgforma/www/soc064/htdocs/don/class/ |
Current File : /home/s/c/g/scgforma/www/soc064/htdocs/don/class/api_donations.class.php |
<?php /* Copyright (C) 2019 Thibault FOUCART <support@ptibogxiv.net> * Copyright (C) 2019 Laurent Destailleur <eldy@users.sourceforge.net> * * 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 <http://www.gnu.org/licenses/>. */ use Luracast\Restler\RestException; require_once DOL_DOCUMENT_ROOT.'/don/class/don.class.php'; /** * API class for donations * * @access protected * @class DolibarrApiAccess {@requires user,external} */ class Donations extends DolibarrApi { /** * @var array $FIELDS Mandatory fields, checked when create and update object */ static $FIELDS = array( 'socid' ); /** * @var Don $don {@type Don} */ public $don; /** * Constructor */ public function __construct() { global $db, $conf; $this->db = $db; $this->don = new Don($this->db); } /** * Get properties of an donation object * * Return an array with donation informations * * @param int $id ID of order * @return array|mixed data without useless information * * @throws RestException */ public function get($id) { if(! DolibarrApiAccess::$user->rights->don->lire) { throw new RestException(401); } $result = $this->don->fetch($id); if( ! $result ) { throw new RestException(404, 'Donation not found'); } if( ! DolibarrApi::_checkAccessToResource('don', $this->don->id)) { throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login); } // Add external contacts ids //$this->don->contacts_ids = $this->don->liste_contact(-1,'external',1); //$this->don->fetchObjectLinked(); return $this->_cleanObjectDatas($this->don); } /** * List donations * * Get a list of donations * * @param string $sortfield Sort field * @param string $sortorder Sort order * @param int $limit Limit for list * @param int $page Page number * @param string $thirdparty_ids Thirdparty ids to filter orders of. {@example '1' or '1,2,3'} {@pattern /^[0-9,]*$/i} * @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')" * @return array Array of order objects * * @throws RestException */ public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $sqlfilters = '') { global $db, $conf; $obj_ret = array(); // case of external user, $thirdparty_ids param is ignored and replaced by user's socid $socids = DolibarrApiAccess::$user->societe_id ? DolibarrApiAccess::$user->societe_id : $thirdparty_ids; $sql = "SELECT t.rowid"; if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) ) $sql .= ", sc.fk_soc, sc.fk_user"; // We need these fields in order to filter by sale (including the case where the user can only see his prospects) $sql.= " FROM ".MAIN_DB_PREFIX."don as t"; $sql.= ' WHERE t.entity IN ('.getEntity('don').')'; if ((!DolibarrApiAccess::$user->rights->societe->client->voir && !$socids) ) $sql.= " AND t.fk_soc = sc.fk_soc"; if ($thirdparty_ids) $sql.= " AND t.fk_soc = ".$thirdparty_ids." "; // Add sql filters if ($sqlfilters) { if (! DolibarrApi::_checkFilters($sqlfilters)) { throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters); } $regexstring='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)'; $sql.=" AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")"; } $sql.= $db->order($sortfield, $sortorder); if ($limit) { if ($page < 0) { $page = 0; } $offset = $limit * $page; $sql.= $db->plimit($limit + 1, $offset); } dol_syslog("API Rest request"); $result = $db->query($sql); if ($result) { $num = $db->num_rows($result); $min = min($num, ($limit <= 0 ? $num : $limit)); $i=0; while ($i < $min) { $obj = $db->fetch_object($result); $don_static = new Don($db); if($don_static->fetch($obj->rowid)) { // Add external contacts ids //$don_static->contacts_ids = $don_static->liste_contact(-1, 'external', 1); $obj_ret[] = $this->_cleanObjectDatas($don_static); } $i++; } } else { throw new RestException(503, 'Error when retrieve donation list : '.$db->lasterror()); } if( ! count($obj_ret)) { throw new RestException(404, 'No donation found'); } return $obj_ret; } /** * Create donation object * * @param array $request_data Request data * @return int ID of order */ public function post($request_data = null) { if (! DolibarrApiAccess::$user->rights->don->creer) { throw new RestException(401, "Insuffisant rights"); } // Check mandatory fields $result = $this->_validate($request_data); foreach ($request_data as $field => $value) { $this->don->$field = $value; } /*if (isset($request_data["lines"])) { $lines = array(); foreach ($request_data["lines"] as $line) { array_push($lines, (object) $line); } $this->don->lines = $lines; }*/ if ($this->don->create(DolibarrApiAccess::$user) < 0) { throw new RestException(500, "Error creating order", array_merge(array($this->don->error), $this->don->errors)); } return $this->don->id; } /** * Update order general fields (won't touch lines of order) * * @param int $id Id of order to update * @param array $request_data Datas * * @return int */ public function put($id, $request_data = null) { if (! DolibarrApiAccess::$user->rights->don->creer) { throw new RestException(401); } $result = $this->don->fetch($id); if (! $result) { throw new RestException(404, 'Donation not found'); } if (! DolibarrApi::_checkAccessToResource('donation', $this->don->id)) { throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login); } foreach ($request_data as $field => $value) { if ($field == 'id') continue; $this->don->$field = $value; } if ($this->don->update(DolibarrApiAccess::$user) > 0) { return $this->get($id); } else { throw new RestException(500, $this->don->error); } } /** * Delete donation * * @param int $id Order ID * @return array */ public function delete($id) { if(! DolibarrApiAccess::$user->rights->don->supprimer) { throw new RestException(401); } $result = $this->don->fetch($id); if( ! $result ) { throw new RestException(404, 'Donation not found'); } if( ! DolibarrApi::_checkAccessToResource('donation', $this->don->id)) { throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login); } if( ! $this->don->delete(DolibarrApiAccess::$user)) { throw new RestException(500, 'Error when delete donation : '.$this->don->error); } return array( 'success' => array( 'code' => 200, 'message' => 'Donation deleted' ) ); } /** * Validate an donation * * If you get a bad value for param notrigger check, provide this in body * { * "idwarehouse": 0, * "notrigger": 0 * } * * @param int $id Order ID * @param int $idwarehouse Warehouse ID * @param int $notrigger 1=Does not execute triggers, 0= execute triggers * * @url POST {id}/validate * * @throws 304 * @throws 401 * @throws 404 * @throws 500 * * @return array */ public function validate($id, $idwarehouse = 0, $notrigger = 0) { if(! DolibarrApiAccess::$user->rights->don->creer) { throw new RestException(401); } $result = $this->don->fetch($id); if( ! $result ) { throw new RestException(404, 'Donation not found'); } if( ! DolibarrApi::_checkAccessToResource('don', $this->don->id)) { throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login); } $result = $this->don->valid(DolibarrApiAccess::$user, $idwarehouse, $notrigger); if ($result == 0) { throw new RestException(304, 'Error nothing done. May be object is already validated'); } if ($result < 0) { throw new RestException(500, 'Error when validating Order: '.$this->don->error); } $result = $this->don->fetch($id); if( ! $result ) { throw new RestException(404, 'Order not found'); } if( ! DolibarrApi::_checkAccessToResource('don', $this->don->id)) { throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login); } $this->don->fetchObjectLinked(); return $this->_cleanObjectDatas($this->don); } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore /** * Clean sensible object datas * * @param object $object Object to clean * @return array Array of cleaned object properties */ protected function _cleanObjectDatas($object) { // phpcs:enable $object = parent::_cleanObjectDatas($object); unset($object->note); unset($object->address); unset($object->barcode_type); unset($object->barcode_type_code); unset($object->barcode_type_label); unset($object->barcode_type_coder); return $object; } /** * Validate fields before create or update object * * @param array $data Array with data to verify * @return array * @throws RestException */ private function _validate($data) { $don = array(); foreach (Orders::$FIELDS as $field) { if (!isset($data[$field])) throw new RestException(400, $field ." field missing"); $don[$field] = $data[$field]; } return $don; } }