Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cakephp/localized
I18n and L10n related CakePHP code
https://github.com/cakephp/localized
Last synced: about 1 month ago
JSON representation
I18n and L10n related CakePHP code
- Host: GitHub
- URL: https://github.com/cakephp/localized
- Owner: cakephp
- License: other
- Created: 2009-11-30T20:19:49.000Z (about 15 years ago)
- Default Branch: 5.x
- Last Pushed: 2024-05-07T08:12:52.000Z (7 months ago)
- Last Synced: 2024-05-17T19:02:40.897Z (7 months ago)
- Language: PHP
- Homepage:
- Size: 1.05 MB
- Stars: 213
- Watchers: 38
- Forks: 178
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-cakephp - Cake/Localized plugin - Localized validation and ready-to-use translation PO files. (I18n)
README
# CakePHP Localized plugin
[](https://app.codecov.io/gh/cakephp/localized/tree/5.x)
[](https://packagist.org/packages/cakephp/localized)
[](https://packagist.org/packages/cakephp/localized/stats)
[](LICENSE)
This plugin contains various localized validation classes for specific countries.
## Requirements
This branch is for use with CakePHP **5.x**. See [version map](https://github.com/cakephp/localized/wiki#version-map) for details.
## Demo
See [sandbox.dereuromark.de/sandbox/localized](https://sandbox.dereuromark.de/sandbox/localized) for live sandbox demo on localized validation.
## Installation
You can install this plugin into your CakePHP application using [composer](https://getcomposer.org).
The recommended way to install composer packages is:
```
composer require cakephp/localized
```
Load your plugin using
```
bin/cake plugin load Cake/Localized
```
or by manually adding `'Cake/Localized'` to the array in your app's `config/plugins.php`.
## Model validation
Localized validation classes can be used for validating model fields.
```php
namespace App\Model\Table;
use Cake\ORM\Table;
use Cake\Localized\Validation\FrValidation;
use Cake\Validation\Validator;
class PostsTable extends Table
{
public function validationDefault(Validator $validator): Validator
{
$validator->setProvider('fr', FrValidation::class);
$validator->add('phoneField', 'myCustomRuleNameForPhone', [
'rule' => 'phone',
'provider' => 'fr',
]);
}
}
```
For further information on validation rules see the [CakePHP documentation on validation](https://book.cakephp.org/5/en/core-libraries/validation.html)
## PO files
This plugin also houses translations for the client-facing translated strings in the core (the `cake` domain). to use these files link or copy them
into their expected location: `resources/locales//cake.po`
## Contributing to Localized
If you find that your country is not part of the Localized plugin, please fork the project on GitHub.
Once you have forked the project you can commit your validator class (and any test cases).
As soon as you have pushed your changes back to GitHub you can send a pull request and your changes will be reviewed and merged in, or feedback will be given.
### Validation methods
There are a few methods that are common to all classes, defined through the interface "ValidationInterface":
* `phone()` to check a phone number
* `postal()` to check a postal code
* `personId()` to check a country specific person ID
Please try to fit your validation rules in that naming scheme.
Apart from that you can also define further validation methods in your implementing class, of course.
## Issues with Localized
If you have issues with Localized, you can report them at [github.com/cakephp/localized/issues](https://github.com/cakephp/localized/issues).