Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TEST | DO NOT MERGE] 📚 Update GHPages website #927

Draft
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Draft

[TEST | DO NOT MERGE] 📚 Update GHPages website #927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f384bdf
GH Pages: update API docs for Requests 925/merge
github-actions[bot] Jan 22, 2025
169bf48
GH Pages: update other docs for Requests 925/merge
github-actions[bot] Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions api-2.x/classes/WpOrg-Requests-Auth-Basic.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</section>
<section class="phpdocumentor-sidebar__category -packages">
<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/Requests.html" class="">Requests</a>
</h4>
Expand Down Expand Up @@ -107,10 +111,6 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</li>
</ul>

<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</a>
</h4>

</section>

<section class="phpdocumentor-sidebar__category -reports">
Expand Down Expand Up @@ -161,7 +161,7 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth/Basic.php"><a href="files/src-auth-basic.html"><abbr title="src/Auth/Basic.php">Basic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
<span class="phpdocumentor-element-found-in__line">25</span>

</aside>

Expand Down Expand Up @@ -239,14 +239,14 @@ <h4 id="toc-methods">
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set cURL parameters before the data is sent</dd>
<dd>Set cURL parameters before the data is sent.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/WpOrg-Requests-Auth-Basic.html#method_fsockopen_header">fsockopen_header()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Add extra headers to the request before sending</dd>
<dd>Add extra headers to the request before sending.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/WpOrg-Requests-Auth-Basic.html#method_getAuthString">getAuthString()</a>
Expand Down Expand Up @@ -292,7 +292,7 @@ <h4 class="phpdocumentor-element__name" id="property_pass">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth/Basic.php"><a href="files/src-auth-basic.html"><abbr title="src/Auth/Basic.php">Basic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
<span class="phpdocumentor-element-found-in__line">38</span>

</aside>

Expand Down Expand Up @@ -329,7 +329,7 @@ <h4 class="phpdocumentor-element__name" id="property_user">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth/Basic.php"><a href="files/src-auth-basic.html"><abbr title="src/Auth/Basic.php">Basic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
<span class="phpdocumentor-element-found-in__line">31</span>

</aside>

Expand Down Expand Up @@ -371,7 +371,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth/Basic.php"><a href="files/src-auth-basic.html"><abbr title="src/Auth/Basic.php">Basic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
<span class="phpdocumentor-element-found-in__line">51</span>

</aside>

Expand Down Expand Up @@ -465,11 +465,11 @@ <h4 class="phpdocumentor-element__name" id="method_curl_before_send">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth/Basic.php"><a href="files/src-auth-basic.html"><abbr title="src/Auth/Basic.php">Basic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">81</span>
<span class="phpdocumentor-element-found-in__line">83</span>

</aside>

<p class="phpdocumentor-summary">Set cURL parameters before the data is sent</p>
<p class="phpdocumentor-summary">Set cURL parameters before the data is sent.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Expand All @@ -486,7 +486,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
: <span class="phpdocumentor-signature__argument__return-type">resource|<abbr title="\CurlHandle">CurlHandle</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>cURL handle</p>
<section class="phpdocumentor-description"><p>The cURL handle.</p>
</section>

</dd>
Expand All @@ -512,11 +512,11 @@ <h4 class="phpdocumentor-element__name" id="method_fsockopen_header">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth/Basic.php"><a href="files/src-auth-basic.html"><abbr title="src/Auth/Basic.php">Basic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">91</span>
<span class="phpdocumentor-element-found-in__line">93</span>

</aside>

<p class="phpdocumentor-summary">Add extra headers to the request before sending</p>
<p class="phpdocumentor-summary">Add extra headers to the request before sending.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Expand All @@ -533,7 +533,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>HTTP header string</p>
<section class="phpdocumentor-description"><p>HTTP header string.</p>
</section>

</dd>
Expand All @@ -559,7 +559,7 @@ <h4 class="phpdocumentor-element__name" id="method_getAuthString">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth/Basic.php"><a href="files/src-auth-basic.html"><abbr title="src/Auth/Basic.php">Basic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">100</span>
<span class="phpdocumentor-element-found-in__line">102</span>

</aside>

Expand Down Expand Up @@ -598,7 +598,7 @@ <h4 class="phpdocumentor-element__name" id="method_register">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth/Basic.php"><a href="files/src-auth-basic.html"><abbr title="src/Auth/Basic.php">Basic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
<span class="phpdocumentor-element-found-in__line">73</span>

</aside>

Expand Down
12 changes: 6 additions & 6 deletions api-2.x/classes/WpOrg-Requests-Auth.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</section>
<section class="phpdocumentor-sidebar__category -packages">
<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/Requests.html" class="">Requests</a>
</h4>
Expand Down Expand Up @@ -107,10 +111,6 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</li>
</ul>

