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

Reimplement PR #287 for SDK 9.0.x #295

Merged
merged 4 commits into from
Apr 4, 2024
Merged

Reimplement PR #287 for SDK 9.0.x #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0fb44e8
SP-896 Update PHP 9.0.x readme
bobbrodie Mar 28, 2024
b57e4cd
Re-implement PR #287 for 9.0.x
bobbrodie Mar 29, 2024
db2a6a1
Generate documentation on version branches
bobbrodie Mar 29, 2024
cdc6ed9
Update phpdoc
Mar 29, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Documentation
on:
push:
branches:
- master
- '*.*.x'

concurrency:
group: documentation
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Full implementation of the BitPay Payment Gateway. This library implements BitPa

## Getting Started

To get up and running with our PHP library quickly, follow [the guide](https://bitpay.readme.io/reference/php-full-sdk-getting-started)
To get up and running with our PHP library quickly, follow [the guide](https://developer.bitpay.com/reference/php-full-sdk-getting-started)

## Support

Expand All @@ -18,7 +18,7 @@ To get up and running with our PHP library quickly, follow [the guide](https://b

### Requirements

- PHP version: 8.0 / 8.1 / 8.2
- PHP version: 8.1 / 8.2 / 8.3
- PHP extensions: json, reflection

## Unit Tests
Expand Down
110 changes: 79 additions & 31 deletions docs/classes/BitPaySDK-Client-BillClient.html
View file
Open in desktop

Large diffs are not rendered by default.

194 changes: 131 additions & 63 deletions docs/classes/BitPaySDK-Client-InvoiceClient.html
View file
Open in desktop

Large diffs are not rendered by default.

54 changes: 36 additions & 18 deletions docs/classes/BitPaySDK-Client-LedgerClient.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Bit
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/bitpaysdk.html" class="">BitPaySDK</a>
Expand All @@ -67,6 +67,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="namespaces/bitpaysdk-exceptions.html" class="">Exceptions</a>

</li>
<li>
<a href="namespaces/bitpaysdk-logger.html" class="">Logger</a>

</li>
<li>
<a href="namespaces/bitpaysdk-model.html" class="">Model</a>
Expand All @@ -79,7 +83,7 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</ul>

</section>
<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/BitPaySDK.html" class="">BitPaySDK</a>
Expand All @@ -88,10 +92,6 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/BitPaySDK-Client.html" class="">Client</a>

</li>
<li>
<a href="packages/BitPaySDK-Exceptions.html" class="">Exceptions</a>

</li>
<li>
<a href="packages/BitPaySDK-Model.html" class="">Model</a>
Expand All @@ -105,14 +105,14 @@ <h4 class="phpdocumentor-sidebar__root-namespace">

</section>

<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -reports">
<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">
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
Expand Down Expand Up @@ -149,7 +149,7 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/LedgerClient.php"><a href="files/src-bitpaysdk-client-ledgerclient.html"><abbr title="src/BitPaySDK/Client/LedgerClient.php">LedgerClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
<span class="phpdocumentor-element-found-in__line">29</span>

</aside>

Expand Down Expand Up @@ -266,6 +266,8 @@ <h4 id="toc-methods">





<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
Expand All @@ -289,7 +291,7 @@ <h4 class="phpdocumentor-element__name" id="property_instance">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/LedgerClient.php"><a href="files/src-bitpaysdk-client-ledgerclient.html"><abbr title="src/BitPaySDK/Client/LedgerClient.php">LedgerClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
<span class="phpdocumentor-element-found-in__line">31</span>

</aside>

Expand Down Expand Up @@ -322,7 +324,7 @@ <h4 class="phpdocumentor-element__name" id="property_restCli">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/LedgerClient.php"><a href="files/src-bitpaysdk-client-ledgerclient.html"><abbr title="src/BitPaySDK/Client/LedgerClient.php">LedgerClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
<span class="phpdocumentor-element-found-in__line">33</span>

</aside>

Expand Down Expand Up @@ -355,7 +357,7 @@ <h4 class="phpdocumentor-element__name" id="property_tokenCache">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/LedgerClient.php"><a href="files/src-bitpaysdk-client-ledgerclient.html"><abbr title="src/BitPaySDK/Client/LedgerClient.php">LedgerClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
<span class="phpdocumentor-element-found-in__line">32</span>

</aside>

Expand Down Expand Up @@ -393,7 +395,7 @@ <h4 class="phpdocumentor-element__name" id="method_get">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/LedgerClient.php"><a href="files/src-bitpaysdk-client-ledgerclient.html"><abbr title="src/BitPaySDK/Client/LedgerClient.php">LedgerClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
<span class="phpdocumentor-element-found-in__line">67</span>

</aside>

Expand Down Expand Up @@ -448,7 +450,15 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/BitPaySDK-Exceptions-LedgerQueryException.html"><abbr title="\BitPaySDK\Exceptions\LedgerQueryException">LedgerQueryException</abbr></a></span>
<span class="phpdocumentor-tag-link"><a href="classes/BitPaySDK-Exceptions-BitPayApiException.html"><abbr title="\BitPaySDK\Exceptions\BitPayApiException">BitPayApiException</abbr></a></span>


</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/BitPaySDK-Exceptions-BitPayGenericException.html"><abbr title="\BitPaySDK\Exceptions\BitPayGenericException">BitPayGenericException</abbr></a></span>


</dd>
Expand Down Expand Up @@ -478,7 +488,7 @@ <h4 class="phpdocumentor-element__name" id="method_getInstance">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/LedgerClient.php"><a href="files/src-bitpaysdk-client-ledgerclient.html"><abbr title="src/BitPaySDK/Client/LedgerClient.php">LedgerClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
<span class="phpdocumentor-element-found-in__line">48</span>

</aside>

Expand Down Expand Up @@ -531,7 +541,7 @@ <h4 class="phpdocumentor-element__name" id="method_getLedgers">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/LedgerClient.php"><a href="files/src-bitpaysdk-client-ledgerclient.html"><abbr title="src/BitPaySDK/Client/LedgerClient.php">LedgerClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
<span class="phpdocumentor-element-found-in__line">105</span>

</aside>

Expand All @@ -556,7 +566,15 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/BitPaySDK-Exceptions-BitPayException.html"><abbr title="\BitPaySDK\Exceptions\BitPayException">BitPayException</abbr></a></span>
<span class="phpdocumentor-tag-link"><a href="classes/BitPaySDK-Exceptions-BitPayApiException.html"><abbr title="\BitPaySDK\Exceptions\BitPayApiException">BitPayApiException</abbr></a></span>


</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/BitPaySDK-Exceptions-BitPayGenericException.html"><abbr title="\BitPaySDK\Exceptions\BitPayGenericException">BitPayGenericException</abbr></a></span>


</dd>
Expand Down Expand Up @@ -586,7 +604,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/LedgerClient.php"><a href="files/src-bitpaysdk-client-ledgerclient.html"><abbr title="src/BitPaySDK/Client/LedgerClient.php">LedgerClient.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
<span class="phpdocumentor-element-found-in__line">35</span>

</aside>

Expand Down
Loading