CWIS Developer Documentation
|
Metadata type representing non-hierarchical controlled vocabulary values. More...
Public Member Functions | |
ControlledName ($NameId, $Name=NULL, $FieldId=NULL, $QualifierId="NULL", $VariantName=NULL) | |
Class constructor. More... | |
Status () | |
Check success of constructor. More... | |
Id () | |
Get ID. More... | |
Name ($NewValue=DB_NOVALUE) | |
Get or set the controlled vocabulary term. More... | |
VariantName ($NewValue=DB_NOVALUE) | |
Get or set any variant terms for this controlled name . More... | |
FieldId ($NewValue=DB_NOVALUE) | |
Get or set the MetadataField associated with this term. More... | |
QualifierId ($NewValue=DB_NOVALUE) | |
Get or set the Qualifier associated with this term via ID. More... | |
Variant ($NewValue=DB_NOVALUE) | |
Get or set the controlled name variant. More... | |
Qualifier ($NewValue=DB_NOVALUE) | |
Get or set the Qualifier associated with this term via object. More... | |
InUse () | |
See if ControlledName is currently associated with any Resources. More... | |
GetAssociatedResources () | |
Get resourceIds associated with this ControlledName. More... | |
RemapTo ($NewNameId) | |
Change all currently associated Resources to be instead associated with another ControlledName. More... | |
UpdateLastAssigned () | |
Update the LastAssigned timestamp for this classification. More... | |
Delete ($DeleteIfHasResources=FALSE) | |
Remove ControlledName (and any accompanying associations from database. More... | |
Static Public Member Functions | |
static | SearchForControlledName ($ControlledName, $FieldId) |
Check if the given controlled name already exists for a given field ID. More... | |
Public Attributes | |
Status Codes (set by constructor and retrieved via Status()) | |
const | STATUS_OK = 0 |
Successful execution. More... | |
const | STATUS_INVALID_ID = 1 |
No ControlledName exists with specified ID. More... | |
const | STATUS_EXISTS = 2 |
ControlledName already exists with this term. More... | |
Metadata type representing non-hierarchical controlled vocabulary values.
Hierarchical controlled vocabularies should use Classification.
Definition at line 14 of file ControlledName.php.
ControlledName::ControlledName | ( | $NameId, | |
$Name = NULL , |
|||
$FieldId = NULL , |
|||
$QualifierId = "NULL" , |
|||
$VariantName = NULL |
|||
) |
Class constructor.
This can be used both to access an existing controlled vocabulary term or to add a new term. For existing terms pass in just the ControlledName ID. To create a new term pass in NULL for the ID, and specify the term, the metadata field ID, and the qualifier ID (if any) and variant name (if any).
int | $NameId | ControlledName ID (NULL if creating new). |
string | $Name | New controlled vocabulary term. (OPTIONAL) |
int | $FieldId | ID of MetadataField for new term. (OPTIONAL) |
int | $QualifierId | ID of Qualifier for new term (if any). (OPTIONAL) |
string | $VariantName | Variant names for new term (if any). (OPTIONAL) |
Definition at line 39 of file ControlledName.php.
References Id().
ControlledName::Delete | ( | $DeleteIfHasResources = FALSE | ) |
Remove ControlledName (and any accompanying associations from database.
This must be the last use of this object.
bool | $DeleteIfHasResources | Remove ControlledName even if Resources are currently associated with it. (OPTIONAL, defaults to FALSE) |
Definition at line 322 of file ControlledName.php.
ControlledName::FieldId | ( | $NewValue = DB_NOVALUE | ) |
Get or set the MetadataField associated with this term.
int | $NewValue | ID of new MetadataField. (OPTIONAL) |
Definition at line 157 of file ControlledName.php.
ControlledName::GetAssociatedResources | ( | ) |
Get resourceIds associated with this ControlledName.
Definition at line 256 of file ControlledName.php.
References Id().
ControlledName::Id | ( | ) |
Get ID.
Definition at line 134 of file ControlledName.php.
Referenced by ControlledName(), Delete(), GetAssociatedResources(), InUse(), RemapTo(), and UpdateLastAssigned().
ControlledName::InUse | ( | ) |
See if ControlledName is currently associated with any Resources.
Definition at line 246 of file ControlledName.php.
References Id().
Referenced by Delete().
ControlledName::Name | ( | $NewValue = DB_NOVALUE | ) |
Get or set the controlled vocabulary term.
string | $NewValue | New value for term. (OPTIONAL) |
Definition at line 141 of file ControlledName.php.
ControlledName::Qualifier | ( | $NewValue = DB_NOVALUE | ) |
Get or set the Qualifier associated with this term via object.
Definition at line 181 of file ControlledName.php.
References DB_NOVALUE, and QualifierId().
ControlledName::QualifierId | ( | $NewValue = DB_NOVALUE | ) |
Get or set the Qualifier associated with this term via ID.
int | $NewValue | ID of new Qualifier. (OPTIONAL) |
Definition at line 165 of file ControlledName.php.
Referenced by Qualifier().
ControlledName::RemapTo | ( | $NewNameId | ) |
Change all currently associated Resources to be instead associated with another ControlledName.
int | $NewNameId | ID of ControlledName to remap resources to. |
Definition at line 270 of file ControlledName.php.
References Id().
|
static |
Check if the given controlled name already exists for a given field ID.
string | $ControlledName | controlled name |
int | $FieldId | field ID |
Definition at line 228 of file ControlledName.php.
ControlledName::Status | ( | ) |
Check success of constructor.
Definition at line 128 of file ControlledName.php.
ControlledName::UpdateLastAssigned | ( | ) |
Update the LastAssigned timestamp for this classification.
Definition at line 310 of file ControlledName.php.
References Id().
ControlledName::Variant | ( | $NewValue = DB_NOVALUE | ) |
Get or set the controlled name variant.
string | $NewValue | New value of the controlled name variant. (OPTIONAL) |
Definition at line 173 of file ControlledName.php.
References VariantName().
ControlledName::VariantName | ( | $NewValue = DB_NOVALUE | ) |
Get or set any variant terms for this controlled name .
string | $NewValue | New value for variant terms. (OPTIONAL) |
Definition at line 149 of file ControlledName.php.
Referenced by Variant().
const ControlledName::STATUS_EXISTS = 2 |
ControlledName already exists with this term.
Definition at line 24 of file ControlledName.php.
const ControlledName::STATUS_INVALID_ID = 1 |
No ControlledName exists with specified ID.
Definition at line 22 of file ControlledName.php.
const ControlledName::STATUS_OK = 0 |
Successful execution.
Definition at line 20 of file ControlledName.php.