Public Member Functions
	__construct ()
	_connectTo (&$destinationNode)
	connectsTo (&$target)
	connectTo (&$destinationNode)
&	getData ()
&	getGraph ()
&	getMetadata ($key, $nullIfNonexistent=false)
	getNeighbours ()
	inDegree ()
	metadataKeyExists ($key)
	outDegree ()
	setData (&$data)
	setGraph (&$graph)
	setMetadata ($key, &$data)
	unsetMetadata ($key)

Data Fields
	$_arcs = array()
	$_data = null
	$_graph = null
	$_metadata = array()

Detailed Description

Definition at line 57 of file Node.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Constructor

@access public

Definition at line 78 of file Node.php.

78 {

79 }

Member Function Documentation

◆ _connectTo()

_connectTo ( & $destinationNode )

@access private

Definition at line 223 of file Node.php.

                                           {
        $this->_arcs[] =& $destinationNode;
    }

Referenced by connectTo().

Here is the caller graph for this function:

◆ connectsTo()

connectsTo ( & $target )

Test wether this node has an arc to the target node

Returns: boolean True if the two nodes are connected @access public

Definition at line 274 of file Node.php.

                                  {
        if (version_compare(PHP_VERSION, '5.0.0') >= 0) {
            return in_array($target, $this->getNeighbours(), true);
        }
 
        $copy = $target;
        $arcKeys = array_keys($this->_arcs);
        foreach($arcKeys as $key) {
            /* ZE1 chokes on this expression:
                if ($target === $arc) return true;
              so, we'll use more convoluted stuff
            */
            $arc =& $this->_arcs[$key];
            $target = true;
            if ($arc === true) {
                $target = false;
                if ($arc === false) {
                    $target = $copy;
                    return true;
                }
            }
        }
        $target = $copy;
        return false;
    }

References getNeighbours().

Referenced by inDegree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ connectTo()

connectTo ( & $destinationNode )

Connect this node to another one.

If the graph is not directed, the reverse arc, connecting $destinationNode to $this is also created.

Parameters

Structures_Graph_Node Node to connect to @access public

Definition at line 238 of file Node.php.

                                          {
        // We only connect to nodes
        if (!is_a($destinationNode, 'Structures_Graph_Node')) return Pear::raiseError('Structures_Graph_Node::connectTo received an object that is not a Structures_Graph_Node', STRUCTURES_GRAPH_ERROR_GENERIC);
        // Nodes must already be in graphs to be connected
        if ($this->_graph == null) return Pear::raiseError('Structures_Graph_Node::connectTo Tried to connect a node that is not in a graph', STRUCTURES_GRAPH_ERROR_GENERIC);
        if ($destinationNode->getGraph() == null) return Pear::raiseError('Structures_Graph_Node::connectTo Tried to connect to a node that is not in a graph', STRUCTURES_GRAPH_ERROR_GENERIC);
        // Connect here
        $this->_connectTo($destinationNode);
        // If graph is undirected, connect back
        if (!$this->_graph->isDirected()) {
            $destinationNode->_connectTo($this);
        }
    }

References _connectTo(), and STRUCTURES_GRAPH_ERROR_GENERIC.

Here is the call graph for this function:

◆ getData()

& getData ( )

Node data getter.

Each graph node can contain a reference to one variable. This is the getter for that reference.

Returns: mixed Data stored in node @access public

Definition at line 119 of file Node.php.

                        {
        return $this->_data;
    }

References $_data.

◆ getGraph()

& getGraph ( )

Node graph getter

Returns: Structures_Graph Graph where node is stored @access public

Definition at line 90 of file Node.php.

                         {
        return $this->_graph;
    }

References $_graph.

◆ getMetadata()

& getMetadata	(		$key,
			$nullIfNonexistent = false )

Node metadata getter

Each graph node can contain multiple 'metadata' entries, each stored under a different key, as in an associative array or in a dictionary. This method gets the data under the given key. If the key does not exist, an error will be thrown, so testing using metadataKeyExists might be needed.

Parameters

string	Key
boolean	nullIfNonexistent (defaults to false).

Returns: mixed Metadata Data stored in node under given key

See also: metadataKeyExists @access public

Definition at line 171 of file Node.php.

                                                          {
        if (array_key_exists($key, $this->_metadata)) {
            return $this->_metadata[$key];
        } else {
            if ($nullIfNonexistent) {
                $a = null;
                return $a;
            } else {
                $a = Pear::raiseError('Structures_Graph_Node::getMetadata: Requested key does not exist', STRUCTURES_GRAPH_ERROR_GENERIC);
                return $a;
            }
        }
    }

