Level-2 / Transphporm

src/Pseudo/Nth.php

Braces +5 added lines, -2 removed lines

@@ -15,8 +15,11 @@
 			$bracketMatcher = new \Transphporm\Parser\BracketMatcher($element->getNodePath());
 			$num = $bracketMatcher->match('[', ']');
 			
-			if (is_callable([$this, $criteria])) return $this->$criteria($num);
-			else return $num == $criteria;			
+			if (is_callable([$this, $criteria])) {
+				return $this->$criteria($num);
+			} else {
+				return $num == $criteria;
+			}
 		}
 		return true;
 	}

src/Hook/PseudoMatcher.php

Braces +12 added lines, -4 removed lines

@@ -31,7 +31,9 @@ 
 	
 	public function hasFunction($name) {
 		foreach ($this->pseudo as $pseudo) {
-			if (strpos($pseudo, $name) === 0) return true;
+			if (strpos($pseudo, $name) === 0) {
+				return true;
+			}
 		}
 	}
 
@@ -50,10 +52,16 @@ 
 		$parenthesis = strpos($pseudo, '(');
 		$square = strpos($pseudo, ']');
 
-		if ($parenthesis === false) $parenthesis = 999;
-		if ($square === false) $square = 999;
+		if ($parenthesis === false) {
+			$parenthesis = 999;
+		}
+		if ($square === false) {
+			$square = 999;
+		}
 
-		if ($parenthesis < $square) return ['(', ')'];
+		if ($parenthesis < $square) {
+			return ['(', ')'];
+		}
 		return ['[', ']'];
 	}
 	

src/Pseudo/Not.php

Braces +3 added lines, -1 removed lines

@@ -30,7 +30,9 @@
 			//Find all nodes matched by the expressions in the brackets :not(EXPR)
 			foreach ($xpath->query($xpathString) as $matchedElement) {
 				//Check to see whether this node was matched by the not query
-				if ($element->isSameNode($matchedElement)) return false;
+				if ($element->isSameNode($matchedElement)) {
+					return false;
+				}
 			}
 		}
 		return true;

src/Parser/Sheet.php

Doc Comments +19 added lines

@@ -12,6 +12,9 @@ 
 	private $prefix;
 	private $valueParser;
 
+	/**
+	 * @param string $tss
+	 */
 	public function __construct($tss, $baseDir, Value $valueParser, $prefix = '') {
 		$this->tss = $this->stripComments($tss, '/*', '*/');
 		$this->tss = $this->stripComments($this->tss, '//', "\n");
@@ -38,6 +41,10 @@ 
 		return $rules;
 	}
 
+	/**
+	 * @param string $selector
+	 * @param integer $index
+	 */
 	private function CssToRules($selector, $index, $properties) {
 		$parts = explode(',', $selector);
 		$rules = [];
@@ -60,6 +67,11 @@ 
 		return $rules;
 	}
 
