# File: docs/structure.xml

  No DocBlock was found for File \app\bootstrap.inc No DocBlock was found for Constant INSTALLATION_FOLDER No DocBlock was found for Constant SOURCE_FOLDER No DocBlock was found for Constant DATA_FOLDER /Utils/Autoload/Autoloader.inc INSTALLATION_FOLDER str_replace('\\', '/', realpath(__DIR__.'/..')) SOURCE_FOLDER INSTALLATION_FOLDER.'/src' DATA_FOLDER INSTALLATION_FOLDER.'/data' No DocBlock was found for File \src\ReingoldTilford\Algorithms\Layout.inc No short description for method current No short description for method key No short description for method next No short description for method rewind No short description for method valid ReingoldTilford\Styles\TreeStyle Utils\Geom\Dimension Utils\Geom\Point Layout \ReingoldTilford\Algorithms\Layout This class encapsulates the layout of a collection of (tree) nodes. \Iterator $coordinates null the collection of coorindates \SplObjectStorage __construct This acts as the constructor of the class. \SplObjectStorage$coordinates SplObjectStorage normalize 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. \ReingoldTilford\Algorithms\Layout getDimension This method gets the dimensions of the layout. \ReingoldTilford\Styles\TreeStyle \Utils\Geom\Dimension $treeStyle TreeStyle getPosition This method returns the position of a given tree node with respect to a given tree style. object \ReingoldTilford\Styles\TreeStyle \Utils\Geom\Point$node $treeStyle TreeStyle getXCoordinate This method returns the x-coordinate of a given tree node with respect to a given tree style. object \ReingoldTilford\Styles\TreeStyle int$node $treeStyle TreeStyle getYCoordinate This method returns the y-coordinate of a given tree node with respect to a given tree style. object \ReingoldTilford\Styles\TreeStyle int$node $treeStyle TreeStyle current key next rewind valid No DocBlock was found for File \src\ReingoldTilford\Algorithms\ReingoldTilfordAlgorithm.inc Utils\Geom\Point ReingoldTilford\Algorithms\Layout ReingoldTilford\Models\ITreeModel ReingoldTilford\Styles\TreeStyle ReingoldTilfordAlgorithm \ReingoldTilford\Algorithms\ReingoldTilfordAlgorithm 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.$ONLY_CHILD_DEGREE 1 one child only makes an only child degree $BINARY_DEGREE 2 two children make an binary degree$model null the tree model the algorithm uses \ReingoldTilford\Models\ITreeModel $root null the root of the (sub)tree to be printed \ReingoldTilford\Algorithms\TreeNode$minDistance 1 the minimal horizontal distance of two nodes int $leftOutline null the left outline of the nodes \ReingoldTilford\Algorithms\SplObjectStorage$rightOutline null the right outline of the nodes \ReingoldTilford\Algorithms\SplObjectStorage $currentRightOutline null the current right outline (i.e. right outline of the current left subtree) array$leftThread null the left threads \ReingoldTilford\Algorithms\SplObjectStorage $rightThread null the right threads \ReingoldTilford\Algorithms\SplObjectStorage$offsets null the x-offsets of the nodes \ReingoldTilford\Algorithms\SplObjectStorage $parents null hash table that maps a node to its parent \ReingoldTilford\Algorithms\SplObjectStorage$depths null hash table that maps a node to its depth \ReingoldTilford\Algorithms\SplObjectStorage $orientation TreeStyle::CENTERED the orientation variant of the tree string$children null a reference to the children of the currently visited node (cached for performance reasons) \ReingoldTilford\Algorithms\array[int]TreeNode $nodeDegree null the number of children of the currently visited node (cached for performance reasons) int __construct This method acts as the constructor of the class. initialize This method (re)initializes the internal data structures, so an object of this class can be used for several trees to be drawn. void calculatesOffsets This method calculates the offsets of a node. <p>This is the main method of the algorithm.</p> object$node calculateSubTreeShifts This method returns the subtree shifts of the children of the current node. object \ReingoldTilford\Algorithms\array[int][int]TreeNode \ReingoldTilford\Algorithms\array[int][int]TreeNode \ReingoldTilford\Algorithms\array[int]int $node$leftOutlines $rightOutlines setNodeOffsets This method sets the offsets of the children of the current node. object \ReingoldTilford\Algorithms\array[int]double void$node $subTreeShifts updateOutlines This method updates the left and the right outline of the current node. object \ReingoldTilford\Algorithms\array[int][int]TreeNode void$node $leftOutlines getLayout This method returns a Layout for a given ITreeModel. \ReingoldTilford\Models\ITreeModel \ReingoldTilford\Algorithms\type \ReingoldTilford\Algorithms\Layout$model ITreeModel $orientation TreeStyle::CENTERED initializeMetaData This helper method initializes the meta data for use in the algorithm getPreOrderEnumeration This helper method returns the pre-order enumaration of the tree model. \SplDoublyLinkedList getPostOrderEnumeration This helper method returns the post-order enumaration of the tree model. \SplDoublyLinkedList getChildren This helper method returns the child nodes of a given node. object \ArrayObject$node getDegree This helper method gets the degree of a given node. object int $node No DocBlock was found for File \src\ReingoldTilford\Models\DomTreeModel.inc Argument$node is missing from the function Docblock DomTreeModel \ReingoldTilford\Models\TreeModel \ReingoldTilford\Models\DomTreeModel This class acts as TreeModel implementation for the PHP's DOMNode class, so this can be used with ReingoldTilford algorithm. __construct This method acts as the constructor of the TreeNodeTreeModel. object $root getChild This method returns the child of the given parent at the given index. object int$parent $index getChildCount This method returns the number of children of the given parent. object int$parent getIndexOfChild This method returns the index of the given child in the given parent. object object int $parent$child getRoot This method returns the root of the tree. object isLeaf This method returns true if the given node is a leaf. object boolean $node getLabel This method returns the label associated with the DOM node, i.e. the node name. <p>As the PHP DOMNode class does not provide a __toString method, a custom implementation is needed.</p>$node No DocBlock was found for File \src\ReingoldTilford\Models\FSTreeModel.inc No short description for method getLabel Argument $node is missing from the function Docblock Utils\File\Directory Utils\File\File FSTreeModel \ReingoldTilford\Models\TreeModel \ReingoldTilford\Models\FSTreeModel This class acts as ITreeModel implementation for the FileSystemObject classes (@see Utils\File\), so they can be used with ReingoldTilford algorithm. __construct This method acts as the constructor of the TreeNodeTreeModel. object$root getChild This method returns the child of the given parent at the given index. object int $parent$index getChildCount This method returns the number of children of the given parent. object int $parent getIndexOfChild This method returns the index of the given child in the given parent. object object int$parent $child isLeaf This method returns true if the given node is a leaf. object boolean$node getLabel $node No DocBlock was found for File \src\ReingoldTilford\Models\ITreeModel.inc Argument$node is missing from the function Docblock ITreeModel \ReingoldTilford\Models\ITreeModel This interface defines the basic methods that are neccessary for a data structure to be processed by the Reingold-Tilford tree drawing algorithm. getChild This method returns the child at the given index of the given parent. object int object $parent$index getChildCount This method returns the number of children of the given node. object boolean $parent getIndexOfChild This method returns the index of the given child of the given parent. object object int$parent $child getRoot This method returns the root of the tree \ReingoldTilford\Models\onject isLeaf This method decides whether or not the given node is a leaf or not object boolean$node getLabel This method returns the label associated with a tree node $node No DocBlock was found for File \src\ReingoldTilford\Models\TreeModel.inc TreeModel \ReingoldTilford\Models\TreeModel This class acts as an abstract ITreeModel implementation, implementing the most basic elements. \ReingoldTilford\Models\ITreeModel$root null the root of the tree object __construct This method acts as the constructor of the TreeNodeTreeModel. object $root getRoot This method returns the root of the tree. object isLeaf This method returns true if the given node is a leaf. object boolean$node getLabel This method returns the label of the given node. <p>This default implementation return the empty string.</p> \ReingoldTilford\Models\type string $node No DocBlock was found for File \src\ReingoldTilford\Plotters\Plotter.inc ReingoldTilford\Algorithms\Layout ReingoldTilford\Models\ITreeModel ReingoldTilford\Styles\TreeStyle Utils\Graphics2D\Shapes\ShapeFactory Utils\Graphics2D\Shapes\EdgeFactory Utils\Graphics2D\Shapes\TextFactory Utils\Graphics2D\DrawingPanes\DrawingPane Utils\Geom\Point Plotter \ReingoldTilford\Plotters\Plotter This class can plot the layout returned by the Reingolf-Tilford tree drawing algorithm.$model null the tree model \ReingoldTilford\Models\ITreeModel $layout null the layout \ReingoldTilford\Algorithms\Layout$treeStyle null the tree style \ReingoldTilford\Styles\TreeStyle $shapeFactory null the factory for creating shapes \Utils\Graphics2D\Shapes\ShapeFactory$edgeFactory null the factory for creating edges \Utils\Graphics2D\Shapes\EdgeFactory $textFactory null the factory for creating texts \Utils\Graphics2D\Shapes\TextFactory$shapeMap null the mapping from nodes to shapes \SplObjectStorage __construct This acts as the constructor of the class. \ReingoldTilford\Models\ITreeModel \ReingoldTilford\Algorithms\Layout \Utils\Graphics2D\Shapes\ShapeFactory \Utils\Graphics2D\Shapes\EdgeFactory \Utils\Graphics2D\Shapes\TextFactory $model ITreeModel$layout Layout $shapeFactory null ShapeFactory$edgeFactory null EdgeFactory $textFactory null TextFactory getShapeFactory This method returns the shape factory. \Utils\Graphics2D\Shapes\ShapeFactory getEdgeFactory This method returns the edge factory. \Utils\Graphics2D\Shapes\EdgeFactory setShapeFactory This method sets the shape factory. \Utils\Graphics2D\Shapes\ShapeFactory$shapeFactory setEdgeFactory This method sets the edge factory. \Utils\Graphics2D\Shapes\EdgeFactory $edgeFactory plot This method plots the tree with the given TreeStyle onto the given IDrawingPane \ReingoldTilford\Styles\TreeStyle \Utils\Graphics2D\DrawingPanes\DrawingPane \Utils\Graphics2D\DrawingPanes\DrawingPane$style TreeStyle $drawingPane DrawingPane plotIterativ This method plots the tree in an interative way. object$root plotRecursive This method plots the tree in a recursive way. <p>This might not be a good idea for real huge trees.</p> object $root drawShape This method exports a node as a source shape. object \ReingoldTilford\Plotters\Shape$node drawEdges This method exports the edges between the source and its target nodes. object $sourceNode getTargetShapes This method returns the target shapes for a given source node. object \ArrayObject$sourceNode No DocBlock was found for File \src\ReingoldTilford\Styles\TreeStyle.inc Utils\Graphics2D\Shapes\Styles\IStyle Utils\Graphics2D\Shapes\Styles\ShapeStyle Utils\Graphics2D\Shapes\Styles\EdgeStyle Utils\Graphics2D\Shapes\Styles\TextStyle TreeStyle \ReingoldTilford\Styles\TreeStyle This class implements a style for trees. \Utils\Graphics2D\Shapes\Styles\IStyle LEFT_BOUND 0 the identifier for a left-bound orientation of child nodes CENTERED 1 the identifier for a centered orientation of child nodes RIGHT_BOUND 2 the identifier for a right-bound orientation of child nodes $shapeStyle null the style of the shapes \Utils\Graphics2D\Shapes\Styles\ShapeStyle$edgeStyle null the style of the edges \Utils\Graphics2D\Shapes\Styles\EdgeStyle $textStyle null the style of the text \Utils\Graphics2D\Shapes\Styles\TextStyle$xOffset null 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) int $yOffset null 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 int$xPadding null the offset from the top of the container to the top of the root (meassured in the measuring unit given by TreeStyle::unit) int $yPadding null 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) int$unit null the measuring unit of the layout string $orientation null the orientation of the tree, either one of left, center or right hierarchical int __construct This acts as the constructor of the class. \Utils\Graphics2D\Shapes\Styles\ShapeStyle \Utils\Graphics2D\Shapes\Styles\EdgeStyle \Utils\Graphics2D\Shapes\Styles\TextStyle \ReingoldTilford\Styles\type \ReingoldTilford\Styles\type \ReingoldTilford\Styles\type \ReingoldTilford\Styles\type \ReingoldTilford\Styles\type \ReingoldTilford\Styles\type$shapeStyle null ShapeStyle $edgeStyle null EdgeStyle$textStyle null TextStyle $xOffset 5$yOffset 10 $xPadding 40$yPadding 40 $unit 'px'$orientation TreeStyle::CENTERED __get This method is a magic getter method for the class. string mixed $memberName setTreeOrientation This method sets the tree orientation. int$orientation setXOffset This method sets the x-offset. int $xOffset setYOffset This method sets the y-offset. int$yOffset setXPadding This method sets the x-padding. int $xPadding setYPadding This method sets the y-padding. int$yPadding No DocBlock was found for File \src\Utils\Autoload\Autoloader.inc SourceFileNotFoundException.inc Autoloader \Utils\Autoload\Autoloader 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. $baseDirectory null the base directory from where to start looking for source files string __construct This method acts as the constructor of the class. \Utils\Autoload\type$baseDirectory autoload This method tries to load the source file associated with the class denoted by the given class name. <p>If no source file can be found, a SourceFileNotFoundException will be thrown.</p> string $className getFileName This method determines the file name for a given class name, taking the base directory into account. string string$className No DocBlock was found for File \src\Utils\Autoload\SourceFileNotFoundException.inc SourceFileNotFoundException \RuntimeException \Utils\Autoload\SourceFileNotFoundException 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. __construct This method acts as the constructor for the class. string $name No DocBlock was found for File \src\Utils\Color\Color.inc Color \Utils\Color\Color This class serves as abstract class for any color. __construct This method is the constructor of the class. void __get This is a magic getter for the members of this class. string mixed$memberName No DocBlock was found for File \src\Utils\Color\RgbColor.inc RgbColor \Utils\Color\Color \Utils\Color\RgbColor This class encapsulates an RGB color. $red 0 the red color component int$green 0 the green color component int $blue 0 the blue color component int __construct This method is the constructor of the class. int int int void$red $green$blue __toString This method returns the DOM representation of the color, e.g. #000000 for black. string No DocBlock was found for File \src\Utils\File\Directory.inc Directory \Utils\File\FileSystemObject \Utils\File\Directory This class represents a directory in the file system. It contains a collection of children referencing files and other directories. $children null the children of the directory \ArrayObject __construct This method acts as the constructor of the class. \SplFileInfo$fileInfo SplFileInfo addChild This method adds a child to this directory. \Utils\File\FileSystemObject $child FileSystemObject getChild This method gets the child from the given index. int \Utils\File\FileSystemObject$index getDecendants This method returns all the decendants of a Directory recursively. \ArrayObject expand This method expands this directory to include all its subdirectories and files. \Utils\File\Directory toRealPath 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. <p>Note, the referenced directory or file must exist physically prior to calling this method.</p> string string $relativePath No DocBlock was found for File \src\Utils\File\File.inc File \Utils\File\FileSystemObject \Utils\File\File This class represents a file in the file system. __construct This method acts as the constructor of the class. \SplFileInfo$fileInfo SplFileInfo No DocBlock was found for File \src\Utils\File\FileSystemObject.inc FileSystemObject \Utils\File\FileSystemObject This class represents an abstract object in the file system. \Utils\File\IFileSystemObject $fileInfo null the file information object associated with this file system object \SplFileInfo$parent null the parent directory of the file system object \Utils\File\Directory __construct This method acts as the constructor of the class. \SplFileInfo $fileInfo SplFileInfo getBasename This method returns the base name of the file system object. string getPathname This method returns the path name of this file system object. string getParent This method returns the parent directory of this file system object. \Utils\File\Directory __toString This method returns the string representation of the file system object, i.e. its base name. string No DocBlock was found for File \src\Utils\File\IFileSystemObject.inc IFileSystemObject \Utils\File\IFileSystemObject This interface defines a type for representing an abstract object in the file system. No DocBlock was found for File \src\Utils\Font\FontManager.inc Utils\Graphics2D\Shapes\Styles\TextStyle Utils\Font\FontMetric Utils\Font\FontMetricServices\FontMetricService FontManager \Utils\Font\FontManager This class is responsible for managing font metrics.$fontMetrics null the collection containing the FontMetrics \Utils\Font\ArrayObject $fontMetricService null the FontMetricService that is in use to get FontMetrics out of TextStyles \Utils\Font\FontMetricServices\FontMetricService$fontMetricsFileName 'fontMetrics.ser' the file name where FontMetrics are cached string __construct This method acts as the constructor of the class, \Utils\Font\FontMetricServices\FontMetricService $fontMetricService null FontMetricService initializeFontMetrics This method initialises the internal FontMetrics data structure, i.e. loading FontMetrics from the cache, if a cache file exists. boolean createFontMetric This method creates a FontMetric for a given TextStyle on behalf of the used FontMetricService. \Utils\Graphics2D\Shapes\Styles\TextStyle$textStyle TextStyle getFontMetricsPath This method returns the full path to the file where FontMetrics are cached persistently. string addFontMetric This method adds a FontMetric to the FontManager. \Utils\Font\FontMetric $metric FontMetric getFontMetric This method returns the FontMetric for a given TextStyle. <p>If the FontMetric for the given TextStyle is not yet created, the FontMetricService is being called, to first create it.</p> \Utils\Graphics2D\Shapes\Styles\TextStyle \Utils\Font\FontMetric$textStyle TextStyle No DocBlock was found for File \src\Utils\Font\FontMetric.inc Utils\Graphics2D\Shapes\Styles\TextStyle FontMetric \Utils\Font\FontMetric 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. $textStyle null the TextStyle the FontMetric is based on \Utils\Graphics2D\Shapes\Styles\TextStyle$metrics null the metrics of the TextStyle, i.e. a mapping from the ASCII code of the TextStyle to the width of the respective character \Utils\Font\ArrayObject __construct This acts as the constructor of the class. \Utils\Graphics2D\Shapes\Styles\TextStyle \int[] $textStyle TextStyle$charMetrics getWidth This method calculates the width of a string in pixel. string int $string getMaxWidth This method calculates the maximal width of a string in a collection of strings. \Traversable int$strings Traversable getHeight This method calculates the height of a string in pixel. string int $string getMaxHeight This method calculates the maximal height of a string in a collection of strings. \Traversable int$strings Traversable getHash This method return a hash of the FontMetric. string splitToLines 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. \Traversable \Utils\Font\ArrayObject $strings Traversable No DocBlock was found for File \src\Utils\Font\FontMetricServices\FontMetricService.inc Utils\Font\FontManager Utils\Graphics2D\Shapes\Styles\TextStyle Utils\File\Directory \Utils\URL\Url FontMetricService \Utils\Font\FontMetricServices\FontMetricService This class represents an abstract front metric service. ASCII_BLANK 32 the ASCII code for the blank, i.e. " "$fontMetricsTemplate 'fontMetrics.tpl' the file name where the template for the font metric HTML file is stored string __construct This method acts as the constructor of the class createHtml This method creates html code which is either opened as static file (@see FontMetricSocketService) or served dynamically (@see FontMetricWebServerService). <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> \Utils\Graphics2D\Shapes\Styles\TextStyle \Utils\URL\Url string $textStyle TextStyle$fontMetricServiceEndpoint Url execute This method executes the respective service. \Utils\Graphics2D\Shapes\Styles\TextStyle \Utils\Font\FontManager $textStyle TextStyle$fontManager FontManager No DocBlock was found for File \src\Utils\Font\FontMetricServices\FontMetricServiceFactory.inc Utils\URL\Url FontMetricServiceFactory \Utils\Font\FontMetricServices\FontMetricServiceFactory This class acts as factory for creating font metric services. createFontMetricService This method creates a FontMetricService. \Utils\URL\Url \Utils\Font\FontMetricServices\FontMetricWebServerService $url Url No DocBlock was found for File \src\Utils\Font\FontMetricServices\FontMetricWebServerService.inc Utils\Font\FontManager Utils\Graphics2D\Shapes\Styles\TextStyle Utils\URL\Url FontMetricWebServerService \Utils\Font\FontMetricServices\FontMetricService \Utils\Font\FontMetricServices\FontMetricWebServerService This font metric service can create font metrics when being invoked directly through the browser.$serviceEndpoint null the service endpoint, which is the target of the callback in the html code, that sends the text style information \Utils\URL\Url __construct This method acts as the constructor of the class. \Utils\URL\Url $url Url execute This method creates HTML and Javascript which is evaluated bz the browser, and then feeds back font metrics to the script. \Utils\Graphics2D\Shapes\Styles\TextStyle \Utils\Font\FontManager$textStyle TextStyle $fontManager FontManager No DocBlock was found for File \src\Utils\Geom\Dimension.inc Dimension \Utils\Geom\Dimension This class encapsulates the width and height of an object in the two-dimensional space, e.g. a rectangle or an ellipse.$width null the width of the dimension int $height null the height of the dimension int __construct This method acts as the constructor of the class. int int$width $height __get This method is a magic getter method for the class. string mixed$memberName resizeBy This method resizes a Dimension by the offset encoded by a Point. \Utils\Geom\Point \Utils\Geom\Dimension $point Point __toString This method returns a string representation of the Dimension. string No DocBlock was found for File \src\Utils\Geom\Point.inc Point \Utils\Geom\Point This class represents a point in the two-dimensional space.$x null the x-coordinate of the point int $y null the y-coordinate of the point int __construct This method acts as the constructor of the class. int int$x $y __get This method is a magic getter method for the class. string mixed$memberName setX This method sets the x-coordinate of the point. int \Utils\Geom\Point $x setY This method sets the y-coordinate of the point. int \Utils\Geom\Point$y moveBy This method moves a point by an offset, given as another Point. \Utils\Geom\Point \Utils\Geom\Point $point Point __toString This method returns a string representation of the Point. string No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\DomDrawingPane.inc Utils\Color\RgbColor Utils\Geom\Dimension DomDrawingPane \Utils\Graphics2D\DrawingPanes\DrawingPane \Utils\Graphics2D\DrawingPanes\DomDrawingPane This class implements an abstract drawing pane for DOM output.$fragment null the DOM document fragment that holds the source code of the export \Utils\Graphics2D\DrawingPanes\DOMDocumentFragment $classNameNode 'rt_node' the name of the CSS class for the node shapes. string$classNameEdge 'rt_edge' the name of the CSS class for the edge shapes. string __construct This method acts as the constructor of the class. \Utils\Geom\Dimension $dimension Dimension clearDocument 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. appendFragment This method appends the fragment to the given parent element. \DOMNode$parentElement DOMNode getClassNameNode This method acts as getter for the CSS class name of the node shapes. string getClassNameEdge This method acts as getter for the CSS class name of the edge shapes. string setClassNameNode This method acts as setter for the CSS class name of the node shapes. string $classNameNode setClassNameEdge This method acts as setter for the CSS class name of the edge shapes. string$classNameEdge toDOMColor This method converts a RGBColor to the DOM representation of the color. \Utils\Graphics2D\DrawingPanes\RGBColor string $color RGBColor No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\DrawingPane.inc No short description for method drawPolyLine Argument$points is missing from the function Docblock No short description for method setStrokeWidth Argument $strokeWidth is missing from the function Docblock No short description for method setStrokeColor Argument$strokeColor is missing from the function Docblock No short description for method setFillColor Argument $fillColor is missing from the function Docblock No short description for method setFontFamily Argument$fontFamily is missing from the function Docblock No short description for method setFontSize Argument $fontSize is missing from the function Docblock No short description for method setFontColor Argument$fontColor is missing from the function Docblock Utils\Color\Color Utils\Geom\Dimension Utils\Geom\Point DrawingPane \Utils\Graphics2D\DrawingPanes\DrawingPane This class implements an abstract drawing pane. \Utils\Graphics2D\DrawingPanes\IDrawingPane $document null the wrapped document mixed$dimension 0 the dimension of the document \Utils\Geom\Dimension $strokeWidth 1 the currect stroke width of the drawing pane int$strokeColor null the current stroke color of the drawing pane \Utils\Color\Color $fillColor null the current fill color of the drawing pane \Utils\Color\Color$fontFamily null the current font family of the drawing pane string $fontSize null the current font size in pixels of the drawing pane int$fontColor null the current font color of the drawing pane \Utils\Color\Color __construct This acts as the constructor of the class. \Utils\Geom\Dimension $dimension Dimension drawPolyLine$points Traversable setStrokeWidth $strokeWidth setStrokeColor$strokeColor Color setFillColor $fillColor Color setFontFamily$fontFamily setFontSize $fontSize setFontColor$fontColor Color No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\GdLibDrawingPane.inc No short description for method drawLine Argument $source is missing from the function Docblock Argument$target is missing from the function Docblock No short description for method drawEllipse Argument $center is missing from the function Docblock Argument$dimension is missing from the function Docblock No short description for method drawRectangle Argument $topLeftCorner is missing from the function Docblock Argument$dimension is missing from the function Docblock No short description for method drawPolygon Argument $points is missing from the function Docblock No short description for method drawText Argument$topLeftCorner is missing from the function Docblock Argument $text is missing from the function Docblock No short description for method save Utils\Color\Color Utils\Color\RgbColor Utils\Geom\Dimension Utils\Geom\Point GdLibDrawingPane \Utils\Graphics2D\DrawingPanes\DrawingPane \Utils\Graphics2D\DrawingPanes\GdLibDrawingPane This class implements a drawing pane for the GD PHP extension.$format null the file format of the document string $useTrueColor FALSE a flag determines whether to use true-color or not boolean$gdColors array() 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 \Utils\Graphics2D\DrawingPanes\int[string] $fontPath null the current path to search for fonts string$DEFAULT_FONT_PATH_WIN 'C:/Windows/Fonts/' the default path to search for fonts on Windows systems string $DEFAULT_FONT_PATH_IX '/usr/share/fonts/' the default path to search for fonts on *IX systems string __construct This method acts as the constructor of the class. \Utils\Geom\Dimension string boolean$dimension Dimension $format$useTrueColor TRUE initializeFontPath This method initializes the font path based on the current operating system. setFontPath This method sets the font path to the given path. string $fontPath createImage This method creates the internal GD library document. void drawLine$source Point $target Point drawEllipse$center Point $dimension Dimension drawFilledArc This method draws a filled arc \Utils\Geom\Point \Utils\Geom\Dimension \Utils\Color\Color \Utils\Graphics2D\DrawingPanes\GdLibDrawingPane$center Point $dimension Dimension$fillColor null Color drawArc This method draws a arc \Utils\Geom\Point \Utils\Geom\Dimension \Utils\Graphics2D\DrawingPanes\GdLibDrawingPane $center Point$dimension Dimension drawRectangle $topLeftCorner Point$dimension Dimension drawPolygon $points Traversable drawText$topLeftCorner Point $text save toGDColor This method converts a RGBColor to a GD color identifier. \Utils\Graphics2D\DrawingPanes\RGBColor int$color RGBColor toGDColorNTC This method converts a RGBColor to a GD non-true-color identifier. \Utils\Graphics2D\DrawingPanes\RGBColor int $color toGDColorTC This method converts a RGBColor to a GD true-color identifier. \Utils\Graphics2D\DrawingPanes\RGBColor int$color No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\HtmlDrawingPane.inc No short description for method drawLine Argument $source is missing from the function Docblock Argument$target is missing from the function Docblock No short description for method drawEllipse Argument $center is missing from the function Docblock Argument$dimension is missing from the function Docblock No DocBlock was found for Method drawRectangle No short description for method drawPolygon Argument $points is missing from the function Docblock No short description for method drawText Argument$topLeftCorner is missing from the function Docblock Argument $text is missing from the function Docblock No short description for method save Utils\Color\Color Utils\Color\RgbColor Utils\Geom\Dimension Utils\Geom\Point HtmlDrawingPane \Utils\Graphics2D\DrawingPanes\DomDrawingPane \Utils\Graphics2D\DrawingPanes\HtmlDrawingPane This class implements a drawing pane for HTML output.$styleClasses array() the collection of used CSS styles \Utils\Graphics2D\DrawingPanes\stdClass[string] $consolidateStyles TRUE the flag to determine, whether or not CSS style information should be consolidated for output or not boolean __construct This method acts as the constructor of the class. \Utils\Geom\Dimension$dimension Dimension drawLine $source Point$target Point drawEllipse $center Point$dimension Dimension drawRectangle $topLeftCorner Point$dimension Dimension drawPolygon $points Traversable drawText$topLeftCorner Point $text save getCssCode This method returns the CSS code for the current document as string. \Utils\Graphics2D\DrawingPanes\type addStyleClass This method adds a style definition to the set of known styles string string$style getBorderWidth This method is a short hand for getting the border width. int getBorderColor This method is a short hand for getting the border color as DOM color string. string getFillColor This method is a short hand for getting the fill color as DOM color string. string No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\HtmlMapDrawingPane.inc No short description for method drawLine Argument $source is missing from the function Docblock Argument$target is missing from the function Docblock No short description for method drawEllipse Argument $center is missing from the function Docblock Argument$dimension is missing from the function Docblock No short description for method drawRectangle Argument $topLeftCorner is missing from the function Docblock Argument$dimension is missing from the function Docblock No short description for method drawPolygon Argument $points is missing from the function Docblock No short description for method drawText Argument$topLeftCorner is missing from the function Docblock Argument $text is missing from the function Docblock No short description for method save Utils\Color\Color Utils\Color\RgbColor Utils\Geom\Dimension Utils\Geom\Point HtmlMapDrawingPane \Utils\Graphics2D\DrawingPanes\DomDrawingPane \Utils\Graphics2D\DrawingPanes\HtmlMapDrawingPane This class implements a drawing pane for HTML map output.$mapName null the name of the HTML map element string __construct This method acts as the constructor for the class. \Utils\Geom\Dimension $dimension Dimension drawLine$source Point $target Point drawEllipse$center Point $dimension Dimension drawRectangle$topLeftCorner Point $dimension Dimension drawPolygon$points Traversable drawText $topLeftCorner Point$text save No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\IDrawingPane.inc Utils\Color\Color Utils\Geom\Dimension Utils\Geom\Point IDrawingPane \Utils\Graphics2D\DrawingPanes\IDrawingPane This interface defines a common super type for drawing panes. drawLine This method draws a line on the document. \Utils\Geom\Point \Utils\Geom\Point \Utils\Graphics2D\DrawingPanes\IDrawingPane $source Point$target Point drawPolyLine This method draws a poly line onto the the document. <p>It expects an traversable of points, where each point is represented by a object of the class Point.</p> \Traversable \Utils\Graphics2D\DrawingPanes\IDrawingPane $points Traversable drawEllipse This method draws an ellipse on the document. \Utils\Geom\Point \Utils\Geom\Dimension \Utils\Graphics2D\DrawingPanes\IDrawingPane$center Point $dimension Dimension drawRectangle This method draws a rectangle on the document. \Utils\Geom\Point \Utils\Geom\Dimension \Utils\Graphics2D\DrawingPanes\IDrawingPane$topLeftCorner Point $dimension Dimension drawPolygon This method draws a polygon on the document. \Traversable \Utils\Graphics2D\DrawingPanes\IDrawingPane$points Traversable drawText This method draws text at the given position. \Utils\Geom\Point \Utils\Graphics2D\DrawingPanes\type \Utils\Graphics2D\DrawingPanes\IDrawingPane $topLeftCorner Point$text setStrokeWidth This method sets the stroke width. int \Utils\Graphics2D\DrawingPanes\DrawingPane $strokeWidth setStrokeColor This method sets the stroke color. \Utils\Color\Color \Utils\Graphics2D\DrawingPanes\DrawingPane$strokeColor Color setFillColor This method sets the fill color. \Utils\Color\Color \Utils\Graphics2D\DrawingPanes\DrawingPane $fillColor Color setFontFamily This method sets the font familiy. string \Utils\Graphics2D\DrawingPanes\DrawingPane$fontFamily setFontSize This method sets the font size. int \Utils\Graphics2D\DrawingPanes\DrawingPane $fontSize setFontColor This method sets the font color. \Utils\Color\Color \Utils\Graphics2D\DrawingPanes\DrawingPane$fontColor Color save This method saves this DrawingPane to a string. string No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\ImageDrawingPane.inc Utils\Geom\Dimension ImageDrawingPane \Utils\Graphics2D\DrawingPanes\DrawingPane \Utils\Graphics2D\DrawingPanes\ImageDrawingPane This class implements an abstract drawing pane for binary image output. GIF 'gif' the constant for output as GIF JPG 'jpg' the constant for output as JPG PNG 'png' the constant for output as PNG __construct This method acts as the constructor for the class. \Utils\Geom\Dimension $dimension Dimension No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\ImagickDrawingPane.inc No short description for method drawLine Argument$source is missing from the function Docblock Argument $target is missing from the function Docblock No short description for method drawPolyLine Argument$points is missing from the function Docblock No short description for method drawEllipse Argument $center is missing from the function Docblock Argument$dimension is missing from the function Docblock No short description for method drawRectangle Argument $topLeftCorner is missing from the function Docblock Argument$dimension is missing from the function Docblock No short description for method drawPolygon Argument $points is missing from the function Docblock No short description for method drawText Argument$topLeftCorner is missing from the function Docblock Argument $text is missing from the function Docblock No short description for method save No short description for method setStrokeWidth Argument$strokeWidth is missing from the function Docblock No short description for method setStrokeColor Argument $strokeColor is missing from the function Docblock No short description for method setFillColor Argument$fillColor is missing from the function Docblock Utils\Color\Color Utils\Color\RgbColor Utils\Geom\Dimension Utils\Geom\Point ImagickDrawingPane \Utils\Graphics2D\DrawingPanes\ImageDrawingPane \Utils\Graphics2D\DrawingPanes\ImagickDrawingPane This class implements a drawing pane for Imagick PHP extension. $draw null the drawing pane of the Imagick object \Utils\Graphics2D\DrawingPanes\ImagickDraw$format ImageDrawingPane::PNG the output file type of the visualisation, which is one of ImageDrawingPane::GIF, ImageDrawingPane::JPG, ImageDrawingPane::PNG string __construct This method acts as the constructor for the class. \Utils\Geom\Dimension $dimension Dimension drawLine$source Point $target Point drawPolyLine$points Traversable drawEllipse $center Point$dimension Dimension drawRectangle $topLeftCorner Point$dimension Dimension drawPolygon $points Traversable drawText$topLeftCorner Point $text setFormat This method sets the format in which the visualisation will be exported. string \Utils\Graphics2D\DrawingPanes\ImagickDrawingPane$format save toImagikColor This method converts a color to its Imagik color representation. \Utils\Graphics2D\DrawingPanes\RGBColor string $color RGBColor pointsToArray This method converts a collection of Points into a two-dimenstional array of x- and y-coordinates. <p>The resulting array looks like array[[x => 137, y = 64], [x => 129, y => 12]... , [x => 225, y => 358]]</p> \Traversable \array[]$points Traversable setStrokeWidth $strokeWidth setStrokeColor$strokeColor Color setFillColor $fillColor Color No DocBlock was found for File \src\Utils\Graphics2D\DrawingPanes\SvgDrawingPane.inc No short description for method drawLine Argument$source is missing from the function Docblock Argument $target is missing from the function Docblock No short description for method drawPolyLine Argument$points is missing from the function Docblock No short description for method drawEllipse Argument $center is missing from the function Docblock Argument$dimension is missing from the function Docblock No short description for method drawPolygon Argument $points is missing from the function Docblock No short description for method drawRectangle Argument$topLeftCorner is missing from the function Docblock Argument $dimension is missing from the function Docblock No short description for method drawText Argument$topLeftCorner is missing from the function Docblock Argument $text is missing from the function Docblock No short description for method save Utils\Color\Color Utils\Color\RgbColor Utils\Geom\Dimension Utils\Geom\Point SvgDrawingPane \Utils\Graphics2D\DrawingPanes\DomDrawingPane \Utils\Graphics2D\DrawingPanes\SvgDrawingPane This class implements a drawing pane for SVG output. __construct This method acts as the constructor for the class. \Utils\Geom\Dimension$dimension Dimension drawLine $source Point$target Point drawPolyLine $points Traversable drawEllipse$center Point $dimension Dimension drawPolygon$points Traversable drawRectangle $topLeftCorner Point$dimension Dimension drawText $topLeftCorner Point$text save pointsToString This method converts a collection of Points to a string representation suitable for SVG output of polylines. \Traversable string $points Traversable pointCount This method determines the number of Points in the given collection. \Traversable int$points Traversable getStyleAttribute This method returns the constant SVG style attributes for the shapes. string No DocBlock was found for File \src\Utils\Graphics2D\Shapes\DirectEdge.inc No short description for method draw Argument $document is missing from the function Docblock Utils\Geom\Point Utils\Graphics2D\Shapes\Styles\ShapeStyle Utils\Graphics2D\Shapes\Styles\EdgeStyle Utils\Graphics2D\DrawingPanes\DrawingPane DirectEdge \Utils\Graphics2D\Shapes\Edge \Utils\Graphics2D\Shapes\DirectEdge This class represents a direct edge. __construct This acts as the constructor of the class. \Utils\Graphics2D\Shapes\IShape \ArrayAccess \Utils\Graphics2D\Shapes\Styles\EdgeStyle$source IShape $targets ArrayAccess$edgeStyle EdgeStyle draw $document DrawingPane No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Edge.inc No short description for method getConnectionPoint Argument$orientation is missing from the function Docblock Argument $targetIndex is missing from the function Docblock Utils\Geom\Point Utils\Graphics2D\Shapes\Styles\ShapeStyle Utils\Graphics2D\Shapes\Styles\EdgeStyle Edge \Utils\Graphics2D\Shapes\Shape \Utils\Graphics2D\Shapes\Edge This class represents an abstract edge shape.$source null the source of the edge \Utils\Graphics2D\Shapes\IShape $targets null the collection of targets of the edge \ArrayAccess __construct This acts as the constructor of the class. \Utils\Graphics2D\Shapes\IShape \ArrayAccess \Utils\Graphics2D\Shapes\Styles\EdgeStyle$source IShape $targets ArrayAccess$edgeStyle EdgeStyle getConnectionPoint $orientation$targetIndex null No DocBlock was found for File \src\Utils\Graphics2D\Shapes\EdgeFactory.inc Utils\Geom\Point Utils\Graphics2D\Shapes\Styles\EdgeStyle EdgeFactory \Utils\Graphics2D\Shapes\EdgeFactory This class acts as factory for graphical edge elements. __construct This acts as the constructor of the class. createEdge This method acts as a factory method for Edges. \Utils\Graphics2D\Shapes\Styles\EdgeStyle \Utils\Graphics2D\Shapes\IShape \ArrayAccess \Utils\Graphics2D\Shapes\Edge $edgeStyle EdgeStyle$source IShape $targets ArrayAccess No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Ellipse.inc No short description for method draw Argument$document is missing from the function Docblock No short description for method getConnectionPoint Argument $orientation is missing from the function Docblock Utils\Graphics2D\Shapes\Styles\ShapeStyle Utils\Graphics2D\DrawingPanes\DrawingPane Utils\Geom\Dimension Utils\Geom\Point Ellipse \Utils\Graphics2D\Shapes\Shape \Utils\Graphics2D\Shapes\Ellipse This class represents an ellipse shape.$center null the center of the Ellipse \Utils\Geom\Point $dimension null the dimension of the Ellipse \Utils\Geom\Dimension __construct This acts as the constructor of the class. \Utils\Geom\Point \Utils\Graphics2D\Shapes\Styles\ShapeStyle$center Point $style ShapeStyle draw$document DrawingPane getConnectionPoint $orientation No DocBlock was found for File \src\Utils\Graphics2D\Shapes\IShape.inc IShape \Utils\Graphics2D\Shapes\IShape This interface defines a type for generic shapes. No DocBlock was found for File \src\Utils\Graphics2D\Shapes\PolyEdge.inc No short description for method draw Argument$document is missing from the function Docblock Utils\Geom\Point Utils\Graphics2D\Shapes\Styles\ShapeStyle Utils\Graphics2D\Shapes\Styles\EdgeStyle Utils\Graphics2D\DrawingPanes\DrawingPane PolyEdge \Utils\Graphics2D\Shapes\Edge \Utils\Graphics2D\Shapes\PolyEdge This class represents a poly-edge shape. __construct This acts as the constructor of the class. \Utils\Graphics2D\Shapes\IShape \ArrayAccess \Utils\Graphics2D\Shapes\Styles\EdgeStyle $source IShape$targets ArrayAccess $edgeStyle EdgeStyle draw$document DrawingPane No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Rectangle.inc No short description for method draw Argument $document is missing from the function Docblock No short description for method getConnectionPoint Argument$orientation is missing from the function Docblock Utils\Graphics2D\Shapes\Styles\ShapeStyle Utils\Graphics2D\DrawingPanes\DrawingPane Utils\Geom\Dimension Utils\Geom\Point Rectangle \Utils\Graphics2D\Shapes\Shape \Utils\Graphics2D\Shapes\Rectangle This class represents a rectangle shape. $topLeftCorner null the top-left corner of the Rectangle \Utils\Geom\Point$dimension null the dimension of the Rectangle \Utils\Geom\Dimension __construct This acts as the constructor of the class. \Utils\Geom\Point \Utils\Graphics2D\Shapes\Styles\ShapeStyle $topLeftCorner Point$style ShapeStyle draw $document DrawingPane getConnectionPoint$orientation No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Shape.inc Utils\Graphics2D\Shapes\Styles\IStyle Utils\Graphics2D\DrawingPanes\DrawingPane Shape \Utils\Graphics2D\Shapes\Shape This class represents an abstract shape. \Utils\Graphics2D\Shapes\IShape NORTH 0 the identifier for a connection point facing north SOUTH 1 the identifier for a connection point facing south $style null the style of the shape \Utils\Graphics2D\Shapes\Styles\IStyle __construct This acts as the constructor of the class. \Utils\Graphics2D\Shapes\Styles\IStyle$style IStyle draw This method draws the shape onto the IDrawingPane. \Utils\Graphics2D\DrawingPanes\DrawingPane $drawingPane DrawingPane getConnectionPoint This method returns the connection points of the Shape. int$orientation No DocBlock was found for File \src\Utils\Graphics2D\Shapes\ShapeFactory.inc Utils\Geom\Point Utils\Graphics2D\Shapes\Styles\ShapeStyle ShapeFactory \Utils\Graphics2D\Shapes\ShapeFactory This class acts as factory for graphical shape elements. __construct This acts as the constructor of the class. createShape This method acts as factory method for Shapes. \Utils\Graphics2D\Shapes\Styles\ShapeStyle \Utils\Geom\Point \Utils\Graphics2D\Shapes\Shape $shapeStyle ShapeStyle$topLeftCorner Point if $lengthHeight was picked as length, this is wrong! No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Star.inc No short description for method draw Argument$document is missing from the function Docblock No short description for method getConnectionPoint Argument $orientation is missing from the function Docblock Utils\Graphics2D\Shapes\Styles\ShapeStyle Utils\Graphics2D\DrawingPanes\DrawingPane Utils\Geom\Dimension Utils\Geom\Point Star \Utils\Graphics2D\Shapes\Shape \Utils\Graphics2D\Shapes\Star This class represents a star shape.$INNER_ANGLE 72 the angle between two adjacent points of the pentagon, measured in the center of the pentagon double $DIAGONAL_TO_LENGTH 0.6180339887/*4989484820458683436569*/ factor to get the side length of the pentagram from the diagonal of the pentagram double$HEIGHT_TO_LENGTH 0.6498393924/*6581265231174282443046*/ factor to get the side length of the pentagram from the height of the pentagram double $LENGTH_TO_OUTTER_RADIUS 1.1755705045/*849462583374119092781*/ factor to get the radius of the circumcircle of the outter pentagram from the side length of the pentagram double$DIAGONAL_TO_INNER_RADIUS 0.2008114158/*8622727986979767263375*/ factor to get the radius of the circumcircle of the inner pentagon from the diagonal of the outter pentagram double $center null the center of the Star \Utils\Geom\Point __construct This acts as the constructor of the class. \Utils\Geom\Point \Utils\Graphics2D\Shapes\Styles\ShapeStyle$center Point $style ShapeStyle draw$document DrawingPane getPoints This method gets the points to draw a 5-star. int int \ArrayObject $width$height getConnectionPoint $orientation No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\BorderStyle.inc Utils\Color\Color BorderStyle \Utils\Graphics2D\Shapes\Styles\LineStyle \Utils\Graphics2D\Shapes\Styles\BorderStyle This class implements a style for borders. __construct This acts as the constructor of the class. int \Utils\Color\Color$width 1 $color null Color No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\EdgeStyle.inc Utils\Color\Color EdgeStyle \Utils\Graphics2D\Shapes\Styles\LineStyle \Utils\Graphics2D\Shapes\Styles\EdgeStyle This class implements a style for edges. DIRECT_EDGE 0 the identifier for a direct edge, i.e. a direct line from source to target POLY_EDGE 1 the identifier for a poly edge, i.e. a connection from source to target via horizonal or vertical lines only$type self::POLY_EDGE the type of this edge, either self::DIRECT_EDGE or self::POLY_EDGE int __construct This acts as the constructor of the class. int \Utils\Color\Color int $width 1$color null Color $type self::POLY_EDGE No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\IStyle.inc IStyle \Utils\Graphics2D\Shapes\Styles\IStyle This interface defines a type for styles. No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\LineStyle.inc Utils\Color\Color Utils\Color\RgbColor LineStyle \Utils\Graphics2D\Shapes\Styles\LineStyle This class implements an abstract style for lines. \Utils\Graphics2D\Shapes\Styles\IStyle$width null the width of the line int $color null the color of the line \Utils\Graphics2D\Shapes\Styles\RGBColor __construct This acts as the constructor of the class. int \Utils\Color\Color$width 1 $color null Color __get This method is a magic getter method for the class. string mixed$memberName setWidth This method is a setter for the width of the line style. int $width setColor This method is a setter for the color of the line style. \Utils\Color\Color$color Color No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\ShapeStyle.inc Utils\Color\Color Utils\Color\RgbColor ShapeStyle \Utils\Graphics2D\Shapes\Styles\ShapeStyle This class implements a style for shapes. \Utils\Graphics2D\Shapes\Styles\IStyle RECTANGLE 0 the shape identifier for a rectangle ELLIPSE 1 the shape identifier for an ellipse STAR 2 the shape identifier for a star $type null the type of shape int$width null the width of the shape int $height null the height of the shape int$color null the color of the shape \Utils\Color\Color $border null the border of the shape \Utils\Graphics2D\Shapes\Styles\BorderStyle __construct This acts as the constructor of the class. int int int \Utils\Color\Color \Utils\Graphics2D\Shapes\Styles\BorderStyle$type self::RECTANGLE $width 22$height 10 $color null Color$border null BorderStyle __get This method is a magic getter method for the class. string mixed $memberName setWidth This method is a setter for the width of the shape style. int$width setHeight This method is a setter for the height of the shape style. int $height setColor This method is a setter for the color of the shape style. \Utils\Color\Color$color Color No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Styles\TextStyle.inc Utils\Color\Color Utils\Color\RgbColor TextStyle \Utils\Graphics2D\Shapes\Styles\TextStyle This class implements a style for texts. \Utils\Graphics2D\Shapes\Styles\IStyle LINE_PADDING 3 constant additional padding for calculating the line height with a given font size (always plus 3) $family 'Times' the name of the font family string$size '12' the font size in pixel int $color null the font color \Utils\Color\Color __construct This acts as the constructor of the class. string int \Utils\Color\Color$family 'Times' $size 12$color null Color __get This method is a magic getter method for the class. string mixed $memberName __set This method is a magic setter method for the class. string mixed$memberName $value getLineHeight This method returns the line height for this TextStyle. int pixelToPoint This method converts from pixel to points unit. int float$pixel __toString This method returns a string representation of the text style. string toCssClass This method converts this TextStyle into a CSS class definition, with the given class name. string string $className getHash This method returns a "hash" of this TextStyle. string No DocBlock was found for File \src\Utils\Graphics2D\Shapes\Text.inc Name of argument$style does not match with function Docblock Name of argument $text does not match with function Docblock No short description for method draw Argument$drawingPane is missing from the function Docblock No short description for method getConnectionPoint Argument $orientation is missing from the function Docblock Utils\Graphics2D\Shapes\Styles\TextStyle Utils\Graphics2D\DrawingPanes\DrawingPane Utils\Geom\Point Text \Utils\Graphics2D\Shapes\Shape \Utils\Graphics2D\Shapes\Text This class represents a text shape.$topLeftCorner null the top-left corner of the Text \Utils\Geom\Point $text null the actual text of the Text string __construct This acts as the constructor of the class. \Utils\Geom\Point \Utils\Graphics2D\Shapes\Styles\TextStyle string$topLeftCorner Point $style TextStyle$text draw $drawingPane DrawingPane getConnectionPoint$orientation No DocBlock was found for File \src\Utils\Graphics2D\Shapes\TextFactory.inc Utils\Graphics2D\Shapes\Text Utils\Graphics2D\Shapes\Styles\TextStyle Utils\Geom\Point ReingoldTilford\Models\ITreeModel TextFactory \Utils\Graphics2D\Shapes\TextFactory This class acts as factory for graphical text elements. __construct This acts as the constructor of the class. createText This method creates a text. \Utils\Graphics2D\Shapes\Styles\TextStyle \Utils\Geom\Point string \Utils\Graphics2D\Shapes\Text $textStyle TextStyle$topLeftCorner Point $text No DocBlock was found for File \src\Utils\Logging\FileLogger.inc FileLogger \Utils\Logging\Logger \Utils\Logging\FileLogger This class acts as a logger which prints to a file.$target 'log.txt' the target of the file logger string setLogFilename This method sets the file name of the log file to use.S string $filename No DocBlock was found for File \src\Utils\Logging\Logger.inc Logger \Utils\Logging\Logger This class acts as a logger which prints to the standard output. ALL -1 the identifier for the log level ALL OFF 0 the identifier for the log level OFF INFO 1 the identifier for the log level INFO WARNING 2 the identifier for the log level WARNING ERROR 4 the identifier for the log level ERROR DEBUG 8 the identifier for the log level DEBUG$CURRENT_SEVERITY 15 the current log level of the logger int $target 'php://stdout' the target of the logging output string log This method logs the given message to the respective target, if the currrent severity includes the passed severity. int string$severity $message setLogLevel This method sets the log level of the logger. int$severity isSevere This method decides whether or not the passed severity is included in the current severity of the logger. int boolean $severity No DocBlock was found for File \src\Utils\URL\Url.inc Url \Utils\URL\Url This class is a simple wrapper for an URL.$protocol null the protocol of the URL string $host null the host address of the URL, e.g. a fully qualified name, or an IP address string$path null the path component of the URL string $port null the number port of the URL int __construct This method acts as the constructor of the class. string string string int$protocol $host$path $port null getProtocol This method return the protocol of the URL. string getHost This method return the host address of the URL. string getPath This method return the path component of the URL. string getPort This method return the port number of the URL. int setPath This method sets the path of the URL. string \Utils\URL\Url$path __toString This method returns a string representation of the Url. string createCurrentUrlFromServerInfo This method creates and returns an URL that is represented in the PHP \$_SERVER super global. \Utils\URL\Url todo fixme