Level-2 / Transphporm

src/SheetLoader/SheetLoader.php

Doc Comments +12 added lines

@@ -42,6 +42,9 @@ 
 	}
 
 
+	/**
+	 * @param \Transphporm\Template $template
+	 */
 	public function processRules($template, \Transphporm\Config $config) {
 		$rules = $this->getRules($config->getCssToXpath(), $config->getValueParser());
 
@@ -57,11 +60,20 @@ 
 	}
 
 	//Load the TSS
+
+	/**
+	 * @param \Transphporm\Parser\CssToXpath $cssToXpath
+	 * @param \Transphporm\Parser\Value $valueParser
+	 */
 	public function getRules($cssToXpath, $valueParser, $indexStart = 0) {
 		return $this->tss->getRules($cssToXpath, $valueParser, $this, $indexStart);
 	}
 
 	//Process a TSS rule e.g. `ul li {content: "foo"; format: bar}
+
+	/**
+	 * @param \Transphporm\Config $config
+	 */
 	private function executeTssRule($rule, $template, $config) {
 		$rule->touch();
 

Indentation +11 added lines, -11 removed lines

@@ -7,17 +7,17 @@
 namespace Transphporm\SheetLoader;
 //Separates out TSS file loading/caching from parsing
 class SheetLoader {
-    private $tss;
-    private $filePath;
-    private $time;
-    private $import = [];
-
-    public function __construct(\Transphporm\Cache $cache, \Transphporm\FilePath $filePath, TSSRules $tss, $time) {
-    	$this->cache = $cache;
-        $this->filePath = $filePath;
-        $this->tss = $tss;
-        $this->time = $time ?? time();
-    }
+	private $tss;
+	private $filePath;
+	private $time;
+	private $import = [];
+
+	public function __construct(\Transphporm\Cache $cache, \Transphporm\FilePath $filePath, TSSRules $tss, $time) {
+		$this->cache = $cache;
+		$this->filePath = $filePath;
+		$this->tss = $tss;
+		$this->time = $time ?? time();
+	}
 
 	//Allows controlling whether any updates are required to the template
 	//e.g. return false

Spacing +1 added lines, -1 removed lines

@@ -84,6 +84,6 @@
 
 
 	private function sortPseudo($a, $b) {
-		return count($a->pseudo) > count($b->pseudo)  ? 1 : -1;
+		return count($a->pseudo) > count($b->pseudo) ? 1 : -1;
 	}
 }

Braces +11 added lines, -4 removed lines

@@ -49,7 +49,9 @@ 
 		usort($rules, [$this, 'sortRules']);
 
 		foreach ($rules as $rule) {
-			if ($rule->shouldRun($this->time)) $this->executeTssRule($rule, $template, $config);
+			if ($rule->shouldRun($this->time)) {
+				$this->executeTssRule($rule, $template, $config);
+			}
 		}
 
 		//if (is_file($this->tss)) $this->write($this->tss, $rules, $this->import);
@@ -74,10 +76,15 @@ 
 
 	private function sortRules($a, $b) {
 		//If they have the same depth, compare on index
-		if ($a->query === $b->query) return $this->sortPseudo($a, $b);
+		if ($a->query === $b->query) {
+			return $this->sortPseudo($a, $b);
+		}
 
-		if ($a->depth === $b->depth) $property = 'index';
-		else $property = 'depth';
+		if ($a->depth === $b->depth) {
+			$property = 'index';
+		} else {
+			$property = 'depth';
+		}
 
 		return ($a->$property < $b->$property) ? -1 : 1;
 	}

src/SheetLoader/TSSFile.php

Doc Comments +4 added lines

@@ -12,6 +12,10 @@
 	private $cache;
 	private $time;
 
+	/**
+	 * @param string $fileName
+	 * @param \Transphporm\Cache $cache
+	 */
 	public function __construct($fileName, \Transphporm\FilePath $filePath, $cache, $time) {
 		$this->fileName = $fileName;
 		$this->filePath = $filePath;

Indentation +5 added lines, -5 removed lines

@@ -16,8 +16,8 @@ 
 		$this->fileName = $fileName;
 		$this->filePath = $filePath;
 		$this->cache = $cache;
-	    $this->time = $time ?? time();
-	    $this->cacheName = $this->fileName;
+		$this->time = $time ?? time();
+		$this->cacheName = $this->fileName;
 	}
 
 	private function getRulesFromCache($file) {
@@ -74,16 +74,16 @@ 
 	}
 
 	//write the sheet to cache
-    public function write($rules, $imports = []) {
+	public function write($rules, $imports = []) {
 
 		$existing = $this->cache->load($this->fileName, filemtime($this->fileName));
 		if (isset($existing['import']) && empty($imports)) $imports = $existing['import'];
 		$this->cache->write($this->cacheName, ['rules' => $rules, 'import' => $imports, 'minFreq' => $this->getMinUpdateFreq($rules), 'ctime' => $this->time, 'cacheKey' => $this->cacheKey]);
 
 		return $rules;
-    }
+	}
 
-    //Gets the minimum update-frequency for a sheet's rules
+	//Gets the minimum update-frequency for a sheet's rules
 	private function getMinUpdateFreq($rules) {
 		$min = \PHP_INT_MAX;
 

Spacing +3 added lines, -3 removed lines

@@ -41,7 +41,7 @@ 
 	}
 
 	public function updateRequired($data) {
-		$this->cacheName = $this->getCacheKey($data) . $this->fileName;
+		$this->cacheName = $this->getCacheKey($data).$this->fileName;
 
 		$rules = $this->getRulesFromCache($this->fileName, $data);
 		//Nothing was cached or the TSS file has changed, update is required
@@ -57,8 +57,8 @@ 
 		$this->getRulesFromCache($this->fileName);
 		if ($this->cacheKey) {
 			$parser = new \Transphporm\Parser\Value($data);
-			$x= $parser->parseTokens($this->cacheKey)[0];
-			$this->cacheName = $x . $this->tss;
+			$x = $parser->parseTokens($this->cacheKey)[0];
+			$this->cacheName = $x.$this->tss;
 			return $x;
 		}
 		else return '';

Braces +22 added lines, -8 removed lines

@@ -29,7 +29,9 @@ 
 		if ($rules) {
 			foreach ($rules['import'] as $file) {
 				//Check that the import file hasn't been changed since the cache was written
-				if (filemtime($file) > $rules['ctime']) return false;
+				if (filemtime($file) > $rules['ctime']) {
+					return false;
+				}
 			}
 		}
 
@@ -45,10 +47,14 @@ 
 
 		$rules = $this->getRulesFromCache($this->fileName, $data);
 		//Nothing was cached or the TSS file has changed, update is required
-		if (empty($rules)) return true;
+		if (empty($rules)) {
+			return true;
+		}
 
 		//Find the sheet's minimum update-frequency, if it hasn't passed then no updates are required
-		if ($rules['ctime']+$rules['minFreq'] <= $this->time) return true;
+		if ($rules['ctime']+$rules['minFreq'] <= $this->time) {
+			return true;
+		}
 
 		return false;
 	}
@@ -60,15 +66,19 @@ 
 			$x= $parser->parseTokens($this->cacheKey)[0];
 			$this->cacheName = $x . $this->tss;
 			return $x;
+		} else {
+			return '';
 		}
