Mistralys / application-localization

example/index.php

Indentation +3 added lines, -3 removed lines

@@ -16,9 +16,9 @@
         die('<b>ERROR:</b> Autoloader not present. Run composer update first.');
     }
 
-   /**
-    * The composer autoloader
-    */
+    /**
+     * The composer autoloader
+     */
     require_once $autoload;
 
     // the folder in which the localization .ini files are stored

src/Localization.php

Indentation +294 added lines, -294 removed lines

@@ -52,12 +52,12 @@ 
     
     const NAMESPACE_CONTENT = '__content';
     
-   /**
-    * Collection of all locales by namespace (application, content, custom...). 
-    *
-    * @var array
-    * @see Localization::addLocale()
-    */
+    /**
+     * Collection of all locales by namespace (application, content, custom...). 
+     *
+     * @var array
+     * @see Localization::addLocale()
+     */
     protected static $locales = array();
 
     /**
@@ -66,44 +66,44 @@ 
      */
     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;
     
     /**
@@ -150,12 +150,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])) {
@@ -172,35 +172,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])) {
@@ -242,11 +242,11 @@ 
         return new $className();
     }
     
-   /**
-    * Retrieves the currency of the selected app locale.
-    * 
-    * @return Localization_Currency
-    */
+    /**
+     * Retrieves the currency of the selected app locale.
+     * 
+     * @return Localization_Currency
+     */
     public static function getAppCurrency() : Localization_Currency
     {
         return self::getCurrencyNS(self::NAMESPACE_APPLICATION);
@@ -283,44 +283,44 @@ 
         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::getSelectedKeyByNS('name', $namespace);
     }
     
-   /**
-    * Retrieves the selected locale instance for the specified namespace.
-    * 
-    * @param string $namespace
-    * @return Localization_Locale
-    * @throws Localization_Exception
-    */
+    /**
+     * Retrieves the selected locale instance for the specified namespace.
+     * 
+     * @param string $namespace
+     * @return Localization_Locale
+     * @throws Localization_Exception
+     */
     public static function getSelectedLocaleByNS(string $namespace) : Localization_Locale
     {
         return self::getSelectedKeyByNS('locale', $namespace);
@@ -345,20 +345,20 @@ 
         );
     }
     
-   /**
-    * Stores the selected locale names by namespace.
-    * @var string[]
-    */
+    /**
+     * Stores the selected locale names by namespace.
+     * @var string[]
+     */
     protected static $selected = array();
 
-   /**
-    * Selects the active locale for the specified namespace.
-    * 
-    * @param string $localeName
-    * @param string $namespace
-    * @return Localization_Locale
-    * @throws Localization_Exception
-    */
+    /**
+     * Selects the active locale for the specified namespace.
+     * 
+     * @param string $localeName
+     * @param string $namespace
+     * @return Localization_Locale
+     * @throws Localization_Exception
+     */
     public static function selectLocaleByNS(string $localeName, string $namespace) : Localization_Locale
     {
         self::requireNamespace($namespace);
@@ -394,13 +394,13 @@ 
         return $locale;
     }
     
-   /**
-    * Triggers the specified event, with the provided arguments.
-    * 
-    * @param string $name The event name.
-    * @param array $argsList
-    * @see Localization_Event
-    */
+    /**
+     * Triggers the specified event, with the provided arguments.
+     * 
+     * @param string $name The event name.
+     * @param array $argsList
+     * @see Localization_Event
+     */
     protected static function triggerEvent(string $name, array $argsList) : Localization_Event
     {
         $class = '\AppLocalize\Localization_Event_'.$name;
@@ -421,14 +421,14 @@ 
         return $event;
     }
     
