Arlisaha / openMindParser

src/Converters/HTML/GenericHTMLConverter.php

Doc Comments +2 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
 	 * 		'icon' => boolean determining if the icons must be displayed or not,
 	 * ]. The first two are mandatory.
 	 * 
-	 * @return DOMDocument $domDocument : The DOMDocument instance created with the HTML.
+	 * @return \DOMElement $domDocument : The DOMDocument instance created with the HTML.
 	 */
 	private function buildHTMLTreeFromNode(DOMDocument $document, Node $node, array $options) {
 		$domElementA = $this->buildElement($document, $options[HTML_CONVERTER_MAIN_TAG_KEY][0]);
@@ -117,7 +117,7 @@ 
 	 * @param DOMDocument $document : The current DOMDocument in creation with the HTML tree.
 	 * @param array $description : The array describing the tag to create.
 	 * 
-	 * @return DOMElement $domElement : The created DOMElement.
+	 * @return \DOMElement $domElement : The created DOMElement.
 	 */
 	private function buildElement(DOMDocument $document, array $description) {
 		$domElement = $document->createElement($description[HTML_CONVERTER_TAG_KEY]);

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use OpenMindParser\Converters\Model\AbstractConverter;
 use OpenMindParser\Models\Document;
 use OpenMindParser\Models\Node;
-use OpenMindParser\Parser;
 use \DOMDocument;
 
 /*A singleton to convert a document tree (object Document) in a HTML tree following few options.*/

Braces +1 added lines, -2 removed lines

@@ -97,8 +97,7 @@
 			$domElementC = $this->buildElement($document, $options[HTML_CONVERTER_MAIN_TAG_KEY][2]);
 			$domElementC->appendChild($text);
 			$domElementB->appendChild($domElementC);
-		}
-		else {
+		} else {
 			$domElementB->appendChild($text);
 		}
 		

Spacing +7 added lines, -8 removed lines

@@ -131,19 +131,18 @@ 
 			]);
 		$domElementB = $this->buildElement($document, $options[self::MAIN_TAG_KEY][1]);
 		
