Mistralys / application-localization

src/Localization/Parser.php

Indentation +47 added lines, -47 removed lines

@@ -27,14 +27,14 @@ 
     
     const ERROR_UNSUPPORTED_FILE_EXTENSION = 40602;
     
-   /**
-    * @var Localization_Scanner
-    */
+    /**
+     * @var Localization_Scanner
+     */
     protected $scanner;
     
-   /**
-    * @var Localization_Scanner_StringsCollection
-    */
+    /**
+     * @var Localization_Scanner_StringsCollection
+     */
     protected $collection;
     
     protected $languageMappings = array(
@@ -48,15 +48,15 @@ 
         $this->collection = $scanner->getCollection();
     }
     
-   /**
-    * Parses a source file. Must have a valid supported file extension.
-    * 
-    * @param string $path
-    * @return Localization_Parser_Language
-    * @throws Localization_Exception
-    * 
-    * @see Localization_Parser::ERROR_UNSUPPORTED_FILE_EXTENSION
-    */
+    /**
+     * Parses a source file. Must have a valid supported file extension.
+     * 
+     * @param string $path
+     * @return Localization_Parser_Language
+     * @throws Localization_Exception
+     * 
+     * @see Localization_Parser::ERROR_UNSUPPORTED_FILE_EXTENSION
+     */
     public function parseFile(string $path) : Localization_Parser_Language
     {
         $this->requireValidFile($path);
@@ -70,16 +70,16 @@ 
         return $language;
     }
     
-   /**
-    * Parses the string for the specified language.
-    * 
-    * @param string $languageID
-    * @param string $code
-    * @return Localization_Parser_Language
-    * @throws Localization_Exception
-    * 
-    * @see Localization_Parser::ERROR_INVALID_LANGUAGE_ID
-    */
+    /**
+     * Parses the string for the specified language.
+     * 
+     * @param string $languageID
+     * @param string $code
+     * @return Localization_Parser_Language
+     * @throws Localization_Exception
+     * 
+     * @see Localization_Parser::ERROR_INVALID_LANGUAGE_ID
+     */
     public function parseString(string $languageID, string $code) : Localization_Parser_Language
     {
         $this->requireValidLanguageID($languageID);
@@ -128,29 +128,29 @@ 
         );
     }
     
-   /**
-    * Retrieves a list of all language IDs that are supported.
-    * @return string[] IDs list like "PHP", "Javascript"
-    */
+    /**
+     * Retrieves a list of all language IDs that are supported.
+     * @return string[] IDs list like "PHP", "Javascript"
+     */
     public function getLanguageIDs() : array
     {
         return array_values($this->languageMappings);
     }
     
-   /**
-    * @var Localization_Parser_Language[]
-    */
+    /**
+     * @var Localization_Parser_Language[]
+     */
     protected $languageParsers = array();
     
-   /**
-    * Creates a parser for the specified language, e.g. "PHP".
-    * NOTE: Existing parser instances are re-used.
-    * 
-    * @param string $languageID
-    * @return Localization_Parser_Language
-    * 
-    * @see  Localization_Parser::ERROR_INVALID_LANGUAGE_ID
-    */
+    /**
+     * Creates a parser for the specified language, e.g. "PHP".
+     * NOTE: Existing parser instances are re-used.
+     * 
+     * @param string $languageID
+     * @return Localization_Parser_Language
+     * 
+     * @see  Localization_Parser::ERROR_INVALID_LANGUAGE_ID
+     */
     public function createLanguage(string $languageID)
     {
         $this->requireValidLanguageID($languageID);
@@ -165,12 +165,12 @@ 
         return $this->languageParsers[$languageID];
     }
     
