Download the PHP package labrodev/laravel-numberable without Composer
On this page you can find all versions of the php package labrodev/laravel-numberable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download labrodev/laravel-numberable
More information about labrodev/laravel-numberable
Files in labrodev/laravel-numberable
Package laravel-numberable
Short Description Laravel package providing a reusable trait that automatically assigns a document number to Eloquent models upon creation.
License MIT
Homepage https://github.com/labrodev/laravel-numberable
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 laravel-numberable
Numberable for Laravel
Numberable is a Laravel package that provides a reusable trait for automatically assigning a number to Eloquent models upon their creation.
By default it generates a unique document number based on the model's ID and the current year. This method can be customized in individual models that use the trait, allowing for flexible document numbering logic.
- Base Year: Uses the current year as the prefix for the document number.
- Prediction Number: Sets a default "prediction number" (e.g., 10000), determining the minimum length of the number portion.
- Padding: Pads the model ID with leading zeros to match the length of the prediction number, ensuring consistent document number lengths.
For example, if the current year is 2024 and the model ID is 45 and prediction number is 10000, the generated document number would be: 202400045.
But you are free to provide your own logic of generation for specific models.
You just need to overwrite method protected function generateNumberByTraitModelHasNumber(int $modelId): string in your model.
Installation
To install the package, run the following command in your Laravel project:
Requirements
- PHP 8.1 or higher
Configuration
After installing the package, no additional configuration is needed to start using the UUID trait in your models.
Usage
To use the ModelHasNumber trait, simply include it in your Eloquent model:
Ensure that your model has 'number' column in model database table.
If it is not, you may add it through Laravel migration:
Override number column name
If the column in your database table designated for document number storage has a name different from the default, you can customize the trait to accommodate this.
Simply override the trait method in your model by adding the following method with your specific column name:
Overwrite logic of number generation
You may overwrite logic of number generation by customize logic in overwritten method in your model:
If you want to keep basic logic by generating number based on current year + prediction number + model ID, but there is a necessity to adjust prediction number value, you may add method to your model:
Testing
To run the tests included with the package, execute the following command:
For static analysis to check the package code, execute the followin command:
Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
Credits
Labro Dev
License
The MIT License (MIT). Please see License File for more information.
