Vocabulary Class Reference

controlled vocabulary More...


Public Member Functions

 Vocabulary ($FileName)
 constructor
 Status ()
 return string indicate status of last action
 Hash ($FileName=NULL)
 return hash string for vocabulary (generated from file name)
 Name ()
 return vocabulary name
 Description ()
 return vocabulary description
 Url ()
 return URL attached to vocabulary
 Version ()
 return version number for vocabulary
 HasQualifier ()
 indicate whether vocabulary has associated qualifier
 QualifierName ()
 return qualifier name
 QualifierNamespace ()
 return qualifier namespace
 QualifierUrl ()
 return qualifier URL
 TermArray ()
 retrieve vocabulary terms as multi-dimensional array
 TermList ()
 retrieve vocabulary terms as flat array with double-dash separators
 XmlVal ($ValueName)
 ExtractTermSet ($Tree)
 BuildTermList ($Prefix, $TermTree)

Public Attributes

 $FileName
 $StatusString
 $Xml

List of all members.


Detailed Description

controlled vocabulary

Definition at line 22 of file Vocabulary.php.


Member Function Documentation

Vocabulary::BuildTermList ( Prefix,
TermTree 
)

Definition at line 169 of file Vocabulary.php.

Referenced by TermList().

Here is the caller graph for this function:

Vocabulary::Description (  ) 

return vocabulary description

Definition at line 69 of file Vocabulary.php.

References XmlVal().

Vocabulary::ExtractTermSet ( Tree  ) 

Definition at line 151 of file Vocabulary.php.

Referenced by TermArray().

Here is the caller graph for this function:

Vocabulary::Hash ( FileName = NULL  ) 

return hash string for vocabulary (generated from file name)

Parameters:
FileName Name of .voc file containing vocabulary (for static calls).
Returns:
32-character hash string.
Note:
Make be called statically by supplying file name.

Definition at line 55 of file Vocabulary.php.

References $FileName.

Referenced by VocabularyFactory::GetVocabularyByHash().

Here is the caller graph for this function:

Vocabulary::HasQualifier (  ) 

indicate whether vocabulary has associated qualifier

Definition at line 84 of file Vocabulary.php.

References QualifierName(), QualifierNamespace(), and QualifierUrl().

Vocabulary::Name (  ) 

return vocabulary name

Definition at line 64 of file Vocabulary.php.

References XmlVal().

Vocabulary::QualifierName (  ) 

return qualifier name

Definition at line 94 of file Vocabulary.php.

Referenced by HasQualifier().

Here is the caller graph for this function:

Vocabulary::QualifierNamespace (  ) 

return qualifier namespace

Definition at line 103 of file Vocabulary.php.

Referenced by HasQualifier().

Here is the caller graph for this function:

Vocabulary::QualifierUrl (  ) 

return qualifier URL

Definition at line 112 of file Vocabulary.php.

Referenced by HasQualifier().

Here is the caller graph for this function:

Vocabulary::Status (  ) 

return string indicate status of last action

Definition at line 47 of file Vocabulary.php.

Vocabulary::TermArray (  ) 

retrieve vocabulary terms as multi-dimensional array

Definition at line 121 of file Vocabulary.php.

References ExtractTermSet().

Referenced by TermList().

Here is the caller graph for this function:

Vocabulary::TermList (  ) 

retrieve vocabulary terms as flat array with double-dash separators

Definition at line 132 of file Vocabulary.php.

References BuildTermList(), and TermArray().

Vocabulary::Url (  ) 

return URL attached to vocabulary

Definition at line 74 of file Vocabulary.php.

References XmlVal().

Vocabulary::Version (  ) 

return version number for vocabulary

Definition at line 79 of file Vocabulary.php.

References XmlVal().

Vocabulary::Vocabulary ( FileName  ) 

constructor

Parameters:
FileName Name of .voc file containing vocabulary to load.
Note:
Check Status() to determine if constructor succeeded

Definition at line 31 of file Vocabulary.php.

References $FileName.

Vocabulary::XmlVal ( ValueName  ) 

Definition at line 145 of file Vocabulary.php.

Referenced by Description(), Name(), Url(), and Version().

Here is the caller graph for this function:


Member Data Documentation

Vocabulary::$FileName

Definition at line 141 of file Vocabulary.php.

Referenced by Hash(), and Vocabulary().

Vocabulary::$StatusString

Definition at line 142 of file Vocabulary.php.

Vocabulary::$Xml

Definition at line 143 of file Vocabulary.php.


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