Download the PHP package effectra/third-party without Composer
On this page you can find all versions of the php package effectra/third-party. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package third-party
Effectra ThirdParty Library
Effectra\ThirdParty is a PHP library that provides OAuth configuration and functionality for various third-party platforms such as LinkedIn, GitHub, Facebook, and Google. It simplifies the process of integrating with these platforms and accessing user data through OAuth authentication.
Features
- Simplified OAuth configuration and authentication for third-party platforms.
- Easy retrieval of access tokens and user information.
- Supports multiple popular platforms like LinkedIn, GitHub, Facebook, and Google.
Installation
You can install the Effectra\ThirdParty library via Composer. Run the following command in your project directory:
Usage
To use the LinkedIn OAuth functionality, follow these steps:
-
Create an instance of the
LinkedIn
class by providing your LinkedIn client ID, client secret, and optional redirect URL and scopes. -
Generate the authorization URL to redirect the user for authentication:
-
Redirect the user to the generated authorization URL. After successful authentication, LinkedIn will redirect the user back to the specified redirect URL with an authorization code.
-
Exchange the authorization code for an access token:
- Use the access token to retrieve user information:
GitHub
To use the GitHub OAuth functionality, follow these steps:
-
Create an instance of the
GitHub
class by providing your GitHub client ID, client secret, and optional redirect URL and scopes. -
Generate the authorization URL to redirect the user for authentication:
-
Redirect the user to the generated authorization URL. After successful authentication, GitHub will redirect the user back to the specified redirect URL with an authorization code.
-
Exchange the authorization code for an access token:
- Use the access token to retrieve user information:
To use the Facebook OAuth functionality, follow these steps:
-
Create an instance of the
Facebook
class by providing your Facebook client ID, client secret, and optional redirect URL and scopes. -
Generate the authorization URL to redirect the user for authentication:
-
Redirect the user to the generated authorization URL. After successful authentication, Facebook will redirect the user back to the specified redirect URL with an authorization code.
- Exchange the authorization code for an access token:
5
. Use the access token to retrieve user information:
To use the Google OAuth functionality, follow these steps:
-
Create an instance of the
Google
class by providing your Google client ID, client secret, and optional redirect URL and scopes. -
Generate the authorization URL to redirect the user for authentication:
-
Redirect the user to the generated authorization URL. After successful authentication, Google will redirect the user back to the specified redirect URL with an authorization code.
-
Exchange the authorization code for an access token:
- Use the access token to retrieve user information:
OAuthServiceInterface
The OAuthServiceInterface
is an interface that defines the contract for an OAuth service. It provides methods for retrieving configuration, authorization URL, access token, and user data from an OAuth service.
Usage
To use this interface, you need to create a class that implements it and provides the necessary functionality. Here's an example of how you can implement the OAuthServiceInterface
:
In the above example, you need to replace the placeholder methods with your actual implementation based on the OAuth service you are integrating with.
Method Overview
getConfig(): array
This method returns the configuration array for the OAuth service.
getAuthURL(): string
This method returns the authorization URL for the OAuth service.
getAccessToken(string $code): string
This method retrieves the access token for the OAuth service using the authorization code provided as a parameter.
getUser(string $token): ?array
This method retrieves the user data from the OAuth service using the access token provided as a parameter. It returns an array containing user data or null
if the operation is unsuccessful.
License
This library is open source and available under the MIT License.
Contribution
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.
Credits
This library is developed and maintained by Effectra. You can find more information about us on our website: www.effectra.com
Contact
For any inquiries or questions, you can reach us at [email protected]
Feel free to modify and customize this README file according to your specific needs.