-		if(!empty($node->getIcon()) && $options[self::MAIN_ICON_KEY][self::DISPLAY_ICON_KEY]) {
+		if (!empty($node->getIcon()) && $options[self::MAIN_ICON_KEY][self::DISPLAY_ICON_KEY]) {
 			$icon = $node->getIcon();
 			$domElementImg = $document->createElement('img');
 			
 			$iconUri = $icon->getShortUri();
-			if(array_key_exists(self::PATH_ICON_KEY, $options[self::MAIN_ICON_KEY])) {
-				if(!is_callable($callback = $options[self::MAIN_ICON_KEY][self::PATH_ICON_KEY][self::CALLBACK_PATH_ICON_KEY])) {
+			if (array_key_exists(self::PATH_ICON_KEY, $options[self::MAIN_ICON_KEY])) {
+				if (!is_callable($callback = $options[self::MAIN_ICON_KEY][self::PATH_ICON_KEY][self::CALLBACK_PATH_ICON_KEY])) {
 					throw new InvalidArgumentException('The argument with the key "'.self::CALLBACK_PATH_ICON_KEY.'" (self::CALLBACK_PATH_ICON_KEY) must be a valid callback.');
 				}
 				
 				$callBackoptions = array_key_exists(self::OPTIONS_PATH_ICON_KEY, $options[self::MAIN_ICON_KEY][self::PATH_ICON_KEY]) ?
-					$options[self::MAIN_ICON_KEY][self::PATH_ICON_KEY][self::OPTIONS_PATH_ICON_KEY] :
-					null;
+					$options[self::MAIN_ICON_KEY][self::PATH_ICON_KEY][self::OPTIONS_PATH_ICON_KEY] : null;
 				
 				$iconUri = $callback($icon->getFullName(), $callBackoptions);
 			}
@@ -154,7 +153,7 @@ 
 		}
 		
 		$text = $document->createTextNode($node->getText());
-		if(isset($options[self::MAIN_TAG_KEY][2])) {
+		if (isset($options[self::MAIN_TAG_KEY][2])) {
 			$domElementC = $this->buildElement($document, $options[self::MAIN_TAG_KEY][2]);
 			$domElementC->appendChild($text);
 			$domElementB->appendChild($domElementC);
@@ -165,7 +164,7 @@ 
 		
 		$domElementA->appendChild($domElementB);
 		
-		foreach($node->getChildren() as $child) {
+		foreach ($node->getChildren() as $child) {
 			$domElementB->appendChild($this->buildHTMLTreeFromNode($document, $child, $options));
 		}
 		
@@ -182,7 +181,7 @@ 
 	 */
 	private function buildElement(DOMDocument $document, array $description) {
 		$domElement = $document->createElement($description[self::TAG_KEY]);
-		foreach($description[self::ATTRIBUTES_KEY] as $name => $attribute) {
+		foreach ($description[self::ATTRIBUTES_KEY] as $name => $attribute) {
 			$domElement->setAttribute($name, $attribute);
 		}
 		

src/Converters/Model/AbstractConverter.php

Doc Comments -1 removed lines

@@ -38,7 +38,6 @@
 	/**
 	 * Abstract class to actually perform the conversion from the Document instance passed in parameter.
 	 * 
-	 * @param mixed $data : The data to convert. Here : a string as the file path or the Document instance.
 	 * @param array $options : An array of options for the conversion.
 	 * 
 	 * @return mixed : The result of the conversion.

Spacing +3 added lines, -3 removed lines

@@ -20,14 +20,14 @@
 	 * @return mixed : The result of the conversion.
 	 */
 	public function convert($data, $options = []) {
-		if(!is_string($data) && !($data instanceof Document)) {
+		if (!is_string($data) && !($data instanceof Document)) {
 			throw new InvalidArgumentException('The $data variable must be of type "string" (the file path), or an instance of "Document".');
 		}
-		elseif(!is_array($options)) {
+		elseif (!is_array($options)) {
 			throw new InvalidArgumentException('The $options variable must be and array.');
 		}
 		
-		if(is_string($data)) {
+		if (is_string($data)) {
 			$parser = Parser::getInstance();
 			$data = $parser->buildDocumentTreeFromFilePath($data);	
 		}

Braces +1 added lines, -2 removed lines

@@ -22,8 +22,7 @@
 	public function convert($data, $options = []) {
 		if(!is_string($data) && !($data instanceof Document)) {
 			throw new InvalidArgumentException('The $data variable must be of type "string" (the file path), or an instance of "Document".');
-		}
-		elseif(!is_array($options)) {
+		} elseif(!is_array($options)) {
 			throw new InvalidArgumentException('The $options variable must be and array.');
 		}
 		

src/Models/Node.php

Doc Comments +1 added lines, -2 removed lines

@@ -208,7 +208,7 @@ 
 	/**
 	 * Return if the current node is folded or not.
 	 * 
-	 * @return Bool $folded
+	 * @return string $folded
 	 */
 	public function isFolded() {
 		return $this->folded;
@@ -307,7 +307,6 @@ 
 	/**
 	 * Return the list of children of the current node.
 	 * 
-	 * @param NodeList $children : The list of children node.
 	 */
 	public function getChildren() {
 		return $this->children;

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use \DOMNode;
 use \DOMElement;
 use \DOMNamedNodeMap;
-use OpenMindParser\Exceptions\InvalidNodeNameException;
 
 /*Object that represent a Node as the tag element in the openMind file.*/
 class Node 

Spacing +5 added lines, -5 removed lines

@@ -357,23 +357,23 @@
 	public function toArray() {
 		$array = [];
 		$sorter = function($value, $key) use(&$array) {
-			if($value instanceof NodeList) {
+			if ($value instanceof NodeList) {
 				$newValue = [];
-				foreach($value as $node) {
+				foreach ($value as $node) {
 					$newValue[] = $node->toArray();
 				}
 				$value = $newValue;
 			}
-			elseif($value instanceof Icon) {
+			elseif ($value instanceof Icon) {
 				$value = $value->getFilePath();
 			}
-			elseif($value instanceof DOMElement) {
+			elseif ($value instanceof DOMElement) {
 				return;
 			}
 			$array[$key] = $value;
 		};
 		
-		foreach(get_object_vars($this) as $key => $value) {
+		foreach (get_object_vars($this) as $key => $value) {
 			$sorter($value, $key);
 		}
 		

Braces +2 added lines, -4 removed lines

@@ -363,11 +363,9 @@
 					$newValue[] = $node->toArray();
 				}
 				$value = $newValue;
-			}
-			elseif($value instanceof Icon) {
+			} elseif($value instanceof Icon) {
 				$value = $value->getFilePath();
-			}
-			elseif($value instanceof DOMElement) {
+			} elseif($value instanceof DOMElement) {
 				return;
 			}
 			$array[$key] = $value;

src/Parser.php

Doc Comments +1 added lines, -1 removed lines

@@ -118,7 +118,7 @@
 	/**
 	 * For each attribute whom the name is the keys of $availableAttributes, its value will be put in the matching attribute.
 	 * 
-	 * @param DOMNamedNodeMap $nodeAttributes : The list of attributes of the current node to fill the Node object.
+	 * @param DOMNamedNodeMap $nodeAtributes : The list of attributes of the current node to fill the Node object.
 	 * @param array $availableAttributes : One of the static array of this class to describe the list of known attributes.
 	 * @param Node $node : The Node object to fill in.
 	 */

Spacing +11 added lines, -11 removed lines

@@ -62,7 +62,7 @@ 
 	 * @return Document : The document instance with all its nodes instances.
 	 */
 	public function buildDocumentTreeFromFilePath($filePath) {
-		if(!file_exists($filePath)) {
+		if (!file_exists($filePath)) {
 			throw new InvalidArgumentException('The given path : "'.$filePath.'" is invalid.');
 		}
 		
@@ -84,7 +84,7 @@ 
 	 */
 	private function fillNode(DOMElement $domNode) {
 		//The given node name must be self::NODE_NODENAME
-		if($domNode->nodeName !== self::NODE_NODENAME) {
+		if ($domNode->nodeName !== self::NODE_NODENAME) {
 			throw new InvalidNodeNameException('The node name must be "node". "'.$domNode->nodeName.'" given.');
 		}
 		
@@ -94,16 +94,16 @@ 
 		
 		//Build the list of children nodes and fill font information.
 		$children = new NodeList();
-		foreach($domNode->childNodes as $childNode) {
-			if($childNode->nodeName === self::NODE_NODENAME) {
+		foreach ($domNode->childNodes as $childNode) {
+			if ($childNode->nodeName === self::NODE_NODENAME) {
 				$children->add($this->fillNode($childNode));
 			}
-			elseif($childNode->nodeName === self::FONT_NODENAME) {
+			elseif ($childNode->nodeName === self::FONT_NODENAME) {
 				$this->fillNodeAttributes($childNode->attributes, self::$fontAvailableAttributes, $node);
 			}
-			elseif($childNode->nodeName === self::ICON_NODENAME) {
-				foreach($childNode->attributes as $attribute) {
-					if(array_key_exists($attribute->nodeName, self::$iconAvailableAttributes)) {
+			elseif ($childNode->nodeName === self::ICON_NODENAME) {
+				foreach ($childNode->attributes as $attribute) {
+					if (array_key_exists($attribute->nodeName, self::$iconAvailableAttributes)) {
 						$node->setIcon(new Icon($attribute->nodeValue));
 					}
 				}
@@ -122,9 +122,9 @@ 
 	 * @param array $availableAttributes : One of the static array of this class to describe the list of known attributes.
 	 * @param Node $node : The Node object to fill in.
 	 */
-	private function fillNodeAttributes (DOMNamedNodeMap $nodeAtributes, array $availableAttributes, Node $node) {
-		foreach($nodeAtributes as $attribute) {
-			if(array_key_exists($attribute->nodeName, $availableAttributes)) {
+	private function fillNodeAttributes(DOMNamedNodeMap $nodeAtributes, array $availableAttributes, Node $node) {
+		foreach ($nodeAtributes as $attribute) {
+			if (array_key_exists($attribute->nodeName, $availableAttributes)) {
 				call_user_func([
 						$node, 
 						sprintf('openMindParser\Models\Node::set%s', ucfirst($availableAttributes[$attribute->nodeName]))

Braces +2 added lines, -4 removed lines

@@ -97,11 +97,9 @@
 		foreach($domNode->childNodes as $childNode) {
 			if($childNode->nodeName === self::NODE_NODENAME) {
 				$children->add($this->fillNode($childNode));
-			}
-			elseif($childNode->nodeName === self::FONT_NODENAME) {
+			} elseif($childNode->nodeName === self::FONT_NODENAME) {
 				$this->fillNodeAttributes($childNode->attributes, self::$fontAvailableAttributes, $node);
-			}
-			elseif($childNode->nodeName === self::ICON_NODENAME) {
+			} elseif($childNode->nodeName === self::ICON_NODENAME) {
 				foreach($childNode->attributes as $attribute) {
 					if(array_key_exists($attribute->nodeName, self::$iconAvailableAttributes)) {
 						$node->setIcon(new Icon($attribute->nodeValue));

src/Models/NodeList.php

Spacing +3 added lines, -3 removed lines

@@ -14,12 +14,12 @@
 	private $list;
 	
 	public function __construct(array $list = null) {
-		if(empty($list)) {
+		if (empty($list)) {
 			$list = [];
 		}
 		
-		foreach($list as $node) {
-			if(!($node instanceof Node)) {
+		foreach ($list as $node) {
+			if (!($node instanceof Node)) {
 				throw new InvalidArgumentException('The array must contain only Node objects. "'.get_class($node).'" given.');
 			}
 		}

src/Models/Document.php

Spacing +3 added lines, -3 removed lines

@@ -148,16 +148,16 @@
 	public function toArray() {
 		$array = [];
 		$sorter = function($value, $key) use(&$array) {
-			if($value instanceof Node) {
+			if ($value instanceof Node) {
 				$value = $value->toArray();
 			}
-			elseif($value instanceof DOMDocument) {
+			elseif ($value instanceof DOMDocument) {
 				return;
 			}
 			$array[$key] = $value;
 		};
 		
-		foreach(get_object_vars($this) as $key => $value) {
+		foreach (get_object_vars($this) as $key => $value) {
 			$sorter($value, $key);
 		}
 		

Braces +1 added lines, -2 removed lines

@@ -150,8 +150,7 @@
 		$sorter = function($value, $key) use(&$array) {
 			if($value instanceof Node) {
 				$value = $value->toArray();
-			}
-			elseif($value instanceof DOMDocument) {
+			} elseif($value instanceof DOMDocument) {
 				return;
 			}
 			$array[$key] = $value;

src/Models/Icon.php

Spacing +2 added lines, -2 removed lines

@@ -42,7 +42,7 @@ 
 	 * @param String $extension : The extension of the icon file without the leading dot. If it is a builtin icon, then it is 'png'.
 	 */ 
 	public function __construct($name = null, $extension = null, $path = null, $shortUri = null, $size = null) {
-		if(!empty($name)) {
+		if (!empty($name)) {
 			$this->setIcon($name, $extension, $path, $shortUri, $size);
 		}
 	}
@@ -64,7 +64,7 @@ 
 		$this->shortUri = $shortUri ?: '/img/'.$this->fullName;
 		$this->path = $path ?: realpath(__DIR__.'/../../img/'.$this->fullName);
 		
-		if(!file_exists($this->path)) {
+		if (!file_exists($this->path)) {
 			throw new UnexistentFileException('The file '.$this->path.' does not exist !');
 		}
 		

usage/SampleGenericHTMLConverter.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use OpenMindParser\Converters\Model\AbstractConverter;
 use OpenMindParser\Models\Document;
 use OpenMindParser\Models\Node;
-use OpenMindParser\Parser;
 use \DOMDocument;
 
 /*A singleton to convert a document tree (object Document) in a HTML tree following few options.*/

Spacing +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
 	GenericHTMLConverter::MAIN_ICON_KEY => [
 		GenericHTMLConverter::DISPLAY_ICON_KEY => true,
 		GenericHTMLConverter::PATH_ICON_KEY    => [
-			GenericHTMLConverter::CALLBACK_PATH_ICON_KEY => function($fullName, $options = null){return '/openMindParser/img/'.$fullName;},
+			GenericHTMLConverter::CALLBACK_PATH_ICON_KEY => function($fullName, $options = null) {return '/openMindParser/img/'.$fullName; },
 		],
 	],
 ]);