# CakePHP Localized plugin [![Build Status](https://secure.travis-ci.org/cakephp/localized.png?branch=master)](http://travis-ci.org/cakephp/localized)

This plugin contains various localized validation classes for specific countries.

## Requirements

The master branch has the following requirements:

* CakePHP 2.1.0 or greater.
* PHP 5.2.8 or greater.

## Installation

* Clone/Copy the files in this directory into `app/Plugin/Localized`
* Ensure the plugin is loaded in `app/Config/bootstrap.php` by calling `CakePlugin::load('Localized');`

### Using Composer

Ensure `require` is present in `composer.json`. This will install the plugin into `Plugin/Localized`:

```
{
    "require": {
        "cakephp/localized": "2.1.*"
    }
}
```

## Model validation

Localized validation classes can be used for validating model fields.

```php
<?php
App::uses('MxValidation', 'Localized.Validation');

class Post extends AppModel {

	public $validate = array(
		'postal' => array(
			'valid' => array(
				'rule' => array('postal', null, 'mx'),
				'message' => 'Must be valid mexico postal code'
			)
		)
	);
}
```

For further information on validation rules see the [cakephp documentation on validation](http://book.cakephp.org/2.0/en/models/data-validation.html)

## Using localized validations with Validation

You can also access the localized validators any time you would call `Validation` methods. After importing the validation class.

```php
	if (Validation::phone($value, null, 'cz')) {
		//do something with valid phone number
	}
```

## 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: `APP/locale/<locale>/LC_MESSAGES/cake.po`

## LC_TIME files

This plugin also houses POSIX compliant LC_TIME files which are used for translating
time related string of LC_TIME domain. To use these files link or copy them into
their expected location: `APP/locale/<locale>/LC_TIME`.

## Migration Guide

### Localized.Validation

The lib path for validation files changed. They should now be either in `APP/Validation/` or in `APP/PluginName/Validation/`.

You also need to adjust your App::uses() statements in your code accordingly:

`App::uses('MxValidation', 'Localized.Lib');` is now `App::uses('MxValidation', 'Localized.Validation');`

## 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).  Once you have pushed your changes back to github send a pull request, and your changes will be reviewed and merged in or feedback will be given.

## Issues with Localized

If you have issues with Localized, you can report them at https://github.com/cakephp/localized/issues
