Mistralys / application-localization

src/Localization.php

Indentation +227 added lines, -227 removed lines

@@ -53,11 +53,11 @@ 
     const EVENT_LOCALE_CHANGED = 'LocaleChanged';
 
     /**
-    * 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();
 
     /**
@@ -66,57 +66,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 $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) {
@@ -155,12 +155,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])) {
@@ -177,35 +177,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])) {
@@ -343,45 +343,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);
@@ -400,24 +400,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 Localization_Event_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 Localization_Event_LocaleChanged
+     */
     public static function selectLocaleByNS(string $localeName, string $namespace) : Localization_Locale
     {
         self::requireNamespace($namespace);
@@ -548,15 +548,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);
@@ -591,10 +591,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);
@@ -617,7 +617,7 @@ 
         sort($names);
         
         return $names;
-     }
+        }
     
     /**
      * Checks by the locale name if the specified locale is
@@ -646,14 +646,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);
@@ -724,10 +724,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;
@@ -799,29 +799,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);
@@ -857,26 +857,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;
@@ -908,10 +908,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();
@@ -932,11 +932,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();
@@ -949,11 +949,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();
@@ -966,13 +966,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();
@@ -1062,17 +1062,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
     {
         self::$clientCacheKey = $key;
@@ -1083,23 +1083,23 @@ 
         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
     {
         self::$clientFolder = $folder;
     }
     
-   /**
-    * 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;
@@ -1119,13 +1119,13 @@ 
         self::createGenerator()->writeFiles($force);
     }
     
-   /**
-    * 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
     {
         return new Localization_ClientGenerator();
@@ -1190,10 +1190,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();
@@ -1220,9 +1220,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();
@@ -1260,12 +1260,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 +47 added lines, -47 removed lines

@@ -119,7 +119,7 @@ 
     */
     public static function init() : void
     {
-        if(self::$initDone) {
+        if (self::$initDone) {
             return;
         }
 
@@ -163,7 +163,7 @@ 
     */
     public static function getLocalesByNS(string $namespace)
     {
-        if(isset(self::$locales[$namespace])) {
+        if (isset(self::$locales[$namespace])) {
             return array_values(self::$locales[$namespace]);
         }
         
@@ -208,11 +208,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);
             
@@ -274,11 +274,11 @@ 
      */
     public static function createCountry(string $id) : Localization_Country
     {
-        $className = Localization_Country::class.'_' . strtoupper($id);
+        $className = Localization_Country::class.'_'.strtoupper($id);
 
         $country = new $className();
 
-        if($country instanceof Localization_Country)
+        if ($country instanceof Localization_Country)
         {
             return $country;
         }
@@ -386,7 +386,7 @@ 
     {
         self::requireNamespace($namespace);
         
-        if(isset(self::$selected[$namespace])) {
+        if (isset(self::$selected[$namespace])) {
             return self::$selected[$namespace];
         }
         
@@ -425,9 +425,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;
             }
             
@@ -463,11 +463,11 @@ 
         $class = Localization_Event::class.'_'.$name;
         $event = 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);
@@ -489,15 +489,15 @@ 
      * @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();
         }
         
         $className = Localization_Event::class.'_'.$eventName;
         
-        if(!class_exists($className)) 
+        if (!class_exists($className)) 
         {
             throw new Localization_Exception(
                 sprintf('Unknown localization event [%s].', $eventName),
@@ -531,7 +531,7 @@ 
      * @throws Localization_Exception
      * @see Localization_Event_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);
     }
@@ -658,7 +658,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];
         }
         
@@ -737,9 +737,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());
@@ -747,7 +747,7 @@ 
             return $obj;
         }
             
-        if(!isset(self::$translator)) 
+        if (!isset(self::$translator)) 
         {
             $obj = new Localization_Translator();
             $obj->addSources(self::getSources());
@@ -772,7 +772,7 @@ 
     {
         self::requireNamespace($namespace);
         
-        if(isset(self::$locales[$namespace])) {
+        if (isset(self::$locales[$namespace])) {
             return count(self::$locales[$namespace]);
         }
         
@@ -785,7 +785,7 @@ 
      */
     protected static function requireNamespace(string $namespace) : void
     {
-        if(isset(self::$locales[$namespace])) {
+        if (isset(self::$locales[$namespace])) {
             return;
         }
         
@@ -808,7 +808,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);
     }
@@ -822,7 +822,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);
     }
@@ -839,9 +839,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');
         }
 
