RetailCRM-Mirror/api-client-php
1
0
Fork 0
mirror of synced 2024-11-22 05:16:07 +03:00
Code Issues Projects Releases Wiki Activity
c604c2d144
api-client-php/classes/RetailCrm-Api-ResourceGroup-CustomMethods.html

822 lines
46 KiB
HTML
Raw 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-resourcegroup.html">ResourceGroup</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
CustomMethods
<span class="phpdocumentor-element__extends">
extends <abbr title="\RetailCrm\Api\ResourceGroup\AbstractApiResourceGroup">AbstractApiResourceGroup</abbr>
</span>
<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-ResourceGroup.html">ResourceGroup</a></li>
</ul>
</div>
</h2>
<div class="phpdocumentor-label-line">
</div>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/ResourceGroup/CustomMethods.php"><a href="files/src-resourcegroup-custommethods.html"><abbr title="src/ResourceGroup/CustomMethods.php">CustomMethods.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Class CustomMethods</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.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>CustomMethods</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-ResourceGroup-CustomMethods.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-methods">
Methods
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.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-ResourceGroup-CustomMethods.html#method___call">__call()</a>
<span>
&nbsp;: array&lt;int|string, mixed&gt;|object </span>
</dt>
<dd>Calls custom method, returns array response.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.html#method_call">call()</a>
<span>
&nbsp;: array&lt;int|string, mixed&gt;|object </span>
</dt>
<dd>Calls custom method, returns array response.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.html#method_register">register()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Register custom method in the resource group. You can use invokable class for easier implementation.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.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___call">
__call()
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.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/ResourceGroup/CustomMethods.php"><a href="files/src-resourcegroup-custommethods.html"><abbr title="src/ResourceGroup/CustomMethods.php">CustomMethods.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">188</span>
</aside>
<p class="phpdocumentor-summary">Calls custom method, returns array response.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;int|string, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$arguments</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;int|string, mixed&gt;|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">$name</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">$arguments</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;int|string, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.html#method___call#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-Interfaces-ApiExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ApiExceptionInterface">ApiExceptionInterface</abbr></a></span>
</dd>
<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-Interfaces-ClientExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ClientExceptionInterface">ClientExceptionInterface</abbr></a></span>
</dd>
<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-Api-AccountDoesNotExistException.html"><abbr title="\RetailCrm\Api\Exception\Api\AccountDoesNotExistException">AccountDoesNotExistException</abbr></a></span>
</dd>
<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-Api-ApiErrorException.html"><abbr title="\RetailCrm\Api\Exception\Api\ApiErrorException">ApiErrorException</abbr></a></span>
</dd>
<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-Api-MissingCredentialsException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingCredentialsException">MissingCredentialsException</abbr></a></span>
</dd>
<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-Api-MissingParameterException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingParameterException">MissingParameterException</abbr></a></span>
</dd>
<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-Api-ValidationException.html"><abbr title="\RetailCrm\Api\Exception\Api\ValidationException">ValidationException</abbr></a></span>
</dd>
<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-HandlerException.html"><abbr title="\RetailCrm\Api\Exception\Client\HandlerException">HandlerException</abbr></a></span>
</dd>
<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-HttpClientException.html"><abbr title="\RetailCrm\Api\Exception\Client\HttpClientException">HttpClientException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.html#method_call"><abbr title="\RetailCrm\Api\ResourceGroup\CustomMethods::call()">CustomMethods::call()</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;int|string, mixed&gt;|object</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_call">
call()
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.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/ResourceGroup/CustomMethods.php"><a href="files/src-resourcegroup-custommethods.html"><abbr title="src/ResourceGroup/CustomMethods.php">CustomMethods.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">160</span>
</aside>
<p class="phpdocumentor-summary">Calls custom method, returns array response.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;int|string, mixed&gt;|object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</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&lt;int|string, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$context</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;int|string, mixed&gt;|object</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Usage:</p>
<pre class="prettyprint"><code class="language-php">$client-&gt;customMethods-&gt;call('scopes');
</code></pre>
<p>Second parameter should be provided for POST requests or query data. Third parameter is used to pass anything
you like to the callable during the method call (logger, for example).</p>
<p>This implementation is also used in the <code class="prettyprint">__call</code> magic method. It works like this:</p>
<pre class="prettyprint"><code class="language-php">$client-&gt;customMethods-&gt;scopes($data, 'any', 'other', 'params');
</code></pre>
<p>will make this call:</p>
<pre class="prettyprint"><code class="language-php">$client-&gt;customMethods-&gt;call('scopes', $data, ['any', 'other', 'params']);
</code></pre>
<p>Full example for the settings method:</p>
<pre class="prettyprint"><code class="language-php">use RetailCrm\Api\Component\CustomApiMethod;
use RetailCrm\Api\Enum\RequestMethod;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
$client = SimpleClientFactory::createClient('https://azgalot.retailcrm.ru', '9y3e3ohX1NGqAausgg5ACMWPv5Z4iXQF');
$client-&gt;customMethods-&gt;register('settings', new CustomApiMethod(RequestMethod::GET, 'settings'));
try {
// It will work because 'settings' method was registered before
$settings = $client-&gt;customMethods-&gt;settings();
} catch (ApiExceptionInterface $exception) {
echo sprintf(
'Error from RetailCRM API (status code: %d): %s',
$exception-&gt;getStatusCode(),
$exception-&gt;getMessage()
);
if (count($exception-&gt;getErrorResponse()-&gt;errors) &gt; 0) {
echo PHP_EOL . 'Errors: ' . implode(', ', $exception-&gt;getErrorResponse()-&gt;errors);
}
return;
}
echo 'Timezone: ' . $settings['settings']['timezone']['value'];
</code></pre>
</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">$name</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">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;int|string, mixed&gt;|object</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$context</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;int|string, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.html#method_call#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-Interfaces-ApiExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ApiExceptionInterface">ApiExceptionInterface</abbr></a></span>
</dd>
<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-Interfaces-ClientExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ClientExceptionInterface">ClientExceptionInterface</abbr></a></span>
</dd>
<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-Api-AccountDoesNotExistException.html"><abbr title="\RetailCrm\Api\Exception\Api\AccountDoesNotExistException">AccountDoesNotExistException</abbr></a></span>
</dd>
<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-Api-ApiErrorException.html"><abbr title="\RetailCrm\Api\Exception\Api\ApiErrorException">ApiErrorException</abbr></a></span>
</dd>
<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-Api-MissingCredentialsException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingCredentialsException">MissingCredentialsException</abbr></a></span>
</dd>
<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-Api-MissingParameterException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingParameterException">MissingParameterException</abbr></a></span>
</dd>
<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-Api-ValidationException.html"><abbr title="\RetailCrm\Api\Exception\Api\ValidationException">ValidationException</abbr></a></span>
</dd>
<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-HandlerException.html"><abbr title="\RetailCrm\Api\Exception\Client\HandlerException">HandlerException</abbr></a></span>
</dd>
<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-HttpClientException.html"><abbr title="\RetailCrm\Api\Exception\Client\HttpClientException">HttpClientException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;int|string, mixed&gt;|object</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_register">
register()
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.html#method_register" 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/ResourceGroup/CustomMethods.php"><a href="files/src-resourcegroup-custommethods.html"><abbr title="src/ResourceGroup/CustomMethods.php">CustomMethods.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
<p class="phpdocumentor-summary">Register custom method in the resource group. You can use invokable class for easier implementation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">register</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">callable|<a href="classes/RetailCrm-Api-Component-CustomApiMethod.html"><abbr title="\RetailCrm\Api\Component\CustomApiMethod">CustomApiMethod</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$sender</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Registered callable should accept three arguments:</p>
<ul>
<li>
<code class="prettyprint">RequestSenderInterface</code>
</li>
<li>Array with the request data (may be null or empty if not provided - this is the case for get requests).</li>
<li>Context data - may contain any data. You can use the context for anything you like.</li>
</ul>
<p>Example with the <code class="prettyprint">CustomApiMethod</code> wrapper:</p>
<pre class="prettyprint"><code class="language-php">use RetailCrm\Api\Component\CustomApiMethod;
use RetailCrm\Api\Enum\RequestMethod;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
$client = SimpleClientFactory::createClient('https://test.simla.com', 'apiKey');
$client-&gt;customMethods-&gt;register('settings', new CustomApiMethod(RequestMethod::GET, 'settings'));
</code></pre>
<p>Sometimes <code class="prettyprint">CustomApiMethod</code> may feel too simple to do certain tasks in the methods. That's why it is possible
to register custom callable. Let's register a custom method that returns array of available scopes:</p>
<p>use RetailCrm\Api\Enum\RequestMethod;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Interfaces\RequestSenderInterface;</p>
<pre class="prettyprint"><code class="language-php">$client = SimpleClientFactory::createClient('https://test.simla.com', 'apiKey');
$client-&gt;customMethods-&gt;register(
'scopes',
static function (RequestSenderInterface $sender, $data, array $context) {
return $sender-&gt;send(
RequestMethod::GET,
sprintf('https://%s/api/credentials', $sender-&gt;host()),
$data
)['scopes'];
}
);
</code></pre>
<p>Check <code class="prettyprint">call()</code> method to learn how to call registered methods.</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">$name</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">$sender</span>
: <span class="phpdocumentor-signature__argument__return-type">callable|<a href="classes/RetailCrm-Api-Component-CustomApiMethod.html"><abbr title="\RetailCrm\Api\Component\CustomApiMethod">CustomApiMethod</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.html#method_register#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">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RetailCrm\Api\ResourceGroup\self::call">self::call</abbr></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Interfaces-RequestSenderInterface.html"><abbr title="\RetailCrm\Api\Interfaces\RequestSenderInterface">RequestSenderInterface</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Component-RequestSender.html"><abbr title="\RetailCrm\Api\Component\RequestSender">RequestSender</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Component-CustomApiMethod.html"><abbr title="\RetailCrm\Api\Component\CustomApiMethod">CustomApiMethod</abbr></a></span>
</dd>
</dl>
</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/ResourceGroup/CustomMethods.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-ResourceGroup-CustomMethods.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-ResourceGroup-CustomMethods.html#method___call">__call()</a></li>
<li><a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.html#method_call">call()</a></li>
<li><a href="classes/RetailCrm-Api-ResourceGroup-CustomMethods.html#method_register">register()</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-ResourceGroup-CustomMethods.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