<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</a>
</h4>

</section>

<section class="phpdocumentor-sidebar__category -reports">
Expand Down Expand Up @@ -148,7 +148,7 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth.php"><a href="files/src-auth.html"><abbr title="src/Auth.php">Auth.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
<span class="phpdocumentor-element-found-in__line">26</span>

</aside>

Expand Down Expand Up @@ -236,7 +236,7 @@ <h4 class="phpdocumentor-element__name" id="method_register">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Auth.php"><a href="files/src-auth.html"><abbr title="src/Auth.php">Auth.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
<span class="phpdocumentor-element-found-in__line">37</span>

</aside>

Expand Down
74 changes: 68 additions & 6 deletions api-2.x/classes/WpOrg-Requests-Autoload.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</section>
<section class="phpdocumentor-sidebar__category -packages">
<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/Requests.html" class="">Requests</a>
</h4>
Expand Down Expand Up @@ -107,10 +111,6 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</li>
</ul>

<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</a>
</h4>

</section>

<section class="phpdocumentor-sidebar__category -reports">
Expand Down Expand Up @@ -158,7 +158,7 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Autoload.php"><a href="files/src-autoload.html"><abbr title="src/Autoload.php">Autoload.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
<span class="phpdocumentor-element-found-in__line">35</span>

</aside>

Expand All @@ -171,6 +171,21 @@ <h2 class="phpdocumentor-content__title">
</section>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/WpOrg-Requests-Autoload.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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.0.0</span>


</dd>
</dl>



Expand All @@ -197,6 +212,13 @@ <h4 id="toc-methods">

</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/WpOrg-Requests-Autoload.html#method_get_deprecated_classes">get_deprecated_classes()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Get the array of deprecated Requests 1.x classes mapped to their equivalent Requests 2.x implementation.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/WpOrg-Requests-Autoload.html#method_load">load()</a>
<span>
Expand All @@ -223,6 +245,45 @@ <h3 class="phpdocumentor-elements__header" id="methods">
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_get_deprecated_classes">
get_deprecated_classes()
<a href="classes/WpOrg-Requests-Autoload.html#method_get_deprecated_classes" 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/Autoload.php"><a href="files/src-autoload.html"><abbr title="src/Autoload.php">Autoload.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">194</span>

</aside>

<p class="phpdocumentor-summary">Get the array of deprecated Requests 1.x classes mapped to their equivalent Requests 2.x implementation.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">get_deprecated_classes</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>







<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
</section>

</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_load">
load()
Expand All @@ -232,7 +293,7 @@ <h4 class="phpdocumentor-element__name" id="method_load">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Autoload.php"><a href="files/src-autoload.html"><abbr title="src/Autoload.php">Autoload.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
<span class="phpdocumentor-element-found-in__line">133</span>

</aside>

Expand Down Expand Up @@ -386,6 +447,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/WpOrg-Requests-Autoload.html#method_get_deprecated_classes">get_deprecated_classes()</a></li>
<li class=""><a href="classes/WpOrg-Requests-Autoload.html#method_load">load()</a></li>
</ul>
</li>
Expand Down
29 changes: 22 additions & 7 deletions api-2.x/classes/WpOrg-Requests-Capability.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</section>
<section class="phpdocumentor-sidebar__category -packages">
<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/Requests.html" class="">Requests</a>
</h4>
Expand Down Expand Up @@ -107,10 +111,6 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</li>
</ul>

<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</a>
</h4>

</section>

<section class="phpdocumentor-sidebar__category -reports">
Expand Down Expand Up @@ -148,7 +148,7 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Capability.php"><a href="files/src-capability.html"><abbr title="src/Capability.php">Capability.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
<span class="phpdocumentor-element-found-in__line">20</span>

</aside>

Expand All @@ -159,6 +159,21 @@ <h2 class="phpdocumentor-content__title">
</section>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/WpOrg-Requests-Capability.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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.0.0</span>


</dd>
</dl>



Expand Down Expand Up @@ -221,7 +236,7 @@ <h4 class="phpdocumentor-element__name" id="constant_ALL">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Capability.php"><a href="files/src-capability.html"><abbr title="src/Capability.php">Capability.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
<span class="phpdocumentor-element-found-in__line">36</span>

</aside>

Expand Down Expand Up @@ -255,7 +270,7 @@ <h4 class="phpdocumentor-element__name" id="constant_SSL">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Capability.php"><a href="files/src-capability.html"><abbr title="src/Capability.php">Capability.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
<span class="phpdocumentor-element-found-in__line">27</span>

</aside>

Expand Down
Loading