OpenMindParser\Models\Node

Complexity

Total Complexity

46

Size/Duplication

Total Lines	417
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

34 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	17	5
A	getId()	0	3	1
A	setId()	0	3	1
A	getColor()	0	3	1
A	setColor()	0	3	1
A	getCreated()	0	3	1
A	setCreated()	0	3	1
A	getModified()	0	3	1
A	setModified()	0	3	1
A	getPosition()	0	3	1
A	setPosition()	0	3	1
A	getVshift()	0	3	1
A	setVshift()	0	3	1
A	isFolded()	0	3	1
A	setFolded()	0	3	2
A	getText()	0	3	1
A	getRawText()	0	3	1
A	setText()	0	3	1
A	getFontName()	0	3	1
A	setFontName()	0	3	1
A	isBold()	0	3	1
A	setBold()	0	3	2
A	isItalic()	0	3	1
A	setItalic()	0	3	2
A	getFontSize()	0	3	1
A	setFontSize()	0	3	1
A	getIcon()	0	3	1
A	setIcon()	0	3	1
A	getChildren()	0	3	1
A	setChildren()	0	3	1
A	getDomNode()	0	3	1
A	setDomNode()	0	3	1
A	__toString()	0	3	1
B	toArray()	0	25	6

<?php

namespace OpenMindParser\Models;

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 
{
	/**
	 * @var String $id : The unique id of the node.
	 */
	private $id;
	/**
	 * @var String $color : The text color of the node.
	 */
	private $color;
	/**
	 * @var float $created : The timestamp of the creation date of the node.
	 */
	private $created;
	/**
	 * @var float $modified : The timestamp of the modified date of the node.
	 */
	private $modified;
	/**
	 * @var String $position : The relative position of the node.
	 */
	private $position;
	/**
	 * @var int $vshift : The vshift of the node.
	 */
	private $vshift;
	/**
	 * @var Bool $folded : Is the node folded or not.
	 */
	private $folded;
	/**
	 * @var String $text : The text of the node.
	 */
	private $text;
	/**
	 * @var Bool $bold : Is the text node in bold.
	 */
	private $bold;
	/**
	 * @var Bool $italic : Is the text node in italic.
	 */
	private $italic;
	/**
	 * @var String $fontName : The font name of the node.
	 */
	private $fontName;
	/**
	 * @var int $fontSize : The font size of the node.
	 */
	private $fontSize;
	/**
	 * @var Icon $icon : The icon of the node if there is one.
	 */
	private $icon;
	/**
	 * @var NodeList $children : The children of the node as a collection of Nodes.
	 */
	private $children;
	/**
	 * @var DOMElement $domNode : The DOMElement instance of the current Node.
	 */
	private $domNode;
	
	/**
	 * @param DOMElement $domNode : The DOMElement instance of the current Node.
	 * @param NodeList $children  : The children of the node as a collection of Nodes.
	 * @param Icon $icon          : The icon of the node if there is one.
	 * @param String $id          : The unique id of the node.
	 * @param String $color       : The text color of the node.
	 * @param float $created     : The timestamp of the creation date of the node.
	 * @param float $modified    : The timestamp of the modified date of the node.
	 * @param String $position    : The relative position of the node.
	 * @param int $vshift      : The vshift of the node.
	 * @param Bool $folded      : Is the node folded or not.
	 * @param String $text        : The text of the node.
	 * @param Bool $bold          : Is the text node in bold.
	 * @param Bool $italic        : Is the text node in italic.
	 * @param String $fontName    : The font name of the current Node.
	 * @param int $fontSize    : The font size of the node.
	 */
	public function __construct(DOMElement $domNode = null, NodeList $children = null, Icon $icon = null, $id = null, $color = null, $created = null, $modified = null, $position = null, $vshift = null, $folded = null, $text = null, $bold = null, $italic = null, $fontName = null, $fontSize = null) {
		$this->id = $id;
		$this->color = $color;
		$this->created = $created;
		$this->modified = $modified;
		$this->position = $position;
		$this->vshift = $vshift;
		$this->folded = $folded ? true : false;
		$this->text = $text;
		$this->bold = $bold ? true : false;
		$this->italic = $italic ? true : false;
		$this->fontName = $fontName;
		$this->fontSize = $fontSize;
		$this->icon = $icon;
		$this->children = $children ?: new NodeList();
		$this->domNode = $domNode;
	}
	
	/**
	 * Return the Id of the current node.
	 * 
	 * @return String : The node id.
	 */
	public function getId() {
		return $this->id;
	}
	
	/**
	 * Set the Id of the current node.
	 * 
	 * @param String $id : The node id.
	 */
	public function setId($id) {
		$this->id = $id;
	}
	
	/**
	 * Return the color of the current node.
	 * 
	 * @return String : The node color value in hexadecimal.
	 */
	public function getColor() {
		return $this->color;
	}
	
	/**
	 * Set the color of the current node.
	 * 
	 * @param String $color : The node color value in hexadecimal.
	 */
	public function setColor($color) {
		$this->color = $color;
	}
	
	/**
	 * Return the created timestamp of the current node.
	 * 
	 * @return float : The node created timestamp.
	 */
	public function getCreated() {
		return $this->created;
	}
	
	/**
	 * Set the created timestamp of the current node.
	 * 
	 * @param float $created : The node created timestamp.
	 */
	public function setCreated($created) {
		$this->created = $created;
	}
	
	/**
	 * Return the modified timestamp of the current node.
	 * 
	 * @return float : The node modified timestamp.
	 */
	public function getModified() {
		return $this->modified;
	}
	
	/**
	 * Set the modified timestamp of the current node.
	 * 
	 * @param float $modified : The node modified timestamp.
	 */
	public function setModified($modified) {
		$this->modified = $modified;
	}
	
	/**
	 * Return the relative position the current node to the parent node.
	 * 
	 * @return String : The node relative position.
	 */
	public function getPosition() {
		return $this->position;
	}
	
	/**
	 * Set the relative position the current node to the parent node.
	 * 
	 * @param String $position : The node relative position.
	 */
	public function setPosition($position) {
		$this->position = $position;
	}
	
	/**
	 * Return the vshift value of the current node.
	 * 
	 * @return int : The node vshift value.
	 */
	public function getVshift() {
		return $this->vshift;
	}
	
	/**
	 * Set the vshift value of the current node.
	 * 
	 * @param int $vshift : The node vshift value.
	 */
	public function setVshift($vshift) {
		$this->vshift = $vshift;
	}
	
	/**
	 * Return if the current node is folded or not.
	 * 
	 * @return Bool $folded
	 */
	public function isFolded() {
		return $this->folded;
	}
	
	/**
	 * Set if the current node is folded or not.
	 * 
	 * @param Bool $folded
	 */
	public function setFolded($folded) {
		$this->folded = $folded ? true : false;
	}
	
	/**
	 * Return the text of the current node with html entities decoded.
	 * 
	 * @return String : The node text value.
	 */
	public function getText() {
		return html_entity_decode($this->text);
	}
	
	/**
	 * Return the text of the current node.
	 * 
	 * @return String : The node text value.
	 */
	public function getRawText() {
		return $this->text;
	}
	
	/**
	 * Set the text of the current node with html entities decoded.
	 * 
	 * @param String $text : The node text value in plain text not html encoded.
	 */
	public function setText($text) {
		$this->text = htmlentities($text);
	}
	
	/**
	 * Return the font name of the current node.
	 * 
	 * @return String : The node font name.
	 */
	public function getFontName() {
		return $this->fontName;
	}
	
	/**
	 * Set the font name of the current node.
	 * 
	 * @param String $fontName : The node font name.
	 */
	public function setFontName($fontName) {
		$this->fontName = $fontName;
	}
	
	/**
	 * Return if the text node is bold.
	 * 
	 * @return Bool : If the text is bold or not.
	 */
	public function isBold() {
		return $this->bold;
	}
	
	/**
	 * Set if the text node is bold.
	 * 
	 * @param Bool $bold : If the text must be bold or not.
	 */
	public function setBold($bold) {
		$this->bold = $bold ? true : false;
	}
	
	/**
	 * Return if the text node is italic.
	 * 
	 * @return Bool : If the text is italic or not.
	 */
	public function isItalic() {
		return $this->italic;
	}
	
	/**
	 * Set if the text node is italic.
	 * 
	 * @param Bool $italic : If the text must be italic or not.
	 */
	public function setItalic($italic) {
		$this->italic = $italic ? true : false;
	}
	
	/**
	 * Return the font size of the current node.
	 * 
	 * @return int : The node font size.
	 */
	public function getFontSize() {
		return $this->fontSize;
	}
	
	/**
	 * Set the font size of the current node.
	 * 
	 * @param int $fontSize : The node font size.
	 */
	public function setFontSize($fontSize) {
		$this->fontSize = $fontSize;
	}
	
	/**
	 * Return the icon of the current node if there is one.
	 * 
	 * @return Icon : The icon.
	 */
	public function getIcon() {
		return $this->icon;
	}
	
	/**
	 * Set the icon of the current node.
	 * 
	 * @param Icon $icon : The node icon.
	 */
	public function setIcon(Icon $icon) {
		$this->icon = $icon;
	}
	
	/**
	 * Return the list of children of the current node.
	 * 
	 * @param NodeList $children : The list of children node.

There is no parameter named $children. Was it maybe removed?

	 */
	public function getChildren() {
		return $this->children;
	}
	
	/**
	 * Set the list of children of the current node.
	 * 
	 * @param NodeList $children : The list of children node.
	 */
	public function setChildren(NodeList $children) {
		$this->children = $children;
	}
	
	/**
	 * Return the DOMElement instance of the cirrent Node.
	 * 
	 * @return DOMElement : DOMElement instance.
	 */
	public function getDomNode() {
		return $this->domNode;
	}
	
	/**
	 * Set the current DOMElement instance.
	 * 
	 * @param DOMElement $domNode : The DOMElement instance.
	 */
	public function setDomNode(DOMElement $domNode) {
		$this->domNode = $domNode;
	}
	
	/**
	 * To String method.
	 * 
	 * @return String : The text content of the node.
	 */
	public function __toString() {
		return $this->getText();
	}
	
	/**
	 * Transform the objects tree in an array tree.
	 * 
	 * @return Array $array : The array tree.
	 */
	public function toArray() {
		$array = [];
		$sorter = function($value, $key) use(&$array) {
			if($value instanceof NodeList) {
				$newValue = [];
				foreach($value as $node) {
					$newValue[] = $node->toArray();
				}
				$value = $newValue;
			}
			elseif($value instanceof Icon) {
				$value = $value->toArray();
			}
			elseif($value instanceof DOMElement) {
				return;
			}
			$array[$key] = $value;
		};
		
		foreach(get_object_vars($this) as $key => $value) {
			$sorter($value, $key);
		}
		
		return $array;
	}
}