Changeset 1698

Timestamp:

02/13/07 05:36:57 (2 years ago)

Author:

david

Message:

new features and changed methods for translation manager and locales, closes #426

Location:

branches/0.11

Files:

• samples/app/lib/routing/AgaviSampleAppLanguageRoutingCallback.class.php (modified) (1 diff)
• src/translation/AgaviLocale.class.php (modified) (2 diffs)
• src/translation/AgaviTranslationManager.class.php (modified) (15 diffs)
• src/validator/AgaviDateTimeValidator.class.php (modified) (2 diffs)
• src/validator/AgaviNumberValidator.class.php (modified) (1 diff)
• tests2/date/CalendarTest.php (modified) (2 diffs)
• tests2/date/TimeZoneTest.php (modified) (2 diffs)

branches/0.11/samples/app/lib/routing/AgaviSampleAppLanguageRoutingCallback.class.php

@@ -21 +21 @@
     // first, let's check if the locale is allowed
     try {
-      $set = $this->context->getTranslationManager()->getClosestMatchingLocale($parameters['locale']);
+      $set = $this->context->getTranslationManager()->getLocaleIdentifier($parameters['locale']);
       $found = true;
     } catch(AgaviException $e) {

branches/0.11/src/translation/AgaviLocale.class.php

@@ -28 +28 @@
  * @version    $Id$
  */
-class AgaviLocale
+class AgaviLocale extends AgaviParameterHolder
 {
   /**
@@ -50 +50 @@
    *
    * @param      AgaviContext The current application context.
+   * @param      array        An associative array of initialization parameters.
    * @param      string       The identifier of the locale
-   * @param      array        An associative array of initialization parameters.
+   * @param      array        The locale data.
    *
    * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @author     David Zuelke <dz@bitxtender.com>
    * @since      0.11.0
    */
-  public function initialize(AgaviContext $context, $identifier, array $data = array())
+  public function initialize(AgaviContext $context, array $parameters = array(), $identifier, array $data = array())
   {
     $this->context = $context;
+    $this->parameters = $parameters;
+    
     $this->identifier = $identifier;
     $this->data = $data;

branches/0.11/src/translation/AgaviTranslationManager.class.php

@@ -62 +62 @@
 
   /**
-   * @var        string The current locale.
+   * @var        string The default locale identifier.
    */
   protected $defaultLocaleIdentifier = null;
@@ -81 +81 @@
    */
   protected $availableLocales = array();
+
+  /**
+   * @var        array A cache for locale instances.
+   */
+  protected $localeCache = array();
 
   /**
@@ -166 +171 @@
   public function setLocale($identifier)
   {
-    $this->currentLocaleIdentifier = $this->getClosestMatchingLocale($identifier);
+    $this->currentLocaleIdentifier = $this->getLocaleIdentifier($identifier);
     $givenData = AgaviLocale::parseLocaleIdentifier($identifier);
     $actualData = AgaviLocale::parseLocaleIdentifier($this->currentLocaleIdentifier);
@@ -203 +208 @@
 
   /**
+   * Retrieve the default locale.
+   *
+   * @return     AgaviLocale The current default.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getDefaultLocale()
+  {
+    $this->getLocale($this->defaultLocale);
+  }
+
+  /**
+   * Retrieve the default locale identifier.
+   *
+   * @return     string The default locale identifier.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getDefaultLocaleIdentifier()
+  {
+    return $this->defaultLocaleIdentifier;
+  }
+
+  /**
    * Sets the default domain.
    *
@@ -250 +281 @@
       $this->loadCurrentLocale();
     } elseif(is_string($locale)) {
-      $locale = $this->getLocaleFromIdentifier($locale);
+      $locale = $this->getLocale($locale);
     }
     
@@ -285 +316 @@
       $this->loadCurrentLocale();
     } elseif(is_string($locale)) {
-      $locale = $this->getLocaleFromIdentifier($locale);
+      $locale = $this->getLocale($locale);
     }
     
@@ -320 +351 @@
       $this->loadCurrentLocale();
     } elseif(is_string($locale)) {
-      $locale = $this->getLocaleFromIdentifier($locale);
+      $locale = $this->getLocale($locale);
     }
     
@@ -358 +389 @@
       $this->loadCurrentLocale();
     } elseif(is_string($locale)) {
-      $locale = $this->getLocaleFromIdentifier($locale);
+      $locale = $this->getLocale($locale);
     }
     
@@ -475 +506 @@
   {
     if(!$this->currentLocale || $this->currentLocale->getIdentifier() != $this->givenLocaleIdentifier) {
-      $this->currentLocale = $this->getLocaleFromIdentifier($this->givenLocaleIdentifier);
+      $this->currentLocale = $this->getLocale($this->givenLocaleIdentifier);
       foreach($this->translators as $translatorList) {
         foreach($translatorList as $translator) {
@@ -507 +538 @@
 
   /**
+   * @see        AgaviTranslationManager::getLocaleIdentifier
+   *
+   * @deprecated
+   */
+  public function getClosestMatchingLocale($identifier)
+  {
+    return $this->getLocaleIdentifier($identifier);
+  }
+  
+  /**
    * Returns the identifier of the available locale which matches the given 
    * locale identifier most.
    *
-   * @param      string The locale identifier
-   *
-   * @return     string The locale identifier of the available locale.
-   *
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function getClosestMatchingLocale($identifier)
-  {
-
+   * @param      string A locale identifier
+   *
+   * @return     string The actual locale identifier of the available locale.
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getLocaleIdentifier($identifier)
+  {
     // if a locale with the given identifier doesn't exist try to find the closest
     // match or bail out on no match or an ambigious match
@@ -566 +607 @@
 
   /**
+   * @see        AgaviTranslationManager::getLocale
+   *
+   * @deprecated
+   */
+  public function getLocaleFromIdentifier($identifier)
+  {
+    return $this->getLocale($identifier);
+  }
+  
+  /**
    * Returns a new AgaviLocale object from the given identifier.
    *
    * @param      string The locale identifier
+   * @param      bool   Force a new instance even if an identical one exists.
    *
    * @return     AgaviLocale The locale instance which matches the available
@@ -574 +626 @@
    *
    * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function getLocaleFromIdentifier($identifier)
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getLocale($identifier, $forceNew = false)
   {
     // enable shortcut notation to only set options to the current locale
@@ -589 +642 @@
     }
     // this doesn't care about the options
-    $availableLocale = $this->availableLocales[$this->getClosestMatchingLocale($identifier)];
+    $availableLocale = $this->availableLocales[$this->getLocaleIdentifier($identifier)];
+
+    // if the user wants all options reset he supplies an 'empty' option set (identifier ends with @)
+    if(substr($identifier, -1) == '@') {
+      $idData['options'] = array();
+    } else {
+      $idData['options'] = array_merge($availableLocale['identifierData']['options'], $idData['options']);
+    }
+
+    if(($atPos = strpos($identifier, '@')) !== false) {
+      $identifier = $availableLocale['identifierData']['locale_str'] . substr($identifier, $atPos);
+    } else {
+      $identifier = $availableLocale['identifier'];
+    }
+
+    if(!$forceNew && isset($this->localeCache[$identifier])) {
+      return $this->localeCache[$identifier];
+    }
 
     if(!isset($this->localeDataCache[$idData['locale_str']])) {
@@ -616 +686 @@
       }
 
-      $this->localeDataCache[$idData['locale_str']] = array_merge_recursive($data, $availableLocale['parameters']);
+      $this->localeDataCache[$idData['locale_str']] = $data;
     }
 
     $data = $this->localeDataCache[$idData['locale_str']];
-
-    // if the user wants all options reset he supplies an 'empty' option set (identifier ends with @)
-    if(substr($identifier, -1) == '@') {
-      $idData['options'] = array();
-    } else {
-      $idData['options'] = array_merge($availableLocale['identifierData']['options'], $idData['options']);
-    }
 
     if(isset($idData['options']['calendar'])) {
@@ -640 +703 @@
     }
 
-    if(($atPos = strpos($identifier, '@')) !== false) {
-      $identifier = $availableLocale['identifierData']['locale_str'] . substr($identifier, $atPos);
-    } else {
-      $identifier = $availableLocale['identifier'];
-    }
-
     $locale = new AgaviLocale();
-    $locale->initialize($this->context, $identifier, $data);
+    $locale->initialize($this->context, $availableLocale['parameters'], $identifier, $data);
+
+    if(!$forceNew) {
+      $this->localeCache[$identifier] = $locale;
+    }
 
     return $locale;

branches/0.11/src/validator/AgaviDateTimeValidator.class.php

@@ -93 +93 @@
 
     $check = $this->getParameter('check', true);
-    $locale = $this->hasParameter('locale') ? $tm->getLocaleFromIdentifier($this->getParameter('locale')) : $tm->getCurrentLocale();
+    $locale = $this->hasParameter('locale') ? $tm->getLocale($this->getParameter('locale')) : $tm->getCurrentLocale();
 
     if($this->hasMultipleArguments() && !$this->getParameter('arguments_format')) {
@@ -131 +131 @@
       $matchedFormat = false;
       foreach($this->getParameter('formats', array()) as $item) {
-        $itemLocale = empty($item['locale']) ? $locale : $tm->getLocaleFromIdentifier($item['locale']);
+        $itemLocale = empty($item['locale']) ? $locale : $tm->getLocale($item['locale']);
         $type = empty($item['type']) ? 'format' : $item['type'];
 

branches/0.11/src/validator/AgaviNumberValidator.class.php

@@ -55 +55 @@
     if(!$this->getParameter('no_locale', false)) {
       if($locale = $this->getParameter('in_locale')) {
-        $locale = $this->getContext()->getTranslationManager()->getLocaleFromIdentifier($locale);
+        $locale = $this->getContext()->getTranslationManager()->getLocale($locale);
       } else {
         $locale = $this->getContext()->getTranslationManager()->getCurrentLocale();

branches/0.11/tests2/date/CalendarTest.php

@@ -313 +313 @@
   {
   // TODO: check how to do this properly ...
-    $c = $this->tm->createCalendar($this->tm->getLocaleFromIdentifier('en_US'));
+    $c = $this->tm->createCalendar($this->tm->getLocale('en_US'));
     $c->setLenient(false);
     $c->clear();
@@ -727 +727 @@
      * to loop_addroll. - aliu */
     $times = 20;
-    $cal = $this->tm->createCalendar($this->tm->getLocaleFromIdentifier('de_DE'));
+    $cal = $this->tm->createCalendar($this->tm->getLocale('de_DE'));
     $sdf = new AgaviSimpleDateFormat("YYYY'-W'ww-ee", AgaviLocale::getGermany());
     $sdf->applyLocalizedPattern("JJJJ'-W'ww-ee");

branches/0.11/tests2/date/TimeZoneTest.php

@@ -815 +815 @@
   public function testDisplayName()
   {
-    $enLocale = $this->tm->getLocaleFromIdentifier('en_US');
+    $enLocale = $this->tm->getLocale('en_US');
 
     $i = 0;
@@ -863 +863 @@
     // Make sure we get the default display format for Locales
     // with no display name data.
-    $mt_MT = $this->tm->getLocaleFromIdentifier("mt_MT");
+    $mt_MT = $this->tm->getLocale("mt_MT");
 
     $name = $zone->getDisplayName($mt_MT);