CWIS Developer Documentation
Public Member Functions | List of all members
VocabularyFactory Class Reference

Factory for manipulating Vocabulary objects. More...

Public Member Functions

 VocabularyFactory ($Path)
 object constructor More...
 
 GetVocabularies ()
 load vocabulary objects from files More...
 
 GetVocabularyByHash ($Hash)
 retrieve vocabulary object based on hash string More...
 

Detailed Description

Factory for manipulating Vocabulary objects.

Definition at line 13 of file VocabularyFactory.php.

Member Function Documentation

VocabularyFactory::GetVocabularies ( )

load vocabulary objects from files

Returns
Array of Vocabulary objects.
Note
Vocabularies are returned sorted by name.

Definition at line 31 of file VocabularyFactory.php.

VocabularyFactory::GetVocabularyByHash (   $Hash)

retrieve vocabulary object based on hash string

Parameters
$HashHash string for Vocabulary (returned by Hash() method).
Returns
Vocabulary object corresponding to hash, or NULL if no matching vocabulary found.

Definition at line 59 of file VocabularyFactory.php.

References Vocabulary\HashForFile().

VocabularyFactory::VocabularyFactory (   $Path)

object constructor

Parameters
$Pathpath to directory containing .voc controlled vocabulary files

Definition at line 21 of file VocabularyFactory.php.


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