Download the PHP package digitaltunnel/otakit without Composer
On this page you can find all versions of the php package digitaltunnel/otakit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download digitaltunnel/otakit
More information about digitaltunnel/otakit
Files in digitaltunnel/otakit
Package otakit
Short Description OtaKit is a Laravel package designed to facilitate the generation and validation of One-Time Passwords (OTPs) within Laravel applications.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package otakit
Otakit
OtaKit is a Laravel package designed to facilitate the generation and validation of One-Time Passwords (OTPs) within Laravel applications.
1. Installation
You can install the package via Composer:
2. Publish Provider
After installing the package, publish its service provider and configuration file using the following Artisan command:
This will publish the configuration file (config/otakit.php) to your application's config directory. You can customize the OTP length and expiration time in this file.
3. Usage
3.1 Prepare Model
To use the OtaKit package, you need to add the Otakit trait to the model you want to generate OTPs for. This trait provides the necessary methods to generate and validate OTPs.
Model can be any model in your application, such as User, Customer ..., extended from the Illuminate\Database\Eloquent\Model class.
3.2 Generate OTP
To generate an OTP for an otpable model, use the GenerateOtp action:
generateOtp can accept two optional parameters: length and ttl. The length parameter specifies the length of the OTP to generate, while the ttl parameter specifies the time to live for the OTP in minutes.
or you can use the generateOtp action directly:
3.3 Validate OTP
To validate an OTP, use the validateOtp method on the otpable model:
or you can use the validateOtp action directly:
4. Listen to Events
The Otakit package fires events when an OTP is generated and when an OTP is validated. You can listen to these events in your application by adding event listeners to your EventServiceProvider.
5. Tests
This package is thoroughly tested using Pest. To run the tests, use the following command:
Test Coverage
OTP generation and storage.
OTP verification (valid, invalid, and expired cases).
Event dispatching for OTP lifecycle events.6. License
This package is open-source software licensed under the MIT License. See the LICENSE file for more details.
Contributing
Contributions are welcome!.
Security Vulnerabilities
If you discover a security vulnerability within this package, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.
Credits
This package is developed and maintained by Digital Tunnel.
Support
If you encounter any issues or have questions, please open an issue on the GitHub repository.
