<?xml version="1.0"?>
<project version="0.15.1" title="">
<file path="\app\bootstrap.inc" hash="d6225ebf605cac291c633f98f17ade36" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \app\bootstrap.inc</error>
<error line="4">No DocBlock was found for Constant INSTALLATION_FOLDER</error>
<error line="7">No DocBlock was found for Constant SOURCE_FOLDER</error>
<error line="10">No DocBlock was found for Constant DATA_FOLDER</error>
</parse_markers>
<include type="Require Once" line="13">
<name>/Utils/Autoload/Autoloader.inc</name>
</include>
<constant namespace="default" line="4" package="Default">
<name>INSTALLATION_FOLDER</name>
<value>str_replace('\\', '/', realpath(__DIR__.'/..'))</value>
</constant>
<constant namespace="default" line="7" package="Default">
<name>SOURCE_FOLDER</name>
<value>INSTALLATION_FOLDER.'/src'</value>
</constant>
<constant namespace="default" line="10" package="Default">
<name>DATA_FOLDER</name>
<value>INSTALLATION_FOLDER.'/data'</value>
</constant>
</file>
<file path="\src\ReingoldTilford\Algorithms\Layout.inc" hash="23c5c29906efaa26032d3ba169b6ed46" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\ReingoldTilford\Algorithms\Layout.inc</error>
<critical line="124">No short description for method current</critical>
<critical line="132">No short description for method key</critical>
<critical line="140">No short description for method next</critical>
<critical line="148">No short description for method rewind</critical>
<critical line="156">No short description for method valid</critical>
</parse_markers>
<namespace-alias name="TreeStyle">ReingoldTilford\Styles\TreeStyle</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="12" namespace="ReingoldTilford\Algorithms" package="Default">
<name>Layout</name>
<extends/>
<full_name>\ReingoldTilford\Algorithms\Layout</full_name>
<docblock>
<description>This class encapsulates the layout of a collection of (tree) nodes.</description>
<long-description>
</long-description>
</docblock>
<implements>\Iterator</implements>
<property final="false" static="false" visibility="private" line="19" package="Default">
<name>$coordinates</name>
<default>null</default>
<docblock>
<description>the collection of coorindates</description>
<long-description>
</long-description>
<tag line="14" name="var" description="" type="\SplObjectStorage">
<type by_reference="false">\SplObjectStorage</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="26" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="21" name="param" description="the collection of coorindates" type="\SplObjectStorage" variable="$coordinates">
<type by_reference="false">\SplObjectStorage</type>
</tag>
</docblock>
<argument line="26">
<name>$coordinates</name>
<default/>
<type>SplObjectStorage</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="36" package="Default">
<name>normalize</name>
<docblock>
<description>This method normalizes the layout, such that no negative coordinates remain, i.e. the lowest x-coordinate will be 0 and will denote the left-most leaf of the tree.</description>
<long-description>
</long-description>
<tag line="31" name="return" description="$this" type="\ReingoldTilford\Algorithms\Layout">
<type by_reference="false">\ReingoldTilford\Algorithms\Layout</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="62" package="Default">
<name>getDimension</name>
<docblock>
<description>This method gets the dimensions of the layout.</description>
<long-description>
</long-description>
<tag line="56" name="param" description="the tree style which is used for calculating the dimensions" type="\ReingoldTilford\Styles\TreeStyle" variable="$treeStyle">
<type by_reference="false">\ReingoldTilford\Styles\TreeStyle</type>
</tag>
<tag line="56" name="return" description="the dimensions of the layout" type="\Utils\Geom\Dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
<argument line="62">
<name>$treeStyle</name>
<default/>
<type>TreeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="87" package="Default">
<name>getPosition</name>
<docblock>
<description>This method returns the position of a given tree node with respect to a given tree style.</description>
<long-description>
</long-description>
<tag line="80" name="param" description="the node for which to get the position" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="80" name="param" description="the tree style to respect" type="\ReingoldTilford\Styles\TreeStyle" variable="$treeStyle">
<type by_reference="false">\ReingoldTilford\Styles\TreeStyle</type>
</tag>
<tag line="80" name="return" description="the position of the node" type="\Utils\Geom\Point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
</docblock>
<argument line="87">
<name>$node</name>
<default/>
<type/>
</argument>
<argument line="87">
<name>$treeStyle</name>
<default/>
<type>TreeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="99" package="Default">
<name>getXCoordinate</name>
<docblock>
<description>This method returns the x-coordinate of a given tree node with respect to a given tree style.</description>
<long-description>
</long-description>
<tag line="92" name="param" description="the node for which to get the position" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="92" name="param" description="the tree style to respect" type="\ReingoldTilford\Styles\TreeStyle" variable="$treeStyle">
<type by_reference="false">\ReingoldTilford\Styles\TreeStyle</type>
</tag>
<tag line="92" name="return" description="the x-coordinate of a given tree node" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="99">
<name>$node</name>
<default/>
<type/>
</argument>
<argument line="99">
<name>$treeStyle</name>
<default/>
<type>TreeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="115" package="Default">
<name>getYCoordinate</name>
<docblock>
<description>This method returns the y-coordinate of a given tree node with respect to a given tree style.</description>
<long-description>
</long-description>
<tag line="108" name="param" description="the node for which to get the position" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="108" name="param" description="the tree style to respect" type="\ReingoldTilford\Styles\TreeStyle" variable="$treeStyle">
<type by_reference="false">\ReingoldTilford\Styles\TreeStyle</type>
</tag>
<tag line="108" name="return" description="the y-coordinate of a given tree node" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="115">
<name>$node</name>
<default/>
<type/>
</argument>
<argument line="115">
<name>$treeStyle</name>
<default/>
<type>TreeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="127" package="Default">
<name>current</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="135" package="Default">
<name>key</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="143" package="Default">
<name>next</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="151" package="Default">
<name>rewind</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="159" package="Default">
<name>valid</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
</class>
</file>
<file path="\src\ReingoldTilford\Algorithms\ReingoldTilfordAlgorithm.inc" hash="74bc09a46863fc189e979beb81c55739" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\ReingoldTilford\Algorithms\ReingoldTilfordAlgorithm.inc</error>
</parse_markers>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<namespace-alias name="Layout">ReingoldTilford\Algorithms\Layout</namespace-alias>
<namespace-alias name="ITreeModel">ReingoldTilford\Models\ITreeModel</namespace-alias>
<namespace-alias name="TreeStyle">ReingoldTilford\Styles\TreeStyle</namespace-alias>
<class final="false" abstract="false" line="13" namespace="ReingoldTilford\Algorithms" package="Default">
<name>ReingoldTilfordAlgorithm</name>
<extends/>
<full_name>\ReingoldTilford\Algorithms\ReingoldTilfordAlgorithm</full_name>
<docblock>
<description>This clas implements the Reingold-Tilford tree drawing algorithm. The alorithm works in O(n), where n is the number of nodes in the tree.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="true" visibility="private" line="18" package="Default">
<name>$ONLY_CHILD_DEGREE</name>
<default>1</default>
<docblock>
<description>one child only makes an only child degree</description>
<long-description>
</long-description>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="23" package="Default">
<name>$BINARY_DEGREE</name>
<default>2</default>
<docblock>
<description>two children make an binary degree</description>
<long-description>
</long-description>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="30" package="Default">
<name>$model</name>
<default>null</default>
<docblock>
<description>the tree model the algorithm uses</description>
<long-description>
</long-description>
<tag line="25" name="var" description="" type="\ReingoldTilford\Models\ITreeModel">
<type by_reference="false">\ReingoldTilford\Models\ITreeModel</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="37" package="Default">
<name>$root</name>
<default>null</default>
<docblock>
<description>the root of the (sub)tree to be printed</description>
<long-description>
</long-description>
<tag line="32" name="var" description="" type="\ReingoldTilford\Algorithms\TreeNode">
<type by_reference="false">\ReingoldTilford\Algorithms\TreeNode</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="44" package="Default">
<name>$minDistance</name>
<default>1</default>
<docblock>
<description>the minimal horizontal distance of two nodes</description>
<long-description>
</long-description>
<tag line="39" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="51" package="Default">
<name>$leftOutline</name>
<default>null</default>
<docblock>
<description>the left outline of the nodes</description>
<long-description>
</long-description>
<tag line="46" name="var" description="" type="\ReingoldTilford\Algorithms\SplObjectStorage">
<type by_reference="false">\ReingoldTilford\Algorithms\SplObjectStorage</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="58" package="Default">
<name>$rightOutline</name>
<default>null</default>
<docblock>
<description>the right outline of the nodes</description>
<long-description>
</long-description>
<tag line="53" name="var" description="" type="\ReingoldTilford\Algorithms\SplObjectStorage">
<type by_reference="false">\ReingoldTilford\Algorithms\SplObjectStorage</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="65" package="Default">
<name>$currentRightOutline</name>
<default>null</default>
<docblock>
<description>the current right outline (i.e. right outline of the current left subtree)</description>
<long-description>
</long-description>
<tag line="60" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="72" package="Default">
<name>$leftThread</name>
<default>null</default>
<docblock>
<description>the left threads</description>
<long-description>
</long-description>
<tag line="67" name="var" description="" type="\ReingoldTilford\Algorithms\SplObjectStorage">
<type by_reference="false">\ReingoldTilford\Algorithms\SplObjectStorage</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="79" package="Default">
<name>$rightThread</name>
<default>null</default>
<docblock>
<description>the right threads</description>
<long-description>
</long-description>
<tag line="74" name="var" description="" type="\ReingoldTilford\Algorithms\SplObjectStorage">
<type by_reference="false">\ReingoldTilford\Algorithms\SplObjectStorage</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="86" package="Default">
<name>$offsets</name>
<default>null</default>
<docblock>
<description>the x-offsets of the nodes</description>
<long-description>
</long-description>
<tag line="81" name="var" description="" type="\ReingoldTilford\Algorithms\SplObjectStorage">
<type by_reference="false">\ReingoldTilford\Algorithms\SplObjectStorage</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="93" package="Default">
<name>$parents</name>
<default>null</default>
<docblock>
<description>hash table that maps a node to its parent</description>
<long-description>
</long-description>
<tag line="88" name="var" description="" type="\ReingoldTilford\Algorithms\SplObjectStorage">
<type by_reference="false">\ReingoldTilford\Algorithms\SplObjectStorage</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="100" package="Default">
<name>$depths</name>
<default>null</default>
<docblock>
<description>hash table that maps a node to its depth</description>
<long-description>
</long-description>
<tag line="95" name="var" description="" type="\ReingoldTilford\Algorithms\SplObjectStorage">
<type by_reference="false">\ReingoldTilford\Algorithms\SplObjectStorage</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="107" package="Default">
<name>$orientation</name>
<default>TreeStyle::CENTERED</default>
<docblock>
<description>the orientation variant of the tree</description>
<long-description>
</long-description>
<tag line="102" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="114" package="Default">
<name>$children</name>
<default>null</default>
<docblock>
<description>a reference to the children of the currently visited node (cached for performance reasons)</description>
<long-description>
</long-description>
<tag line="109" name="var" description="" type="\ReingoldTilford\Algorithms\array[int]TreeNode">
<type by_reference="false">\ReingoldTilford\Algorithms\array[int]TreeNode</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="121" package="Default">
<name>$nodeDegree</name>
<default>null</default>
<docblock>
<description>the number of children of the currently visited node (cached for performance reasons)</description>
<long-description>
</long-description>
<tag line="116" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="127" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="136" package="Default">
<name>initialize</name>
<docblock>
<description>This method (re)initializes the internal data structures, so an object of this class can be used for several trees to be drawn.</description>
<long-description>
</long-description>
<tag line="131" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="156" package="Default">
<name>calculatesOffsets</name>
<docblock>
<description>This method calculates the offsets of a node.</description>
<long-description><p>This is the main method of the algorithm.</p>
</long-description>
<tag line="149" name="param" description="" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="156">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="196" package="Default">
<name>calculateSubTreeShifts</name>
<docblock>
<description>This method returns the subtree shifts of the children of the current node.</description>
<long-description>
</long-description>
<tag line="188" name="param" description="the current node that is traversed" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="188" name="param" description="the left outlines of the node" type="\ReingoldTilford\Algorithms\array[int][int]TreeNode" variable="$leftOutlines">
<type by_reference="false">\ReingoldTilford\Algorithms\array[int][int]TreeNode</type>
</tag>
<tag line="188" name="param" description="the right outlines of the node" type="\ReingoldTilford\Algorithms\array[int][int]TreeNode" variable="$rightOutlines">
<type by_reference="false">\ReingoldTilford\Algorithms\array[int][int]TreeNode</type>
</tag>
<tag line="188" name="return" description="" type="\ReingoldTilford\Algorithms\array[int]int">
<type by_reference="false">\ReingoldTilford\Algorithms\array[int]int</type>
</tag>
</docblock>
<argument line="196">
<name>$node</name>
<default/>
<type/>
</argument>
<argument line="196">
<name>$leftOutlines</name>
<default/>
<type/>
</argument>
<argument line="196">
<name>$rightOutlines</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="267" package="Default">
<name>setNodeOffsets</name>
<docblock>
<description>This method sets the offsets of the children of the current node.</description>
<long-description>
</long-description>
<tag line="260" name="param" description="the current node that is traversed" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="260" name="param" description="the shifts of the subtrees" type="\ReingoldTilford\Algorithms\array[int]double" variable="$subTreeShifts">
<type by_reference="false">\ReingoldTilford\Algorithms\array[int]double</type>
</tag>
<tag line="260" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="267">
<name>$node</name>
<default/>
<type/>
</argument>
<argument line="267">
<name>$subTreeShifts</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="328" package="Default">
<name>updateOutlines</name>
<docblock>
<description>This method updates the left and the right outline of the current node.</description>
<long-description>
</long-description>
<tag line="321" name="param" description="the current node that is traversed" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="321" name="param" description="the left outlines of the node" type="\ReingoldTilford\Algorithms\array[int][int]TreeNode" variable="$leftOutlines">
<type by_reference="false">\ReingoldTilford\Algorithms\array[int][int]TreeNode</type>
</tag>
<tag line="321" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="328">
<name>$node</name>
<default/>
<type/>
</argument>
<argument line="328">
<name>$leftOutlines</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="399" package="Default">
<name>getLayout</name>
<docblock>
<description>This method returns a Layout for a given ITreeModel.</description>
<long-description>
</long-description>
<tag line="392" name="param" description="the tree model to get a layout for" type="\ReingoldTilford\Models\ITreeModel" variable="$model">
<type by_reference="false">\ReingoldTilford\Models\ITreeModel</type>
</tag>
<tag line="392" name="param" description="the orientation of the children of a node, either one of TreeStyle::CENTERED, TreeStyle::LEFT, TreeStyle::RIGHT" type="\ReingoldTilford\Algorithms\type" variable="$orientation">
<type by_reference="false">\ReingoldTilford\Algorithms\type</type>
</tag>
<tag line="392" name="return" description="the layout of the given tree model" type="\ReingoldTilford\Algorithms\Layout">
<type by_reference="false">\ReingoldTilford\Algorithms\Layout</type>
</tag>
</docblock>
<argument line="399">
<name>$model</name>
<default/>
<type>ITreeModel</type>
</argument>
<argument line="399">
<name>$orientation</name>
<default>TreeStyle::CENTERED</default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="431" package="Default">
<name>initializeMetaData</name>
<docblock>
<description>This helper method initializes the meta data for use in the algorithm</description>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="462" package="Default">
<name>getPreOrderEnumeration</name>
<docblock>
<description>This helper method returns the pre-order enumaration of the tree model.</description>
<long-description>
</long-description>
<tag line="457" name="return" description="the pre-order enumaration of the tree model" type="\SplDoublyLinkedList">
<type by_reference="false">\SplDoublyLinkedList</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="485" package="Default">
<name>getPostOrderEnumeration</name>
<docblock>
<description>This helper method returns the post-order enumaration of the tree model.</description>
<long-description>
</long-description>
<tag line="480" name="return" description="the post-order enumaration of the tree model" type="\SplDoublyLinkedList">
<type by_reference="false">\SplDoublyLinkedList</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="520" package="Default">
<name>getChildren</name>
<docblock>
<description>This helper method returns the child nodes of a given node.</description>
<long-description>
</long-description>
<tag line="514" name="param" description="the node for which to get its child nodes" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="514" name="return" description="of child nodes" type="\ArrayObject">
<type by_reference="false">\ArrayObject</type>
</tag>
</docblock>
<argument line="520">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="536" package="Default">
<name>getDegree</name>
<docblock>
<description>This helper method gets the degree of a given node.</description>
<long-description>
</long-description>
<tag line="530" name="param" description="the node of which the degree has to be calculated" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="530" name="return" description="the degree of the node" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="536">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\ReingoldTilford\Models\DomTreeModel.inc" hash="812802ce9f95b1e3fad0b8e662c1ebd2" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\ReingoldTilford\Models\DomTreeModel.inc</error>
<notice line="91">Argument $node is missing from the function Docblock</notice>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="ReingoldTilford\Models" package="Default">
<name>DomTreeModel</name>
<extends>\ReingoldTilford\Models\TreeModel</extends>
<full_name>\ReingoldTilford\Models\DomTreeModel</full_name>
<docblock>
<description>This class acts as TreeModel implementation for the PHP's DOMNode class, so this can be used with ReingoldTilford algorithm.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="15" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the TreeNodeTreeModel.</description>
<long-description>
</long-description>
<tag line="10" name="param" description="the root of the tree" type="object" variable="$root">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="15">
<name>$root</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="26" package="Default">
<name>getChild</name>
<docblock>
<description>This method returns the child of the given parent at the given index.</description>
<long-description>
</long-description>
<tag line="20" name="param" description="the parent node" type="object" variable="$parent">
<type by_reference="false">object</type>
</tag>
<tag line="20" name="param" description="the index" type="int" variable="$index">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="26">
<name>$parent</name>
<default/>
<type/>
</argument>
<argument line="26">
<name>$index</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="37" package="Default">
<name>getChildCount</name>
<docblock>
<description>This method returns the number of children of the given parent.</description>
<long-description>
</long-description>
<tag line="31" name="param" description="the parent node" type="object" variable="$parent">
<type by_reference="false">object</type>
</tag>
<tag line="31" name="return" description="the number of children of the given parent" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="37">
<name>$parent</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="53" package="Default">
<name>getIndexOfChild</name>
<docblock>
<description>This method returns the index of the given child in the given parent.</description>
<long-description>
</long-description>
<tag line="46" name="param" description="the parent node" type="object" variable="$parent">
<type by_reference="false">object</type>
</tag>
<tag line="46" name="param" description="the cild node" type="object" variable="$child">
<type by_reference="false">object</type>
</tag>
<tag line="46" name="return" description="the index of the given child in the given parent" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="53">
<name>$parent</name>
<default/>
<type/>
</argument>
<argument line="53">
<name>$child</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="69" package="Default">
<name>getRoot</name>
<docblock>
<description>This method returns the root of the tree.</description>
<long-description>
</long-description>
<tag line="64" name="return" description="the root of the tree" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="80" package="Default">
<name>isLeaf</name>
<docblock>
<description>This method returns true if the given node is a leaf.</description>
<long-description>
</long-description>
<tag line="74" name="param" description="the node" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="74" name="return" description="true, if the the node is a leaf, else false" type="boolean">
<type by_reference="false">boolean</type>
</tag>
</docblock>
<argument line="80">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="91" package="Default">
<name>getLabel</name>
<docblock>
<description>This method returns the label associated with the DOM node, i.e. the node name.</description>
<long-description><p>As the PHP DOMNode class does not provide a __toString method, a custom implementation is needed.</p>
</long-description>
</docblock>
<argument line="91">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\ReingoldTilford\Models\FSTreeModel.inc" hash="39cfce51c003c0591cc9376ae32550ec" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\ReingoldTilford\Models\FSTreeModel.inc</error>
<critical line="86">No short description for method getLabel</critical>
<notice line="89">Argument $node is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="Directory">Utils\File\Directory</namespace-alias>
<namespace-alias name="File">Utils\File\File</namespace-alias>
<class final="false" abstract="false" line="11" namespace="ReingoldTilford\Models" package="Default">
<name>FSTreeModel</name>
<extends>\ReingoldTilford\Models\TreeModel</extends>
<full_name>\ReingoldTilford\Models\FSTreeModel</full_name>
<docblock>
<description>This class acts as ITreeModel implementation for the FileSystemObject classes (@see Utils\File\), so they can be used with ReingoldTilford algorithm.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="18" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the TreeNodeTreeModel.</description>
<long-description>
</long-description>
<tag line="13" name="param" description="the root of the tree" type="object" variable="$root">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="18">
<name>$root</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="29" package="Default">
<name>getChild</name>
<docblock>
<description>This method returns the child of the given parent at the given index.</description>
<long-description>
</long-description>
<tag line="23" name="param" description="the parent node" type="object" variable="$parent">
<type by_reference="false">object</type>
</tag>
<tag line="23" name="param" description="the index" type="int" variable="$index">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="29">
<name>$parent</name>
<default/>
<type/>
</argument>
<argument line="29">
<name>$index</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="40" package="Default">
<name>getChildCount</name>
<docblock>
<description>This method returns the number of children of the given parent.</description>
<long-description>
</long-description>
<tag line="34" name="param" description="the parent node" type="object" variable="$parent">
<type by_reference="false">object</type>
</tag>
<tag line="34" name="return" description="the number of children of the given parent" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="40">
<name>$parent</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="60" package="Default">
<name>getIndexOfChild</name>
<docblock>
<description>This method returns the index of the given child in the given parent.</description>
<long-description>
</long-description>
<tag line="53" name="param" description="the parent node" type="object" variable="$parent">
<type by_reference="false">object</type>
</tag>
<tag line="53" name="param" description="the cild node" type="object" variable="$child">
<type by_reference="false">object</type>
</tag>
<tag line="53" name="return" description="the index of the given child in the given parent" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="60">
<name>$parent</name>
<default/>
<type/>
</argument>
<argument line="60">
<name>$child</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="80" package="Default">
<name>isLeaf</name>
<docblock>
<description>This method returns true if the given node is a leaf.</description>
<long-description>
</long-description>
<tag line="74" name="param" description="the node" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="74" name="return" description="true, if the the node is a leaf, else false" type="boolean">
<type by_reference="false">boolean</type>
</tag>
</docblock>
<argument line="80">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="89" package="Default">
<name>getLabel</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="89">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\ReingoldTilford\Models\ITreeModel.inc" hash="25041303d1d9e26bfb7585658b346fbd" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\ReingoldTilford\Models\ITreeModel.inc</error>
<notice line="54">Argument $node is missing from the function Docblock</notice>
</parse_markers>
<interface namespace="ReingoldTilford\Models" line="8" package="Default">
<name>ITreeModel</name>
<extends/>
<full_name>\ReingoldTilford\Models\ITreeModel</full_name>
<docblock>
<description>This interface defines the basic methods that are neccessary for a data structure to be processed by the Reingold-Tilford tree drawing algorithm.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="17" package="Default">
<name>getChild</name>
<docblock>
<description>This method returns the child at the given index of the given parent.</description>
<long-description>
</long-description>
<tag line="10" name="param" description="the parent to get the child from" type="object" variable="$parent">
<type by_reference="false">object</type>
</tag>
<tag line="10" name="param" description="the index at where to search the child" type="int" variable="$index">
<type by_reference="false">int</type>
</tag>
<tag line="10" name="return" description="the child" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="17">
<name>$parent</name>
<default/>
<type/>
</argument>
<argument line="17">
<name>$index</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="25" package="Default">
<name>getChildCount</name>
<docblock>
<description>This method returns the number of children of the given node.</description>
<long-description>
</long-description>
<tag line="19" name="param" description="the parent to get the child count from" type="object" variable="$parent">
<type by_reference="false">object</type>
</tag>
<tag line="19" name="return" description="int the child count of the node" type="boolean">
<type by_reference="false">boolean</type>
</tag>
</docblock>
<argument line="25">
<name>$parent</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="34" package="Default">
<name>getIndexOfChild</name>
<docblock>
<description>This method returns the index of the given child of the given parent.</description>
<long-description>
</long-description>
<tag line="27" name="param" description="the parent to search in" type="object" variable="$parent">
<type by_reference="false">object</type>
</tag>
<tag line="27" name="param" description="the child whose index has to be determined" type="object" variable="$child">
<type by_reference="false">object</type>
</tag>
<tag line="27" name="return" description="the index of the child" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="34">
<name>$parent</name>
<default/>
<type/>
</argument>
<argument line="34">
<name>$child</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="41" package="Default">
<name>getRoot</name>
<docblock>
<description>This method returns the root of the tree</description>
<long-description>
</long-description>
<tag line="36" name="return" description="the root of the tree" type="\ReingoldTilford\Models\onject">
<type by_reference="false">\ReingoldTilford\Models\onject</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="49" package="Default">
<name>isLeaf</name>
<docblock>
<description>This method decides whether or not the given node is a leaf or not</description>
<long-description>
</long-description>
<tag line="43" name="param" description="the node to make the test for" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="43" name="return" description="true, if the given node is a leaf, else false" type="boolean">
<type by_reference="false">boolean</type>
</tag>
</docblock>
<argument line="49">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="54" package="Default">
<name>getLabel</name>
<docblock>
<description>This method returns the label associated with a tree node</description>
<long-description>
</long-description>
</docblock>
<argument line="54">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
</interface>
</file>
<file path="\src\ReingoldTilford\Models\TreeModel.inc" hash="47bcc94df5f3472813cbbd003a0af950" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\ReingoldTilford\Models\TreeModel.inc</error>
</parse_markers>
<class final="false" abstract="true" line="8" namespace="ReingoldTilford\Models" package="Default">
<name>TreeModel</name>
<extends/>
<full_name>\ReingoldTilford\Models\TreeModel</full_name>
<docblock>
<description>This class acts as an abstract ITreeModel implementation, implementing the most basic elements.</description>
<long-description>
</long-description>
</docblock>
<implements>\ReingoldTilford\Models\ITreeModel</implements>
<property final="false" static="false" visibility="protected" line="15" package="Default">
<name>$root</name>
<default>null</default>
<docblock>
<description>the root of the tree</description>
<long-description>
</long-description>
<tag line="10" name="var" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="22" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the TreeNodeTreeModel.</description>
<long-description>
</long-description>
<tag line="17" name="param" description="the root of the tree" type="object" variable="$root">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="22">
<name>$root</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="32" package="Default">
<name>getRoot</name>
<docblock>
<description>This method returns the root of the tree.</description>
<long-description>
</long-description>
<tag line="27" name="return" description="the root of the tree" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="43" package="Default">
<name>isLeaf</name>
<docblock>
<description>This method returns true if the given node is a leaf.</description>
<long-description>
</long-description>
<tag line="37" name="param" description="the node" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="37" name="return" description="true, if the the node is a leaf, else false" type="boolean">
<type by_reference="false">boolean</type>
</tag>
</docblock>
<argument line="43">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="56" package="Default">
<name>getLabel</name>
<docblock>
<description>This method returns the label of the given node.</description>
<long-description><p>This default implementation return the empty string.</p>
</long-description>
<tag line="48" name="param" description="the node for which to get the label" type="\ReingoldTilford\Models\type" variable="$node">
<type by_reference="false">\ReingoldTilford\Models\type</type>
</tag>
<tag line="48" name="return" description="the label of the given node" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="56">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\ReingoldTilford\Plotters\Plotter.inc" hash="fef35da074160d009a09b8524f0e1765" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\ReingoldTilford\Plotters\Plotter.inc</error>
</parse_markers>
<namespace-alias name="Layout">ReingoldTilford\Algorithms\Layout</namespace-alias>
<namespace-alias name="ITreeModel">ReingoldTilford\Models\ITreeModel</namespace-alias>
<namespace-alias name="TreeStyle">ReingoldTilford\Styles\TreeStyle</namespace-alias>
<namespace-alias name="ShapeFactory">Utils\Graphics2D\Shapes\ShapeFactory</namespace-alias>
<namespace-alias name="EdgeFactory">Utils\Graphics2D\Shapes\EdgeFactory</namespace-alias>
<namespace-alias name="TextFactory">Utils\Graphics2D\Shapes\TextFactory</namespace-alias>
<namespace-alias name="DrawingPane">Utils\Graphics2D\DrawingPanes\DrawingPane</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="17" namespace="ReingoldTilford\Plotters" package="Default">
<name>Plotter</name>
<extends/>
<full_name>\ReingoldTilford\Plotters\Plotter</full_name>
<docblock>
<description>This class can plot the layout returned by the Reingolf-Tilford tree drawing algorithm.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="24" package="Default">
<name>$model</name>
<default>null</default>
<docblock>
<description>the tree model</description>
<long-description>
</long-description>
<tag line="19" name="var" description="" type="\ReingoldTilford\Models\ITreeModel">
<type by_reference="false">\ReingoldTilford\Models\ITreeModel</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="31" package="Default">
<name>$layout</name>
<default>null</default>
<docblock>
<description>the layout</description>
<long-description>
</long-description>
<tag line="26" name="var" description="" type="\ReingoldTilford\Algorithms\Layout">
<type by_reference="false">\ReingoldTilford\Algorithms\Layout</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="38" package="Default">
<name>$treeStyle</name>
<default>null</default>
<docblock>
<description>the tree style</description>
<long-description>
</long-description>
<tag line="33" name="var" description="" type="\ReingoldTilford\Styles\TreeStyle">
<type by_reference="false">\ReingoldTilford\Styles\TreeStyle</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="45" package="Default">
<name>$shapeFactory</name>
<default>null</default>
<docblock>
<description>the factory for creating shapes</description>
<long-description>
</long-description>
<tag line="40" name="var" description="" type="\Utils\Graphics2D\Shapes\ShapeFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\ShapeFactory</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="52" package="Default">
<name>$edgeFactory</name>
<default>null</default>
<docblock>
<description>the factory for creating edges</description>
<long-description>
</long-description>
<tag line="47" name="var" description="" type="\Utils\Graphics2D\Shapes\EdgeFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\EdgeFactory</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="59" package="Default">
<name>$textFactory</name>
<default>null</default>
<docblock>
<description>the factory for creating texts</description>
<long-description>
</long-description>
<tag line="54" name="var" description="" type="\Utils\Graphics2D\Shapes\TextFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\TextFactory</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="66" package="Default">
<name>$shapeMap</name>
<default>null</default>
<docblock>
<description>the mapping from nodes to shapes</description>
<long-description>
</long-description>
<tag line="61" name="var" description="" type="\SplObjectStorage">
<type by_reference="false">\SplObjectStorage</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="77" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="68" name="param" description="the tree model" type="\ReingoldTilford\Models\ITreeModel" variable="$model">
<type by_reference="false">\ReingoldTilford\Models\ITreeModel</type>
</tag>
<tag line="68" name="param" description="the layout" type="\ReingoldTilford\Algorithms\Layout" variable="$layout">
<type by_reference="false">\ReingoldTilford\Algorithms\Layout</type>
</tag>
<tag line="68" name="param" description="the factory for creating shapes" type="\Utils\Graphics2D\Shapes\ShapeFactory" variable="$shapeFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\ShapeFactory</type>
</tag>
<tag line="68" name="param" description="the factory for creating edges" type="\Utils\Graphics2D\Shapes\EdgeFactory" variable="$edgeFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\EdgeFactory</type>
</tag>
<tag line="68" name="param" description="the factory for creating texts" type="\Utils\Graphics2D\Shapes\TextFactory" variable="$textFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\TextFactory</type>
</tag>
</docblock>
<argument line="77">
<name>$model</name>
<default/>
<type>ITreeModel</type>
</argument>
<argument line="77">
<name>$layout</name>
<default/>
<type>Layout</type>
</argument>
<argument line="77">
<name>$shapeFactory</name>
<default>null</default>
<type>ShapeFactory</type>
</argument>
<argument line="77">
<name>$edgeFactory</name>
<default>null</default>
<type>EdgeFactory</type>
</argument>
<argument line="77">
<name>$textFactory</name>
<default>null</default>
<type>TextFactory</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="97" package="Default">
<name>getShapeFactory</name>
<docblock>
<description>This method returns the shape factory.</description>
<long-description>
</long-description>
<tag line="92" name="return" description="the shape factory" type="\Utils\Graphics2D\Shapes\ShapeFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\ShapeFactory</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="107" package="Default">
<name>getEdgeFactory</name>
<docblock>
<description>This method returns the edge factory.</description>
<long-description>
</long-description>
<tag line="102" name="return" description="the edge factory" type="\Utils\Graphics2D\Shapes\EdgeFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\EdgeFactory</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="117" package="Default">
<name>setShapeFactory</name>
<docblock>
<description>This method sets the shape factory.</description>
<long-description>
</long-description>
<tag line="112" name="param" description="the new shape factory" type="\Utils\Graphics2D\Shapes\ShapeFactory" variable="$shapeFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\ShapeFactory</type>
</tag>
</docblock>
<argument line="117">
<name>$shapeFactory</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="127" package="Default">
<name>setEdgeFactory</name>
<docblock>
<description>This method sets the edge factory.</description>
<long-description>
</long-description>
<tag line="122" name="param" description="the new edge factory" type="\Utils\Graphics2D\Shapes\EdgeFactory" variable="$edgeFactory">
<type by_reference="false">\Utils\Graphics2D\Shapes\EdgeFactory</type>
</tag>
</docblock>
<argument line="127">
<name>$edgeFactory</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="139" package="Default">
<name>plot</name>
<docblock>
<description>This method plots the tree with the given TreeStyle onto the given IDrawingPane</description>
<long-description>
</long-description>
<tag line="132" name="param" description="the style to use for the plotting" type="\ReingoldTilford\Styles\TreeStyle" variable="$style">
<type by_reference="false">\ReingoldTilford\Styles\TreeStyle</type>
</tag>
<tag line="132" name="param" description="the drawing pane to plot on" type="\Utils\Graphics2D\DrawingPanes\DrawingPane" variable="$drawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DrawingPane</type>
</tag>
<tag line="132" name="return" description="the DrawingPane, with the plotting of the tree" type="\Utils\Graphics2D\DrawingPanes\DrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DrawingPane</type>
</tag>
</docblock>
<argument line="139">
<name>$style</name>
<default/>
<type>TreeStyle</type>
</argument>
<argument line="139">
<name>$drawingPane</name>
<default/>
<type>DrawingPane</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="159" package="Default">
<name>plotIterativ</name>
<docblock>
<description>This method plots the tree in an interative way.</description>
<long-description>
</long-description>
<tag line="154" name="param" description="the root node of the tree" type="object" variable="$root">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="159">
<name>$root</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="192" package="Default">
<name>plotRecursive</name>
<docblock>
<description>This method plots the tree in a recursive way.</description>
<long-description><p>This might not be a good idea for real huge trees.</p>
</long-description>
<tag line="185" name="param" description="the current node to plot" type="object" variable="$root">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="192">
<name>$root</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="protected" line="217" package="Default">
<name>drawShape</name>
<docblock>
<description>This method exports a node as a source shape.</description>
<long-description>
</long-description>
<tag line="211" name="param" description="the node to export" type="object" variable="$node">
<type by_reference="false">object</type>
</tag>
<tag line="211" name="return" description="the shape associated with the given source node" type="\ReingoldTilford\Plotters\Shape">
<type by_reference="false">\ReingoldTilford\Plotters\Shape</type>
</tag>
</docblock>
<argument line="217">
<name>$node</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="protected" line="236" package="Default">
<name>drawEdges</name>
<docblock>
<description>This method exports the edges between the source and its target nodes.</description>
<long-description>
</long-description>
<tag line="231" name="param" description="the soure node" type="object" variable="$sourceNode">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="236">
<name>$sourceNode</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="252" package="Default">
<name>getTargetShapes</name>
<docblock>
<description>This method returns the target shapes for a given source node.</description>
<long-description>
</long-description>
<tag line="246" name="param" description="the source node for which to get the target shapes" type="object" variable="$sourceNode">
<type by_reference="false">object</type>
</tag>
<tag line="246" name="return" description="the target shapes associated with the given source node" type="\ArrayObject">
<type by_reference="false">\ArrayObject</type>
</tag>
</docblock>
<argument line="252">
<name>$sourceNode</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\ReingoldTilford\Styles\TreeStyle.inc" hash="c728b8cd1067191bd9964603c2fae493" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\ReingoldTilford\Styles\TreeStyle.inc</error>
</parse_markers>
<namespace-alias name="IStyle">Utils\Graphics2D\Shapes\Styles\IStyle</namespace-alias>
<namespace-alias name="ShapeStyle">Utils\Graphics2D\Shapes\Styles\ShapeStyle</namespace-alias>
<namespace-alias name="EdgeStyle">Utils\Graphics2D\Shapes\Styles\EdgeStyle</namespace-alias>
<namespace-alias name="TextStyle">Utils\Graphics2D\Shapes\Styles\TextStyle</namespace-alias>
<class final="false" abstract="false" line="13" namespace="ReingoldTilford\Styles" package="Default">
<name>TreeStyle</name>
<extends/>
<full_name>\ReingoldTilford\Styles\TreeStyle</full_name>
<docblock>
<description>This class implements a style for trees.</description>
<long-description>
</long-description>
</docblock>
<implements>\Utils\Graphics2D\Shapes\Styles\IStyle</implements>
<constant namespace="ReingoldTilford\Styles" line="18" package="Default">
<name>LEFT_BOUND</name>
<value>0</value>
<docblock>
<description>the identifier for a left-bound orientation of child nodes</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="ReingoldTilford\Styles" line="23" package="Default">
<name>CENTERED</name>
<value>1</value>
<docblock>
<description>the identifier for a centered orientation of child nodes</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="ReingoldTilford\Styles" line="28" package="Default">
<name>RIGHT_BOUND</name>
<value>2</value>
<docblock>
<description>the identifier for a right-bound orientation of child nodes</description>
<long-description>
</long-description>
</docblock>
</constant>
<property final="false" static="false" visibility="private" line="35" package="Default">
<name>$shapeStyle</name>
<default>null</default>
<docblock>
<description>the style of the shapes</description>
<long-description>
</long-description>
<tag line="30" name="var" description="" type="\Utils\Graphics2D\Shapes\Styles\ShapeStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\ShapeStyle</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="42" package="Default">
<name>$edgeStyle</name>
<default>null</default>
<docblock>
<description>the style of the edges</description>
<long-description>
</long-description>
<tag line="37" name="var" description="" type="\Utils\Graphics2D\Shapes\Styles\EdgeStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\EdgeStyle</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="49" package="Default">
<name>$textStyle</name>
<default>null</default>
<docblock>
<description>the style of the text</description>
<long-description>
</long-description>
<tag line="44" name="var" description="" type="\Utils\Graphics2D\Shapes\Styles\TextStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="56" package="Default">
<name>$xOffset</name>
<default>null</default>
<docblock>
<description>the offset of the left of a node to the left to the node right next to it on the same level (meassured in the measuring unit given by TreeStyle::unit)</description>
<long-description>
</long-description>
<tag line="51" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="64" package="Default">
<name>$yOffset</name>
<default>null</default>
<docblock>
<description>the offset from the top of a father to the top of its sons (meassured in the measuring unit given by TreeStyle::unit)
for a radial layout, this is used to determine the radius increment between levels</description>
<long-description>
</long-description>
<tag line="58" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="71" package="Default">
<name>$xPadding</name>
<default>null</default>
<docblock>
<description>the offset from the top of the container to the top of the root (meassured in the measuring unit given by TreeStyle::unit)</description>
<long-description>
</long-description>
<tag line="66" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="78" package="Default">
<name>$yPadding</name>
<default>null</default>
<docblock>
<description>the offset from the left of the container to the left of the most left node (meassured in the measuring unit given by TreeStyle::unit)</description>
<long-description>
</long-description>
<tag line="73" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="85" package="Default">
<name>$unit</name>
<default>null</default>
<docblock>
<description>the measuring unit of the layout</description>
<long-description>
</long-description>
<tag line="80" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="92" package="Default">
<name>$orientation</name>
<default>null</default>
<docblock>
<description>the orientation of the tree, either one of left, center or right hierarchical</description>
<long-description>
</long-description>
<tag line="87" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="107" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="94" name="param" description="the style of the shapes" type="\Utils\Graphics2D\Shapes\Styles\ShapeStyle" variable="$shapeStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\ShapeStyle</type>
</tag>
<tag line="94" name="param" description="the style of the edges" type="\Utils\Graphics2D\Shapes\Styles\EdgeStyle" variable="$edgeStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\EdgeStyle</type>
</tag>
<tag line="94" name="param" description="the style of the text" type="\Utils\Graphics2D\Shapes\Styles\TextStyle" variable="$textStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
<tag line="94" name="param" description="the x-offset" type="\ReingoldTilford\Styles\type" variable="$xOffset">
<type by_reference="false">\ReingoldTilford\Styles\type</type>
</tag>
<tag line="94" name="param" description="the y-offset" type="\ReingoldTilford\Styles\type" variable="$yOffset">
<type by_reference="false">\ReingoldTilford\Styles\type</type>
</tag>
<tag line="94" name="param" description="the x-padding" type="\ReingoldTilford\Styles\type" variable="$xPadding">
<type by_reference="false">\ReingoldTilford\Styles\type</type>
</tag>
<tag line="94" name="param" description="the y-padding" type="\ReingoldTilford\Styles\type" variable="$yPadding">
<type by_reference="false">\ReingoldTilford\Styles\type</type>
</tag>
<tag line="94" name="param" description="the unit to use" type="\ReingoldTilford\Styles\type" variable="$unit">
<type by_reference="false">\ReingoldTilford\Styles\type</type>
</tag>
<tag line="94" name="param" description="the orientation of the child nodes, one of self::LEFT_BOUND, self::CENTERED, self::RIGHT_BOUND" type="\ReingoldTilford\Styles\type" variable="$orientation">
<type by_reference="false">\ReingoldTilford\Styles\type</type>
</tag>
</docblock>
<argument line="107">
<name>$shapeStyle</name>
<default>null</default>
<type>ShapeStyle</type>
</argument>
<argument line="108">
<name>$edgeStyle</name>
<default>null</default>
<type>EdgeStyle</type>
</argument>
<argument line="109">
<name>$textStyle</name>
<default>null</default>
<type>TextStyle</type>
</argument>
<argument line="110">
<name>$xOffset</name>
<default>5</default>
<type/>
</argument>
<argument line="110">
<name>$yOffset</name>
<default>10</default>
<type/>
</argument>
<argument line="110">
<name>$xPadding</name>
<default>40</default>
<type/>
</argument>
<argument line="110">
<name>$yPadding</name>
<default>40</default>
<type/>
</argument>
<argument line="111">
<name>$unit</name>
<default>'px'</default>
<type/>
</argument>
<argument line="111">
<name>$orientation</name>
<default>TreeStyle::CENTERED</default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="138" package="Default">
<name>__get</name>
<docblock>
<description>This method is a magic getter method for the class.</description>
<long-description>
</long-description>
<tag line="131" name="todo" description="replace this with Trait in PHP 5.4"/>
<tag line="131" name="param" description="the name of the member to get" type="string" variable="$memberName">
<type by_reference="false">string</type>
</tag>
<tag line="131" name="return" description="the value of the member" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="138">
<name>$memberName</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="148" package="Default">
<name>setTreeOrientation</name>
<docblock>
<description>This method sets the tree orientation.</description>
<long-description>
</long-description>
<tag line="143" name="param" description="the new tree orientation, one of self::LEFT_BOUND, self::CENTERED, self::RIGHT_BOUND" type="int" variable="$orientation">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="148">
<name>$orientation</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="162" package="Default">
<name>setXOffset</name>
<docblock>
<description>This method sets the x-offset.</description>
<long-description>
</long-description>
<tag line="157" name="param" description="the new x-offset" type="int" variable="$xOffset">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="162">
<name>$xOffset</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="172" package="Default">
<name>setYOffset</name>
<docblock>
<description>This method sets the y-offset.</description>
<long-description>
</long-description>
<tag line="167" name="param" description="the new y-offset" type="int" variable="$yOffset">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="172">
<name>$yOffset</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="182" package="Default">
<name>setXPadding</name>
<docblock>
<description>This method sets the x-padding.</description>
<long-description>
</long-description>
<tag line="177" name="param" description="the new x-padding" type="int" variable="$xPadding">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="182">
<name>$xPadding</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="192" package="Default">
<name>setYPadding</name>
<docblock>
<description>This method sets the y-padding.</description>
<long-description>
</long-description>
<tag line="187" name="param" description="the new y-padding" type="int" variable="$yPadding">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="192">
<name>$yPadding</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Autoload\Autoloader.inc" hash="4c7c1afb8e4a56743f0597f9d505292e" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Autoload\Autoloader.inc</error>
</parse_markers>
<include type="Require Once" line="8">
<name>SourceFileNotFoundException.inc</name>
</include>
<class final="false" abstract="false" line="13" namespace="Utils\Autoload" package="Default">
<name>Autoloader</name>
<extends/>
<full_name>\Utils\Autoload\Autoloader</full_name>
<docblock>
<description>This class acts as a just-in-time autoloader for class files. Given a base directory, class files are looked up by mapping the classes namespace to a folder, and the class name to a file name in that particular folder.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="20" package="Default">
<name>$baseDirectory</name>
<default>null</default>
<docblock>
<description>the base directory from where to start looking for source files</description>
<long-description>
</long-description>
<tag line="15" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="27" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="22" name="param" description="the base directory from where to start looking for source files" type="\Utils\Autoload\type" variable="$baseDirectory">
<type by_reference="false">\Utils\Autoload\type</type>
</tag>
</docblock>
<argument line="27">
<name>$baseDirectory</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="39" package="Default">
<name>autoload</name>
<docblock>
<description>This method tries to load the source file associated with the class denoted by the given class name.</description>
<long-description><p>If no source file can be found, a SourceFileNotFoundException will be thrown.</p>
</long-description>
<tag line="32" name="param" description="the name of the class to load the source file for" type="string" variable="$className">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="39">
<name>$className</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="54" package="Default">
<name>getFileName</name>
<docblock>
<description>This method determines the file name for a given class name, taking the base directory into account.</description>
<long-description>
</long-description>
<tag line="48" name="param" description="the name of the class to load the source file for" type="string" variable="$className">
<type by_reference="false">string</type>
</tag>
<tag line="48" name="return" description="the absolute path to the source file" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="54">
<name>$className</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Autoload\SourceFileNotFoundException.inc" hash="f2377a05cfc80ac1579dc3b609916bfa" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Autoload\SourceFileNotFoundException.inc</error>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="Utils\Autoload" package="Default">
<name>SourceFileNotFoundException</name>
<extends>\RuntimeException</extends>
<full_name>\Utils\Autoload\SourceFileNotFoundException</full_name>
<docblock>
<description>This class represents an exception, which is thrown when the autoloader is unable to locate a source file that holds the definition of a class or interface.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="15" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor for the class.</description>
<long-description>
</long-description>
<tag line="10" name="param" description="the name of the class/interface which could not be found." type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="15">
<name>$name</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Color\Color.inc" hash="31641823f05c11762f8a7058057e8a15" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Color\Color.inc</error>
</parse_markers>
<class final="false" abstract="true" line="8" namespace="Utils\Color" package="Default">
<name>Color</name>
<extends/>
<full_name>\Utils\Color\Color</full_name>
<docblock>
<description>This class serves as abstract class for any color.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="15" package="Default">
<name>__construct</name>
<docblock>
<description>This method is the constructor of the class.</description>
<long-description>
</long-description>
<tag line="10" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="27" package="Default">
<name>__get</name>
<docblock>
<description>This is a magic getter for the members of this class.</description>
<long-description>
</long-description>
<tag line="19" name="param" description="the name of the member to get" type="string" variable="$memberName">
<type by_reference="false">string</type>
</tag>
<tag line="19" name="return" description="the respective member" type="mixed">
<type by_reference="false">mixed</type>
</tag>
<tag line="19" name="todo" description="this should not be in an abstract class, as it implies this functionality for all of its subclasses"/>
<tag line="19" name="todo" description="replace this with Trait in subclasses"/>
</docblock>
<argument line="27">
<name>$memberName</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Color\RgbColor.inc" hash="2448a22192713d7870e16a69324fccc0" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Color\RgbColor.inc</error>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="Utils\Color" package="Default">
<name>RgbColor</name>
<extends>\Utils\Color\Color</extends>
<full_name>\Utils\Color\RgbColor</full_name>
<docblock>
<description>This class encapsulates an RGB color.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="protected" line="15" package="Default">
<name>$red</name>
<default>0</default>
<docblock>
<description>the red color component</description>
<long-description>
</long-description>
<tag line="10" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="22" package="Default">
<name>$green</name>
<default>0</default>
<docblock>
<description>the green color component</description>
<long-description>
</long-description>
<tag line="17" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="29" package="Default">
<name>$blue</name>
<default>0</default>
<docblock>
<description>the blue color component</description>
<long-description>
</long-description>
<tag line="24" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="39" package="Default">
<name>__construct</name>
<docblock>
<description>This method is the constructor of the class.</description>
<long-description>
</long-description>
<tag line="31" name="param" description="the red color component" type="int" variable="$red">
<type by_reference="false">int</type>
</tag>
<tag line="31" name="param" description="the green color component" type="int" variable="$green">
<type by_reference="false">int</type>
</tag>
<tag line="31" name="param" description="the blue color component" type="int" variable="$blue">
<type by_reference="false">int</type>
</tag>
<tag line="31" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="39">
<name>$red</name>
<default/>
<type/>
</argument>
<argument line="39">
<name>$green</name>
<default/>
<type/>
</argument>
<argument line="39">
<name>$blue</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="55" package="Default">
<name>__toString</name>
<docblock>
<description>This method returns the DOM representation of the color, e.g. #000000 for black.</description>
<long-description>
</long-description>
<tag line="50" name="return" description="the color as string in its DOM representation" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="\src\Utils\File\Directory.inc" hash="1a263963b039bfa6f9ab7db335af202d" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\File\Directory.inc</error>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="Utils\File" package="Default">
<name>Directory</name>
<extends>\Utils\File\FileSystemObject</extends>
<full_name>\Utils\File\Directory</full_name>
<docblock>
<description>This class represents a directory in the file system. It contains a collection of children referencing files and other directories.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="protected" line="15" package="Default">
<name>$children</name>
<default>null</default>
<docblock>
<description>the children of the directory</description>
<long-description>
</long-description>
<tag line="10" name="var" description="" type="\ArrayObject">
<type by_reference="false">\ArrayObject</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="22" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="17" name="param" description="the file information object associated with this directory" type="\SplFileInfo" variable="$fileInfo">
<type by_reference="false">\SplFileInfo</type>
</tag>
</docblock>
<argument line="22">
<name>$fileInfo</name>
<default/>
<type>SplFileInfo</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="34" package="Default">
<name>addChild</name>
<docblock>
<description>This method adds a child to this directory.</description>
<long-description>
</long-description>
<tag line="29" name="param" description="the child to add" type="\Utils\File\FileSystemObject" variable="$child">
<type by_reference="false">\Utils\File\FileSystemObject</type>
</tag>
</docblock>
<argument line="34">
<name>$child</name>
<default/>
<type>FileSystemObject</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="47" package="Default">
<name>getChild</name>
<docblock>
<description>This method gets the child from the given index.</description>
<long-description>
</long-description>
<tag line="41" name="param" description="the index from where to get the child" type="int" variable="$index">
<type by_reference="false">int</type>
</tag>
<tag line="41" name="return" description="the child at the given index or null if none exists at this index." type="\Utils\File\FileSystemObject">
<type by_reference="false">\Utils\File\FileSystemObject</type>
</tag>
</docblock>
<argument line="47">
<name>$index</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="57" package="Default">
<name>getDecendants</name>
<docblock>
<description>This method returns all the decendants of a Directory recursively.</description>
<long-description>
</long-description>
<tag line="52" name="return" description="of FileSystemObjects" type="\ArrayObject">
<type by_reference="false">\ArrayObject</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="87" package="Default">
<name>expand</name>
<docblock>
<description>This method expands this directory to include all its subdirectories and files.</description>
<long-description>
</long-description>
<tag line="82" name="return" description="this directory, with all its subdirectories and files" type="\Utils\File\Directory">
<type by_reference="false">\Utils\File\Directory</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="true" visibility="public" line="123" package="Default">
<name>toRealPath</name>
<docblock>
<description>This method returns the absolute path to a given relative one. When calling this method for a directory, then the resulting absolute path will always have a trailing slash.</description>
<long-description><p>Note, the referenced directory or file must exist physically prior to calling this method.</p>
</long-description>
<tag line="115" name="param" description="the relative path to the file system object" type="string" variable="$relativePath">
<type by_reference="false">string</type>
</tag>
<tag line="115" name="return" description="the absolute path for the given relative one" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="123">
<name>$relativePath</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\File\File.inc" hash="afae3b55be616fab46c2d5319b56fbb3" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\File\File.inc</error>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="Utils\File" package="Default">
<name>File</name>
<extends>\Utils\File\FileSystemObject</extends>
<full_name>\Utils\File\File</full_name>
<docblock>
<description>This class represents a file in the file system.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="15" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="10" name="param" description="the file information object associated with this file" type="\SplFileInfo" variable="$fileInfo">
<type by_reference="false">\SplFileInfo</type>
</tag>
</docblock>
<argument line="15">
<name>$fileInfo</name>
<default/>
<type>SplFileInfo</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\File\FileSystemObject.inc" hash="afaa5b02ca5ed56dcd642dc722febf43" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\File\FileSystemObject.inc</error>
</parse_markers>
<class final="false" abstract="true" line="8" namespace="Utils\File" package="Default">
<name>FileSystemObject</name>
<extends/>
<full_name>\Utils\File\FileSystemObject</full_name>
<docblock>
<description>This class represents an abstract object in the file system.</description>
<long-description>
</long-description>
</docblock>
<implements>\Utils\File\IFileSystemObject</implements>
<property final="false" static="false" visibility="protected" line="15" package="Default">
<name>$fileInfo</name>
<default>null</default>
<docblock>
<description>the file information object associated with this file system object</description>
<long-description>
</long-description>
<tag line="10" name="var" description="" type="\SplFileInfo">
<type by_reference="false">\SplFileInfo</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="22" package="Default">
<name>$parent</name>
<default>null</default>
<docblock>
<description>the parent directory of the file system object</description>
<long-description>
</long-description>
<tag line="17" name="var" description="" type="\Utils\File\Directory">
<type by_reference="false">\Utils\File\Directory</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="29" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="24" name="param" description="the file information object associated with this file system object" type="\SplFileInfo" variable="$fileInfo">
<type by_reference="false">\SplFileInfo</type>
</tag>
</docblock>
<argument line="29">
<name>$fileInfo</name>
<default/>
<type>SplFileInfo</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="39" package="Default">
<name>getBasename</name>
<docblock>
<description>This method returns the base name of the file system object.</description>
<long-description>
</long-description>
<tag line="34" name="return" description="the base name of the file system object" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="49" package="Default">
<name>getPathname</name>
<docblock>
<description>This method returns the path name of this file system object.</description>
<long-description>
</long-description>
<tag line="44" name="return" description="the path name of this file system object" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="59" package="Default">
<name>getParent</name>
<docblock>
<description>This method returns the parent directory of this file system object.</description>
<long-description>
</long-description>
<tag line="54" name="return" description="the parent directory of this file system object" type="\Utils\File\Directory">
<type by_reference="false">\Utils\File\Directory</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="69" package="Default">
<name>__toString</name>
<docblock>
<description>This method returns the string representation of the file system object, i.e. its base name.</description>
<long-description>
</long-description>
<tag line="64" name="return" description="the base name of the file system object as string" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="\src\Utils\File\IFileSystemObject.inc" hash="c17d06ee5b37076288851eaeb131c794" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\File\IFileSystemObject.inc</error>
</parse_markers>
<interface namespace="Utils\File" line="8" package="Default">
<name>IFileSystemObject</name>
<extends/>
<full_name>\Utils\File\IFileSystemObject</full_name>
<docblock>
<description>This interface defines a type for representing an abstract object in the file system.</description>
<long-description>
</long-description>
</docblock>
</interface>
</file>
<file path="\src\Utils\Font\FontManager.inc" hash="17bd524e4f6fe578c02cebd2ec948ca2" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Font\FontManager.inc</error>
</parse_markers>
<namespace-alias name="TextStyle">Utils\Graphics2D\Shapes\Styles\TextStyle</namespace-alias>
<namespace-alias name="FontMetric">Utils\Font\FontMetric</namespace-alias>
<namespace-alias name="FontMetricService">Utils\Font\FontMetricServices\FontMetricService</namespace-alias>
<class final="false" abstract="false" line="12" namespace="Utils\Font" package="Default">
<name>FontManager</name>
<extends/>
<full_name>\Utils\Font\FontManager</full_name>
<docblock>
<description>This class is responsible for managing font metrics.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="19" package="Default">
<name>$fontMetrics</name>
<default>null</default>
<docblock>
<description>the collection containing the FontMetrics</description>
<long-description>
</long-description>
<tag line="14" name="var" description="" type="\Utils\Font\ArrayObject">
<type by_reference="false">\Utils\Font\ArrayObject</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="26" package="Default">
<name>$fontMetricService</name>
<default>null</default>
<docblock>
<description>the FontMetricService that is in use to get FontMetrics out of TextStyles</description>
<long-description>
</long-description>
<tag line="21" name="var" description="" type="\Utils\Font\FontMetricServices\FontMetricService">
<type by_reference="false">\Utils\Font\FontMetricServices\FontMetricService</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="33" package="Default">
<name>$fontMetricsFileName</name>
<default>'fontMetrics.ser'</default>
<docblock>
<description>the file name where FontMetrics are cached</description>
<long-description>
</long-description>
<tag line="28" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="40" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class,</description>
<long-description>
</long-description>
<tag line="35" name="param" description="the FontMetricService to use" type="\Utils\Font\FontMetricServices\FontMetricService" variable="$fontMetricService">
<type by_reference="false">\Utils\Font\FontMetricServices\FontMetricService</type>
</tag>
</docblock>
<argument line="40">
<name>$fontMetricService</name>
<default>null</default>
<type>FontMetricService</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="52" package="Default">
<name>initializeFontMetrics</name>
<docblock>
<description>This method initialises the internal FontMetrics data structure, i.e. loading FontMetrics from the cache, if a cache file exists.</description>
<long-description>
</long-description>
<tag line="47" name="return" description="true, if a cache for FontMetrics was found, else false" type="boolean">
<type by_reference="false">boolean</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="73" package="Default">
<name>createFontMetric</name>
<docblock>
<description>This method creates a FontMetric for a given TextStyle on behalf of the used FontMetricService.</description>
<long-description>
</long-description>
<tag line="68" name="param" description="the TextStyle for which a FontMetric has to be created" type="\Utils\Graphics2D\Shapes\Styles\TextStyle" variable="$textStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
</docblock>
<argument line="73">
<name>$textStyle</name>
<default/>
<type>TextStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="84" package="Default">
<name>getFontMetricsPath</name>
<docblock>
<description>This method returns the full path to the file where FontMetrics are cached persistently.</description>
<long-description>
</long-description>
<tag line="79" name="return" description="the full path to the FontMetrics cache file" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="94" package="Default">
<name>addFontMetric</name>
<docblock>
<description>This method adds a FontMetric to the FontManager.</description>
<long-description>
</long-description>
<tag line="89" name="param" description="the FontMetric to be added" type="\Utils\Font\FontMetric" variable="$metric">
<type by_reference="false">\Utils\Font\FontMetric</type>
</tag>
</docblock>
<argument line="94">
<name>$metric</name>
<default/>
<type>FontMetric</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="109" package="Default">
<name>getFontMetric</name>
<docblock>
<description>This method returns the FontMetric for a given TextStyle.</description>
<long-description><p>If the FontMetric for the given TextStyle is not yet created, the FontMetricService is being called, to first create it.</p>
</long-description>
<tag line="101" name="param" description="the TextStyle whose FontMetric has to be retrieved" type="\Utils\Graphics2D\Shapes\Styles\TextStyle" variable="$textStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
<tag line="101" name="return" description="the FontMetric for the given TextStyle" type="\Utils\Font\FontMetric">
<type by_reference="false">\Utils\Font\FontMetric</type>
</tag>
</docblock>
<argument line="109">
<name>$textStyle</name>
<default/>
<type>TextStyle</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Font\FontMetric.inc" hash="8918855eb40f93292924cf22d9b9507b" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Font\FontMetric.inc</error>
</parse_markers>
<namespace-alias name="TextStyle">Utils\Graphics2D\Shapes\Styles\TextStyle</namespace-alias>
<class final="false" abstract="false" line="10" namespace="Utils\Font" package="Default">
<name>FontMetric</name>
<extends/>
<full_name>\Utils\Font\FontMetric</full_name>
<docblock>
<description>This class encapsulates font metrics, i.e. for a given font family and font size given as text stlye, it can calculate the width and height of a string or a collection of strings.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="17" package="Default">
<name>$textStyle</name>
<default>null</default>
<docblock>
<description>the TextStyle the FontMetric is based on</description>
<long-description>
</long-description>
<tag line="12" name="var" description="" type="\Utils\Graphics2D\Shapes\Styles\TextStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="24" package="Default">
<name>$metrics</name>
<default>null</default>
<docblock>
<description>the metrics of the TextStyle, i.e. a mapping from the ASCII code of the TextStyle to the width of the respective character</description>
<long-description>
</long-description>
<tag line="19" name="var" description="" type="\Utils\Font\ArrayObject">
<type by_reference="false">\Utils\Font\ArrayObject</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="32" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="26" name="param" description="the text style to use for the metric" type="\Utils\Graphics2D\Shapes\Styles\TextStyle" variable="$textStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
<tag line="26" name="param" description="the metrics of the text style, i.e. a mapping from the ASCII code of the TextStyle to the width of the respective character" type="\int[]" variable="$charMetrics">
<type by_reference="false">\int[]</type>
</tag>
</docblock>
<argument line="32">
<name>$textStyle</name>
<default/>
<type>TextStyle</type>
</argument>
<argument line="32">
<name>$charMetrics</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="45" package="Default">
<name>getWidth</name>
<docblock>
<description>This method calculates the width of a string in pixel.</description>
<long-description>
</long-description>
<tag line="39" name="param" description="the string whose width has to be calculated" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
<tag line="39" name="return" description="the width of the string in pixels" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="45">
<name>$string</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="65" package="Default">
<name>getMaxWidth</name>
<docblock>
<description>This method calculates the maximal width of a string in a collection of strings.</description>
<long-description>
</long-description>
<tag line="59" name="param" description="the collection of strings" type="\Traversable" variable="$strings">
<type by_reference="false">\Traversable</type>
</tag>
<tag line="59" name="return" description="the maximal width of the strings in the collection" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="65">
<name>$strings</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="85" package="Default">
<name>getHeight</name>
<docblock>
<description>This method calculates the height of a string in pixel.</description>
<long-description>
</long-description>
<tag line="79" name="param" description="the string whose height has to be calculated" type="string" variable="$string">
<type by_reference="false">string</type>
</tag>
<tag line="79" name="return" description="the height of the string in pixels" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="85">
<name>$string</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="99" package="Default">
<name>getMaxHeight</name>
<docblock>
<description>This method calculates the maximal height of a string in a collection of strings.</description>
<long-description>
</long-description>
<tag line="93" name="param" description="the collection of strings" type="\Traversable" variable="$strings">
<type by_reference="false">\Traversable</type>
</tag>
<tag line="93" name="return" description="the maximal height of the strings in the collection" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="99">
<name>$strings</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="117" package="Default">
<name>getHash</name>
<docblock>
<description>This method return a hash of the FontMetric.</description>
<long-description>
</long-description>
<tag line="112" name="return" description="the hash of the FontMetric" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="true" visibility="private" line="128" package="Default">
<name>splitToLines</name>
<docblock>
<description>This method splits each string in a collection of strings into a set of strings with no line breaks, and returns all line-break-free strings as ArrayObject.</description>
<long-description>
</long-description>
<tag line="122" name="param" description="the collection of string to split" type="\Traversable" variable="$strings">
<type by_reference="false">\Traversable</type>
</tag>
<tag line="122" name="return" description="the collection of strings without line breaks" type="\Utils\Font\ArrayObject">
<type by_reference="false">\Utils\Font\ArrayObject</type>
</tag>
</docblock>
<argument line="128">
<name>$strings</name>
<default/>
<type>Traversable</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Font\FontMetricServices\FontMetricService.inc" hash="94b866a26868af25dd07433dd35557b9" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Font\FontMetricServices\FontMetricService.inc</error>
</parse_markers>
<namespace-alias name="FontManager">Utils\Font\FontManager</namespace-alias>
<namespace-alias name="TextStyle">Utils\Graphics2D\Shapes\Styles\TextStyle</namespace-alias>
<namespace-alias name="Directory">Utils\File\Directory</namespace-alias>
<namespace-alias name="Url">\Utils\URL\Url</namespace-alias>
<class final="false" abstract="true" line="13" namespace="Utils\Font\FontMetricServices" package="Default">
<name>FontMetricService</name>
<extends/>
<full_name>\Utils\Font\FontMetricServices\FontMetricService</full_name>
<docblock>
<description>This class represents an abstract front metric service.</description>
<long-description>
</long-description>
</docblock>
<constant namespace="Utils\Font\FontMetricServices" line="18" package="Default">
<name>ASCII_BLANK</name>
<value>32</value>
<docblock>
<description>the ASCII code for the blank, i.e. " "</description>
<long-description>
</long-description>
</docblock>
</constant>
<property final="false" static="false" visibility="private" line="25" package="Default">
<name>$fontMetricsTemplate</name>
<default>'fontMetrics.tpl'</default>
<docblock>
<description>the file name where the template for the font metric HTML file is stored</description>
<long-description>
</long-description>
<tag line="20" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="30" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class</description>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="protected" line="43" package="Default">
<name>createHtml</name>
<docblock>
<description>This method creates html code which is either opened as static file (@see FontMetricSocketService) or served dynamically (@see FontMetricWebServerService).</description>
<long-description><p>The html code of the template is complated, and a span element for each of the first 255 charachters of the current text style are added. The javascript code embedded in the template html code gets the width of each span element (i.e. the width of each character) and sends this information bach to the registered service endpoint.</p>
</long-description>
<tag line="34" name="param" description="the text style for which the html should be created" type="\Utils\Graphics2D\Shapes\Styles\TextStyle" variable="$textStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
<tag line="34" name="param" description="the service endpoint to which the result should be sent to" type="\Utils\URL\Url" variable="$fontMetricServiceEndpoint">
<type by_reference="false">\Utils\URL\Url</type>
</tag>
<tag line="34" name="return" description="the generated html code" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="43">
<name>$textStyle</name>
<default/>
<type>TextStyle</type>
</argument>
<argument line="43">
<name>$fontMetricServiceEndpoint</name>
<default/>
<type>Url</type>
</argument>
</method>
<method final="false" abstract="true" static="false" visibility="public" line="78" package="Default">
<name>execute</name>
<docblock>
<description>This method executes the respective service.</description>
<long-description>
</long-description>
<tag line="72" name="param" description="the text style for which the font definition is needed" type="\Utils\Graphics2D\Shapes\Styles\TextStyle" variable="$textStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
<tag line="72" name="param" description="the font manager to which the font definition is added to" type="\Utils\Font\FontManager" variable="$fontManager">
<type by_reference="false">\Utils\Font\FontManager</type>
</tag>
</docblock>
<argument line="78">
<name>$textStyle</name>
<default/>
<type>TextStyle</type>
</argument>
<argument line="78">
<name>$fontManager</name>
<default/>
<type>FontManager</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Font\FontMetricServices\FontMetricServiceFactory.inc" hash="79a8941eb4d48081a1b41acc4c8cb370" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Font\FontMetricServices\FontMetricServiceFactory.inc</error>
</parse_markers>
<namespace-alias name="Url">Utils\URL\Url</namespace-alias>
<class final="false" abstract="false" line="10" namespace="Utils\Font\FontMetricServices" package="Default">
<name>FontMetricServiceFactory</name>
<extends/>
<full_name>\Utils\Font\FontMetricServices\FontMetricServiceFactory</full_name>
<docblock>
<description>This class acts as factory for creating font metric services.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="true" visibility="public" line="18" package="Default">
<name>createFontMetricService</name>
<docblock>
<description>This method creates a FontMetricService.</description>
<long-description>
</long-description>
<tag line="12" name="param" description="the URL of the underlying service endpoint" type="\Utils\URL\Url" variable="$url">
<type by_reference="false">\Utils\URL\Url</type>
</tag>
<tag line="12" name="return" description="the created FontMetricService" type="\Utils\Font\FontMetricServices\FontMetricWebServerService">
<type by_reference="false">\Utils\Font\FontMetricServices\FontMetricWebServerService</type>
</tag>
</docblock>
<argument line="18">
<name>$url</name>
<default/>
<type>Url</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Font\FontMetricServices\FontMetricWebServerService.inc" hash="ba5585765b0b627854b3141861016637" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Font\FontMetricServices\FontMetricWebServerService.inc</error>
</parse_markers>
<namespace-alias name="FontManager">Utils\Font\FontManager</namespace-alias>
<namespace-alias name="TextStyle">Utils\Graphics2D\Shapes\Styles\TextStyle</namespace-alias>
<namespace-alias name="Url">Utils\URL\Url</namespace-alias>
<class final="false" abstract="false" line="12" namespace="Utils\Font\FontMetricServices" package="Default">
<name>FontMetricWebServerService</name>
<extends>\Utils\Font\FontMetricServices\FontMetricService</extends>
<full_name>\Utils\Font\FontMetricServices\FontMetricWebServerService</full_name>
<docblock>
<description>This font metric service can create font metrics when being invoked directly through the browser.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="19" package="Default">
<name>$serviceEndpoint</name>
<default>null</default>
<docblock>
<description>the service endpoint, which is the target of the callback in the html code, that sends the text style information</description>
<long-description>
</long-description>
<tag line="14" name="var" description="" type="\Utils\URL\Url">
<type by_reference="false">\Utils\URL\Url</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="26" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="21" name="param" description="the service endpoint, which is the target of the callback in the html code, that sends the text style information" type="\Utils\URL\Url" variable="$url">
<type by_reference="false">\Utils\URL\Url</type>
</tag>
</docblock>
<argument line="26">
<name>$url</name>
<default/>
<type>Url</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="39" package="Default">
<name>execute</name>
<docblock>
<description>This method creates HTML and Javascript which is evaluated bz the browser, and then feeds back font metrics to the script.</description>
<long-description>
</long-description>
<tag line="33" name="param" description="the text style for which the font definition is needed" type="\Utils\Graphics2D\Shapes\Styles\TextStyle" variable="$textStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
<tag line="33" name="param" description="the font manager to which the font definition is added to" type="\Utils\Font\FontManager" variable="$fontManager">
<type by_reference="false">\Utils\Font\FontManager</type>
</tag>
</docblock>
<argument line="39">
<name>$textStyle</name>
<default/>
<type>TextStyle</type>
</argument>
<argument line="39">
<name>$fontManager</name>
<default/>
<type>FontManager</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Geom\Dimension.inc" hash="bcf33ab0a5cfe2b019e860bc706d1034" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Geom\Dimension.inc</error>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="Utils\Geom" package="Default">
<name>Dimension</name>
<extends/>
<full_name>\Utils\Geom\Dimension</full_name>
<docblock>
<description>This class encapsulates the width and height of an object in the two-dimensional space, e.g. a rectangle or an ellipse.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="15" package="Default">
<name>$width</name>
<default>null</default>
<docblock>
<description>the width of the dimension</description>
<long-description>
</long-description>
<tag line="10" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="22" package="Default">
<name>$height</name>
<default>null</default>
<docblock>
<description>the height of the dimension</description>
<long-description>
</long-description>
<tag line="17" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="30" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="24" name="param" description="the width of the dimension" type="int" variable="$width">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="param" description="the height of the dimension" type="int" variable="$height">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="30">
<name>$width</name>
<default/>
<type/>
</argument>
<argument line="30">
<name>$height</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="44" package="Default">
<name>__get</name>
<docblock>
<description>This method is a magic getter method for the class.</description>
<long-description>
</long-description>
<tag line="37" name="todo" description="replace this with Trait in PHP 5.4"/>
<tag line="37" name="param" description="the name of the member to get" type="string" variable="$memberName">
<type by_reference="false">string</type>
</tag>
<tag line="37" name="return" description="the value of the member" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="44">
<name>$memberName</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="55" package="Default">
<name>resizeBy</name>
<docblock>
<description>This method resizes a Dimension by the offset encoded by a Point.</description>
<long-description>
</long-description>
<tag line="49" name="param" description="the offset by which the Dimension has to be resized" type="\Utils\Geom\Point" variable="$point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="49" name="return" description="a new Dimension resized by the offset encoded in the given Point" type="\Utils\Geom\Dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
<argument line="55">
<name>$point</name>
<default/>
<type>Point</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="65" package="Default">
<name>__toString</name>
<docblock>
<description>This method returns a string representation of the Dimension.</description>
<long-description>
</long-description>
<tag line="60" name="return" description="the string representation of the Dimension" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="\src\Utils\Geom\Point.inc" hash="d1d050b31743eee8a247c63ecfcdaa59" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Geom\Point.inc</error>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="Utils\Geom" package="Default">
<name>Point</name>
<extends/>
<full_name>\Utils\Geom\Point</full_name>
<docblock>
<description>This class represents a point in the two-dimensional space.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="15" package="Default">
<name>$x</name>
<default>null</default>
<docblock>
<description>the x-coordinate of the point</description>
<long-description>
</long-description>
<tag line="10" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="22" package="Default">
<name>$y</name>
<default>null</default>
<docblock>
<description>the y-coordinate of the point</description>
<long-description>
</long-description>
<tag line="17" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="30" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="24" name="param" description="the x-coordinate of the point" type="int" variable="$x">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="param" description="the y-coordinate of the point" type="int" variable="$y">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="30">
<name>$x</name>
<default/>
<type/>
</argument>
<argument line="30">
<name>$y</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="44" package="Default">
<name>__get</name>
<docblock>
<description>This method is a magic getter method for the class.</description>
<long-description>
</long-description>
<tag line="37" name="todo" description="replace this with Trait in PHP 5.4"/>
<tag line="37" name="param" description="the name of the member to get" type="string" variable="$memberName">
<type by_reference="false">string</type>
</tag>
<tag line="37" name="return" description="the value of the member" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="44">
<name>$memberName</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="55" package="Default">
<name>setX</name>
<docblock>
<description>This method sets the x-coordinate of the point.</description>
<long-description>
</long-description>
<tag line="49" name="param" description="the new x-coordinate of the point" type="int" variable="$x">
<type by_reference="false">int</type>
</tag>
<tag line="49" name="return" description="this point" type="\Utils\Geom\Point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
</docblock>
<argument line="55">
<name>$x</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="68" package="Default">
<name>setY</name>
<docblock>
<description>This method sets the y-coordinate of the point.</description>
<long-description>
</long-description>
<tag line="62" name="param" description="the new y-coordinate of the point" type="int" variable="$y">
<type by_reference="false">int</type>
</tag>
<tag line="62" name="return" description="this point" type="\Utils\Geom\Point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
</docblock>
<argument line="68">
<name>$y</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="79" package="Default">
<name>moveBy</name>
<docblock>
<description>This method moves a point by an offset, given as another Point.</description>
<long-description>
</long-description>
<tag line="73" name="param" description="the Point by which this Point shall be moved by" type="\Utils\Geom\Point" variable="$point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="73" name="return" description="a new Point moved by the offset encapsulated by the given Point" type="\Utils\Geom\Point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
</docblock>
<argument line="79">
<name>$point</name>
<default/>
<type>Point</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="89" package="Default">
<name>__toString</name>
<docblock>
<description>This method returns a string representation of the Point.</description>
<long-description>
</long-description>
<tag line="84" name="return" description="the string representation of the Point" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\DrawingPanes\DomDrawingPane.inc" hash="c6d4db1f992d1e7d09ee2be30c243e15" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\DomDrawingPane.inc</error>
</parse_markers>
<namespace-alias name="RgbColor">Utils\Color\RgbColor</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<class final="false" abstract="true" line="11" namespace="Utils\Graphics2D\DrawingPanes" package="Default">
<name>DomDrawingPane</name>
<extends>\Utils\Graphics2D\DrawingPanes\DrawingPane</extends>
<full_name>\Utils\Graphics2D\DrawingPanes\DomDrawingPane</full_name>
<docblock>
<description>This class implements an abstract drawing pane for DOM output.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="protected" line="18" package="Default">
<name>$fragment</name>
<default>null</default>
<docblock>
<description>the DOM document fragment that holds the source code of the export</description>
<long-description>
</long-description>
<tag line="13" name="var" description="" type="\Utils\Graphics2D\DrawingPanes\DOMDocumentFragment">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DOMDocumentFragment</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="25" package="Default">
<name>$classNameNode</name>
<default>'rt_node'</default>
<docblock>
<description>the name of the CSS class for the node shapes.</description>
<long-description>
</long-description>
<tag line="20" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="32" package="Default">
<name>$classNameEdge</name>
<default>'rt_edge'</default>
<docblock>
<description>the name of the CSS class for the edge shapes.</description>
<long-description>
</long-description>
<tag line="27" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="39" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="34" name="param" description="the dimension of the document" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
<argument line="39">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="protected" line="51" package="Default">
<name>clearDocument</name>
<docblock>
<description>This method assures that the document is empty before saving it. Otherwise, multiple calls to violate the DOMDocument structure (e.g. multiple <svg elements>). Creating a new document does not work, as the fragement depends on the first created document.</description>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="protected" line="62" package="Default">
<name>appendFragment</name>
<docblock>
<description>This method appends the fragment to the given parent element.</description>
<long-description>
</long-description>
<tag line="57" name="param" description="the root element to append the internal document fragment to" type="\DOMNode" variable="$parentElement">
<type by_reference="false">\DOMNode</type>
</tag>
</docblock>
<argument line="62">
<name>$parentElement</name>
<default/>
<type>DOMNode</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="74" package="Default">
<name>getClassNameNode</name>
<docblock>
<description>This method acts as getter for the CSS class name of the node shapes.</description>
<long-description>
</long-description>
<tag line="69" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="84" package="Default">
<name>getClassNameEdge</name>
<docblock>
<description>This method acts as getter for the CSS class name of the edge shapes.</description>
<long-description>
</long-description>
<tag line="79" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="95" package="Default">
<name>setClassNameNode</name>
<docblock>
<description>This method acts as setter for the CSS class name of the node shapes.</description>
<long-description>
</long-description>
<tag line="89" name="param" description="the new name of the CSS class for node shapes return void" type="string" variable="$classNameNode">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="95">
<name>$classNameNode</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="106" package="Default">
<name>setClassNameEdge</name>
<docblock>
<description>This method acts as setter for the CSS class name of the edge shapes.</description>
<long-description>
</long-description>
<tag line="100" name="param" description="the new name of the CSS class for edge shapes return void" type="string" variable="$classNameEdge">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="106">
<name>$classNameEdge</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="117" package="Default">
<name>toDOMColor</name>
<docblock>
<description>This method converts a RGBColor to the DOM representation of the color.</description>
<long-description>
</long-description>
<tag line="111" name="param" description="the color to convert" type="\Utils\Graphics2D\DrawingPanes\RGBColor" variable="$color">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\RGBColor</type>
</tag>
<tag line="111" name="return" description="the DOM representation of the color" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="117">
<name>$color</name>
<default/>
<type>RGBColor</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\DrawingPanes\DrawingPane.inc" hash="18bb80b81f6aeb1c0148912fe8921f4b" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\DrawingPane.inc</error>
<critical line="81">No short description for method drawPolyLine</critical>
<notice line="84">Argument $points is missing from the function Docblock</notice>
<critical line="99">No short description for method setStrokeWidth</critical>
<notice line="102">Argument $strokeWidth is missing from the function Docblock</notice>
<critical line="109">No short description for method setStrokeColor</critical>
<notice line="112">Argument $strokeColor is missing from the function Docblock</notice>
<critical line="119">No short description for method setFillColor</critical>
<notice line="122">Argument $fillColor is missing from the function Docblock</notice>
<critical line="129">No short description for method setFontFamily</critical>
<notice line="132">Argument $fontFamily is missing from the function Docblock</notice>
<critical line="139">No short description for method setFontSize</critical>
<notice line="142">Argument $fontSize is missing from the function Docblock</notice>
<critical line="149">No short description for method setFontColor</critical>
<notice line="152">Argument $fontColor is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="true" line="13" namespace="Utils\Graphics2D\DrawingPanes" package="Default">
<name>DrawingPane</name>
<extends/>
<full_name>\Utils\Graphics2D\DrawingPanes\DrawingPane</full_name>
<docblock>
<description>This class implements an abstract drawing pane.</description>
<long-description>
</long-description>
</docblock>
<implements>\Utils\Graphics2D\DrawingPanes\IDrawingPane</implements>
<property final="false" static="false" visibility="public" line="20" package="Default">
<name>$document</name>
<default>null</default>
<docblock>
<description>the wrapped document</description>
<long-description>
</long-description>
<tag line="15" name="var" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="27" package="Default">
<name>$dimension</name>
<default>0</default>
<docblock>
<description>the dimension of the document</description>
<long-description>
</long-description>
<tag line="22" name="var" description="" type="\Utils\Geom\Dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="34" package="Default">
<name>$strokeWidth</name>
<default>1</default>
<docblock>
<description>the currect stroke width of the drawing pane</description>
<long-description>
</long-description>
<tag line="29" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="41" package="Default">
<name>$strokeColor</name>
<default>null</default>
<docblock>
<description>the current stroke color of the drawing pane</description>
<long-description>
</long-description>
<tag line="36" name="var" description="" type="\Utils\Color\Color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="48" package="Default">
<name>$fillColor</name>
<default>null</default>
<docblock>
<description>the current fill color of the drawing pane</description>
<long-description>
</long-description>
<tag line="43" name="var" description="" type="\Utils\Color\Color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="55" package="Default">
<name>$fontFamily</name>
<default>null</default>
<docblock>
<description>the current font family of the drawing pane</description>
<long-description>
</long-description>
<tag line="50" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="62" package="Default">
<name>$fontSize</name>
<default>null</default>
<docblock>
<description>the current font size in pixels of the drawing pane</description>
<long-description>
</long-description>
<tag line="57" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="69" package="Default">
<name>$fontColor</name>
<default>null</default>
<docblock>
<description>the current font color of the drawing pane</description>
<long-description>
</long-description>
<tag line="64" name="var" description="" type="\Utils\Color\Color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="76" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="71" name="param" description="the dimension of the document" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
<argument line="76">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="84" package="Default">
<name>drawPolyLine</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="84">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="102" package="Default">
<name>setStrokeWidth</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="102">
<name>$strokeWidth</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="112" package="Default">
<name>setStrokeColor</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="112">
<name>$strokeColor</name>
<default/>
<type>Color</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="122" package="Default">
<name>setFillColor</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="122">
<name>$fillColor</name>
<default/>
<type>Color</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="132" package="Default">
<name>setFontFamily</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="132">
<name>$fontFamily</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="142" package="Default">
<name>setFontSize</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="142">
<name>$fontSize</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="152" package="Default">
<name>setFontColor</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="152">
<name>$fontColor</name>
<default/>
<type>Color</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\DrawingPanes\GdLibDrawingPane.inc" hash="8ab576e597ba6cb5de3c118f44267993" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\GdLibDrawingPane.inc</error>
<critical line="136">No short description for method drawLine</critical>
<notice line="139">Argument $source is missing from the function Docblock</notice>
<notice line="139">Argument $target is missing from the function Docblock</notice>
<critical line="168">No short description for method drawEllipse</critical>
<notice line="171">Argument $center is missing from the function Docblock</notice>
<notice line="171">Argument $dimension is missing from the function Docblock</notice>
<critical line="268">No short description for method drawRectangle</critical>
<notice line="271">Argument $topLeftCorner is missing from the function Docblock</notice>
<notice line="271">Argument $dimension is missing from the function Docblock</notice>
<critical line="307">No short description for method drawPolygon</critical>
<notice line="310">Argument $points is missing from the function Docblock</notice>
<critical line="342">No short description for method drawText</critical>
<notice line="345">Argument $topLeftCorner is missing from the function Docblock</notice>
<notice line="345">Argument $text is missing from the function Docblock</notice>
<critical line="361">No short description for method save</critical>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="RgbColor">Utils\Color\RgbColor</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="14" namespace="Utils\Graphics2D\DrawingPanes" package="Default">
<name>GdLibDrawingPane</name>
<extends>\Utils\Graphics2D\DrawingPanes\DrawingPane</extends>
<full_name>\Utils\Graphics2D\DrawingPanes\GdLibDrawingPane</full_name>
<docblock>
<description>This class implements a drawing pane for the GD PHP extension.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="21" package="Default">
<name>$format</name>
<default>null</default>
<docblock>
<description>the file format of the document</description>
<long-description>
</long-description>
<tag line="16" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="28" package="Default">
<name>$useTrueColor</name>
<default>FALSE</default>
<docblock>
<description>a flag determines whether to use true-color or not</description>
<long-description>
</long-description>
<tag line="23" name="var" description="" type="boolean">
<type by_reference="false">boolean</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="35" package="Default">
<name>$gdColors</name>
<default>array()</default>
<docblock>
<description>a collection of GD color ressources - this is a work-around for the limit of colors to be created in a non-true-color GD image</description>
<long-description>
</long-description>
<tag line="30" name="var" description="" type="\Utils\Graphics2D\DrawingPanes\int[string]">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\int[string]</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="42" package="Default">
<name>$fontPath</name>
<default>null</default>
<docblock>
<description>the current path to search for fonts</description>
<long-description>
</long-description>
<tag line="37" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="49" package="Default">
<name>$DEFAULT_FONT_PATH_WIN</name>
<default>'C:/Windows/Fonts/'</default>
<docblock>
<description>the default path to search for fonts on Windows systems</description>
<long-description>
</long-description>
<tag line="44" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="56" package="Default">
<name>$DEFAULT_FONT_PATH_IX</name>
<default>'/usr/share/fonts/'</default>
<docblock>
<description>the default path to search for fonts on *IX systems</description>
<long-description>
</long-description>
<tag line="51" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="65" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="58" name="param" description="the dimension of the document" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
<tag line="58" name="param" description="the file format of the document, which is one of ImageDrawingPane::GIF, ImageDrawingPane::JPG, ImageDrawingPane::PNG" type="string" variable="$format">
<type by_reference="false">string</type>
</tag>
<tag line="58" name="param" description="determines if the image should be a true color image (which consumes more memory)" type="boolean" variable="$useTrueColor">
<type by_reference="false">boolean</type>
</tag>
</docblock>
<argument line="65">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
<argument line="65">
<name>$format</name>
<default/>
<type/>
</argument>
<argument line="65">
<name>$useTrueColor</name>
<default>TRUE</default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="96" package="Default">
<name>initializeFontPath</name>
<docblock>
<description>This method initializes the font path based on the current operating system.</description>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="111" package="Default">
<name>setFontPath</name>
<docblock>
<description>This method sets the font path to the given path.</description>
<long-description>
</long-description>
<tag line="106" name="param" description="the new font path to use" type="string" variable="$fontPath">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="111">
<name>$fontPath</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="124" package="Default">
<name>createImage</name>
<docblock>
<description>This method creates the internal GD library document.</description>
<long-description>
</long-description>
<tag line="119" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="139" package="Default">
<name>drawLine</name>
<docblock>
<description/>
<long-description>
</long-description>
<tag line="136" name="inheritDoc" description="This method tries to imitate SVG line drawing, which start at the source and ends before the target. The line is always drawn from top to bottom and from left to right, not matter if source and target respect this."/>
</docblock>
<argument line="139">
<name>$source</name>
<default/>
<type>Point</type>
</argument>
<argument line="139">
<name>$target</name>
<default/>
<type>Point</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="171" package="Default">
<name>drawEllipse</name>
<docblock>
<description/>
<long-description>
</long-description>
<tag line="168" name="inheritDoc" description="Using imageellipse of gdlib does not work here, as drawings with even width/height results in ellipses being one pixel too wide/high (this is a knownn bug in PHP GD Library)"/>
</docblock>
<argument line="171">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="171">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="202" package="Default">
<name>drawFilledArc</name>
<docblock>
<description>This method draws a filled arc</description>
<long-description>
</long-description>
<tag line="194" name="param" description="the center of the arc" type="\Utils\Geom\Point" variable="$center">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="194" name="param" description="the dimension of the arc" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
<tag line="194" name="param" description="the fill color of the arc, or null if not filled" type="\Utils\Color\Color" variable="$fillColor">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
<tag line="194" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\GdLibDrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\GdLibDrawingPane</type>
</tag>
</docblock>
<argument line="202">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="202">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
<argument line="202">
<name>$fillColor</name>
<default>null</default>
<type>Color</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="236" package="Default">
<name>drawArc</name>
<docblock>
<description>This method draws a arc</description>
<long-description>
</long-description>
<tag line="229" name="param" description="the center of the arc" type="\Utils\Geom\Point" variable="$center">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="229" name="param" description="the dimension of the arc" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
<tag line="229" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\GdLibDrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\GdLibDrawingPane</type>
</tag>
</docblock>
<argument line="236">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="236">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="271" package="Default">
<name>drawRectangle</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="271">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="271">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="310" package="Default">
<name>drawPolygon</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="310">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="345" package="Default">
<name>drawText</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="345">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="345">
<name>$text</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="364" package="Default">
<name>save</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="388" package="Default">
<name>toGDColor</name>
<docblock>
<description>This method converts a RGBColor to a GD color identifier.</description>
<long-description>
</long-description>
<tag line="382" name="param" description="the color to convert" type="\Utils\Graphics2D\DrawingPanes\RGBColor" variable="$color">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\RGBColor</type>
</tag>
<tag line="382" name="return" description="the GD color identifier for the given color" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="388">
<name>$color</name>
<default/>
<type>RGBColor</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="399" package="Default">
<name>toGDColorNTC</name>
<docblock>
<description>This method converts a RGBColor to a GD non-true-color identifier.</description>
<long-description>
</long-description>
<tag line="393" name="param" description="the color to convert" type="\Utils\Graphics2D\DrawingPanes\RGBColor" variable="$color">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\RGBColor</type>
</tag>
<tag line="393" name="return" description="the GD non-true-color identifier for the given color" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="399">
<name>$color</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="413" package="Default">
<name>toGDColorTC</name>
<docblock>
<description>This method converts a RGBColor to a GD true-color identifier.</description>
<long-description>
</long-description>
<tag line="407" name="param" description="the color to convert" type="\Utils\Graphics2D\DrawingPanes\RGBColor" variable="$color">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\RGBColor</type>
</tag>
<tag line="407" name="return" description="the GD true-color identifier for the given color" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="413">
<name>$color</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\DrawingPanes\HtmlDrawingPane.inc" hash="33a20201bb71ffa47b0e1a3855ffbf4e" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\HtmlDrawingPane.inc</error>
<critical line="40">No short description for method drawLine</critical>
<notice line="43">Argument $source is missing from the function Docblock</notice>
<notice line="43">Argument $target is missing from the function Docblock</notice>
<critical line="90">No short description for method drawEllipse</critical>
<notice line="93">Argument $center is missing from the function Docblock</notice>
<notice line="93">Argument $dimension is missing from the function Docblock</notice>
<error line="100">No DocBlock was found for Method drawRectangle</error>
<critical line="129">No short description for method drawPolygon</critical>
<notice line="132">Argument $points is missing from the function Docblock</notice>
<critical line="139">No short description for method drawText</critical>
<notice line="142">Argument $topLeftCorner is missing from the function Docblock</notice>
<notice line="142">Argument $text is missing from the function Docblock</notice>
<critical line="161">No short description for method save</critical>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="RgbColor">Utils\Color\RgbColor</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="14" namespace="Utils\Graphics2D\DrawingPanes" package="Default">
<name>HtmlDrawingPane</name>
<extends>\Utils\Graphics2D\DrawingPanes\DomDrawingPane</extends>
<full_name>\Utils\Graphics2D\DrawingPanes\HtmlDrawingPane</full_name>
<docblock>
<description>This class implements a drawing pane for HTML output.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="protected" line="21" package="Default">
<name>$styleClasses</name>
<default>array()</default>
<docblock>
<description>the collection of used CSS styles</description>
<long-description>
</long-description>
<tag line="16" name="var" description="" type="\Utils\Graphics2D\DrawingPanes\stdClass[string]">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\stdClass[string]</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="28" package="Default">
<name>$consolidateStyles</name>
<default>TRUE</default>
<docblock>
<description>the flag to determine, whether or not CSS style information should be consolidated for output or not</description>
<long-description>
</long-description>
<tag line="23" name="var" description="" type="boolean">
<type by_reference="false">boolean</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="35" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="30" name="param" description="the dimension of the document" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
<argument line="35">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="43" package="Default">
<name>drawLine</name>
<docblock>
<description/>
<long-description>
</long-description>
<tag line="40" name="inheritDoc" description="In plain HTML, only horizonal or vertical lines are supported, otherwise a \InvalidArgumentException is thrown."/>
</docblock>
<argument line="43">
<name>$source</name>
<default/>
<type>Point</type>
</argument>
<argument line="43">
<name>$target</name>
<default/>
<type>Point</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="93" package="Default">
<name>drawEllipse</name>
<docblock>
<description/>
<long-description>
</long-description>
<tag line="90" name="inheritDoc" description="Currently, this method is unsupported for HTMLDocument - a <code>BadMethodCallException</code> is thrown when it is called."/>
</docblock>
<argument line="93">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="93">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="100" package="Default">
<name>drawRectangle</name>
<argument line="100">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="100">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="132" package="Default">
<name>drawPolygon</name>
<docblock>
<description/>
<long-description>
</long-description>
<tag line="129" name="inheritDoc" description="Currently, this method is unsupported for HTMLDocument - a <code>BadMethodCallException</code> is thrown when it is called."/>
</docblock>
<argument line="132">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="142" package="Default">
<name>drawText</name>
<docblock>
<description/>
<long-description>
</long-description>
<tag line="139" name="inheritDoc" description="With font sizes bigger than 20 pixels, the HTML text is not correctly positioned, when compared the e.g. SVG or GDLib - reason not known, might be HTML rendering, but same for Firefox 4.0 and Internet Explorer 9"/>
</docblock>
<argument line="142">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="142">
<name>$text</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="164" package="Default">
<name>save</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="180" package="Default">
<name>getCssCode</name>
<docblock>
<description>This method returns the CSS code for the current document as string.</description>
<long-description>
</long-description>
<tag line="175" name="return" description="string the CSS code for the current document" type="\Utils\Graphics2D\DrawingPanes\type">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\type</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="196" package="Default">
<name>addStyleClass</name>
<docblock>
<description>This method adds a style definition to the set of known styles</description>
<long-description>
</long-description>
<tag line="190" name="param" description="the style information as string" type="string" variable="$style">
<type by_reference="false">string</type>
</tag>
<tag line="190" name="return" description="the generic name of the CSS class made from the given style definition" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="196">
<name>$style</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="217" package="Default">
<name>getBorderWidth</name>
<docblock>
<description>This method is a short hand for getting the border width.</description>
<long-description>
</long-description>
<tag line="212" name="return" description="the border width" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="227" package="Default">
<name>getBorderColor</name>
<docblock>
<description>This method is a short hand for getting the border color as DOM color string.</description>
<long-description>
</long-description>
<tag line="222" name="return" description="the border color as DOM color string" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="237" package="Default">
<name>getFillColor</name>
<docblock>
<description>This method is a short hand for getting the fill color as DOM color string.</description>
<long-description>
</long-description>
<tag line="232" name="return" description="the fill color as DOM color string" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\DrawingPanes\HtmlMapDrawingPane.inc" hash="471eb0135e5381f1ca131f272d077e5a" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\HtmlMapDrawingPane.inc</error>
<critical line="35">No short description for method drawLine</critical>
<notice line="38">Argument $source is missing from the function Docblock</notice>
<notice line="38">Argument $target is missing from the function Docblock</notice>
<critical line="51">No short description for method drawEllipse</critical>
<notice line="54">Argument $center is missing from the function Docblock</notice>
<notice line="54">Argument $dimension is missing from the function Docblock</notice>
<critical line="66">No short description for method drawRectangle</critical>
<notice line="69">Argument $topLeftCorner is missing from the function Docblock</notice>
<notice line="69">Argument $dimension is missing from the function Docblock</notice>
<critical line="85">No short description for method drawPolygon</critical>
<notice line="88">Argument $points is missing from the function Docblock</notice>
<critical line="107">No short description for method drawText</critical>
<notice line="110">Argument $topLeftCorner is missing from the function Docblock</notice>
<notice line="110">Argument $text is missing from the function Docblock</notice>
<critical line="115">No short description for method save</critical>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="RgbColor">Utils\Color\RgbColor</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="14" namespace="Utils\Graphics2D\DrawingPanes" package="Default">
<name>HtmlMapDrawingPane</name>
<extends>\Utils\Graphics2D\DrawingPanes\DomDrawingPane</extends>
<full_name>\Utils\Graphics2D\DrawingPanes\HtmlMapDrawingPane</full_name>
<docblock>
<description>This class implements a drawing pane for HTML map output.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="21" package="Default">
<name>$mapName</name>
<default>null</default>
<docblock>
<description>the name of the HTML map element</description>
<long-description>
</long-description>
<tag line="16" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="28" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor for the class.</description>
<long-description>
</long-description>
<tag line="23" name="param" description="the dimension of the document" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
<argument line="28">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="38" package="Default">
<name>drawLine</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="38">
<name>$source</name>
<default/>
<type>Point</type>
</argument>
<argument line="38">
<name>$target</name>
<default/>
<type>Point</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="54" package="Default">
<name>drawEllipse</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="54">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="54">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="69" package="Default">
<name>drawRectangle</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="69">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="69">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="88" package="Default">
<name>drawPolygon</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="88">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="110" package="Default">
<name>drawText</name>
<docblock>
<description/>
<long-description>
</long-description>
<tag line="107" name="inheritDoc" description="This method does not do anything, as drawing text on a HTML map does not make sense."/>
</docblock>
<argument line="110">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="110">
<name>$text</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="118" package="Default">
<name>save</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\DrawingPanes\IDrawingPane.inc" hash="b66187c5605d6c91ea2944bbb709d42e" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\IDrawingPane.inc</error>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<interface namespace="Utils\Graphics2D\DrawingPanes" line="13" package="Default">
<name>IDrawingPane</name>
<extends/>
<full_name>\Utils\Graphics2D\DrawingPanes\IDrawingPane</full_name>
<docblock>
<description>This interface defines a common super type for drawing panes.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="22" package="Default">
<name>drawLine</name>
<docblock>
<description>This method draws a line on the document.</description>
<long-description>
</long-description>
<tag line="15" name="param" description="the source point of the line" type="\Utils\Geom\Point" variable="$source">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="15" name="param" description="the target point of the line" type="\Utils\Geom\Point" variable="$target">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="15" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\IDrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\IDrawingPane</type>
</tag>
</docblock>
<argument line="22">
<name>$source</name>
<default/>
<type>Point</type>
</argument>
<argument line="22">
<name>$target</name>
<default/>
<type>Point</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="32" package="Default">
<name>drawPolyLine</name>
<docblock>
<description>This method draws a poly line onto the the document.</description>
<long-description><p>It expects an traversable of points, where each point is represented by a object of the class Point.</p>
</long-description>
<tag line="24" name="param" description="the coordinates of the points of the line" type="\Traversable" variable="$points">
<type by_reference="false">\Traversable</type>
</tag>
<tag line="24" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\IDrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\IDrawingPane</type>
</tag>
</docblock>
<argument line="32">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="41" package="Default">
<name>drawEllipse</name>
<docblock>
<description>This method draws an ellipse on the document.</description>
<long-description>
</long-description>
<tag line="34" name="param" description="the center of the ellipse" type="\Utils\Geom\Point" variable="$center">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="34" name="param" description="the dimension of the ellipse" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
<tag line="34" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\IDrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\IDrawingPane</type>
</tag>
</docblock>
<argument line="41">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="41">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="50" package="Default">
<name>drawRectangle</name>
<docblock>
<description>This method draws a rectangle on the document.</description>
<long-description>
</long-description>
<tag line="43" name="param" description="the top left corner of the rectangle" type="\Utils\Geom\Point" variable="$topLeftCorner">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="43" name="param" description="the dimension of the rectangle" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
<tag line="43" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\IDrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\IDrawingPane</type>
</tag>
</docblock>
<argument line="50">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="50">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="58" package="Default">
<name>drawPolygon</name>
<docblock>
<description>This method draws a polygon on the document.</description>
<long-description>
</long-description>
<tag line="52" name="param" description="the points defining the polygon" type="\Traversable" variable="$points">
<type by_reference="false">\Traversable</type>
</tag>
<tag line="52" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\IDrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\IDrawingPane</type>
</tag>
</docblock>
<argument line="58">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="67" package="Default">
<name>drawText</name>
<docblock>
<description>This method draws text at the given position.</description>
<long-description>
</long-description>
<tag line="60" name="param" description="the top left corner of the text to draw" type="\Utils\Geom\Point" variable="$topLeftCorner">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="60" name="param" description="the text to draw" type="\Utils\Graphics2D\DrawingPanes\type" variable="$text">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\type</type>
</tag>
<tag line="60" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\IDrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\IDrawingPane</type>
</tag>
</docblock>
<argument line="67">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="67">
<name>$text</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="75" package="Default">
<name>setStrokeWidth</name>
<docblock>
<description>This method sets the stroke width.</description>
<long-description>
</long-description>
<tag line="69" name="param" description="the new stroke width" type="int" variable="$strokeWidth">
<type by_reference="false">int</type>
</tag>
<tag line="69" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\DrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DrawingPane</type>
</tag>
</docblock>
<argument line="75">
<name>$strokeWidth</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="83" package="Default">
<name>setStrokeColor</name>
<docblock>
<description>This method sets the stroke color.</description>
<long-description>
</long-description>
<tag line="77" name="param" description="the new stroke color" type="\Utils\Color\Color" variable="$strokeColor">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
<tag line="77" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\DrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DrawingPane</type>
</tag>
</docblock>
<argument line="83">
<name>$strokeColor</name>
<default/>
<type>Color</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="91" package="Default">
<name>setFillColor</name>
<docblock>
<description>This method sets the fill color.</description>
<long-description>
</long-description>
<tag line="85" name="param" description="the new fill color" type="\Utils\Color\Color" variable="$fillColor">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
<tag line="85" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\DrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DrawingPane</type>
</tag>
</docblock>
<argument line="91">
<name>$fillColor</name>
<default/>
<type>Color</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="99" package="Default">
<name>setFontFamily</name>
<docblock>
<description>This method sets the font familiy.</description>
<long-description>
</long-description>
<tag line="93" name="param" description="the name of the new font family" type="string" variable="$fontFamily">
<type by_reference="false">string</type>
</tag>
<tag line="93" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\DrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DrawingPane</type>
</tag>
</docblock>
<argument line="99">
<name>$fontFamily</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="107" package="Default">
<name>setFontSize</name>
<docblock>
<description>This method sets the font size.</description>
<long-description>
</long-description>
<tag line="101" name="param" description="the new font size in pixel" type="int" variable="$fontSize">
<type by_reference="false">int</type>
</tag>
<tag line="101" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\DrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DrawingPane</type>
</tag>
</docblock>
<argument line="107">
<name>$fontSize</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="115" package="Default">
<name>setFontColor</name>
<docblock>
<description>This method sets the font color.</description>
<long-description>
</long-description>
<tag line="109" name="param" description="the new font color" type="\Utils\Color\Color" variable="$fontColor">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
<tag line="109" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\DrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DrawingPane</type>
</tag>
</docblock>
<argument line="115">
<name>$fontColor</name>
<default/>
<type>Color</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="122" package="Default">
<name>save</name>
<docblock>
<description>This method saves this DrawingPane to a string.</description>
<long-description>
</long-description>
<tag line="117" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</interface>
</file>
<file path="\src\Utils\Graphics2D\DrawingPanes\ImageDrawingPane.inc" hash="3ee0c07d353bf4fb27325d805d4a1b3b" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\ImageDrawingPane.inc</error>
</parse_markers>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<class final="false" abstract="true" line="10" namespace="Utils\Graphics2D\DrawingPanes" package="Default">
<name>ImageDrawingPane</name>
<extends>\Utils\Graphics2D\DrawingPanes\DrawingPane</extends>
<full_name>\Utils\Graphics2D\DrawingPanes\ImageDrawingPane</full_name>
<docblock>
<description>This class implements an abstract drawing pane for binary image output.</description>
<long-description>
</long-description>
</docblock>
<constant namespace="Utils\Graphics2D\DrawingPanes" line="15" package="Default">
<name>GIF</name>
<value>'gif'</value>
<docblock>
<description>the constant for output as GIF</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Graphics2D\DrawingPanes" line="20" package="Default">
<name>JPG</name>
<value>'jpg'</value>
<docblock>
<description>the constant for output as JPG</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Graphics2D\DrawingPanes" line="25" package="Default">
<name>PNG</name>
<value>'png'</value>
<docblock>
<description>the constant for output as PNG</description>
<long-description>
</long-description>
</docblock>
</constant>
<method final="false" abstract="false" static="false" visibility="public" line="32" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor for the class.</description>
<long-description>
</long-description>
<tag line="27" name="param" description="the dimension of the document" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
<argument line="32">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\DrawingPanes\ImagickDrawingPane.inc" hash="16ebefc4d277ff6edef88dc7a3f797c9" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\ImagickDrawingPane.inc</error>
<critical line="48">No short description for method drawLine</critical>
<notice line="51">Argument $source is missing from the function Docblock</notice>
<notice line="51">Argument $target is missing from the function Docblock</notice>
<critical line="80">No short description for method drawPolyLine</critical>
<notice line="83">Argument $points is missing from the function Docblock</notice>
<critical line="91">No short description for method drawEllipse</critical>
<notice line="94">Argument $center is missing from the function Docblock</notice>
<notice line="94">Argument $dimension is missing from the function Docblock</notice>
<critical line="106">No short description for method drawRectangle</critical>
<notice line="109">Argument $topLeftCorner is missing from the function Docblock</notice>
<notice line="109">Argument $dimension is missing from the function Docblock</notice>
<critical line="138">No short description for method drawPolygon</critical>
<notice line="141">Argument $points is missing from the function Docblock</notice>
<critical line="148">No short description for method drawText</critical>
<notice line="151">Argument $topLeftCorner is missing from the function Docblock</notice>
<notice line="151">Argument $text is missing from the function Docblock</notice>
<critical line="179">No short description for method save</critical>
<critical line="236">No short description for method setStrokeWidth</critical>
<notice line="239">Argument $strokeWidth is missing from the function Docblock</notice>
<critical line="251">No short description for method setStrokeColor</critical>
<notice line="254">Argument $strokeColor is missing from the function Docblock</notice>
<critical line="263">No short description for method setFillColor</critical>
<notice line="266">Argument $fillColor is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="RgbColor">Utils\Color\RgbColor</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="14" namespace="Utils\Graphics2D\DrawingPanes" package="Default">
<name>ImagickDrawingPane</name>
<extends>\Utils\Graphics2D\DrawingPanes\ImageDrawingPane</extends>
<full_name>\Utils\Graphics2D\DrawingPanes\ImagickDrawingPane</full_name>
<docblock>
<description>This class implements a drawing pane for Imagick PHP extension.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="21" package="Default">
<name>$draw</name>
<default>null</default>
<docblock>
<description>the drawing pane of the Imagick object</description>
<long-description>
</long-description>
<tag line="16" name="var" description="" type="\Utils\Graphics2D\DrawingPanes\ImagickDraw">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\ImagickDraw</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="28" package="Default">
<name>$format</name>
<default>ImageDrawingPane::PNG</default>
<docblock>
<description>the output file type of the visualisation, which is one of ImageDrawingPane::GIF, ImageDrawingPane::JPG, ImageDrawingPane::PNG</description>
<long-description>
</long-description>
<tag line="23" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="35" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor for the class.</description>
<long-description>
</long-description>
<tag line="30" name="param" description="the dimension of the document" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
<argument line="35">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="51" package="Default">
<name>drawLine</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="51">
<name>$source</name>
<default/>
<type>Point</type>
</argument>
<argument line="51">
<name>$target</name>
<default/>
<type>Point</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="83" package="Default">
<name>drawPolyLine</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="83">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="94" package="Default">
<name>drawEllipse</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="94">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="94">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="109" package="Default">
<name>drawRectangle</name>
<docblock>
<description/>
<long-description>
</long-description>
<tag line="106" name="inheritDoc" description="Currently there is the limitations, that the border width is on pixel to wide, unless it is 0 or 1"/>
</docblock>
<argument line="109">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="109">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="141" package="Default">
<name>drawPolygon</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="141">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="151" package="Default">
<name>drawText</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="151">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="151">
<name>$text</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="172" package="Default">
<name>setFormat</name>
<docblock>
<description>This method sets the format in which the visualisation will be exported.</description>
<long-description>
</long-description>
<tag line="166" name="param" description="the desired file format, which is one of ImageDrawingPane::GIF, ImageDrawingPane::JPG, ImageDrawingPane::PNG" type="string" variable="$format">
<type by_reference="false">string</type>
</tag>
<tag line="166" name="return" description="$this" type="\Utils\Graphics2D\DrawingPanes\ImagickDrawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\ImagickDrawingPane</type>
</tag>
</docblock>
<argument line="172">
<name>$format</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="182" package="Default">
<name>save</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="210" package="Default">
<name>toImagikColor</name>
<docblock>
<description>This method converts a color to its Imagik color representation.</description>
<long-description>
</long-description>
<tag line="204" name="param" description="the color to convert" type="\Utils\Graphics2D\DrawingPanes\RGBColor" variable="$color">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\RGBColor</type>
</tag>
<tag line="204" name="return" description="the Imagik color representation of the color" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="210">
<name>$color</name>
<default/>
<type>RGBColor</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="226" package="Default">
<name>pointsToArray</name>
<docblock>
<description>This method converts a collection of Points into a two-dimenstional array of x- and y-coordinates.</description>
<long-description><p>The resulting array looks like array[[x => 137, y = 64], [x => 129, y => 12]... , [x => 225, y => 358]]</p>
</long-description>
<tag line="218" name="param" description="the collection of Points to convert" type="\Traversable" variable="$points">
<type by_reference="false">\Traversable</type>
</tag>
<tag line="218" name="return" description="the two-dimenstional array of x- and y-coordinates" type="\array[]">
<type by_reference="false">\array[]</type>
</tag>
</docblock>
<argument line="226">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="239" package="Default">
<name>setStrokeWidth</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="239">
<name>$strokeWidth</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="254" package="Default">
<name>setStrokeColor</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="254">
<name>$strokeColor</name>
<default/>
<type>Color</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="266" package="Default">
<name>setFillColor</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="266">
<name>$fillColor</name>
<default/>
<type>Color</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\DrawingPanes\SvgDrawingPane.inc" hash="77efbf6cd4fa6a0be79b17252169a2d8" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\SvgDrawingPane.inc</error>
<critical line="26">No short description for method drawLine</critical>
<notice line="29">Argument $source is missing from the function Docblock</notice>
<notice line="29">Argument $target is missing from the function Docblock</notice>
<critical line="36">No short description for method drawPolyLine</critical>
<notice line="39">Argument $points is missing from the function Docblock</notice>
<critical line="61">No short description for method drawEllipse</critical>
<notice line="64">Argument $center is missing from the function Docblock</notice>
<notice line="64">Argument $dimension is missing from the function Docblock</notice>
<critical line="77">No short description for method drawPolygon</critical>
<notice line="80">Argument $points is missing from the function Docblock</notice>
<critical line="91">No short description for method drawRectangle</critical>
<notice line="94">Argument $topLeftCorner is missing from the function Docblock</notice>
<notice line="94">Argument $dimension is missing from the function Docblock</notice>
<critical line="111">No short description for method drawText</critical>
<notice line="114">Argument $topLeftCorner is missing from the function Docblock</notice>
<notice line="114">Argument $text is missing from the function Docblock</notice>
<critical line="133">No short description for method save</critical>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="RgbColor">Utils\Color\RgbColor</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="14" namespace="Utils\Graphics2D\DrawingPanes" package="Default">
<name>SvgDrawingPane</name>
<extends>\Utils\Graphics2D\DrawingPanes\DomDrawingPane</extends>
<full_name>\Utils\Graphics2D\DrawingPanes\SvgDrawingPane</full_name>
<docblock>
<description>This class implements a drawing pane for SVG output.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="21" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor for the class.</description>
<long-description>
</long-description>
<tag line="16" name="param" description="the dimension of the document" type="\Utils\Geom\Dimension" variable="$dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
<argument line="21">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="29" package="Default">
<name>drawLine</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="29">
<name>$source</name>
<default/>
<type>Point</type>
</argument>
<argument line="29">
<name>$target</name>
<default/>
<type>Point</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="39" package="Default">
<name>drawPolyLine</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="39">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="64" package="Default">
<name>drawEllipse</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="64">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="64">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="80" package="Default">
<name>drawPolygon</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="80">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="94" package="Default">
<name>drawRectangle</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="94">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="94">
<name>$dimension</name>
<default/>
<type>Dimension</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="114" package="Default">
<name>drawText</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="114">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="114">
<name>$text</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="136" package="Default">
<name>save</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="170" package="Default">
<name>pointsToString</name>
<docblock>
<description>This method converts a collection of Points to a string representation suitable for SVG output of polylines.</description>
<long-description>
</long-description>
<tag line="164" name="param" description="the collection of Points" type="\Traversable" variable="$points">
<type by_reference="false">\Traversable</type>
</tag>
<tag line="164" name="return" description="the string representation of the collection of Points, i.e. "x1, y1 x2, y2 ... xn, yn"" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="170">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="191" package="Default">
<name>pointCount</name>
<docblock>
<description>This method determines the number of Points in the given collection.</description>
<long-description>
</long-description>
<tag line="185" name="param" description="the collection of Points" type="\Traversable" variable="$points">
<type by_reference="false">\Traversable</type>
</tag>
<tag line="185" name="return" description="the number of points in the collection" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="191">
<name>$points</name>
<default/>
<type>Traversable</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="206" package="Default">
<name>getStyleAttribute</name>
<docblock>
<description>This method returns the constant SVG style attributes for the shapes.</description>
<long-description>
</long-description>
<tag line="201" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\DirectEdge.inc" hash="4be38bd8122abda1859e99b27981c386" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\DirectEdge.inc</error>
<critical line="27">No short description for method draw</critical>
<notice line="30">Argument $document is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<namespace-alias name="ShapeStyle">Utils\Graphics2D\Shapes\Styles\ShapeStyle</namespace-alias>
<namespace-alias name="EdgeStyle">Utils\Graphics2D\Shapes\Styles\EdgeStyle</namespace-alias>
<namespace-alias name="DrawingPane">Utils\Graphics2D\DrawingPanes\DrawingPane</namespace-alias>
<class final="false" abstract="false" line="13" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>DirectEdge</name>
<extends>\Utils\Graphics2D\Shapes\Edge</extends>
<full_name>\Utils\Graphics2D\Shapes\DirectEdge</full_name>
<docblock>
<description>This class represents a direct edge.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="22" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="15" name="param" description="the source of the edge" type="\Utils\Graphics2D\Shapes\IShape" variable="$source">
<type by_reference="false">\Utils\Graphics2D\Shapes\IShape</type>
</tag>
<tag line="15" name="param" description="the collection of targets of the shape" type="\ArrayAccess" variable="$targets">
<type by_reference="false">\ArrayAccess</type>
</tag>
<tag line="15" name="param" description="the style of the edge" type="\Utils\Graphics2D\Shapes\Styles\EdgeStyle" variable="$edgeStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\EdgeStyle</type>
</tag>
</docblock>
<argument line="22">
<name>$source</name>
<default/>
<type>IShape</type>
</argument>
<argument line="22">
<name>$targets</name>
<default/>
<type>ArrayAccess</type>
</argument>
<argument line="22">
<name>$edgeStyle</name>
<default/>
<type>EdgeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="30" package="Default">
<name>draw</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="30">
<name>$document</name>
<default/>
<type>DrawingPane</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Edge.inc" hash="de00088611b4f7a928cd425d0c26b57a" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Edge.inc</error>
<critical line="44">No short description for method getConnectionPoint</critical>
<notice line="47">Argument $orientation is missing from the function Docblock</notice>
<notice line="47">Argument $targetIndex is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<namespace-alias name="ShapeStyle">Utils\Graphics2D\Shapes\Styles\ShapeStyle</namespace-alias>
<namespace-alias name="EdgeStyle">Utils\Graphics2D\Shapes\Styles\EdgeStyle</namespace-alias>
<class final="false" abstract="true" line="12" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>Edge</name>
<extends>\Utils\Graphics2D\Shapes\Shape</extends>
<full_name>\Utils\Graphics2D\Shapes\Edge</full_name>
<docblock>
<description>This class represents an abstract edge shape.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="protected" line="19" package="Default">
<name>$source</name>
<default>null</default>
<docblock>
<description>the source of the edge</description>
<long-description>
</long-description>
<tag line="14" name="var" description="" type="\Utils\Graphics2D\Shapes\IShape">
<type by_reference="false">\Utils\Graphics2D\Shapes\IShape</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="26" package="Default">
<name>$targets</name>
<default>null</default>
<docblock>
<description>the collection of targets of the edge</description>
<long-description>
</long-description>
<tag line="21" name="var" description="of IShapes" type="\ArrayAccess">
<type by_reference="false">\ArrayAccess</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="35" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="28" name="param" description="the source of the edge" type="\Utils\Graphics2D\Shapes\IShape" variable="$source">
<type by_reference="false">\Utils\Graphics2D\Shapes\IShape</type>
</tag>
<tag line="28" name="param" description="the collection of targets of the shape" type="\ArrayAccess" variable="$targets">
<type by_reference="false">\ArrayAccess</type>
</tag>
<tag line="28" name="param" description="the style of the edge" type="\Utils\Graphics2D\Shapes\Styles\EdgeStyle" variable="$edgeStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\EdgeStyle</type>
</tag>
</docblock>
<argument line="35">
<name>$source</name>
<default/>
<type>IShape</type>
</argument>
<argument line="35">
<name>$targets</name>
<default/>
<type>ArrayAccess</type>
</argument>
<argument line="35">
<name>$edgeStyle</name>
<default/>
<type>EdgeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="47" package="Default">
<name>getConnectionPoint</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="47">
<name>$orientation</name>
<default/>
<type/>
</argument>
<argument line="47">
<name>$targetIndex</name>
<default>null</default>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\EdgeFactory.inc" hash="a188843a60a0c87fe0f663ee608946ce" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\EdgeFactory.inc</error>
</parse_markers>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<namespace-alias name="EdgeStyle">Utils\Graphics2D\Shapes\Styles\EdgeStyle</namespace-alias>
<class final="true" abstract="false" line="11" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>EdgeFactory</name>
<extends/>
<full_name>\Utils\Graphics2D\Shapes\EdgeFactory</full_name>
<docblock>
<description>This class acts as factory for graphical edge elements.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="16" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="26" package="Default">
<name>createEdge</name>
<docblock>
<description>This method acts as a factory method for Edges.</description>
<long-description>
</long-description>
<tag line="18" name="param" description="the style of the edge" type="\Utils\Graphics2D\Shapes\Styles\EdgeStyle" variable="$edgeStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\EdgeStyle</type>
</tag>
<tag line="18" name="param" description="the source shape of the edge" type="\Utils\Graphics2D\Shapes\IShape" variable="$source">
<type by_reference="false">\Utils\Graphics2D\Shapes\IShape</type>
</tag>
<tag line="18" name="param" description="the collection of target shapes of the edge" type="\ArrayAccess" variable="$targets">
<type by_reference="false">\ArrayAccess</type>
</tag>
<tag line="18" name="return" description="the new Edge" type="\Utils\Graphics2D\Shapes\Edge">
<type by_reference="false">\Utils\Graphics2D\Shapes\Edge</type>
</tag>
</docblock>
<argument line="26">
<name>$edgeStyle</name>
<default/>
<type>EdgeStyle</type>
</argument>
<argument line="26">
<name>$source</name>
<default/>
<type>IShape</type>
</argument>
<argument line="26">
<name>$targets</name>
<default/>
<type>ArrayAccess</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Ellipse.inc" hash="d55d75336f96e976822817d5a968e907" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Ellipse.inc</error>
<critical line="44">No short description for method draw</critical>
<notice line="47">Argument $document is missing from the function Docblock</notice>
<critical line="55">No short description for method getConnectionPoint</critical>
<notice line="58">Argument $orientation is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="ShapeStyle">Utils\Graphics2D\Shapes\Styles\ShapeStyle</namespace-alias>
<namespace-alias name="DrawingPane">Utils\Graphics2D\DrawingPanes\DrawingPane</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="13" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>Ellipse</name>
<extends>\Utils\Graphics2D\Shapes\Shape</extends>
<full_name>\Utils\Graphics2D\Shapes\Ellipse</full_name>
<docblock>
<description>This class represents an ellipse shape.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="20" package="Default">
<name>$center</name>
<default>null</default>
<docblock>
<description>the center of the Ellipse</description>
<long-description>
</long-description>
<tag line="15" name="var" description="" type="\Utils\Geom\Point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="27" package="Default">
<name>$dimension</name>
<default>null</default>
<docblock>
<description>the dimension of the Ellipse</description>
<long-description>
</long-description>
<tag line="22" name="var" description="" type="\Utils\Geom\Dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="35" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="29" name="param" description="the center of the Ellipse." type="\Utils\Geom\Point" variable="$center">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="29" name="param" description="the style of the Ellipse." type="\Utils\Graphics2D\Shapes\Styles\ShapeStyle" variable="$style">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\ShapeStyle</type>
</tag>
</docblock>
<argument line="35">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="35">
<name>$style</name>
<default/>
<type>ShapeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="47" package="Default">
<name>draw</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="47">
<name>$document</name>
<default/>
<type>DrawingPane</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="58" package="Default">
<name>getConnectionPoint</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="58">
<name>$orientation</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\IShape.inc" hash="ce421a4dd2fbb29d66f148485705ecee" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\IShape.inc</error>
</parse_markers>
<interface namespace="Utils\Graphics2D\Shapes" line="8" package="Default">
<name>IShape</name>
<extends/>
<full_name>\Utils\Graphics2D\Shapes\IShape</full_name>
<docblock>
<description>This interface defines a type for generic shapes.</description>
<long-description>
</long-description>
</docblock>
</interface>
</file>
<file path="\src\Utils\Graphics2D\Shapes\PolyEdge.inc" hash="2517ee5b303ca945428f0170f7e870c0" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\PolyEdge.inc</error>
<critical line="27">No short description for method draw</critical>
<notice line="30">Argument $document is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<namespace-alias name="ShapeStyle">Utils\Graphics2D\Shapes\Styles\ShapeStyle</namespace-alias>
<namespace-alias name="EdgeStyle">Utils\Graphics2D\Shapes\Styles\EdgeStyle</namespace-alias>
<namespace-alias name="DrawingPane">Utils\Graphics2D\DrawingPanes\DrawingPane</namespace-alias>
<class final="false" abstract="false" line="13" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>PolyEdge</name>
<extends>\Utils\Graphics2D\Shapes\Edge</extends>
<full_name>\Utils\Graphics2D\Shapes\PolyEdge</full_name>
<docblock>
<description>This class represents a poly-edge shape.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="22" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="15" name="param" description="the source of the edge" type="\Utils\Graphics2D\Shapes\IShape" variable="$source">
<type by_reference="false">\Utils\Graphics2D\Shapes\IShape</type>
</tag>
<tag line="15" name="param" description="the collection of targets of the shape" type="\ArrayAccess" variable="$targets">
<type by_reference="false">\ArrayAccess</type>
</tag>
<tag line="15" name="param" description="the style of the edge" type="\Utils\Graphics2D\Shapes\Styles\EdgeStyle" variable="$edgeStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\EdgeStyle</type>
</tag>
</docblock>
<argument line="22">
<name>$source</name>
<default/>
<type>IShape</type>
</argument>
<argument line="22">
<name>$targets</name>
<default/>
<type>ArrayAccess</type>
</argument>
<argument line="22">
<name>$edgeStyle</name>
<default/>
<type>EdgeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="30" package="Default">
<name>draw</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="30">
<name>$document</name>
<default/>
<type>DrawingPane</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Rectangle.inc" hash="a297ab701dde23971025dfd51d52f44d" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Rectangle.inc</error>
<critical line="44">No short description for method draw</critical>
<notice line="47">Argument $document is missing from the function Docblock</notice>
<critical line="55">No short description for method getConnectionPoint</critical>
<notice line="58">Argument $orientation is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="ShapeStyle">Utils\Graphics2D\Shapes\Styles\ShapeStyle</namespace-alias>
<namespace-alias name="DrawingPane">Utils\Graphics2D\DrawingPanes\DrawingPane</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="13" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>Rectangle</name>
<extends>\Utils\Graphics2D\Shapes\Shape</extends>
<full_name>\Utils\Graphics2D\Shapes\Rectangle</full_name>
<docblock>
<description>This class represents a rectangle shape.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="20" package="Default">
<name>$topLeftCorner</name>
<default>null</default>
<docblock>
<description>the top-left corner of the Rectangle</description>
<long-description>
</long-description>
<tag line="15" name="var" description="" type="\Utils\Geom\Point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="27" package="Default">
<name>$dimension</name>
<default>null</default>
<docblock>
<description>the dimension of the Rectangle</description>
<long-description>
</long-description>
<tag line="22" name="var" description="" type="\Utils\Geom\Dimension">
<type by_reference="false">\Utils\Geom\Dimension</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="35" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="29" name="param" description="the center of the Rectangle." type="\Utils\Geom\Point" variable="$topLeftCorner">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="29" name="param" description="the style of the Rectangle." type="\Utils\Graphics2D\Shapes\Styles\ShapeStyle" variable="$style">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\ShapeStyle</type>
</tag>
</docblock>
<argument line="35">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="35">
<name>$style</name>
<default/>
<type>ShapeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="47" package="Default">
<name>draw</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="47">
<name>$document</name>
<default/>
<type>DrawingPane</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="58" package="Default">
<name>getConnectionPoint</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="58">
<name>$orientation</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Shape.inc" hash="cb55623709fcf18cd53ce20b49b52f6b" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Shape.inc</error>
</parse_markers>
<namespace-alias name="IStyle">Utils\Graphics2D\Shapes\Styles\IStyle</namespace-alias>
<namespace-alias name="DrawingPane">Utils\Graphics2D\DrawingPanes\DrawingPane</namespace-alias>
<class final="false" abstract="true" line="11" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>Shape</name>
<extends/>
<full_name>\Utils\Graphics2D\Shapes\Shape</full_name>
<docblock>
<description>This class represents an abstract shape.</description>
<long-description>
</long-description>
</docblock>
<implements>\Utils\Graphics2D\Shapes\IShape</implements>
<constant namespace="Utils\Graphics2D\Shapes" line="16" package="Default">
<name>NORTH</name>
<value>0</value>
<docblock>
<description>the identifier for a connection point facing north</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Graphics2D\Shapes" line="21" package="Default">
<name>SOUTH</name>
<value>1</value>
<docblock>
<description>the identifier for a connection point facing south</description>
<long-description>
</long-description>
</docblock>
</constant>
<property final="false" static="false" visibility="protected" line="28" package="Default">
<name>$style</name>
<default>null</default>
<docblock>
<description>the style of the shape</description>
<long-description>
</long-description>
<tag line="23" name="var" description="" type="\Utils\Graphics2D\Shapes\Styles\IStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\IStyle</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="protected" line="35" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="30" name="param" description="the style of the shape" type="\Utils\Graphics2D\Shapes\Styles\IStyle" variable="$style">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\IStyle</type>
</tag>
</docblock>
<argument line="35">
<name>$style</name>
<default/>
<type>IStyle</type>
</argument>
</method>
<method final="false" abstract="true" static="false" visibility="public" line="45" package="Default">
<name>draw</name>
<docblock>
<description>This method draws the shape onto the IDrawingPane.</description>
<long-description>
</long-description>
<tag line="40" name="param" description="" type="\Utils\Graphics2D\DrawingPanes\DrawingPane" variable="$drawingPane">
<type by_reference="false">\Utils\Graphics2D\DrawingPanes\DrawingPane</type>
</tag>
</docblock>
<argument line="45">
<name>$drawingPane</name>
<default/>
<type>DrawingPane</type>
</argument>
</method>
<method final="false" abstract="true" static="false" visibility="public" line="52" package="Default">
<name>getConnectionPoint</name>
<docblock>
<description>This method returns the connection points of the Shape.</description>
<long-description>
</long-description>
<tag line="47" name="param" description="where the connections should face to, either Shape::NORTH or Shape::SOUTH" type="int" variable="$orientation">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="52">
<name>$orientation</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\ShapeFactory.inc" hash="d672e91221be0cd7c61b164311a7365a" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\ShapeFactory.inc</error>
</parse_markers>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<namespace-alias name="ShapeStyle">Utils\Graphics2D\Shapes\Styles\ShapeStyle</namespace-alias>
<class final="true" abstract="false" line="11" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>ShapeFactory</name>
<extends/>
<full_name>\Utils\Graphics2D\Shapes\ShapeFactory</full_name>
<docblock>
<description>This class acts as factory for graphical shape elements.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="16" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="25" package="Default">
<name>createShape</name>
<docblock>
<description>This method acts as factory method for Shapes.</description>
<long-description>
</long-description>
<tag line="18" name="param" description="the style of the shape" type="\Utils\Graphics2D\Shapes\Styles\ShapeStyle" variable="$shapeStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\ShapeStyle</type>
</tag>
<tag line="18" name="param" description="the position of the top-left corner of the shape" type="\Utils\Geom\Point" variable="$topLeftCorner">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="18" name="return" description="the new Shape" type="\Utils\Graphics2D\Shapes\Shape">
<type by_reference="false">\Utils\Graphics2D\Shapes\Shape</type>
</tag>
</docblock>
<argument line="25">
<name>$shapeStyle</name>
<default/>
<type>ShapeStyle</type>
</argument>
<argument line="25">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Star.inc" hash="48eb6bcce05eb3db08725c5bf2fdc89a" package="Default">
<markers>
<fixme line="100">if $lengthHeight was picked as length, this is wrong!</fixme>
</markers>
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Star.inc</error>
<critical line="71">No short description for method draw</critical>
<notice line="74">Argument $document is missing from the function Docblock</notice>
<critical line="122">No short description for method getConnectionPoint</critical>
<notice line="125">Argument $orientation is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="ShapeStyle">Utils\Graphics2D\Shapes\Styles\ShapeStyle</namespace-alias>
<namespace-alias name="DrawingPane">Utils\Graphics2D\DrawingPanes\DrawingPane</namespace-alias>
<namespace-alias name="Dimension">Utils\Geom\Dimension</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="13" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>Star</name>
<extends>\Utils\Graphics2D\Shapes\Shape</extends>
<full_name>\Utils\Graphics2D\Shapes\Star</full_name>
<docblock>
<description>This class represents a star shape.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="true" visibility="private" line="20" package="Default">
<name>$INNER_ANGLE</name>
<default>72</default>
<docblock>
<description>the angle between two adjacent points of the pentagon, measured in the center of the pentagon</description>
<long-description>
</long-description>
<tag line="15" name="var" description="" type="double">
<type by_reference="false">double</type>
</tag>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="27" package="Default">
<name>$DIAGONAL_TO_LENGTH</name>
<default>0.6180339887/*4989484820458683436569*/</default>
<docblock>
<description>factor to get the side length of the pentagram from the diagonal of the pentagram</description>
<long-description>
</long-description>
<tag line="22" name="var" description="" type="double">
<type by_reference="false">double</type>
</tag>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="34" package="Default">
<name>$HEIGHT_TO_LENGTH</name>
<default>0.6498393924/*6581265231174282443046*/</default>
<docblock>
<description>factor to get the side length of the pentagram from the height of the pentagram</description>
<long-description>
</long-description>
<tag line="29" name="var" description="" type="double">
<type by_reference="false">double</type>
</tag>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="41" package="Default">
<name>$LENGTH_TO_OUTTER_RADIUS</name>
<default>1.1755705045/*849462583374119092781*/</default>
<docblock>
<description>factor to get the radius of the circumcircle of the outter pentagram from the side length of the pentagram</description>
<long-description>
</long-description>
<tag line="36" name="var" description="" type="double">
<type by_reference="false">double</type>
</tag>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="49" package="Default">
<name>$DIAGONAL_TO_INNER_RADIUS</name>
<default>0.2008114158/*8622727986979767263375*/</default>
<docblock>
<description>factor to get the radius of the circumcircle of the inner pentagon from the diagonal of the outter pentagram</description>
<long-description>
</long-description>
<tag line="43" name="see" description="\Utils\Graphics2D\Shapes\http://mathworld.wolfram.com/Pentagram.html" refers="\Utils\Graphics2D\Shapes\http://mathworld.wolfram.com/Pentagram.html"/>
<tag line="43" name="var" description="" type="double">
<type by_reference="false">double</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="56" package="Default">
<name>$center</name>
<default>null</default>
<docblock>
<description>the center of the Star</description>
<long-description>
</long-description>
<tag line="51" name="var" description="" type="\Utils\Geom\Point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="64" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="58" name="param" description="the center of the Star" type="\Utils\Geom\Point" variable="$center">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="58" name="param" description="the style of the Star" type="\Utils\Graphics2D\Shapes\Styles\ShapeStyle" variable="$style">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\ShapeStyle</type>
</tag>
</docblock>
<argument line="64">
<name>$center</name>
<default/>
<type>Point</type>
</argument>
<argument line="64">
<name>$style</name>
<default/>
<type>ShapeStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="74" package="Default">
<name>draw</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="74">
<name>$document</name>
<default/>
<type>DrawingPane</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" line="89" package="Default">
<name>getPoints</name>
<docblock>
<description>This method gets the points to draw a 5-star.</description>
<long-description>
</long-description>
<tag line="82" name="param" description="the width of the Star" type="int" variable="$width">
<type by_reference="false">int</type>
</tag>
<tag line="82" name="param" description="the height of the Star" type="int" variable="$height">
<type by_reference="false">int</type>
</tag>
<tag line="82" name="return" description="of the Points of the Star" type="\ArrayObject">
<type by_reference="false">\ArrayObject</type>
</tag>
</docblock>
<argument line="89">
<name>$width</name>
<default/>
<type/>
</argument>
<argument line="89">
<name>$height</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="125" package="Default">
<name>getConnectionPoint</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="125">
<name>$orientation</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Styles\BorderStyle.inc" hash="8d0c2d4f1434f35ffe7078eb11287019" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\BorderStyle.inc</error>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<class final="false" abstract="false" line="10" namespace="Utils\Graphics2D\Shapes\Styles" package="Default">
<name>BorderStyle</name>
<extends>\Utils\Graphics2D\Shapes\Styles\LineStyle</extends>
<full_name>\Utils\Graphics2D\Shapes\Styles\BorderStyle</full_name>
<docblock>
<description>This class implements a style for borders.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="18" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="12" name="param" description="the width of the border in pixels" type="int" variable="$width">
<type by_reference="false">int</type>
</tag>
<tag line="12" name="param" description="the color of the border, or null for transparent color" type="\Utils\Color\Color" variable="$color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
<argument line="18">
<name>$width</name>
<default>1</default>
<type/>
</argument>
<argument line="18">
<name>$color</name>
<default>null</default>
<type>Color</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Styles\EdgeStyle.inc" hash="d528846eb0bf393623e77e8ff651ac56" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\EdgeStyle.inc</error>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<class final="false" abstract="false" line="10" namespace="Utils\Graphics2D\Shapes\Styles" package="Default">
<name>EdgeStyle</name>
<extends>\Utils\Graphics2D\Shapes\Styles\LineStyle</extends>
<full_name>\Utils\Graphics2D\Shapes\Styles\EdgeStyle</full_name>
<docblock>
<description>This class implements a style for edges.</description>
<long-description>
</long-description>
</docblock>
<constant namespace="Utils\Graphics2D\Shapes\Styles" line="15" package="Default">
<name>DIRECT_EDGE</name>
<value>0</value>
<docblock>
<description>the identifier for a direct edge, i.e. a direct line from source to target</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Graphics2D\Shapes\Styles" line="20" package="Default">
<name>POLY_EDGE</name>
<value>1</value>
<docblock>
<description>the identifier for a poly edge, i.e. a connection from source to target via horizonal or vertical lines only</description>
<long-description>
</long-description>
</docblock>
</constant>
<property final="false" static="false" visibility="protected" line="27" package="Default">
<name>$type</name>
<default>self::POLY_EDGE</default>
<docblock>
<description>the type of this edge, either self::DIRECT_EDGE or self::POLY_EDGE</description>
<long-description>
</long-description>
<tag line="22" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="36" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="29" name="param" description="the width of the edge" type="int" variable="$width">
<type by_reference="false">int</type>
</tag>
<tag line="29" name="param" description="the color of the edge, or null for transparent color" type="\Utils\Color\Color" variable="$color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
<tag line="29" name="param" description="the type of edge, either self::DIRECT_EDGE for a direct line, or self::POLY_EDGE for a poly edge" type="int" variable="$type">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="36">
<name>$width</name>
<default>1</default>
<type/>
</argument>
<argument line="36">
<name>$color</name>
<default>null</default>
<type>Color</type>
</argument>
<argument line="36">
<name>$type</name>
<default>self::POLY_EDGE</default>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Styles\IStyle.inc" hash="0d8c88f7f973171327b9100a687f0284" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\IStyle.inc</error>
</parse_markers>
<interface namespace="Utils\Graphics2D\Shapes\Styles" line="8" package="Default">
<name>IStyle</name>
<extends/>
<full_name>\Utils\Graphics2D\Shapes\Styles\IStyle</full_name>
<docblock>
<description>This interface defines a type for styles.</description>
<long-description>
</long-description>
</docblock>
</interface>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Styles\LineStyle.inc" hash="0f7eb7522315023ce5d5467abff7b4c1" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\LineStyle.inc</error>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="RgbColor">Utils\Color\RgbColor</namespace-alias>
<class final="false" abstract="true" line="11" namespace="Utils\Graphics2D\Shapes\Styles" package="Default">
<name>LineStyle</name>
<extends/>
<full_name>\Utils\Graphics2D\Shapes\Styles\LineStyle</full_name>
<docblock>
<description>This class implements an abstract style for lines.</description>
<long-description>
</long-description>
</docblock>
<implements>\Utils\Graphics2D\Shapes\Styles\IStyle</implements>
<property final="false" static="false" visibility="protected" line="18" package="Default">
<name>$width</name>
<default>null</default>
<docblock>
<description>the width of the line</description>
<long-description>
</long-description>
<tag line="13" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="25" package="Default">
<name>$color</name>
<default>null</default>
<docblock>
<description>the color of the line</description>
<long-description>
</long-description>
<tag line="20" name="var" description="" type="\Utils\Graphics2D\Shapes\Styles\RGBColor">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\RGBColor</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="33" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="27" name="param" description="the width of the line" type="int" variable="$width">
<type by_reference="false">int</type>
</tag>
<tag line="27" name="param" description="the color of the line" type="\Utils\Color\Color" variable="$color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
<argument line="33">
<name>$width</name>
<default>1</default>
<type/>
</argument>
<argument line="33">
<name>$color</name>
<default>null</default>
<type>Color</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="47" package="Default">
<name>__get</name>
<docblock>
<description>This method is a magic getter method for the class.</description>
<long-description>
</long-description>
<tag line="40" name="todo" description="replace this with Trait in PHP 5.4"/>
<tag line="40" name="param" description="the name of the member to get" type="string" variable="$memberName">
<type by_reference="false">string</type>
</tag>
<tag line="40" name="return" description="the value of the member" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="47">
<name>$memberName</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="57" package="Default">
<name>setWidth</name>
<docblock>
<description>This method is a setter for the width of the line style.</description>
<long-description>
</long-description>
<tag line="52" name="param" description="the new width of the line style" type="int" variable="$width">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="57">
<name>$width</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="67" package="Default">
<name>setColor</name>
<docblock>
<description>This method is a setter for the color of the line style.</description>
<long-description>
</long-description>
<tag line="62" name="param" description="the new color of the line style" type="\Utils\Color\Color" variable="$color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
<argument line="67">
<name>$color</name>
<default/>
<type>Color</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Styles\ShapeStyle.inc" hash="d9c69407468380b06e19639ac889570b" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\ShapeStyle.inc</error>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="RgbColor">Utils\Color\RgbColor</namespace-alias>
<class final="false" abstract="false" line="11" namespace="Utils\Graphics2D\Shapes\Styles" package="Default">
<name>ShapeStyle</name>
<extends/>
<full_name>\Utils\Graphics2D\Shapes\Styles\ShapeStyle</full_name>
<docblock>
<description>This class implements a style for shapes.</description>
<long-description>
</long-description>
</docblock>
<implements>\Utils\Graphics2D\Shapes\Styles\IStyle</implements>
<constant namespace="Utils\Graphics2D\Shapes\Styles" line="16" package="Default">
<name>RECTANGLE</name>
<value>0</value>
<docblock>
<description>the shape identifier for a rectangle</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Graphics2D\Shapes\Styles" line="21" package="Default">
<name>ELLIPSE</name>
<value>1</value>
<docblock>
<description>the shape identifier for an ellipse</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Graphics2D\Shapes\Styles" line="26" package="Default">
<name>STAR</name>
<value>2</value>
<docblock>
<description>the shape identifier for a star</description>
<long-description>
</long-description>
</docblock>
</constant>
<property final="false" static="false" visibility="protected" line="33" package="Default">
<name>$type</name>
<default>null</default>
<docblock>
<description>the type of shape</description>
<long-description>
</long-description>
<tag line="28" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="40" package="Default">
<name>$width</name>
<default>null</default>
<docblock>
<description>the width of the shape</description>
<long-description>
</long-description>
<tag line="35" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="47" package="Default">
<name>$height</name>
<default>null</default>
<docblock>
<description>the height of the shape</description>
<long-description>
</long-description>
<tag line="42" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="54" package="Default">
<name>$color</name>
<default>null</default>
<docblock>
<description>the color of the shape</description>
<long-description>
</long-description>
<tag line="49" name="var" description="" type="\Utils\Color\Color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="61" package="Default">
<name>$border</name>
<default>null</default>
<docblock>
<description>the border of the shape</description>
<long-description>
</long-description>
<tag line="56" name="var" description="" type="\Utils\Graphics2D\Shapes\Styles\BorderStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\BorderStyle</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="72" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="63" name="param" description="the type of the shape, which has to be one of self::RECTANGLE, self::ELLIPSE or self::STAR" type="int" variable="$type">
<type by_reference="false">int</type>
</tag>
<tag line="63" name="param" description="the width of the shape" type="int" variable="$width">
<type by_reference="false">int</type>
</tag>
<tag line="63" name="param" description="the height of the shape" type="int" variable="$height">
<type by_reference="false">int</type>
</tag>
<tag line="63" name="param" description="the color of the shape" type="\Utils\Color\Color" variable="$color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
<tag line="63" name="param" description="the border of the shape" type="\Utils\Graphics2D\Shapes\Styles\BorderStyle" variable="$border">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\BorderStyle</type>
</tag>
</docblock>
<argument line="72">
<name>$type</name>
<default>self::RECTANGLE</default>
<type/>
</argument>
<argument line="72">
<name>$width</name>
<default>22</default>
<type/>
</argument>
<argument line="72">
<name>$height</name>
<default>10</default>
<type/>
</argument>
<argument line="72">
<name>$color</name>
<default>null</default>
<type>Color</type>
</argument>
<argument line="72">
<name>$border</name>
<default>null</default>
<type>BorderStyle</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="92" package="Default">
<name>__get</name>
<docblock>
<description>This method is a magic getter method for the class.</description>
<long-description>
</long-description>
<tag line="85" name="todo" description="replace this with Trait in PHP 5.4"/>
<tag line="85" name="param" description="the name of the member to get" type="string" variable="$memberName">
<type by_reference="false">string</type>
</tag>
<tag line="85" name="return" description="the value of the member" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="92">
<name>$memberName</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="102" package="Default">
<name>setWidth</name>
<docblock>
<description>This method is a setter for the width of the shape style.</description>
<long-description>
</long-description>
<tag line="97" name="param" description="the new width of the shape" type="int" variable="$width">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="102">
<name>$width</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="112" package="Default">
<name>setHeight</name>
<docblock>
<description>This method is a setter for the height of the shape style.</description>
<long-description>
</long-description>
<tag line="107" name="param" description="the new height of the shape" type="int" variable="$height">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="112">
<name>$height</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="122" package="Default">
<name>setColor</name>
<docblock>
<description>This method is a setter for the color of the shape style.</description>
<long-description>
</long-description>
<tag line="117" name="param" description="the new color of the shape" type="\Utils\Color\Color" variable="$color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
<argument line="122">
<name>$color</name>
<default/>
<type>Color</type>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Styles\TextStyle.inc" hash="8d5e11eb0c71d6a3c829663ae86e6f93" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\TextStyle.inc</error>
</parse_markers>
<namespace-alias name="Color">Utils\Color\Color</namespace-alias>
<namespace-alias name="RgbColor">Utils\Color\RgbColor</namespace-alias>
<class final="false" abstract="false" line="11" namespace="Utils\Graphics2D\Shapes\Styles" package="Default">
<name>TextStyle</name>
<extends/>
<full_name>\Utils\Graphics2D\Shapes\Styles\TextStyle</full_name>
<docblock>
<description>This class implements a style for texts.</description>
<long-description>
</long-description>
</docblock>
<implements>\Utils\Graphics2D\Shapes\Styles\IStyle</implements>
<constant namespace="Utils\Graphics2D\Shapes\Styles" line="16" package="Default">
<name>LINE_PADDING</name>
<value>3</value>
<docblock>
<description>constant additional padding for calculating the line height with a given font size (always plus 3)</description>
<long-description>
</long-description>
</docblock>
</constant>
<property final="false" static="false" visibility="private" line="23" package="Default">
<name>$family</name>
<default>'Times'</default>
<docblock>
<description>the name of the font family</description>
<long-description>
</long-description>
<tag line="18" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="30" package="Default">
<name>$size</name>
<default>'12'</default>
<docblock>
<description>the font size in pixel</description>
<long-description>
</long-description>
<tag line="25" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="37" package="Default">
<name>$color</name>
<default>null</default>
<docblock>
<description>the font color</description>
<long-description>
</long-description>
<tag line="32" name="var" description="" type="\Utils\Color\Color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="46" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="39" name="param" description="the name of the font family" type="string" variable="$family">
<type by_reference="false">string</type>
</tag>
<tag line="39" name="param" description="the font size in pixel" type="int" variable="$size">
<type by_reference="false">int</type>
</tag>
<tag line="39" name="param" description="the font color" type="\Utils\Color\Color" variable="$color">
<type by_reference="false">\Utils\Color\Color</type>
</tag>
</docblock>
<argument line="46">
<name>$family</name>
<default>'Times'</default>
<type/>
</argument>
<argument line="46">
<name>$size</name>
<default>12</default>
<type/>
</argument>
<argument line="46">
<name>$color</name>
<default>null</default>
<type>Color</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="62" package="Default">
<name>__get</name>
<docblock>
<description>This method is a magic getter method for the class.</description>
<long-description>
</long-description>
<tag line="55" name="todo" description="replace this with Trait in PHP 5.4"/>
<tag line="55" name="param" description="the name of the member to get" type="string" variable="$memberName">
<type by_reference="false">string</type>
</tag>
<tag line="55" name="return" description="the value of the member" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="62">
<name>$memberName</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="74" package="Default">
<name>__set</name>
<docblock>
<description>This method is a magic setter method for the class.</description>
<long-description>
</long-description>
<tag line="67" name="todo" description="replace this with Trait in PHP 5.4"/>
<tag line="67" name="param" description="the name of the member to get" type="string" variable="$memberName">
<type by_reference="false">string</type>
</tag>
<tag line="67" name="param" description="the new value of the member" type="mixed" variable="$value">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="74">
<name>$memberName</name>
<default/>
<type/>
</argument>
<argument line="74">
<name>$value</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="84" package="Default">
<name>getLineHeight</name>
<docblock>
<description>This method returns the line height for this TextStyle.</description>
<long-description>
</long-description>
<tag line="79" name="return" description="the line height for this TextStyle in pixels" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="true" visibility="public" line="95" package="Default">
<name>pixelToPoint</name>
<docblock>
<description>This method converts from pixel to points unit.</description>
<long-description>
</long-description>
<tag line="89" name="param" description="the value in pixels" type="int" variable="$pixel">
<type by_reference="false">int</type>
</tag>
<tag line="89" name="return" description="the value in points" type="float">
<type by_reference="false">float</type>
</tag>
</docblock>
<argument line="95">
<name>$pixel</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="105" package="Default">
<name>__toString</name>
<docblock>
<description>This method returns a string representation of the text style.</description>
<long-description>
</long-description>
<tag line="100" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="116" package="Default">
<name>toCssClass</name>
<docblock>
<description>This method converts this TextStyle into a CSS class definition, with the given class name.</description>
<long-description>
</long-description>
<tag line="110" name="param" description="the class name of the CSS class definition" type="string" variable="$className">
<type by_reference="false">string</type>
</tag>
<tag line="110" name="return" description="a CSS class definition with the given class name of this TextStlye" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="116">
<name>$className</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="129" package="Default">
<name>getHash</name>
<docblock>
<description>This method returns a "hash" of this TextStyle.</description>
<long-description>
</long-description>
<tag line="124" name="return" description="a "hash" of this TextStyle, consisting of the concatination of the fontFamily and size members of this TextStyle" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\Text.inc" hash="e05ad4e6ee2a73117d01e05d71a6b49b" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Text.inc</error>
<notice line="35">Name of argument $style does not match with function Docblock</notice>
<notice line="35">Name of argument $text does not match with function Docblock</notice>
<critical line="44">No short description for method draw</critical>
<notice line="47">Argument $drawingPane is missing from the function Docblock</notice>
<critical line="55">No short description for method getConnectionPoint</critical>
<notice line="58">Argument $orientation is missing from the function Docblock</notice>
</parse_markers>
<namespace-alias name="TextStyle">Utils\Graphics2D\Shapes\Styles\TextStyle</namespace-alias>
<namespace-alias name="DrawingPane">Utils\Graphics2D\DrawingPanes\DrawingPane</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<class final="false" abstract="false" line="12" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>Text</name>
<extends>\Utils\Graphics2D\Shapes\Shape</extends>
<full_name>\Utils\Graphics2D\Shapes\Text</full_name>
<docblock>
<description>This class represents a text shape.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="19" package="Default">
<name>$topLeftCorner</name>
<default>null</default>
<docblock>
<description>the top-left corner of the Text</description>
<long-description>
</long-description>
<tag line="14" name="var" description="" type="\Utils\Geom\Point">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="26" package="Default">
<name>$text</name>
<default>null</default>
<docblock>
<description>the actual text of the Text</description>
<long-description>
</long-description>
<tag line="21" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="35" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="28" name="param" description="the top-left corner where to position the text" type="\Utils\Geom\Point" variable="$topLeftCorner">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="28" name="param" description="the textStyle to use for the text." type="\Utils\Graphics2D\Shapes\Styles\TextStyle" variable="$textStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
<tag line="28" name="param" description="the actual text of the Text" type="string" variable="$treeNode">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="35">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="35">
<name>$style</name>
<default/>
<type>TextStyle</type>
</argument>
<argument line="35">
<name>$text</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="47" package="Default">
<name>draw</name>
<docblock>
<description/>
<long-description>
</long-description>
</docblock>
<argument line="47">
<name>$drawingPane</name>
<default/>
<type>DrawingPane</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="58" package="Default">
<name>getConnectionPoint</name>
<docblock>
<description/>
<long-description>
</long-description>
<tag line="55" name="todo" description=": tobe implemented later"/>
</docblock>
<argument line="58">
<name>$orientation</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Graphics2D\Shapes\TextFactory.inc" hash="0401208e656739ea00cf25337b5e9995" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Graphics2D\Shapes\TextFactory.inc</error>
</parse_markers>
<namespace-alias name="Text">Utils\Graphics2D\Shapes\Text</namespace-alias>
<namespace-alias name="TextStyle">Utils\Graphics2D\Shapes\Styles\TextStyle</namespace-alias>
<namespace-alias name="Point">Utils\Geom\Point</namespace-alias>
<namespace-alias name="ITreeModel">ReingoldTilford\Models\ITreeModel</namespace-alias>
<class final="true" abstract="false" line="13" namespace="Utils\Graphics2D\Shapes" package="Default">
<name>TextFactory</name>
<extends/>
<full_name>\Utils\Graphics2D\Shapes\TextFactory</full_name>
<docblock>
<description>This class acts as factory for graphical text elements.</description>
<long-description>
</long-description>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" line="18" package="Default">
<name>__construct</name>
<docblock>
<description>This acts as the constructor of the class.</description>
<long-description>
</long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="28" package="Default">
<name>createText</name>
<docblock>
<description>This method creates a text.</description>
<long-description>
</long-description>
<tag line="20" name="param" description="the textStyle to use for the text." type="\Utils\Graphics2D\Shapes\Styles\TextStyle" variable="$textStyle">
<type by_reference="false">\Utils\Graphics2D\Shapes\Styles\TextStyle</type>
</tag>
<tag line="20" name="param" description="the top-left corner where to position the text" type="\Utils\Geom\Point" variable="$topLeftCorner">
<type by_reference="false">\Utils\Geom\Point</type>
</tag>
<tag line="20" name="param" description="the text to represent" type="string" variable="$text">
<type by_reference="false">string</type>
</tag>
<tag line="20" name="return" description="the new Text object" type="\Utils\Graphics2D\Shapes\Text">
<type by_reference="false">\Utils\Graphics2D\Shapes\Text</type>
</tag>
</docblock>
<argument line="28">
<name>$textStyle</name>
<default/>
<type>TextStyle</type>
</argument>
<argument line="28">
<name>$topLeftCorner</name>
<default/>
<type>Point</type>
</argument>
<argument line="28">
<name>$text</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Logging\FileLogger.inc" hash="8d67935a7d34798830b6630177bf9948" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Logging\FileLogger.inc</error>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="Utils\Logging" package="Default">
<name>FileLogger</name>
<extends>\Utils\Logging\Logger</extends>
<full_name>\Utils\Logging\FileLogger</full_name>
<docblock>
<description>This class acts as a logger which prints to a file.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="true" visibility="protected" line="15" package="Default">
<name>$target</name>
<default>'log.txt'</default>
<docblock>
<description>the target of the file logger</description>
<long-description>
</long-description>
<tag line="10" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="true" visibility="public" line="22" package="Default">
<name>setLogFilename</name>
<docblock>
<description>This method sets the file name of the log file to use.S</description>
<long-description>
</long-description>
<tag line="17" name="param" description="the file name of the file where to log to" type="string" variable="$filename">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="22">
<name>$filename</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\Logging\Logger.inc" hash="11076ea2227147f8f04ec249f75dfa8f" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\Logging\Logger.inc</error>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="Utils\Logging" package="Default">
<name>Logger</name>
<extends/>
<full_name>\Utils\Logging\Logger</full_name>
<docblock>
<description>This class acts as a logger which prints to the standard output.</description>
<long-description>
</long-description>
</docblock>
<constant namespace="Utils\Logging" line="13" package="Default">
<name>ALL</name>
<value>-1</value>
<docblock>
<description>the identifier for the log level ALL</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Logging" line="18" package="Default">
<name>OFF</name>
<value>0</value>
<docblock>
<description>the identifier for the log level OFF</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Logging" line="23" package="Default">
<name>INFO</name>
<value>1</value>
<docblock>
<description>the identifier for the log level INFO</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Logging" line="28" package="Default">
<name>WARNING</name>
<value>2</value>
<docblock>
<description>the identifier for the log level WARNING</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Logging" line="33" package="Default">
<name>ERROR</name>
<value>4</value>
<docblock>
<description>the identifier for the log level ERROR</description>
<long-description>
</long-description>
</docblock>
</constant>
<constant namespace="Utils\Logging" line="38" package="Default">
<name>DEBUG</name>
<value>8</value>
<docblock>
<description>the identifier for the log level DEBUG</description>
<long-description>
</long-description>
</docblock>
</constant>
<property final="false" static="true" visibility="private" line="45" package="Default">
<name>$CURRENT_SEVERITY</name>
<default>15</default>
<docblock>
<description>the current log level of the logger</description>
<long-description>
</long-description>
<tag line="40" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="true" visibility="protected" line="52" package="Default">
<name>$target</name>
<default>'php://stdout'</default>
<docblock>
<description>the target of the logging output</description>
<long-description>
</long-description>
<tag line="47" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="true" visibility="public" line="60" package="Default">
<name>log</name>
<docblock>
<description>This method logs the given message to the respective target, if the currrent severity includes the passed severity.</description>
<long-description>
</long-description>
<tag line="54" name="param" description="the log level of the log message" type="int" variable="$severity">
<type by_reference="false">int</type>
</tag>
<tag line="54" name="param" description="the log message" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="60">
<name>$severity</name>
<default/>
<type/>
</argument>
<argument line="60">
<name>$message</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="true" visibility="public" line="71" package="Default">
<name>setLogLevel</name>
<docblock>
<description>This method sets the log level of the logger.</description>
<long-description>
</long-description>
<tag line="66" name="param" description="the new severity of the logger" type="int" variable="$severity">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="71">
<name>$severity</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="true" visibility="protected" line="82" package="Default">
<name>isSevere</name>
<docblock>
<description>This method decides whether or not the passed severity is included in the current severity of the logger.</description>
<long-description>
</long-description>
<tag line="76" name="param" description="the severity to decide upon" type="int" variable="$severity">
<type by_reference="false">int</type>
</tag>
<tag line="76" name="return" description="true, if the passed log level is included in the loggers severity, false if not" type="boolean">
<type by_reference="false">boolean</type>
</tag>
</docblock>
<argument line="82">
<name>$severity</name>
<default/>
<type/>
</argument>
</method>
</class>
</file>
<file path="\src\Utils\URL\Url.inc" hash="325d584f2b70cd0fa5ca85e87bd41ac5" package="Default">
<parse_markers>
<error line="1">No DocBlock was found for File \src\Utils\URL\Url.inc</error>
</parse_markers>
<class final="false" abstract="false" line="8" namespace="Utils\URL" package="Default">
<name>Url</name>
<extends/>
<full_name>\Utils\URL\Url</full_name>
<docblock>
<description>This class is a simple wrapper for an URL.</description>
<long-description>
</long-description>
</docblock>
<property final="false" static="false" visibility="private" line="15" package="Default">
<name>$protocol</name>
<default>null</default>
<docblock>
<description>the protocol of the URL</description>
<long-description>
</long-description>
<tag line="10" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="22" package="Default">
<name>$host</name>
<default>null</default>
<docblock>
<description>the host address of the URL, e.g. a fully qualified name, or an IP address</description>
<long-description>
</long-description>
<tag line="17" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="29" package="Default">
<name>$path</name>
<default>null</default>
<docblock>
<description>the path component of the URL</description>
<long-description>
</long-description>
<tag line="24" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="36" package="Default">
<name>$port</name>
<default>null</default>
<docblock>
<description>the number port of the URL</description>
<long-description>
</long-description>
<tag line="31" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" line="46" package="Default">
<name>__construct</name>
<docblock>
<description>This method acts as the constructor of the class.</description>
<long-description>
</long-description>
<tag line="38" name="param" description="the protocol of the URL" type="string" variable="$protocol">
<type by_reference="false">string</type>
</tag>
<tag line="38" name="param" description="the host address of the URL, e.g. a fully qualified name, or an IP address" type="string" variable="$host">
<type by_reference="false">string</type>
</tag>
<tag line="38" name="param" description="the path component of the URL" type="string" variable="$path">
<type by_reference="false">string</type>
</tag>
<tag line="38" name="param" description="the number port of the URL, maybe null" type="int" variable="$port">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="46">
<name>$protocol</name>
<default/>
<type/>
</argument>
<argument line="46">
<name>$host</name>
<default/>
<type/>
</argument>
<argument line="46">
<name>$path</name>
<default/>
<type/>
</argument>
<argument line="46">
<name>$port</name>
<default>null</default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="62" package="Default">
<name>getProtocol</name>
<docblock>
<description>This method return the protocol of the URL.</description>
<long-description>
</long-description>
<tag line="57" name="return" description="the protocol of the URL" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="72" package="Default">
<name>getHost</name>
<docblock>
<description>This method return the host address of the URL.</description>
<long-description>
</long-description>
<tag line="67" name="return" description="the host address of the URL" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="82" package="Default">
<name>getPath</name>
<docblock>
<description>This method return the path component of the URL.</description>
<long-description>
</long-description>
<tag line="77" name="return" description="the path component of the URL" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="92" package="Default">
<name>getPort</name>
<docblock>
<description>This method return the port number of the URL.</description>
<long-description>
</long-description>
<tag line="87" name="return" description="the port number of the URL, or null if it is not set" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="103" package="Default">
<name>setPath</name>
<docblock>
<description>This method sets the path of the URL.</description>
<long-description>
</long-description>
<tag line="97" name="param" description="the path to set" type="string" variable="$path">
<type by_reference="false">string</type>
</tag>
<tag line="97" name="return" description="the URL with the given path set" type="\Utils\URL\Url">
<type by_reference="false">\Utils\URL\Url</type>
</tag>
</docblock>
<argument line="103">
<name>$path</name>
<default/>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" line="113" package="Default">
<name>__toString</name>
<docblock>
<description>This method returns a string representation of the Url.</description>
<long-description>
</long-description>
<tag line="108" name="return" description="the string representation of the Url" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="true" visibility="public" line="128" package="Default">
<name>createCurrentUrlFromServerInfo</name>
<docblock>
<description>This method creates and returns an URL that is represented in the PHP $_SERVER super global.</description>
<long-description>
</long-description>
<tag line="123" name="return" description="the URL that is represented in the PHP $_SERVER super global" type="\Utils\URL\Url">
<type by_reference="false">\Utils\URL\Url</type>
</tag>
</docblock>
</method>
</class>
</file>
<package name="Default"/>
<namespace name="ReingoldTilford">
<namespace name="Algorithms"/>
<namespace name="Models"/>
<namespace name="Plotters"/>
<namespace name="Styles"/>
</namespace>
<namespace name="Utils">
<namespace name="Autoload"/>
<namespace name="Color"/>
<namespace name="File"/>
<namespace name="Font">
<namespace name="FontMetricServices"/>
</namespace>
<namespace name="Geom"/>
<namespace name="Graphics2D">
<namespace name="DrawingPanes"/>
<namespace name="Shapes">
<namespace name="Styles"/>
</namespace>
</namespace>
<namespace name="Logging"/>
<namespace name="URL"/>
</namespace>
<namespace name="default"/>
<marker>todo</marker>
<marker>fixme</marker>
</project>
|
Stumble It!
Bookmark in del.icio.us
Download