References STRUCTURES_GRAPH_ERROR_GENERIC.

◆ getNeighbours()

getNeighbours ( )

Return nodes connected to this one.

Returns: array Array of nodes @access public

Definition at line 261 of file Node.php.

                             {
        return $this->_arcs;
    }

References $_arcs.

Referenced by connectsTo().

Here is the caller graph for this function:

◆ inDegree()

inDegree ( )

Calculate the in degree of the node.

The indegree for a node is the number of arcs entering the node. For non directed graphs, the indegree is equal to the outdegree.

Returns: integer In degree of the node @access public

Definition at line 312 of file Node.php.

                        {
        if ($this->_graph == null) return 0;
        if (!$this->_graph->isDirected()) return $this->outDegree();
        $result = 0;
        $graphNodes =& $this->_graph->getNodes();
        foreach (array_keys($graphNodes) as $key) {
            if ($graphNodes[$key]->connectsTo($this)) $result++;
        }
        return $result;
        
    }

References $result, connectsTo(), and outDegree().

Here is the call graph for this function:

◆ metadataKeyExists()

metadataKeyExists ( $key )

Test for existence of metadata under a given key.

Each graph node can contain multiple 'metadata' entries, each stored under a different key, as in an associative array or in a dictionary. This method tests whether a given metadata key exists for this node.

Parameters

string Key to test

Returns: boolean
@access public

Definition at line 151 of file Node.php.

                                     {
        return array_key_exists($key, $this->_metadata);
    }

◆ outDegree()

outDegree ( )

Calculate the out degree of the node.

The outdegree for a node is the number of arcs exiting the node. For non directed graphs, the outdegree is always equal to the indegree.

Returns: integer Out degree of the node @access public

Definition at line 336 of file Node.php.

                         {
        if ($this->_graph == null) return 0;
        return sizeof($this->_arcs);
    }

References $_arcs.

Referenced by inDegree().

Here is the caller graph for this function:

◆ setData()

setData ( & $data )

Node data setter

Each graph node can contain a reference to one variable. This is the setter for that reference.

Returns: mixed Data to store in node @access public

Definition at line 134 of file Node.php.

                             {
        $this->_data =& $data;
    }

Referenced by PEAR_Downloader\sortPackagesForInstall().

Here is the caller graph for this function:

◆ setGraph()

setGraph ( & $graph )

Node graph setter. This method should not be called directly. Use Graph::addNode instead.

Parameters

Structures_Graph Set the graph for this node.

See also: Structures_Graph::addNode() @access public

Definition at line 104 of file Node.php.

                               {
        $this->_graph =& $graph;
    }

◆ setMetadata()

setMetadata	(		$key,
		&	$data )

Node metadata setter

Each graph node can contain multiple 'metadata' entries, each stored under a different key, as in an associative array or in a dictionary. This method stores data under the given key. If the key already exists, previously stored data is discarded.

Parameters

string	Key
mixed	Data @access public

Definition at line 216 of file Node.php.

                                       {
        $this->_metadata[$key] =& $data;
    }

◆ unsetMetadata()

unsetMetadata ( $key )

Delete metadata by key

Each graph node can contain multiple 'metadata' entries, each stored under a different key, as in an associative array or in a dictionary. This method removes any data that might be stored under the provided key. If the key does not exist, no error is thrown, so it is safe using this method without testing for key existence.

Parameters

string Key @access public

Definition at line 198 of file Node.php.

                                 {
        if (array_key_exists($key, $this->_metadata)) unset($this->_metadata[$key]);
    }

Field Documentation

◆ $_arcs

$_arcs = array()

@access private

Definition at line 66 of file Node.php.

Referenced by getNeighbours(), and outDegree().

◆ $_data

$_data = null

@access private

Definition at line 62 of file Node.php.

Referenced by getData().

◆ $_graph

$_graph = null

@access private

Definition at line 68 of file Node.php.

Referenced by getGraph().

◆ $_metadata

$_metadata = array()

@access private

Definition at line 64 of file Node.php.

The documentation for this class was generated from the following file:

E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/Structures/Graph/Node.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _connectTo()

◆ connectsTo()

◆ connectTo()

◆ getData()

◆ getGraph()

◆ getMetadata()

◆ getNeighbours()

◆ inDegree()

◆ metadataKeyExists()

◆ outDegree()

◆ setData()

◆ setGraph()

◆ setMetadata()

◆ unsetMetadata()

Field Documentation

◆ $_arcs

◆ $_data

◆ $_graph

◆ $_metadata