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/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/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])) {

src/Localization/Generator.php

Indentation +37 added lines, -37 removed lines

@@ -18,24 +18,24 @@ 
     
     const FILES_CACHE_KEY = 'cachekey';
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $force = false;
     
-   /**
-    * @var Localization_Translator
-    */
+    /**
+     * @var Localization_Translator
+     */
     protected $translator;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $targetFolder;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $cacheKeyFile;
     
     protected $cacheKey = '';
@@ -118,14 +118,14 @@ 
         $this->writeCacheKey();
     }
     
-   /**
-    * Retrieves a list of all localization client 
-    * files that are written to disk. This includes
-    * the locale files and the libraries required
-    * to make it work clientside.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all localization client 
+     * files that are written to disk. This includes
+     * the locale files and the libraries required
+     * to make it work clientside.
+     * 
+     * @return string[]
+     */
     public function getFilesList() : array
     {
         $files = array();
@@ -273,11 +273,11 @@ 
         $this->written[self::FILES_LOCALES] = true;
     }
     
-   /**
-    * Generates the cache key file, which is used to determine
-    * automatically whether the client libraries need to be 
-    * refreshed.
-    */
+    /**
+     * Generates the cache key file, which is used to determine
+     * automatically whether the client libraries need to be 
+     * refreshed.
+     */
     protected function writeCacheKey()
     {
         if(file_exists($this->cacheKeyFile) && !$this->force) {
@@ -289,18 +289,18 @@ 
         $this->written[self::FILES_CACHE_KEY] = true;
     }
 
-   /**
-    * Whether the specified files have been written to 
-    * disk this session. 
-    * 
-    * NOTE: only useful when called after <code>writeFiles</code>.
-    * 
-    * @param string $filesID
-    * 
-    * @see Localization_ClientGenerator::FILES_CACHE_KEY
-    * @see Localization_ClientGenerator::FILES_LOCALES
-    * @see Localization_ClientGenerator::FILES_LIBRARIES
-    */
+    /**
+     * Whether the specified files have been written to 
+     * disk this session. 
+     * 
+     * NOTE: only useful when called after <code>writeFiles</code>.
+     * 
+     * @param string $filesID
+     * 
+     * @see Localization_ClientGenerator::FILES_CACHE_KEY
+     * @see Localization_ClientGenerator::FILES_LOCALES
+     * @see Localization_ClientGenerator::FILES_LIBRARIES
+     */
     public function areFilesWritten(string $filesID)
     {
         if(isset($this->written[$filesID])) {

src/Localization/Locale.php

Indentation +25 added lines, -25 removed lines

@@ -33,14 +33,14 @@ 
      */
     protected $country;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $countryCode;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $languageCode;
 
     /**
@@ -69,11 +69,11 @@ 
         $this->languageCode = $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;
@@ -100,25 +100,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;

src/Localization/Parser/Language.php

Indentation +79 added lines, -79 removed lines

@@ -17,49 +17,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 array
-    */
+    /**
+     * All texts that have been collected.
+     * @var array
+     */
     protected $texts = array();
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $content = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $id;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     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 = '';
     
     public function __construct(Localization_Parser $parser)
@@ -70,10 +70,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)) {
@@ -93,12 +93,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)) 
@@ -131,10 +131,10 @@ 
         );
     }
     
-   /**
-    * Parses a source code string.
-    * @param string $content
-    */
+    /**
+     * Parses a source code string.
+     * @param string $content
+     */
     public function parseString($content) : void
     {
         $this->content = $content;
@@ -175,11 +175,11 @@ 
         );
     }
 
-   /**
-    * 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();
@@ -190,13 +190,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);
@@ -206,34 +206,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()
     {
         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 $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 $parentToken
+     * @return Localization_Parser_Token
+     */
     protected function createToken($definition, Localization_Parser_Token $parentToken=null) : Localization_Parser_Token
     {
         $class = '\AppLocalize\Localization_Parser_Token_'.$this->getID();
@@ -241,12 +241,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)
     {
         $textParts = array();