MetadataField Class Reference
List of all members.Detailed Description
Definition at line 11 of file MetadataField.php.
Member Function Documentation
MetadataField::AddDatabaseFields | ( | ) |
Definition at line 1111 of file MetadataField.php.
References DBFieldName(), DefaultValue(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_DATE, MetadataSchema::MDFTYPE_FILE, MetadataSchema::MDFTYPE_FLAG, MetadataSchema::MDFTYPE_IMAGE, MetadataSchema::MDFTYPE_NUMBER, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_PARAGRAPH, MetadataSchema::MDFTYPE_POINT, MetadataSchema::MDFTYPE_TEXT, MetadataSchema::MDFTYPE_TIMESTAMP, MetadataSchema::MDFTYPE_TREE, MetadataSchema::MDFTYPE_URL, MetadataSchema::MDFTYPE_USER, Name(), Optional(), Type(), and UpdateValue().
Referenced by IsTempItem().
Here is the caller graph for this function:

MetadataField::AllowMultiple | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::AssociatedQualifierList | ( | ) |
Definition at line 526 of file MetadataField.php.
Referenced by UnassociatedQualifierList().
Here is the caller graph for this function:

MetadataField::AssociateWithQualifier | ( | $ | QualifierIdOrObject | ) |
MetadataField::AuthoringPrivilege | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::DateFormat | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::DBFieldName | ( | ) |
Definition at line 214 of file MetadataField.php.
Referenced by AddDatabaseFields(), and HasItemLevelQualifiers().
Here is the caller graph for this function:

MetadataField::DefaultAltText | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::DefaultQualifier | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::DefaultValue | ( | $ | NewValue = DB_NOVALUE |
) |
Definition at line 300 of file MetadataField.php.
References MetadataSchema::MDFTYPE_POINT, Type(), and UpdateValue().
Referenced by AddDatabaseFields(), and ModifyField().
Here is the caller graph for this function:

MetadataField::Description | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::Drop | ( | ) |
Definition at line 779 of file MetadataField.php.
References $FieldTypePHPEnums, Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_DATE, MetadataSchema::MDFTYPE_FILE, MetadataSchema::MDFTYPE_FLAG, MetadataSchema::MDFTYPE_IMAGE, MetadataSchema::MDFTYPE_NUMBER, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_PARAGRAPH, MetadataSchema::MDFTYPE_POINT, MetadataSchema::MDFTYPE_TEXT, MetadataSchema::MDFTYPE_TIMESTAMP, MetadataSchema::MDFTYPE_TREE, MetadataSchema::MDFTYPE_URL, and MetadataSchema::MDFTYPE_USER.
MetadataField::EditingPrivilege | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::Enabled | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::FlagOffLabel | ( | $ | NewValue = DB_NOVALUE |
) |
Definition at line 233 of file MetadataField.php.
References UpdateValue().
Referenced by GetPossibleValues().
Here is the caller graph for this function:

MetadataField::FlagOnLabel | ( | $ | NewValue = DB_NOVALUE |
) |
Definition at line 232 of file MetadataField.php.
References UpdateValue().
Referenced by GetPossibleValues().
Here is the caller graph for this function:

MetadataField::GetAllowedConversionTypes | ( | ) |
Definition at line 87 of file MetadataField.php.
References MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_DATE, MetadataSchema::MDFTYPE_FILE, MetadataSchema::MDFTYPE_FLAG, MetadataSchema::MDFTYPE_IMAGE, MetadataSchema::MDFTYPE_NUMBER, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_PARAGRAPH, MetadataSchema::MDFTYPE_TEXT, MetadataSchema::MDFTYPE_TIMESTAMP, MetadataSchema::MDFTYPE_TREE, MetadataSchema::MDFTYPE_URL, MetadataSchema::MDFTYPE_USER, and Type().
MetadataField::GetCountOfPossibleValues | ( | ) |
Definition at line 390 of file MetadataField.php.
References Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_FLAG, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_TREE, and Type().
MetadataField::GetFactory | ( | ) |
Definition at line 602 of file MetadataField.php.
References Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_TREE, and Type().
MetadataField::GetIdForValue | ( | $ | Value | ) |
Definition at line 424 of file MetadataField.php.
References Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_TREE, and Type().
MetadataField::GetPossibleValues | ( | $ | MaxNumberOfValues = NULL , |
|
$ | Offset = 0 | |||
) |
Definition at line 340 of file MetadataField.php.
References FlagOffLabel(), FlagOnLabel(), Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_FLAG, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_TREE, and Type().
MetadataField::GetValueForId | ( | $ | Id | ) |
Definition at line 456 of file MetadataField.php.
References Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_TREE, and Type().
MetadataField::HasItemLevelQualifiers | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::Id | ( | ) |
Definition at line 213 of file MetadataField.php.
Referenced by AssociateWithQualifier(), Drop(), GetCountOfPossibleValues(), GetFactory(), GetIdForValue(), GetPossibleValues(), GetValueForId(), IsTempItem(), ModifyField(), PointDecimalDigits(), PointPrecision(), and UnassociateWithQualifier().
Here is the caller graph for this function:

MetadataField::IncludeInAdvancedSearch | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::IncludeInKeywordSearch | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::IncludeInRecommenderSystem | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::IsTempItem | ( | $ | NewSetting = NULL |
) |
Definition at line 142 of file MetadataField.php.
References AddDatabaseFields(), Id(), MetadataSchema::MDFSTAT_ILLEGALNAME, Name(), and NormalizeFieldNameForDB().
MetadataField::MaxHeight | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::MaxLength | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::MaxPreviewHeight | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::MaxPreviewWidth | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::MaxThumbnailHeight | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::MaxThumbnailWidth | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::MaxValue | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::MaxWidth | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::MetadataField | ( | $ | FieldId, | |
$ | FieldName = NULL , |
|||
$ | FieldType = NULL , |
|||
$ | Optional = TRUE , |
|||
$ | DefaultValue = NULL | |||
) |
Definition at line 689 of file MetadataField.php.
References $FieldTypeDBEnums, MetadataSchema::MDFORDER_DISPLAY, MetadataSchema::MDFORDER_EDITING, MetadataSchema::MDFSTAT_DUPLICATENAME, MetadataSchema::MDFSTAT_FIELDDOESNOTEXIST, MetadataSchema::MDFSTAT_OK, NormalizeFieldNameForDB(), and OrderPosition().
MetadataField::MinValue | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::ModifyField | ( | $ | NewName = NULL , |
|
$ | NewType = NULL | |||
) |
Definition at line 885 of file MetadataField.php.
References $FieldTypeDBEnums, $FieldTypePHPEnums, DefaultValue(), Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_DATE, MetadataSchema::MDFTYPE_FILE, MetadataSchema::MDFTYPE_FLAG, MetadataSchema::MDFTYPE_IMAGE, MetadataSchema::MDFTYPE_NUMBER, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_PARAGRAPH, MetadataSchema::MDFTYPE_POINT, MetadataSchema::MDFTYPE_TEXT, MetadataSchema::MDFTYPE_TIMESTAMP, MetadataSchema::MDFTYPE_TREE, MetadataSchema::MDFTYPE_URL, MetadataSchema::MDFTYPE_USER, NormalizeFieldNameForDB(), and UpdateValue().
Referenced by Name(), and Type().
Here is the caller graph for this function:

MetadataField::Name | ( | $ | NewName = DB_NOVALUE |
) |
Definition at line 47 of file MetadataField.php.
References MetadataSchema::MDFSTAT_DUPLICATENAME, MetadataSchema::MDFSTAT_ILLEGALNAME, MetadataSchema::MDFSTAT_OK, ModifyField(), and NormalizeFieldNameForDB().
Referenced by AddDatabaseFields(), and IsTempItem().
Here is the caller graph for this function:

MetadataField::NormalizeFieldNameForDB | ( | $ | Name | ) |
Definition at line 1105 of file MetadataField.php.
Referenced by IsTempItem(), MetadataField(), ModifyField(), and Name().
Here is the caller graph for this function:

MetadataField::Optional | ( | $ | NewValue = DB_NOVALUE |
) |
Definition at line 220 of file MetadataField.php.
References UpdateValue().
Referenced by AddDatabaseFields().
Here is the caller graph for this function:

MetadataField::OrderPosition | ( | $ | OrderType, | |
$ | NewValue = DB_NOVALUE | |||
) |
Definition at line 1257 of file MetadataField.php.
References MetadataSchema::MDFORDER_DISPLAY, MetadataSchema::MDFORDER_EDITING, and UpdateValue().
Referenced by MetadataField().
Here is the caller graph for this function:

MetadataField::ParagraphCols | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::ParagraphRows | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::PointDecimalDigits | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::PointPrecision | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::RecommenderWeight | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::RequiredBySPT | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::SearchWeight | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::Status | ( | ) |
Definition at line 23 of file MetadataField.php.
MetadataField::TextFieldSize | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::Type | ( | $ | NewValue = DB_NOVALUE |
) |
Definition at line 26 of file MetadataField.php.
References $FieldTypePHPEnums, and ModifyField().
Referenced by AddDatabaseFields(), DefaultValue(), GetAllowedConversionTypes(), GetCountOfPossibleValues(), GetFactory(), GetIdForValue(), GetPossibleValues(), and GetValueForId().
Here is the caller graph for this function:

MetadataField::TypeAsName | ( | ) |
Definition at line 41 of file MetadataField.php.
MetadataField::UnassociatedQualifierList | ( | ) |
MetadataField::UnassociateWithQualifier | ( | $ | QualifierIdOrObject | ) |
MetadataField::UpdateMethod | ( | $ | NewValue = DB_NOVALUE |
) |
Get/set method by which field is updated.
- Parameters:
-
NewValue New update method.
- Returns:
- Existing update method.
Definition at line 333 of file MetadataField.php.
References UpdateValue().
MetadataField::UpdateValue | ( | $ | FieldName, | |
$ | NewValue | |||
) |
Definition at line 1097 of file MetadataField.php.
Referenced by AddDatabaseFields(), AllowMultiple(), AuthoringPrivilege(), DateFormat(), DefaultAltText(), DefaultQualifier(), DefaultValue(), Description(), EditingPrivilege(), Enabled(), FlagOffLabel(), FlagOnLabel(), HasItemLevelQualifiers(), IncludeInAdvancedSearch(), IncludeInKeywordSearch(), IncludeInRecommenderSystem(), MaxHeight(), MaxLength(), MaxPreviewHeight(), MaxPreviewWidth(), MaxThumbnailHeight(), MaxThumbnailWidth(), MaxValue(), MaxWidth(), MinValue(), ModifyField(), Optional(), OrderPosition(), ParagraphCols(), ParagraphRows(), PointDecimalDigits(), PointPrecision(), RecommenderWeight(), RequiredBySPT(), SearchWeight(), TextFieldSize(), UpdateMethod(), UseForOaiSets(), UsesQualifiers(), Viewable(), and ViewingPrivilege().
Here is the caller graph for this function:

MetadataField::UseForOaiSets | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::UsesQualifiers | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::Viewable | ( | $ | NewValue = DB_NOVALUE |
) |
MetadataField::ViewingPrivilege | ( | $ | NewValue = DB_NOVALUE |
) |
Member Data Documentation
MetadataField::$FieldTypeDBAllowedEnums [static] |
Initial value:
array( MetadataSchema::MDFTYPE_TEXT => "Text", MetadataSchema::MDFTYPE_PARAGRAPH => "Paragraph", MetadataSchema::MDFTYPE_NUMBER => "Number", MetadataSchema::MDFTYPE_DATE => "Date", MetadataSchema::MDFTYPE_TIMESTAMP => "TimeStamp", MetadataSchema::MDFTYPE_FLAG => "Flag", MetadataSchema::MDFTYPE_TREE => "Tree", MetadataSchema::MDFTYPE_CONTROLLEDNAME => "ControlledName", MetadataSchema::MDFTYPE_OPTION => "Option", MetadataSchema::MDFTYPE_IMAGE => "Still Image", MetadataSchema::MDFTYPE_FILE => "File", MetadataSchema::MDFTYPE_URL => "Url", MetadataSchema::MDFTYPE_POINT => "Point" )
Definition at line 647 of file MetadataField.php.
Referenced by MetadataSchema::GetAllowedFieldTypes().
MetadataField::$FieldTypeDBEnums [static] |
Initial value:
array( MetadataSchema::MDFTYPE_TEXT => "Text", MetadataSchema::MDFTYPE_PARAGRAPH => "Paragraph", MetadataSchema::MDFTYPE_NUMBER => "Number", MetadataSchema::MDFTYPE_DATE => "Date", MetadataSchema::MDFTYPE_TIMESTAMP => "TimeStamp", MetadataSchema::MDFTYPE_FLAG => "Flag", MetadataSchema::MDFTYPE_TREE => "Tree", MetadataSchema::MDFTYPE_CONTROLLEDNAME => "ControlledName", MetadataSchema::MDFTYPE_OPTION => "Option", MetadataSchema::MDFTYPE_USER => "User", MetadataSchema::MDFTYPE_IMAGE => "Still Image", MetadataSchema::MDFTYPE_FILE => "File", MetadataSchema::MDFTYPE_URL => "Url", MetadataSchema::MDFTYPE_POINT => "Point" )
Definition at line 631 of file MetadataField.php.
Referenced by MetadataSchema::GetFieldTypes(), MetadataField(), and ModifyField().
MetadataField::$FieldTypePHPEnums [static] |
Initial value:
array( "Text" => MetadataSchema::MDFTYPE_TEXT, "Paragraph" => MetadataSchema::MDFTYPE_PARAGRAPH, "Number" => MetadataSchema::MDFTYPE_NUMBER, "Date" => MetadataSchema::MDFTYPE_DATE, "TimeStamp" => MetadataSchema::MDFTYPE_TIMESTAMP, "Flag" => MetadataSchema::MDFTYPE_FLAG, "Tree" => MetadataSchema::MDFTYPE_TREE, "ControlledName" => MetadataSchema::MDFTYPE_CONTROLLEDNAME, "Option" => MetadataSchema::MDFTYPE_OPTION, "User" => MetadataSchema::MDFTYPE_USER, "Still Image" => MetadataSchema::MDFTYPE_IMAGE, "File" => MetadataSchema::MDFTYPE_FILE, "Url" => MetadataSchema::MDFTYPE_URL, "Point" => MetadataSchema::MDFTYPE_POINT )
Definition at line 662 of file MetadataField.php.
Referenced by Drop(), MetadataSchema::GetFields(), ModifyField(), and Type().
MetadataField::$UpdateTypes [static] |
Initial value:
array( MetadataField::UPDATEMETHOD_NOAUTOUPDATE => "Do not update automatically", MetadataField::UPDATEMETHOD_ONRECORDCREATE => "Update on record creation", MetadataField::UPDATEMETHOD_BUTTON => "Provide an update button", MetadataField::UPDATEMETHOD_ONRECORDEDIT => "Update when record is edited", MetadataField::UPDATEMETHOD_ONRECORDCHANGE => "Update when record is changed" )
Definition at line 679 of file MetadataField.php.
const MetadataField::UPDATEMETHOD_BUTTON = "Button" |
Definition at line 18 of file MetadataField.php.
const MetadataField::UPDATEMETHOD_NOAUTOUPDATE = "NoAutoUpdate" |
Definition at line 16 of file MetadataField.php.
const MetadataField::UPDATEMETHOD_ONRECORDCHANGE = "OnRecordChange" |
Definition at line 20 of file MetadataField.php.
const MetadataField::UPDATEMETHOD_ONRECORDCREATE = "OnRecordCreate" |
const MetadataField::UPDATEMETHOD_ONRECORDEDIT = "OnRecordEdit" |
Definition at line 19 of file MetadataField.php.
The documentation for this class was generated from the following file: