root/trunk/lib/widget/ExtendedWidgetFormI18nSelectCountry.class.php

<?php

/*
 * This file is part of the symfony package.
 * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * ExtendedWidgetFormI18nSelectCountry represents a country HTML select tag, and 
 * adds some useful options.
 *
 * @package    symfony
 * @subpackage widget
 */
class ExtendedWidgetFormI18nSelectCountry extends sfWidgetFormSelect
{
  /**
   * Widget configuration
   *
   * Available options:
   *
   *  * culture:          The culture to use for internationalized strings (required)
   *  * countries:        An array of country codes to use (ISO 3166)
   *  * add_label_option: Adds a custom option at the top of the selector, which the value is empty
   *
   * @param array $options     An array of options
   * @param array $attributes  An array of default HTML attributes
   *
   * @see sfWidgetFormSelect
   */
  protected function configure($options = array(), $attributes = array())
  {
    parent::configure($options, $attributes);

    $this->addRequiredOption('culture');
    $this->addOption('countries');
    $this->addOption('add_label_option');

    // populate choices with all countries
    $culture = isset($options['culture']) ? $options['culture'] : 'en';

    $cultureInfo = new sfCultureInfo($culture);
    $countries = $cultureInfo->getCountries();

    // restrict countries to a sub-set
    if (isset($options['countries']))
    {
      if ($problems = array_diff($options['countries'], array_keys($countries)))
      {
        throw new InvalidArgumentException(sprintf('The following countries do not exist: %s.', implode(', ', $problems)));
      }

      $countries = array_intersect_key($countries, array_flip($options['countries']));
    }

    asort($countries);
    
    if (isset($options['add_label_option']))
    {
      $countries = array('' => $options['add_label_option']) + $countries;
    }

    $this->setOption('choices', $countries);
  }
}