+	/**
+	 * @param integer $pos
+	 * @param integer $next
+	 * @param integer $indexStart
+	 */
 	private function processingInstructions($tss, $pos, $next, $indexStart) {
 		$rules = [];
 		while (($atPos = strpos($tss, '@', $pos)) !== false) {
@@ -90,6 +102,10 @@ 
 		return ($a->depth < $b->depth) ? -1 : 1;
 	}
 
+	/**
+	 * @param string $open
+	 * @param string $close
+	 */
 	private function stripComments($str, $open, $close) {
 		$pos = 0;
 		while (($pos = strpos($str, $open, $pos)) !== false) {
@@ -100,6 +116,9 @@ 
 		return $str;
 	}
 
+	/**
+	 * @param string $str
+	 */
 	private function getProperties($str) {
 		$stringExtractor = new StringExtractor($str);
 		$rules = explode(';', $stringExtractor);

Spacing +4 added lines, -4 removed lines

@@ -28,7 +28,7 @@ 
 			}
 
 			$selector = trim(substr($this->tss, $pos, $next-$pos));
-			$pos =  strpos($this->tss, '}', $next)+1;
+			$pos = strpos($this->tss, '}', $next)+1;
 			$newRules = $this->cssToRules($selector, count($rules)+$indexStart, $this->getProperties(trim(substr($this->tss, $next+1, $pos-2-$next))));
 			$rules = $this->writeRule($rules, $newRules);
 		}
@@ -63,7 +63,7 @@ 
 	private function processingInstructions($tss, $pos, $next, $indexStart) {
 		$rules = [];
 		while (($atPos = strpos($tss, '@', $pos)) !== false) {
-			if ($atPos  <= (int) $next) {
+			if ($atPos <= (int) $next) {
 				$spacePos = strpos($tss, ' ', $atPos);
 				$funcName = substr($tss, $atPos+1, $spacePos-$atPos-1);
 				$pos = strpos($tss, ';', $spacePos);
@@ -79,9 +79,9 @@ 
 	}
 
 	private function import($args, $indexStart) {
-		if (is_file(trim($args,'\'" '))) $fileName = trim($args,'\'" ');
+		if (is_file(trim($args, '\'" '))) $fileName = trim($args, '\'" ');
 		else $fileName = $this->valueParser->parse($args)[0];
-		$sheet = new Sheet(file_get_contents($this->baseDir . $fileName), $this->baseDir, $this->valueParser, $this->prefix);
+		$sheet = new Sheet(file_get_contents($this->baseDir.$fileName), $this->baseDir, $this->valueParser, $this->prefix);
 		return $sheet->parse(0, [], $indexStart);
 	}
 

Braces +18 added lines, -8 removed lines

@@ -33,7 +33,9 @@ 
 			$rules = $this->writeRule($rules, $newRules);
 		}
 		//there may be processing instructions at the end
-		if ($processing = $this->processingInstructions($this->tss, $pos, strlen($this->tss), count($rules)+$indexStart)) $rules = array_merge($rules, $processing['rules']);
+		if ($processing = $this->processingInstructions($this->tss, $pos, strlen($this->tss), count($rules)+$indexStart)) {
+			$rules = array_merge($rules, $processing['rules']);
+		}
 		usort($rules, [$this, 'sortRules']);
 		return $rules;
 	}
@@ -69,8 +71,7 @@ 
 				$pos = strpos($tss, ';', $spacePos);
 				$args = substr($tss, $spacePos+1, $pos-$spacePos-1);
 				$rules = array_merge($rules, $this->$funcName($args, $indexStart));
-			}
-			else {
+			} else {
 				break;	
 			} 
 		}
@@ -79,15 +80,20 @@ 
 	}
 
 	private function import($args, $indexStart) {
-		if (is_file(trim($args,'\'" '))) $fileName = trim($args,'\'" ');
-		else $fileName = $this->valueParser->parse($args)[0];
+		if (is_file(trim($args,'\'" '))) {
+			$fileName = trim($args,'\'" ');
+		} else {
+			$fileName = $this->valueParser->parse($args)[0];
+		}
 		$sheet = new Sheet(file_get_contents($this->baseDir . $fileName), $this->baseDir, $this->valueParser, $this->prefix);
 		return $sheet->parse(0, [], $indexStart);
 	}
 
 	private function sortRules($a, $b) {
 		//If they have the same depth, compare on index
-		if ($a->depth === $b->depth) return $a->index < $b->index ? -1 : 1;
+		if ($a->depth === $b->depth) {
+			return $a->index < $b->index ? -1 : 1;
+		}
 
 		return ($a->depth < $b->depth) ? -1 : 1;
 	}
@@ -96,7 +102,9 @@ 
 		$pos = 0;
 		while (($pos = strpos($str, $open, $pos)) !== false) {
 			$end = strpos($str, $close, $pos);
-			if ($end === false) break;
+			if ($end === false) {
+				break;
+			}
 			$str = substr_replace($str, '', $pos, $end-$pos+2);
 		}
 
@@ -109,7 +117,9 @@ 
 		$return = [];
 
 		foreach ($rules as $rule) {
-			if (trim($rule) === '') continue;
+			if (trim($rule) === '') {
+				continue;
+			}
 			$parts = explode(':', $rule, 2);
 			$parts[1] = $stringExtractor->rebuild($parts[1]);
 			$return[trim($parts[0])] = isset($parts[1]) ? trim($parts[1]) : '';

src/Builder.php

Spacing +3 added lines, -3 removed lines

@@ -49,7 +49,7 @@ 
 		
 		$cachedOutput = $this->loadTemplate();
 		//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($cachedOutput['body']) ? str_ireplace('<!doctype', '<!DOCTYPE', $cachedOutput['body']) : '<template>' . $cachedOutput['body'] . '</template>' );
+		$template = new Template($this->isValidDoc($cachedOutput['body']) ? str_ireplace('<!doctype', '<!DOCTYPE', $cachedOutput['body']) : '<template>'.$cachedOutput['body'].'</template>');
 
 		$this->processRules($template, $data, $featureSet);
 		
@@ -98,11 +98,11 @@ 
 	//N.b. only files can be cached
 	private function getRules($template, $valueParser) {		
 		if (is_file($this->tss)) {
-			$this->baseDir = dirname(realpath($this->tss)) . DIRECTORY_SEPARATOR;
+			$this->baseDir = dirname(realpath($this->tss)).DIRECTORY_SEPARATOR;
 			//The cache for the key: the filename and template prefix
 			//Each template may have a different prefix which changes the parsed TSS,
 			//Because of this the cache needs to be generated for each template prefix.
-			$key = $this->tss . $template->getPrefix() . $this->baseDir;
+			$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());

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);
+			if ($rule->shouldRun($this->time)) {
+				$this->executeTssRule($rule, $template, $valueParser, $config);
+			}
 		}
 	}
 
@@ -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) {

Doc Comments +20 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,11 @@ 
 		return (object) $result;
 	}
 
+	/**
+	 * @param Template $template
+	 * @param FunctionSet $data
+	 * @param Config $config
+	 */
 	private function processRules($template, $data, $config) {
 		$valueParser = new Parser\Value($data);
 		$rules = $this->getRules($template, $valueParser);
@@ -72,12 +80,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) {
 		$rule->touch();
 		$pseudoMatcher = $config->createPseudoMatcher($rule->pseudo);
@@ -98,6 +114,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;

src/Parser/StringExtractor.php

Spacing +2 added lines, -2 removed lines

@@ -23,8 +23,8 @@
 			$end = strpos($str, '"', $pos+1);
 			if (!$end) break;
 			while ($str[$end-1] == '\\') $end = strpos($str, '"', $end+1);
-			$strings['$___STR' . ++$num] = substr($str, $pos, $end-$pos+1);
-			$str = substr_replace($str, '$___STR' . $num, $pos, $end-$pos+1);
+			$strings['$___STR'.++$num] = substr($str, $pos, $end-$pos+1);
+			$str = substr_replace($str, '$___STR'.$num, $pos, $end-$pos+1);
 		}
 
 		return [$str, $strings];

Braces +6 added lines, -2 removed lines

@@ -21,7 +21,9 @@ 
 		$strings = [];
 		while (isset($str[$pos]) && ($pos = strpos($str, '"', $pos)) !== false) {
 			$end = strpos($str, '"', $pos+1);
-			if (!$end) break;
+			if (!$end) {
+				break;
+			}
 			$end = $this->getNextPosEscaped($str, '\\', '"', $end);
 			$strings['$___STR' . ++$num] = substr($str, $pos, $end-$pos+1);
 			$str = substr_replace($str, '$___STR' . $num, $pos, $end-$pos+1);
@@ -31,7 +33,9 @@ 
 	}
 
 	private function getNextPosEscaped($str, $escape, $chr, $start) {
-		while ($str[$start-1] == $escape) $start = strpos($str, $chr, $start+1);
+		while ($str[$start-1] == $escape) {
+			$start = strpos($str, $chr, $start+1);
+		}
 		return $start;
 	}
 

src/Module/Format.php

Spacing +2 added lines, -2 removed lines

@@ -14,8 +14,8 @@
 
 	private function getLocale() {
 		if (is_array($this->locale)) return $this->locale;
-		else if (strlen($this->locale) > 0) return json_decode(file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . '../Formatter' . DIRECTORY_SEPARATOR . 'Locale' . DIRECTORY_SEPARATOR . $this->locale . '.json'), true);
-		else return json_decode(file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . '../Formatter' . DIRECTORY_SEPARATOR . 'Locale' . DIRECTORY_SEPARATOR . 'enGB.json'), true);
+		else if (strlen($this->locale) > 0) return json_decode(file_get_contents(__DIR__.DIRECTORY_SEPARATOR.'../Formatter'.DIRECTORY_SEPARATOR.'Locale'.DIRECTORY_SEPARATOR.$this->locale.'.json'), true);
+		else return json_decode(file_get_contents(__DIR__.DIRECTORY_SEPARATOR.'../Formatter'.DIRECTORY_SEPARATOR.'Locale'.DIRECTORY_SEPARATOR.'enGB.json'), true);
 	}
 
 	public function load(\Transphporm\FeatureSet $featureSet) {

Braces +7 added lines, -3 removed lines

@@ -13,9 +13,13 @@
 	}
 
 	private function getLocale() {
-		if (is_array($this->locale)) return $this->locale;
-		else if (strlen($this->locale) > 0) return json_decode(file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . '../Formatter' . DIRECTORY_SEPARATOR . 'Locale' . DIRECTORY_SEPARATOR . $this->locale . '.json'), true);
-		else return json_decode(file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . '../Formatter' . DIRECTORY_SEPARATOR . 'Locale' . DIRECTORY_SEPARATOR . 'enGB.json'), true);
+		if (is_array($this->locale)) {
+			return $this->locale;
+		} else if (strlen($this->locale) > 0) {
+			return json_decode(file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . '../Formatter' . DIRECTORY_SEPARATOR . 'Locale' . DIRECTORY_SEPARATOR . $this->locale . '.json'), true);
+		} else {
+			return json_decode(file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . '../Formatter' . DIRECTORY_SEPARATOR . 'Locale' . DIRECTORY_SEPARATOR . 'enGB.json'), true);
+		}
 	}
 
 	public function load(\Transphporm\FeatureSet $featureSet) {

src/Property/Content.php

Doc Comments +19 added lines

@@ -11,6 +11,9 @@ 
 	private $formatter;
 
 
+	/**
+	 * @param \Transphporm\FunctionSet $data
+	 */
 	public function __construct($data, &$headers, \Transphporm\Hook\Formatter $formatter) {
 		$this->data = $data;
 		$this->headers = &$headers;
@@ -30,6 +33,9 @@ 
 		}
 	}
 
