Level-2 / Transphporm

src/Builder.php

Doc Comments +20 added lines

@@ -19,6 +19,9 @@ 
 		'\\Transphporm\\Module\\Format'
 	];
 
+	/**
+	 * @param string $template
+	 */
 	public function __construct($template, $tss = '', $modules = null) {
 		$this->template = $template;
 		$this->tss = $tss;
@@ -60,6 +63,11 @@ 
 		return (object) $result;
 	}
 
+	/**
+	 * @param Template $template
+	 * @param Hook\DataFunction $data
+	 * @param FeatureSet $featureSet
+	 */
 	private function processRules($template, $data, $featureSet) {
 		$valueParser = new Parser\Value($data);
 		foreach ($this->getRules($template, $valueParser) as $rule) {
@@ -68,12 +76,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, $featureSet) {
 		$rule->touch();
 		$pseudoMatcher = new Hook\PseudoMatcher($rule->pseudo);
@@ -96,6 +112,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;

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

@@ -25,7 +25,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
@@ -44,7 +46,9 @@ 
 		$data = new Hook\DataFunction(new \SplObjectStorage(), $data, $this->baseDir);
 		$featureSet = new FeatureSet($data, new Hook\Formatter(), $headers);
 
-		foreach ($this->modules as $module) $module->load($featureSet);
+		foreach ($this->modules as $module) {
+			$module->load($featureSet);
+		}
 		//$locale = $this->getLocale();
 		
 		$cachedOutput = $this->loadTemplate();
@@ -63,7 +67,9 @@ 
 	private function processRules($template, $data, $featureSet) {
 		$valueParser = new Parser\Value($data);
 		foreach ($this->getRules($template, $valueParser) as $rule) {
-			if ($rule->shouldRun($this->time)) $this->executeTssRule($rule, $template, $valueParser, $featureSet);
+			if ($rule->shouldRun($this->time)) {
+				$this->executeTssRule($rule, $template, $valueParser, $featureSet);
+			}
 		}
 	}
 
@@ -90,8 +96,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
@@ -105,10 +112,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/FeatureSet.php

Doc Comments +6 added lines

@@ -14,6 +14,9 @@ 
 		return $this->data;
 	}
 
+	/**
+	 * @return Hook\Formatter
+	 */
 	public function getFormatter() {
 		return $this->formatter;
 	}
@@ -26,6 +29,9 @@ 
 		$this->formatter->register($formatter);
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function registerProperty($name, Property $property) {
 		$this->properties[$name] = $property;
 	}

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

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 . '../' . $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.'../'.$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 . '../' . $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 . '../' . $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) {