-		else return '';
 	}
 
 	public function getRules($cssToXpath, $valueParser, $sheetLoader, $indexStart) {
 		$rules = $this->getRulesFromCache($this->fileName)['rules'];
 		$this->filePath->addPath(dirname(realpath($this->fileName)));
-		if (empty($rules)) $tss = file_get_contents($this->fileName);
-		else return $rules;
+		if (empty($rules)) {
+			$tss = file_get_contents($this->fileName);
+		} else {
+			return $rules;
+		}
 
 		return $tss == null ? [] : (new \Transphporm\Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $sheetLoader))->parse($indexStart);
 	}
@@ -77,7 +87,9 @@ 
     public function write($rules, $imports = []) {
 
 		$existing = $this->cache->load($this->fileName, filemtime($this->fileName));
-		if (isset($existing['import']) && empty($imports)) $imports = $existing['import'];
+		if (isset($existing['import']) && empty($imports)) {
+			$imports = $existing['import'];
+		}
 		$this->cache->write($this->cacheName, ['rules' => $rules, 'import' => $imports, 'minFreq' => $this->getMinUpdateFreq($rules), 'ctime' => $this->time, 'cacheKey' => $this->cacheKey]);
 
 		return $rules;
@@ -89,7 +101,9 @@ 
 
 		foreach ($rules as $rule) {
 			$ruleFreq = $rule->getUpdateFrequency();
-			if ($ruleFreq < $min) $min = $ruleFreq;
+			if ($ruleFreq < $min) {
+				$min = $ruleFreq;
+			}
 		}
 
 		return $min;

src/SheetLoader/TSSString.php

Doc Comments +8 added lines

@@ -9,6 +9,9 @@ 
 	private $str;
 	private $filePath;
 
+	/**
+	 * @param string $str
+	 */
 	public function __construct($str, $filePath) {
 		$this->str = $str;
 		$this->filePath = $filePath;
@@ -22,6 +25,11 @@ 
 		return '';
 	}
 
+	/**
+	 * @param \Transphporm\Parser\CssToXpath $cssToXpath
+	 * @param \Transphporm\Parser\Value $valueParser
+	 * @param SheetLoader $sheetLoader
+	 */
 	public function getRules($cssToXpath, $valueParser, $sheetLoader, $indexStart) {
 		return (new \Transphporm\Parser\Sheet($this->str, $cssToXpath, $valueParser, $this->filePath, $sheetLoader))->parse($indexStart);
 	}

src/Builder.php

Spacing +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
 			   'headers' => array_merge($result['headers'], $headers),
 			   'body' => $this->doPostProcessing($template)->output($document)
 			];