+	/**
+	 * @param \DOMElement $element
+	 */
 	private function shouldRun($element) {
 		if ($element->getAttribute('transphporm') === 'remove') return false;
 		do {
@@ -43,6 +49,10 @@ 
 		return (isset($rules['content-mode'])) ? $rules['content-mode'] : 'append';
 	}
 
+	/**
+	 * @param \DOMElement $element
+	 * @param \Transphporm\Hook\PseudoMatcher $pseudoMatcher
+	 */
 	private function processPseudo($value, $element, $pseudoMatcher) {
 		$pseudoContent = ['attr', 'header', 'before', 'after'];
 		foreach ($pseudoContent as $pseudo) {
@@ -93,6 +103,9 @@ 
 		}			 
 	}
 
+	/**
+	 * @param \DOMElement $element
+	 */
 	private function replaceContent($element, $content) {
 		//If this rule was cached, the elements that were added last time need to be removed prior to running the rule again.
 		foreach ($this->getNode($content, $element->ownerDocument) as $node) {
@@ -101,12 +114,18 @@ 
 		$element->setAttribute('transphporm', 'remove');
 	}
 
+	/**
+	 * @param \DOMElement $element
+	 */
 	private function appendContent($element, $content) {
 		foreach ($this->getNode($content, $element->ownerDocument) as $node) {
 			$element->appendChild($node);
 		}
 	}
 	
+	/**
+	 * @param \DOMElement $element
+	 */
 	private function removeAllChildren($element) {
 		while ($element->hasChildNodes()) $element->removeChild($element->firstChild);
 	}

Braces +24 added lines, -10 removed lines

@@ -18,21 +18,28 @@ 
 	}
 
 	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);
 		if (!$this->processPseudo($values, $element, $pseudoMatcher)) {
 			//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;
@@ -54,21 +61,26 @@ 
 	}
 	
 	private function getNode($node, $document) {
-		if (is_array($node[0])) $node = $node[0];
+		if (is_array($node[0])) {
+			$node = $node[0];
+		}
 		foreach ($node as $n) {
 
 			if ($n instanceof \DomElement) {
 				$new = $document->importNode($n, true);
 				//Removing this might cause problems with caching... 
 				//$new->setAttribute('transphporm', 'added');
-			}
-			else {
+			} else {
 				
 
 
-				if ($n instanceof \DomText) $n = $n->nodeValue;
+				if ($n instanceof \DomText) {
+					$n = $n->nodeValue;
+				}
 				$new = $document->createElement('text');
-				if (is_array($n)) throw new \Exception();
+				if (is_array($n)) {
+					throw new \Exception();
+				}
 				
 				$new->appendChild($document->createTextNode($n));
 				$new->setAttribute('transphporm', 'text');
@@ -114,6 +126,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/Config.php

Braces +6 added lines, -2 removed lines

@@ -35,12 +35,16 @@
 	}
 
 	public function loadProperties(Hook\PropertyHook $hook) {
-		foreach ($this->properties as $name => $property) $hook->registerProperty($name, $property);
+		foreach ($this->properties as $name => $property) {
+			$hook->registerProperty($name, $property);
+		}
 	}
 
 	public function createPseudoMatcher($pseudo) {
 		$pseudoMatcher = new Hook\PseudoMatcher($pseudo);
-		foreach ($this->pseudo as $pseudoFunction) $pseudoMatcher->registerFunction($pseudoFunction);
+		foreach ($this->pseudo as $pseudoFunction) {
+			$pseudoMatcher->registerFunction($pseudoFunction);
+		}
 		return $pseudoMatcher;
 	}
 }
\ No newline at end of file