AppLocalize\Localization_Scanner_StringHash

Complexity

Total Complexity

28

Size/Duplication

Total Lines	195
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getFileNames()	0	12	2
A	getSearchString()	0	7	1
A	getTextAsString()	0	10	2
A	countStrings()	0	3	1
A	toArray()	0	9	2
A	getText()	0	7	2
A	getStrings()	0	3	1
A	isTranslated()	0	4	1
A	__construct()	0	4	1
A	countFiles()	0	11	3
A	getHash()	0	3	1
A	hasSourceID()	0	3	1
A	hasLanguageType()	0	9	3
A	getTranslatedText()	0	10	2
A	addString()	0	6	1
A	getFiles()	0	19	4

<?php

namespace AppLocalize;

use AppLocalize\Parser\Text;

/**
 * Container for a single string hash: collects all instances
 * of the same string hash accross all places where the same
 * string has been found.
 * 
 * @package Localization
 * @subpackage Scanner
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Localization_Scanner_StringHash
{
   /**
    * @var Localization_Scanner_StringsCollection
    */
    protected $collection;
    
   /**
    * @var string
    */
    protected $hash;
    
   /**
    * @var Localization_Scanner_StringInfo[]
    */
    protected $strings = array();

    /**
     * @var array<string,bool>
     */
    protected $sourceIDs = array();
    
    public function __construct(Localization_Scanner_StringsCollection $collection, string $hash)
    {
        $this->collection = $collection;
        $this->hash = $hash;
    }
    
    public function addString(Localization_Scanner_StringInfo $string) : Localization_Scanner_StringHash
    {
        $this->strings[] = $string;
        $this->sourceIDs[$string->getSourceID()] = true;
        
        return $this;
    }
    
    public function toArray() : array
    {
        $entries = array();
       
        foreach($this->strings as $string) {
            $entries[] = $string->toArray();
        }
        
        return $entries;
    }
    
   /**
    * Retrieves all individual string locations where this text was found.
    * @return Localization_Scanner_StringInfo[]
    */
    public function getStrings() : array
    {
        return $this->strings;
    }
    
    public function countFiles() : int
    {
        $amount = 0;
        
        foreach($this->strings as $string) {
            if($string->isFile()) {
                $amount++;
            }
        }
        
        return $amount;
    }
    
    public function hasSourceID(string $id) : bool
    {
        return isset($this->sourceIDs[$id]);
    }
    
    public function hasLanguageType(string $type) : bool
    {
        foreach($this->strings as $string) {
            if($string->getLanguageType() == $type) {
                return true;
            }
        }
        
        return false;
    }
    
    public function getText() : ?Text
    {
        if(isset($this->strings[0])) {
            return $this->strings[0]->getText();
        }
        
        return null;
    }
    
    public function getHash() : string
    {
        return $this->hash;
    }
    
    public function isTranslated() : bool
    {
        $translator = Localization::getTranslator();
        return $translator->hashExists($this->getHash());
    }
    
    public function countStrings() : int
    {
        return count($this->strings);
    }
    
   /**
    * Retrieves the translated text, if any.
    * @return string
    */
    public function getTranslatedText() : string
    {
        $translator = Localization::getTranslator();
        $text = $translator->getHashTranslation($this->getHash());
        
        if($text !== null) {
            return $text;
        }
        
        return '';
    }
    
   /**
    * Retrieves a list of all file names, with relative paths.
    * @return string[]
    */
    public function getFiles() : array
    {
        $files = array();
        
        foreach($this->strings as $string) 
        {
            if(!$string->isFile()) {
                continue;
            }
            
            $file = $string->getSourceFile();
            if(!in_array($file, $files)) {
                $files[] = $file;
            }
        }
        
        sort($files);
        
        return $files;
    }
    
   /**
    * Retrieves a list of all file names this string is used in.
    * @return string[]
    */
    public function getFileNames() : array
    {
        $files = $this->getFiles();
        $result = array();
        
        foreach($files as $path) {
            $result[] = basename($path);
        }
        
        // some files may have the same name, there's no
        // sense in using duplicates in this context.
        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
    */
    public function getSearchString() : string
    {
        $parts = array($this->getTranslatedText(), $this->getTextAsString());
        
        $parts = array_merge($parts, $this->getFiles());
        
        return implode(' ', $parts);
    }

    public function getTextAsString() : string
    {
        $text = $this->getText();

        if($text !== null)
        {
            return $text->getText();
        }

        return '';
    }
}