1358 lines
58 KiB
HTML
1358 lines
58 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>CRM V2</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=Source+Sans+Pro:wght@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/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 V2</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 -four 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"><abbr title="\LDC">LDC</abbr></a></h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li><a href="namespaces/ldc-ldccrm.html"><abbr title="\LDC\LDCCRM">LDCCRM</abbr></a></li>
|
|
</ul>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/LDCCrmClient.html"><abbr title="\LDCCrmClient">LDCCrmClient</abbr></a></h3>
|
|
<ul class="phpdocumentor-list">
|
|
<li><a href="packages/LDCCrmClient-enums.html"><abbr title="\LDCCrmClient\enums">enums</abbr></a></li>
|
|
<li><a href="packages/LDCCrmClient-exceptions.html"><abbr title="\LDCCrmClient\exceptions">exceptions</abbr></a></li>
|
|
<li><a href="packages/LDCCrmClient-models.html"><abbr title="\LDCCrmClient\models">models</abbr></a></li>
|
|
<li><a href="packages/LDCCrmClient-transport.html"><abbr title="\LDCCrmClient\transport">transport</abbr></a></li>
|
|
<li><a href="packages/LDCCrmClient-utilities.html"><abbr title="\LDCCrmClient\utilities">utilities</abbr></a></li>
|
|
<li><a href="packages/LDCCrmClient-Wordpress.html"><abbr title="\LDCCrmClient\Wordpress">Wordpress</abbr></a></li>
|
|
</ul>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/None.html"><abbr title="\None">None</abbr></a></h3>
|
|
</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 -eight phpdocumentor-content">
|
|
<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">
|
|
Request
|
|
|
|
|
|
<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>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/Transport/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">24</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The LDC CRM request
|
|
Contains the http method, the requested url and data to pass</p>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#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="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_data">$data</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_headers">$headers</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_method">$method</a>
|
|
<span>
|
|
: <abbr title="\LDC\LDCCRM\Enums\HttpMethods">HttpMethods</abbr> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_uri">$uri</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_attemps">$attemps</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Current attempt to login</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_data">$data</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Data to pass to the http body</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_headers">$headers</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Data to pass to the http headers</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_maxAttemps">$maxAttemps</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Max attemps to login</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_method">$method</a>
|
|
<span>
|
|
: <abbr title="\LDC\LDCCRM\Enums\HttpMethods">HttpMethods</abbr> </span>
|
|
</dt>
|
|
<dd>The http method</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_uri">$uri</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>The http url</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_client">$client</a>
|
|
<span>
|
|
: <abbr title="\GuzzleHttp\Client">Client</abbr> </span>
|
|
</dt>
|
|
<dd>GuzzleHttp client</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_endpoint">$endpoint</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>The Api endpoint</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_hidden">$hidden</a>
|
|
<span>
|
|
: callable </span>
|
|
</dt>
|
|
<dd>Hidden props</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_request">$request</a>
|
|
<span>
|
|
: callable </span>
|
|
</dt>
|
|
<dd>Guzzle request</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method___construct">__construct()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method___get">__get()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_addData">addData()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Add data to the request</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_addHeaders">addHeaders()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Add headers to the request</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_call">call()</a>
|
|
<span>
|
|
: <abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr> </span>
|
|
</dt>
|
|
<dd>Make the Http request</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_getAttempts">getAttempts()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Get attempted calls</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_incrementAttempt">incrementAttempt()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Increment the attempt to call</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_maxAttempted">maxAttempted()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Does max attempts have been reached</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_setEndpoint">setEndpoint()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set the api endpoint to the request</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_setHidden">setHidden()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set hidden header and data</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_makeRequest">makeRequest()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>make the guzzle request</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.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_data">
|
|
$data
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.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<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$data</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>readonly data</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_headers">
|
|
$headers
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.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<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$headers</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>headers</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_method">
|
|
$method
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_method" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.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"><abbr title="\LDC\LDCCRM\Enums\HttpMethods">HttpMethods</abbr></span>
|
|
<span class="phpdocumentor-signature__name">$method</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>readonly method</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_uri">
|
|
$uri
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_uri" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.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">$uri</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>readonly uri</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_attemps">
|
|
$attemps
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_attemps" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">95</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Current attempt to login</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$attemps</span>
|
|
= <span class="phpdocumentor-signature__default-value">0</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_data">
|
|
$data
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">60</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Data to pass to the http body</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$data</span>
|
|
= <span class="phpdocumentor-signature__default-value">[]</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_headers">
|
|
$headers
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">53</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Data to pass to the http headers</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$headers</span>
|
|
= <span class="phpdocumentor-signature__default-value">[]</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_maxAttemps">
|
|
$maxAttemps
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_maxAttemps" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">88</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Max attemps to login</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$maxAttemps</span>
|
|
= <span class="phpdocumentor-signature__default-value">1</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_method">
|
|
$method
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_method" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">39</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The http method</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type"><abbr title="\LDC\LDCCRM\Enums\HttpMethods">HttpMethods</abbr></span>
|
|
<span class="phpdocumentor-signature__name">$method</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_uri">
|
|
$uri
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_uri" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">46</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The http url</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$uri</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_client">
|
|
$client
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_client" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">32</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">GuzzleHttp client</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><abbr title="\GuzzleHttp\Client">Client</abbr></span>
|
|
<span class="phpdocumentor-signature__name">$client</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_endpoint">
|
|
$endpoint
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_endpoint" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">74</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The Api endpoint</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">$endpoint</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_hidden">
|
|
$hidden
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_hidden" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">81</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Hidden props</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">callable</span>
|
|
<span class="phpdocumentor-signature__name">$hidden</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_request">
|
|
$request
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#property_request" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">67</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Guzzle request</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">callable</span>
|
|
<span class="phpdocumentor-signature__name">$request</span>
|
|
</code>
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>the returns \GuzzleHttp\Psr7\Request</p>
|
|
</section>
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.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-Request.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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">97</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<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"><abbr title="\LDC\LDCCRM\Enums\HttpMethods">HttpMethods</abbr> </span><span class="phpdocumentor-signature__argument__name">$method</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$uri</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$headers</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$data</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></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">$method</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\LDC\LDCCRM\Enums\HttpMethods">HttpMethods</abbr></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$uri</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$headers</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$data</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___get">
|
|
__get()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">120</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<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">mixed </span><span class="phpdocumentor-signature__argument__name">$field</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></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">$field</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addData">
|
|
addData()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_addData" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">194</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add data to the request</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addData</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
|
|
<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">$data</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addHeaders">
|
|
addHeaders()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_addHeaders" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">183</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add headers to the request</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addHeaders</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$headers</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
|
|
<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">$headers</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_call">
|
|
call()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_call" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">167</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Make the Http request</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">call</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr></span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\Psr\Http\Message\ResponseInterface">ResponseInterface</abbr></span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getAttempts">
|
|
getAttempts()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_getAttempts" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">232</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get attempted calls</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getAttempts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_incrementAttempt">
|
|
incrementAttempt()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_incrementAttempt" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">252</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Increment the attempt to call</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">incrementAttempt</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_maxAttempted">
|
|
maxAttempted()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_maxAttempted" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">242</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Does max attempts have been reached</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">maxAttempted</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setEndpoint">
|
|
setEndpoint()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_setEndpoint" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">157</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set the api endpoint to the request</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setEndpoint</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$endpoint</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
|
|
<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">$endpoint</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setHidden">
|
|
setHidden()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_setHidden" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">205</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set hidden header and data</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setHidden</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$array</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
|
|
<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">$array</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_makeRequest">
|
|
makeRequest()
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.html#method_makeRequest" 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/Request.php"><a href="files/src-transport-request.html"><abbr title="src/Transport/Request.php">Request.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">133</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">make the guzzle request</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">makeRequest</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
|
<script type="text/javascript">
|
|
function loadExternalCodeSnippets(line) {
|
|
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
|
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
|
|
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
|
var language = 'php';
|
|
|
|
var 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) {
|
|
|
|
if (xhr.status < 400 && xhr.responseText) {
|
|
code.textContent = xhr.responseText;
|
|
|
|
Prism.highlightElement(code);
|
|
}
|
|
else if (xhr.status >= 400) {
|
|
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
}
|
|
else {
|
|
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
|
|
}
|
|
}
|
|
};
|
|
|
|
xhr.send(null);
|
|
});
|
|
}
|
|
|
|
var modals = document.querySelectorAll("[data-modal]");
|
|
|
|
modals.forEach(function (trigger) {
|
|
trigger.addEventListener("click", function (event) {
|
|
//event.preventDefault();
|
|
const modal = document.getElementById(trigger.dataset.modal);
|
|
modal.classList.add("phpdocumentor-modal__open");
|
|
loadExternalCodeSnippets(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 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>
|
|
</div>
|
|
<a href="classes/LDC-LDCCRM-Transport-Request.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>
|