MetadataField Class Reference

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)
 IncludeInSortOptions ($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)
 ImagePreviewPrivilege ($NewValue=DB_NOVALUE)
 UsesQualifiers ($NewValue=DB_NOVALUE)
 ShowQualifiers ($NewValue=DB_NOVALUE)
 DefaultQualifier ($NewValue=DB_NOVALUE)
 UseForOaiSets ($NewValue=DB_NOVALUE)
 ViewingPrivilege ($NewValue=DB_NOVALUE)
 AuthoringPrivilege ($NewValue=DB_NOVALUE)
 EditingPrivilege ($NewValue=DB_NOVALUE)
 AllowHTML ($NewValue=DB_NOVALUE)
 TreeBrowsingPrivilege ($NewValue=DB_NOVALUE)
 PointPrecision ($NewValue=DB_NOVALUE)
 PointDecimalDigits ($NewValue=DB_NOVALUE)
 DefaultValue ($NewValue=DB_NOVALUE)
 UpdateMethod ($NewValue=DB_NOVALUE)
 Get/set method by which field is updated.
 GetPossibleValues ($MaxNumberOfValues=NULL, $Offset=0)
 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)

Public Attributes

const UPDATEMETHOD_NOAUTOUPDATE = "NoAutoUpdate"
const UPDATEMETHOD_ONRECORDCREATE = "OnRecordCreate"
const UPDATEMETHOD_BUTTON = "Button"
const UPDATEMETHOD_ONRECORDEDIT = "OnRecordEdit"
const UPDATEMETHOD_ONRECORDCHANGE = "OnRecordChange"

Static Public Attributes

static $FieldTypeDBEnums
static $FieldTypeDBAllowedEnums
static $FieldTypePHPEnums
static $UpdateTypes

List of all members.


Detailed Description

Definition at line 11 of file MetadataField.php.


Member Function Documentation

MetadataField::AllowHTML ( NewValue = DB_NOVALUE )

Definition at line 256 of file MetadataField.php.

References UpdateValue().

MetadataField::AllowMultiple ( NewValue = DB_NOVALUE )

Definition at line 225 of file MetadataField.php.

References UpdateValue().

MetadataField::AssociatedQualifierList (  )

Definition at line 534 of file MetadataField.php.

Referenced by UnassociatedQualifierList().

Here is the caller graph for this function:

MetadataField::AssociateWithQualifier ( QualifierIdOrObject )

Definition at line 570 of file MetadataField.php.

References Id().

MetadataField::AuthoringPrivilege ( NewValue = DB_NOVALUE )

Definition at line 254 of file MetadataField.php.

References UpdateValue().

MetadataField::DateFormat ( NewValue = DB_NOVALUE )

Definition at line 238 of file MetadataField.php.

References UpdateValue().

MetadataField::DBFieldName (  )

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

References UpdateValue().

MetadataField::DefaultQualifier ( NewValue = DB_NOVALUE )

Definition at line 251 of file MetadataField.php.

References UpdateValue().

MetadataField::DefaultValue ( NewValue = DB_NOVALUE )

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

References UpdateValue().

MetadataField::EditingPrivilege ( NewValue = DB_NOVALUE )

Definition at line 255 of file MetadataField.php.

References UpdateValue().

MetadataField::Enabled ( NewValue = DB_NOVALUE )

Definition at line 222 of file MetadataField.php.

References UpdateValue().

MetadataField::FlagOffLabel ( NewValue = DB_NOVALUE )

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

References UpdateValue().

Referenced by GetPossibleValues().

Here is the caller graph for this function:

MetadataField::GetCountOfPossibleValues (  )
MetadataField::GetFactory (  )
MetadataField::GetIdForValue ( Value )
MetadataField::GetPossibleValues ( MaxNumberOfValues = NULL,
Offset = 0 
)
MetadataField::GetValueForId ( Id )
MetadataField::HasItemLevelQualifiers ( NewValue = DB_NOVALUE )

Definition at line 497 of file MetadataField.php.

References DBFieldName(), and UpdateValue().

MetadataField::Id (  )
MetadataField::ImagePreviewPrivilege ( NewValue = DB_NOVALUE )

Definition at line 248 of file MetadataField.php.

References UpdateValue().

MetadataField::IncludeInAdvancedSearch ( NewValue = DB_NOVALUE )

Definition at line 227 of file MetadataField.php.

References UpdateValue().

MetadataField::IncludeInKeywordSearch ( NewValue = DB_NOVALUE )

Definition at line 226 of file MetadataField.php.

References UpdateValue().

MetadataField::IncludeInRecommenderSystem ( NewValue = DB_NOVALUE )

Definition at line 229 of file MetadataField.php.

References UpdateValue().

MetadataField::IncludeInSortOptions ( NewValue = DB_NOVALUE )

Definition at line 228 of file MetadataField.php.

References UpdateValue().

MetadataField::IsTempItem ( NewSetting = NULL )
MetadataField::MaxHeight ( NewValue = DB_NOVALUE )

Definition at line 241 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxLength ( NewValue = DB_NOVALUE )

Definition at line 231 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxPreviewHeight ( NewValue = DB_NOVALUE )

Definition at line 243 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxPreviewWidth ( NewValue = DB_NOVALUE )

Definition at line 244 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxThumbnailHeight ( NewValue = DB_NOVALUE )

Definition at line 245 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxThumbnailWidth ( NewValue = DB_NOVALUE )

Definition at line 246 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxValue ( NewValue = DB_NOVALUE )

Definition at line 235 of file MetadataField.php.

References UpdateValue().

MetadataField::MaxWidth ( NewValue = DB_NOVALUE )

Definition at line 242 of file MetadataField.php.

References UpdateValue().

MetadataField::MetadataField ( FieldId,
FieldName = NULL,
FieldType = NULL,
Optional = TRUE,
DefaultValue = NULL 
)
MetadataField::MinValue ( NewValue = DB_NOVALUE )

Definition at line 234 of file MetadataField.php.

References UpdateValue().

MetadataField::Name ( NewName = DB_NOVALUE )

Definition at line 47 of file MetadataField.php.

References MetadataSchema::MDFSTAT_DUPLICATENAME, MetadataSchema::MDFSTAT_ILLEGALNAME, MetadataSchema::MDFSTAT_OK, and ModifyField().

Referenced by AddDatabaseFields(), and IsTempItem().

Here is the caller graph for this function:

MetadataField::NormalizeFieldNameForDB ( Name )

Definition at line 1114 of file MetadataField.php.

Referenced by IsTempItem(), MetadataField(), and ModifyField().

Here is the caller graph for this function:

MetadataField::Optional ( NewValue = DB_NOVALUE )

Definition at line 223 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 1266 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 233 of file MetadataField.php.

References UpdateValue().

MetadataField::ParagraphRows ( NewValue = DB_NOVALUE )

Definition at line 232 of file MetadataField.php.

References UpdateValue().

MetadataField::PointDecimalDigits ( NewValue = DB_NOVALUE )

Definition at line 284 of file MetadataField.php.

References Id(), and UpdateValue().

MetadataField::PointPrecision ( NewValue = DB_NOVALUE )

Definition at line 259 of file MetadataField.php.

References Id(), and UpdateValue().

MetadataField::RecommenderWeight ( NewValue = DB_NOVALUE )

Definition at line 240 of file MetadataField.php.

References UpdateValue().

MetadataField::RequiredBySPT ( NewValue = DB_NOVALUE )

Definition at line 221 of file MetadataField.php.

References UpdateValue().

MetadataField::SearchWeight ( NewValue = DB_NOVALUE )

Definition at line 239 of file MetadataField.php.

References UpdateValue().

MetadataField::ShowQualifiers ( NewValue = DB_NOVALUE )

Definition at line 250 of file MetadataField.php.

References UpdateValue().

MetadataField::Status (  )

Definition at line 23 of file MetadataField.php.

MetadataField::TextFieldSize ( NewValue = DB_NOVALUE )

Definition at line 230 of file MetadataField.php.

References UpdateValue().

MetadataField::TreeBrowsingPrivilege ( NewValue = DB_NOVALUE )

Definition at line 257 of file MetadataField.php.

References UpdateValue().

MetadataField::Type ( NewValue = DB_NOVALUE )
MetadataField::TypeAsName (  )

Definition at line 41 of file MetadataField.php.

MetadataField::UnassociatedQualifierList (  )

Definition at line 556 of file MetadataField.php.

References AssociatedQualifierList().

MetadataField::UnassociateWithQualifier ( QualifierIdOrObject )

Definition at line 594 of file MetadataField.php.

MetadataField::UpdateMethod ( NewValue = DB_NOVALUE )

Get/set method by which field is updated.

Parameters:
NewValueNew update method.
Returns:
Existing update method.

Definition at line 341 of file MetadataField.php.

References UpdateValue().

MetadataField::UseForOaiSets ( NewValue = DB_NOVALUE )

Definition at line 252 of file MetadataField.php.

References UpdateValue().

MetadataField::UsesQualifiers ( NewValue = DB_NOVALUE )

Definition at line 249 of file MetadataField.php.

References UpdateValue().

MetadataField::Viewable ( NewValue = DB_NOVALUE )

Definition at line 224 of file MetadataField.php.

References UpdateValue().

MetadataField::ViewingPrivilege ( NewValue = DB_NOVALUE )

Definition at line 253 of file MetadataField.php.

References UpdateValue().


Member Data Documentation

MetadataField::$FieldTypeDBAllowedEnums [static]
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 688 of file MetadataField.php.

Definition at line 18 of file MetadataField.php.

Definition at line 16 of file MetadataField.php.

Definition at line 20 of file MetadataField.php.

Definition at line 17 of file MetadataField.php.

Referenced by Resource::Resource().

Definition at line 19 of file MetadataField.php.


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