dolibarr  20.0.0-beta
Public Member Functions | Protected Member Functions | List of all members
PrestaShopWebservice Class Reference
Collaboration diagram for PrestaShopWebservice:
Collaboration graph
[legend]

Public Member Functions

 __construct ($url, $key, $debug=true)
 PrestaShopWebservice constructor. More...
 
 executeRequest ($url, $curl_params=array())
 Handles a CURL request to PrestaShop Webservice. More...
 
 printDebug ($title, $content)
 Output debug info. More...
 
 getVersion ()
 Return version. More...
 
 add ($options)
 Add (POST) a resource. More...
 
 get ($options)
 Retrieve (GET) a resource. More...
 
 head ($options)
 Head method (HEAD) a resource. More...
 
 edit ($options)
 Edit (PUT) a resource. More...
 
 delete ($options)
 Delete (DELETE) a resource. More...
 

Protected Member Functions

 checkStatusCode ($request)
 Take the status code and throw an exception if the server didn't return 200 or 201 code. More...
 
 getCurlDefaultParams ()
 Provides default parameters for the curl connection(s) More...
 
 parseXML ($response)
 Load XML from string. More...
 

Detailed Description

Definition at line 32 of file PSWebServiceLibrary.class.php.

Constructor & Destructor Documentation

◆ __construct()

PrestaShopWebservice::__construct (   $url,
  $key,
  $debug = true 
)

PrestaShopWebservice constructor.

Throw an exception when CURL is not installed/activated <?php require_once('./PrestaShopWebservice.php'); try { $ws = new PrestaShopWebservice('https://mystore.com/', 'ZQ88PRJX5VWQHCWE4EE7SQ7HPNX00RAJ', false); // Now we have a webservice object to play with } catch (PrestaShopWebserviceException $ex) { echo 'Error : '.$ex->getMessage(); } ?>

Parameters
string$urlRoot URL for the shop
string$keyAuthentication key
mixed$debugDebug mode Activated (true) or deactivated (false)
Exceptions
PrestaShopWebserviceExceptionif curl is not loaded

Definition at line 75 of file PSWebServiceLibrary.class.php.

Member Function Documentation

◆ add()

PrestaShopWebservice::add (   $options)

Add (POST) a resource.

Unique parameter must take :

'resource' => Resource name
'postXml' => Full XML string to add resource<br>
Examples are given in the tutorial

Parameters
array$optionsOptions
Returns
SimpleXMLElement status_code, response
Exceptions
PrestaShopWebserviceException

Definition at line 323 of file PSWebServiceLibrary.class.php.

◆ checkStatusCode()

PrestaShopWebservice::checkStatusCode (   $request)
protected

Take the status code and throw an exception if the server didn't return 200 or 201 code.

Unique parameter must take :

'status_code' => Status code of an HTTP return
'response' => CURL response

Parameters
array$requestResponse elements of CURL request
Returns
void
Exceptions
PrestaShopWebserviceExceptionif HTTP status code is not 200 or 201

Definition at line 100 of file PSWebServiceLibrary.class.php.

◆ delete()

PrestaShopWebservice::delete (   $options)

Delete (DELETE) a resource.

Unique parameter must take :

'resource' => Resource name
'id' => ID or array which contains IDs of a resource(s) you want to delete<br>
<?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(); } ?>

Parameters
array$optionsArray representing resource to delete.
Returns
bool
Exceptions
PrestaShopWebserviceException

Definition at line 511 of file PSWebServiceLibrary.class.php.

◆ edit()

PrestaShopWebservice::edit (   $options)

Edit (PUT) a resource.

Unique parameter must take :

'resource' => Resource name ,
'id' => ID of a resource you want to edit,
'putXml' => Modified XML string of a resource<br>
Examples are given in the tutorial

Parameters
array$optionsArray representing resource to edit.
Returns
SimpleXMLElement
Exceptions
PrestaShopWebserviceException

Definition at line 460 of file PSWebServiceLibrary.class.php.

◆ executeRequest()

PrestaShopWebservice::executeRequest (   $url,
  $curl_params = array() 
)

Handles a CURL request to PrestaShop Webservice.

Can throw exception.

Parameters
string$urlResource name
mixed$curl_paramsCURL parameters (sent to curl_set_opt)
Returns
array status_code, response, header
Exceptions
PrestaShopWebserviceException

Definition at line 173 of file PSWebServiceLibrary.class.php.

References dol_syslog(), and getCurlDefaultParams().

◆ get()

PrestaShopWebservice::get (   $options)

Retrieve (GET) a resource.

Unique parameter must take :

'url' => Full URL for a GET request of Webservice (ex: https://mystore.com/api/customers/1/)
OR
'resource' => Resource name,
'id' => ID of a resource you want to get<br>

<?php require_once('./PrestaShopWebservice.php'); try { $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 foreach ($xml->children()->children() as $attName => $attValue) echo $attName.' = '.$attValue.'
'; } catch (PrestaShopWebserviceException $ex) { echo 'Error : '.$ex->getMessage(); } ?>

Parameters
array$optionsArray representing resource to get.
Returns
SimpleXMLElement status_code, response
Exceptions
PrestaShopWebserviceException

Definition at line 376 of file PSWebServiceLibrary.class.php.

◆ getCurlDefaultParams()

PrestaShopWebservice::getCurlDefaultParams ( )
protected

Provides default parameters for the curl connection(s)

Returns
array Default parameters for curl connection(s)

Definition at line 147 of file PSWebServiceLibrary.class.php.

Referenced by executeRequest().

◆ getVersion()

PrestaShopWebservice::getVersion ( )

Return version.

Returns
string Version

Definition at line 274 of file PSWebServiceLibrary.class.php.

◆ head()

PrestaShopWebservice::head (   $options)

Head method (HEAD) a resource.

Parameters
array$optionsArray representing resource for head request.
Returns
SimpleXMLElement status_code, response
Exceptions
PrestaShopWebserviceException

Definition at line 417 of file PSWebServiceLibrary.class.php.

◆ parseXML()

PrestaShopWebservice::parseXML (   $response)
protected

Load XML from string.

Can throw exception

Parameters
string$responseString from a CURL response
Returns
SimpleXMLElement status_code, response
Exceptions
PrestaShopWebserviceException

Definition at line 287 of file PSWebServiceLibrary.class.php.

◆ printDebug()

PrestaShopWebservice::printDebug (   $title,
  $content 
)

Output debug info.

Parameters
string$titleTitle
string$contentContent
Returns
void

Definition at line 256 of file PSWebServiceLibrary.class.php.


The documentation for this class was generated from the following file: