619 lines
31 KiB
HTML
619 lines
31 KiB
HTML
|
<!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-component.html">Component</a></li>
|
||
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/retailcrm-api-component-formdata.html">FormData</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<article class="phpdocumentor-element -class">
|
||
|
|
<h2 class="phpdocumentor-content__title">
|
||
|
|
FormEncoder
|
||
|
|
|
||
|
|
|
||
|
|
<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-Component.html">Component</a></li>
|
||
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/RetailCrm-Api-Component-FormData.html">FormData</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<span class="phpdocumentor-element__implements">
|
||
|
|
implements
|
||
|
|
<a href="classes/RetailCrm-Api-Interfaces-FormEncoderInterface.html"><abbr title="\RetailCrm\Api\Interfaces\FormEncoderInterface">FormEncoderInterface</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/Component/FormData/FormEncoder.php"><a href="files/src-component-formdata-formencoder.html"><abbr title="src/Component/FormData/FormEncoder.php">FormEncoder.php</abbr></a></abbr>
|
||
|
|
:
|
||
|
|
<span class="phpdocumentor-element-found-in__line">33</span>
|
||
|
|
|
||
|
|
</aside>
|
||
|
|
|
||
|
|
<p class="phpdocumentor-summary">Class FormEncoder</p>
|
||
|
|
|
||
|
|
<section class="phpdocumentor-description"><p>FormEncoder is a vital part of the library. Our API expects form-data for all requests, but some fields may contain
|
||
|
|
JSON data (for example, <code class="prettyprint">/api/v5/customers/create</code> method works like that). FormEncoder is our custom serializer that
|
||
|
|
converts request instances to form-data and uses Liip serializer under the hood to fill some fields with JSON data.</p>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
||
|
|
Tags
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.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">see</span>
|
||
|
|
</dt>
|
||
|
|
<dd class="phpdocumentor-tag-list__definition">
|
||
|
|
<span class="phpdocumentor-tag-link"><a href="https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-customers-create">https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-customers-create</a></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<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>FormEncoder</p>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 id="toc">
|
||
|
|
Table of Contents
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
||
|
|
|
||
|
|
</h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 id="toc-interfaces">
|
||
|
|
Interfaces
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.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-FormEncoderInterface.html"><abbr title="\RetailCrm\Api\Interfaces\FormEncoderInterface">FormEncoderInterface</abbr></a></dt><dd>Interface FormEncoderInterface</dd> </dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 id="toc-methods">
|
||
|
|
Methods
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.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-Component-FormData-FormEncoder.html#method___construct">__construct()</a>
|
||
|
|
<span>
|
||
|
|
: mixed </span>
|
||
|
|
</dt>
|
||
|
|
<dd>FormEncoder constructor.</dd>
|
||
|
|
|
||
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#method_encode">encode()</a>
|
||
|
|
<span>
|
||
|
|
: string </span>
|
||
|
|
</dt>
|
||
|
|
<dd>Encodes provided object into a form data</dd>
|
||
|
|
|
||
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#method_encodeArray">encodeArray()</a>
|
||
|
|
<span>
|
||
|
|
: array<string|int, mixed> </span>
|
||
|
|
</dt>
|
||
|
|
<dd>Encodes provided object into an array</dd>
|
||
|
|
|
||
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#method_getSerializer">getSerializer()</a>
|
||
|
|
<span>
|
||
|
|
: <abbr title="\Liip\Serializer\SerializerInterface">SerializerInterface</abbr> </span>
|
||
|
|
</dt>
|
||
|
|
<dd>Returns underlying serializer instance.</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section class="phpdocumentor-methods">
|
||
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
||
|
|
Methods
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.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/RetailCrm-Api-Component-FormData-FormEncoder.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/Component/FormData/FormEncoder.php"><a href="files/src-component-formdata-formencoder.html"><abbr title="src/Component/FormData/FormEncoder.php">FormEncoder.php</abbr></a></abbr>
|
||
|
|
:
|
||
|
|
<span class="phpdocumentor-element-found-in__line">47</span>
|
||
|
|
|
||
|
|
</aside>
|
||
|
|
|
||
|
|
<p class="phpdocumentor-summary">FormEncoder constructor.</p>
|
||
|
|
|
||
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
||
|
|
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Liip\Serializer\SerializerInterface">SerializerInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$serializer</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Doctrine\Common\Annotations\Reader">Reader</abbr>|null </span><span class="phpdocumentor-signature__argument__name">$annotationReader</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||
|
|
|
||
|
|
<div class="phpdocumentor-label-line">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||
|
|
<dl class="phpdocumentor-argument-list">
|
||
|
|
<dt class="phpdocumentor-argument-list__entry">
|
||
|
|
<span class="phpdocumentor-signature__argument__name">$serializer</span>
|
||
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Liip\Serializer\SerializerInterface">SerializerInterface</abbr></span>
|
||
|
|
</dt>
|
||
|
|
<dd class="phpdocumentor-argument-list__definition">
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt class="phpdocumentor-argument-list__entry">
|
||
|
|
<span class="phpdocumentor-signature__argument__name">$annotationReader</span>
|
||
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Doctrine\Common\Annotations\Reader">Reader</abbr>|null</span>
|
||
|
|
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
|
||
|
|
<dd class="phpdocumentor-argument-list__definition">
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
<article
|
||
|
|
class="phpdocumentor-element
|
||
|
|
-method
|
||
|
|
-public
|
||
|
|
"
|
||
|
|
>
|
||
|
|
<h4 class="phpdocumentor-element__name" id="method_encode">
|
||
|
|
encode()
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#method_encode" 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/Component/FormData/FormEncoder.php"><a href="files/src-component-formdata-formencoder.html"><abbr title="src/Component/FormData/FormEncoder.php">FormEncoder.php</abbr></a></abbr>
|
||
|
|
:
|
||
|
|
<span class="phpdocumentor-element-found-in__line">62</span>
|
||
|
|
|
||
|
|
</aside>
|
||
|
|
|
||
|
|
<p class="phpdocumentor-summary">Encodes provided object into a form data</p>
|
||
|
|
|
||
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
||
|
|
<span class="phpdocumentor-signature__name">encode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$object</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">$object</span>
|
||
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
||
|
|
</dt>
|
||
|
|
<dd class="phpdocumentor-argument-list__definition">
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt class="phpdocumentor-argument-list__entry">
|
||
|
|
<span class="phpdocumentor-signature__argument__name">$type</span>
|
||
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</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-Component-FormData-FormEncoder.html#method_encode#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"><abbr title="\ReflectionException">ReflectionException</abbr></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
</article>
|
||
|
|
<article
|
||
|
|
class="phpdocumentor-element
|
||
|
|
-method
|
||
|
|
-public
|
||
|
|
"
|
||
|
|
>
|
||
|
|
<h4 class="phpdocumentor-element__name" id="method_encodeArray">
|
||
|
|
encodeArray()
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#method_encodeArray" 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/Component/FormData/FormEncoder.php"><a href="files/src-component-formdata-formencoder.html"><abbr title="src/Component/FormData/FormEncoder.php">FormEncoder.php</abbr></a></abbr>
|
||
|
|
:
|
||
|
|
<span class="phpdocumentor-element-found-in__line">76</span>
|
||
|
|
|
||
|
|
</aside>
|
||
|
|
|
||
|
|
<p class="phpdocumentor-summary">Encodes provided object into an array</p>
|
||
|
|
|
||
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
||
|
|
<span class="phpdocumentor-signature__name">encodeArray</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$object</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</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<string|int, mixed></span></code>
|
||
|
|
|
||
|
|
<div class="phpdocumentor-label-line">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||
|
|
<dl class="phpdocumentor-argument-list">
|
||
|
|
<dt class="phpdocumentor-argument-list__entry">
|
||
|
|
<span class="phpdocumentor-signature__argument__name">$object</span>
|
||
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
||
|
|
</dt>
|
||
|
|
<dd class="phpdocumentor-argument-list__definition">
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt class="phpdocumentor-argument-list__entry">
|
||
|
|
<span class="phpdocumentor-signature__argument__name">$type</span>
|
||
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</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-Component-FormData-FormEncoder.html#method_encodeArray#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"><abbr title="\ReflectionException">ReflectionException</abbr></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
</article>
|
||
|
|
<article
|
||
|
|
class="phpdocumentor-element
|
||
|
|
-method
|
||
|
|
-public
|
||
|
|
"
|
||
|
|
>
|
||
|
|
<h4 class="phpdocumentor-element__name" id="method_getSerializer">
|
||
|
|
getSerializer()
|
||
|
|
<a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#method_getSerializer" 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/Component/FormData/FormEncoder.php"><a href="files/src-component-formdata-formencoder.html"><abbr title="src/Component/FormData/FormEncoder.php">FormEncoder.php</abbr></a></abbr>
|
||
|
|
:
|
||
|
|
<span class="phpdocumentor-element-found-in__line">94</span>
|
||
|
|
|
||
|
|
</aside>
|
||
|
|
|
||
|
|
<p class="phpdocumentor-summary">Returns underlying serializer instance.</p>
|
||
|
|
|
||
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
||
|
|
<span class="phpdocumentor-signature__name">getSerializer</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Liip\Serializer\SerializerInterface">SerializerInterface</abbr></span></code>
|
||
|
|
|
||
|
|
<div class="phpdocumentor-label-line">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\Liip\Serializer\SerializerInterface">SerializerInterface</abbr></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/Component/FormData/FormEncoder.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
|
||
|
|
</div>
|
||
|
|
<button data-exit-button class="phpdocumentor-modal__close">×</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-Component-FormData-FormEncoder.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-Component-FormData-FormEncoder.html#method___construct">__construct()</a></li>
|
||
|
|
<li><a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#method_encode">encode()</a></li>
|
||
|
|
<li><a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#method_encodeArray">encodeArray()</a></li>
|
||
|
|
<li><a href="classes/RetailCrm-Api-Component-FormData-FormEncoder.html#method_getSerializer">getSerializer()</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-Component-FormData-FormEncoder.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>
|