| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Part of the Joomla Framework OAuth2 Package
| Copyright: | Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. |
| License: | GNU General Public License version 2 or later; see LICENSE |
| File Size: | 423 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Client:: (10 methods):
__construct()
authenticate()
isAuthenticated()
createUrl()
query()
getOption()
setOption()
getToken()
setToken()
refreshToken()
| __construct($options = [], Http $http = null, Input $input = null, WebApplicationInterface $application = null) X-Ref |
| Constructor. param: array|\ArrayAccess $options OAuth2 Client options object param: Http $http The HTTP client object param: Input $input The input object param: WebApplicationInterface $application The application object |
| authenticate() X-Ref |
| Get the access token or redirect to the authentication URL. return: array|boolean The access token or false on failure |
| isAuthenticated() X-Ref |
| Verify if the client has been authenticated return: boolean Is authenticated |
| createUrl() X-Ref |
| Create the URL for authentication. return: string |
| query($url, $data = null, $headers = [], $method = 'get', $timeout = null) X-Ref |
| Send a signed OAuth request. param: string $url The URL for the request param: mixed $data Either an associative array or a string to be sent with the request param: array $headers The headers to send with the request param: string $method The method with which to send the request param: integer $timeout The timeout for the request return: \Joomla\Http\Response |
| getOption($key, $default = null) X-Ref |
| Get an option from the OAuth2 Client instance. param: string $key The name of the option to get param: mixed $default Optional default value, returned if the requested option does not exist. return: mixed The option value |
| setOption($key, $value) X-Ref |
| Set an option for the OAuth2 Client instance. param: string $key The name of the option to set param: mixed $value The option value to set return: Client This object for method chaining |
| getToken() X-Ref |
| Get the access token from the Client instance. return: array The access token |
| setToken($value) X-Ref |
| Set an option for the Client instance. param: array $value The access token return: Client This object for method chaining |
| refreshToken($token = null) X-Ref |
| Refresh the access token instance. param: string $token The refresh token return: array The new access token |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |