Search:

# CWIS Developers Documentation

- Main Page
- Classes
- Files

- Search for |

- Alphabetical List
- Class List
- Class Hierarchy
- Class Members

# MetadataField Class Reference

List of all members.

## Public Member Functions
| Status ()
| Type ($NewValue=DB_NOVALUE)
| TypeAsName ()
| Name ($NewName=DB_NOVALUE)
| GetAllowedConversionTypes ()
| IsTempItem ($NewSetting=NULL)
| Id ()
| DBFieldName ()
| Description ($NewValue=DB_NOVALUE)
| RequiredBySPT ($NewValue=DB_NOVALUE)
| Enabled ($NewValue=DB_NOVALUE)
| Optional ($NewValue=DB_NOVALUE)
| Viewable ($NewValue=DB_NOVALUE)
| AllowMultiple ($NewValue=DB_NOVALUE)
| IncludeInKeywordSearch ($NewValue=DB_NOVALUE)
| IncludeInAdvancedSearch ($NewValue=DB_NOVALUE)
| IncludeInRecommenderSystem ($NewValue=DB_NOVALUE)
| TextFieldSize ($NewValue=DB_NOVALUE)
| MaxLength ($NewValue=DB_NOVALUE)
| ParagraphRows ($NewValue=DB_NOVALUE)
| ParagraphCols ($NewValue=DB_NOVALUE)
| MinValue ($NewValue=DB_NOVALUE)
| MaxValue ($NewValue=DB_NOVALUE)
| FlagOnLabel ($NewValue=DB_NOVALUE)
| FlagOffLabel ($NewValue=DB_NOVALUE)
| DateFormat ($NewValue=DB_NOVALUE)
| SearchWeight ($NewValue=DB_NOVALUE)
| RecommenderWeight ($NewValue=DB_NOVALUE)
| MaxHeight ($NewValue=DB_NOVALUE)
| MaxWidth ($NewValue=DB_NOVALUE)
| MaxPreviewHeight ($NewValue=DB_NOVALUE)
| MaxPreviewWidth ($NewValue=DB_NOVALUE)
| MaxThumbnailHeight ($NewValue=DB_NOVALUE)
| MaxThumbnailWidth ($NewValue=DB_NOVALUE)
| DefaultAltText ($NewValue=DB_NOVALUE)
| UsesQualifiers ($NewValue=DB_NOVALUE)
| DefaultQualifier ($NewValue=DB_NOVALUE)
| UseForOaiSets ($NewValue=DB_NOVALUE)
| ViewingPrivilege ($NewValue=DB_NOVALUE)
| AuthoringPrivilege ($NewValue=DB_NOVALUE)
| EditingPrivilege ($NewValue=DB_NOVALUE)
| PointPrecision ($NewValue=DB_NOVALUE)
| PointDecimalDigits ($NewValue=DB_NOVALUE)
| DefaultValue ($NewValue=DB_NOVALUE)
| GetPossibleValues ($MaxNumberOfValues=NULL)
| GetCountOfPossibleValues ()
| GetIdForValue ($Value)
| GetValueForId ($Id)
| HasItemLevelQualifiers ($NewValue=DB_NOVALUE)
| AssociatedQualifierList ()
| UnassociatedQualifierList ()
| AssociateWithQualifier ($QualifierIdOrObject)
| UnassociateWithQualifier ($QualifierIdOrObject)
| GetFactory ()
| MetadataField ($FieldId, $FieldName=NULL, $FieldType=NULL, $Optional=TRUE, $DefaultValue=NULL)
| Drop ()
| ModifyField ($NewName=NULL, $NewType=NULL)
| UpdateValue ($FieldName, $NewValue)
| NormalizeFieldNameForDB ($Name)
| AddDatabaseFields ()
| OrderPosition ($OrderType, $NewValue=DB_NOVALUE)
## Static Public Attributes
static | $FieldTypeDBEnums
static | $FieldTypeDBAllowedEnums
static | $FieldTypePHPEnums

## Detailed Description

Definition at line 11 of file MetadataField.php.

## Member Function Documentation

MetadataField::AddDatabaseFields | ( |  | ) |

Definition at line 1075 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` | ) |

Definition at line 216 of file MetadataField.php.

References UpdateValue().

MetadataField::AssociatedQualifierList | ( |  | ) |

Definition at line 499 of file MetadataField.php.

Referenced by UnassociatedQualifierList().

Here is the caller graph for this function:

MetadataField::AssociateWithQualifier | ( | $ | QualifierIdOrObject | ) |

Definition at line 535 of file MetadataField.php.

References Id().

MetadataField::AuthoringPrivilege | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 242 of file MetadataField.php.

References UpdateValue().

MetadataField::DateFormat | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 228 of file MetadataField.php.

References UpdateValue().

MetadataField::DBFieldName | ( |  | ) |

Definition at line 208 of file MetadataField.php.

Referenced by AddDatabaseFields(), and HasItemLevelQualifiers().

Here is the caller graph for this function:

MetadataField::DefaultAltText | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 237 of file MetadataField.php.

References UpdateValue().

MetadataField::DefaultQualifier | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 239 of file MetadataField.php.

References UpdateValue().

MetadataField::DefaultValue | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 289 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` | ) |

Definition at line 211 of file MetadataField.php.

References UpdateValue().

MetadataField::Drop | ( |  | ) |

Definition at line 743 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` | ) |

Definition at line 243 of file MetadataField.php.

References UpdateValue().

MetadataField::Enabled | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 213 of file MetadataField.php.

References UpdateValue().

MetadataField::FlagOffLabel | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 227 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 226 of file MetadataField.php.

References UpdateValue().

Referenced by GetPossibleValues().

Here is the caller graph for this function:

MetadataField::GetAllowedConversionTypes | ( |  | ) |

Definition at line 80 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 363 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 575 of file MetadataField.php.

References Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_TREE, and Type().

MetadataField::GetIdForValue | ( | $ | Value | ) |

Definition at line 397 of file MetadataField.php.

References Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_TREE, and Type().

MetadataField::GetPossibleValues | ( | $ | MaxNumberOfValues = `NULL` | ) |

Definition at line 319 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 429 of file MetadataField.php.

References Id(), MetadataSchema::MDFTYPE_CONTROLLEDNAME, MetadataSchema::MDFTYPE_OPTION, MetadataSchema::MDFTYPE_TREE, and Type().

MetadataField::HasItemLevelQualifiers | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 462 of file MetadataField.php.

References DBFieldName(), and UpdateValue().

MetadataField::Id | ( |  | ) |

Definition at line 207 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` | ) |

Definition at line 218 of file MetadataField.php.

References UpdateValue().

MetadataField::IncludeInKeywordSearch | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 217 of file MetadataField.php.

References UpdateValue().

MetadataField::IncludeInRecommenderSystem | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 219 of file MetadataField.php.

References UpdateValue().

MetadataField::IsTempItem | ( | $ | NewSetting = `NULL` | ) |

Definition at line 136 of file MetadataField.php.

References AddDatabaseFields(), Id(), MetadataSchema::MDFSTAT_ILLEGALNAME, Name(), and NormalizeFieldNameForDB().

MetadataField::MaxHeight | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 231 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxLength | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 221 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxPreviewHeight | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 233 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxPreviewWidth | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 234 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxThumbnailHeight | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 235 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxThumbnailWidth | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 236 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxValue | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 225 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxWidth | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 232 of file MetadataField.php.

References UpdateValue().

MetadataField::MetadataField | ( | $ | FieldId,
|  | $ | FieldName = `NULL`,
|  | $ | FieldType = `NULL`,
|  | $ | Optional = `TRUE`,
|  | $ | DefaultValue = `NULL` |
| ) |  |  |

Definition at line 653 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` | ) |

Definition at line 224 of file MetadataField.php.

References UpdateValue().

MetadataField::ModifyField | ( | $ | NewName = `NULL`,
|  | $ | NewType = `NULL` |
| ) |  |  |

Definition at line 849 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 40 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 1069 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 214 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 1221 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` | ) |

Definition at line 223 of file MetadataField.php.

References UpdateValue().

MetadataField::ParagraphRows | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 222 of file MetadataField.php.

References UpdateValue().

MetadataField::PointDecimalDigits | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 267 of file MetadataField.php.

References Id(), and UpdateValue().

MetadataField::PointPrecision | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 245 of file MetadataField.php.

References Id(), and UpdateValue().

MetadataField::RecommenderWeight | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 230 of file MetadataField.php.

References UpdateValue().

MetadataField::RequiredBySPT | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 212 of file MetadataField.php.

References UpdateValue().

MetadataField::SearchWeight | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 229 of file MetadataField.php.

References UpdateValue().

MetadataField::Status | ( |  | ) |

Definition at line 16 of file MetadataField.php.

MetadataField::TextFieldSize | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 220 of file MetadataField.php.

References UpdateValue().

MetadataField::Type | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 19 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 34 of file MetadataField.php.

MetadataField::UnassociatedQualifierList | ( |  | ) |

Definition at line 521 of file MetadataField.php.

References AssociatedQualifierList().

MetadataField::UnassociateWithQualifier | ( | $ | QualifierIdOrObject | ) |

Definition at line 559 of file MetadataField.php.

References Id().

MetadataField::UpdateValue | ( | $ | FieldName,
|  | $ | NewValue |
| ) |  |  |

Definition at line 1061 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(), UseForOaiSets(), UsesQualifiers(), Viewable(), and ViewingPrivilege().

Here is the caller graph for this function:

MetadataField::UseForOaiSets | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 240 of file MetadataField.php.

References UpdateValue().

MetadataField::UsesQualifiers | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 238 of file MetadataField.php.

References UpdateValue().

MetadataField::Viewable | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 215 of file MetadataField.php.

References UpdateValue().

MetadataField::ViewingPrivilege | ( | $ | NewValue = `DB_NOVALUE` | ) |

Definition at line 241 of file MetadataField.php.

References UpdateValue().

## 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_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 620 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 604 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 634 of file MetadataField.php.

Referenced by Drop(), MetadataSchema::GetFields(), ModifyField(), and Type().

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

- MetadataField.php