-   /**
-    * Whether the specified file extension is supported.
-    * 
-    * @param string $ext
-    * @return bool
-    */
+    /**
+     * Whether the specified file extension is supported.
+     * 
+     * @param string $ext
+     * @return bool
+     */
     public function isExtensionSupported(string $ext) : bool
     {
         $ext = strtolower($ext);

src/Localization/Event/LocaleChanged.php

Indentation +20 added lines, -20 removed lines

@@ -20,10 +20,10 @@ 
  */
 class Localization_Event_LocaleChanged extends Localization_Event
 {
-   /**
-    * 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);
@@ -34,38 +34,38 @@ 
         return null;
     }
     
-   /**
-    * The locale that is used now after the change.
-    * @return Localization_Locale
-    */
+    /**
+     * The locale that is used now after the change.
+     * @return Localization_Locale
+     */
     public function getCurrent() : Localization_Locale
     {
         $arg = $this->getArgument(2);
         return $arg['locale'];
     }
     
-   /**
-    * 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 $this->getArgument(0);
     }
 
-   /**
-    * Whether the change occurred for an application locale.
-    * @return bool
-    */
+    /**
+     * Whether the change occurred for an application locale.
+     * @return bool
+     */
     public function isAppLocale() : bool
     {
         return $this->getNamespace() === Localization::NAMESPACE_APPLICATION;
     }
     
-   /**
-    * Whether the change occurred for a content locale.
-    * @return bool
-    */
+    /**
+     * Whether the change occurred for a content locale.
+     * @return bool
+     */
     public function isContentLocale() : bool
     {
         return $this->getNamespace() === Localization::NAMESPACE_CONTENT;

src/Localization/Editor.php

Indentation +181 added lines, -181 removed lines

@@ -22,44 +22,44 @@ 
     
     const ERROR_NO_SOURCES_AVAILABLE = 40001;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $installPath;
     
-   /**
-    * @var Localization_Source[]
-    */
+    /**
+     * @var Localization_Source[]
+     */
     protected $sources;
     
-   /**
-    * @var \AppUtils\Request
-    */
+    /**
+     * @var \AppUtils\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;
 
     protected $requestParams = array();
@@ -80,15 +80,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;
@@ -241,34 +241,34 @@ 
                                 	</a>
                                     <div class="dropdown-menu" aria-labelledby="dropdown01">
                                     	<?php 
-                                    	    foreach($this->sources as $source)
-                                    	    {
-                                    	       ?>
+                                            foreach($this->sources as $source)
+                                            {
+                                                ?>
                                         			<a class="dropdown-item" href="<?php echo $this->getSourceURL($source) ?>">
                                         				<?php 
-                                            				if($source->getID() === $this->activeSource->getID()) 
-                                            				{
-                                            				    ?>
+                                                            if($source->getID() === $this->activeSource->getID()) 
+                                                            {
+                                                                ?>
                                             				    	<b><?php echo $source->getLabel() ?></b>
                                         				    	<?php 
-                                            				}
-                                            				else
-                                            				{
-                                            				    echo $source->getLabel();
-                                            				}
-                                        				?>
+                                                            }
+                                                            else
+                                                            {
+                                                                echo $source->getLabel();
+                                                            }
+                                                        ?>
                                         				<?php
-                                        				    $untranslated = $source->countUntranslated($this->scanner);
-                                        				    if($untranslated > 0) {
-                                        				        ?>
+                                                            $untranslated = $source->countUntranslated($this->scanner);
+                                                            if($untranslated > 0) {
+                                                                ?>
                                         				        	(<span class="text-danger" title="<?php pt('%1$s texts have not been translated in this text source.', $untranslated) ?>"><?php echo $untranslated ?></span>)
                                 				            	<?php 
-                                        				    }
-                                    				    ?>
+                                                            }
+                                                        ?>
                                     				</a>
                                     			<?php 
-                                    	    }
-                                	    ?>
+                                            }
+                                        ?>
                                     </div>
                                 </li>
                                 <li class="nav-item dropdown">
@@ -277,15 +277,15 @@ 
                                 	</a>
                                     <div class="dropdown-menu" aria-labelledby="dropdown01">
                                     	<?php 
-                                    	    foreach($this->appLocales as $locale)
-                                    	    {
-                                    	       ?>
+                                            foreach($this->appLocales as $locale)
+                                            {
+                                                ?>
                                         			<a class="dropdown-item" href="<?php echo $this->getLocaleURL($locale) ?>">
                                         				<?php echo $locale->getLabel() ?>
                                     				</a>
                                     			<?php 
-                                    	    }
-                                	    ?>
+                                            }
+                                        ?>
                                     </div>
                                 </li>
                                 <li class="nav-item">
@@ -295,8 +295,8 @@ 
                                     </a>
                     			</li>
                     			<?php 
-                        			if($this->scanner->hasWarnings()) {
-                        			    ?>
+                                    if($this->scanner->hasWarnings()) {
+                                        ?>
                         			    	<li class="nav-item">
                         			    		<a href="<?php echo $this->getWarningsURL() ?>">
                             			    		<span class="badge badge-warning" title="<?php pts('The last scan for translateable texts reported warnings.'); pts('Click for details.'); ?>" data-toggle="tooltip">
@@ -306,8 +306,8 @@ 
                         			    		</a>
                         			    	</li>
                         			    <?php 
-                        			}
-                    			?>
+                                    }
+                                ?>
                             </ul>
                         <?php 
                     }
@@ -323,36 +323,36 @@ 
                         	</a>
                     	<?php 
                     }
-            	?>
+                ?>
     		</div>
 		</nav>
 		<main role="main" class="container">
 			<div>
     			<?php 
-    			    if(empty($this->appLocales))
-    			    {
-    			        ?>
+                    if(empty($this->appLocales))
+                    {
+                        ?>
     			        	<div class="alert alert-danger">
     			        		<i class="fa fa-exclamation-triangle"></i>
     			        		<b><?php pt('Nothing to translate:') ?></b>
     			        		<?php pt('No application locales were added to translate to.') ?>
     			        	</div>
     			        <?php 
-    			    }
-    			    else if($this->request->getBool($this->getVarName('warnings')))
-    			    {
-    			        echo $this->renderWarnings();
-    			    }
-    			    else
-    			    {
-    			        ?>
+                    }
+                    else if($this->request->getBool($this->getVarName('warnings')))
+                    {
+                        echo $this->renderWarnings();
+                    }
+                    else
+                    {
+                        ?>
             				<h1><?php echo $this->activeSource->getLabel() ?></h1>
             				<?php 
-                				if(!empty($_SESSION['localization_messages'])) 
-                				{
-                				    foreach($_SESSION['localization_messages'] as $def)
-                				    {
-                				        ?>
+                                if(!empty($_SESSION['localization_messages'])) 
+                                {
+                                    foreach($_SESSION['localization_messages'] as $def)
+                                    {
+                                        ?>
                 				        	<div class="alert alert-<?php echo $def['type'] ?>" role="alert">
                                         		<?php echo $def['text'] ?>
                                         		<button type="button" class="close" data-dismiss="alert" aria-label="<?php pt('Close') ?>" title="<?php pt('Dismiss this message.') ?>" data-toggle="tooltip">
@@ -360,28 +360,28 @@ 
             									</button>
                                         	</div>
             				        	<?php 
-                				    }
+                                    }
                 				    
-                				    // reset the messages after having displayed them
-                				    $_SESSION['localization_messages'] = array();
-                				}
-            				?>
+                                    // reset the messages after having displayed them
+                                    $_SESSION['localization_messages'] = array();
+                                }
+                            ?>
             				<p>
             					<?php 
-            				        pt(
-                					    'You are translating to %1$s', 
-                					    '<span class="badge badge-info">'.
-                					       $this->activeAppLocale->getLabel().
-                				        '</span>'
+                                    pt(
+                                        'You are translating to %1$s', 
+                                        '<span class="badge badge-info">'.
+                                            $this->activeAppLocale->getLabel().
+                                        '</span>'
                                     );
-            				    ?><br>
+                                ?><br>
             					<?php pt('Found %1$s texts to translate.', $this->activeSource->countUntranslated($this->scanner)) ?>
             				</p>
             				<br>
             				<?php
-                				if(!$this->scanner->isScanAvailable()) 
-                				{
-                				    ?>
+                                if(!$this->scanner->isScanAvailable()) 
+                                {
+                                    ?>
                 				    	<div class="alert alert-primary" role="alert">
                                         	<b><?php pt('No texts found:') ?></b> 
                                         	<?php pt('The source folders have not been scanned yet.') ?>
@@ -393,15 +393,15 @@ 
                                             </a>
                                         </p>
                 				    <?php 
-                				}
-                				else
-                				{
-                				    echo $this->filters->renderForm();
-                				    echo $this->renderList();
-                				}
+                                }
+                                else
+                                {
+                                    echo $this->filters->renderForm();
+                                    echo $this->renderList();
+                                }
             				
-        				}
-    				?>
+                        }
+                    ?>
 			</div>
 		</main>
 	</body>
@@ -419,22 +419,22 @@ 
         	<h1><?php pt('Warnings') ?></h1>
         	<p class="abstract">
         		<?php 
-        		    pts('The following shows all texts where the system decided that they cannot be translated.');
-       		    ?>
+                    pts('The following shows all texts where the system decided that they cannot be translated.');
+                    ?>
         	</p>
         	<dl>
         		<?php 
-        		    $warnings = $this->scanner->getWarnings();
+                    $warnings = $this->scanner->getWarnings();
         		    
-        		    foreach($warnings as $warning)
-        		    {
-        		        ?>
+                    foreach($warnings as $warning)
+                    {
+                        ?>
         		        	<dt><?php echo FileHelper::relativizePathByDepth($warning->getFile(), 3) ?>:<?php echo $warning->getLine() ?></dt>
         		        	<dd><?php echo $warning->getMessage() ?></dd>
         		        <?php 
-        		    }
+                    }
         		        
-        		?>
+                ?>
         	</dl>
     	<?php 
     	
@@ -493,13 +493,13 @@ 
 			<form method="post">
 				<div class="form-hiddens">
 					<?php 
-    					$params = $this->getRequestParams();
-    					foreach($params as $name => $value) {
-    					    ?>
+                        $params = $this->getRequestParams();
+                        foreach($params as $name => $value) {
+                            ?>
     					    	<input type="hidden" name="<?php echo $name ?>" value="<?php echo $value ?>">
     					    <?php 
-    					}
-					?>
+                        }
+                    ?>
 				</div>
             	<table class="table table-hover">
     				<thead>
@@ -512,20 +512,20 @@ 
     				</thead>
     				<tbody>
     					<?php 
-    					    foreach($keep as $string)
-    					    {
-    					        $this->renderListEntry($string);
-    					    }
-    					?>
+                            foreach($keep as $string)
+                            {
+                                $this->renderListEntry($string);
+                            }
+                        ?>
     				</tbody>
     			</table>
     			<?php 
-        			if($pager->hasPages()) 
-        			{
-        			    $prevUrl = $this->getPaginationURL($pager->getPreviousPage());
-        			    $nextUrl = $this->getPaginationURL($pager->getNextPage());
+                    if($pager->hasPages()) 
+                    {
+                        $prevUrl = $this->getPaginationURL($pager->getPreviousPage());
+                        $nextUrl = $this->getPaginationURL($pager->getNextPage());
         			    
-        			    ?>
+                        ?>
         			    	<nav aria-label="<?php pt('Navigate available pages of texts.') ?>">
                                 <ul class="pagination">
                                     <li class="page-item">
@@ -534,20 +534,20 @@ 
                                 		</a>
                             		</li>
                             		<?php 
-                            		    $numbers = $pager->getPageNumbers();
-                            		    foreach($numbers as $number) 
-                            		    {
-                            		        $url = $this->getPaginationURL($number);
+                                        $numbers = $pager->getPageNumbers();
+                                        foreach($numbers as $number) 
+                                        {
+                                            $url = $this->getPaginationURL($number);
                             		        
-                            		        ?>
+                                            ?>
                             		        	<li class="page-item <?php if($pager->isCurrentPage($number)) { echo 'active'; } ?>">
                             		        		<a class="page-link" href="<?php echo $url ?>">
                             		        			<?php echo $number ?>
                         		        			</a>
                         		        		</li>
                             		        <?php 
-                            		    }
-                            		?>
+                                        }
+                                    ?>
                                     <li class="page-item">
                                     	<a class="page-link" href="<?php echo $nextUrl ?>">
                                     		<i class="fa fa-arrow-right"></i>
@@ -556,8 +556,8 @@ 
                                 </ul>
                             </nav>
         			    <?php 
-        			}
-    			?>
+                    }
+                ?>
 				<br>
 				<p>
 					<button type="submit" name="<?php echo $this->getVarName('save') ?>" value="yes" class="btn btn-primary">
@@ -615,48 +615,48 @@ 
         			<div class="files-list">
             			<p>
             				<?php 
-            				    $totalFiles = count($files);
+                                $totalFiles = count($files);
             				    
-            				    if($totalFiles == 1)
-            				    {
-            				        pt('Found in a single file:');
-            				    }
-            				    else
-            				    {
-            				        pt('Found in %1$s files:', $totalFiles);
-            				    }
-    				        ?>
+                                if($totalFiles == 1)
+                                {
+                                    pt('Found in a single file:');
+                                }
+                                else
+                                {
+                                    pt('Found in %1$s files:', $totalFiles);
+                                }
+                            ?>
             			</p>
         				<div class="files-scroller">
                 			<ul>
                 				<?php 
-                				    $locations = $string->getStrings();
+                                    $locations = $string->getStrings();
                 				    
-                    				foreach($locations as $location) 
-                    				{
-                    				    $file = $location->getSourceFile();
-                    				    $line = $location->getLine();
+                                    foreach($locations as $location) 
+                                    {
+                                        $file = $location->getSourceFile();
+                                        $line = $location->getLine();
                     				    
-                    				    $icon = '';
+                                        $icon = '';
                     				    
-                    				    $ext = \AppUtils\FileHelper::getExtension($file);
+                                        $ext = \AppUtils\FileHelper::getExtension($file);
                     				    
-                    				    if($ext == 'php') {
-                    				        $icon = 'fab fa-php';
-                    				    } else if($ext == 'js') {
-                    				        $icon = 'fab fa-js-square';
-                    				    } else {
-                    				        $icon = 'fas fa-file-code';
-                    				    }
+                                        if($ext == 'php') {
+                                            $icon = 'fab fa-php';
+                                        } else if($ext == 'js') {
+                                            $icon = 'fab fa-js-square';
+                                        } else {
+                                            $icon = 'fas fa-file-code';
+                                        }
                     				    
-                    				    ?>
+                                        ?>
                     				    	<li>
                     				    		<i class="<?php echo $icon ?>"></i>
                     				    		<?php echo $file ?><span class="line-number">:<?php echo $line ?></span>
                     				    	</li>
                     				    <?php 
-                    				}
-                				?>
+                                    }
+                                ?>
                 			</ul>
             			</div>
         			</div>
@@ -867,13 +867,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);
@@ -890,27 +890,27 @@ 
         return t('Localization editor');
     }
 
-   /**
-    * Selects the default source to use if none has been 
-    * explicitly selected.
-    * 
-    * @param string $sourceID
-    */
+    /**
+     * Selects the default source to use if none has been 
+     * explicitly selected.
+     * 
+     * @param string $sourceID
+     */
     public function selectDefaultSource(string $sourceID) : Localization_Editor
     {
         $this->setOption('default-source', $sourceID);
         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/Editor/Filters.php

Indentation +49 added lines, -49 removed lines

@@ -6,20 +6,20 @@ 
 
 class Localization_Editor_Filters
 {
-   /**
-    * @var Localization_Editor
-    */
+    /**
+     * @var Localization_Editor
+     */
     protected $editor;
     
-   /**
-    * @var \AppUtils\Request
-    */
+    /**
+     * @var \AppUtils\Request
+     */
     
     protected $request; 
      
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sessionName = 'localize_filters';
     
     protected $vars = array(
@@ -174,13 +174,13 @@ 
             <form class="form-inline">
             	<div class="form-hiddens">
             		<?php 
-    					$params = $this->editor->getRequestParams();
-    					foreach($params as $name => $value) {
-    					    ?>
+                        $params = $this->editor->getRequestParams();
+                        foreach($params as $name => $value) {
+                            ?>
     					    	<input type="hidden" name="<?php echo $name ?>" value="<?php echo $value ?>">
     					    <?php 
-    					}
-					?>
+                        }
+                    ?>
             	</div>
             	<div class="form-row">
             		<div class="col-auto">
@@ -188,42 +188,42 @@ 
     		        </div>
                     <div class="col-auto">
                     	<?php
-                    	    echo $this->renderSelect(
-                    	       $this->vars['status'],
-                    	       array(
-                        	       array(
-                        	            'value' => '',
-                        	            'label' => t('Status...')
-                        	       ),
-                        	       array(
-                        	           'value' => 'untranslated',
-                        	           'label' => t('Not translated')
-                        	       ),
-                        	       array(
-                        	           'value' => 'translated',
-                        	           'label' => t('Translated')
-                        	       )
-                    	       )
-                    	   );
+                            echo $this->renderSelect(
+                                $this->vars['status'],
+                                array(
+                                    array(
+                                        'value' => '',
+                                        'label' => t('Status...')
+                                    ),
+                                    array(
+                                        'value' => 'untranslated',
+                                        'label' => t('Not translated')
+                                    ),
+                                    array(
+                                        'value' => 'translated',
+                                        'label' => t('Translated')
+                                    )
+                                )
+                            );
                     	
-                    	   echo $this->renderSelect(
-                    	       $this->vars['location'],
-                    	       array(
-                    	           array(
-                    	               'value' => '',
-                    	               'label' => t('Location...')
-                    	           ),
-                    	           array(
-                    	               'value' => 'client',
-                    	               'label' => t('Clientside')
-                    	           ),
-                    	           array(
-                    	               'value' => 'server',
-                    	               'label' => t('Serverside')
-                    	           )
-                    	       )
-                	       );
-                    	?>
+                            echo $this->renderSelect(
+                                $this->vars['location'],
+                                array(
+                                    array(
+                                        'value' => '',
+                                        'label' => t('Location...')
+                                    ),
+                                    array(
+                                        'value' => 'client',
+                                        'label' => t('Clientside')
+                                    ),
+                                    array(
+                                        'value' => 'server',
+                                        'label' => t('Serverside')
+                                    )
+                                )
+                            );
+                        ?>
                     </div>
                     <div class="col-auto">
 	    				<button type="submit" name="<?php echo $this->vars['filter'] ?>" value="yes" class="btn btn-primary mb-2" title="<?php pt('Filter the list with the selected criteria.') ?>" data-toggle="tooltip">

src/Localization/Scanner.php

Indentation +21 added lines, -21 removed lines

@@ -4,24 +4,24 @@ 
 
 class Localization_Scanner
 {
-   /**
-    * @var float
-    */
+    /**
+     * @var float
+     */
     protected $timeStart;
     
-   /**
-    * @var float
-    */
+    /**
+     * @var float
+     */
     protected $timeEnd;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $stringInfos = array();
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $storageFile;
     
     /**
@@ -91,9 +91,9 @@ 
         \AppUtils\FileHelper::saveAsJSON($data, $this->storageFile);
     }
     
-   /**
-    * @var Localization_Parser
-    */
+    /**
+     * @var Localization_Parser
+     */
     protected $parser;
 
     public function getParser()
@@ -149,12 +149,12 @@ 
         return $this->getCollection()->countWarnings();
     }
     
-   /**
-    * Retrieves all warnings that have been registered
-    * during the last search for translateable texts.
-    * 
-    * @return \AppLocalize\Localization_Scanner_StringsCollection_Warning[]
-    */
+    /**
+     * Retrieves all warnings that have been registered
+     * during the last search for translateable texts.
+     * 
+     * @return \AppLocalize\Localization_Scanner_StringsCollection_Warning[]
+     */
     public function getWarnings()
     {
         return $this->getCollection()->getWarnings();

src/Localization/Scanner/StringsCollection/Warning.php

Indentation +3 added lines, -3 removed lines

@@ -6,9 +6,9 @@
 
 class Localization_Scanner_StringsCollection_Warning
 {
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $data;
     
     public function __construct(array $data)

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
-    */
+    /**
+     * Retrieves the translated text, if any.
+     * @return string
+     */
     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 +23 added lines, -23 removed lines

@@ -6,39 +6,39 @@
 
 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;
     
-   /**
-    * Available during scanning.
-    * @var Localization_Scanner_StringsCollection|NULL
-    */
+    /**
+     * Available during scanning.
+     * @var Localization_Scanner_StringsCollection|NULL
+     */
     protected $collection;
     
-   /**
-    * Available during scanning.
-    * @var Localization_Parser|NULL
-    */
+    /**
+     * Available during scanning.
+     * @var Localization_Parser|NULL
+     */
     protected $parser;
     
     public function __construct(string $alias, string $label, string $group, string $storageFolder)

src/Localization.php

Indentation +302 added lines, -302 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,57 +66,57 @@ 
      */
     private static $initDone = false;
 
-   /**
-    * Path to the file in which the scanner results are stored.
-    * @var string
-    * @see Localization::configure()
-    */
+    /**
+     * Path to the file in which the scanner results are stored.
+     * @var string
+     * @see Localization::configure()
+     */
     protected static $storageFile = '';
     
-   /**
-    * Path to the folder into which the client libraries are written.
-    * @var string
-    * @see Localization::setClientLibrariesFolder()
-    */
+    /**
+     * Path to the folder into which the client libraries are written.
+     * @var string
+     * @see Localization::setClientLibrariesFolder()
+     */
     protected static $clientFolder = '';
     
-   /**
-    * If this key changes, client libraries are refreshed.
-    * @var string
-    * @see Localization::setClientLibrariesCacheKey()
-    */
+    /**
+     * If this key changes, client libraries are refreshed.
+     * @var string
+     * @see Localization::setClientLibrariesCacheKey()
+     */
     protected static $clientCacheKey = '';
     
-   /**
-    * Whether the configuration has been made.
-    * @var bool
-    * @see Localization::configure()
-    */
+    /**
+     * Whether the configuration has been made.
+     * @var bool
+     * @see Localization::configure()
+     */
     protected static $configured = false;
     
-   /**
-    * Stores event listener instances.
-    * @var array
-    */
+    /**
+     * Stores event listener instances.
+     * @var array
+     */
     protected static $listeners = array();
     
-   /**
-    * @var integer
-    * @see Localization::addEventListener()
-    */
+    /**
+     * @var integer
+     * @see Localization::addEventListener()
+     */
     protected static $listenersCounter = 0;
     
-   /**
-    * @var Localization_Translator|NULL
-    */
+    /**
+     * @var Localization_Translator|NULL
+     */
     protected static $translator;
     
-   /**
-    * Initializes the localization layer. This is done
-    * automatically, and only once per request.
-    * 
-    * (Called at the end of this file)
-    */
+    /**
+     * Initializes the localization layer. This is done
+     * automatically, and only once per request.
+     * 
+     * (Called at the end of this file)
+     */
     public static function init() : void
     {
         if(self::$initDone) {
@@ -155,12 +155,12 @@ 
         return self::getLocalesByNS(self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Retrieves all locales in the specified namespace.
-    * 
-    * @param string $namespace
-    * @return Localization_Locale[]
-    */
+    /**
+     * Retrieves all locales in the specified namespace.
+     * 
+     * @param string $namespace
+     * @return Localization_Locale[]
+     */
     public static function getLocalesByNS(string $namespace)
     {
         if(isset(self::$locales[$namespace])) {
@@ -177,35 +177,35 @@ 
         );
     }
     
-   /**
-    * Adds an application locale to use in the application.
-    * 
-    * @param string $localeName
-    * @return Localization_Locale
-    */
+    /**
+     * Adds an application locale to use in the application.
+     * 
+     * @param string $localeName
+     * @return Localization_Locale
+     */
     public static function addAppLocale(string $localeName) : Localization_Locale
     {
         return self::addLocaleByNS($localeName, self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Adds a content locale to use for content in the application.
-    * 
-    * @param string $localeName
-    * @return Localization_Locale
-    */
+    /**
+     * Adds a content locale to use for content in the application.
+     * 
+     * @param string $localeName
+     * @return Localization_Locale
+     */
     public static function addContentLocale(string $localeName) : Localization_Locale
     {
         return self::addLocaleByNS($localeName, self::NAMESPACE_CONTENT);
     }
     
-   /**
-    * Adds a locale to the specified namespace.
-    * 
-    * @param string $localeName
-    * @param string $namespace
-    * @return Localization_Locale
-    */
+    /**
+     * Adds a locale to the specified namespace.
+     * 
+     * @param string $localeName
+     * @param string $namespace
+     * @return Localization_Locale
+     */
     public static function addLocaleByNS(string $localeName, string $namespace) : Localization_Locale
     {
         if(!isset(self::$locales[$namespace])) {
@@ -247,11 +247,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);
@@ -288,44 +288,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);
@@ -350,20 +350,20 @@ 
         );
     }
     
-   /**
-    * Stores the selected locale names by namespace.
-    * @var array
-    */
+    /**
+     * Stores the selected locale names by namespace.
+     * @var array
+     */
     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);
@@ -399,13 +399,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;
@@ -426,14 +426,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])) {
@@ -463,43 +463,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);
@@ -533,22 +533,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);
@@ -558,7 +558,7 @@ 
         sort($names);
         
         return $names;
-     }
+        }
     
     /**
      * Checks by the locale name if the specified locale is
@@ -587,14 +587,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);
@@ -654,10 +654,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;
@@ -724,29 +724,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);
@@ -781,26 +781,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;
@@ -832,10 +832,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();
@@ -856,11 +856,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();
@@ -873,11 +873,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();
@@ -890,13 +890,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();
@@ -942,12 +942,12 @@ 
         );
     }
     
-   /**
-    * Creates the scanner instance that is used to find
-    * all translateable strings in the application.
-    * 
-    * @return Localization_Scanner
-    */
+    /**
+     * Creates the scanner instance that is used to find
+     * all translateable strings in the application.
+     * 
+     * @return Localization_Scanner
+     */
     public static function createScanner() : Localization_Scanner
     {
         self::requireConfiguration();
@@ -960,14 +960,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;
@@ -983,17 +983,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;
@@ -1004,48 +1004,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();
@@ -1088,13 +1088,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() : Localization_Editor
     {
         self::requireConfiguration();
@@ -1102,10 +1102,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();
@@ -1132,9 +1132,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();
@@ -1166,22 +1166,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);