Skip to content

Commit

Permalink
Minor vardoc and README fix for oauthGetRedirectUrl method
Browse files Browse the repository at this point in the history
  • Loading branch information
colinmollenhour committed Apr 18, 2024
1 parent 0ebe83c commit ffb3ee1
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -997,12 +997,12 @@ $this->removeCache('some_data');

## OAuth

Several OAuth methods are defined in the interfate to provide an abstracted support for performing OAuth "Client Credentials"
Several OAuth methods are defined in the interface to provide an abstracted support for performing OAuth "Client Credentials"
type authentication whereby the user authenticates and authorizes the plugin through a redirect to the third-party system
with which the plugin is integrating. These methods are:

- oauthHandleRedirect(request: array): void
- oauthGetRedirectUrl([params: array = [...]]): string
- oauthGetRedirectUrl(area: string, bypassGateway: bool): string
- oauthGetConnectUrl([redirectUrl: null|string = NULL]): string
- oauthGetConnectButton([connectParams: array = [...]]): string
- oauthDisconnect([params: array = [...]]): void
Expand Down
3 changes: 2 additions & 1 deletion lib/Plugin/Abstract.php
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,8 @@ public function handleWebhook($query, $headers, $data)
public function oauthHandleRedirect($request) {}

/**
* @param array $params
* @param null|string $area
* @param bool $bypassGateway
* @return string
*/
public function oauthGetRedirectUrl($area = NULL, $bypassGateway = FALSE)
Expand Down
1 change: 1 addition & 0 deletions lib/Plugin/Interface.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ function oauthHandleRedirect($request);

/**
* @param null|string $area
* @param bool $bypassGateway
* @return string
*/
function oauthGetRedirectUrl($area = NULL, $bypassGateway = FALSE);
Expand Down

0 comments on commit ffb3ee1

Please sign in to comment.