hpz937/billReminder
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
b37c414111346b8e6afcc598ed4e439b4b47c76f
billReminder/docs/api/classes/Hpz937-Restclient-RestClient.html

1534 lines
72 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</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">Documentation</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/hpz937.html" class="">Hpz937</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/hpz937-billreminder.html" class="">BillReminder</a>
</li>
<li>
<a href="namespaces/hpz937-restclient.html" class="">Restclient</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/composer.html" class="">Composer</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/composer-autoload.html" class="">Autoload</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/Application.html" class="">Application</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Hpz937.html" class="">Hpz937</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Hpz937-BillReminder.html" class="">BillReminder</a>
</li>
</ul>
</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/hpz937.html">Hpz937</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/hpz937-restclient.html">Restclient</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
RestClient
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</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="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
</aside>
<p class="phpdocumentor-summary">Class RestClient</p>
<section class="phpdocumentor-description"><p>A versatile PHP class for making HTTP requests using cURL with options for handling JSON responses and cookies.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="classes/Hpz937-Restclient-RestClient.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-properties">
Properties
<a href="classes/Hpz937-Restclient-RestClient.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Hpz937-Restclient-RestClient.html#property_baseUrl">$baseUrl</a>
<span>
&nbsp;: string|null </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Hpz937-Restclient-RestClient.html#property_cookieFilePath">$cookieFilePath</a>
<span>
&nbsp;: string|null </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Hpz937-Restclient-RestClient.html#property_downloadFilename">$downloadFilename</a>
<span>
&nbsp;: string|null </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Hpz937-Restclient-RestClient.html#property_headers">$headers</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Hpz937-Restclient-RestClient.html#property_response">$response</a>
<span>
&nbsp;: string|null </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Hpz937-Restclient-RestClient.html#property_useCookies">$useCookies</a>
<span>
&nbsp;: bool </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Hpz937-Restclient-RestClient.html#property_userAgent">$userAgent</a>
<span>
&nbsp;: string|null </span>
</dt>
</dl>
<h4 id="toc-methods">
Methods
<a href="classes/Hpz937-Restclient-RestClient.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/Hpz937-Restclient-RestClient.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>RestClient constructor.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_decodeJson">decodeJson()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Decode the JSON response to an associative array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_delete">delete()</a>
<span>
&nbsp;: <a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a> </span>
</dt>
<dd>Make an HTTP DELETE request.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_download">download()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_get">get()</a>
<span>
&nbsp;: <a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a> </span>
</dt>
<dd>Make an HTTP GET request.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_getResponse">getResponse()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the raw HTTP response.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_post">post()</a>
<span>
&nbsp;: <a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a> </span>
</dt>
<dd>Make an HTTP POST request.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_put">put()</a>
<span>
&nbsp;: <a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a> </span>
</dt>
<dd>Make an HTTP PUT request.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_setBaseUrl">setBaseUrl()</a>
<span>
&nbsp;: <a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a> </span>
</dt>
<dd>Set the base URL for API requests.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_setHeaders">setHeaders()</a>
<span>
&nbsp;: <a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a> </span>
</dt>
<dd>Set custom HTTP headers for requests.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_setUseCookies">setUseCookies()</a>
<span>
&nbsp;: <a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a> </span>
</dt>
<dd>Set whether to use cookies for maintaining session.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Hpz937-Restclient-RestClient.html#method_setUserAgent">setUserAgent()</a>
<span>
&nbsp;: <a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a> </span>
</dt>
<dd>Set the user-agent string for HTTP requests.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Hpz937-Restclient-RestClient.html#method_jsonToArray">jsonToArray()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Convert JSON string to an associative array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Hpz937-Restclient-RestClient.html#method_request">request()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Send an HTTP request.</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/Hpz937-Restclient-RestClient.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_baseUrl">
$baseUrl
<a href="classes/Hpz937-Restclient-RestClient.html#property_baseUrl" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$baseUrl</span>
</code>
<section class="phpdocumentor-description"><p>The base URL for API requests.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_cookieFilePath">
$cookieFilePath
<a href="classes/Hpz937-Restclient-RestClient.html#property_cookieFilePath" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$cookieFilePath</span>
</code>
<section class="phpdocumentor-description"><p>The file path to use for storing cookies.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_downloadFilename">
$downloadFilename
<a href="classes/Hpz937-Restclient-RestClient.html#property_downloadFilename" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$downloadFilename</span>
</code>
<section class="phpdocumentor-description"><p>The filename to use when downloading a file.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_headers">
$headers
<a href="classes/Hpz937-Restclient-RestClient.html#property_headers" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$headers</span>
</code>
<section class="phpdocumentor-description"><p>The HTTP headers to include in requests.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_response">
$response
<a href="classes/Hpz937-Restclient-RestClient.html#property_response" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$response</span>
</code>
<section class="phpdocumentor-description"><p>The HTTP response from the most recent request.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_useCookies">
$useCookies
<a href="classes/Hpz937-Restclient-RestClient.html#property_useCookies" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$useCookies</span>
</code>
<section class="phpdocumentor-description"><p>Whether to use cookies for maintaining session.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_userAgent">
$userAgent
<a href="classes/Hpz937-Restclient-RestClient.html#property_userAgent" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$userAgent</span>
</code>
<section class="phpdocumentor-description"><p>The user-agent string to use in HTTP requests.</p>
</section>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Hpz937-Restclient-RestClient.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/Hpz937-Restclient-RestClient.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="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">RestClient 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>[</span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$cookieFilePath</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;/tmp/rest_client_cookies.txt&#039;</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">$cookieFilePath</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;/tmp/rest_client_cookies.txt&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_decodeJson">
decodeJson()
<a href="classes/Hpz937-Restclient-RestClient.html#method_decodeJson" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">167</span>
</aside>
<p class="phpdocumentor-summary">Decode the JSON response to an associative array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">decodeJson</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Hpz937-Restclient-RestClient.html#method_decodeJson#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="\Exception">Exception</abbr></span>
<section class="phpdocumentor-description"><p>If there is no response to decode or if there is a decoding error.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>The decoded JSON response.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_delete">
delete()
<a href="classes/Hpz937-Restclient-RestClient.html#method_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">155</span>
</aside>
<p class="phpdocumentor-summary">Make an HTTP DELETE request.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$endpoint</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</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">$endpoint</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The API endpoint to request.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>$this Allows method chaining.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_download">
download()
<a href="classes/Hpz937-Restclient-RestClient.html#method_download" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">175</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">download</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</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">$filename</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get">
get()
<a href="classes/Hpz937-Restclient-RestClient.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Make an HTTP GET request.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$endpoint</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</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">$endpoint</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The API endpoint to request.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>$this Allows method chaining.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getResponse">
getResponse()
<a href="classes/Hpz937-Restclient-RestClient.html#method_getResponse" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">186</span>
</aside>
<p class="phpdocumentor-summary">Get the raw HTTP response.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getResponse</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>The raw HTTP response.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_post">
post()
<a href="classes/Hpz937-Restclient-RestClient.html#method_post" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<p class="phpdocumentor-summary">Make an HTTP POST request.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">post</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$endpoint</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</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">$endpoint</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The API endpoint to request.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The data to include in the POST request body.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>$this Allows method chaining.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_put">
put()
<a href="classes/Hpz937-Restclient-RestClient.html#method_put" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">143</span>
</aside>
<p class="phpdocumentor-summary">Make an HTTP PUT request.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">put</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$endpoint</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</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">$endpoint</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The API endpoint to request.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The data to include in the PUT request body.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>$this Allows method chaining.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setBaseUrl">
setBaseUrl()
<a href="classes/Hpz937-Restclient-RestClient.html#method_setBaseUrl" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Set the base URL for API requests.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setBaseUrl</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$baseUrl</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</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">$baseUrl</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The base URL for API requests.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>$this Allows method chaining.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setHeaders">
setHeaders()
<a href="classes/Hpz937-Restclient-RestClient.html#method_setHeaders" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">106</span>
</aside>
<p class="phpdocumentor-summary">Set custom HTTP headers for requests.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setHeaders</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$headers</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</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">$headers</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An array of custom HTTP headers.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>$this Allows method chaining.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setUseCookies">
setUseCookies()
<a href="classes/Hpz937-Restclient-RestClient.html#method_setUseCookies" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">82</span>
</aside>
<p class="phpdocumentor-summary">Set whether to use cookies for maintaining session.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setUseCookies</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$useCookies</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</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">$useCookies</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Whether to use cookies (default: false).</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>$this Allows method chaining.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setUserAgent">
setUserAgent()
<a href="classes/Hpz937-Restclient-RestClient.html#method_setUserAgent" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<p class="phpdocumentor-summary">Set the user-agent string for HTTP requests.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setUserAgent</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$userAgent</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</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">$userAgent</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The user-agent string to use.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Hpz937-Restclient-RestClient.html"><abbr title="\Hpz937\Restclient\RestClient">RestClient</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>$this Allows method chaining.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_jsonToArray">
jsonToArray()
<a href="classes/Hpz937-Restclient-RestClient.html#method_jsonToArray" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">275</span>
</aside>
<p class="phpdocumentor-summary">Convert JSON string to an associative array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">jsonToArray</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$json</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</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">$json</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The JSON string to decode.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Hpz937-Restclient-RestClient.html#method_jsonToArray#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="\Exception">Exception</abbr></span>
<section class="phpdocumentor-description"><p>If there is a JSON decoding error.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>The decoded JSON as an associative array.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_request">
request()
<a href="classes/Hpz937-Restclient-RestClient.html#method_request" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/hpz937/restclient/src/RestClient.php"><a href="files/vendor-hpz937-restclient-src-restclient.html"><abbr title="vendor/hpz937/restclient/src/RestClient.php">RestClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">200</span>
</aside>
<p class="phpdocumentor-summary">Send an HTTP request.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">request</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$method</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$endpoint</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</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">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">$method</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The HTTP request method (GET, POST, PUT, DELETE, etc.).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$endpoint</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The API endpoint to request.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The data to include in the request body.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Hpz937-Restclient-RestClient.html#method_request#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="\Exception">Exception</abbr></span>
<section class="phpdocumentor-description"><p>If there is a cURL error, an HTTP error, or a JSON decoding error.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>The HTTP response.</p>
</section>
</section>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/vendor/hpz937/restclient/src/RestClient.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/Hpz937-Restclient-RestClient.html#toc-properties">Properties</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/Hpz937-Restclient-RestClient.html#property_baseUrl">$baseUrl<a href="classes/Hpz937-Restclient-RestClient.html"></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#property_cookieFilePath">$cookieFilePath<a href="classes/Hpz937-Restclient-RestClient.html"></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#property_downloadFilename">$downloadFilename<a href="classes/Hpz937-Restclient-RestClient.html"></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#property_headers">$headers<a href="classes/Hpz937-Restclient-RestClient.html"></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#property_response">$response<a href="classes/Hpz937-Restclient-RestClient.html"></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#property_useCookies">$useCookies<a href="classes/Hpz937-Restclient-RestClient.html"></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#property_userAgent">$userAgent<a href="classes/Hpz937-Restclient-RestClient.html"></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/Hpz937-Restclient-RestClient.html#method___construct">__construct()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_decodeJson">decodeJson()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_delete">delete()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_download">download()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_get">get()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_getResponse">getResponse()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_post">post()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_put">put()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_setBaseUrl">setBaseUrl()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_setHeaders">setHeaders()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_setUseCookies">setUseCookies()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_setUserAgent">setUserAgent()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_jsonToArray">jsonToArray()</a></li>
<li><a href="classes/Hpz937-Restclient-RestClient.html#method_request">request()</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/Hpz937-Restclient-RestClient.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 View Git Blame Copy Permalink