PropertyHierarchy Class Reference

The property hierarchy of the system. More...

List of all members.

Public Member Functions

 __construct ($rootProperty)
 Constructor.
 __destruct ()
 addPropertyRelationship ($property, $subPropertyOf)
 Add a property to the property hierarchy.
 getSuperProperties ($property)
 Returns a list of references to the superproperties.
 getSubproperties ($property)
 Returns a list of references to the subproperties.
 isSubPropertyOf ($subproperty, $superProperty)
 Check if a class if a sub-property of another property.

Public Attributes

 $properties = array()
 PropertyNode(s) that define the class structure.


Detailed Description

The property hierarchy of the system.

This property structure is used by multiple modules to leverage the properties structure of a node. It is used to get the super-properties-of, sub-properties-of, labels and descriptions of properties.


Todo:
Load this structure from the database system instead of the file system (using include_once).
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 28 of file PropertyHierarchy.php.


Constructor & Destructor Documentation

PropertyHierarchy::__construct ( rootProperty  ) 

Constructor.


Parameters:
[in] $rootProperty Root property of the property hierarchy.
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 43 of file PropertyHierarchy.php.

PropertyHierarchy::__destruct (  ) 

Definition at line 45 of file PropertyHierarchy.php.


Member Function Documentation

PropertyHierarchy::addPropertyRelationship ( property,
subPropertyOf 
)

Add a property to the property hierarchy.


Parameters:
[in] $property URI of the property to add to the hierarchy
[in] $subPropertyOf URI of the super-property of the property being added.
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 58 of file PropertyHierarchy.php.

PropertyHierarchy::getSubproperties ( property  ) 

Returns a list of references to the subproperties.


Parameters:
[in] $property URI of the property to get its sub-properties references
Returns:
returns a list of references to the subproperties
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 199 of file PropertyHierarchy.php.

PropertyHierarchy::getSuperProperties ( property  ) 

Returns a list of references to the superproperties.


Parameters:
[in] $property URI of the property to get its super-properties references
Returns:
returns a list of references to the superproperties
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 149 of file PropertyHierarchy.php.

PropertyHierarchy::isSubPropertyOf ( subproperty,
superProperty 
)

Check if a class if a sub-property of another property.


Parameters:
[in] $subproperty URI of the property to check if it is a sub-property of another property
[in] $superProperty URI of the super property of the property
Returns:
returns TRUE if the property is a sub-property of the super-property; FALSE otherwise
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 250 of file PropertyHierarchy.php.


Member Data Documentation

PropertyHierarchy::$properties = array()

PropertyNode(s) that define the class structure.

Definition at line 31 of file PropertyHierarchy.php.


The documentation for this class was generated from the following file:
Copyright © 2009. Structured Dynamics LLC Structured Dynamics LLC. All rights reserved.