Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • GraphNode
  • TreeGraph

Class TreeGraph

Maintains the geometry for a tree graph.

Namespace: Alpha\Util\Graph
Copyright:

Copyright (c) 2018, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at Util/Graph/TreeGraph.php

Methods summary

public
# __construct( integer $rowSpace = 40, integer $colSpace = 40, integer $branchSpace = 80 )

Constructor.

Constructor.

Parameters

$rowSpace
$colSpace
$branchSpace

Since

1.0
public
# add( integer $id, integer $pid, string $message, integer $w, integer $h, array $nodeColour, string $URL )

Add a new node to the graph.

Add a new node to the graph.

Parameters

$id
$pid
$message
$w
$h
$nodeColour
$URL

Since

1.0
public Alpha\Util\Graph\GraphNode
# get( integer $id )

Get the specified node from the graph.

Get the specified node from the graph.

Parameters

$id

Returns

Alpha\Util\Graph\GraphNode

Since

2.0.1
protected
# render( )

Render the chart in memory.

Render the chart in memory.

Since

1.0
public
# getWidth( )

Get the width of the graph, will invoke render() if not already rendered.

Get the width of the graph, will invoke render() if not already rendered.

Since

1.0
public
# getHeight( )

Get the heith of the graph, will invoke render() if not already rendered.

Get the heith of the graph, will invoke render() if not already rendered.

Since

1.0
public Alpha\Util\Graph\GraphNode
# next( )

Get the next GraphNode instance in the graph, will invoke render() if not already rendered.

Get the next GraphNode instance in the graph, will invoke render() if not already rendered.

Returns

Alpha\Util\Graph\GraphNode

Since

1.0
public boolean
# hasNext( )

Check to see if another GraphNode instance in the graph is available.

Check to see if another GraphNode instance in the graph is available.

Returns

boolean

Since

1.0
Alpha Framework 3.0.0 API Documentation API documentation generated by ApiGen