Level-2 / Transphporm

src/FunctionSet.php

Braces +4 added lines, -3 removed lines

@@ -26,11 +26,12 @@
 	private function getArgs0($name, $args) {
 		if (isset($this->functions[$name]) && !($this->functions[$name] instanceof TSSFunction\Data)) {
 			$tokens = $args[0];
-			if ($tokens->count() == 0) return [];
+			if ($tokens->count() == 0) {
+				return [];
+			}
 			$parser = new \Transphporm\Parser\Value($this);
 			return $parser->parseTokens($tokens, $this->elementData->getData($this->element));
-		}
-		else {
+		} else {
 			return iterator_to_array($args[0]);
 		}
 

src/Property/Content.php

Braces +28 added lines, -13 removed lines

@@ -14,7 +14,9 @@ 
 	}
 
 	public function run(array $values, \DomElement $element, array $rules, \Transphporm\Hook\PseudoMatcher $pseudoMatcher, array $properties = []) {
-		if (!$this->shouldRun($element)) return false;
+		if (!$this->shouldRun($element)) {
+			return false;
+		}
 
 		$values = $this->formatter->format($values, $rules);
 
@@ -22,14 +24,19 @@ 
 			//Remove the current contents
 			$this->removeAllChildren($element);
 			//Now make a text node
-			if ($this->getContentMode($rules) === 'replace') $this->replaceContent($element, $values);
-			else $this->appendContent($element, $values);
+			if ($this->getContentMode($rules) === 'replace') {
+				$this->replaceContent($element, $values);
+			} else {
+				$this->appendContent($element, $values);
+			}
 		}
 	}
 
 	private function shouldRun($element) {
 		do {
-			if ($element->getAttribute('transphporm') == 'includedtemplate') return false;
+			if ($element->getAttribute('transphporm') == 'includedtemplate') {
+				return false;
+			}
 		}
 		while (($element = $element->parentNode) instanceof \DomElement);
 		return true;
@@ -56,9 +63,10 @@ 
 	public function getNode($node, $document) {
 		foreach ($node as $n) {
 			if (is_array($n)) {
-				foreach ($this->getNode($n, $document) as $new) yield $new;
-			}
-			else {
+				foreach ($this->getNode($n, $document) as $new) {
+					yield $new;
+				}
+			} else {
 				yield $this->convertNode($n, $document);
 			}
 		}
@@ -69,9 +77,10 @@ 
 			$new = $document->importNode($node, true);
 			//Removing this might cause problems with caching...
 			//$new->setAttribute('transphporm', 'added');
-		}
-		else {
-			if ($node instanceof \DomText) $node = $node->nodeValue;
+		} else {
+			if ($node instanceof \DomText) {
+				$node = $node->nodeValue;
+			}
 			$new = $document->createElement('text');
 
 			$new->appendChild($document->createTextNode($node));
@@ -82,14 +91,18 @@ 
 
 
 	private function replaceContent($element, $content) {
-		if ($element->getAttribute('transphporm') == 'added') return;
+		if ($element->getAttribute('transphporm') == 'added') {
+			return;
+		}
 		//If this rule was cached, the elements that were added last time need to be removed prior to running the rule again.
 		if ($element->getAttribute('transphporm')) {
 			$this->replaceCachedContent($element);
 		}
 
 		foreach ($this->getNode($content, $element->ownerDocument) as $node) {
-			if (!$node->getAttribute('transphporm'))  $node->setAttribute('transphporm', 'added');
+			if (!$node->getAttribute('transphporm')) {
+				$node->setAttribute('transphporm', 'added');
+			}
 			$element->parentNode->insertBefore($node, $element);
 		}
 
@@ -123,6 +136,8 @@ 
 	}
 
 	private function removeAllChildren($element) {
-		while ($element->hasChildNodes()) $element->removeChild($element->firstChild);
+		while ($element->hasChildNodes()) {
+			$element->removeChild($element->firstChild);
+		}
 	}
 }
\ No newline at end of file

src/Builder.php

Doc Comments +4 added lines

@@ -85,6 +85,10 @@
 	}
 
 	//Add a postprocessing hook. This cleans up anything transphporm has added to the markup which needs to be removed
+
+	/**
+	 * @param Template $template
+	 */
 	private function doPostProcessing($template) {
 		$template->addHook('//*[@transphporm]', new Hook\PostProcess());
 		return $template;

Braces +12 added lines, -4 removed lines

@@ -27,7 +27,9 @@ 
 		$this->cache = new Cache(new \ArrayObject());
 		$this->filePath = new FilePath();
 		$modules = is_array($modules) ? $modules : $this->defaultModules;
-		foreach ($modules as $module) $this->loadModule(new $module);
+		foreach ($modules as $module) {
+			$this->loadModule(new $module);
+		}
 	}
 
 	//Allow setting the time used by Transphporm for caching. This is for testing purposes
