MetadataField Class Reference

List of all members.

Public Member Functions

 Status ()
 Type ($NewValue=DB_NOVALUE)
 TypeAsName ()
 GetDisplayName ()
 Name ($NewName=DB_NOVALUE)
 Label ($NewLabel=DB_NOVALUE)
 GetAllowedConversionTypes ()
 IsTempItem ($NewSetting=NULL)
 Id ()
 DBFieldName ()
 Description ($NewValue=DB_NOVALUE)
 Instructions ($NewValue=DB_NOVALUE)
 Owner ($NewValue=DB_NOVALUE)
 RequiredBySPT ($NewValue=DB_NOVALUE)
 Enabled ($NewValue=DB_NOVALUE)
 Optional ($NewValue=DB_NOVALUE)
 Editable ($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)
 UsesQualifiers ($NewValue=DB_NOVALUE)
 ShowQualifiers ($NewValue=DB_NOVALUE)
 DefaultQualifier ($NewValue=DB_NOVALUE)
 AllowHTML ($NewValue=DB_NOVALUE)
 UseWysiwygEditor ($NewValue=DB_NOVALUE)
 UseForOaiSets ($NewValue=DB_NOVALUE)
 NumAjaxResults ($NewValue=DB_NOVALUE)
 ViewingPrivilege ($NewValue=DB_NOVALUE)
 AuthoringPrivilege ($NewValue=DB_NOVALUE)
 EditingPrivilege ($NewValue=DB_NOVALUE)
 ImagePreviewPrivilege ($NewValue=DB_NOVALUE)
 TreeBrowsingPrivilege ($NewValue=DB_NOVALUE)
 EnableOnOwnerReturn ($NewValue=DB_NOVALUE)
 ViewingUserIsValue ($NewValue=DB_NOVALUE)
 AuthoringUserIsValue ($NewValue=DB_NOVALUE)
 EditingUserIsValue ($NewValue=DB_NOVALUE)
 ViewingUserValue ($NewValue=DB_NOVALUE)
 AuthoringUserValue ($NewValue=DB_NOVALUE)
 EditingUserValue ($NewValue=DB_NOVALUE)
 UserPrivilegeRestrictions ($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 ()
 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"
const USERISVALUE_OR = -1
const USERISVALUE_UNSET = 0
const USERISVALUE_AND = 1

Static Public Attributes

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

Detailed Description

Definition at line 10 of file MetadataField.php.


Member Function Documentation

MetadataField::AllowHTML ( NewValue = DB_NOVALUE  ) 

Definition at line 340 of file MetadataField.php.

MetadataField::AllowMultiple ( NewValue = DB_NOVALUE  ) 

Definition at line 288 of file MetadataField.php.

Referenced by DefaultValue().

Here is the caller graph for this function:

MetadataField::AssociatedQualifierList (  ) 

Definition at line 728 of file MetadataField.php.

Referenced by UnassociatedQualifierList().

Here is the caller graph for this function:

MetadataField::AssociateWithQualifier ( QualifierIdOrObject  ) 

Definition at line 764 of file MetadataField.php.

References Id().

MetadataField::AuthoringPrivilege ( NewValue = DB_NOVALUE  ) 

Definition at line 350 of file MetadataField.php.

MetadataField::AuthoringUserIsValue ( NewValue = DB_NOVALUE  ) 

Definition at line 362 of file MetadataField.php.

MetadataField::AuthoringUserValue ( NewValue = DB_NOVALUE  ) 

Definition at line 368 of file MetadataField.php.

MetadataField::DateFormat ( NewValue = DB_NOVALUE  ) 

Definition at line 314 of file MetadataField.php.

MetadataField::DBFieldName (  ) 

Definition at line 269 of file MetadataField.php.

Referenced by HasItemLevelQualifiers().

Here is the caller graph for this function:

MetadataField::DefaultAltText ( NewValue = DB_NOVALUE  ) 

Definition at line 332 of file MetadataField.php.

MetadataField::DefaultQualifier ( NewValue = DB_NOVALUE  ) 

Definition at line 338 of file MetadataField.php.

MetadataField::DefaultValue ( NewValue = DB_NOVALUE  ) 

MetadataField::Description ( NewValue = DB_NOVALUE  ) 

Definition at line 272 of file MetadataField.php.

MetadataField::Drop (  ) 

MetadataField::Editable ( NewValue = DB_NOVALUE  ) 

Definition at line 284 of file MetadataField.php.

MetadataField::EditingPrivilege ( NewValue = DB_NOVALUE  ) 

Definition at line 352 of file MetadataField.php.

MetadataField::EditingUserIsValue ( NewValue = DB_NOVALUE  ) 

Definition at line 364 of file MetadataField.php.

MetadataField::EditingUserValue ( NewValue = DB_NOVALUE  ) 

Definition at line 370 of file MetadataField.php.

MetadataField::Enabled ( NewValue = DB_NOVALUE  ) 

Definition at line 280 of file MetadataField.php.

MetadataField::EnableOnOwnerReturn ( NewValue = DB_NOVALUE  ) 

Definition at line 358 of file MetadataField.php.

MetadataField::FlagOffLabel ( NewValue = DB_NOVALUE  ) 

Definition at line 312 of file MetadataField.php.

Referenced by GetPossibleValues().

Here is the caller graph for this function:

MetadataField::FlagOnLabel ( NewValue = DB_NOVALUE  ) 

Definition at line 310 of file MetadataField.php.

Referenced by GetPossibleValues().

Here is the caller graph for this function:

MetadataField::GetAllowedConversionTypes (  ) 

MetadataField::GetCountOfPossibleValues (  ) 

MetadataField::GetDisplayName (  ) 

Definition at line 53 of file MetadataField.php.

References Label(), and Name().

MetadataField::GetFactory (  ) 

MetadataField::GetIdForValue ( Value  ) 

MetadataField::GetPossibleValues ( MaxNumberOfValues = NULL,
Offset = 0 
)

MetadataField::GetValueForId ( Id  ) 

MetadataField::HasItemLevelQualifiers ( NewValue = DB_NOVALUE  ) 

Definition at line 691 of file MetadataField.php.

References DBFieldName().

MetadataField::Id (  ) 

MetadataField::ImagePreviewPrivilege ( NewValue = DB_NOVALUE  ) 

Definition at line 354 of file MetadataField.php.

MetadataField::IncludeInAdvancedSearch ( NewValue = DB_NOVALUE  ) 

Definition at line 292 of file MetadataField.php.

MetadataField::IncludeInKeywordSearch ( NewValue = DB_NOVALUE  ) 

Definition at line 290 of file MetadataField.php.

MetadataField::IncludeInRecommenderSystem ( NewValue = DB_NOVALUE  ) 

Definition at line 296 of file MetadataField.php.

MetadataField::IncludeInSortOptions ( NewValue = DB_NOVALUE  ) 

Definition at line 294 of file MetadataField.php.

MetadataField::Instructions ( NewValue = DB_NOVALUE  ) 

Definition at line 274 of file MetadataField.php.

MetadataField::IsTempItem ( NewSetting = NULL  ) 

Definition at line 194 of file MetadataField.php.

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

MetadataField::Label ( NewLabel = DB_NOVALUE  ) 

Definition at line 101 of file MetadataField.php.

References MetadataSchema::MDFSTAT_ILLEGALLABEL, and MetadataSchema::MDFSTAT_OK.

Referenced by GetDisplayName().

Here is the caller graph for this function:

MetadataField::MaxHeight ( NewValue = DB_NOVALUE  ) 

Definition at line 320 of file MetadataField.php.

MetadataField::MaxLength ( NewValue = DB_NOVALUE  ) 

Definition at line 300 of file MetadataField.php.

MetadataField::MaxPreviewHeight ( NewValue = DB_NOVALUE  ) 

Definition at line 324 of file MetadataField.php.

MetadataField::MaxPreviewWidth ( NewValue = DB_NOVALUE  ) 

Definition at line 326 of file MetadataField.php.

MetadataField::MaxThumbnailHeight ( NewValue = DB_NOVALUE  ) 

Definition at line 328 of file MetadataField.php.

MetadataField::MaxThumbnailWidth ( NewValue = DB_NOVALUE  ) 

Definition at line 330 of file MetadataField.php.

MetadataField::MaxValue ( NewValue = DB_NOVALUE  ) 

Definition at line 308 of file MetadataField.php.

MetadataField::MaxWidth ( NewValue = DB_NOVALUE  ) 

Definition at line 322 of file MetadataField.php.

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

MetadataField::MinValue ( NewValue = DB_NOVALUE  ) 

Definition at line 306 of file MetadataField.php.

MetadataField::Name ( NewName = DB_NOVALUE  ) 

Definition at line 60 of file MetadataField.php.

References MetadataSchema::MDFSTAT_DUPLICATENAME, MetadataSchema::MDFSTAT_ILLEGALNAME, and MetadataSchema::MDFSTAT_OK.

Referenced by GetDisplayName(), and IsTempItem().

Here is the caller graph for this function:

MetadataField::NumAjaxResults ( NewValue = DB_NOVALUE  ) 

Definition at line 346 of file MetadataField.php.

MetadataField::Optional ( NewValue = DB_NOVALUE  ) 

Definition at line 282 of file MetadataField.php.

MetadataField::OrderPosition ( OrderType,
NewValue = DB_NOVALUE 
)

Definition at line 1094 of file MetadataField.php.

References MetadataSchema::MDFORDER_DISPLAY, and MetadataSchema::MDFORDER_EDITING.

Referenced by MetadataField().

Here is the caller graph for this function:

MetadataField::Owner ( NewValue = DB_NOVALUE  ) 

Definition at line 276 of file MetadataField.php.

MetadataField::ParagraphCols ( NewValue = DB_NOVALUE  ) 

Definition at line 304 of file MetadataField.php.

MetadataField::ParagraphRows ( NewValue = DB_NOVALUE  ) 

Definition at line 302 of file MetadataField.php.

MetadataField::PointDecimalDigits ( NewValue = DB_NOVALUE  ) 

Definition at line 423 of file MetadataField.php.

References Id().

MetadataField::PointPrecision ( NewValue = DB_NOVALUE  ) 

Definition at line 398 of file MetadataField.php.

References Id().

MetadataField::RecommenderWeight ( NewValue = DB_NOVALUE  ) 

Definition at line 318 of file MetadataField.php.

MetadataField::RequiredBySPT ( NewValue = DB_NOVALUE  ) 

Definition at line 278 of file MetadataField.php.

MetadataField::SearchWeight ( NewValue = DB_NOVALUE  ) 

Definition at line 316 of file MetadataField.php.

Referenced by MetadataField().

Here is the caller graph for this function:

MetadataField::ShowQualifiers ( NewValue = DB_NOVALUE  ) 

Definition at line 336 of file MetadataField.php.

MetadataField::Status (  ) 

Definition at line 27 of file MetadataField.php.

MetadataField::TextFieldSize ( NewValue = DB_NOVALUE  ) 

Definition at line 298 of file MetadataField.php.

MetadataField::TreeBrowsingPrivilege ( NewValue = DB_NOVALUE  ) 

Definition at line 356 of file MetadataField.php.

MetadataField::Type ( NewValue = DB_NOVALUE  ) 

Definition at line 30 of file MetadataField.php.

References $FieldTypePHPEnums.

Referenced by DefaultValue(), GetAllowedConversionTypes(), GetCountOfPossibleValues(), GetFactory(), GetIdForValue(), GetPossibleValues(), and GetValueForId().

Here is the caller graph for this function:

MetadataField::TypeAsName (  ) 

Definition at line 46 of file MetadataField.php.

MetadataField::UnassociatedQualifierList (  ) 

Definition at line 750 of file MetadataField.php.

References AssociatedQualifierList().

MetadataField::UnassociateWithQualifier ( QualifierIdOrObject  ) 

Definition at line 788 of file MetadataField.php.

References Id().

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 505 of file MetadataField.php.

MetadataField::UseForOaiSets ( NewValue = DB_NOVALUE  ) 

Definition at line 344 of file MetadataField.php.

MetadataField::UserPrivilegeRestrictions ( NewValue = DB_NOVALUE  ) 

Definition at line 373 of file MetadataField.php.

Referenced by GetPossibleValues().

Here is the caller graph for this function:

MetadataField::UsesQualifiers ( NewValue = DB_NOVALUE  ) 

Definition at line 334 of file MetadataField.php.

MetadataField::UseWysiwygEditor ( NewValue = DB_NOVALUE  ) 

Definition at line 342 of file MetadataField.php.

MetadataField::Viewable ( NewValue = DB_NOVALUE  ) 

Definition at line 286 of file MetadataField.php.

MetadataField::ViewingPrivilege ( NewValue = DB_NOVALUE  ) 

Definition at line 348 of file MetadataField.php.

MetadataField::ViewingUserIsValue ( NewValue = DB_NOVALUE  ) 

Definition at line 360 of file MetadataField.php.

MetadataField::ViewingUserValue ( NewValue = DB_NOVALUE  ) 

Definition at line 366 of file MetadataField.php.


Member Data Documentation

MetadataField::$FieldTypeDBAllowedEnums [static]

MetadataField::$FieldTypeDBEnums [static]

MetadataField::$FieldTypePHPEnums [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 882 of file MetadataField.php.

Definition at line 17 of file MetadataField.php.

Definition at line 15 of file MetadataField.php.

Definition at line 19 of file MetadataField.php.

Definition at line 16 of file MetadataField.php.

Referenced by Resource::Resource().

Definition at line 18 of file MetadataField.php.

Definition at line 24 of file MetadataField.php.


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