Level-2 / Transphporm

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;

Indentation +8 added lines, -8 removed lines

@@ -41,9 +41,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);
@@ -93,15 +93,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->template, filemtime($this->template));
-        return $xml ? $xml : ['cache' => file_get_contents($this->template) ?: "", 'headers' => []];
-    }
+	private function loadTemplateFromFile($file) {
+		$xml = $this->cache->load($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 +2 added lines, -2 removed lines

@@ -52,7 +52,7 @@ 
 	public function output($data = null, $document = false) {
 		$headers = [];
 		$result = $this->loadTemplate();
-		$tssCache = new SheetLoader($this->cache,  $this->filePath, $this->tss, $this->time);
+		$tssCache = new SheetLoader($this->cache, $this->filePath, $this->tss, $this->time);
 
 		//If an update is required, run any rules that need to be run. Otherwise, return the result from cache
 		//without creating any further objects, loading a DomDocument, etc
@@ -75,7 +75,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);

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();
+		}
 	}
 }

src/SheetLoader.php

Doc Comments +15 added lines

@@ -12,6 +12,9 @@ 
     private $time;
     private $import = [];
 
+    /**
+     * @param string $tss
+     */
     public function __construct(Cache $cache, FilePath $filePath, $tss, $time) {
         $this->cache = $cache;
         $this->filePath = $filePath;
@@ -59,6 +62,9 @@ 
 		return $rules;
     }
 
+	/**
+	 * @param Template $template
+	 */
 	public function processRules($template, \Transphporm\Config $config) {
 		$rules = $this->getRules($this->tss, $config->getCssToXpath(), $config->getValueParser());
 
@@ -72,6 +78,11 @@ 
 	}
 
 	//Load the TSS
+
+	/**
+	 * @param Parser\CssToXpath $cssToXpath
+	 * @param Parser\Value $valueParser
+	 */
 	public function getRules($tss, $cssToXpath, $valueParser) {
 		if (is_file($tss)) {
     		//$rules = $this->cache->load($tss);
@@ -84,6 +95,10 @@ 
 	}
 
 	//Process a TSS rule e.g. `ul li {content: "foo"; format: bar}
+
+	/**
+	 * @param Config $config
+	 */
 	private function executeTssRule($rule, $template, $config) {
 		$rule->touch();
 

Indentation +16 added lines, -16 removed lines

@@ -7,17 +7,17 @@ 
 namespace Transphporm;
 //Separates out TSS file loading/caching from parsing
 class SheetLoader {
-    private $cache;
-    private $sheet;
-    private $time;
-    private $import = [];
-
-    public function __construct(Cache $cache, FilePath $filePath, $tss, $time) {
-        $this->cache = $cache;
-        $this->filePath = $filePath;
-        $this->tss = $tss;
-        $this->time = $time;
-    }
+	private $cache;
+	private $sheet;
+	private $time;
+	private $import = [];
+
+	public function __construct(Cache $cache, FilePath $filePath, $tss, $time) {
+		$this->cache = $cache;
+		$this->filePath = $filePath;
+		$this->tss = $tss;
+		$this->time = $time;
+	}
 
 	private function getRulesFromCache($file) {
 		//The cache for the key: the filename and template prefix
@@ -49,7 +49,7 @@ 
 		return $file . dirname(realpath($file)) . DIRECTORY_SEPARATOR;
 	}
 	//write the sheet to cache
-    public function write($file, $rules, $imports = []) {
+	public function write($file, $rules, $imports = []) {
 		if (is_file($file)) {
 			$key = $this->getCacheKey($file);
 			$existing = $this->cache->load($key, filemtime($file));
@@ -57,7 +57,7 @@ 
 			$this->cache->write($key, ['rules' => $rules, 'import' => $imports]);
 		}
 		return $rules;
-    }
+	}
 
 	public function processRules($template, \Transphporm\Config $config) {
 		$rules = $this->getRules($this->tss, $config->getCssToXpath(), $config->getValueParser());
@@ -74,12 +74,12 @@ 
 	//Load the TSS
 	public function getRules($tss, $cssToXpath, $valueParser) {
 		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 (new Parser\Sheet($tss, $cssToXpath, $valueParser, $this->filePath, $this))->parse();
 	}
 

Spacing +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
 	}
 
 	private function getCacheKey($file) {
-		return $file . dirname(realpath($file)) . DIRECTORY_SEPARATOR;
+		return $file.dirname(realpath($file)).DIRECTORY_SEPARATOR;
 	}
 	//write the sheet to cache
     public function write($file, $rules, $imports = []) {
@@ -106,6 +106,6 @@ 
 
 
 	private function sortPseudo($a, $b) {
-		return count($a->pseudo) < count($b->pseudo)  ? -1  :1;
+		return count($a->pseudo) < count($b->pseudo) ? -1 : 1;
 	}
 }