576 lines
11 KiB
HTML
576 lines
11 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
|
||
|
|
<title>Class RetailCrm\Response\ApiResponse | 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.Response.html" title="Summary of RetailCrm\Response"><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>
|
||
|
|
<a href="namespace-RetailCrm.Http.html">
|
||
|
|
Http </a>
|
||
|
|
</li>
|
||
|
|
<li class="active">
|
||
|
|
<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.Response.ApiResponse.html">ApiResponse</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="splitter"></div>
|
||
|
|
|
||
|
|
<div id="right">
|
||
|
|
<div id="rightInner">
|
||
|
|
<div id="content" class="class">
|
||
|
|
<h1>Class ApiResponse</h1>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Response from retailCRM API</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<dl class="tree well">
|
||
|
|
<dd style="padding-left:0px">
|
||
|
|
<b><span>RetailCrm\Response\ApiResponse</span></b>
|
||
|
|
implements
|
||
|
|
<span>ArrayAccess</span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="alert alert-info">
|
||
|
|
|
||
|
|
|
||
|
|
<b>Namespace:</b> RetailCrm\Response<br>
|
||
|
|
|
||
|
|
|
||
|
|
<b>Located at</b> <a href="source-class-RetailCrm.Response.ApiResponse.html#7-127" title="Go to source code">RetailCrm/Response/ApiResponse.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.Response.ApiResponse.html#18-34" title="Go to source code">__construct</a>( <span>mixed <var>$statusCode</var></span>, <span>mixed <var>$responseBody</var> = <span class="php-keyword1">null</span></span> )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="getStatusCode" id="_getStatusCode">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
integer
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_getStatusCode">#</a>
|
||
|
|
<code><a href="source-class-RetailCrm.Response.ApiResponse.html#36-44" title="Go to source code">getStatusCode</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Return HTTP response status code</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Return HTTP response status code</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
<div class="list">
|
||
|
|
<code>integer</code>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="isSuccessful" id="_isSuccessful">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
boolean
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_isSuccessful">#</a>
|
||
|
|
<code><a href="source-class-RetailCrm.Response.ApiResponse.html#46-54" title="Go to source code">isSuccessful</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>HTTP request was successful</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>HTTP request was successful</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
<div class="list">
|
||
|
|
<code>boolean</code>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="__call" id="___call">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
mixed
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#___call">#</a>
|
||
|
|
<code><a href="source-class-RetailCrm.Response.ApiResponse.html#56-72" title="Go to source code">__call</a>( <span>string <var>$name</var></span>, <span>mixed <var>$arguments</var></span> )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Allow to access for the property throw class method</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Allow to access for the property throw class method</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<div class="list"><dl>
|
||
|
|
<dt><var>$name</var></dt>
|
||
|
|
<dd>
|
||
|
|
</dd>
|
||
|
|
<dt><var>$arguments</var></dt>
|
||
|
|
<dd>
|
||
|
|
</dd>
|
||
|
|
</dl></div>
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
<div class="list">
|
||
|
|
<code>mixed</code>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="__get" id="___get">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
mixed
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#___get">#</a>
|
||
|
|
<code><a href="source-class-RetailCrm.Response.ApiResponse.html#74-87" title="Go to source code">__get</a>( <span>string <var>$name</var></span> )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Allow to access for the property throw object property</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Allow to access for the property throw object property</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<div class="list"><dl>
|
||
|
|
<dt><var>$name</var></dt>
|
||
|
|
<dd>
|
||
|
|
</dd>
|
||
|
|
</dl></div>
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
<div class="list">
|
||
|
|
<code>mixed</code>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="offsetSet" id="_offsetSet">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_offsetSet">#</a>
|
||
|
|
<code><a href="source-class-RetailCrm.Response.ApiResponse.html#89-96" title="Go to source code">offsetSet</a>( <span>mixed <var>$offset</var></span>, <span>mixed <var>$value</var></span> )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<div class="list"><dl>
|
||
|
|
<dt><var>$offset</var></dt>
|
||
|
|
<dd>
|
||
|
|
</dd>
|
||
|
|
<dt><var>$value</var></dt>
|
||
|
|
<dd>
|
||
|
|
</dd>
|
||
|
|
</dl></div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Implementation of</h4>
|
||
|
|
<div class="list"><code>ArrayAccess::offsetSet()</code></div>
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="offsetUnset" id="_offsetUnset">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_offsetUnset">#</a>
|
||
|
|
<code><a href="source-class-RetailCrm.Response.ApiResponse.html#98-104" title="Go to source code">offsetUnset</a>( <span>mixed <var>$offset</var></span> )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<div class="list"><dl>
|
||
|
|
<dt><var>$offset</var></dt>
|
||
|
|
<dd>
|
||
|
|
</dd>
|
||
|
|
</dl></div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Implementation of</h4>
|
||
|
|
<div class="list"><code>ArrayAccess::offsetUnset()</code></div>
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="offsetExists" id="_offsetExists">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
boolean
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_offsetExists">#</a>
|
||
|
|
<code><a href="source-class-RetailCrm.Response.ApiResponse.html#106-113" title="Go to source code">offsetExists</a>( <span>mixed <var>$offset</var></span> )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<div class="list"><dl>
|
||
|
|
<dt><var>$offset</var></dt>
|
||
|
|
<dd>
|
||
|
|
</dd>
|
||
|
|
</dl></div>
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
<div class="list">
|
||
|
|
<code>boolean</code>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Implementation of</h4>
|
||
|
|
<div class="list"><code>ArrayAccess::offsetExists()</code></div>
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="offsetGet" id="_offsetGet">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
mixed
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_offsetGet">#</a>
|
||
|
|
<code><a href="source-class-RetailCrm.Response.ApiResponse.html#115-126" title="Go to source code">offsetGet</a>( <span>mixed <var>$offset</var></span> )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<div class="list"><dl>
|
||
|
|
<dt><var>$offset</var></dt>
|
||
|
|
<dd>
|
||
|
|
</dd>
|
||
|
|
</dl></div>
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
<div class="list">
|
||
|
|
<code>mixed</code>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Implementation of</h4>
|
||
|
|
<div class="list"><code>ArrayAccess::offsetGet()</code></div>
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Magic methods summary</h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Properties summary</h2>
|
||
|
|
<table class="summary table table-bordered table-striped properties" id="properties">
|
||
|
|
<tr data-order="statusCode" id="$statusCode">
|
||
|
|
<td class="attributes"><code>
|
||
|
|
protected
|
||
|
|
mixed
|
||
|
|
</code></td>
|
||
|
|
|
||
|
|
<td class="name">
|
||
|
|
<a href="source-class-RetailCrm.Response.ApiResponse.html#13" title="Go to source code"><var>$statusCode</var></a>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
<td class="value">
|
||
|
|
<div>
|
||
|
|
<a href="#$statusCode" class="anchor">#</a>
|
||
|
|
<code></code>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="response" id="$response">
|
||
|
|
<td class="attributes"><code>
|
||
|
|
protected
|
||
|
|
mixed
|
||
|
|
</code></td>
|
||
|
|
|
||
|
|
<td class="name">
|
||
|
|
<a href="source-class-RetailCrm.Response.ApiResponse.html#16" title="Go to source code"><var>$response</var></a>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
<td class="value">
|
||
|
|
<div>
|
||
|
|
<a href="#$response" class="anchor">#</a>
|
||
|
|
<code></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?3857396088"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|