Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michael-rubel/laravel-formatters
«Formatter» pattern for Laravel.
https://github.com/michael-rubel/laravel-formatters
formatter formatters formatting laravel looking-for-contributors php
Last synced: 5 days ago
JSON representation
«Formatter» pattern for Laravel.
- Host: GitHub
- URL: https://github.com/michael-rubel/laravel-formatters
- Owner: michael-rubel
- License: mit
- Created: 2021-10-30T17:17:37.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T18:18:22.000Z (5 months ago)
- Last Synced: 2024-10-15T07:26:23.445Z (3 months ago)
- Topics: formatter, formatters, formatting, laravel, looking-for-contributors, php
- Language: PHP
- Homepage:
- Size: 450 KB
- Stars: 89
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Laravel Formatters
[](https://packagist.org/packages/michael-rubel/laravel-formatters)
[](https://packagist.org/packages/michael-rubel/laravel-formatters)
[](https://scrutinizer-ci.com/g/michael-rubel/laravel-formatters/?branch=main)
[](https://scrutinizer-ci.com/g/michael-rubel/laravel-formatters/?branch=main)
[](https://github.com/michael-rubel/laravel-formatters/actions)
[](https://github.com/michael-rubel/laravel-formatters/actions)
This package introduces the `Formatter` pattern you can use to standardize data formats in your Laravel application. You can write your own formatters and put them in `app/Formatters` folder, then apply them everywhere in your application through `format` helper. The package uses the Service Container under the hood to easily extend or override the formatter classes.
---
The package requires `PHP 8.1` or higher and `Laravel 10` or higher.
If you're looking for older versions, check [release history](https://github.com/michael-rubel/laravel-formatters/releases).
## #StandWithUkraine
[](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
## Installation
Install the package via composer:
```bash
composer require michael-rubel/laravel-formatters
```
```bash
php artisan vendor:publish --tag="formatters-config"
```
## Usage
```php
format(DateTimeFormatter::class, now());
```
You can use a shorter version of the string as an alternative:
```php
format('date-time', now());
```
## Available built-in formatters
- [`Date`](https://github.com/michael-rubel/laravel-formatters/blob/main/src/Collection/DateFormatter.php)
- [`DateTime`](https://github.com/michael-rubel/laravel-formatters/blob/main/src/Collection/DateTimeFormatter.php)
- [`FullName`](https://github.com/michael-rubel/laravel-formatters/blob/main/src/Collection/FullNameFormatter.php)
- [`LocaleNumber`](https://github.com/michael-rubel/laravel-formatters/blob/main/src/Collection/LocaleNumberFormatter.php)
- [`MaskString`](https://github.com/michael-rubel/laravel-formatters/blob/main/src/Collection/MaskStringFormatter.php)
- [`Name`](https://github.com/michael-rubel/laravel-formatters/blob/main/src/Collection/NameFormatter.php)
- [`TableColumn`](https://github.com/michael-rubel/laravel-formatters/blob/main/src/Collection/TableColumnFormatter.php)
- [`TaxNumber`](https://github.com/michael-rubel/laravel-formatters/blob/main/src/Collection/TaxNumberFormatter.php)
### Artisan command
To make the programmer's life easier, we also added the Artisan command. You can use `make:formatter` command to generate formatter classes. It will put the class with the given name into `app/Formatters` folder and auto-inject the stub.
### Extending formatters
Since the formatters are resolved through the Service Container they can be easily overridden by extending bindings.
For example in your Service Provider:
```php
$this->app->extend(DateTimeFormatter::class, function ($formatter) {
$formatter->datetime_format = 'Y.m.d H:i';
return $formatter;
});
```
### Adding custom/overriding package formatters
To add a custom formatter you should create the class that implements the `MichaelRubel\Formatters\Formatter` interface and put it to the `app/Formatters` folder.
You can put formatter with the same name as the package's to override the formatter from the package. You can customize the folder in the config file.
### Examples
You can discover examples of the usage [here](https://github.com/michael-rubel/laravel-formatters/blob/main/docs/examples.md).
## Contributing
If you have written your own formatter and want to add it to this package, PRs are welcomed. But take care of the extendability of the formatter you want to make as built-in and remember to write tests for your use cases.
## Testing
```bash
composer test
```