Mistralys / application-localization

src/Localization.php

Indentation +227 added lines, -227 removed lines

@@ -63,11 +63,11 @@ 
     public const EVENT_CACHE_KEY_CHANGED = 'CacheKeyChanged';
 
     /**
-    * Collection of all locales by namespace (application, content, custom...). 
-    *
-    * @var array<string,array<string,Localization_Locale>>
-    * @see Localization::addLocale()
-    */
+     * Collection of all locales by namespace (application, content, custom...). 
+     *
+     * @var array<string,array<string,Localization_Locale>>
+     * @see Localization::addLocale()
+     */
     protected static $locales = array();
 
     /**
@@ -76,57 +76,57 @@ 
      */
     private static $initDone = false;
 
-   /**
-    * Path to the file in which the scanner results are stored.
-    * @var string
-    * @see Localization::configure()
-    */
+    /**
+     * Path to the file in which the scanner results are stored.
+     * @var string
+     * @see Localization::configure()
+     */
     protected static $storageFile = '';
     
-   /**
-    * Path to the folder into which the client libraries are written.
-    * @var string
-    * @see Localization::setClientLibrariesFolder()
-    */
+    /**
+     * Path to the folder into which the client libraries are written.
+     * @var string
+     * @see Localization::setClientLibrariesFolder()
+     */
     protected static $clientFolder = '';
     
-   /**
-    * If this key changes, client libraries are refreshed.
-    * @var string
-    * @see Localization::setClientLibrariesCacheKey()
-    */
+    /**
+     * If this key changes, client libraries are refreshed.
+     * @var string
+     * @see Localization::setClientLibrariesCacheKey()
+     */
     protected static $clientCacheKey = '';
     
-   /**
-    * Whether the configuration has been made.
-    * @var bool
-    * @see Localization::configure()
-    */
+    /**
+     * Whether the configuration has been made.
+     * @var bool
+     * @see Localization::configure()
+     */
     protected static $configured = false;
     
-   /**
-    * Stores event listener instances.
-    * @var array
-    */
+    /**
+     * Stores event listener instances.
+     * @var array
+     */
     protected static array $listeners = array();
     
-   /**
-    * @var integer
-    * @see Localization::addEventListener()
-    */
+    /**
+     * @var integer
+     * @see Localization::addEventListener()
+     */
     protected static $listenersCounter = 0;
     
-   /**
-    * @var Localization_Translator|NULL
-    */
+    /**
+     * @var Localization_Translator|NULL
+     */
     protected static $translator;
     