-   /**
-    * Adds a listener to the specified event name.
-    * 
-    * @param string $eventName
-    * @param callable $callback
-    * @param array $args Additional arguments to add to the event
-    * @return int The listener number.
-    */
+    /**
+     * Adds a listener to the specified event name.
+     * 
+     * @param string $eventName
+     * @param callable $callback
+     * @param array $args Additional arguments to add to the event
+     * @return int The listener number.
+     */
     public static function addEventListener(string $eventName, $callback, array $args=array()) : int
     {
         if(!isset(self::$listeners[$eventName])) {
@@ -458,43 +458,43 @@ 
         return self::$listenersCounter;
     }
     
-   /**
-    * Adds an event listener for the <code>LocaleChanged</code> event,
-    * which is triggered every time a locale is changed in any of the
-    * available namespaces.
-    * 
-    * The first parameter of the callback is always the event instance.
-    * 
-    * @param callable $callback The listener function to call.
-    * @param array $args Optional indexed array with additional arguments to pass on to the callback function.
-    * @return int
-    * @see Localization_Event_LocaleChanged
-    */
+    /**
+     * Adds an event listener for the <code>LocaleChanged</code> event,
+     * which is triggered every time a locale is changed in any of the
+     * available namespaces.
+     * 
+     * The first parameter of the callback is always the event instance.
+     * 
+     * @param callable $callback The listener function to call.
+     * @param array $args Optional indexed array with additional arguments to pass on to the callback function.
+     * @return int
+     * @see Localization_Event_LocaleChanged
+     */
     public static function onLocaleChanged($callback, array $args=array()) : int
     {
         return self::addEventListener('LocaleChanged', $callback, $args);
     }
     
-   /**
-    * Selects the application locale to use.
-    * 
-    * @param string $localeName
-    * @return Localization_Locale
-    */
+    /**
+     * Selects the application locale to use.
+     * 
+     * @param string $localeName
+     * @return Localization_Locale
+     */
     public static function selectAppLocale(string $localeName) : Localization_Locale
     {
         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);
@@ -528,22 +528,22 @@ 
         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);
     }
     
-   /**
-    * Retrieves all locale names available in the specified namespace.
-    * The names are sorted alphabetically.
-    * 
-    * @param string $namespace
-    * @return array|array
-    */
+    /**
+     * Retrieves all locale names available in the specified namespace.
+     * The names are sorted alphabetically.
+     * 
+     * @param string $namespace
+     * @return array|array
+     */
     public static function getLocaleNamesByNS(string $namespace)
     {
         self::requireNamespace($namespace);
@@ -553,7 +553,7 @@ 
         sort($names);
         
         return $names;
-     }
+        }
     
     /**
      * Checks by the locale name if the specified locale is
@@ -582,14 +582,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);
@@ -649,10 +649,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;
@@ -719,29 +719,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|NULL $label
-    * @return \HTML_QuickForm2_Element_Select
-    */
+     * @param string $elementName
+     * @param \HTML_QuickForm2_Container $container
+     * @param string|NULL $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);
@@ -776,26 +776,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 \AppLocalize\Localization_Source[]
-    */
+    /**
+     * Retrieves all currently available sources.
+     * 
+     * @return \AppLocalize\Localization_Source[]
+     */
     public static function getSources()
     {
         return self::$sources;
@@ -827,10 +827,10 @@ 
         return $source;
     }
     
-   /**
-    * Retrieves all sources grouped by their group name.
-    * @return Localization_Source[]
-    */
+    /**
+     * Retrieves all sources grouped by their group name.
+     * @return Localization_Source[]
+     */
     public static function getSourcesGrouped()
     {
         $sources = self::getSources();
@@ -851,11 +851,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();
@@ -868,11 +868,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();
@@ -885,13 +885,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();
@@ -937,13 +937,13 @@ 
         );
     }
     
-   /**
-    * Creates the scanner instance that is used to find
-    * all translateable strings in the application.
-    * 
-    * @param string $storageFile Path to the file in which to store string information.
-    * @return Localization_Scanner
-    */
+    /**
+     * Creates the scanner instance that is used to find
+     * all translateable strings in the application.
+     * 
+     * @param string $storageFile Path to the file in which to store string information.
+     * @return Localization_Scanner
+     */
     public static function createScanner() : Localization_Scanner
     {
         self::requireConfiguration();
@@ -956,14 +956,14 @@ 
         // FIXME: TODO: Add this
     }
     
-   /**
-    * Configures the localization for the application:
-    * sets the location of the required files and folders.
-    * Also updated the client library files as needed.
-    * 
-    * @param string $storageFile Where to store the file analysis storage file.
-    * @param string $clientLibrariesFolder Where to put the client libraries and translation files. Will be created if it does not exist. Optional: if not set, client libraries will not be created.
-    */
+    /**
+     * Configures the localization for the application:
+     * sets the location of the required files and folders.
+     * Also updated the client library files as needed.
+     * 
+     * @param string $storageFile Where to store the file analysis storage file.
+     * @param string $clientLibrariesFolder Where to put the client libraries and translation files. Will be created if it does not exist. Optional: if not set, client libraries will not be created.
+     */
     public static function configure(string $storageFile, string $clientLibrariesFolder='')
     {
         self::$configured = true;
@@ -979,17 +979,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)
     {
         self::$clientCacheKey = $key;
@@ -1000,48 +1000,48 @@ 
         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)
     {
         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;
     }
     
