ldc-crm-client/docs/client-api/classes/LDC-LDCCRM-Transport-Response.html
Jérémy Munsch 23fdfca0be
Tests OK
2023-10-05 12:16:43 +02:00

1266 lines
55 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>CRM V4</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">CRM V4</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/ldc.html" class="">LDC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/ldc-ldccrm.html" class="">LDCCRM</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/LDCCrmClient.html" class="">LDCCrmClient</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/LDCCrmClient-exceptions.html" class="">exceptions</a>
</li>
<li>
<a href="packages/LDCCrmClient-models.html" class="">models</a>
</li>
<li>
<a href="packages/LDCCrmClient-transport.html" class="">transport</a>
</li>
<li>
<a href="packages/LDCCrmClient-utilities.html" class="">utilities</a>
</li>
<li>
<a href="packages/LDCCrmClient-Wordpress.html" class="">Wordpress</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/None.html" class="">None</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/ldc.html">LDC</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/ldc-ldccrm.html">LDCCRM</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/ldc-ldccrm-transport.html">Transport</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Response
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/LDCCrmClient.html">LDCCrmClient</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/LDCCrmClient-transport.html">transport</a></li>
</ul>
</div>
</h2>
<div class="phpdocumentor-label-line">
</div>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-Transport-Response.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">subpackage</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>transport</p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/LDC-LDCCRM-Transport-Response.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-properties">
Properties
<a href="classes/LDC-LDCCRM-Transport-Response.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_apiError">$apiError</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-Enums-ApiError.html"><abbr title="\LDC\LDCCRM\Enums\ApiError">ApiError</abbr></a> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_content">$content</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_data">$data</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_headers">$headers</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_httpCode">$httpCode</a>
<span>
&nbsp;: int </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_message">$message</a>
<span>
&nbsp;: string </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_status">$status</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-Enums-ApiStatus.html"><abbr title="\LDC\LDCCRM\Enums\ApiStatus">ApiStatus</abbr></a> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_apiError">$apiError</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-Enums-ApiError.html"><abbr title="\LDC\LDCCRM\Enums\ApiError">ApiError</abbr></a> </span>
</dt>
<dd>The api error</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_body">$body</a>
<span>
&nbsp;: <abbr title="\Psr\Http\Message\StreamInterface">StreamInterface</abbr> </span>
</dt>
<dd>The response body</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_content">$content</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>The response decoded content</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_headers">$headers</a>
<span>
&nbsp;: array&lt;string, array&lt;string|int, string&gt;&gt; </span>
</dt>
<dd>The response headers</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_httpCode">$httpCode</a>
<span>
&nbsp;: int </span>
</dt>
<dd>The response http code</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_message">$message</a>
<span>
&nbsp;: string </span>
</dt>
<dd>The interface message</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_response">$response</a>
<span>
&nbsp;: <abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr> </span>
</dt>
<dd>PSR response</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_status">$status</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-Enums-ApiStatus.html"><abbr title="\LDC\LDCCRM\Enums\ApiStatus">ApiStatus</abbr></a> </span>
</dt>
<dd>The response status</dd>
</dl>
<h4 id="toc-methods">
Methods
<a href="classes/LDC-LDCCRM-Transport-Response.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-Transport-Response.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Response</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-Transport-Response.html#method___get">__get()</a>
<span>
&nbsp;: mixed|null </span>
</dt>
<dd>Generic accessor</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#method_checkVersion">checkVersion()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>This checks if the Flucollector version is way far beyond the client version.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-Transport-Response.html#method_tryDecodeJson">tryDecodeJson()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|false </span>
</dt>
<dd>Try to decode json and return false if it is
not a valid json</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/LDC-LDCCRM-Transport-Response.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_apiError">
$apiError
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_apiError" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type"><a href="classes/LDC-LDCCRM-Enums-ApiError.html"><abbr title="\LDC\LDCCRM\Enums\ApiError">ApiError</abbr></a></span>
<span class="phpdocumentor-signature__name">$apiError</span>
</code>
<section class="phpdocumentor-description"><p>The api error status it there is any</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_content">
$content
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_content" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$content</span>
</code>
<section class="phpdocumentor-description"><p>The http response content, this is parsed json</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_data">
$data
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
<span class="phpdocumentor-signature__name">$data</span>
</code>
<section class="phpdocumentor-description"><p>The reponse data</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_headers">
$headers
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_headers" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$headers</span>
</code>
<section class="phpdocumentor-description"><p>The http reponse headers</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_httpCode">
$httpCode
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_httpCode" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$httpCode</span>
</code>
<section class="phpdocumentor-description"><p>The http response code</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_message">
$message
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_message" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$message</span>
</code>
<section class="phpdocumentor-description"><p>The api message</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_status">
$status
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_status" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type"><a href="classes/LDC-LDCCRM-Enums-ApiStatus.html"><abbr title="\LDC\LDCCRM\Enums\ApiStatus">ApiStatus</abbr></a></span>
<span class="phpdocumentor-signature__name">$status</span>
</code>
<section class="phpdocumentor-description"><p>The response api status</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_apiError">
$apiError
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_apiError" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">The api error</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LDC-LDCCRM-Enums-ApiError.html"><abbr title="\LDC\LDCCRM\Enums\ApiError">ApiError</abbr></a></span>
<span class="phpdocumentor-signature__name">$apiError</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_body">
$body
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_body" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">The response body</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><abbr title="\Psr\Http\Message\StreamInterface">StreamInterface</abbr></span>
<span class="phpdocumentor-signature__name">$body</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_content">
$content
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_content" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">The response decoded content</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$content</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_headers">
$headers
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_headers" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">The response headers</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">array&lt;string, array&lt;string|int, string&gt;&gt;</span>
<span class="phpdocumentor-signature__name">$headers</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_httpCode">
$httpCode
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_httpCode" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">The response http code</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$httpCode</span>
= <span class="phpdocumentor-signature__default-value">0</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_message">
$message
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_message" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">The interface message</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$message</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_response">
$response
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_response" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
<p class="phpdocumentor-summary">PSR response</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr></span>
<span class="phpdocumentor-signature__name">$response</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_status">
$status
<a href="classes/LDC-LDCCRM-Transport-Response.html#property_status" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">The response status</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LDC-LDCCRM-Enums-ApiStatus.html"><abbr title="\LDC\LDCCRM\Enums\ApiStatus">ApiStatus</abbr></a></span>
<span class="phpdocumentor-signature__name">$status</span>
</code>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/LDC-LDCCRM-Transport-Response.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/LDC-LDCCRM-Transport-Response.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">92</span>
</aside>
<p class="phpdocumentor-summary">Response</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LDC-LDCCRM-Enums-ApiStatus.html"><abbr title="\LDC\LDCCRM\Enums\ApiStatus">ApiStatus</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$status</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$response</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$status</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LDC-LDCCRM-Enums-ApiStatus.html"><abbr title="\LDC\LDCCRM\Enums\ApiStatus">ApiStatus</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$response</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-Transport-Response.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-CrmException.html"><abbr title="\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></a></span>
<section class="phpdocumentor-description"><p>If HTTP response body in not JSON.</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___get">
__get()
<a href="classes/LDC-LDCCRM-Transport-Response.html#method___get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">145</span>
</aside>
<p class="phpdocumentor-summary">Generic accessor</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_checkVersion">
checkVersion()
<a href="classes/LDC-LDCCRM-Transport-Response.html#method_checkVersion" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">188</span>
</aside>
<p class="phpdocumentor-summary">This checks if the Flucollector version is way far beyond the client version.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">checkVersion</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>If a minor version mismatch is detected we will log this as a warning.
If a major version mismatch is detected we will throw a AppilcationException as
there shall be an incompatibility with the response.</p>
<p>The goal here is to force clients to be up to date.
A major version change means breaking change.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$version</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-Transport-Response.html#method_checkVersion#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-CrmException.html"><abbr title="\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></a></span>
<section class="phpdocumentor-description"><p>If a major version mismatch is detected.</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_tryDecodeJson">
tryDecodeJson()
<a href="classes/LDC-LDCCRM-Transport-Response.html#method_tryDecodeJson" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Response.php"><a href="files/src-transport-response.html"><abbr title="src/Transport/Response.php">Response.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">168</span>
</aside>
<p class="phpdocumentor-summary">Try to decode json and return false if it is
not a valid json</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">tryDecodeJson</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|false</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|false</span>
&mdash;
<section class="phpdocumentor-description"><p>Returns an associative data array or false if failed to parse.</p>
</section>
</section>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Transport/Response.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#toc-properties">Properties</a></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_apiError">$apiError<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_content">$content<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_data">$data<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_headers">$headers<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_httpCode">$httpCode<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_message">$message<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_status">$status<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_apiError">$apiError<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_body">$body<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_content">$content<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_headers">$headers<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_httpCode">$httpCode<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_message">$message<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_response">$response<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#property_status">$status<a href="classes/LDC-LDCCRM-Transport-Response.html"></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#method___construct">__construct()</a></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#method___get">__get()</a></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#method_checkVersion">checkVersion()</a></li>
<li><a href="classes/LDC-LDCCRM-Transport-Response.html#method_tryDecodeJson">tryDecodeJson()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/LDC-LDCCRM-Transport-Response.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>