288 lines
5.9 KiB
HTML
288 lines
5.9 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<title>Class RetailCrm\Http\Client | retailCRM PHP API client</title>
|
|
|
|
<link rel="stylesheet" href="resources/bootstrap.min.css?260161822">
|
|
<link rel="stylesheet" href="resources/style.css?2608535020">
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div id="navigation" class="navbar navbar-fixed-top">
|
|
<div class="navbar-inner">
|
|
<div class="container">
|
|
<a href="index.html" class="brand">retailCRM PHP API client</a>
|
|
<div class="nav-collapse">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="namespace-RetailCrm.Http.html" title="Summary of RetailCrm\Http"><span>Namespace</span></a>
|
|
</li>
|
|
<li class="active">
|
|
<span>Class</span> </li>
|
|
|
|
<li class="divider-vertical"></li>
|
|
|
|
<li>
|
|
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
|
|
</li>
|
|
<li>
|
|
<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
|
|
</li>
|
|
<li>
|
|
<a href="todo.html" title="Todo list"><span>Todo</span></a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="left">
|
|
<div id="menu">
|
|
<form id="search" class="form-search">
|
|
<input type="hidden" name="cx" value="">
|
|
<input type="hidden" name="ie" value="UTF-8">
|
|
<input type="text" name="q" class="search-query" placeholder="Search">
|
|
</form>
|
|
|
|
|
|
<div id="groups">
|
|
<h3>Namespaces</h3>
|
|
<ul>
|
|
<li class="active">
|
|
<a href="namespace-RetailCrm.html">
|
|
RetailCrm<span></span>
|
|
</a>
|
|
<ul>
|
|
<li>
|
|
<a href="namespace-RetailCrm.Exception.html">
|
|
Exception </a>
|
|
</li>
|
|
<li class="active">
|
|
<a href="namespace-RetailCrm.Http.html">
|
|
Http </a>
|
|
</li>
|
|
<li>
|
|
<a href="namespace-RetailCrm.Response.html">
|
|
Response </a>
|
|
</li>
|
|
</ul></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div id="elements">
|
|
<h3>Classes</h3>
|
|
<ul>
|
|
<li class="active"><a href="class-RetailCrm.Http.Client.html">Client</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="splitter"></div>
|
|
|
|
<div id="right">
|
|
<div id="rightInner">
|
|
<div id="content" class="class">
|
|
<h1>Class Client</h1>
|
|
|
|
|
|
<div class="description">
|
|
<p>HTTP client</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="alert alert-info">
|
|
|
|
|
|
<b>Namespace:</b> RetailCrm\Http<br>
|
|
|
|
|
|
<b>Located at</b> <a href="source-class-RetailCrm.Http.Client.html#8-82" title="Go to source code">RetailCrm/Http/Client.php</a><br>
|
|
</div>
|
|
|
|
|
|
|
|
<h2>Methods summary</h2>
|
|
<table class="summary table table-bordered table-striped methods" id="methods">
|
|
<tr data-order="__construct" id="___construct">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#___construct">#</a>
|
|
<code><a href="source-class-RetailCrm.Http.Client.html#19-27" title="Go to source code">__construct</a>( <span>mixed <var>$url</var></span>, <span>array <var>$defaultParameters</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="makeRequest" id="_makeRequest">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_makeRequest">#</a>
|
|
<code><a href="source-class-RetailCrm.Http.Client.html#29-81" title="Go to source code">makeRequest</a>( <span>string <var>$path</var></span>, <span>string <var>$method</var></span>, <span>array <var>$parameters</var> = <span class="php-keyword1">array</span>()</span>, <span>integer <var>$timeout</var> = <span class="php-num">30</span></span> )</code>
|
|
|
|
<div class="description short">
|
|
<p>Make HTTP request</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>Make HTTP request</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$path</var></dt>
|
|
<dd>
|
|
</dd>
|
|
<dt><var>$method</var></dt>
|
|
<dd>(default: 'GET')
|
|
</dd>
|
|
<dt><var>$parameters</var></dt>
|
|
<dd>(default: array())
|
|
</dd>
|
|
<dt><var>$timeout</var></dt>
|
|
<dd>
|
|
</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
<h3>Magic methods summary</h3>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Constants summary</h2>
|
|
<table class="summary table table-bordered table-striped constants" id="constants">
|
|
<tr data-order="METHOD_GET" id="METHOD_GET">
|
|
|
|
<td class="attributes"><code>string</code></td>
|
|
<td class="name">
|
|
<code>
|
|
<a href="source-class-RetailCrm.Http.Client.html#13" title="Go to source code"><b>METHOD_GET</b></a>
|
|
</code>
|
|
|
|
<div class="description short">
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#METHOD_GET" class="anchor">#</a>
|
|
<code><span class="php-quote">'GET'</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="METHOD_POST" id="METHOD_POST">
|
|
|
|
<td class="attributes"><code>string</code></td>
|
|
<td class="name">
|
|
<code>
|
|
<a href="source-class-RetailCrm.Http.Client.html#14" title="Go to source code"><b>METHOD_POST</b></a>
|
|
</code>
|
|
|
|
<div class="description short">
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#METHOD_POST" class="anchor">#</a>
|
|
<code><span class="php-quote">'POST'</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="footer">
|
|
retailCRM PHP API client API documentation generated by <a href="http://apigen.org">ApiGen</a>
|
|
</div>
|
|
</div>
|
|
<script src="resources/combined.js?371644040"></script>
|
|
<script src="elementlist.js?1838453619"></script>
|
|
</body>
|
|
</html>
|