MetadataSchema Class Reference

Inheritance diagram for MetadataSchema:

Inheritance graph
[legend]
Collaboration diagram for MetadataSchema:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MetadataSchema ()
 CacheData ($NewValue)
 AddField ($FieldName, $FieldType, $Optional=TRUE, $DefaultValue=NULL)
 DropField ($FieldId)
 GetField ($FieldId)
 GetFieldByName ($FieldName, $IgnoreCase=FALSE)
 Retrieve metadata field by name.
 GetFieldIdByName ($FieldName, $IgnoreCase=FALSE)
 Retrieve metadata field ID by name.
 FieldExists ($FieldName)
 GetFields ($FieldTypes=NULL, $OrderType=NULL, $IncludeDisabledFields=FALSE, $IncludeTempFields=FALSE)
 CompareFieldOrder ($FieldA, $FieldB)
 GetFieldNames ($FieldTypes=NULL, $OrderType=NULL, $IncludeDisabledFields=FALSE, $IncludeTempFields=FALSE)
 GetFieldsAsOptionList ($OptionListName, $FieldTypes=NULL, $SelectedFieldId=NULL, $IncludeNullOption=TRUE, $AddEntries=NULL)
 Retrieve fields of specified type as HTML option list with field names as labels and field IDs as value attributes.
 GetFieldTypes ()
 GetAllowedFieldTypes ()
 RemoveQualifierAssociations ($QualifierIdOrObject)
 QualifierIsInUse ($QualifierIdOrObject)
 MoveUpInOrder ($FieldIdOrObj, $OrderType)
 MoveDownInOrder ($FieldIdOrObj, $OrderType)
 GetHighestFieldId ()
 GetFieldByMappedName ($MappedName)
 Get field by standard field name.

Static Public Member Functions

static StdNameToFieldMapping ($MappedName, $FieldId=NULL)
 Get/set mapping of standard field name to specific field.
static FieldToStdNameMapping ($FieldId)
 Get mapping of field ID to standard field name.

Public Attributes

const MDFORDER_DISPLAY = 1
const MDFORDER_EDITING = 2
const MDFORDER_ALPHABETICAL = 3
const MDFTYPE_TEXT = 1
const MDFTYPE_PARAGRAPH = 2
const MDFTYPE_NUMBER = 4
const MDFTYPE_DATE = 8
const MDFTYPE_TIMESTAMP = 16
const MDFTYPE_FLAG = 32
const MDFTYPE_TREE = 64
const MDFTYPE_CONTROLLEDNAME = 128
const MDFTYPE_OPTION = 256
const MDFTYPE_USER = 512
const MDFTYPE_IMAGE = 1024
const MDFTYPE_FILE = 2048
const MDFTYPE_URL = 4096
const MDFTYPE_POINT = 8192
const MDFSTAT_OK = 1
const MDFSTAT_DUPLICATENAME = 2
const MDFSTAT_DUPLICATEDBCOLUMN = 4
const MDFSTAT_ILLEGALNAME = 8
const MDFSTAT_FIELDDOESNOTEXIST = 16

Detailed Description

Definition at line 9 of file MetadataSchema.php.


Member Function Documentation

MetadataSchema::AddField ( FieldName,
FieldType,
Optional = TRUE,
DefaultValue = NULL 
)

Definition at line 61 of file MetadataSchema.php.

References MDFSTAT_OK, and ItemFactory::Status().

MetadataSchema::CacheData ( NewValue  ) 

Definition at line 55 of file MetadataSchema.php.

MetadataSchema::CompareFieldOrder ( FieldA,
FieldB 
)

Definition at line 204 of file MetadataSchema.php.

References MDFORDER_ALPHABETICAL.

MetadataSchema::DropField ( FieldId  ) 

Definition at line 78 of file MetadataSchema.php.

References ItemFactory::$FieldId.

MetadataSchema::FieldExists ( FieldName  ) 

Definition at line 138 of file MetadataSchema.php.

References ItemFactory::NameIsInUse().

static MetadataSchema::FieldToStdNameMapping ( FieldId  )  [static]

Get mapping of field ID to standard field name.

Parameters:
FieldId Field ID.
Returns:
Standard field name to which specified field is mapped, or NULL if field is not currently mapped.

Definition at line 378 of file MetadataSchema.php.

References ItemFactory::$FieldId.

MetadataSchema::GetAllowedFieldTypes (  ) 

Definition at line 304 of file MetadataSchema.php.

References MetadataField::$FieldTypeDBAllowedEnums.

MetadataSchema::GetField ( FieldId  ) 

Definition at line 85 of file MetadataSchema.php.

References ItemFactory::$FieldId.

Referenced by GetFieldByMappedName(), and GetFieldByName().

Here is the caller graph for this function:

MetadataSchema::GetFieldByMappedName ( MappedName  ) 

Get field by standard field name.

