Mistralys / application-localization

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();

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->getTextAsString());

src/Localization/Parser/Token.php

Indentation +7 added lines, -7 removed lines

@@ -8,14 +8,14 @@ 
 
 abstract class Localization_Parser_Token
 {
-   /**
-    * @var array|string
-    */
+    /**
+     * @var array|string
+     */
     protected $definition;
     
-   /**
-    * @var Localization_Parser_Token|NULL
-    */
+    /**
+     * @var Localization_Parser_Token|NULL
+     */
     protected $parentToken;
 
     /**
@@ -98,6 +98,6 @@ 
             'value' => $this->getValue(),
             'line' => $this->getLine(),
             'isEncapsedString' => ConvertHelper::bool2string($this->isEncapsedString())
-         );
+            );
     }
 }

src/Localization/Source/Folder.php

Indentation +14 added lines, -14 removed lines

@@ -23,24 +23,24 @@
  */
 class Localization_Source_Folder extends Localization_Source
 {
-   /**
-    * The folder under which all translatable files are kept.
-    * @var string
-    */
+    /**
+     * The folder under which all translatable 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 translatable 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 translatable strings.
+     */
     public function __construct(string $alias, string $label, string $group, string $storageFolder, string $sourcesFolder)
     {
         parent::__construct($alias, $label, $group, $storageFolder);

src/Localization/Source.php

Indentation +15 added lines, -15 removed lines

@@ -27,27 +27,27 @@
  */
 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;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $alias;
 
     public function __construct(string $alias, string $label, string $group, string $storageFolder)

src/Localization/Editor.php

Indentation +54 added lines, -54 removed lines

@@ -41,53 +41,53 @@ 
     const VARIABLE_WARNINGS = 'warnings';
 
     /**
-    * @var string
-    */
+     * @var string
+     */
     protected $installPath;
     
-   /**
-    * @var Localization_Source[]
-    */
+    /**
+     * @var Localization_Source[]
+     */
     protected $sources;
     
-   /**
-    * @var Request
-    */
+    /**
+     * @var Request
+     */
     protected $request;
     
-   /**
-    * @var Localization_Source
-    */
+    /**
+     * @var Localization_Source
+     */
     protected $activeSource;
     
-   /**
-    * @var Localization_Scanner
-    */
+    /**
+     * @var Localization_Scanner
+     */
     protected $scanner;
     
-   /**
-    * @var Localization_Locale[]
-    */
+    /**
+     * @var Localization_Locale[]
+     */
     protected $appLocales = array();
     
-   /**
-    * @var Localization_Locale
-    */
+    /**
+     * @var Localization_Locale
+     */
     protected $activeAppLocale;
     
-   /**
-    * @var Localization_Editor_Filters
-    */
+    /**
+     * @var Localization_Editor_Filters
+     */
     protected $filters;
 
-   /**
-    * @var array<string,string>
-    */
+    /**
+     * @var array<string,string>
+     */
     protected $requestParams = array();
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $varPrefix = 'applocalize_';
 
     /**
@@ -128,15 +128,15 @@ 
         return $this->request;
     }
     
-   /**
-    * Adds a request parameter that will be persisted in all URLs
-    * within the editor. This can be used when integrating the
-    * editor in an existing page that needs specific request params.
-    * 
-    * @param string $name
-    * @param string $value
-    * @return Localization_Editor
-    */
+    /**
+     * Adds a request parameter that will be persisted in all URLs
+     * within the editor. This can be used when integrating the
+     * editor in an existing page that needs specific request params.
+     * 
+     * @param string $name
+     * @param string $value
+     * @return Localization_Editor
+     */
     public function addRequestParam(string $name, string $value) : Localization_Editor
     {
         $this->requestParams[$name] = $value;
@@ -500,13 +500,13 @@ 
         );
     }
     
-   /**
-    * Sets the application name shown in the main navigation
-    * in the user interface.
-    * 
-    * @param string $name
-    * @return Localization_Editor
-    */
+    /**
+     * Sets the application name shown in the main navigation
+     * in the user interface.
+     * 
+     * @param string $name
+     * @return Localization_Editor
+     */
     public function setAppName(string $name) : Localization_Editor
     {
         $this->setOption('appname', $name);
@@ -536,15 +536,15 @@ 
         return $this;
     }
     
-   /**
-    * Sets an URL that the translators can use to go back to
-    * the main application, for example if it is integrated into
-    * an existing application.
-    * 
-    * @param string $url The URL to use for the link
-    * @param string $label Label of the link
-    * @return Localization_Editor
-    */
+    /**
+     * Sets an URL that the translators can use to go back to
+     * the main application, for example if it is integrated into
+     * an existing application.
+     * 
+     * @param string $url The URL to use for the link
+     * @param string $label Label of the link
+     * @return Localization_Editor
+     */
     public function setBackURL(string $url, string $label) : Localization_Editor
     {
         $this->setOption('back-url', $url);

src/Localization/Locale.php

Indentation +20 added lines, -20 removed lines

@@ -33,14 +33,14 @@ 
      */
     protected $country;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $countryCode;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $languageCode;
 
     public function __construct()
@@ -64,25 +64,25 @@ 
         return Localization::isLocaleSupported($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;

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');

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;