Localization_Editor::getAppName() - Code Metrics - Inspection of "Removed unused class." - Mistralys/application-localization - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 4a5f5f...d4ccbb )

by Sebastian
created 2021-08-07 16:34 UTC
Localization_Editor::getAppName() A

↳ Parent: Localization_Editor
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	1	Features	0
Metric	Value
cc	2
eloc	4
c	2
b	1
f	0
nc	2
nop	0
dl	0
loc	8
rs	10
<?php
/**
 * File containing the {@link Localization_Editor} class.
 * 
 * @package Localization
 * @subpackage Editor
 * @see Localization_Translator
 */

declare(strict_types=1);

namespace AppLocalize;

use AppLocalize\Editor\OutputBuffering;use AppUtils\ConvertHelper;
use AppUtils\PaginationHelper;
use AppUtils\Traits_Optionable;
use AppUtils\Interface_Optionable;
use AppUtils\FileHelper;
use AppUtils\Request;

/**
 * User Interface handler for editing localization files.
 *
 * @package Localization
 * @subpackage Editor
 * @author Sebastian Mordziol <[email protected]>
 */
class Localization_Editor implements Interface_Optionable
{
    use Traits_Optionable;
    
    const MESSAGE_INFO = 'info';
    const MESSAGE_ERROR = 'danger';
    const MESSAGE_WARNING = 'warning';
    const MESSAGE_SUCCESS = 'success';
    
    const ERROR_NO_SOURCES_AVAILABLE = 40001;
    const ERROR_LOCAL_PATH_NOT_FOUND = 40002;

   /**
    * @var string
    */
    protected $installPath;
    
   /**
    * @var Localization_Source[]
    */
    protected $sources;
    
   /**
    * @var Request
    */
    protected $request;
    
   /**
    * @var Localization_Source
    */
    protected $activeSource;
    
   /**
    * @var Localization_Scanner
    */
    protected $scanner;
    
   /**
    * @var Localization_Locale[]
    */
    protected $appLocales = array();
    
   /**
    * @var Localization_Locale
    */
    protected $activeAppLocale;
    
   /**
    * @var Localization_Editor_Filters
    */
    protected $filters;

   /**
    * @var array<string,string>
    */
    protected $requestParams = array();
    
   /**
    * @var string
    */
    protected $varPrefix = 'applocalize_';

    /**
     * @var int
     */
    protected $perPage = 20;

    /**
     * @throws Localization_Exception
     * @see \AppLocalize\Localization_Editor::ERROR_LOCAL_PATH_NOT_FOUND
     */
    public function __construct()
    {
        $path = realpath(__DIR__.'/../');
        if($path === false)
        {
            throw new Localization_Exception(
                'Local path not found',
                sprintf(
                    'Could not get the parent folder\'s real path from [%s].',
                    __DIR__
                ),
                self::ERROR_LOCAL_PATH_NOT_FOUND
            );
        }

        $this->installPath = $path;
        $this->request = new Request();
        $this->scanner = Localization::createScanner();
        $this->scanner->load();

        $this->initSession();
        $this->initAppLocales();
    }
    
    public function getRequest() : Request
    {
        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
    */
    public function addRequestParam(string $name, string $value) : Localization_Editor
    {
        $this->requestParams[$name] = $value;
        return $this;
    }
    
    public function getActiveLocale() : Localization_Locale
    {
        return $this->activeAppLocale;
    }
    
    public function getActiveSource() : Localization_Source 
    {
        return $this->activeSource;
    }
    
    protected function initSession() : void
    {
        if(session_status() != PHP_SESSION_ACTIVE) {
            session_start();
        }
        
        if(!isset($_SESSION['localization_messages'])) {
            $_SESSION['localization_messages'] = array();
        }
    }
    
    public function getVarName(string $name) : string
    {
        return $this->varPrefix.$name;
    }

    /**
     * @throws Localization_Exception
     */
    protected function initSources() : void
    {
        $this->sources = Localization::getSources();
        
        if(empty($this->sources)) 
        {
            throw new Localization_Exception(
                'Cannot start editor: no sources defined.',
                null,
                self::ERROR_NO_SOURCES_AVAILABLE
            );
        }
        
        $activeID = $this->request->registerParam($this->getVarName('source'))->setEnum(Localization::getSourceIDs())->get();
        if(empty($activeID)) {
            $activeID = $this->getDefaultSourceID();
        }
        
        $this->activeSource = Localization::getSourceByID($activeID);
    }
    
    protected function getDefaultSourceID() : string
    {
        $default = $this->getOption('default-source');
        if(!empty($default) && Localization::sourceAliasExists($default)) {
            return Localization::getSourceByAlias($default)->getID();
        }
        
        return $this->sources[0]->getID();
    }
    
    protected function initAppLocales() : void
    {
        $names = array();
        
        $locales = Localization::getAppLocales();
        foreach($locales as $locale) {
            if(!$locale->isNative()) {
                $this->appLocales[] = $locale;
                $names[] = $locale->getName();
            }
        }
        
        // use the default locale if no other is available.
        if(empty($names)) {
            $this->activeAppLocale = Localization::getAppLocale();
            return;
        }
       
        $activeID = $this->request->registerParam($this->getVarName('locale'))->setEnum($names)->get();
        if(empty($activeID)) {
            $activeID = $this->appLocales[0]->getName();
        }
        
        $this->activeAppLocale = Localization::getAppLocaleByName($activeID);
        
        Localization::selectAppLocale($activeID);
    }
    
    protected function handleActions() : void
    {
        $this->initSources();
        
        $this->filters = new Localization_Editor_Filters($this);
        
        if($this->request->getBool($this->getVarName('scan'))) 
        {
            $this->executeScan();
        } 
        else if($this->request->getBool($this->getVarName('save'))) 
        {
            $this->executeSave();
        }
    }
    
    public function getScanner() : Localization_Scanner
    {
        return $this->scanner;
    }

    /**
     * @return string
     * @throws Localization_Exception
     * @see \AppLocalize\Localization_Editor::ERROR_RENDERING_FAILED
     */
    public function render() : string
    {
        $this->handleActions();
        
        $appName = $this->getAppName();
        
        OutputBuffering::start();
        
?><!doctype html>
<html lang="en">
	<head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
        <meta name="description" content="">
        <title><?php echo $appName ?></title>
        <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
        <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
        <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
        <script src="https://kit.fontawesome.com/54212b9b2b.js" crossorigin="anonymous"></script>
        <script><?php echo $this->getJavascript() ?></script>
        <style><?php echo $this->getCSS() ?></style>
	</head>
	<body>
        <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
            <a class="navbar-brand" href="<?php echo $this->getURL() ?>"><?php echo $appName ?></a>
            <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
                <span class="navbar-toggler-icon"></span>
            </button>
            <div class="collapse navbar-collapse" id="navbarsExampleDefault">
                <?php 
                    if(!empty($this->appLocales))
                    {
                        ?>
                            <ul class="navbar-nav mr-auto">
                        		<li class="nav-item dropdown">
                                    <a class="nav-link dropdown-toggle" href="#" id="dropdown01" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
                                    	<?php pt('Text sources') ?>
                                	</a>
                                    <div class="dropdown-menu" aria-labelledby="dropdown01">
                                    	<?php 
                                    	    foreach($this->sources as $source)
                                    	    {
                                    	       ?>
                                        			<a class="dropdown-item" href="<?php echo $this->getSourceURL($source) ?>">
                                        				<?php 
                                            				if($source->getID() === $this->activeSource->getID()) 
                                            				{
                                            				    ?>
                                            				    	<b><?php echo $source->getLabel() ?></b>
                                        				    	<?php 
                                            				}
                                            				else
                                            				{
                                            				    echo $source->getLabel();
                                            				}
                                        				?>
                                        				<?php
                                        				    $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">
                                    <a class="nav-link dropdown-toggle" href="#" id="dropdown01" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
                                    	<?php echo $this->activeAppLocale->getLabel() ?>
                                	</a>
                                    <div class="dropdown-menu" aria-labelledby="dropdown01">
                                    	<?php 
                                    	    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">
                    				<a href="<?php echo $this->getScanURL() ?>" class="btn btn-light btn-sm" title="<?php pt('Scan all source files to find translatable texts.') ?>" data-toggle="tooltip">
                                    	<i class="fa fa-refresh"></i>
                                    	<?php pt('Scan') ?>
                                    </a>
                    			</li>
                    			<?php 
                        			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">
                            			    			<i class="fa fa-exclamation-triangle"></i>
                            			    			<?php echo $this->scanner->countWarnings() ?>
                            			    		</span>
                        			    		</a>
                        			    	</li>
                        			    <?php 
                        			}
                    			?>
                            </ul>
                        <?php 
                    }
                ?>
                <?php 
                    $backURL = $this->getOption('back-url');
                    if(!empty($backURL)) 
                    {
                        ?>
                            <a href="<?php echo $backURL ?>" class="btn btn-light btn-sm">
                            	<i class="fas fa-arrow-circle-left"></i>
                            	<?php echo $this->getOption('back-label'); ?>
                        	</a>
                    	<?php 
                    }
            	?>
    		</div>
		</nav>
		<main role="main" class="container">
			<div>
    			<?php 
    			    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
    			    {
    			        ?>
            				<h1><?php echo $this->activeSource->getLabel() ?></h1>
            				<?php 
                				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">
                									<span aria-hidden="true">&times;</span>
            									</button>
                                        	</div>
            				        	<?php 
                				    }
                				    
                				    // 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>'
                                    );
            				    ?><br>
            					<?php pt('Found %1$s texts to translate.', $this->activeSource->countUntranslated($this->scanner)) ?>
            				</p>
            				<br>
            				<?php
                				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.') ?>
                                        </div>
                                        <p>
                                            <a href="<?php echo $this->getScanURL() ?>" class="btn btn-primary">
                                            	<i class="fa fa-refresh"></i>
                                            	<?php pt('Scan files now') ?>
                                            </a>
                                        </p>
                				    <?php 
                				}
                				else
                				{
                				    echo $this->filters->renderForm();

                				    $this->displayList();
                				}
        				}
    				?>
			</div>
		</main>
	</body>
</html>
<?php

        return OutputBuffering::getClean();
    }

    protected function renderWarnings() : string
    {
        OutputBuffering::start();

        ?>
        	<h1><?php pt('Warnings') ?></h1>
        	<p class="abstract">
        		<?php 
        		    pts('The following shows all texts where the system decided that they cannot be translated.');
       		    ?>
        	</p>
        	<dl>
        		<?php 
        		    $warnings = $this->scanner->getWarnings();
        		    
        		    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 

        return OutputBuffering::getClean();
    }

    /**
     * @return Localization_Scanner_StringHash[]
     */
    protected function getFilteredStrings() : array
    {
        $strings = $this->activeSource->getHashes($this->scanner);
        
        $result = array();
        
        foreach($strings as $string)
        {
            if($this->filters->isStringMatch($string)) {
                $result[] = $string;
            }
        }

        return $result;
    }
    
    public function getRequestParams() : array
    {
        $params = $this->requestParams;
        $params[$this->getVarName('locale')] = $this->activeAppLocale->getName();
        $params[$this->getVarName('source')] = $this->activeSource->getID();
        $params[$this->getVarName('page')] = $this->getPage();

        return $params;
    }
    
    protected function getPage() : int
    {
        return intval($this->request
            ->registerParam($this->getVarName('page'))
            ->setInteger()
            ->get(0)
        );
    }
    
    protected function displayList() : void
    {
        $strings = $this->getFilteredStrings();
        
        if(empty($strings))
        {
            ?>
            	<div class="alert alert-info">
            		<?php pt('No matching strings found.') ?>
            	</div>
            <?php 
            
            return;
        }
        
        $total = count($strings);
        $page = $this->getPage();
        $pager = new PaginationHelper($total, $this->perPage, $page);
        
        $keep = array_slice($strings, $pager->getOffsetStart(), $this->perPage);
        
        ?>
			<form method="post">
				<div class="form-hiddens">
					<?php 
    					$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>
    					<tr>
    						<th><?php pt('Text') ?></th>
    						<th class="align-center"><?php pt('Translated?') ?></th>
    						<th class="align-center"><?php pt('Location') ?></th>
    						<th class="align-right"><?php pt('Sources') ?></th>
    					</tr>
    				</thead>
    				<tbody>
    					<?php 
    					    foreach($keep as $string)
    					    {
    					        $this->renderListEntry($string);
    					    }
    					?>
    				</tbody>
    			</table>
    			<?php 
        			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">
                                    	<a class="page-link" href="<?php echo $prevUrl ?>">
                                    		<i class="fa fa-arrow-left"></i>
                                		</a>
                            		</li>
                            		<?php 
                            		    $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>
                                		</a>
                                	</li>
                                </ul>
                            </nav>
        			    <?php 
        			}
    			?>
				<br>
				<p>
					<button type="submit" name="<?php echo $this->getVarName('save') ?>" value="yes" class="btn btn-primary">
						<i class="fas fa-save"></i>
						<?php pt('Save now') ?>
					</button>
				</p>
			</form>
			
        <?php 
    }
    
    protected function getPaginationURL(int $page, array $params=array()) : string
    {
        $params[$this->getVarName('page')] = $page;
        
        return $this->getURL($params);
    }
    
    protected function renderListEntry(Localization_Scanner_StringHash $string) : void
    {
        $hash = $string->getHash();
        $text = $string->getText();
        
        $previewText = $string->getTranslatedText();
        if(empty($previewText)) {
            $previewText = $text->getText();
        }
        
        $shortText =  $this->renderText($previewText, 50);
        
        $files = $string->getFiles();
        
        ?>
        	<tr class="string-entry inactive" onclick="Editor.Toggle('<?php echo $hash ?>')" data-hash="<?php echo $hash ?>">
        		<td class="string-text"><?php echo $shortText ?></td>
        		<td class="align-center string-status"><?php echo $this->renderStatus($string) ?></td>
        		<td class="align-center"><?php echo $this->renderTypes($string) ?></td>
        		<td class="align-right"><?php echo $this->renderFileNames($string) ?></td>
        	</tr>
        	<tr class="string-form">
        		<td colspan="4">
        			<?php pt('Native text:') ?>
        			<p class="native-text"><?php echo $this->renderText($text->getText()) ?></p>
        			<p>
        				<textarea rows="4" class="form-control" name="<?php echo $this->getVarName('strings') ?>[<?php echo $hash ?>]"><?php echo $string->getTranslatedText() ?></textarea>
        			</p>
                    <?php
                        $explanation = $text->getExplanation();
                        if(!empty($explanation))
                        {
                            ?>
                            <p>
                                <?php pt('Context information:') ?><br>
                                <span class="native-text"><?php echo $explanation ?></span>
                            </p>
                            <?php
                        }
                    ?>
        			<p>
	        			<button type="button" class="btn btn-outline-primary btn-sm" onclick="Editor.Confirm('<?php echo $hash ?>')">
	        				<?php ptex('OK', 'Button') ?>
	        			</button>
	        			<button type="button" class="btn btn-outline-secondary btn-sm" onclick="Editor.Toggle('<?php echo $hash ?>')">
	        				<?php ptex('Cancel', 'Button') ?>
	        			</button>
        			</p>
        			<div class="files-list">
            			<p>
            				<?php 
            				    $totalFiles = count($files);
            				    
            				    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();
                				    
                    				foreach($locations as $location) 
                    				{
                    				    $file = $location->getSourceFile();
                    				    $line = $location->getLine();
                    				    
                    				    $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';
                    				    }
                    				    
                    				    ?>
                    				    	<li>
                    				    		<i class="<?php echo $icon ?>"></i>
                    				    		<?php echo $file ?><span class="line-number">:<?php echo $line ?></span>
                    				    	</li>
                    				    <?php 
                    				}
                				?>
                			</ul>
            			</div>
        			</div>
        		</td>
        	</tr>
        <?php 
    }
    
    protected function renderText(string $text, int $cutAt=0) : string
    {
        if(empty($text)) {
            return '';
        }

        if($cutAt > 0) {
            $text = ConvertHelper::text_cut($text, $cutAt);
        }

        $text = htmlspecialchars($text);
        
        $vars = $this->detectVariables($text);
        
        foreach($vars as $var) {
            $text = str_replace($var, '<span class="placeholder">'.$var.'</span>', $text);
        }
        
        return $text;
    }
    
    protected function detectVariables(string $string) : array
    {
        $result = array();
        preg_match_all('/%[0-9]+d|%s|%[0-9]+\$s/i', $string, $result, PREG_PATTERN_ORDER);

        if(isset($result[0]) && !empty($result[0])) {
            return $result[0];
        }
        
        return array();
    }
    
    protected function renderFileNames(Localization_Scanner_StringHash $hash) : string
    {
        $max = 2;
        $total = $hash->countFiles();
        $keep = $hash->getFileNames();
        $keepTotal = count($keep); // with duplicate file names, this can be less than the file total
        
        // add a counter of the additional files if the total
        // is higher than the maximum to show
        if($total > $max) 
        {
            $length = $max;
            if($length > $keepTotal) {
                $length = $keepTotal; 
            }
            
            $keep = array_slice($keep, 0, $length);
            $keep[] = '+'.($total - $length); 
        }
        
        $result = implode(', ', $keep);
        
        return $result;
    }
    
    public function display() : void
    {
        echo $this->render();
    }
    
    protected function getJavascript() : string
    {
        return FileHelper::readContents($this->installPath.'/js/editor.js');
    }
    
    protected function getCSS() : string
    {
        return FileHelper::readContents($this->installPath.'/css/editor.css');
    }
    
    public function getSourceURL(Localization_Source $source, array $params=array()) : string
    {
        $params[$this->getVarName('source')] = $source->getID();
        
        return $this->getURL($params);
    }
    
    public function getLocaleURL(Localization_Locale $locale, array $params=array()) : string
    {
        $params[$this->getVarName('locale')] = $locale->getName();
        
        return $this->getURL($params);
    }
    
    public function getScanURL() : string
    {
        return $this->getSourceURL($this->activeSource, array($this->getVarName('scan') => 'yes'));
    }
    
    public function getWarningsURL() : string
    {
        return $this->getSourceURL($this->activeSource, array($this->getVarName('warnings') => 'yes'));
    }
    
    public function getURL(array $params=array()) : string
    {
        $persist = $this->getRequestParams();
        
        foreach($persist as $name => $value) {
            if(!isset($params[$name])) {
                $params[$name] = $value;
            }
        }
        
        return '?'.http_build_query($params);
    }

    /**
     * @param string $url
     * @return never-returns

     */
    public function redirect(string $url) : void
    {
        header('Location:'.$url);
        exit;
    }
    
    protected function executeScan() : void
    {
        $this->scanner->scan();

        $this->addMessage(
            t('The source files have been analyzed successfully at %1$s.', date('H:i:s')),
            self::MESSAGE_SUCCESS
        );
        
        $this->redirect($this->getSourceURL($this->activeSource));
    }
    
    protected function executeSave() : void
    {
        $data = $_POST;
        
        $translator = Localization::getTranslator($this->activeAppLocale);
        
        $strings = $data[$this->getVarName('strings')];
        foreach($strings as $hash => $text) 
        {
            $text = trim($text);
            
            if(empty($text)) {
                continue;
            } 
            
            $translator->setTranslation($hash, $text);
        }
        
        $translator->save($this->activeSource, $this->scanner->getCollection());
        
        // refresh all the client files
        Localization::writeClientFiles(true);
        
        $this->addMessage(
            t('The texts have been updated successfully at %1$s.', date('H:i:s')),
            self::MESSAGE_SUCCESS
        );
        
        $this->redirect($this->getURL());
    }
    
    protected function renderStatus(Localization_Scanner_StringHash $hash) : string
    {
        if($hash->isTranslated()) {
            return '<i class="fa fa-check text-success"></i>';
        }        
        
        return '<i class="fa fa-ban text-danger"></i>';
    }
    
    protected function renderTypes(Localization_Scanner_StringHash $hash) : string
    {
        $types = array();
        
        if($hash->hasLanguageType('PHP')) {
            $types[] = t('Server');
        }
        
        if($hash->hasLanguageType('Javascript')) {
            $types[] = t('Client');
        }
        
        return implode(', ', $types);
    }
    
    protected function addMessage(string $message, string $type=self::MESSAGE_INFO) : void
    {
        $_SESSION['localization_messages'][] = array(
            'text' => $message,
            'type' => $type
        );
    }

    /**
     * @return array<string,string>
     */
    public function getDefaultOptions() : array
    {
        return array(
            'appname' => '',
            'default-source' => '',
            'back-url' => '',
            'back-label' => ''
        );
    }
    
   /**
    * 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);
        return $this;
    }
    
    public function getAppName() : string
    {
        $name = $this->getOption('appname');
        if(!empty($name)) {
            return $name;
        }
        
        return t('Localization editor');
    }

    /**
     * Selects the default source to use if none has been
     * explicitly selected.
     *
     * @param string $sourceID
     * @return Localization_Editor
     */
    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
    */
    public function setBackURL(string $url, string $label) : Localization_Editor
    {
        $this->setOption('back-url', $url);
        $this->setOption('back-label', $label);
        return $this;
    }
}

Mistralys / application-localization

Push — master ( 4a5f5f...d4ccbb )

Localization_Editor::getAppName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
