Level-2 / Transphporm

src/Builder.php

Doc Comments +8 added lines

@@ -62,6 +62,10 @@ 
 		return (object) $result;
 	}
 
+	/**
+	 * @param Template $template
+	 * @param Config $config
+	 */
 	private function processRules($template, $config) {
 		$rules = $this->getRules($template, $config);
 
@@ -71,6 +75,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;

src/TSSFunction/Template.php

Doc Comments +3 added lines

@@ -17,6 +17,9 @@
 		$this->xPath = $xPath;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	private function readArray($array, $index) {
 		return isset($array[$index]) ? $array[$index] : null;
 	}

src/Formatter/HTMLFormatter.php

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
         $this->templateFunction = $templateFunction;
     }
 
+    /**
+     * @param string $val
+     */
     public function html($val) {
 		return $this->templateFunction->run(['<template>' . $val . '</template>']);
 	}

src/Property/Content.php

Doc Comments +16 added lines

@@ -28,6 +28,9 @@ 
 		}
 	}
 
+	/**
+	 * @param \DOMElement $element
+	 */
 	private function shouldRun($element) {
 		do {
 			if ($element->getAttribute('transphporm') == 'includedtemplate') return false;
@@ -40,6 +43,10 @@ 
 		return (isset($rules['content-mode'])) ? $rules['content-mode']->read() : 'append';
 	}
 
+	/**
+	 * @param \DOMElement $element
+	 * @param \Transphporm\Hook\PseudoMatcher $pseudoMatcher
+	 */
 	private function processPseudo($value, $element, $pseudoMatcher) {
 		$pseudoContent = ['attr', 'header', 'before', 'after'];
 		foreach ($pseudoContent as $pseudo) {
@@ -101,6 +108,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) {
@@ -109,12 +119,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);
 	}

src/Property/Repeat.php

Doc Comments +12 added lines

@@ -11,6 +11,9 @@ 
 	private $line;
     private $filePath;
 
+	/**
+	 * @param integer $line
+	 */
 	public function __construct(\Transphporm\FunctionSet $functionSet, \Transphporm\Hook\ElementData $elementData, &$line, \Transphporm\FilePath $filePath) {
 		$this->functionSet = $functionSet;
 		$this->elementData = $elementData;
@@ -58,6 +61,12 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param \DOMElement $element
+	 * @param integer $count
+	 *
+	 * @return \DOMElement
+	 */
 	private function cloneElement($element, $iteration, $key, $count) {
 		$clone = $element->cloneNode(true);
 		$this->tagElement($clone, $count);
@@ -77,6 +86,9 @@ 
 		return isset($values[1]) ? $values[1] : PHP_INT_MAX;
 	}
 
+	/**
+	 * @param \Transphporm\Hook\PseudoMatcher $pseudoMatcher
+	 */
 	private function createHook($newRules, $pseudoMatcher, $properties) {
 		$hook = new \Transphporm\Hook\PropertyHook($newRules, $this->line, null, $this->line, $pseudoMatcher, new \Transphporm\Parser\Value($this->functionSet), $this->functionSet, $this->filePath);
 		foreach ($properties as $name => $property) $hook->registerProperty($name, $property);

src/Parser/Sheet.php

Doc Comments +16 added lines

@@ -16,6 +16,9 @@ 
 	private $filePath;
 	private $import = [];
 
+	/**
+	 * @param string $tss
+	 */
 	public function __construct($tss, CssToXpath $xPath, Value $valueParser, \Transphporm\TSSCache $cache, \Transphporm\FilePath $filePath) {
 		$this->cache = $cache;
 		$this->xPath = $xPath;
@@ -42,6 +45,9 @@ 
 		return $this->cache->write($this->file, $rules, $this->import);
 	}
 
+	/**
+	 * @param integer $indexStart
+	 */
 	private function parseTokens($indexStart) {
 		$this->rules = [];
 		foreach (new TokenFilterIterator($this->tss, [Tokenizer::WHITESPACE]) as $token) {
@@ -66,6 +72,9 @@ 
 		if (empty($rules) && count($this->tss) > 0) throw new \Exception('No TSS rules parsed');
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	private function CssToRules($selector, $index, $properties, $line) {
 		$parts = $selector->trim()->splitOnToken(Tokenizer::ARG);
 		$rules = [];
@@ -89,6 +98,9 @@ 
 		return $rules;
 	}
 
+	/**
+	 * @param integer $indexStart
+	 */
 	private function processingInstructions($token, $indexStart) {
 		if ($token['type'] !== Tokenizer::AT_SIGN) return false;
 		$tokens = $this->tss->from(Tokenizer::AT_SIGN, false)->to(Tokenizer::SEMI_COLON, false);
@@ -117,6 +129,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) {

src/Parser/ValueResult.php

Doc Comments +4 added lines

@@ -91,6 +91,10 @@
 	}
 
 	//Postprocessing - replace values with null where allowed, or override a value at position
+
+	/**
+	 * @param boolean $allowNull
+	 */
 	public function postProcess(ValueData $data, $val, $overrideVal, $allowNull) {
 		foreach ($this->getResult() as $i => $value) {
 			if (is_scalar($value)) {