Mistralys / application-localization

src/Localization/Scanner.php

Indentation +18 added lines, -18 removed lines

@@ -24,24 +24,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;
 
     /**
@@ -172,12 +172,12 @@ 
         return $this->getCollection()->countWarnings();
     }
     
-   /**
-    * Retrieves all warnings that have been registered
-    * during the last search for translatable texts.
-    * 
-    * @return Localization_Scanner_StringsCollection_Warning[]
-    */
+    /**
+     * Retrieves all warnings that have been registered
+     * during the last search for translatable texts.
+     * 
+     * @return Localization_Scanner_StringsCollection_Warning[]
+     */
     public function getWarnings() : array
     {
         return $this->getCollection()->getWarnings();

src/Localization/Writer.php

Indentation +25 added lines, -25 removed lines

@@ -20,29 +20,29 @@ 
  */
 class Localization_Writer
 {
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $editable = false;
     
-   /**
-    * @var array<string,string>
-    */
+    /**
+     * @var array<string,string>
+     */
     private $hashes = array();
     
-   /**
-    * @var Localization_Locale
-    */
+    /**
+     * @var Localization_Locale
+     */
     private $locale;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $fileType;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $filePath;
     
     public function __construct(Localization_Locale $locale, string $fileType, string $filePath)
@@ -150,16 +150,16 @@ 
         return $hashes;
     }
     
-   /**
-    * 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 int
-    */
+    /**
+     * 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 int
+     */
     public function callback_sortStrings(array $a, array $b) : int
     {
         $result = strnatcasecmp($a['text'], $b['text']);

src/Localization/Scanner/StringsCollection.php

Indentation +49 added lines, -49 removed lines

@@ -12,19 +12,19 @@ 
     
     const STORAGE_FORMAT_VERSION = 2;
     
-   /**
-    * @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)
@@ -52,12 +52,12 @@ 
         return new Localization_Scanner_StringInfo($this, $sourceID, $sourceType, $text);
     }
     
-   /**
-    * Adds a single translatable string.
-    * 
-    * @param Localization_Scanner_StringInfo $string
-    * @return Localization_Scanner_StringsCollection
-    */
+    /**
+     * Adds a single translatable string.
+     * 
+     * @param Localization_Scanner_StringInfo $string
+     * @return Localization_Scanner_StringsCollection
+     */
     protected function add(Localization_Scanner_StringInfo $string) : Localization_Scanner_StringsCollection
     {
         $hash = $string->getHash();
@@ -70,12 +70,12 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves all available translatable strings,
-    * grouped by their hash to identify unique strings.
-    * 
-    * @return Localization_Scanner_StringHash[]
-    */
+    /**
+     * Retrieves all available translatable strings,
+     * grouped by their hash to identify unique strings.
+     * 
+     * @return Localization_Scanner_StringHash[]
+     */
     public function getHashes() : array
     {
         return array_values($this->hashes);
@@ -146,32 +146,32 @@ 
         return true;
     }
     
-   /**
-    * Whether the parser reported warnings during the
-    * search for translatable texts.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the parser reported warnings during the
+     * search for translatable 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 translatable texts, if any.
-    * 
-    * @return Localization_Scanner_StringsCollection_Warning[]
-    */
+    /**
+     * Retrieves all warning messages that were added
+     * during the search for translatable texts, if any.
+     * 
+     * @return Localization_Scanner_StringsCollection_Warning[]
+     */
     public function getWarnings() : array
     {
         $result = array();
@@ -198,12 +198,12 @@ 
         return $amount;
     }
     
-   /**
-    * Retrieves all string hashed for the specified source.
-    * 
-    * @param string $id
-    * @return Localization_Scanner_StringHash[]
-    */
+    /**
+     * Retrieves all string hashed for the specified source.
+     * 
+     * @param string $id
+     * @return Localization_Scanner_StringHash[]
+     */
     public function getHashesBySourceID(string $id) : array
     {
         $hashes = array();
@@ -217,12 +217,12 @@ 
         return $hashes;
     }
     
-   /**
-    * Retrieves all hashes for the specified language ID.
-    * 
-    * @param string $languageID The language ID, e.g. "PHP"
-    * @return Localization_Scanner_StringHash[]
-    */
+    /**
+     * Retrieves all hashes for the specified language ID.
+     * 
+     * @param string $languageID The language ID, e.g. "PHP"
+     * @return Localization_Scanner_StringHash[]
+     */
     public function getHashesByLanguageID(string $languageID) : array
     {
         $hashes = array();

src/Localization/Generator.php

Indentation +25 added lines, -25 removed lines

@@ -17,24 +17,24 @@ 
     const FILES_LOCALES = 'locales';
     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;
 
     /**
@@ -119,14 +119,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();
@@ -279,11 +279,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() : void
     {
         if(file_exists($this->cacheKeyFile) && !$this->force) {

src/Localization/Editor/Filters.php

Indentation +55 added lines, -55 removed lines

@@ -23,25 +23,25 @@ 
  */
 class Localization_Editor_Filters
 {
-   /**
-    * @var Localization_Editor
-    */
+    /**
+     * @var Localization_Editor
+     */
     protected $editor;
     
-   /**
-    * @var Request
-    */
+    /**
+     * @var Request
+     */
     
     protected $request; 
      
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sessionName = 'localize_filters';
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $vars = array(
         'resetfilter' => '',
         'filter' => '',
@@ -204,13 +204,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">
@@ -218,42 +218,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">
@@ -268,9 +268,9 @@ 
             </form>
             <p>
             	<small class="text-muted"><?php 
-            	   pts('Hint:'); 
-            	   pt('Search works in translated and untranslated text, as well as the file name.') 
-        	   ?></small>
+                    pts('Hint:'); 
+                    pt('Search works in translated and untranslated text, as well as the file name.') 
+                ?></small>
             </p>
 			<br>
         <?php

src/Localization/Editor.php

Indentation +180 added lines, -180 removed lines

@@ -37,54 +37,54 @@ 
     const ERROR_NO_SOURCES_AVAILABLE = 40001;
     const ERROR_LOCAL_PATH_NOT_FOUND = 40002;
 
-   /**
-    * @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_';
 
     /**
@@ -125,15 +125,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;
@@ -295,34 +295,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 ptex('%1$s texts have not been translated in this text source.', 'Amount of texts', $untranslated) ?>"><?php echo $untranslated ?></span>)
                                 				            	<?php 
-                                        				    }
-                                    				    ?>
+                                                            }
+                                                        ?>
                                     				</a>
                                     			<?php 
-                                    	    }
-                                	    ?>
+                                            }
+                                        ?>
                                     </div>
                                 </li>
                                 <li class="nav-item dropdown">
@@ -331,15 +331,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">
@@ -349,8 +349,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 translatable texts reported warnings.'); pts('Click for details.'); ?>" data-toggle="tooltip">
@@ -360,8 +360,8 @@ 
                         			    		</a>
                         			    	</li>
                         			    <?php 
-                        			}
-                    			?>
+                                    }
+                                ?>
                             </ul>
                         <?php 
                     }
@@ -377,36 +377,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">
@@ -414,28 +414,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.') ?>
@@ -447,15 +447,15 @@ 
                                             </a>
                                         </p>
                 				    <?php 
-                				}
-                				else
-                				{
-                				    echo $this->filters->renderForm();
+                                }
+                                else
+                                {
+                                    echo $this->filters->renderForm();
 
-                				    $this->displayList();
-                				}
-        				}
-    				?>
+                                    $this->displayList();
+                                }
+                        }
+                    ?>
 			</div>
 		</main>
 	</body>
@@ -473,22 +473,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 
 
@@ -558,13 +558,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>
@@ -577,20 +577,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">
@@ -599,20 +599,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>
@@ -621,8 +621,8 @@ 
                                 </ul>
                             </nav>
         			    <?php 
-        			}
-    			?>
+                    }
+                ?>
 				<br>
 				<p>
 					<button type="submit" name="<?php echo $this->getVarName('save') ?>" value="yes" class="btn btn-primary">
@@ -693,46 +693,46 @@ 
         			<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();
                     				    
-                    				    $ext = FileHelper::getExtension($file);
+                                        $ext = 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>
@@ -949,13 +949,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);
@@ -985,15 +985,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.php

Indentation +227 added lines, -227 removed lines

@@ -53,11 +53,11 @@ 
     const EVENT_LOCALE_CHANGED = 'LocaleChanged';
 
     /**
-    * Collection of all locales by namespace (application, content, custom...). 
-    *
-    * @var array<string,array<string,Localization_Locale>>
-    * @see Localization::addLocale()
-    */
+     * Collection of all locales by namespace (application, content, custom...). 
+     *
+     * @var array<string,array<string,Localization_Locale>>
+     * @see Localization::addLocale()
+     */
     protected static $locales = array();
 
     /**
@@ -66,57 +66,57 @@ 
      */
     private static $initDone = false;
 
-   /**
-    * Path to the file in which the scanner results are stored.
-    * @var string
-    * @see Localization::configure()
-    */
+    /**
+     * Path to the file in which the scanner results are stored.
+     * @var string
+     * @see Localization::configure()
+     */
     protected static $storageFile = '';
     
-   /**
-    * Path to the folder into which the client libraries are written.
-    * @var string
-    * @see Localization::setClientLibrariesFolder()
-    */
+    /**
+     * Path to the folder into which the client libraries are written.
+     * @var string
+     * @see Localization::setClientLibrariesFolder()
+     */
     protected static $clientFolder = '';
     
-   /**
-    * If this key changes, client libraries are refreshed.
-    * @var string
-    * @see Localization::setClientLibrariesCacheKey()
-    */
+    /**
+     * If this key changes, client libraries are refreshed.
+     * @var string
+     * @see Localization::setClientLibrariesCacheKey()
+     */
     protected static $clientCacheKey = '';
     
-   /**
-    * Whether the configuration has been made.
-    * @var bool
-    * @see Localization::configure()
-    */
+    /**
+     * Whether the configuration has been made.
+     * @var bool
+     * @see Localization::configure()
+     */
     protected static $configured = false;
     
-   /**
-    * Stores event listener instances.
-    * @var array
-    */
+    /**
+     * Stores event listener instances.
+     * @var array
+     */
     protected static $listeners = array();
     
-   /**
-    * @var integer
-    * @see Localization::addEventListener()
-    */
+    /**
+     * @var integer
+     * @see Localization::addEventListener()
+     */
     protected static $listenersCounter = 0;
     
-   /**
-    * @var Localization_Translator|NULL
-    */
+    /**
+     * @var Localization_Translator|NULL
+     */
     protected static $translator;
     
-   /**
-    * Initializes the localization layer. This is done
-    * automatically, and only once per request.
-    * 
-    * (Called at the end of this file)
-    */
+    /**
+     * Initializes the localization layer. This is done
+     * automatically, and only once per request.
+     * 
+     * (Called at the end of this file)
+     */
     public static function init() : void
     {
         if(self::$initDone) {
@@ -155,12 +155,12 @@ 
         return self::getLocalesByNS(self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Retrieves all locales in the specified namespace.
-    * 
-    * @param string $namespace
-    * @return Localization_Locale[]
-    */
+    /**
+     * Retrieves all locales in the specified namespace.
+     * 
+     * @param string $namespace
+     * @return Localization_Locale[]
+     */
     public static function getLocalesByNS(string $namespace)
     {
         if(isset(self::$locales[$namespace])) {
@@ -177,35 +177,35 @@ 
         );
     }
     
-   /**
-    * Adds an application locale to use in the application.
-    * 
-    * @param string $localeName
-    * @return Localization_Locale
-    */
+    /**
+     * Adds an application locale to use in the application.
+     * 
+     * @param string $localeName
+     * @return Localization_Locale
+     */
     public static function addAppLocale(string $localeName) : Localization_Locale
     {
         return self::addLocaleByNS($localeName, self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Adds a content locale to use for content in the application.
-    * 
-    * @param string $localeName
-    * @return Localization_Locale
-    */
+    /**
+     * Adds a content locale to use for content in the application.
+     * 
+     * @param string $localeName
+     * @return Localization_Locale
+     */
     public static function addContentLocale(string $localeName) : Localization_Locale
     {
         return self::addLocaleByNS($localeName, self::NAMESPACE_CONTENT);
     }
     
-   /**
-    * Adds a locale to the specified namespace.
-    * 
-    * @param string $localeName
-    * @param string $namespace
-    * @return Localization_Locale
-    */
+    /**
+     * Adds a locale to the specified namespace.
+     * 
+     * @param string $localeName
+     * @param string $namespace
+     * @return Localization_Locale
+     */
     public static function addLocaleByNS(string $localeName, string $namespace) : Localization_Locale
     {
         if(!isset(self::$locales[$namespace])) {
@@ -343,45 +343,45 @@ 
         return self::getSelectedLocaleByNS(self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Retrieves the name of the selected application locale.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the name of the selected application locale.
+     * 
+     * @return string
+     */
     public static function getAppLocaleName() : string
     {
         return self::getLocaleNameByNS(self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Retrieves the names of the available application locales.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of the available application locales.
+     * @return string[]
+     */
     public static function getAppLocaleNames() : array
     {
         return self::getLocaleNamesByNS(self::NAMESPACE_APPLICATION);
     }
     
-   /**
-    * Retrieves the selected locale name in the specified namespace.
-    * 
-    * @param string $namespace
-    * @throws Localization_Exception
-    * @return string
-    */
+    /**
+     * Retrieves the selected locale name in the specified namespace.
+     * 
+     * @param string $namespace
+     * @throws Localization_Exception
+     * @return string
+     */
     public static function getLocaleNameByNS(string $namespace) : string
     {
         return self::getSelectedLocaleByNS($namespace)->getName();
     }
     
-   /**
-    * Retrieves the selected locale instance for the specified namespace.
-    * 
-    * @param string $namespace
-    * @return Localization_Locale
-    * @throws Localization_Exception
-    * @see Localization::ERROR_NO_LOCALE_SELECTED_IN_NS
-    */
+    /**
+     * Retrieves the selected locale instance for the specified namespace.
+     * 
+     * @param string $namespace
+     * @return Localization_Locale
+     * @throws Localization_Exception
+     * @see Localization::ERROR_NO_LOCALE_SELECTED_IN_NS
+     */
     public static function getSelectedLocaleByNS(string $namespace) : Localization_Locale
     {
         self::requireNamespace($namespace);
@@ -400,24 +400,24 @@ 
         );
     }
     
-   /**
-    * Stores the selected locale names by namespace.
-    * @var array<string,Localization_Locale>
-    */
+    /**
+     * Stores the selected locale names by namespace.
+     * @var array<string,Localization_Locale>
+     */
     protected static $selected = array();
 
-   /**
-    * Selects the active locale for the specified namespace.
-    *
-    * NOTE: Triggers the "LocaleChanged" event.
-    * 
-    * @param string $localeName
-    * @param string $namespace
-    * @return Localization_Locale
-    * @throws Localization_Exception
-    *
-    * @see Localization_Event_LocaleChanged
-    */
+    /**
+     * Selects the active locale for the specified namespace.
+     *
+     * NOTE: Triggers the "LocaleChanged" event.
+     * 
+     * @param string $localeName
+     * @param string $namespace
+     * @return Localization_Locale
+     * @throws Localization_Exception
+     *
+     * @see Localization_Event_LocaleChanged
+     */
     public static function selectLocaleByNS(string $localeName, string $namespace) : Localization_Locale
     {
         self::requireNamespace($namespace);
@@ -548,15 +548,15 @@ 
         return self::selectLocaleByNS($localeName, self::NAMESPACE_APPLICATION);
     }
 
-   /**
-    * Retrieves an application locale by its name. 
-    * Note that the locale must have been added first.
-    * 
-    * @param string $localeName
-    * @throws Localization_Exception
-    * @return Localization_Locale
-    * @see Localization::appLocaleExists()
-    */
+    /**
+     * Retrieves an application locale by its name. 
+     * Note that the locale must have been added first.
+     * 
+     * @param string $localeName
+     * @throws Localization_Exception
+     * @return Localization_Locale
+     * @see Localization::appLocaleExists()
+     */
     public static function getAppLocaleByName(string $localeName) : Localization_Locale
     {
         return self::getLocaleByNameNS($localeName, self::NAMESPACE_APPLICATION);
@@ -591,10 +591,10 @@ 
         return self::getLocalesByNS(self::NAMESPACE_CONTENT);
     }
     
-   /**
-    * Retrieves the names of all content locales that have been added.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all content locales that have been added.
+     * @return string[]
+     */
     public static function getContentLocaleNames()
     {
         return self::getLocaleNamesByNS(self::NAMESPACE_CONTENT);
@@ -617,7 +617,7 @@ 
         sort($names);
         
         return $names;
-     }
+        }
     
     /**
      * Checks by the locale name if the specified locale is
@@ -646,14 +646,14 @@ 
         return self::getLocaleByNameNS($localeName, self::NAMESPACE_CONTENT);
     }
     
-   /**
-    * Retrieves a locale by its name in the specified namespace.
-    * 
-    * @param string $localeName
-    * @param string $namespace
-    * @throws Localization_Exception
-    * @return Localization_Locale
-    */
+    /**
+     * Retrieves a locale by its name in the specified namespace.
+     * 
+     * @param string $localeName
+     * @param string $namespace
+     * @throws Localization_Exception
+     * @return Localization_Locale
+     */
     public static function getLocaleByNameNS(string $localeName, string $namespace) : Localization_Locale
     {
         self::requireNamespace($namespace);
@@ -724,10 +724,10 @@ 
         return self::selectLocaleByNS($localeName, self::NAMESPACE_CONTENT);
     }
     
-   /**
-    * Checks whether the localization has been configured entirely.
-    * @return bool
-    */
+    /**
+     * Checks whether the localization has been configured entirely.
+     * @return bool
+     */
     public static function isConfigured() : bool
     {
         return self::$configured;
@@ -799,29 +799,29 @@ 
         );
     }
     
-   /**
-    * Injects a content locales selector element into the specified
-    * HTML QuickForm2 container.
-    * 
-    * @param string $elementName
-    * @param HTML_QuickForm2_Container $container
-    * @param string $label
-    * @return HTML_QuickForm2_Element_Select
-    */
+    /**
+     * Injects a content locales selector element into the specified
+     * HTML QuickForm2 container.
+     * 
+     * @param string $elementName
+     * @param HTML_QuickForm2_Container $container
+     * @param string $label
+     * @return HTML_QuickForm2_Element_Select
+     */
     public static function injectContentLocalesSelector(string $elementName, HTML_QuickForm2_Container $container, string $label='') : HTML_QuickForm2_Element_Select
     {
         return self::injectLocalesSelectorNS($elementName, self::NAMESPACE_CONTENT, $container, $label);
     }
     
-   /**
-    * Injects an app locales selector element into the specified
+    /**
+     * Injects an app locales selector element into the specified
      * HTML QuickForm2 container.
      * 
-    * @param string $elementName
-    * @param HTML_QuickForm2_Container $container
-    * @param string $label
-    * @return HTML_QuickForm2_Element_Select
-    */
+     * @param string $elementName
+     * @param HTML_QuickForm2_Container $container
+     * @param string $label
+     * @return HTML_QuickForm2_Element_Select
+     */
     public static function injectAppLocalesSelector(string $elementName, HTML_QuickForm2_Container $container, string $label='') : HTML_QuickForm2_Element_Select
     {
         return self::injectLocalesSelectorNS($elementName, self::NAMESPACE_APPLICATION, $container, $label);
@@ -857,26 +857,26 @@ 
         return $select;
     }
 
-   /**
-    * @var Localization_Source[]
-    */
+    /**
+     * @var Localization_Source[]
+     */
     protected static $sources = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $excludeFolders = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $excludeFiles = array();
     
-   /**
-    * Retrieves all currently available sources.
-    * 
-    * @return Localization_Source[]
-    */
+    /**
+     * Retrieves all currently available sources.
+     * 
+     * @return Localization_Source[]
+     */
     public static function getSources() : array
     {
         return self::$sources;
@@ -908,10 +908,10 @@ 
         return $source;
     }
     
-   /**
-    * Retrieves all sources grouped by their group name.
-    * @return array
-    */
+    /**
+     * Retrieves all sources grouped by their group name.
+     * @return array
+     */
     public static function getSourcesGrouped()
     {
         $sources = self::getSources();
@@ -932,11 +932,11 @@ 
         return $grouped;
     }
     
-   /**
-    * Checks whether a specific source exists by its ID.
-    * @param string $sourceID
-    * @return boolean
-    */
+    /**
+     * Checks whether a specific source exists by its ID.
+     * @param string $sourceID
+     * @return boolean
+     */
     public static function sourceExists(string $sourceID) : bool
     {
         $sources = self::getSources();
@@ -949,11 +949,11 @@ 
         return false;
     }
     
-   /**
-    * Checks whether a specific source exists by its alias.
-    * @param string $sourceAlias
-    * @return boolean
-    */
+    /**
+     * Checks whether a specific source exists by its alias.
+     * @param string $sourceAlias
+     * @return boolean
+     */
     public static function sourceAliasExists(string $sourceAlias) : bool
     {
         $sources = self::getSources();
@@ -966,13 +966,13 @@ 
         return false;
     }
 
-   /**
-    * Retrieves a localization source by its ID.
-    * 
-    * @param string $sourceID
-    * @throws Localization_Exception
-    * @return Localization_Source
-    */
+    /**
+     * Retrieves a localization source by its ID.
+     * 
+     * @param string $sourceID
+     * @throws Localization_Exception
+     * @return Localization_Source
+     */
     public static function getSourceByID(string $sourceID) : Localization_Source
     {
         $sources = self::getSources();
@@ -1062,17 +1062,17 @@ 
         }
     }
     
-   /**
-    * Sets a key that is used to verify whether the client
-    * libraries have to be refreshed. A common use is to set
-    * this to the application's version number to guarantee
-    * new texts are automatically used with each release.
-    * 
-    * NOTE: Otherwise files are refreshed only when saving 
-    * them in the editor UI.
-    *  
-    * @param string $key
-    */
+    /**
+     * Sets a key that is used to verify whether the client
+     * libraries have to be refreshed. A common use is to set
+     * this to the application's version number to guarantee
+     * new texts are automatically used with each release.
+     * 
+     * NOTE: Otherwise files are refreshed only when saving 
+     * them in the editor UI.
+     *  
+     * @param string $key
+     */
     public static function setClientLibrariesCacheKey(string $key) : void
     {
         self::$clientCacheKey = $key;
@@ -1083,23 +1083,23 @@ 
         return self::$clientCacheKey;
     }
     
-   /**
-    * Sets the folder where client libraries are to be stored.
-    * @param string $folder
-    */
+    /**
+     * Sets the folder where client libraries are to be stored.
+     * @param string $folder
+     */
     public static function setClientLibrariesFolder(string $folder) : void
     {
         self::$clientFolder = $folder;
     }
     
-   /**
-    * Retrieves the path to the folder in which the client
-    * libraries should be stored.
-    * 
-    * NOTE: Can return an empty string, when this is disabled.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the path to the folder in which the client
+     * libraries should be stored.
+     * 
+     * NOTE: Can return an empty string, when this is disabled.
+     * 
+     * @return string
+     */
     public static function getClientLibrariesFolder() : string
     {
         return self::$clientFolder;
@@ -1119,13 +1119,13 @@ 
         self::createGenerator()->writeFiles($force);
     }
     
-   /**
-    * Creates a new instance of the client generator class
-    * that is used to write the localization files into the
-    * target folder on disk.
-    * 
-    * @return Localization_ClientGenerator
-    */
+    /**
+     * Creates a new instance of the client generator class
+     * that is used to write the localization files into the
+     * target folder on disk.
+     * 
+     * @return Localization_ClientGenerator
+     */
     public static function createGenerator() : Localization_ClientGenerator
     {
         return new Localization_ClientGenerator();
@@ -1190,10 +1190,10 @@ 
         return new Localization_Editor();
     }
     
-   /**
-    * Retrieves a list of all available source IDs.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all available source IDs.
+     * @return string[]
+     */
     public static function getSourceIDs() : array
     {
         $ids = array();
@@ -1220,9 +1220,9 @@ 
         return $aliases;
     }
     
-   /**
-    * Resets all locales to the built-in locale.
-    */
+    /**
+     * Resets all locales to the built-in locale.
+     */
     public static function reset() : void
     {
         self::$locales = array();
@@ -1260,12 +1260,12 @@ 
         return self::$supportedLocales;
     }
     
-   /**
-    * Checks whether the specified locale is supported.
-    * 
-    * @param string $localeName
-    * @return bool
-    */
+    /**
+     * Checks whether the specified locale is supported.
+     * 
+     * @param string $localeName
+     * @return bool
+     */
     public static function isLocaleSupported(string $localeName) : bool
     {
         return file_exists(__DIR__.'/Localization/Locale/'.$localeName.'.php');

src/Localization/Locale.php

Indentation +25 added lines, -25 removed lines

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

src/Localization/Scanner/StringHash.php

Indentation +32 added lines, -32 removed lines

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