#5 Allow setting a proxy #27
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@qurben Have you tested it somehow? :) |
|
@dnl-blkv I tested it with a socks proxy through ssh to a remote server. |
dnl-blkv
previously requested changes
Aug 7, 2017
README.md
Outdated
| ##### Proxy | ||
|
|
||
| You can use a proxy with the bunq PHP SDK. This option must be a string. This proxy will be used for all requests done with | ||
| the SDK. You will be prompted to provide a proxy URL when using the interactive installation script. |
There was a problem hiding this comment.
May be smth like This proxy will be used for all the requests done with the context for which it was specified ?
README.md
Outdated
| @@ -80,6 +80,20 @@ $apiContext = ApiContext::restore($fileName); | |||
| **Tip:** both saving and restoring the context can be done without any arguments. In this case the context will be saved | |||
| to/restored from the `bunq.conf` file in the same folder with your script. | |||
|
|
|||
| ##### Proxy | |||
|
|
|||
There was a problem hiding this comment.
Do we really need this newline? :P
README.md
Outdated
| the SDK. You will be prompted to provide a proxy URL when using the interactive installation script. | ||
|
|
||
| ```php | ||
| $proxyUrl = 'socks5://localhost:1080'; // The proxy for all requests, leave empty to disable |
There was a problem hiding this comment.
Leave empty? So, empty string disables it?
src/Context/ApiContext.php
Outdated
| @@ -331,6 +346,14 @@ public function getEnvironmentType() | |||
| } | |||
|
|
|||
| /** | |||
| * @return string | |||
src/Context/ApiContext.php
Outdated
| @@ -331,6 +346,14 @@ public function getEnvironmentType() | |||
| } | |||
|
|
|||
| /** | |||
| * @return string | |||
| */ | |||
| public function getProxyUrlOrNull() | |||
There was a problem hiding this comment.
We typically do not do OrNull in the getters in the SDK code. The reason is that the option of nullability is already stated in the doc header, and adding it into method name is not a normal practice among the PHP community.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Save the proxy in the ApiContext. Allow an api context to not contain a proxy.
Fixes #5