192 lines
14 KiB
HTML
192 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="robots" content="noindex">
|
|
|
|
<title>File RetailCrm/Http/Client.php | 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>
|
|
<a href="class-RetailCrm.Http.Client.html" title="Summary of RetailCrm\Http\Client"><span>Class</span></a>
|
|
</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">
|
|
<pre id="source"><code><span id="1" class="l"><a class="l" href="#1"> 1 </a><span class="xlang"><?php</span>
|
|
</span><span id="2" class="l"><a class="l" href="#2"> 2 </a>
|
|
</span><span id="3" class="l"><a class="l" href="#3"> 3 </a><span class="php-keyword1">namespace</span> RetailCrm\Http;
|
|
</span><span id="4" class="l"><a class="l" href="#4"> 4 </a>
|
|
</span><span id="5" class="l"><a class="l" href="#5"> 5 </a><span class="php-keyword1">use</span> RetailCrm\Exception\CurlException;
|
|
</span><span id="6" class="l"><a class="l" href="#6"> 6 </a><span class="php-keyword1">use</span> RetailCrm\Response\ApiResponse;
|
|
</span><span id="7" class="l"><a class="l" href="#7"> 7 </a>
|
|
</span><span id="8" class="l"><a class="l" href="#8"> 8 </a><span class="php-comment">/**
|
|
</span></span><span id="9" class="l"><a class="l" href="#9"> 9 </a><span class="php-comment"> * HTTP client
|
|
</span></span><span id="10" class="l"><a class="l" href="#10">10 </a><span class="php-comment"> */</span>
|
|
</span><span id="11" class="l"><a class="l" href="#11">11 </a><span class="php-keyword1">class</span> <a id="Client" href="#Client">Client</a>
|
|
</span><span id="12" class="l"><a class="l" href="#12">12 </a>{
|
|
</span><span id="13" class="l"><a class="l" href="#13">13 </a> <span class="php-keyword1">const</span> <a id="METHOD_GET" href="#METHOD_GET">METHOD_GET</a> = <span class="php-quote">'GET'</span>;
|
|
</span><span id="14" class="l"><a class="l" href="#14">14 </a> <span class="php-keyword1">const</span> <a id="METHOD_POST" href="#METHOD_POST">METHOD_POST</a> = <span class="php-quote">'POST'</span>;
|
|
</span><span id="15" class="l"><a class="l" href="#15">15 </a>
|
|
</span><span id="16" class="l"><a class="l" href="#16">16 </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$url" href="#$url">$url</a></span>;
|
|
</span><span id="17" class="l"><a class="l" href="#17">17 </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$defaultParameters" href="#$defaultParameters">$defaultParameters</a></span>;
|
|
</span><span id="18" class="l"><a class="l" href="#18">18 </a>
|
|
</span><span id="19" class="l"><a class="l" href="#19">19 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$url</span>, <span class="php-keyword1">array</span> <span class="php-var">$defaultParameters</span> = <span class="php-keyword1">array</span>())
|
|
</span><span id="20" class="l"><a class="l" href="#20">20 </a> {
|
|
</span><span id="21" class="l"><a class="l" href="#21">21 </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">false</span> === <span class="php-keyword2">stripos</span>(<span class="php-var">$url</span>, <span class="php-quote">'https://'</span>)) {
|
|
</span><span id="22" class="l"><a class="l" href="#22">22 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> \InvalidArgumentException(<span class="php-quote">'API schema requires HTTPS protocol'</span>);
|
|
</span><span id="23" class="l"><a class="l" href="#23">23 </a> }
|
|
</span><span id="24" class="l"><a class="l" href="#24">24 </a>
|
|
</span><span id="25" class="l"><a class="l" href="#25">25 </a> <span class="php-var">$this</span>->url = <span class="php-var">$url</span>;
|
|
</span><span id="26" class="l"><a class="l" href="#26">26 </a> <span class="php-var">$this</span>->defaultParameters = <span class="php-var">$defaultParameters</span>;
|
|
</span><span id="27" class="l"><a class="l" href="#27">27 </a> }
|
|
</span><span id="28" class="l"><a class="l" href="#28">28 </a>
|
|
</span><span id="29" class="l"><a class="l" href="#29">29 </a> <span class="php-comment">/**
|
|
</span></span><span id="30" class="l"><a class="l" href="#30">30 </a><span class="php-comment"> * Make HTTP request
|
|
</span></span><span id="31" class="l"><a class="l" href="#31">31 </a><span class="php-comment"> *
|
|
</span></span><span id="32" class="l"><a class="l" href="#32">32 </a><span class="php-comment"> * @param string $path
|
|
</span></span><span id="33" class="l"><a class="l" href="#33">33 </a><span class="php-comment"> * @param string $method (default: 'GET')
|
|
</span></span><span id="34" class="l"><a class="l" href="#34">34 </a><span class="php-comment"> * @param array $parameters (default: array())
|
|
</span></span><span id="35" class="l"><a class="l" href="#35">35 </a><span class="php-comment"> * @param int $timeout
|
|
</span></span><span id="36" class="l"><a class="l" href="#36">36 </a><span class="php-comment"> * @return ApiResponse
|
|
</span></span><span id="37" class="l"><a class="l" href="#37">37 </a><span class="php-comment"> */</span>
|
|
</span><span id="38" class="l"><a class="l" href="#38">38 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_makeRequest" href="#_makeRequest">makeRequest</a>(<span class="php-var">$path</span>, <span class="php-var">$method</span>, <span class="php-keyword1">array</span> <span class="php-var">$parameters</span> = <span class="php-keyword1">array</span>(), <span class="php-var">$timeout</span> = <span class="php-num">30</span>)
|
|
</span><span id="39" class="l"><a class="l" href="#39">39 </a> {
|
|
</span><span id="40" class="l"><a class="l" href="#40">40 </a> <span class="php-var">$allowedMethods</span> = <span class="php-keyword1">array</span>(self::METHOD_GET, self::METHOD_POST);
|
|
</span><span id="41" class="l"><a class="l" href="#41">41 </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">in_array</span>(<span class="php-var">$method</span>, <span class="php-var">$allowedMethods</span>)) {
|
|
</span><span id="42" class="l"><a class="l" href="#42">42 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> \InvalidArgumentException(<span class="php-keyword2">sprintf</span>(
|
|
</span><span id="43" class="l"><a class="l" href="#43">43 </a> <span class="php-quote">'Method "%s" is not valid. Allowed methods are %s'</span>,
|
|
</span><span id="44" class="l"><a class="l" href="#44">44 </a> <span class="php-var">$method</span>,
|
|
</span><span id="45" class="l"><a class="l" href="#45">45 </a> <span class="php-keyword2">implode</span>(<span class="php-quote">', '</span>, <span class="php-var">$allowedMethods</span>)
|
|
</span><span id="46" class="l"><a class="l" href="#46">46 </a> ));
|
|
</span><span id="47" class="l"><a class="l" href="#47">47 </a> }
|
|
</span><span id="48" class="l"><a class="l" href="#48">48 </a>
|
|
</span><span id="49" class="l"><a class="l" href="#49">49 </a> <span class="php-var">$parameters</span> = <span class="php-keyword2">array_merge</span>(<span class="php-var">$this</span>->defaultParameters, <span class="php-var">$parameters</span>);
|
|
</span><span id="50" class="l"><a class="l" href="#50">50 </a>
|
|
</span><span id="51" class="l"><a class="l" href="#51">51 </a> <span class="php-var">$path</span> = <span class="php-var">$this</span>->url . <span class="php-var">$path</span>;
|
|
</span><span id="52" class="l"><a class="l" href="#52">52 </a> <span class="php-keyword1">if</span> (self::METHOD_GET === <span class="php-var">$method</span> && <span class="php-keyword2">sizeof</span>(<span class="php-var">$parameters</span>)) {
|
|
</span><span id="53" class="l"><a class="l" href="#53">53 </a> <span class="php-var">$path</span> .= <span class="php-quote">'?'</span> . <span class="php-keyword2">http_build_query</span>(<span class="php-var">$parameters</span>);
|
|
</span><span id="54" class="l"><a class="l" href="#54">54 </a> }
|
|
</span><span id="55" class="l"><a class="l" href="#55">55 </a>
|
|
</span><span id="56" class="l"><a class="l" href="#56">56 </a> <span class="php-var">$ch</span> = <span class="php-keyword2">curl_init</span>();
|
|
</span><span id="57" class="l"><a class="l" href="#57">57 </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_URL, <span class="php-var">$path</span>);
|
|
</span><span id="58" class="l"><a class="l" href="#58">58 </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_FAILONERROR, <span class="php-keyword1">false</span>);
|
|
</span><span id="59" class="l"><a class="l" href="#59">59 </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_RETURNTRANSFER, <span class="php-num">1</span>); <span class="php-comment">// return into a variable</span>
|
|
</span><span id="60" class="l"><a class="l" href="#60">60 </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_TIMEOUT, (int) <span class="php-var">$timeout</span>); <span class="php-comment">// times out after 30s</span>
|
|
</span><span id="61" class="l"><a class="l" href="#61">61 </a> <span class="php-comment">// curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);</span>
|
|
</span><span id="62" class="l"><a class="l" href="#62">62 </a> <span class="php-comment">// curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1); // allow redirects</span>
|
|
</span><span id="63" class="l"><a class="l" href="#63">63 </a>
|
|
</span><span id="64" class="l"><a class="l" href="#64">64 </a> <span class="php-keyword1">if</span> (self::METHOD_POST === <span class="php-var">$method</span>) {
|
|
</span><span id="65" class="l"><a class="l" href="#65">65 </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_POST, <span class="php-keyword1">true</span>);
|
|
</span><span id="66" class="l"><a class="l" href="#66">66 </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_POSTFIELDS, <span class="php-var">$parameters</span>);
|
|
</span><span id="67" class="l"><a class="l" href="#67">67 </a> }
|
|
</span><span id="68" class="l"><a class="l" href="#68">68 </a>
|
|
</span><span id="69" class="l"><a class="l" href="#69">69 </a> <span class="php-var">$responseBody</span> = <span class="php-keyword2">curl_exec</span>(<span class="php-var">$ch</span>);
|
|
</span><span id="70" class="l"><a class="l" href="#70">70 </a> <span class="php-var">$statusCode</span> = <span class="php-keyword2">curl_getinfo</span>(<span class="php-var">$ch</span>, CURLINFO_HTTP_CODE);
|
|
</span><span id="71" class="l"><a class="l" href="#71">71 </a>
|
|
</span><span id="72" class="l"><a class="l" href="#72">72 </a> <span class="php-var">$errno</span> = <span class="php-keyword2">curl_errno</span>(<span class="php-var">$ch</span>);
|
|
</span><span id="73" class="l"><a class="l" href="#73">73 </a> <span class="php-var">$error</span> = <span class="php-keyword2">curl_error</span>(<span class="php-var">$ch</span>);
|
|
</span><span id="74" class="l"><a class="l" href="#74">74 </a> <span class="php-keyword2">curl_close</span>(<span class="php-var">$ch</span>);
|
|
</span><span id="75" class="l"><a class="l" href="#75">75 </a>
|
|
</span><span id="76" class="l"><a class="l" href="#76">76 </a> <span class="php-keyword1">if</span> (<span class="php-var">$errno</span>) {
|
|
</span><span id="77" class="l"><a class="l" href="#77">77 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> CurlException(<span class="php-var">$error</span>, <span class="php-var">$errno</span>);
|
|
</span><span id="78" class="l"><a class="l" href="#78">78 </a> }
|
|
</span><span id="79" class="l"><a class="l" href="#79">79 </a>
|
|
</span><span id="80" class="l"><a class="l" href="#80">80 </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> ApiResponse(<span class="php-var">$statusCode</span>, <span class="php-var">$responseBody</span>);
|
|
</span><span id="81" class="l"><a class="l" href="#81">81 </a> }
|
|
</span><span id="82" class="l"><a class="l" href="#82">82 </a>}
|
|
</span><span id="83" class="l"><a class="l" href="#83">83 </a></span></code></pre>
|
|
</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>
|