Solar_Locale->getCode() generates non RFC1766 compliant output.

[umka.dk@…]

Just spent a day trying to integrate Solar_Locale functionality into a multi-lingual app and noticed that Solar_Locale->getCode() returns a language locale string a bit different to that defined by RFC1766. This makes it a bit awkward to use with XHTML's lang and xml:lang attributes as W3C expect a RFC1766 compliant value.

From what I could workout, Solar_Locale->getCode() returns a locale of the following format:

[language code as defined by ISO 639 alpha-2]_[country code as defined by ISO 3166 alpha-2]

while RFC1766 and thus XHTML expects:

[language code as defined by ISO 639 alpha-2]-[country code as defined by ISO 3166 alpha-2]

The only difference between the two string is the separator, one uses an "_" [underscore] while the other one uses a "-" [dash].

I realise that Solar_Locale->getCode() is probably used to determine the name of the file that contains all current locale strings so it is unlikely that the output of the function and thus the filenames will be changed to use a "-" [dash] instead of an "_" [underscore]. However it would be very handy if an assistive function getLanguageCode() which returns language code as defined by ISO 639 alpha-2 was added to Solar_Locale! This way getLanguageCode() combined with getCountryCode() could be used to build language locale string in the desired/any format.

Thanks,

Dmytro

PS: Also, as pointed out by PACE on IRC, as a result of the above behaviour Solar locale files are the only files in the entire framework where "_" [underscore] is used as part of the filename and not as a directory separator.

[umka.dk@…]

Possible solution to renaming locale files while still maintaining backwards compatibility with the old format:

In Solar_Locale:

  /**
   * 
   * Loads the translation array for a given class.
   * 
   * @param string $class The class name to load translations for.
   * 
   * @return void
   * 
   */
  protected function _load($class)
  {
      // build the file name.  note that we use the fixdir()
      // method, which automatically replaces '/' with the
      // correct directory separator.
      $base = str_replace('_', '/', $class);
      $stack = array(
          Solar_Dir::fix($base . '/Locale/') . $this->_code . '.php',
          Solar_Dir::fix($base . '/Locale/') 
              . strtr($this->_code, '-', '_') . '.php');
      
      // process locale stack
      foreach ((array) $stack as $file) {
          // can we find the file?
          $target = Solar_File::exists($file);
          if ($target) {
              // put the locale values into the shared locale array
              $this->trans[$class] = (array) Solar_File::load($target);
          } else {
              // could not find file.
              // fail silently, as it's often the case that the
              // translation file simply doesn't exist.
              $this->trans[$class] = array();
          }
      }
  }