-   /**
-    * Initializes the localization layer. This is done
-    * automatically, and only once per request.
-    * 
-    * (Called at the end of this file)
-    */
+    /**
+     * Initializes the localization layer. This is done
+     * automatically, and only once per request.
+     * 
+     * (Called at the end of this file)
+     */
     public static function init() : void
     {
         if(self::$initDone) {
@@ -165,12 +165,12 @@ 
         return self::getLocalesByNS(self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Retrieves all locales in the specified namespace.
-    * 
-    * @param string $namespace
-    * @return Localization_Locale[]
-    */
+    /**
+     * Retrieves all locales in the specified namespace.
+     * 
+     * @param string $namespace
+     * @return Localization_Locale[]
+     */
     public static function getLocalesByNS(string $namespace)
     {
         if(isset(self::$locales[$namespace])) {
@@ -187,35 +187,35 @@ 
         );
     }
     
-   /**
-    * Adds an application locale to use in the application.
-    * 
-    * @param string $localeName
-    * @return Localization_Locale
-    */
+    /**
+     * Adds an application locale to use in the application.
+     * 
+     * @param string $localeName
+     * @return Localization_Locale
+     */
     public static function addAppLocale(string $localeName) : Localization_Locale
     {
         return self::addLocaleByNS($localeName, self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Adds a content locale to use for content in the application.
-    * 
-    * @param string $localeName
-    * @return Localization_Locale
-    */
+    /**
+     * Adds a content locale to use for content in the application.
+     * 
+     * @param string $localeName
+     * @return Localization_Locale
+     */
     public static function addContentLocale(string $localeName) : Localization_Locale
     {
         return self::addLocaleByNS($localeName, self::NAMESPACE_CONTENT);
     }
     
-   /**
-    * Adds a locale to the specified namespace.
-    * 
-    * @param string $localeName
-    * @param string $namespace
-    * @return Localization_Locale
-    */
+    /**
+     * Adds a locale to the specified namespace.
+     * 
+     * @param string $localeName
+     * @param string $namespace
+     * @return Localization_Locale
+     */
     public static function addLocaleByNS(string $localeName, string $namespace) : Localization_Locale
     {
         if(!isset(self::$locales[$namespace])) {
@@ -368,45 +368,45 @@ 
         return self::getSelectedLocaleByNS(self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Retrieves the name of the selected application locale.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the name of the selected application locale.
+     * 
+     * @return string
+     */
     public static function getAppLocaleName() : string
     {
         return self::getLocaleNameByNS(self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Retrieves the names of the available application locales.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of the available application locales.
+     * @return string[]
+     */
     public static function getAppLocaleNames() : array
     {
         return self::getLocaleNamesByNS(self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Retrieves the selected locale name in the specified namespace.
-    * 
-    * @param string $namespace
-    * @throws Localization_Exception
-    * @return string
-    */
+    /**
+     * Retrieves the selected locale name in the specified namespace.
+     * 
+     * @param string $namespace
+     * @throws Localization_Exception
+     * @return string
+     */
     public static function getLocaleNameByNS(string $namespace) : string
     {
         return self::getSelectedLocaleByNS($namespace)->getName();
     }
     
-   /**
-    * Retrieves the selected locale instance for the specified namespace.
-    * 
-    * @param string $namespace
-    * @return Localization_Locale
-    * @throws Localization_Exception
-    * @see Localization::ERROR_NO_LOCALE_SELECTED_IN_NS
-    */
+    /**
+     * Retrieves the selected locale instance for the specified namespace.
+     * 
+     * @param string $namespace
+     * @return Localization_Locale
+     * @throws Localization_Exception
+     * @see Localization::ERROR_NO_LOCALE_SELECTED_IN_NS
+     */
     public static function getSelectedLocaleByNS(string $namespace) : Localization_Locale
     {
         self::requireNamespace($namespace);
@@ -425,24 +425,24 @@ 
         );
     }
     
-   /**
-    * Stores the selected locale names by namespace.
-    * @var array<string,Localization_Locale>
-    */
+    /**
+     * Stores the selected locale names by namespace.
+     * @var array<string,Localization_Locale>
+     */
     protected static $selected = array();
 
-   /**
-    * Selects the active locale for the specified namespace.
-    *
-    * NOTE: Triggers the "LocaleChanged" event.
-    * 
-    * @param string $localeName
-    * @param string $namespace
-    * @return Localization_Locale
-    * @throws Localization_Exception
-    *
-    * @see LocaleChanged
-    */
+    /**
+     * Selects the active locale for the specified namespace.
+     *
+     * NOTE: Triggers the "LocaleChanged" event.
+     * 
+     * @param string $localeName
+     * @param string $namespace
+     * @return Localization_Locale
+     * @throws Localization_Exception
+     *
+     * @see LocaleChanged
+     */
     public static function selectLocaleByNS(string $localeName, string $namespace) : Localization_Locale
     {
         self::requireNamespace($namespace);
@@ -594,15 +594,15 @@ 
         return self::selectLocaleByNS($localeName, self::NAMESPACE_APPLICATION);
     }
 
-   /**
-    * Retrieves an application locale by its name. 
-    * Note that the locale must have been added first.
-    * 
-    * @param string $localeName
-    * @throws Localization_Exception
-    * @return Localization_Locale
-    * @see Localization::appLocaleExists()
-    */
+    /**
+     * Retrieves an application locale by its name. 
+     * Note that the locale must have been added first.
+     * 
+     * @param string $localeName
+     * @throws Localization_Exception
+     * @return Localization_Locale
+     * @see Localization::appLocaleExists()
+     */
     public static function getAppLocaleByName(string $localeName) : Localization_Locale
     {
         return self::getLocaleByNameNS($localeName, self::NAMESPACE_APPLICATION);
@@ -637,10 +637,10 @@ 
         return self::getLocalesByNS(self::NAMESPACE_CONTENT);
     }
     
-   /**
-    * Retrieves the names of all content locales that have been added.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all content locales that have been added.
+     * @return string[]
+     */
     public static function getContentLocaleNames()
     {
         return self::getLocaleNamesByNS(self::NAMESPACE_CONTENT);
@@ -663,7 +663,7 @@ 
         sort($names);
         
         return $names;
-     }
+        }
     
     /**
      * Checks by the locale name if the specified locale is
@@ -692,14 +692,14 @@ 
         return self::getLocaleByNameNS($localeName, self::NAMESPACE_CONTENT);
     }
     
-   /**
-    * Retrieves a locale by its name in the specified namespace.
-    * 
-    * @param string $localeName
-    * @param string $namespace
-    * @throws Localization_Exception
-    * @return Localization_Locale
-    */
+    /**
+     * Retrieves a locale by its name in the specified namespace.
+     * 
+     * @param string $localeName
+     * @param string $namespace
+     * @throws Localization_Exception
+     * @return Localization_Locale
+     */
     public static function getLocaleByNameNS(string $localeName, string $namespace) : Localization_Locale
     {
         self::requireNamespace($namespace);
@@ -770,10 +770,10 @@ 
         return self::selectLocaleByNS($localeName, self::NAMESPACE_CONTENT);
     }
     
-   /**
-    * Checks whether the localization has been configured entirely.
-    * @return bool
-    */
+    /**
+     * Checks whether the localization has been configured entirely.
+     * @return bool
+     */
     public static function isConfigured() : bool
     {
         return self::$configured;
@@ -845,29 +845,29 @@ 
         );
     }
     
-   /**
-    * Injects a content locales selector element into the specified
-    * HTML QuickForm2 container.
-    * 
-    * @param string $elementName
-    * @param HTML_QuickForm2_Container $container
-    * @param string $label
-    * @return HTML_QuickForm2_Element_Select
-    */
+    /**
+     * Injects a content locales selector element into the specified
+     * HTML QuickForm2 container.
+     * 
+     * @param string $elementName
+     * @param HTML_QuickForm2_Container $container
+     * @param string $label
+     * @return HTML_QuickForm2_Element_Select
+     */
     public static function injectContentLocalesSelector(string $elementName, HTML_QuickForm2_Container $container, string $label='') : HTML_QuickForm2_Element_Select
     {
         return self::injectLocalesSelectorNS($elementName, self::NAMESPACE_CONTENT, $container, $label);
     }
     
-   /**
-    * Injects an app locales selector element into the specified
+    /**
+     * Injects an app locales selector element into the specified
      * HTML QuickForm2 container.
      * 
-    * @param string $elementName
-    * @param HTML_QuickForm2_Container $container
-    * @param string $label
-    * @return HTML_QuickForm2_Element_Select
-    */
+     * @param string $elementName
+     * @param HTML_QuickForm2_Container $container
+     * @param string $label
+     * @return HTML_QuickForm2_Element_Select
+     */
     public static function injectAppLocalesSelector(string $elementName, HTML_QuickForm2_Container $container, string $label='') : HTML_QuickForm2_Element_Select
     {
         return self::injectLocalesSelectorNS($elementName, self::NAMESPACE_APPLICATION, $container, $label);
@@ -903,26 +903,26 @@ 
         return $select;
     }
 
-   /**
-    * @var Localization_Source[]
-    */
+    /**
+     * @var Localization_Source[]
+     */
     protected static $sources = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $excludeFolders = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $excludeFiles = array();
     
-   /**
-    * Retrieves all currently available sources.
-    * 
-    * @return Localization_Source[]
-    */
+    /**
+     * Retrieves all currently available sources.
+     * 
+     * @return Localization_Source[]
+     */
     public static function getSources() : array
     {
         return self::$sources;
@@ -954,10 +954,10 @@ 
         return $source;
     }
     
-   /**
-    * Retrieves all sources grouped by their group name.
-    * @return array
-    */
+    /**
+     * Retrieves all sources grouped by their group name.
+     * @return array
+     */
     public static function getSourcesGrouped()
     {
         $sources = self::getSources();
@@ -978,11 +978,11 @@ 
         return $grouped;
     }
     
-   /**
-    * Checks whether a specific source exists by its ID.
-    * @param string $sourceID
-    * @return boolean
-    */
+    /**
+     * Checks whether a specific source exists by its ID.
+     * @param string $sourceID
+     * @return boolean
+     */
     public static function sourceExists(string $sourceID) : bool
     {
         $sources = self::getSources();
@@ -995,11 +995,11 @@ 
         return false;
     }
     
-   /**
-    * Checks whether a specific source exists by its alias.
-    * @param string $sourceAlias
-    * @return boolean
-    */
+    /**
+     * Checks whether a specific source exists by its alias.
+     * @param string $sourceAlias
+     * @return boolean
+     */
     public static function sourceAliasExists(string $sourceAlias) : bool
     {
         $sources = self::getSources();
@@ -1012,13 +1012,13 @@ 
         return false;
     }
 
-   /**
-    * Retrieves a localization source by its ID.
-    * 
-    * @param string $sourceID
-    * @throws Localization_Exception
-    * @return Localization_Source
-    */
+    /**
+     * Retrieves a localization source by its ID.
+     * 
+     * @param string $sourceID
+     * @throws Localization_Exception
+     * @return Localization_Source
+     */
     public static function getSourceByID(string $sourceID) : Localization_Source
     {
         $sources = self::getSources();
@@ -1108,17 +1108,17 @@ 
         }
     }
     
-   /**
-    * Sets a key that is used to verify whether the client
-    * libraries have to be refreshed. A common use is to set
-    * this to the application's version number to guarantee
-    * new texts are automatically used with each release.
-    * 
-    * NOTE: Otherwise files are refreshed only when saving 
-    * them in the editor UI.
-    *  
-    * @param string $key
-    */
+    /**
+     * Sets a key that is used to verify whether the client
+     * libraries have to be refreshed. A common use is to set
+     * this to the application's version number to guarantee
+     * new texts are automatically used with each release.
+     * 
+     * NOTE: Otherwise files are refreshed only when saving 
+     * them in the editor UI.
+     *  
+     * @param string $key
+     */
     public static function setClientLibrariesCacheKey(string $key) : void
     {
         if($key !== self::$clientCacheKey) {
@@ -1132,10 +1132,10 @@ 
         return self::$clientCacheKey;
     }
     
-   /**
-    * Sets the folder where client libraries are to be stored.
-    * @param string $folder
-    */
+    /**
+     * Sets the folder where client libraries are to be stored.
+     * @param string $folder
+     */
     public static function setClientLibrariesFolder(string $folder) : void
     {
         if($folder !== self::$clientFolder) {
@@ -1144,14 +1144,14 @@ 
         }
     }
     
-   /**
-    * Retrieves the path to the folder in which the client
-    * libraries should be stored.
-    * 
-    * NOTE: Can return an empty string, when this is disabled.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the path to the folder in which the client
+     * libraries should be stored.
+     * 
+     * NOTE: Can return an empty string, when this is disabled.
+     * 
+     * @return string
+     */
     public static function getClientLibrariesFolder() : string
     {
         return self::$clientFolder;
@@ -1173,13 +1173,13 @@ 
 
     private static ?Localization_ClientGenerator $generator = null;
 
-   /**
-    * Creates a new instance of the client generator class
-    * that is used to write the localization files into the
-    * target folder on disk.
-    * 
-    * @return Localization_ClientGenerator
-    */
+    /**
+     * Creates a new instance of the client generator class
+     * that is used to write the localization files into the
+     * target folder on disk.
+     * 
+     * @return Localization_ClientGenerator
+     */
     public static function createGenerator() : Localization_ClientGenerator
     {
         if(!isset(self::$generator)) {
@@ -1248,10 +1248,10 @@ 
         return new Localization_Editor();
     }
     
-   /**
-    * Retrieves a list of all available source IDs.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all available source IDs.
+     * @return string[]
+     */
     public static function getSourceIDs() : array
     {
         $ids = array();
@@ -1278,9 +1278,9 @@ 
         return $aliases;
     }
     
-   /**
-    * Resets all locales to the built-in locale.
-    */
+    /**
+     * Resets all locales to the built-in locale.
+     */
     public static function reset() : void
     {
         self::$locales = array();
@@ -1316,12 +1316,12 @@ 
         return self::$supportedLocales;
     }
     
-   /**
-    * Checks whether the specified locale is supported.
-    * 
-    * @param string $localeName
-    * @return bool
-    */
+    /**
+     * Checks whether the specified locale is supported.
+     * 
+     * @param string $localeName
+     * @return bool
+     */
     public static function isLocaleSupported(string $localeName) : bool
     {
         return file_exists(__DIR__.'/Localization/Locale/'.$localeName.'.php');

Spacing +54 added lines, -54 removed lines

@@ -129,7 +129,7 @@ 
     */
     public static function init() : void
     {
-        if(self::$initDone) {
+        if (self::$initDone) {
             return;
         }
 
@@ -173,7 +173,7 @@ 
     */
     public static function getLocalesByNS(string $namespace)
     {
-        if(isset(self::$locales[$namespace])) {
+        if (isset(self::$locales[$namespace])) {
             return array_values(self::$locales[$namespace]);
         }
         
@@ -218,11 +218,11 @@ 
     */
     public static function addLocaleByNS(string $localeName, string $namespace) : Localization_Locale
     {
-        if(!isset(self::$locales[$namespace])) {
+        if (!isset(self::$locales[$namespace])) {
             self::$locales[$namespace] = array();
         }
         
-        if(!isset(self::$locales[$namespace][$localeName])) 
+        if (!isset(self::$locales[$namespace][$localeName])) 
         {
             self::$locales[$namespace][$localeName] = self::createLocale($localeName);
             
@@ -281,7 +281,7 @@ 
      */
     public static function createCountries() : CountryCollection
     {
-        if(!isset(self::$countries)) {
+        if (!isset(self::$countries)) {
             self::$countries = CountryCollection::getInstance();
         }
 
@@ -298,7 +298,7 @@ 
      */
     public static function createCurrencies() : CurrencyCollection
     {
-        if(!isset(self::$currencies)) {
+        if (!isset(self::$currencies)) {
             self::$currencies = CurrencyCollection::getInstance();
         }
 
@@ -411,7 +411,7 @@ 
     {
         self::requireNamespace($namespace);
         
-        if(isset(self::$selected[$namespace])) {
+        if (isset(self::$selected[$namespace])) {
             return self::$selected[$namespace];
         }
         
@@ -450,9 +450,9 @@ 
         $locale = self::addLocaleByNS($localeName, $namespace);
         $previous = null;
         
-        if(isset(self::$selected[$namespace])) 
+        if (isset(self::$selected[$namespace])) 
         {
-            if(self::$selected[$namespace]->getName() === $localeName) {
+            if (self::$selected[$namespace]->getName() === $localeName) {
                 return $locale;
             }
             
@@ -492,11 +492,11 @@ 
             new $class($argsList)
         );
         
-        if(!isset(self::$listeners[$name])) {
+        if (!isset(self::$listeners[$name])) {
             return $event;
         }
         
-        foreach(self::$listeners[$name] as $listener) 
+        foreach (self::$listeners[$name] as $listener) 
         {
             $callArgs = $listener['args'];
             array_unshift($callArgs, $event);
@@ -518,9 +518,9 @@ 
      * @throws Localization_Exception
      * @see Localization::ERROR_UNKNOWN_EVENT_NAME
      */
-    public static function addEventListener(string $eventName, $callback, array $args=array()) : int
+    public static function addEventListener(string $eventName, $callback, array $args = array()) : int
     {
-        if(!isset(self::$listeners[$eventName])) {
+        if (!isset(self::$listeners[$eventName])) {
             self::$listeners[$eventName] = array();
         }
         
@@ -543,7 +543,7 @@ 
             'AppLocalize'
         );
 
-        if(class_exists($className)) {
+        if (class_exists($className)) {
             return $className;
         }
 
@@ -567,17 +567,17 @@ 
      * @throws Localization_Exception
      * @see LocaleChanged
      */
-    public static function onLocaleChanged($callback, array $args=array()) : int
+    public static function onLocaleChanged($callback, array $args = array()) : int
     {
         return self::addEventListener(self::EVENT_LOCALE_CHANGED, $callback, $args);
     }
 
-    public static function onClientFolderChanged(callable $callback, array $args=array()) : int
+    public static function onClientFolderChanged(callable $callback, array $args = array()) : int
     {
         return self::addEventListener(self::EVENT_CLIENT_FOLDER_CHANGED, $callback, $args);
     }
 
-    public static function onCacheKeyChanged(callable $callback, array $args=array()) : int
+    public static function onCacheKeyChanged(callable $callback, array $args = array()) : int
     {
         return self::addEventListener(self::EVENT_CACHE_KEY_CHANGED, $callback, $args);
     }
@@ -704,7 +704,7 @@ 
     {
         self::requireNamespace($namespace);
         
-        if(isset(self::$locales[$namespace]) && isset(self::$locales[$namespace][$localeName])) {
+        if (isset(self::$locales[$namespace]) && isset(self::$locales[$namespace][$localeName])) {
             return self::$locales[$namespace][$localeName];
         }
         
@@ -783,9 +783,9 @@ 
      * @param Localization_Locale|null $locale
      * @return Localization_Translator
      */
-    public static function getTranslator(?Localization_Locale $locale=null) : Localization_Translator
+    public static function getTranslator(?Localization_Locale $locale = null) : Localization_Translator
     {
-        if($locale !== null)
+        if ($locale !== null)
         {
             $obj = new Localization_Translator();
             $obj->addSources(self::getSources());
@@ -793,7 +793,7 @@ 
             return $obj;
         }
             
-        if(!isset(self::$translator)) 
+        if (!isset(self::$translator)) 
         {
             $obj = new Localization_Translator();
             $obj->addSources(self::getSources());
@@ -818,7 +818,7 @@ 
     {
         self::requireNamespace($namespace);
         
-        if(isset(self::$locales[$namespace])) {
+        if (isset(self::$locales[$namespace])) {
             return count(self::$locales[$namespace]);
         }
         
@@ -831,7 +831,7 @@ 
      */
     protected static function requireNamespace(string $namespace) : void
     {
-        if(isset(self::$locales[$namespace])) {
+        if (isset(self::$locales[$namespace])) {
             return;
         }
         
@@ -854,7 +854,7 @@ 
     * @param string $label
     * @return HTML_QuickForm2_Element_Select
     */
-    public static function injectContentLocalesSelector(string $elementName, HTML_QuickForm2_Container $container, string $label='') : HTML_QuickForm2_Element_Select
+    public static function injectContentLocalesSelector(string $elementName, HTML_QuickForm2_Container $container, string $label = '') : HTML_QuickForm2_Element_Select
     {
         return self::injectLocalesSelectorNS($elementName, self::NAMESPACE_CONTENT, $container, $label);
     }
@@ -868,7 +868,7 @@ 
     * @param string $label
     * @return HTML_QuickForm2_Element_Select
     */
-    public static function injectAppLocalesSelector(string $elementName, HTML_QuickForm2_Container $container, string $label='') : HTML_QuickForm2_Element_Select
+    public static function injectAppLocalesSelector(string $elementName, HTML_QuickForm2_Container $container, string $label = '') : HTML_QuickForm2_Element_Select
     {
         return self::injectLocalesSelectorNS($elementName, self::NAMESPACE_APPLICATION, $container, $label);
     }
@@ -885,9 +885,9 @@ 
      * @return HTML_QuickForm2_Element_Select
      * @throws Localization_Exception
      */
-    public static function injectLocalesSelectorNS(string $elementName, string $namespace, HTML_QuickForm2_Container $container, string $label='') : HTML_QuickForm2_Element_Select
+    public static function injectLocalesSelectorNS(string $elementName, string $namespace, HTML_QuickForm2_Container $container, string $label = '') : HTML_QuickForm2_Element_Select
     {
-        if(empty($label)) {
+        if (empty($label)) {
             $label = t('Language');
         }
 
@@ -896,7 +896,7 @@ 
 
         $locales = self::getLocalesByNS($namespace);
         
-        foreach($locales as $locale) {
+        foreach ($locales as $locale) {
             $select->addOption($locale->getLabel(), $locale->getName());
         }
 
@@ -930,14 +930,14 @@ 
     
     public static function addExcludeFolder(string $folderName) : void
     { 
-        if(!in_array($folderName, self::$excludeFolders)) {
+        if (!in_array($folderName, self::$excludeFolders)) {
             self::$excludeFolders[] = $folderName;
         }
     }
     
     public static function addExcludeFile(string $fileName) : void
     {
-        if(!in_array($fileName, self::$excludeFiles)) {
+        if (!in_array($fileName, self::$excludeFiles)) {
             self::$excludeFiles[] = $fileName;
         }
     }
@@ -964,11 +964,11 @@ 
         
         $grouped = array();
         
-        foreach($sources as $source) 
+        foreach ($sources as $source) 
         {
             $group = $source->getGroup();
             
-            if(!isset($grouped[$group])) {
+            if (!isset($grouped[$group])) {
                 $grouped[$group] = array();
             }
             
@@ -986,8 +986,8 @@ 
     public static function sourceExists(string $sourceID) : bool
     {
         $sources = self::getSources();
-        foreach($sources as $source) {
-            if($source->getID() == $sourceID) {
+        foreach ($sources as $source) {
+            if ($source->getID() == $sourceID) {
                 return true;
             }
         }
@@ -1003,8 +1003,8 @@ 
     public static function sourceAliasExists(string $sourceAlias) : bool
     {
         $sources = self::getSources();
-        foreach($sources as $source) {
-            if($source->getAlias() == $sourceAlias) {
+        foreach ($sources as $source) {
+            if ($source->getAlias() == $sourceAlias) {
                 return true;
             }
         }
@@ -1022,8 +1022,8 @@ 
     public static function getSourceByID(string $sourceID) : Localization_Source
     {
         $sources = self::getSources();
-        foreach($sources as $source) {
-            if($source->getID() == $sourceID) {
+        foreach ($sources as $source) {
+            if ($source->getID() == $sourceID) {
                 return $source;
             }
         }
@@ -1048,8 +1048,8 @@ 
     public static function getSourceByAlias(string $sourceAlias) : Localization_Source
     {
         $sources = self::getSources();
-        foreach($sources as $source) {
-            if($source->getAlias() == $sourceAlias) {
+        foreach ($sources as $source) {
+            if ($source->getAlias() == $sourceAlias) {
                 return $source;
             }
         }
@@ -1093,7 +1093,7 @@ 
      * @throws FileHelper_Exception
      * @throws Localization_Exception
      */
-    public static function configure(string $storageFile, string $clientLibrariesFolder='') : void
+    public static function configure(string $storageFile, string $clientLibrariesFolder = '') : void
     {
         self::$configured = true;
         
@@ -1102,7 +1102,7 @@ 
 
         // only write the client libraries to disk if the folder
         // has been specified.
-        if(!empty($clientLibrariesFolder)) 
+        if (!empty($clientLibrariesFolder)) 
         {
             self::writeClientFiles();
         }
@@ -1121,7 +1121,7 @@ 
     */
     public static function setClientLibrariesCacheKey(string $key) : void
     {
-        if($key !== self::$clientCacheKey) {
+        if ($key !== self::$clientCacheKey) {
             self::$clientCacheKey = $key;
             self::triggerEvent(self::EVENT_CACHE_KEY_CHANGED, array($key));
         }
@@ -1138,7 +1138,7 @@ 
     */
     public static function setClientLibrariesFolder(string $folder) : void
     {
-        if($folder !== self::$clientFolder) {
+        if ($folder !== self::$clientFolder) {
             self::$clientFolder = $folder;
             self::triggerEvent(self::EVENT_CLIENT_FOLDER_CHANGED, array($folder));
         }
@@ -1166,7 +1166,7 @@ 
      * @throws Localization_Exception|FileHelper_Exception
      * @see Localization_ClientGenerator
      */
-    public static function writeClientFiles(bool $force=false) : void
+    public static function writeClientFiles(bool $force = false) : void
     {
         self::createGenerator()->writeFiles();
     }
@@ -1182,7 +1182,7 @@ 
     */
     public static function createGenerator() : Localization_ClientGenerator
     {
-        if(!isset(self::$generator)) {
+        if (!isset(self::$generator)) {
             self::$generator = new Localization_ClientGenerator();
         }
 
@@ -1205,7 +1205,7 @@ 
      */
     protected static function requireConfiguration() : void
     {
-        if(!self::$configured) 
+        if (!self::$configured) 
         {
             throw new Localization_Exception(
                 'The localization configuration is incomplete.',
@@ -1214,7 +1214,7 @@ 
             );
         }
 
-        if(empty(self::$storageFile))
+        if (empty(self::$storageFile))
         {
             throw new Localization_Exception(
                 'No localization storage file set',
@@ -1223,7 +1223,7 @@ 
             );
         }
         
-        if(empty(self::$sources)) 
+        if (empty(self::$sources)) 
         {
             throw new Localization_Exception(
                 'No source folders have been defined.',
@@ -1256,7 +1256,7 @@ 
     {
         $ids = array();
         
-        foreach(self::$sources as $source) {
+        foreach (self::$sources as $source) {
             $ids[] = $source->getID();
         }
         
@@ -1271,7 +1271,7 @@ 
     {
         $aliases = array();
         
-        foreach(self::$sources as $source) {
+        foreach (self::$sources as $source) {
             $aliases[] = $source->getAlias();
         }
         
@@ -1307,7 +1307,7 @@ 
      */
     public static function getSupportedLocaleNames() : array
     {
-        if(empty(self::$supportedLocales))
+        if (empty(self::$supportedLocales))
         {
             self::$supportedLocales = FileHelper::createFileFinder(__DIR__.'/Localization/Locale')
                 ->getPHPClassNames();
@@ -1331,13 +1331,13 @@ 
 
     public static function getVersion() : string
     {
-        if(isset(self::$version)) {
+        if (isset(self::$version)) {
             return self::$version;
         }
 
         $versionFile = FileInfo::factory(__DIR__.'/../version.txt');
 
-        if($versionFile->exists()) {
+        if ($versionFile->exists()) {
             self::$version = $versionFile->getContents();
             return self::$version;
         }

src/Localization/Event/LocaleChanged.php

Indentation +15 added lines, -15 removed lines

@@ -30,9 +30,9 @@ 
     public const ERROR_NO_CURRENT_LOCALE_SPECIFIED = 91401;
 
     /**
-    * The locale that was used before the change, if any.
-    * @return Localization_Locale|NULL
-    */
+     * The locale that was used before the change, if any.
+     * @return Localization_Locale|NULL
+     */
     public function getPrevious() : ?Localization_Locale
     {
         $arg = $this->getArgument(1);
@@ -64,28 +64,28 @@ 
         );
     }
     
-   /**
-    * The namespace in which the locale change occurred.
-    * @return string
-    */
+    /**
+     * The namespace in which the locale change occurred.
+     * @return string
+     */
     public function getNamespace() : string
     {
         return strval($this->getArgument(0));
     }
 
-   /**
-    * Whether the change occurred for an application locale.
-    * @return bool
-    */
+    /**
+     * Whether the change occurred for an application locale.
+     * @return bool
+     */
     public function isAppLocale() : bool
     {
         return $this->getNamespace() === Localization::NAMESPACE_APPLICATION;
     }
     
-   /**
-    * Whether the change occurred for a content locale.
-    * @return bool
-    */
+    /**
+     * Whether the change occurred for a content locale.
+     * @return bool
+     */
     public function isContentLocale() : bool
     {
         return $this->getNamespace() === Localization::NAMESPACE_CONTENT;

src/Localization/Generator.php

Indentation +13 added lines, -13 removed lines

@@ -143,14 +143,14 @@ 
         $this->writeCacheKey();
     }
     
-   /**
-    * Retrieves a list of all localization client 
-    * files that are written to disk. This includes
-    * the locale files and the libraries required
-    * to make it work clientside.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all localization client 
+     * files that are written to disk. This includes
+     * the locale files and the libraries required
+     * to make it work clientside.
+     * 
+     * @return string[]
+     */
     public function getFilesList() : array
     {
         $files = array();
@@ -328,11 +328,11 @@ 
         return self::$systemKey;
     }
 
-   /**
-    * Generates the cache key file, which is used to determine
-    * automatically whether the client libraries need to be 
-    * refreshed.
-    */
+    /**
+     * Generates the cache key file, which is used to determine
+     * automatically whether the client libraries need to be 
+     * refreshed.
+     */
     protected function writeCacheKey() : void
     {
         $this->cacheKey = self::getSystemKey();

Spacing +23 added lines, -23 removed lines

@@ -24,15 +24,15 @@ 
     {
         $this->translator = Localization::getTranslator();
 
-        Localization::onLocaleChanged(function () {
+        Localization::onLocaleChanged(function() {
             $this->handleLocaleChanged();
         });
 
-        Localization::onCacheKeyChanged(function () {
+        Localization::onCacheKeyChanged(function() {
             $this->handleCacheKeyChanged();
         });
 
-        Localization::onClientFolderChanged(function () {
+        Localization::onClientFolderChanged(function() {
             $this->handleFolderChanged();
         });
     }
@@ -41,7 +41,7 @@ 
     {
         $folder = Localization::getClientFolder();
 
-        if(!empty($folder)) {
+        if (!empty($folder)) {
             return FolderInfo::factory($folder);
         }
 
@@ -52,7 +52,7 @@ 
     {
         $folder = $this->getTargetFolder();
 
-        if($folder !== null) {
+        if ($folder !== null) {
             return FileInfo::factory($folder.'/cachekey.txt');
         }
 
@@ -91,7 +91,7 @@ 
 
     private static function log(string $message, ...$args) : void
     {
-        if(self::$logging === false) {
+        if (self::$logging === false) {
             return;
         }
 
@@ -100,13 +100,13 @@ 
 
     public function getCacheKey() : ?string
     {
-        if(isset($this->cacheKey)) {
+        if (isset($this->cacheKey)) {
             return $this->cacheKey;
         }
 
         $file = $this->getCacheKeyFile();
 
-        if($file !== null && $file->exists()) {
+        if ($file !== null && $file->exists()) {
             $this->cacheKey = $file->getContents();
         }
 
@@ -121,7 +121,7 @@ 
     {
         self::log('Write Files');
 
-        if($this->getCacheKey() === self::getSystemKey()) {
+        if ($this->getCacheKey() === self::getSystemKey()) {
             self::log('Write Files | SKIP | Still up to date.');
             return;
         }
@@ -129,7 +129,7 @@ 
         $targetFolder = $this->getTargetFolder();
 
         // no client libraries folder set: ignore.
-        if($targetFolder === null) {
+        if ($targetFolder === null) {
             self::log('Write Files | SKIP | No folder set.');
             return;
         }
@@ -155,12 +155,12 @@ 
     {
         $files = array();
         
-        foreach($this->libraries as $fileName)
+        foreach ($this->libraries as $fileName)
         {
             $files[] = $this->getLibraryFilePath($fileName);
         }
         
-        foreach($this->getTargetLocales() as $locale)
+        foreach ($this->getTargetLocales() as $locale)
         {
             $files[] = $this->getLocaleFilePath($locale);
         }
@@ -172,7 +172,7 @@ 
     {
         self::log('Write Files | Writing locales.');
 
-        foreach(self::getTargetLocales() as $locale)
+        foreach (self::getTargetLocales() as $locale)
         {
             $this->writeLocaleFile($locale);
         }
@@ -194,7 +194,7 @@ 
     {
         $sourceFolder = FolderInfo::factory(__DIR__.'/../js');
 
-        if(!$sourceFolder->exists())
+        if (!$sourceFolder->exists())
         {
             throw new Localization_Exception(
                 'Unexpected folder structure encountered.',
@@ -206,7 +206,7 @@ 
             );
         }
         
-        foreach($this->libraries as $fileName)
+        foreach ($this->libraries as $fileName)
         {
             $targetFile = $this->getLibraryFilePath($fileName);
             $sourceFile = $sourceFolder.'/'.$fileName;
@@ -222,8 +222,8 @@ 
     {
         $result = array();
 
-        foreach(Localization::getAppLocales() as $locale) {
-            if($locale->isNative()) {
+        foreach (Localization::getAppLocales() as $locale) {
+            if ($locale->isNative()) {
                 continue;
             }
 
@@ -237,7 +237,7 @@ 
     {
         $result = array();
 
-        foreach(self::getTargetLocales() as $locale) {
+        foreach (self::getTargetLocales() as $locale) {
             $result[] = $locale->getName();
         }
 
@@ -281,9 +281,9 @@ 
         $strings = $this->translator->getClientStrings($locale);
         
         $tokens = array();
-        foreach($strings as $hash => $text)
+        foreach ($strings as $hash => $text)
         {
-            if(empty($text)) {
+            if (empty($text)) {
                 continue;
             }
             
@@ -294,7 +294,7 @@ 
             );
         }
         
-        if(empty($tokens))
+        if (empty($tokens))
         {
             $content = '/* No strings found. */';
         }
@@ -314,7 +314,7 @@ 
 
     public static function getSystemKey() : string
     {
-        if(!isset(self::$systemKey)) {
+        if (!isset(self::$systemKey)) {
             self::$systemKey = sprintf(
                 'Lib:%s|System:%s|Locales:%s',
                 Localization::getClientLibrariesCacheKey(),
@@ -339,7 +339,7 @@ 
 
         $file = $this->getCacheKeyFile();
 
-        if($file !== null) {
+        if ($file !== null) {
             $file->putContents($this->cacheKey);
         }