-   /**
-    * Writes / updates the client library files on disk,
-    * at the location specified in the {@link Localization::configure()}
-    * method.
-    * 
-    * @see Localization_ClientGenerator
-    * @param bool $force Whether to refresh the files, even if they exist.
-    */
+    /**
+     * Writes / updates the client library files on disk,
+     * at the location specified in the {@link Localization::configure()}
+     * method.
+     * 
+     * @see Localization_ClientGenerator
+     * @param bool $force Whether to refresh the files, even if they exist.
+     */
     public static function writeClientFiles(bool $force=false) : void
     {
         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();
@@ -1084,13 +1084,13 @@ 
         }
     }
     
-   /**
-    * Creates the editor instance that can be used to 
-    * display the localization UI to edit translateable
-    * strings in the browser.
-    * 
-    * @return \AppLocalize\Localization_Editor
-    */
+    /**
+     * Creates the editor instance that can be used to 
+     * display the localization UI to edit translateable
+     * strings in the browser.
+     * 
+     * @return \AppLocalize\Localization_Editor
+     */
     public static function createEditor()
     {
         self::requireConfiguration();
@@ -1098,10 +1098,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()
     {
         $ids = array();
@@ -1128,9 +1128,9 @@ 
         return $aliases;
     }
     
-   /**
-    * Resets all locales to the built-in locale.
-    */
+    /**
+     * Resets all locales to the built-in locale.
+     */
     public static function reset()
     {
         self::$locales = array();
@@ -1162,22 +1162,22 @@ 
         'de_CH'
     );
     
-   /**
-    * Retrieves a list of all supported locales.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves a list of all supported locales.
+     * 
+     * @return array
+     */
     public static function getSupportedLocaleNames() : array
     {
         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 in_array($localeName, self::$supportedLocales);

src/Localization/Translator.php

Indentation +42 added lines, -42 removed lines

@@ -45,9 +45,9 @@ 
     
     private $targetLocaleName = null;
     
-   /**
-    * @var Localization_Source[]
-    */
+    /**
+     * @var Localization_Source[]
+     */
     private $sources = array();
 
     public function addSource(Localization_Source $source)
@@ -174,14 +174,14 @@ 
         );
     }
     
-   /**
-    * Retrieves all available strings for the specified locale,
-    * as hash => text value pairs.
-    * 
-    * @param Localization_Locale $locale
-    * @throws Localization_Exception
-    * @return string[]
-    */
+    /**
+     * Retrieves all available strings for the specified locale,
+     * as hash => text value pairs.
+     * 
+     * @param Localization_Locale $locale
+     * @throws Localization_Exception
+     * @return string[]
+     */
     public function getStrings(Localization_Locale $locale)
     {
         $this->load($locale);
@@ -210,14 +210,14 @@ 
         return !empty($this->strings[$locale->getName()]);
     }
     
-   /**
-    * @param string $type
-    * @param Localization_Scanner_StringHash[] $hashes
-    * @param string $file
-    * @param Localization_Locale $locale
-    * @param boolean $editable
-    * @throws Localization_Exception
-    */
+    /**
+     * @param string $type
+     * @param Localization_Scanner_StringHash[] $hashes
+     * @param string $file
+     * @param Localization_Locale $locale
+     * @param boolean $editable
+     * @throws Localization_Exception
+     */
     protected function renderStringsFile($type, Localization_Source $source, $hashes, $file, Localization_Locale $locale, $editable=true)
     {
         $sourceID = $source->getID();
@@ -280,16 +280,16 @@ 
         }
     }
     
-   /**
-    * Sort the strings to ensure they always appear in the same order:
-    * first by text, and same strings by their hashes. This is important 
-    * for strings that have the same translation to avoid them changing 
-    * order between sorts.
-    * 
-    * @param array $a
-    * @param array $b
-    * @return number
-    */
+    /**
+     * Sort the strings to ensure they always appear in the same order:
+     * first by text, and same strings by their hashes. This is important 
+     * for strings that have the same translation to avoid them changing 
+     * order between sorts.
+     * 
+     * @param array $a
+     * @param array $b
+     * @return number
+     */
     public function callback_sortStrings($a, $b)
     {
         $result = strnatcasecmp($a['text'], $b['text']);
@@ -316,13 +316,13 @@ 
         );
     }
     
-   /**
-    * Retrieves the full path to the strings storage ini file 
-    * for the clientside strings.
-    * 
-    * @param Localization_Locale $locale
-    * @return string
-    */
+    /**
+     * Retrieves the full path to the strings storage ini file 
+     * for the clientside strings.
+     * 
+     * @param Localization_Locale $locale
+     * @return string
+     */
     protected function getClientStorageFile(Localization_Locale $locale, Localization_Source $source)
     {
         return sprintf(
@@ -444,12 +444,12 @@ 
         return null;
     }
 
-   /**
-    * Retrieves only the strings that are available clientside.
-    * 
-    * @param Localization_Locale $locale
-    * @return array
-    */
+    /**
+     * Retrieves only the strings that are available clientside.
+     * 
+     * @param Localization_Locale $locale
+     * @return array
+     */
     public function getClientStrings(Localization_Locale $locale)
     {
         $result = array();

src/Localization/Scanner/StringsCollection.php

Indentation +49 added lines, -49 removed lines

@@ -10,19 +10,19 @@ 
     
     const STORAGE_FORMAT_VERSION = 1;
     
-   /**
-    * @var Localization_Scanner
-    */
+    /**
+     * @var Localization_Scanner
+     */
     protected $scanner;
     
-   /**
-    * @var Localization_Scanner_StringHash[]
-    */
+    /**
+     * @var Localization_Scanner_StringHash[]
+     */
     protected $hashes = array();
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $warnings = array();
     
     public function __construct(Localization_Scanner $scanner)
@@ -51,12 +51,12 @@ 
         return $string;
     }
     
-   /**
-    * Adds a single translateable string.
-    * 
-    * @param Localization_Scanner_StringInfo $string
-    * @return Localization_Scanner_StringsCollection
-    */
+    /**
+     * Adds a single translateable string.
+     * 
+     * @param Localization_Scanner_StringInfo $string
+     * @return Localization_Scanner_StringsCollection
+     */
     protected function add(Localization_Scanner_StringInfo $string)
     {
         $hash = $string->getHash();
@@ -69,12 +69,12 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves all available translateable strings, 
-    * grouped by their hash to identify unique strings.
-    * 
-    * @return Localization_Scanner_StringHash[]
-    */
+    /**
+     * Retrieves all available translateable strings, 
+     * grouped by their hash to identify unique strings.
+     * 
+     * @return Localization_Scanner_StringHash[]
+     */
     public function getHashes()
     {
         return array_values($this->hashes);
@@ -133,32 +133,32 @@ 
         return true;
     }
     
-   /**
-    * Whether the parser reported warnings during the
-    * search for translateable texts.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the parser reported warnings during the
+     * search for translateable texts.
+     * 
+     * @return bool
+     */
     public function hasWarnings() : bool
     {
         return !empty($this->warnings);
     }
     
-   /**
-    * Retrieves the amount of warnings.
-    * @return int
-    */
+    /**
+     * Retrieves the amount of warnings.
+     * @return int
+     */
     public function countWarnings() : int
     {
         return count($this->warnings);
     }
     
-   /**
-    * Retrieves all warning messages that were added
-    * during the search for translateable texts, if any.
-    * 
-    * @return Localization_Scanner_StringsCollection_Warning[]
-    */
+    /**
+     * Retrieves all warning messages that were added
+     * during the search for translateable texts, if any.
+     * 
+     * @return Localization_Scanner_StringsCollection_Warning[]
+     */
     public function getWarnings() : array
     {
         $result = array();
@@ -185,12 +185,12 @@ 
         return $amount;
     }
     
-   /**
-    * Retrieves all string hashed for the specified source.
-    * 
-    * @param string $id
-    * @return \AppLocalize\Localization_Scanner_StringHash[]
-    */
+    /**
+     * Retrieves all string hashed for the specified source.
+     * 
+     * @param string $id
+     * @return \AppLocalize\Localization_Scanner_StringHash[]
+     */
     public function getHashesBySourceID(string $id) 
     {
         $hashes = array();
@@ -204,12 +204,12 @@ 
         return $hashes;
     }
     
-   /**
-    * Retrieves all hashes for the specified language ID.
-    * 
-    * @param string $languageID The language ID, e.g. "PHP"
-    * @return \AppLocalize\Localization_Scanner_StringHash[]
-    */
+    /**
+     * Retrieves all hashes for the specified language ID.
+     * 
+     * @param string $languageID The language ID, e.g. "PHP"
+     * @return \AppLocalize\Localization_Scanner_StringHash[]
+     */
     public function getHashesByLanguageID(string $languageID)
     {
         $hashes = array();

src/Localization/Scanner/StringInfo.php

Indentation +3 added lines, -3 removed lines

@@ -4,9 +4,9 @@
 
 class Localization_Scanner_StringInfo
 {
-   /**
-    * @var Localization_Scanner_StringsCollection
-    */
+    /**
+     * @var Localization_Scanner_StringsCollection
+     */
     protected $collection;
     
     protected $properties = array();

src/Localization/Scanner/StringHash.php

Indentation +32 added lines, -32 removed lines

@@ -13,19 +13,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();
     
     protected $sourceIDs = array();
@@ -55,10 +55,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()
     {
         return $this->strings;
@@ -118,10 +118,10 @@ 
         return count($this->strings);
     }
     
-   /**
-    * Retrieves the translated text, if any.
-    * @return string|NULL
-    */
+    /**
+     * Retrieves the translated text, if any.
+     * @return string|NULL
+     */
     public function getTranslatedText() : string
     {
         $translator = Localization::getTranslator();
@@ -134,10 +134,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();
@@ -159,10 +159,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();
@@ -179,13 +179,13 @@ 
         return $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());

src/Localization/Source.php

Indentation +20 added lines, -20 removed lines

@@ -6,22 +6,22 @@ 
 
 abstract class Localization_Source
 {
-   /**
-    * Human readable label for the source.
-    * @var string
-    */
+    /**
+     * Human readable label for the source.
+     * @var string
+     */
     protected $label;
     
-   /**
-    * Human readable group name to categorize the source.
-    * @var string
-    */
+    /**
+     * Human readable group name to categorize the source.
+     * @var string
+     */
     protected $group;
     
-   /**
-    * The folder in which the localization files are stored
-    * @var string
-    */
+    /**
+     * The folder in which the localization files are stored
+     * @var string
+     */
     protected $storageFolder;
     
     public function __construct(string $alias, string $label, string $group, string $storageFolder)
@@ -54,16 +54,16 @@ 
         return $this->storageFolder;
     }
     
-   /**
-    * Available during scanning.
-    * @var Localization_Scanner_StringsCollection
-    */
+    /**
+     * Available during scanning.
+     * @var Localization_Scanner_StringsCollection
+     */
     protected $collection;
     
-   /**
-    * Available during scanning.
-    * @var Localization_Parser
-    */
+    /**
+     * Available during scanning.
+     * @var Localization_Parser
+     */
     protected $parser;
     
     public function scan(Localization_Scanner $scanner)

src/Localization/Source/Folder.php

Indentation +14 added lines, -14 removed lines

@@ -6,24 +6,24 @@
 
 class Localization_Source_Folder extends Localization_Source
 {
-   /**
-    * The folder under which all translateable files are kept.
-    * @var string
-    */
+    /**
+     * The folder under which all translateable files are kept.
+     * @var string
+     */
     protected $sourcesFolder;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $id;
 
-   /**
-    * @param string $alias An alias for this source, to recognize it by.
-    * @param string $label The human readable label, used in the editor.
-    * @param string $group A human readable group label to group several sources by. Used in the editor.
-    * @param string $storageFolder The folder in which to store the localization files.
-    * @param string $sourcesFolder The folder in which to analyze files to find translateable strings. 
-    */
+    /**
+     * @param string $alias An alias for this source, to recognize it by.
+     * @param string $label The human readable label, used in the editor.
+     * @param string $group A human readable group label to group several sources by. Used in the editor.
+     * @param string $storageFolder The folder in which to store the localization files.
+     * @param string $sourcesFolder The folder in which to analyze files to find translateable strings. 
+     */
     public function __construct(string $alias, string $label, string $group, string $storageFolder, string $sourcesFolder)
     {
         parent::__construct($alias, $label, $group, $storageFolder);

src/Localization/Event.php

Indentation +10 added lines, -10 removed lines

@@ -20,9 +20,9 @@ 
  */
 abstract class Localization_Event
 {
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $args;
     
     public function __construct(array $args)
@@ -30,13 +30,13 @@ 
         $this->args = $args;
     }
 
-   /**
-    * Fetches the argument at the specified index in the 
-    * event's arguments list, if it exists. 
-    * 
-    * @param int $index Zero-based index number.
-    * @return mixed|NULL
-    */ 
+    /**
+     * Fetches the argument at the specified index in the 
+     * event's arguments list, if it exists. 
+     * 
+     * @param int $index Zero-based index number.
+     * @return mixed|NULL
+     */ 
     public function getArgument(int $index)
     {
         if(isset($this->args[$index])) {