Level-2 / Transphporm

src/Builder.php

Doc Comments +21 added lines

@@ -20,6 +20,9 @@ 
 		'\\Transphporm\\Module\\Functions'
 	];
 
+	/**
+	 * @param string $template
+	 */
 	public function __construct($template, $tss = '', $modules = null) {
 		$this->template = $template;
 		$this->tss = $tss;
@@ -62,6 +65,12 @@ 
 		return (object) $result;
 	}
 
+	/**
+	 * @param Template $template
+	 * @param FunctionSet $data
+	 * @param Config $config
+	 * @param FunctionSet $functionSet
+	 */
 	private function processRules($template, $data, $config, $functionSet) {
 		$valueParser = new Parser\Value($data);
 		$rules = $this->getRules($template, $valueParser);
@@ -72,12 +81,20 @@ 
 	}
 
 	//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;
 	}
 
 	//Process a TSS rule e.g. `ul li {content: "foo"; format: bar}
+
+	/**
+	 * @param Parser\Value $valueParser
+	 */
 	private function executeTssRule($rule, $template, $valueParser, $config, $functionSet) {
 		$rule->touch();
 		$pseudoMatcher = $config->createPseudoMatcher($rule->pseudo);
@@ -98,6 +115,10 @@ 
 
 	//Load the TSS rules either from a file or as a string
 	//N.b. only files can be cached
+
+	/**
+	 * @param Parser\Value $valueParser
+	 */
 	private function getRules($template, $valueParser) {		
 		if (is_file($this->tss)) {
 			$this->baseDir = dirname(realpath($this->tss)) . DIRECTORY_SEPARATOR;

Braces +18 added lines, -7 removed lines

@@ -26,7 +26,9 @@ 
 		$this->cache = new Cache(new \ArrayObject());
 
 		$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
@@ -47,7 +49,9 @@ 
 		$data = new FunctionSet($elementData, $this->baseDir);
 		$config = new Config($data, $elementData, new Hook\Formatter(), $headers, $this->baseDir);
 
-		foreach ($this->modules as $module) $module->load($config);
+		foreach ($this->modules as $module) {
+			$module->load($config);
+		}
 		
 		$cachedOutput = $this->loadTemplate();
 		//To be a valid XML document it must have a root element, automatically wrap it in <template> to ensure it does
@@ -67,7 +71,9 @@ 
 		$rules = $this->getRules($template, $valueParser);
 
 		foreach ($rules as $rule) {
-			if ($rule->shouldRun($this->time)) $this->executeTssRule($rule, $template, $valueParser, $config, $functionSet);
+			if ($rule->shouldRun($this->time)) {
+				$this->executeTssRule($rule, $template, $valueParser, $config, $functionSet);
+			}
 		}
 	}
 
@@ -92,8 +98,9 @@ 
 		if (trim($this->template)[0] !== '<') {			
 			$xml = $this->cache->load($this->template, filemtime($this->template));
 			return $xml ? $xml : ['body' => file_get_contents($this->template), 'headers' => []];
+		} else {
+			return ['body' => $this->template, 'headers' => []];
 		}
-		else return ['body' => $this->template, 'headers' => []];	
 	}
 
 	//Load the TSS rules either from a file or as a string
@@ -107,10 +114,14 @@ 
 			$key = $this->tss . $template->getPrefix() . $this->baseDir;
 			//Try to load the cached rules, if not set in the cache (or expired) parse the supplied sheet
 			$rules = $this->cache->load($key, filemtime($this->tss));
-			if (!$rules) return $this->cache->write($key, (new Parser\Sheet(file_get_contents($this->tss), $this->baseDir, $valueParser, $template->getPrefix()))->parse());
-			else return $rules;
+			if (!$rules) {
+				return $this->cache->write($key, (new Parser\Sheet(file_get_contents($this->tss), $this->baseDir, $valueParser, $template->getPrefix()))->parse());
+			} else {
+				return $rules;
+			}
+		} else {
+			return (new Parser\Sheet($this->tss, $this->baseDir, $valueParser, $template->getPrefix()))->parse();
 		}
-		else return (new Parser\Sheet($this->tss, $this->baseDir, $valueParser, $template->getPrefix()))->parse();
 	}
 
 	public function setCache(\ArrayAccess $cache) {

src/Hook/PropertyHook.php

Doc Comments +6 added lines

@@ -31,6 +31,9 @@ 
 		}
 	}
 
+	/**
+	 * @param \DOMElement $element
+	 */
 	private function getArgs($value, $element) {
 		return $this->valueParser->parse($value, $element);
 	}
@@ -39,6 +42,9 @@ 
 		$this->properties[$name] = $property;
 	}
 