@@ -850,7 +850,7 @@ 
 
         $locales = self::getLocalesByNS($namespace);
         
-        foreach($locales as $locale) {
+        foreach ($locales as $locale) {
             $select->addOption($locale->getLabel(), $locale->getName());
         }
 
@@ -884,14 +884,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;
         }
     }
@@ -918,11 +918,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();
             }
             
@@ -940,8 +940,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;
             }
         }
@@ -957,8 +957,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;
             }
         }
@@ -976,8 +976,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;
             }
         }
@@ -1002,8 +1002,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;
             }
         }
@@ -1047,7 +1047,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;
         
@@ -1056,7 +1056,7 @@ 
 
         // only write the client libraries to disk if the folder
         // has been specified.
-        if(!empty($clientLibrariesFolder)) 
+        if (!empty($clientLibrariesFolder)) 
         {
             self::writeClientFiles();
         }
@@ -1114,7 +1114,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($force);
     }
@@ -1147,7 +1147,7 @@ 
      */
     protected static function requireConfiguration() : void
     {
-        if(!self::$configured) 
+        if (!self::$configured) 
         {
             throw new Localization_Exception(
                 'The localization configuration is incomplete.',
@@ -1156,7 +1156,7 @@ 
             );
         }
 
-        if(empty(self::$storageFile))
+        if (empty(self::$storageFile))
         {
             throw new Localization_Exception(
                 'No localization storage file set',
@@ -1165,7 +1165,7 @@ 
             );
         }
         
-        if(empty(self::$sources)) 
+        if (empty(self::$sources)) 
         {
             throw new Localization_Exception(
                 'No source folders have been defined.',
@@ -1198,7 +1198,7 @@ 
     {
         $ids = array();
         
-        foreach(self::$sources as $source) {
+        foreach (self::$sources as $source) {
             $ids[] = $source->getID();
         }
         
@@ -1213,7 +1213,7 @@ 
     {
         $aliases = array();
         
-        foreach(self::$sources as $source) {
+        foreach (self::$sources as $source) {
             $aliases[] = $source->getAlias();
         }
         
@@ -1251,7 +1251,7 @@ 
      */
     public static function getSupportedLocaleNames() : array
     {
-        if(empty(self::$supportedLocales))
+        if (empty(self::$supportedLocales))
         {
             self::$supportedLocales = FileHelper::createFileFinder(__DIR__.'/Localization/Locale')
                 ->getPHPClassNames();

Braces +1 added lines, -2 removed lines

@@ -246,8 +246,7 @@
             {
                 return $locale;
             }
-        }
-        catch (Exception $e)
+        } catch (Exception $e)
         {
 
         }

src/Localization/Locale.php

Indentation +25 added lines, -25 removed lines

@@ -32,14 +32,14 @@ 
      */
     protected $country;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $countryCode;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $languageCode;
 
     public function __construct()
@@ -53,11 +53,11 @@ 
         $this->languageCode = strtolower($tokens[0]);
     }
     
-   /**
-    * Retrieves the two-letter language code of the locale.
-    * 
-    * @return string Language code, e.g. "en", "de"
-    */
+    /**
+     * Retrieves the two-letter language code of the locale.
+     * 
+     * @return string Language code, e.g. "en", "de"
+     */
     public function getLanguageCode() : string
     {
         return $this->languageCode;
@@ -84,25 +84,25 @@ 
         return $this->localeName;
     }
     
-   /**
-    * Retrieves the shortened version of the locale name,
-    * e.g. "en" or "de".
-    *
-    * @return string
-    * @deprecated
-    * @see Localization_Locale::getLanguageCode()
-    */
+    /**
+     * Retrieves the shortened version of the locale name,
+     * e.g. "en" or "de".
+     *
+     * @return string
+     * @deprecated
+     * @see Localization_Locale::getLanguageCode()
+     */
     public function getShortName() : string
     {
         return $this->getLanguageCode();
     }
     
-   /**
-    * Retrieves the two-letter country code of
-    * the locale.
-    * 
-    * @return string Lowercase code, e.g. "uk"
-    */
+    /**
+     * Retrieves the two-letter country code of
+     * the locale.
+     * 
+     * @return string Lowercase code, e.g. "uk"
+     */
     public function getCountryCode() : string
     {
         return $this->countryCode;

Spacing +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
      */
     public function getCountry() : Localization_Country
     {
-        if(!isset($this->country)) {
+        if (!isset($this->country)) {
             $this->country = Localization::createCountry($this->countryCode);
         }
         

src/Localization/Scanner/StringHash.php

Indentation +32 added lines, -32 removed lines

@@ -15,19 +15,19 @@ 
  */
 class Localization_Scanner_StringHash
 {
-   /**
-    * @var Localization_Scanner_StringsCollection
-    */
+    /**
+     * @var Localization_Scanner_StringsCollection
+     */
     protected $collection;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $hash;
     
-   /**
-    * @var Localization_Scanner_StringInfo[]
-    */
+    /**
+     * @var Localization_Scanner_StringInfo[]
+     */
     protected $strings = array();
 
     /**
@@ -60,10 +60,10 @@ 
         return $entries;
     }
     
-   /**
-    * Retrieves all individual string locations where this text was found.
-    * @return Localization_Scanner_StringInfo[]
-    */
+    /**
+     * Retrieves all individual string locations where this text was found.
+     * @return Localization_Scanner_StringInfo[]
+     */
     public function getStrings() : array
     {
         return $this->strings;
@@ -123,10 +123,10 @@ 
         return count($this->strings);
     }
     
-   /**
-    * Retrieves the translated text, if any.
-    * @return string
-    */
+    /**
+     * Retrieves the translated text, if any.
+     * @return string
+     */
     public function getTranslatedText() : string
     {
         $translator = Localization::getTranslator();
@@ -139,10 +139,10 @@ 
         return '';
     }
     
-   /**
-    * Retrieves a list of all file names, with relative paths.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all file names, with relative paths.
+     * @return string[]
+     */
     public function getFiles() : array
     {
         $files = array();
@@ -164,10 +164,10 @@ 
         return $files;
     }
     
-   /**
-    * Retrieves a list of all file names this string is used in.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all file names this string is used in.
+     * @return string[]
+     */
     public function getFileNames() : array
     {
         $files = $this->getFiles();
@@ -182,13 +182,13 @@ 
         return array_unique($result);
     }
     
-   /**
-    * Retrieves a text comprised of all strings that are relevant
-    * for a full text search, imploded together. Used in the search
-    * function to find matching strings.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a text comprised of all strings that are relevant
+     * for a full text search, imploded together. Used in the search
+     * function to find matching strings.
+     * 
+     * @return string
+     */
     public function getSearchString() : string
     {
         $parts = array($this->getTranslatedText(), $this->getText()->getText());

src/Localization/Parser/Language.php

Indentation +79 added lines, -79 removed lines

@@ -23,49 +23,49 @@ 
      */
     protected $parser;
 
-   /**
-    * The function names that are included in the search.
-    * @var array
-    */
+    /**
+     * The function names that are included in the search.
+     * @var array
+     */
     protected $functionNames = array();
     
-   /**
-    * The tokens definitions.
-    * @var array
-    */
+    /**
+     * The tokens definitions.
+     * @var array
+     */
     protected $tokens = array();
     
-   /**
-    * The total amount of tokens found in the content.
-    * @var integer
-    */
+    /**
+     * The total amount of tokens found in the content.
+     * @var integer
+     */
     protected $totalTokens = 0;
     
-   /**
-    * All texts that have been collected.
-    * @var Text[]
-    */
+    /**
+     * All texts that have been collected.
+     * @var Text[]
+     */
     protected $texts = array();
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $content = '';
 
-   /**
-    * @var string|NULL
-    */
+    /**
+     * @var string|NULL
+     */
     protected $id;
     
-   /**
-    * @var Localization_Parser_Warning[]
-    */
+    /**
+     * @var Localization_Parser_Warning[]
+     */
     protected $warnings = array();
     
-   /**
-    * The source file that was parsed (if any)
-    * @var string
-    */
+    /**
+     * The source file that was parsed (if any)
+     * @var string
+     */
     protected $sourceFile = '';
 
     /**
@@ -91,10 +91,10 @@ 
     
     abstract protected function getTokens() : array;
     
-   /**
-    * Retrieves the ID of the language.
-    * @return string E.g. "PHP", "Javascript"
-    */
+    /**
+     * Retrieves the ID of the language.
+     * @return string E.g. "PHP", "Javascript"
+     */
     public function getID() : string
     {
         if(!isset($this->id)) {
@@ -114,12 +114,12 @@ 
         return $this->sourceFile;
     }
     
-   /**
-    * Parses the code from a file.
-    * 
-    * @param string $path
-    * @throws Localization_Exception
-    */
+    /**
+     * Parses the code from a file.
+     * 
+     * @param string $path
+     * @throws Localization_Exception
+     */
     public function parseFile(string $path) : void
     {
         if(!file_exists($path)) 
@@ -156,10 +156,10 @@ 
         $this->parse();
     }
     
-   /**
-    * Parses a source code string.
-    * @param string $content
-    */
+    /**
+     * Parses a source code string.
+     * @param string $content
+     */
     public function parseString(string $content) : void
     {
         $this->content = $content;
@@ -214,11 +214,11 @@ 
         $this->texts[] = new Text($text, $line, $explanation);
     }
 
-   /**
-    * Retrieves a list of all the function names that are
-    * used as translation functions in the language.
-    * @return array
-    */
+    /**
+     * Retrieves a list of all the function names that are
+     * used as translation functions in the language.
+     * @return array
+     */
     public function getFunctionNames() : array
     {
         return $this->createToken('dummy')->getFunctionNames();
@@ -229,13 +229,13 @@ 
         Localization::log(sprintf('%1$s parser | %2$s', $this->getID(), $message));
     }
 
-   /**
-    * Adds a warning message when a text cannot be parsed correctly for some reason.
-    * 
-    * @param Localization_Parser_Token $token
-    * @param string $message
-    * @return Localization_Parser_Warning
-    */
+    /**
+     * Adds a warning message when a text cannot be parsed correctly for some reason.
+     * 
+     * @param Localization_Parser_Token $token
+     * @param string $message
+     * @return Localization_Parser_Warning
+     */
     protected function addWarning(Localization_Parser_Token $token, string $message) : Localization_Parser_Warning
     {
         $warning = new Localization_Parser_Warning($this, $token, $message);
@@ -245,34 +245,34 @@ 
         return $warning;
     }
     
-   /**
-    * Whether any warnings were generated during parsing.
-    * @return bool
-    */
+    /**
+     * Whether any warnings were generated during parsing.
+     * @return bool
+     */
     public function hasWarnings() : bool
     {
         return !empty($this->warnings);
     }
     
-   /**
-    * Retrieves all warnings that were generated during parsing,
-    * if any.
-    * 
-    * @return Localization_Parser_Warning[]
-    */
+    /**
+     * Retrieves all warnings that were generated during parsing,
+     * if any.
+     * 
+     * @return Localization_Parser_Warning[]
+     */
     public function getWarnings() : array
     {
         return $this->warnings;
     }
     
-   /**
-    * Creates a token instance: this retrieves information on
-    * the language token being parsed.
-    * 
-    * @param array|string $definition The token definition.
-    * @param Localization_Parser_Token|NULL $parentToken
-    * @return Localization_Parser_Token
-    */
+    /**
+     * Creates a token instance: this retrieves information on
+     * the language token being parsed.
+     * 
+     * @param array|string $definition The token definition.
+     * @param Localization_Parser_Token|NULL $parentToken
+     * @return Localization_Parser_Token
+     */
     protected function createToken($definition, Localization_Parser_Token $parentToken=null) : Localization_Parser_Token
     {
         $class = Localization_Parser_Token::class.'_'.$this->getID();
@@ -280,12 +280,12 @@ 
         return new $class($definition, $parentToken);
     }
 
-   /**
-    * Parses a translation function token.
-    * 
-    * @param int $number
-    * @param Localization_Parser_Token $token
-    */
+    /**
+     * Parses a translation function token.
+     * 
+     * @param int $number
+     * @param Localization_Parser_Token $token
+     */
     protected function parseToken(int $number, Localization_Parser_Token $token) : void
     {
         $textParts = array();

Spacing +25 added lines, -25 removed lines

@@ -97,7 +97,7 @@ 
     */
     public function getID() : string
     {
-        if(!isset($this->id)) {
+        if (!isset($this->id)) {
             $this->id = str_replace(Localization_Parser_Language::class.'_', '', get_class($this));
         }
         
@@ -122,7 +122,7 @@ 
     */
     public function parseFile(string $path) : void
     {
-        if(!file_exists($path)) 
+        if (!file_exists($path)) 
         {
             throw new Localization_Exception(
                 sprintf('Source code file [%s] not found', basename($path)),
@@ -175,12 +175,12 @@ 
         $this->tokens = $this->getTokens();
         $this->totalTokens = count($this->tokens);
         
-        for($i = 0; $i < $this->totalTokens; $i++)
+        for ($i = 0; $i < $this->totalTokens; $i++)
         {
             $token = $this->createToken($this->tokens[$i]);
             
-            if($token->isTranslationFunction()) {
-                $this->parseToken($i+1, $token);
+            if ($token->isTranslationFunction()) {
+                $this->parseToken($i + 1, $token);
             }
         }
     }
@@ -204,7 +204,7 @@ 
         return self::$allowedContextTags;
     }
 
-    protected function addResult(string $text, int $line=0, string $explanation='') : void
+    protected function addResult(string $text, int $line = 0, string $explanation = '') : void
     {
         $this->log(sprintf('Line [%1$s] | Found string [%2$s]', $line, $text));
 
@@ -273,7 +273,7 @@ 
     * @param Localization_Parser_Token|NULL $parentToken
     * @return Localization_Parser_Token
     */
-    protected function createToken($definition, Localization_Parser_Token $parentToken=null) : Localization_Parser_Token
+    protected function createToken($definition, Localization_Parser_Token $parentToken = null) : Localization_Parser_Token
     {
         $class = Localization_Parser_Token::class.'_'.$this->getID();
         
@@ -293,48 +293,48 @@ 
         $open = false;
         $explanation = '';
         
-        for($i = $number; $i < $max; $i++)
+        for ($i = $number; $i < $max; $i++)
         {
-            if(!isset($this->tokens[$i])) {
+            if (!isset($this->tokens[$i])) {
                 break;
             }
             
             $subToken = $this->createToken($this->tokens[$i], $token);
             
-            if(!$open && $subToken->isOpeningFuncParams())
+            if (!$open && $subToken->isOpeningFuncParams())
             {
                 $open = true;
                 continue;
             }
             
-            if($open && $subToken->isClosingFuncParams()) {
+            if ($open && $subToken->isClosingFuncParams()) {
                 break;
             }
             
             // additional parameters in the translation function, we don't want to capture these now.
-            if($open && $subToken->isArgumentSeparator())
+            if ($open && $subToken->isArgumentSeparator())
             {
-                if($token->isExplanationFunction()) {
-                    $leftover = array_slice($this->tokens, $i+1);
+                if ($token->isExplanationFunction()) {
+                    $leftover = array_slice($this->tokens, $i + 1);
                     $explanation = $this->parseExplanation($token, $leftover);
                 }
                 break;
             }
             
-            if($open && $subToken->isEncapsedString())
+            if ($open && $subToken->isEncapsedString())
             {
                 $textParts[] = $this->trimText(strval($subToken->getValue()));
                 continue;
             }
             
-            if($open && $subToken->isVariableOrFunction()) {
+            if ($open && $subToken->isVariableOrFunction()) {
                 $textParts = null;
                 $this->addWarning($subToken, t('Variables or functions are not supported in translation functions.'));
                 break;
             }
         }
         
-        if(empty($textParts)) {
+        if (empty($textParts)) {
             return;
         }
         
@@ -348,38 +348,38 @@ 
         $textParts = array();
         $max = 200;
 
-        for($i = 0; $i < $max; $i++)
+        for ($i = 0; $i < $max; $i++)
         {
-            if(!isset($tokens[$i])) {
+            if (!isset($tokens[$i])) {
                 break;
             }
 
             $subToken = $this->createToken($tokens[$i], $token);
 
-            if($subToken->isClosingFuncParams()) {
+            if ($subToken->isClosingFuncParams()) {
                 break;
             }
 
             // additional parameters in the translation function, we don't want to capture these now.
-            if($subToken->isArgumentSeparator())
+            if ($subToken->isArgumentSeparator())
             {
                 break;
             }
 
-            if($subToken->isEncapsedString())
+            if ($subToken->isEncapsedString())
             {
                 $textParts[] = $this->trimText(strval($subToken->getValue()));
                 continue;
             }
 
-            if($subToken->isVariableOrFunction()) {
+            if ($subToken->isVariableOrFunction()) {
                 $textParts = null;
                 $this->addWarning($subToken, t('Variables or functions are not supported in translation functions.'));
                 break;
             }
         }
 
-        if(empty($textParts)) {
+        if (empty($textParts)) {
             return '';
         }
 
@@ -388,7 +388,7 @@ 
 
     protected function debug(string $text) : void
     {
-        if($this->debug) {
+        if ($this->debug) {
             echo $text;
         }
     }

example/index.php

Spacing +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
     $autoload = realpath($root.'/../vendor/autoload.php');
     
     // we need the autoloader to be present
-    if($autoload === false) {
+    if ($autoload === false) {
         die('<b>ERROR:</b> Autoloader not present. Run composer update first.');
     }