mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2026-01-04 08:02:22 +01:00
Fix Update PSWebServiceLibrary to fix deprecated function call libxml_disable_entity_loader()
# Fix PSWebServiceLibrary.class.php: PhanDeprecatedFunctionInternal: Call to deprecated function \libxml_disable_entity_loader() See https://github.com/Dolibarr/dolibarr/actions/runs/7242938198/job/19729044021#step:5:32
This commit is contained in:
MDW
@@ -1,6 +1,6 @@
|
||||
<?php
|
||||
/*
|
||||
* 2007-2013 PrestaShop
|
||||
* 2007-2022 PrestaShop SA and Contributors
|
||||
*
|
||||
* NOTICE OF LICENSE
|
||||
*
|
||||
@@ -18,10 +18,10 @@
|
||||
* versions in the future. If you wish to customize PrestaShop for your
|
||||
* needs please refer to https://www.prestashop.com for more information.
|
||||
*
|
||||
* @author PrestaShop SA <contact@prestashop.com>
|
||||
* @copyright 2007-2013 PrestaShop SA
|
||||
* @license https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
|
||||
* International Registered Trademark & Property of PrestaShop SA
|
||||
* @author PrestaShop SA <contact@prestashop.com>
|
||||
* @copyright 2007-2022 PrestaShop SA
|
||||
* @license https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
|
||||
* International Registered Trademark & Property of PrestaShop SA
|
||||
* PrestaShop Webservice Library
|
||||
* @package PrestaShopWebservice
|
||||
*/
|
||||
@@ -31,10 +31,11 @@
|
||||
*/
|
||||
class PrestaShopWebservice
|
||||
{
|
||||
|
||||
/** @var string Shop URL */
|
||||
protected $url;
|
||||
|
||||
/** @var string Authentification key */
|
||||
/** @var string Authentication key */
|
||||
protected $key;
|
||||
|
||||
/** @var boolean is debug activated */
|
||||
@@ -43,36 +44,40 @@ class PrestaShopWebservice
|
||||
/** @var string PS version */
|
||||
protected $version;
|
||||
|
||||
/** @var string compatible min version of PrestaShop Webservice */
|
||||
const PSCOMPATIBLEVERSIONMIN = '1.4.0.0';
|
||||
/** @var string compatible max version of PrestaShop Webservice */
|
||||
const PSCOMPATIBLEVERSIONMAX = '1.7.99.99';
|
||||
|
||||
/** @var string Minimal version of PrestaShop to use with this library */
|
||||
const psCompatibleVersionsMin = '1.4.0.0';
|
||||
/** @var string Maximal version of PrestaShop to use with this library */
|
||||
const psCompatibleVersionsMax = '8.1.1';
|
||||
|
||||
/**
|
||||
* PrestaShopWebservice constructor. Throw an exception when CURL is not installed/activated
|
||||
* <code>
|
||||
* <?php
|
||||
* require_once './PrestaShopWebservice.php';
|
||||
* require_once('./PrestaShopWebservice.php');
|
||||
* try
|
||||
* {
|
||||
* $ws = new PrestaShopWebservice('http://mystore.com/', 'ZQ88PRJX5VWQHCWE4EE7SQ7HPNX00RAJ', false);
|
||||
* // Now we have a webservice object to play with
|
||||
* $ws = new PrestaShopWebservice('https://mystore.com/', 'ZQ88PRJX5VWQHCWE4EE7SQ7HPNX00RAJ', false);
|
||||
* // Now we have a webservice object to play with
|
||||
* }
|
||||
* catch (PrestaShopWebserviceException $ex)
|
||||
* {
|
||||
* echo 'Error : '.$ex->getMessage();
|
||||
* echo 'Error : '.$ex->getMessage();
|
||||
* }
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* @param string $url Root URL for the shop
|
||||
* @param string $key Authentification key
|
||||
* @param string $key Authentication key
|
||||
* @param mixed $debug Debug mode Activated (true) or deactivated (false)
|
||||
*
|
||||
* @throws PrestaShopWebserviceException if curl is not loaded
|
||||
*/
|
||||
public function __construct($url, $key, $debug = true)
|
||||
function __construct($url, $key, $debug = true)
|
||||
{
|
||||
if (!extension_loaded('curl')) {
|
||||
throw new PrestaShopWebserviceException('Please activate the PHP extension \'curl\' to allow use of PrestaShop webservice library');
|
||||
throw new PrestaShopWebserviceException(
|
||||
'Please activate the PHP extension \'curl\' to allow use of PrestaShop webservice library'
|
||||
);
|
||||
}
|
||||
$this->url = $url;
|
||||
$this->key = $key;
|
||||
@@ -82,51 +87,92 @@ class PrestaShopWebservice
|
||||
|
||||
/**
|
||||
* Take the status code and throw an exception if the server didn't return 200 or 201 code
|
||||
* <p>Unique parameter must take : <br><br>
|
||||
* 'status_code' => Status code of an HTTP return<br>
|
||||
* 'response' => CURL response
|
||||
* </p>
|
||||
*
|
||||
* @param array $request Response elements of CURL request
|
||||
*
|
||||
* @param int $status_code Status code of an HTTP return
|
||||
* @return void
|
||||
* @throws PrestaShopWebserviceException if HTTP status code is not 200 or 201
|
||||
*/
|
||||
protected function checkStatusCode($status_code)
|
||||
protected function checkStatusCode($request)
|
||||
{
|
||||
$error_label = 'This call to PrestaShop Web Services failed and returned an HTTP status of %d. That means: %s.';
|
||||
switch ($status_code) {
|
||||
switch ($request['status_code']) {
|
||||
case 200:
|
||||
case 201:
|
||||
break;
|
||||
case 204:
|
||||
throw new PrestaShopWebserviceException(sprintf($error_label, $status_code, 'No content'));
|
||||
$error_message = 'No content';
|
||||
break;
|
||||
case 400:
|
||||
throw new PrestaShopWebserviceException(sprintf($error_label, $status_code, 'Bad Request'));
|
||||
$error_message = 'Bad Request';
|
||||
break;
|
||||
case 401:
|
||||
throw new PrestaShopWebserviceException(sprintf($error_label, $status_code, 'Unauthorized'));
|
||||
$error_message = 'Unauthorized';
|
||||
break;
|
||||
case 404:
|
||||
throw new PrestaShopWebserviceException(sprintf($error_label, $status_code, 'Not Found'));
|
||||
$error_message = 'Not Found';
|
||||
break;
|
||||
case 405:
|
||||
throw new PrestaShopWebserviceException(sprintf($error_label, $status_code, 'Method Not Allowed'));
|
||||
$error_message = 'Method Not Allowed';
|
||||
break;
|
||||
case 500:
|
||||
throw new PrestaShopWebserviceException(sprintf($error_label, $status_code, 'Internal Server Error'));
|
||||
$error_message = 'Internal Server Error';
|
||||
break;
|
||||
default:
|
||||
throw new PrestaShopWebserviceException('This call to PrestaShop Web Services returned an unexpected HTTP status of:'.$status_code);
|
||||
throw new PrestaShopWebserviceException(
|
||||
'This call to PrestaShop Web Services returned an unexpected HTTP status of:' . $request['status_code']
|
||||
);
|
||||
}
|
||||
|
||||
if (!empty($error_message)) {
|
||||
$response = $this->parseXML($request['response']);
|
||||
$errors = $response->children()->children();
|
||||
if ($errors && count($errors) > 0) {
|
||||
foreach ($errors as $error) {
|
||||
$error_message.= ' - (Code ' . $error->code . '): ' . $error->message;
|
||||
}
|
||||
}
|
||||
$error_label = 'This call to PrestaShop Web Services failed and returned an HTTP status of %d. That means: %s.';
|
||||
throw new PrestaShopWebserviceException(sprintf($error_label, $request['status_code'], $error_message));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles a CURL request to PrestaShop Webservice. Can throw exception.
|
||||
*
|
||||
* @param string $url Resource name
|
||||
* @param mixed $curl_params CURL parameters (sent to curl_set_opt)
|
||||
* @return array status_code, response
|
||||
* Provides default parameters for the curl connection(s)
|
||||
* @return array Default parameters for curl connection(s)
|
||||
*/
|
||||
public function executeRequest($url, $curl_params = array())
|
||||
protected function getCurlDefaultParams()
|
||||
{
|
||||
$defaultParams = array(
|
||||
CURLOPT_HEADER => true,
|
||||
CURLOPT_RETURNTRANSFER => true,
|
||||
CURLINFO_HEADER_OUT => true,
|
||||
CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
|
||||
CURLOPT_USERPWD => $this->key.':',
|
||||
CURLOPT_HTTPHEADER => array('Expect:')
|
||||
CURLOPT_USERPWD => $this->key . ':',
|
||||
CURLOPT_HTTPHEADER => array('Expect:'),
|
||||
//CURLOPT_SSL_VERIFYPEER => false, // reminder, in dev environment sometimes self-signed certificates are used
|
||||
//CURLOPT_CAINFO => "PATH2CAINFO", // ssl certificate chain checking
|
||||
//CURLOPT_CAPATH => "PATH2CAPATH",
|
||||
);
|
||||
return $defaultParams;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles a CURL request to PrestaShop Webservice. Can throw exception.
|
||||
*
|
||||
* @param string $url Resource name
|
||||
* @param mixed $curl_params CURL parameters (sent to curl_set_opt)
|
||||
*
|
||||
* @return array status_code, response, header
|
||||
*
|
||||
* @throws PrestaShopWebserviceException
|
||||
*/
|
||||
protected function executeRequest($url, $curl_params = array())
|
||||
{
|
||||
$defaultParams = $this->getCurlDefaultParams();
|
||||
|
||||
dol_syslog("curl_init url=".$url);
|
||||
$session = curl_init($url);
|
||||
@@ -151,7 +197,7 @@ class PrestaShopWebservice
|
||||
|
||||
$index = strpos($response, "\r\n\r\n");
|
||||
if ($index === false && $curl_params[CURLOPT_CUSTOMREQUEST] != 'HEAD') {
|
||||
throw new PrestaShopWebserviceException('Bad HTTP response');
|
||||
throw new PrestaShopWebserviceException('Bad HTTP response ' . $response . curl_error($session));
|
||||
}
|
||||
|
||||
$header = substr($response, 0, $index);
|
||||
@@ -170,10 +216,13 @@ class PrestaShopWebservice
|
||||
|
||||
if (array_key_exists('PSWS-Version', $headerArray)) {
|
||||
$this->version = $headerArray['PSWS-Version'];
|
||||
if (version_compare(PrestaShopWebservice::PSCOMPATIBLEVERSIONMIN, $headerArray['PSWS-Version']) == 1 ||
|
||||
version_compare(PrestaShopWebservice::PSCOMPATIBLEVERSIONMAX, $headerArray['PSWS-Version']) == -1
|
||||
if (
|
||||
version_compare(PrestaShopWebservice::psCompatibleVersionsMin, $headerArray['PSWS-Version']) == 1 ||
|
||||
version_compare(PrestaShopWebservice::psCompatibleVersionsMax, $headerArray['PSWS-Version']) == -1
|
||||
) {
|
||||
throw new PrestaShopWebserviceException('This library is not compatible with this version of PrestaShop. Please upgrade/downgrade this library');
|
||||
throw new PrestaShopWebserviceException(
|
||||
'This library is not compatible with this version of PrestaShop. Please upgrade/downgrade this library'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -183,7 +232,7 @@ class PrestaShopWebservice
|
||||
}
|
||||
$status_code = curl_getinfo($session, CURLINFO_HTTP_CODE);
|
||||
if ($status_code === 0) {
|
||||
throw new PrestaShopWebserviceException('CURL Error: '.curl_error($session));
|
||||
throw new PrestaShopWebserviceException('CURL Error: ' . curl_error($session));
|
||||
}
|
||||
curl_close($session);
|
||||
if ($this->debug) {
|
||||
@@ -200,19 +249,27 @@ class PrestaShopWebservice
|
||||
/**
|
||||
* Output debug info
|
||||
*
|
||||
* @param string $title Title
|
||||
* @param string $content Content
|
||||
* @return void
|
||||
* @param string $title Title
|
||||
* @param string $content Content
|
||||
* @return void
|
||||
*/
|
||||
public function printDebug($title, $content)
|
||||
{
|
||||
echo '<div style="display:table;background:#CCC;font-size:8pt;padding:7px"><h6 style="font-size:9pt;margin:0">'.dol_escape_htmltag($title).'</h6><pre>'.dol_escape_htmltag($content).'</pre></div>';
|
||||
if (php_sapi_name() == 'cli') {
|
||||
echo $title . PHP_EOL . $content;
|
||||
} else {
|
||||
echo '<div style="display:table;background:#CCC;font-size:8pt;padding:7px"><h6 style="font-size:9pt;margin:0">'
|
||||
. $title
|
||||
. '</h6><pre>'
|
||||
. htmlentities($content)
|
||||
. '</pre></div>';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return version
|
||||
*
|
||||
* @return string Version
|
||||
* @return string Version
|
||||
*/
|
||||
public function getVersion()
|
||||
{
|
||||
@@ -222,9 +279,9 @@ class PrestaShopWebservice
|
||||
/**
|
||||
* Load XML from string. Can throw exception
|
||||
*
|
||||
* @param string $response String from a CURL response
|
||||
* @return SimpleXMLElement|boolean status_code, response
|
||||
* @param string $response String from a CURL response
|
||||
*
|
||||
* @return SimpleXMLElement status_code, response
|
||||
* @throws PrestaShopWebserviceException
|
||||
*/
|
||||
protected function parseXML($response)
|
||||
@@ -232,16 +289,11 @@ class PrestaShopWebservice
|
||||
if ($response != '') {
|
||||
libxml_clear_errors();
|
||||
libxml_use_internal_errors(true);
|
||||
libxml_disable_entity_loader(true); // Avoid load of external entities (security problem). Required only if LIBXML_VERSION < 20900
|
||||
|
||||
if (!function_exists('simplexml_load_string')) {
|
||||
throw new PrestaShopWebserviceException('Method simplexml_load_string not available. Your PHP does not support xml.');
|
||||
}
|
||||
$xml = simplexml_load_string($response, 'SimpleXMLElement', LIBXML_NOCDATA|LIBXML_NONET);
|
||||
$xml = simplexml_load_string(trim($response), 'SimpleXMLElement', LIBXML_NOCDATA);
|
||||
if (libxml_get_errors()) {
|
||||
$msg = var_export(libxml_get_errors(), true);
|
||||
libxml_clear_errors();
|
||||
throw new PrestaShopWebserviceException('HTTP XML response is not parsable: '.$msg);
|
||||
throw new PrestaShopWebserviceException('HTTP XML response is not parsable: ' . $msg);
|
||||
}
|
||||
return $xml;
|
||||
} else {
|
||||
@@ -256,62 +308,62 @@ class PrestaShopWebservice
|
||||
* 'postXml' => Full XML string to add resource<br><br>
|
||||
* Examples are given in the tutorial</p>
|
||||
*
|
||||
* @param array $options Options
|
||||
* @return SimpleXMLElement|boolean status_code, response
|
||||
* @param array $options
|
||||
*
|
||||
* @return SimpleXMLElement status_code, response
|
||||
* @throws PrestaShopWebserviceException
|
||||
*/
|
||||
public function add($options)
|
||||
{
|
||||
$xml = '';
|
||||
$url = '';
|
||||
|
||||
if (isset($options['resource'], $options['postXml']) || isset($options['url'], $options['postXml'])) {
|
||||
$url = (isset($options['resource']) ? $this->url.'/api/'.$options['resource'] : $options['url']);
|
||||
$url = (isset($options['resource']) ? $this->url . '/api/' . $options['resource'] : $options['url']);
|
||||
$xml = $options['postXml'];
|
||||
if (isset($options['id_shop'])) {
|
||||
$url .= '&id_shop='.$options['id_shop'];
|
||||
$url .= '&id_shop=' . $options['id_shop'];
|
||||
}
|
||||
if (isset($options['id_group_shop'])) {
|
||||
$url .= '&id_group_shop='.$options['id_group_shop'];
|
||||
$url .= '&id_group_shop=' . $options['id_group_shop'];
|
||||
}
|
||||
} else {
|
||||
throw new PrestaShopWebserviceException('Bad parameters given');
|
||||
}
|
||||
$request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => $xml));
|
||||
|
||||
$this->checkStatusCode($request['status_code']);
|
||||
$this->checkStatusCode($request);
|
||||
return $this->parseXML($request['response']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve (GET) a resource
|
||||
* <p>Unique parameter must take : <br><br>
|
||||
* 'url' => Full URL for a GET request of Webservice (ex: http://mystore.com/api/customers/1/)<br>
|
||||
* 'url' => Full URL for a GET request of Webservice (ex: https://mystore.com/api/customers/1/)<br>
|
||||
* OR<br>
|
||||
* 'resource' => Resource name,<br>
|
||||
* 'id' => ID of a resource you want to get<br><br>
|
||||
* </p>
|
||||
* <code>
|
||||
* <?php
|
||||
* require_once './PrestaShopWebservice.php';
|
||||
* require_once('./PrestaShopWebservice.php');
|
||||
* try
|
||||
* {
|
||||
* $ws = new PrestaShopWebservice('http://mystore.com/', 'ZQ88PRJX5VWQHCWE4EE7SQ7HPNX00RAJ', false);
|
||||
* $ws = new PrestaShopWebservice('https://mystore.com/', 'ZQ88PRJX5VWQHCWE4EE7SQ7HPNX00RAJ', false);
|
||||
* $xml = $ws->get(array('resource' => 'orders', 'id' => 1));
|
||||
* // Here in $xml, a SimpleXMLElement object you can parse
|
||||
* // Here in $xml, a SimpleXMLElement object you can parse
|
||||
* foreach ($xml->children()->children() as $attName => $attValue)
|
||||
* echo $attName.' = '.$attValue.'<br>';
|
||||
* echo $attName.' = '.$attValue.'<br />';
|
||||
* }
|
||||
* catch (PrestaShopWebserviceException $ex)
|
||||
* {
|
||||
* echo 'Error : '.$ex->getMessage();
|
||||
* echo 'Error : '.$ex->getMessage();
|
||||
* }
|
||||
* ?>
|
||||
* </code>
|
||||
* @param array $options Array representing resource to get.
|
||||
* @return SimpleXMLElement|boolean status_code, response
|
||||
*
|
||||
* @param array $options Array representing resource to get.
|
||||
*
|
||||
* @return SimpleXMLElement status_code, response
|
||||
* @throws PrestaShopWebserviceException
|
||||
*/
|
||||
public function get($options)
|
||||
@@ -319,15 +371,13 @@ class PrestaShopWebservice
|
||||
if (isset($options['url'])) {
|
||||
$url = $options['url'];
|
||||
} elseif (isset($options['resource'])) {
|
||||
$url = $this->url.'/api/'.$options['resource'];
|
||||
$url = $this->url . '/api/' . $options['resource'];
|
||||
$url_params = array();
|
||||
if (isset($options['id'])) {
|
||||
$url .= '/'.$options['id'];
|
||||
$url .= '/' . $options['id'];
|
||||
}
|
||||
|
||||
// @CHANGE LDR
|
||||
//$params = array('filter', 'display', 'sort', 'limit', 'id_shop', 'id_group_shop');
|
||||
$params = array('filter', 'display', 'sort', 'limit', 'id_shop', 'id_group_shop', 'date');
|
||||
$params = array('filter', 'display', 'sort', 'limit', 'id_shop', 'id_group_shop', 'schema', 'language', 'date', 'price');
|
||||
foreach ($params as $p) {
|
||||
foreach ($options as $k => $o) {
|
||||
if (strpos($k, $p) !== false) {
|
||||
@@ -336,23 +386,25 @@ class PrestaShopWebservice
|
||||
}
|
||||
}
|
||||
if (count($url_params) > 0) {
|
||||
$url .= '?'.http_build_query($url_params);
|
||||
$url .= '?' . http_build_query($url_params);
|
||||
}
|
||||
} else {
|
||||
throw new PrestaShopWebserviceException('Bad parameters given ');
|
||||
throw new PrestaShopWebserviceException('Bad parameters given');
|
||||
}
|
||||
|
||||
$request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'GET'));
|
||||
$this->checkStatusCode($request['status_code']); // check the response validity
|
||||
|
||||
$this->checkStatusCode($request);// check the response validity
|
||||
|
||||
return $this->parseXML($request['response']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Head method (HEAD) a resource
|
||||
*
|
||||
* @param array $options Array representing resource for head request.
|
||||
* @return SimpleXMLElement status_code, response
|
||||
* @param array $options Array representing resource for head request.
|
||||
*
|
||||
* @return SimpleXMLElement status_code, response
|
||||
* @throws PrestaShopWebserviceException
|
||||
*/
|
||||
public function head($options)
|
||||
@@ -360,10 +412,10 @@ class PrestaShopWebservice
|
||||
if (isset($options['url'])) {
|
||||
$url = $options['url'];
|
||||
} elseif (isset($options['resource'])) {
|
||||
$url = $this->url.'/api/'.$options['resource'];
|
||||
$url = $this->url . '/api/' . $options['resource'];
|
||||
$url_params = array();
|
||||
if (isset($options['id'])) {
|
||||
$url .= '/'.$options['id'];
|
||||
$url .= '/' . $options['id'];
|
||||
}
|
||||
|
||||
$params = array('filter', 'display', 'sort', 'limit');
|
||||
@@ -375,15 +427,16 @@ class PrestaShopWebservice
|
||||
}
|
||||
}
|
||||
if (count($url_params) > 0) {
|
||||
$url .= '?'.http_build_query($url_params);
|
||||
$url .= '?' . http_build_query($url_params);
|
||||
}
|
||||
} else {
|
||||
throw new PrestaShopWebserviceException('Bad parameters given');
|
||||
}
|
||||
$request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'HEAD', CURLOPT_NOBODY => true));
|
||||
$this->checkStatusCode($request['status_code']); // check the response validity
|
||||
$this->checkStatusCode($request);// check the response validity
|
||||
return $request['header'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit (PUT) a resource
|
||||
* <p>Unique parameter must take : <br><br>
|
||||
@@ -392,9 +445,9 @@ class PrestaShopWebservice
|
||||
* 'putXml' => Modified XML string of a resource<br><br>
|
||||
* Examples are given in the tutorial</p>
|
||||
*
|
||||
* @param array $options Array representing resource to edit.
|
||||
* @return SimpleXMLElement|boolean status_code, response
|
||||
* @param array $options Array representing resource to edit.
|
||||
*
|
||||
* @return SimpleXMLElement
|
||||
* @throws PrestaShopWebserviceException
|
||||
*/
|
||||
public function edit($options)
|
||||
@@ -403,22 +456,75 @@ class PrestaShopWebservice
|
||||
if (isset($options['url'])) {
|
||||
$url = $options['url'];
|
||||
} elseif ((isset($options['resource'], $options['id']) || isset($options['url'])) && $options['putXml']) {
|
||||
$url = (isset($options['url']) ? $options['url'] : $this->url.'/api/'.$options['resource'].'/'.$options['id']);
|
||||
$url = (isset($options['url']) ? $options['url'] :
|
||||
$this->url . '/api/' . $options['resource'] . '/' . $options['id']);
|
||||
$xml = $options['putXml'];
|
||||
if (isset($options['id_shop'])) {
|
||||
$url .= '&id_shop='.$options['id_shop'];
|
||||
$url .= '&id_shop=' . $options['id_shop'];
|
||||
}
|
||||
if (isset($options['id_group_shop'])) {
|
||||
$url .= '&id_group_shop='.$options['id_group_shop'];
|
||||
$url .= '&id_group_shop=' . $options['id_group_shop'];
|
||||
}
|
||||
} else {
|
||||
throw new PrestaShopWebserviceException('Bad parameters given');
|
||||
}
|
||||
|
||||
$request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'PUT', CURLOPT_POSTFIELDS => $xml));
|
||||
$this->checkStatusCode($request['status_code']); // check the response validity
|
||||
$this->checkStatusCode($request);// check the response validity
|
||||
return $this->parseXML($request['response']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete (DELETE) a resource.
|
||||
* Unique parameter must take : <br><br>
|
||||
* 'resource' => Resource name<br>
|
||||
* 'id' => ID or array which contains IDs of a resource(s) you want to delete<br><br>
|
||||
* <code>
|
||||
* <?php
|
||||
* require_once('./PrestaShopWebservice.php');
|
||||
* try
|
||||
* {
|
||||
* $ws = new PrestaShopWebservice('https://mystore.com/', 'ZQ88PRJX5VWQHCWE4EE7SQ7HPNX00RAJ', false);
|
||||
* $xml = $ws->delete(array('resource' => 'orders', 'id' => 1));
|
||||
* // Following code will not be executed if an exception is thrown.
|
||||
* echo 'Successfully deleted.';
|
||||
* }
|
||||
* catch (PrestaShopWebserviceException $ex)
|
||||
* {
|
||||
* echo 'Error : '.$ex->getMessage();
|
||||
* }
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* @param array $options Array representing resource to delete.
|
||||
*
|
||||
* @return bool
|
||||
* @throws PrestaShopWebserviceException
|
||||
*/
|
||||
public function delete($options)
|
||||
{
|
||||
if (isset($options['url'])) {
|
||||
$url = $options['url'];
|
||||
} elseif (isset($options['resource']) && isset($options['id'])) {
|
||||
$url = (is_array($options['id']))
|
||||
? $this->url . '/api/' . $options['resource'] . '/?id=[' . implode(',', $options['id']) . ']'
|
||||
: $this->url . '/api/' . $options['resource'] . '/' . $options['id'];
|
||||
} else {
|
||||
throw new PrestaShopWebserviceException('Bad parameters given');
|
||||
}
|
||||
|
||||
if (isset($options['id_shop'])) {
|
||||
$url .= '&id_shop=' . $options['id_shop'];
|
||||
}
|
||||
if (isset($options['id_group_shop'])) {
|
||||
$url .= '&id_group_shop=' . $options['id_group_shop'];
|
||||
}
|
||||
|
||||
$request = $this->executeRequest($url, array(CURLOPT_CUSTOMREQUEST => 'DELETE'));
|
||||
$this->checkStatusCode($request);// check the response validity
|
||||
return true;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user