Parameters:
MappedName Standard field name.
Returns:
MetadataField to which standard field name is mapped or NULL if specified standard field name is not currently mapped or mapped field does not exist.

Definition at line 400 of file MetadataSchema.php.

References GetField(), and StdNameToFieldMapping().

MetadataSchema::GetFieldByName ( FieldName,
IgnoreCase = FALSE 
)

Retrieve metadata field by name.

Parameters:
FieldName Field name.
IgnoreCase If TRUE, case is ignore when matching field names.
Returns:
Requested MetadataField or NULL if no field found with specified name.

Definition at line 106 of file MetadataSchema.php.

References ItemFactory::$FieldId, GetField(), and GetFieldIdByName().

MetadataSchema::GetFieldIdByName ( FieldName,
IgnoreCase = FALSE 
)

Retrieve metadata field ID by name.

Parameters:
FieldName Field name.
IgnoreCase If TRUE, case is ignore when matching field names.
Returns:
ID of requested MetadataField or FALSE if no field found with specified name.

Definition at line 119 of file MetadataSchema.php.

Referenced by GetFieldByName().

Here is the caller graph for this function:

MetadataSchema::GetFieldNames ( FieldTypes = NULL,
OrderType = NULL,
IncludeDisabledFields = FALSE,
IncludeTempFields = FALSE 
)

Definition at line 226 of file MetadataSchema.php.

References ItemFactory::$DB, and GetFields().

Referenced by GetFieldsAsOptionList().

Here is the caller graph for this function:

MetadataSchema::GetFields ( FieldTypes = NULL,
OrderType = NULL,
IncludeDisabledFields = FALSE,
IncludeTempFields = FALSE 
)

Definition at line 141 of file MetadataSchema.php.

References MetadataField::$FieldTypePHPEnums.

Referenced by GetFieldNames().

Here is the caller graph for this function:

MetadataSchema::GetFieldsAsOptionList ( OptionListName,
FieldTypes = NULL,
SelectedFieldId = NULL,
IncludeNullOption = TRUE,
AddEntries = NULL 
)

Retrieve fields of specified type as HTML option list with field names as labels and field IDs as value attributes.

The first element on the list will have a label of "--" and an ID of -1 to indicate no field selected.

Parameters:
OptionListName Value of option list "name" and "id" attributes.
FieldTypes Types of fields to return. (OPTIONAL - use NULL for all types)
SelectedFieldId ID of currently-selected field. (OPTIONAL)
IncludeNullOption Whether to include "no selection" (-1) option. (OPTIONAL - defaults to TRUE)
AddEntries An array of additional entries to include at the end of the option list, with option list values for the indexes and option list labels for the values. (OPTIONAL)
Returns:
HTML for option list.

Definition at line 257 of file MetadataSchema.php.

References GetFieldNames().

MetadataSchema::GetFieldTypes (  ) 

Definition at line 298 of file MetadataSchema.php.

References MetadataField::$FieldTypeDBEnums.

MetadataSchema::GetHighestFieldId (  ) 

Definition at line 353 of file MetadataSchema.php.

References ItemFactory::GetHighestItemId().

MetadataSchema::MetadataSchema (  ) 

Definition at line 44 of file MetadataSchema.php.

References ItemFactory::ItemFactory().

MetadataSchema::MoveDownInOrder ( FieldIdOrObj,
OrderType 
)

Definition at line 347 of file MetadataSchema.php.

MetadataSchema::MoveUpInOrder ( FieldIdOrObj,
OrderType 
)

Definition at line 343 of file MetadataSchema.php.

MetadataSchema::QualifierIsInUse ( QualifierIdOrObject  ) 

Definition at line 322 of file MetadataSchema.php.

MetadataSchema::RemoveQualifierAssociations ( QualifierIdOrObject  ) 

Definition at line 310 of file MetadataSchema.php.

static MetadataSchema::StdNameToFieldMapping ( MappedName,
FieldId = NULL 
) [static]

Get/set mapping of standard field name to specific field.

Parameters:
MappedName Standard field name.
FieldId ID of field to map to. (OPTIONAL)
Returns:
ID of field to which standard field name is mapped or NULL if specified standard field name is not currently mapped.

Definition at line 362 of file MetadataSchema.php.

References ItemFactory::$FieldId.

Referenced by GetFieldByMappedName().

Here is the caller graph for this function:


Member Data Documentation

Definition at line 16 of file MetadataSchema.php.

Referenced by CompareFieldOrder().

Definition at line 39 of file MetadataSchema.php.

Definition at line 38 of file MetadataSchema.php.

Referenced by MetadataField::MetadataField(), and MetadataField::Name().

Definition at line 41 of file MetadataSchema.php.

Referenced by MetadataField::MetadataField().

Definition at line 40 of file MetadataSchema.php.

Referenced by MetadataField::IsTempItem(), and MetadataField::Name().


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