RetailCRM-Mirror/api-client-php
1
0
Fork 0
mirror of synced 2024-11-24 22:36:06 +03:00
Code Issues Projects Releases Wiki Activity
gh-pages
api-client-php/classes/RetailCrm-Api-Factory-ClientFactory.html

1113 lines
61 KiB
HTML
Raw Permalink Normal View History

Deploy to GitHub pages
2024-10-18 10:10:58 +03:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>RetailCRM API Client</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">RetailCRM API Client</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/retailcrm.html" class="">RetailCrm</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/retailcrm-api.html" class="">Api</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/RetailCrm.html" class="">RetailCrm</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/RetailCrm-Api.html" class="">Api</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</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/retailcrm.html">RetailCrm</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/retailcrm-api.html">Api</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/retailcrm-api-factory.html">Factory</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
ClientFactory
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/RetailCrm.html">RetailCrm</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/RetailCrm-Api.html">Api</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/RetailCrm-Api-Factory.html">Factory</a></li>
</ul>
</div>
<span class="phpdocumentor-element__implements">
implements
<a href="classes/RetailCrm-Api-Interfaces-ClientFactoryInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ClientFactoryInterface">ClientFactoryInterface</abbr></a>, <a href="classes/RetailCrm-Api-Interfaces-EventDispatcherAwareInterface.html"><abbr title="\RetailCrm\Api\Interfaces\EventDispatcherAwareInterface">EventDispatcherAwareInterface</abbr></a> </span>
<span class="phpdocumentor-element__extends">
Uses
<a href="classes/RetailCrm-Api-Traits-EventDispatcherAwareTrait.html"><abbr title="\RetailCrm\Api\Traits\EventDispatcherAwareTrait">EventDispatcherAwareTrait</abbr></a> </span>
</h2>
<div class="phpdocumentor-label-line">
</div>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Class ClientFactory.</p>
<section class="phpdocumentor-description"><p>ClientFactory will create any amount of clients with provided credentials.
The cache will be used if it was provided before instantiating any client.</p>
<p>This factory should be instantiated using DI, like <code class="prettyprint">symfony/dependency-injection</code>. Cache implementation can be
injected during factory instantiation (it's optional, but should be used if you care about performance).</p>
<p>FormEncoder instance with all underlying dependencies and ResponseTransformer will be shared between
Client instances. RequestTransformer with handlers pipeline will not be shared between clients because one
of the handlers will be authenticator, which is supposed to be unique between Clients.</p>
<p>Service configuration example for Symfony (<code class="prettyprint">symfony/dependency-injection</code>):</p>
<pre class="prettyprint"><code class="language-yaml">RetailCrm\Api\Interfaces\ClientFactoryInterface:
class: 'RetailCrm\Api\Factory\ClientFactory'
calls:
- setCacheDir: ['%kernel.cache_dir%']
- setEventDispatcher: ['@event_dispatcher']
</code></pre>
<p>You also can set a LoggerInterface instance for debug purposes:</p>
<pre class="prettyprint"><code class="language-yaml">RetailCrm\Api\Interfaces\ClientFactoryInterface:
class: 'RetailCrm\Api\Factory\ClientFactory'
calls:
- setCacheDir: ['%kernel.cache_dir%']
- setEventDispatcher: ['@event_dispatcher']
- setDebugLogger: ['@logger']
</code></pre>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/RetailCrm-Api-Factory-ClientFactory.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">category</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>ClientFactory</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">SuppressWarnings</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>(PHPMD.CouplingBetweenObjects)</p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-interfaces">
Interfaces
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#toc-interfaces" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/RetailCrm-Api-Interfaces-ClientFactoryInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ClientFactoryInterface">ClientFactoryInterface</abbr></a></dt><dd>Interface ClientFactoryInterface</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/RetailCrm-Api-Interfaces-EventDispatcherAwareInterface.html"><abbr title="\RetailCrm\Api\Interfaces\EventDispatcherAwareInterface">EventDispatcherAwareInterface</abbr></a></dt><dd>Interface EventDispatcherAwareInterface</dd> </dl>
<h4 id="toc-methods">
Methods
<a href="classes/RetailCrm-Api-Factory-ClientFactory.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/RetailCrm-Api-Factory-ClientFactory.html#method_appendRequestHandler">appendRequestHandler()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Appends an additional request handler into the request processing chain.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendRequestHandlers">appendRequestHandlers()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Appends additional request handlers into the request processing chain.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendResponseHandler">appendResponseHandler()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Appends an additional handler into the response processing chain.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendResponseHandlers">appendResponseHandlers()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Appends additional response handlers into the response processing chain.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_createClient">createClient()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Client.html"><abbr title="\RetailCrm\Api\Client">Client</abbr></a> </span>
</dt>
<dd>Instantiates a new instance of Client.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setCache">setCache()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Sets cache implementation which will be used to store metadata cache.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setCacheDir">setCacheDir()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Sets cache directory which will be used to store metadata cache.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setDebugLogger">setDebugLogger()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Sets debug logger</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Traits-EventDispatcherAwareTrait.html#method_setEventDispatcher">setEventDispatcher()</a>
<span>
&nbsp;: object </span>
</dt>
<dd>Sets PSR-14 compatible event dispatcher. Useful if you want to handle specific errors in one place.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setHttpClient">setHttpClient()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Set your PSR-18 HTTP client.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setRequestFactory">setRequestFactory()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Sets PSR-17 compatible request factory. You can skip this step if you want to use service discovery.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setStreamFactory">setStreamFactory()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Sets PSR-17 compatible stream factory. You can skip this step if you want to use service discovery.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setUriFactory">setUriFactory()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a> </span>
</dt>
<dd>Sets PSR-17 compatible URI factory. You can skip this step if you want to use service discovery.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/RetailCrm-Api-Factory-ClientFactory.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_appendRequestHandler">
appendRequestHandler()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendRequestHandler" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">208</span>
</aside>
<p class="phpdocumentor-summary">Appends an additional request handler into the request processing chain.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">appendRequestHandler</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Interfaces-HandlerInterface.html"><abbr title="\RetailCrm\Api\Interfaces\HandlerInterface">HandlerInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$handler</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$handler</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Interfaces-HandlerInterface.html"><abbr title="\RetailCrm\Api\Interfaces\HandlerInterface">HandlerInterface</abbr></a></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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_appendRequestHandlers">
appendRequestHandlers()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendRequestHandlers" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">234</span>
</aside>
<p class="phpdocumentor-summary">Appends additional request handlers into the request processing chain.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">appendRequestHandlers</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, <a href="classes/RetailCrm-Api-Interfaces-HandlerInterface.html"><abbr title="\RetailCrm\Api\Interfaces\HandlerInterface">HandlerInterface</abbr></a>&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$handlers</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$handlers</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, <a href="classes/RetailCrm-Api-Interfaces-HandlerInterface.html"><abbr title="\RetailCrm\Api\Interfaces\HandlerInterface">HandlerInterface</abbr></a>&gt;</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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_appendResponseHandler">
appendResponseHandler()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendResponseHandler" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">221</span>
</aside>
<p class="phpdocumentor-summary">Appends an additional handler into the response processing chain.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">appendResponseHandler</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Interfaces-HandlerInterface.html"><abbr title="\RetailCrm\Api\Interfaces\HandlerInterface">HandlerInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$handler</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$handler</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Interfaces-HandlerInterface.html"><abbr title="\RetailCrm\Api\Interfaces\HandlerInterface">HandlerInterface</abbr></a></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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_appendResponseHandlers">
appendResponseHandlers()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendResponseHandlers" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">250</span>
</aside>
<p class="phpdocumentor-summary">Appends additional response handlers into the response processing chain.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">appendResponseHandlers</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, <a href="classes/RetailCrm-Api-Interfaces-HandlerInterface.html"><abbr title="\RetailCrm\Api\Interfaces\HandlerInterface">HandlerInterface</abbr></a>&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$handlers</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$handlers</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, <a href="classes/RetailCrm-Api-Interfaces-HandlerInterface.html"><abbr title="\RetailCrm\Api\Interfaces\HandlerInterface">HandlerInterface</abbr></a>&gt;</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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_createClient">
createClient()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_createClient" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">268</span>
</aside>
<p class="phpdocumentor-summary">Instantiates a new instance of Client.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">createClient</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$apiUrl</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$apiKey</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Client.html"><abbr title="\RetailCrm\Api\Client">Client</abbr></a></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">$apiUrl</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiKey</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/RetailCrm-Api-Factory-ClientFactory.html#method_createClient#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/RetailCrm-Api-Exception-Client-BuilderException.html"><abbr title="\RetailCrm\Api\Exception\Client\BuilderException">BuilderException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Client.html"><abbr title="\RetailCrm\Api\Client">Client</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setCache">
setCache()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setCache" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">128</span>
</aside>
<p class="phpdocumentor-summary">Sets cache implementation which will be used to store metadata cache.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setCache</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Cache\CacheItemPoolInterface">CacheItemPoolInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$cache</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$cache</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Cache\CacheItemPoolInterface">CacheItemPoolInterface</abbr></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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setCacheDir">
setCacheDir()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setCacheDir" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">Sets cache directory which will be used to store metadata cache.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setCacheDir</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$cacheDir</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$cacheDir</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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setDebugLogger">
setDebugLogger()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setDebugLogger" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">141</span>
</aside>
<p class="phpdocumentor-summary">Sets debug logger</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDebugLogger</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Log\LoggerInterface">LoggerInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$debugLogger</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$debugLogger</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Log\LoggerInterface">LoggerInterface</abbr></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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setEventDispatcher">
setEventDispatcher()
<a href="classes/RetailCrm-Api-Traits-EventDispatcherAwareTrait.html#method_setEventDispatcher" 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/Traits/EventDispatcherAwareTrait.php"><a href="files/src-traits-eventdispatcherawaretrait.html"><abbr title="src/Traits/EventDispatcherAwareTrait.php">EventDispatcherAwareTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Sets PSR-14 compatible event dispatcher. Useful if you want to handle specific errors in one place.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setEventDispatcher</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\EventDispatcher\EventDispatcherInterface">EventDispatcherInterface</abbr>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$eventDispatcher</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</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">$eventDispatcher</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\EventDispatcher\EventDispatcherInterface">EventDispatcherInterface</abbr>|null</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">object</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setHttpClient">
setHttpClient()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setHttpClient" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">156</span>
</aside>
<p class="phpdocumentor-summary">Set your PSR-18 HTTP client.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setHttpClient</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Client\ClientInterface">ClientInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$httpClient</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Service discovery will be used if no client has been provided.</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">$httpClient</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Client\ClientInterface">ClientInterface</abbr></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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setRequestFactory">
setRequestFactory()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setRequestFactory" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<p class="phpdocumentor-summary">Sets PSR-17 compatible request factory. You can skip this step if you want to use service discovery.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setRequestFactory</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\RequestFactoryInterface">RequestFactoryInterface</abbr>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$requestFactory</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$requestFactory</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\RequestFactoryInterface">RequestFactoryInterface</abbr>|null</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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setStreamFactory">
setStreamFactory()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setStreamFactory" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">169</span>
</aside>
<p class="phpdocumentor-summary">Sets PSR-17 compatible stream factory. You can skip this step if you want to use service discovery.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setStreamFactory</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\StreamFactoryInterface">StreamFactoryInterface</abbr>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$streamFactory</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$streamFactory</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\StreamFactoryInterface">StreamFactoryInterface</abbr>|null</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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setUriFactory">
setUriFactory()
<a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setUriFactory" 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/Factory/ClientFactory.php"><a href="files/src-factory-clientfactory.html"><abbr title="src/Factory/ClientFactory.php">ClientFactory.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">195</span>
</aside>
<p class="phpdocumentor-summary">Sets PSR-17 compatible URI factory. You can skip this step if you want to use service discovery.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setUriFactory</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\UriFactoryInterface">UriFactoryInterface</abbr>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$uriFactory</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></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">$uriFactory</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\UriFactoryInterface">UriFactoryInterface</abbr>|null</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"><a href="classes/RetailCrm-Api-Factory-ClientFactory.html"><abbr title="\RetailCrm\Api\Factory\ClientFactory">ClientFactory</abbr></a></span>
</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/Factory/ClientFactory.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/RetailCrm-Api-Factory-ClientFactory.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendRequestHandler">appendRequestHandler()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendRequestHandlers">appendRequestHandlers()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendResponseHandler">appendResponseHandler()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_appendResponseHandlers">appendResponseHandlers()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_createClient">createClient()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setCache">setCache()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setCacheDir">setCacheDir()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setDebugLogger">setDebugLogger()</a></li>
<li><a href="classes/RetailCrm-Api-Traits-EventDispatcherAwareTrait.html#method_setEventDispatcher">setEventDispatcher()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setHttpClient">setHttpClient()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setRequestFactory">setRequestFactory()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setStreamFactory">setStreamFactory()</a></li>
<li><a href="classes/RetailCrm-Api-Factory-ClientFactory.html#method_setUriFactory">setUriFactory()</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/RetailCrm-Api-Factory-ClientFactory.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>
Reference in New Issue Copy Permalink