Search:

# CWIS Developers Documentation

Public Member Functions

# VocabularyFactory Class Reference

Factory for manipulating Vocabulary objects. More...

## Public Member Functions
| VocabularyFactory ($Path)
| object constructor
| GetVocabularies ()
| load vocabulary objects from files
| GetVocabularyByHash ($Hash)
| retrieve vocabulary object based on hash string

List of all members.

## Detailed Description

Factory for manipulating Vocabulary objects.

Definition at line 14 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 32 of file VocabularyFactory.php.

VocabularyFactory::GetVocabularyByHash | ( | $ | Hash ) |

retrieve vocabulary object based on hash string

Parameters:

  Hash | Hash string for Vocabulary (returned by Hash() method).

Returns:
  Vocabulary object corresponding to hash, or NULL if no matching vocabulary found.

Definition at line 60 of file VocabularyFactory.php.

References Vocabulary::HashForFile().

VocabularyFactory::VocabularyFactory | ( | $ | Path ) |

object constructor

Parameters:

  Path | path to directory containing .voc controlled vocabulary files

Definition at line 22 of file VocabularyFactory.php.

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

- VocabularyFactory.php