Country Plugin

This plugin provides useful functions/data when dealing with countries.

Dependencies

This uses ArraySource extensively. In your plugins directory do: git clone git://github.com/cakephp/datasources

Due to this (and plugin DATABASE_CONFIG objects not being supported) the lines: var $country_array( 'datasource' => 'Datasources.ArraySource' ); must be added to your app/core/database.php file.

Models

Provides information about Countries. Main fields are: ISO alpha-2 Code ISO alpha-3 Code ISO numeric Code FIPS Code but there are a lot more. Also provides information about neighbouring countries and country languages.

Usage

In your controller: var $uses = array('Country.Country');

Anywhere else: $Country = ClassRegistry::init('Country.Country');

Available methods: findISO2($code) $code - valid ISO alpha-2, ISO alpha-3 or ISO numeric Code @return - valid ISO alpha-2 code

findISO3($code)
    $code - valid ISO alpha-2, ISO alpha-3 or ISO numeric Code
    @return - valid ISO alpha-3 code

findISONum($code)
    $code - valid ISO alpha-2, ISO alpha-3 or ISO numeric Code
    @return - valid ISO numeric code

countryName($code)
    $code - valid ISO alpha-2, ISO alpha-3 or ISO numeric Code
    @return - Country Name

continentName($code)
    $code - valid ISO alpha-2, ISO alpha-3 or ISO numeric Code
    @return - Continent Name

Helpers

Provides ability to output flag images if given valid iso or iso3 code. Provides select boxes for countries or continents.

Usage

In your controller: var $helpers = array('COuntry.Country');

Available methods: flag($code, $options = array()) $code - valid ISO alpha-2, ISO alpha-3 or ISO numeric Code $options - htmlOptions, same as for HtmlHelper::image method @return - HTML image tag for flag of the relevant country.

countrySelect($name, $options = array()
    $name - field name
    $options - FormHelper::input options element.
    @return - HTML select box with selected countries.

continentSelect($name, $options = array()
    $name - field name
    $options - FormHelper::input options element.
    @return - HTML select box with selected continents.

Also, all the model methods are valid.

Behaviours

Provides methods to validate country code fields, and postal codes, based on either a fixed country or a different form field for country.

Usage

In your model: var $actsAs = array('COuntry.Country');

Available validation methods for use in $model->validate array: countryValidISO2 countryValidISO3 countryValidISONum countryValidPostalCode

More on countryValidPostalCode: countryValidPostalCode takes a single argument - i.e var $validate = array( 'postal_code' => array( 'rule' => array('countryValidPostalCode', array('type' => 'value')) ) ); 'type' can be one of: iso iso3 numeric fips 'value' can either be a code of the required type, in which case the settings for that country will be used, OR a field name, in which case the current value of that field will be used as the country.