-			$this->cache->write($tssCache->getCacheKey($data) . $this->template, $result);
+			$this->cache->write($tssCache->getCacheKey($data).$this->template, $result);
 		}
 		unset($result['cache'], $result['renderTime']);
 		return (object) $result;
@@ -82,7 +82,7 @@ 
 		$elementData = new \Transphporm\Hook\ElementData(new \SplObjectStorage(), $data);
 		$functionSet = new FunctionSet($elementData);
 		//To be a valid XML document it must have a root element, automatically wrap it in <template> to ensure it does
-		$template = new Template($this->isValidDoc($body) ? str_ireplace('<!doctype', '<!DOCTYPE', $body) : '<template>' . $body . '</template>' );
+		$template = new Template($this->isValidDoc($body) ? str_ireplace('<!doctype', '<!DOCTYPE', $body) : '<template>'.$body.'</template>');
 
 		$valueParser = new Parser\Value($functionSet);
 		$this->config = new Config($functionSet, $valueParser, $elementData, new Hook\Formatter(), new Parser\CssToXpath($functionSet, $template->getPrefix(), md5($this->tss)), $this->filePath, $headers);
@@ -106,7 +106,7 @@ 
 	}
 
     private function loadTemplateFromFile($file) {
-        $xml = $this->cache->load($this->cacheKey . $this->template, filemtime($this->template));
+        $xml = $this->cache->load($this->cacheKey.$this->template, filemtime($this->template));
         return $xml ? $xml : ['cache' => file_get_contents($this->template) ?: "", 'headers' => []];
     }
 

src/Parser/Sheet.php

Indentation +8 added lines, -8 removed lines

@@ -100,14 +100,14 @@
 
 
 	private function getProperties($tokens) {
-        $rules = $tokens->splitOnToken(Tokenizer::SEMI_COLON);
+		$rules = $tokens->splitOnToken(Tokenizer::SEMI_COLON);
 
-        $return = [];
-        foreach ($rules as $rule) {
-            $name = $rule->from(Tokenizer::NAME, true)->to(Tokenizer::COLON)->read();
-            $return[$name] = $rule->from(Tokenizer::COLON)->trim();
-        }
+		$return = [];
+		foreach ($rules as $rule) {
+			$name = $rule->from(Tokenizer::NAME, true)->to(Tokenizer::COLON)->read();
+			$return[$name] = $rule->from(Tokenizer::COLON)->trim();
+		}
 
-        return $return;
-    }
+		return $return;
+	}
 }