+	/**
+	 * @param \DOMElement $element
+	 */
 	private function callProperty($name, $element, $value) {
 		if (isset($this->properties[$name])) return $this->properties[$name]->run($value, $element, $this->rules, $this->pseudoMatcher, $this->properties);
 		return false;

src/Parser/Value.php

Braces +45 added lines, -29 removed lines

@@ -61,7 +61,9 @@ 
 		$this->data = $data;
 		$this->last = null;
 
-		if (empty($tokens)) return [$this->data];
+		if (empty($tokens)) {
+			return [$this->data];
+		}
 		
 		foreach ($tokens as $token) {
 			$this->{$this->tokenFuncs[$token['type']]}($token);	
@@ -75,27 +77,36 @@ 
 
 		if ($this->mode == Tokenizer::NOT && $token['type'] == Tokenizer::EQUALS) {
 			$this->mode = Tokenizer::NOT;
+		} else {
+			$this->mode = $token['type'];
 		}
-		else $this->mode = $token['type'];
 	}
 
 
 	//Reads the last selected value from $data regardless if it's an array or object and overrides $this->data with the new value
 	private function moveLastToData() {
-		if (isset($this->data->{$this->last})) $this->data = $this->data->{$this->last};
-		else if (is_array($this->data) && isset($this->data[$this->last])) $this->data = $this->data[$this->last];
+		if (isset($this->data->{$this->last})) {
+			$this->data = $this->data->{$this->last};
+		} else if (is_array($this->data) && isset($this->data[$this->last])) {
+			$this->data = $this->data[$this->last];
+		}
 	}
 
 	//Dot moves $data to the next object in $data foo.bar moves the $data pointer from `foo` to `bar`
 	private function processDot($token) {
-		if ($this->last !== null) $this->moveLastToData();
-		else $this->data = array_pop($this->result);
+		if ($this->last !== null) {
+			$this->moveLastToData();
+		} else {
+			$this->data = array_pop($this->result);
+		}
 
 		$this->last = null;
 	}
 
 	private function processSquareBracket($token) {
-		if ($this->last !== null) $this->moveLastToData();
+		if ($this->last !== null) {
+			$this->moveLastToData();
+		}
 
 		$parser = new Value($this->baseData, $this->autoLookup);
 		$this->last = $parser->parseTokens($token['value'], null)[0];
@@ -118,15 +129,15 @@ 
 	private function processBrackets($token) {
 		if ($this->baseData instanceof \Transphporm\Functionset && $this->baseData->hasFunction($this->last)) {
 			$this->callTransphpormFunctions($token);
-		}
-		else if ($this->data instanceof \Transphporm\Functionset) {
+		} else if ($this->data instanceof \Transphporm\Functionset) {
 			$this->result = $this->processValue($this->data->{$this->last}($token['value']));
 			$this->last = null;
-		}
-		else {
+		} else {
 			$parser = new Value($this->baseData, $this->autoLookup);
 			$args = $parser->parseTokens($token['value'], $this->data);
-			if ($args[0] == $this->data) $args = [];
+			if ($args[0] == $this->data) {
+				$args = [];
+			}
 			$funcResult = $this->callFunc($this->last, $args, $this->data);
 			$this->result = $this->processValue($funcResult);
 			$this->last = null;
@@ -137,9 +148,12 @@ 
 		$this->result = $this->processValue($this->baseData->{$this->last}($token['value']));
 		foreach ($this->result as $i => $value) {
 			if (is_array($this->data)) {
-				if (isset($this->data[$value])) $this->result[$i] = $this->data[$value];
+				if (isset($this->data[$value])) {
+					$this->result[$i] = $this->data[$value];
+				}
+			} else if (is_scalar($value) && isset($this->data->$value)) {
+				$this->result[$i] = $this->data->$value;
 			}
-			else if (is_scalar($value) && isset($this->data->$value)) $this->result[$i] = $this->data->$value;
 		}
 		$this->last = null;
 	}
@@ -149,12 +163,12 @@ 
 		if ($this->last !== null) {
 			try {
 				$this->result = $this->extractLast($this->result);
-			}
-			catch (\UnexpectedValueException $e) {
+			} catch (\UnexpectedValueException $e) {
 				if (!$this->autoLookup) {
 					$this->result = $this->processValue($this->last);
+				} else {
+					$this->result = [false];
 				}
-				else $this->result = [false];			
 			}			
 		}
 		return $this->result;
@@ -166,8 +180,7 @@ 
 	private function extractLast($result) {
 		if ($this->autoLookup && isset($this->data->{$this->last})) {
 			return $this->processValue($this->data->{$this->last});
-		}
-		else if (is_array($this->data) && isset($this->data[$this->last])) {
+		} else if (is_array($this->data) && isset($this->data[$this->last])) {
 			return $this->processValue($this->data[$this->last]);
 		}
 		throw new \UnexpectedValueException('Not found');
@@ -178,14 +191,11 @@ 
 	private function processValue($newValue) {
 		if ($this->mode == Tokenizer::ARG) {
 			$this->result[] = $newValue;
-		}
-		else if ($this->mode == Tokenizer::CONCAT) {
+		} else if ($this->mode == Tokenizer::CONCAT) {
 				$this->result[count($this->result)-1] .= $newValue;
-		}
-		else if ($this->mode == Tokenizer::NOT) {
+		} else if ($this->mode == Tokenizer::NOT) {
 			$this->result[count($this->result)-1] = $this->result[count($this->result)-1] != $newValue;
-		}
-		else if ($this->mode == Tokenizer::EQUALS) {
+		} else if ($this->mode == Tokenizer::EQUALS) {
 			$this->result[count($this->result)-1] = $this->result[count($this->result)-1] == $newValue;
 		}
 
@@ -193,12 +203,18 @@ 
 	}
 
 	private function callFunc($name, $args, $data) {
-		if ($this->data instanceof \Transphporm\FunctionSet) return $this->data->$name($args);
-		else return $this->callFuncOnObject($this->data, $name, $args);
+		if ($this->data instanceof \Transphporm\FunctionSet) {
+			return $this->data->$name($args);
+		} else {
+			return $this->callFuncOnObject($this->data, $name, $args);
+		}
 	}
 
 	private function callFuncOnObject($obj, $func, $args) {
-		if (isset($obj->$func) && is_callable($obj->$func)) return call_user_func_array($obj->$func, $args);
-		else return call_user_func_array([$obj, $func], $args);
+		if (isset($obj->$func) && is_callable($obj->$func)) {
+			return call_user_func_array($obj->$func, $args);
+		} else {
+			return call_user_func_array([$obj, $func], $args);
+		}
 	}
 }