@@ -80,7 +82,9 @@ 
 		$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);
 
-		foreach ($this->modules as $module) $module->load($this->config);
+		foreach ($this->modules as $module) {
+			$module->load($this->config);
+		}
 		return $template;
 	}
 
@@ -94,7 +98,9 @@ 
 	//Load a template, firstly check if it's a file or a valid string
 	private function loadTemplate() {
         $result = ['cache' => $this->template, 'headers' => []];
-		if (strpos($this->template, "\n") === false && is_file($this->template)) $result = $this->loadTemplateFromFile($this->template);
+		if (strpos($this->template, "\n") === false && is_file($this->template)) {
+			$result = $this->loadTemplateFromFile($this->template);
+		}
 		return $result;
 	}
 
@@ -113,6 +119,8 @@ 
 
 	public function __destruct() {
 		//Required hack as DomXPath can only register static functions clear the statically stored instance to avoid memory leaks
-		if (isset($this->config)) $this->config->getCssToXpath()->cleanup();
+		if (isset($this->config)) {
+			$this->config->getCssToXpath()->cleanup();
+		}
 	}
 }

Indentation +8 added lines, -8 removed lines

@@ -42,9 +42,9 @@ 
 	}
 
 	public function setLocale($locale) {
-        $format = new \Transphporm\Module\Format($locale);
-        $this->modules[get_class($format)] = $format;
-    }
+		$format = new \Transphporm\Module\Format($locale);
+		$this->modules[get_class($format)] = $format;
+	}
 
 	public function addPath($dir) {
 		$this->filePath->addPath($dir);
@@ -97,15 +97,15 @@ 
 
 	//Load a template, firstly check if it's a file or a valid string
 	private function loadTemplate() {
-        $result = ['cache' => $this->template, 'headers' => []];
+		$result = ['cache' => $this->template, 'headers' => []];
 		if (strpos($this->template, "\n") === false && is_file($this->template)) $result = $this->loadTemplateFromFile($this->template);
 		return $result;
 	}
 
-    private function loadTemplateFromFile($file) {
-        $xml = $this->cache->load($this->cacheKey . $this->template, filemtime($this->template));
-        return $xml ? $xml : ['cache' => file_get_contents($this->template) ?: "", 'headers' => []];
-    }
+	private function loadTemplateFromFile($file) {
+		$xml = $this->cache->load($this->cacheKey . $this->template, filemtime($this->template));
+		return $xml ? $xml : ['cache' => file_get_contents($this->template) ?: "", 'headers' => []];
+	}
 
 	public function setCache(\ArrayAccess $cache) {
 		$this->cache = new Cache($cache);

Spacing +3 added lines, -3 removed lines

@@ -69,7 +69,7 @@ 
 			   '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;
@@ -79,7 +79,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);
@@ -103,7 +103,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/SheetLoader.php

Doc Comments +15 added lines

@@ -15,6 +15,9 @@ 
     private $rules;
     private $cacheName;
 
+    /**
+     * @param string $tss
+     */
     public function __construct(Cache $cache, FilePath $filePath, $tss, $time) {
     	$this->cache = $cache;
         $this->filePath = $filePath;
@@ -99,6 +102,9 @@ 
 		return $rules;
     }
 
+	/**
+	 * @param Template $template
+	 */
 	public function processRules($template, \Transphporm\Config $config) {
 		$rules = $this->getRules($this->tss, $config->getCssToXpath(), $config->getValueParser());
 
@@ -113,6 +119,11 @@ 
 	}
 
 	//Load the TSS
+
+	/**
+	 * @param Parser\CssToXpath $cssToXpath
+	 * @param Parser\Value $valueParser
+	 */
 	public function getRules($tss, $cssToXpath, $valueParser, $indexStart = 0) {
 		if (is_file($tss)) {
     		//$rules = $this->cache->load($tss);
@@ -124,6 +135,10 @@ 
 		return $tss == null ? [] : (new Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $this))->parse($indexStart);
 	}
 	//Process a TSS rule e.g. `ul li {content: "foo"; format: bar}
+
+	/**
+	 * @param Config $config
+	 */
 	private function executeTssRule($rule, $template, $config) {
 		$rule->touch();
 

Indentation +20 added lines, -20 removed lines

@@ -7,21 +7,21 @@ 
 namespace Transphporm;
 //Separates out TSS file loading/caching from parsing
 class SheetLoader {
-    private $cache;
-    private $sheet;
-    private $time;
-    private $import = [];
-    private $cacheKey;
-    private $rules;
-    private $cacheName;
-
-    public function __construct(Cache $cache, FilePath $filePath, $tss, $time) {
-    	$this->cache = $cache;
-        $this->filePath = $filePath;
-        $this->tss = $tss;
-        $this->time = $time ?? time();
-        $this->cacheName = $tss;
-    }
+	private $cache;
+	private $sheet;
+	private $time;
+	private $import = [];
+	private $cacheKey;
+	private $rules;
+	private $cacheName;
+
+	public function __construct(Cache $cache, FilePath $filePath, $tss, $time) {
+		$this->cache = $cache;
+		$this->filePath = $filePath;
+		$this->tss = $tss;
+		$this->time = $time ?? time();
+		$this->cacheName = $tss;
+	}
 
 	private function getRulesFromCache($file) {
 		//Try to load the cached rules, if not set in the cache (or expired) parse the supplied sheet
@@ -90,14 +90,14 @@ 
 	}
 
 	//write the sheet to cache
-    public function write($file, $rules, $imports = []) {
+	public function write($file, $rules, $imports = []) {
 		if (is_file($file)) {
 			$existing = $this->cache->load($file, filemtime($file));
 			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;
-    }
+	}
 
 	public function processRules($template, \Transphporm\Config $config) {
 		$rules = $this->getRules($this->tss, $config->getCssToXpath(), $config->getValueParser());
@@ -115,12 +115,12 @@ 
 	//Load the TSS
 	public function getRules($tss, $cssToXpath, $valueParser, $indexStart = 0) {
 		if (is_file($tss)) {
-    		//$rules = $this->cache->load($tss);
-    		$rules = $this->getRulesFromCache($tss)['rules'];
+			//$rules = $this->cache->load($tss);
+			$rules = $this->getRulesFromCache($tss)['rules'];
 			$this->filePath->addPath(dirname(realpath($tss)));
 			if (empty($rules)) $tss = file_get_contents($tss);
 			else return $rules;
-    	}
+		}
 		return $tss == null ? [] : (new Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $this))->parse($indexStart);
 	}
 	//Process a TSS rule e.g. `ul li {content: "foo"; format: bar}

Spacing +4 added lines, -4 removed lines

@@ -46,7 +46,7 @@ 
 	public function updateRequired($data) {
 		if (!is_file($this->tss)) return true;
 
-		$this->cacheName = $this->getCacheKey($data) . $this->tss;
+		$this->cacheName = $this->getCacheKey($data).$this->tss;
 
 		$rules = $this->getRulesFromCache($this->tss, $data);
 		//Nothing was cached or the TSS file has changed, update is required
@@ -82,8 +82,8 @@ 
 		if (is_file($this->tss)) $this->getRulesFromCache($this->tss);
 		if ($this->cacheKey) {
 			$parser = new 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 '';
@@ -146,6 +146,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 +42 added lines, -15 removed lines

@@ -32,7 +32,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;
+				}
 			}
 		}
 
@@ -44,16 +46,22 @@ 
 	//   2. If the data hasn't changed since the last run
 	//If this function returns false, the rendered template is sent straight from the cache skipping 99% of transphporm's code
 	public function updateRequired($data) {
-		if (!is_file($this->tss)) return true;
+		if (!is_file($this->tss)) {
+			return true;
+		}
 
 		$this->cacheName = $this->getCacheKey($data) . $this->tss;
 
 		$rules = $this->getRulesFromCache($this->tss, $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;
 	}
@@ -64,7 +72,9 @@ 
 
 		foreach ($rules as $rule) {
 			$ruleFreq = $rule->getUpdateFrequency();
-			if ($ruleFreq < $min) $min = $ruleFreq;
+			if ($ruleFreq < $min) {
+				$min = $ruleFreq;
+			}
 		}
 
 		return $min;
@@ -79,21 +89,26 @@ 
 	}
 
 	public function getCacheKey($data) {
-		if (is_file($this->tss)) $this->getRulesFromCache($this->tss);
+		if (is_file($this->tss)) {
+			$this->getRulesFromCache($this->tss);
+		}
 		if ($this->cacheKey) {
 			$parser = new Parser\Value($data);
 			$x= $parser->parseTokens($this->cacheKey)[0];
 			$this->cacheName = $x . $this->tss;
 			return $x;
+		} else {
+			return '';
 		}
-		else return '';
 	}
 
 	//write the sheet to cache
     public function write($file, $rules, $imports = []) {
 		if (is_file($file)) {
 			$existing = $this->cache->load($file, filemtime($file));
-			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;
@@ -106,10 +121,14 @@ 
 		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);
+		if (is_file($this->tss)) {
+			$this->write($this->tss, $rules, $this->import);
+		}
 	}
 
 	//Load the TSS
@@ -118,8 +137,11 @@ 
     		//$rules = $this->cache->load($tss);
     		$rules = $this->getRulesFromCache($tss)['rules'];
 			$this->filePath->addPath(dirname(realpath($tss)));
-			if (empty($rules)) $tss = file_get_contents($tss);
-			else return $rules;
+			if (empty($rules)) {
+				$tss = file_get_contents($tss);
+			} else {
+				return $rules;
+			}
     	}
 		return $tss == null ? [] : (new Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $this))->parse($indexStart);
 	}
@@ -136,10 +158,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;
 	}