CWIS Developer Documentation
|
Controlled vocabulary. More...
Public Member Functions | |
__construct ($FileName) | |
Object constructor. More... | |
Status () | |
Get string indicate status of last action. More... | |
Hash () | |
Get hash string for vocabulary (generated from file name). More... | |
Name () | |
Get vocabulary name. More... | |
Description () | |
Get vocabulary description. More... | |
Url () | |
Get URL attached to vocabulary. More... | |
Version () | |
Get version number for vocabulary. More... | |
HasQualifier () | |
Get whether vocabulary has associated qualifier. More... | |
QualifierName () | |
Get qualifier name. More... | |
QualifierNamespace () | |
Get qualifier namespace. More... | |
QualifierUrl () | |
Get qualifier URL. More... | |
OwnerName () | |
Get name of owning (maintaining) organization. More... | |
OwnerUrl () | |
Get primary URL for owning (maintaining) organization. More... | |
TermArray () | |
Get vocabulary terms as multi-dimensional array. More... | |
TermList () | |
Get vocabulary terms as flat array with double-dash separators. More... | |
Static Public Member Functions | |
static | HashForFile ($FileName=NULL) |
Get hash string for specified vocabulary file name. More... | |
static | FileSearchPaths ($NewValue=NULL) |
Get/set the list of paths where vocabulary files will be searched for. More... | |
Controlled vocabulary.
Definition at line 13 of file Vocabulary.php.
Vocabulary::__construct | ( | $FileName | ) |
Object constructor.
string | $FileName | Name of .voc file containing vocabulary to load. |
Definition at line 22 of file Vocabulary.php.
Vocabulary::Description | ( | ) |
Get vocabulary description.
Definition at line 90 of file Vocabulary.php.
|
static |
Get/set the list of paths where vocabulary files will be searched for.
array | $NewValue | Array of paths to search (OPTIONAL) |
Definition at line 205 of file Vocabulary.php.
Vocabulary::Hash | ( | ) |
Get hash string for vocabulary (generated from file name).
Definition at line 62 of file Vocabulary.php.
|
static |
Get hash string for specified vocabulary file name.
string | $FileName | Name of .voc file containing vocabulary. |
Definition at line 72 of file Vocabulary.php.
Referenced by VocabularyFactory\GetVocabularyByHash().
Vocabulary::HasQualifier | ( | ) |
Get whether vocabulary has associated qualifier.
Definition at line 117 of file Vocabulary.php.
References QualifierName(), QualifierNamespace(), and QualifierUrl().
Vocabulary::Name | ( | ) |
Vocabulary::OwnerName | ( | ) |
Get name of owning (maintaining) organization.
Definition at line 161 of file Vocabulary.php.
Vocabulary::OwnerUrl | ( | ) |
Get primary URL for owning (maintaining) organization.
Definition at line 171 of file Vocabulary.php.
Vocabulary::QualifierName | ( | ) |
Get qualifier name.
Definition at line 129 of file Vocabulary.php.
Referenced by HasQualifier().
Vocabulary::QualifierNamespace | ( | ) |
Get qualifier namespace.
Definition at line 140 of file Vocabulary.php.
Referenced by HasQualifier().
Vocabulary::QualifierUrl | ( | ) |
Get qualifier URL.
Definition at line 151 of file Vocabulary.php.
Referenced by HasQualifier().
Vocabulary::Status | ( | ) |
Get string indicate status of last action.
Definition at line 53 of file Vocabulary.php.
Vocabulary::TermArray | ( | ) |
Get vocabulary terms as multi-dimensional array.
Definition at line 181 of file Vocabulary.php.
Referenced by TermList().
Vocabulary::TermList | ( | ) |
Get vocabulary terms as flat array with double-dash separators.
Definition at line 193 of file Vocabulary.php.
References TermArray().
Vocabulary::Url | ( | ) |
Get URL attached to vocabulary.
Definition at line 99 of file Vocabulary.php.
Vocabulary::Version | ( | ) |
Get version number for vocabulary.
Definition at line 108 of file Vocabulary.php.