CWIS Developer Documentation
|
Object representing a locally-defined type of metadata field. More...
Public Member Functions | |
Status () | |
Get current error status of object. More... | |
Type ($NewValue=DB_NOVALUE) | |
Get/set type of metadata field (enumerated value). More... | |
TypeAsName () | |
Get type of field as string. More... | |
IsControlledVocabularyField () | |
Check whether field is a type that uses controlled vocabularies. More... | |
SchemaId () | |
Get ID of schema for field. More... | |
GetDisplayName () | |
Get display name for field. More... | |
Name ($NewName=DB_NOVALUE) | |
Get/set name of field. More... | |
Label ($NewLabel=DB_NOVALUE) | |
Get/set label for field. More... | |
GetAllowedConversionTypes () | |
Get metadata field types that this field can be converted to. More... | |
IsTempItem ($NewSetting=NULL) | |
Get/set whether field is temporary instance. More... | |
AuthoringPrivileges ($NewValue=NULL) | |
Get/set privileges that allowing authoring values for this field. More... | |
EditingPrivileges ($NewValue=NULL) | |
Get/set privileges that allowing editing values for this field. More... | |
ViewingPrivileges ($NewValue=NULL) | |
Get/set privileges that allowing viewing values for this field. More... | |
PreviewingPrivileges ($NewValue=NULL) | |
Get/set privileges that allowing previewing values for this field. More... | |
Id () | |
Get metadata field ID. More... | |
DBFieldName () | |
Get base name of database column used to store metadata field value. More... | |
Description ($NewValue=DB_NOVALUE) | |
Get/set field description. More... | |
Instructions ($NewValue=DB_NOVALUE) | |
Get/set field instructions. More... | |
Owner ($NewValue=DB_NOVALUE) | |
Get/set field owner. More... | |
Enabled ($NewValue=DB_NOVALUE) | |
Get/set whether field is enabled. More... | |
Optional ($NewValue=DB_NOVALUE) | |
Get/set whether a value is required for this field. More... | |
Editable ($NewValue=DB_NOVALUE) | |
Get/set whether this field is editable. More... | |
AllowMultiple ($NewValue=DB_NOVALUE) | |
Get/set whether to allow multiple values for field. More... | |
IncludeInKeywordSearch ($NewValue=DB_NOVALUE) | |
Get/set whether to include field in keyword search. More... | |
IncludeInAdvancedSearch ($NewValue=DB_NOVALUE) | |
Get/set whether to include field in advanced search. More... | |
IncludeInFacetedSearch ($NewValue=DB_NOVALUE) | |
Get/set whether to include field in faceted search. More... | |
SearchGroupLogic ($NewValue=DB_NOVALUE) | |
Get/set the search group logic, used for both facets and advanced search when more than one value is selected for this field. More... | |
IncludeInSortOptions ($NewValue=DB_NOVALUE) | |
Get/set whether to include field in search result sort options. More... | |
IncludeInRecommender ($NewValue=DB_NOVALUE) | |
Get/set whether to include field in recommender system comparisons. More... | |
CopyOnResourceDuplication ($NewValue=DB_NOVALUE) | |
Get/set whether to duplciate this field when a resource is duplicated. More... | |
TextFieldSize ($NewValue=DB_NOVALUE) | |
Get/set the width of text fields. More... | |
MaxLength ($NewValue=DB_NOVALUE) | |
Get/set maximum length to store in a text field. More... | |
ParagraphRows ($NewValue=DB_NOVALUE) | |
Get/set the number of rows to display for a paragraph field. More... | |
ParagraphCols ($NewValue=DB_NOVALUE) | |
Get/set the number of columns to display for a paragraph field. More... | |
MinValue ($NewValue=DB_NOVALUE) | |
Get/set the minimum value allowed for a number field. More... | |
MaxValue ($NewValue=DB_NOVALUE) | |
Get/set the maximum allowed value for a number field. More... | |
FlagOnLabel ($NewValue=DB_NOVALUE) | |
Get/set the label displayed when a flag field is 'on'. More... | |
FlagOffLabel ($NewValue=DB_NOVALUE) | |
Get/set the label displayed when a flag field is 'off'. More... | |
DateFormat ($NewValue=DB_NOVALUE) | |
Get/set the date format. More... | |
SearchWeight ($NewValue=DB_NOVALUE) | |
Get/set the weight this field has for search results (higher weights have a larger impact). More... | |
RecommenderWeight ($NewValue=DB_NOVALUE) | |
Get/set the weight this field has for recommendations (higher weights have a larger impact). More... | |
MaxHeight ($NewValue=DB_NOVALUE) | |
Get/set the max width (in pixels) of images. More... | |
MaxWidth ($NewValue=DB_NOVALUE) | |
Get/set the max width (in pixels) of images. More... | |
MaxPreviewHeight ($NewValue=DB_NOVALUE) | |
Get/set the max height (in pixels) of thumbnail images. More... | |
MaxPreviewWidth ($NewValue=DB_NOVALUE) | |
Get/set the max width (in pixels) of thumbnail images. More... | |
MaxThumbnailHeight ($NewValue=DB_NOVALUE) | |
Get/set the max height (in pixels) of thumbnail images. More... | |
MaxThumbnailWidth ($NewValue=DB_NOVALUE) | |
Get/set the max width (in pixels) of thumbnail images. More... | |
DefaultAltText ($NewValue=DB_NOVALUE) | |
Get/set the default alt text for this field. More... | |
UsesQualifiers ($NewValue=DB_NOVALUE) | |
Get/set if this field uses qualifiers. More... | |
ShowQualifiers ($NewValue=DB_NOVALUE) | |
Get/set if this field should display qualifiers on EditResource. More... | |
DefaultQualifier ($NewValue=DB_NOVALUE) | |
Get/set the default qualifier for this field. More... | |
AllowHTML ($NewValue=DB_NOVALUE) | |
Get/set if this field should allow HTML. More... | |
UseWysiwygEditor ($NewValue=DB_NOVALUE) | |
Get/set if this field should enable WYSIWYG editing. More... | |
UseForOaiSets ($NewValue=DB_NOVALUE) | |
Get/set if this field should be used to create OAI sets. More... | |
DisplayAsListForAdvancedSearch ($NewValue=DB_NOVALUE) | |
Get/set if this field should be displayed as a list on the advanced search page. More... | |
MaxDepthForAdvancedSearch ($NewValue=DB_NOVALUE) | |
Get/set maximum depth of classifications to display in the list view on the AdvancedSearch page. More... | |
OptionListThreshold ($NewValue=DB_NOVALUE) | |
Get/set the number of results necessary to active option list menus. More... | |
AjaxThreshold ($NewValue=DB_NOVALUE) | |
Get/set the number of results necessary to activate the AJAX dropdown. More... | |
NumAjaxResults ($NewValue=DB_NOVALUE) | |
Get/set the maximum number of results to display in an AJAX dropdown. More... | |
RequiredBySPT ($NewValue=DB_NOVALUE) | |
Get/set 'RequiredBySPT'. More... | |
PointPrecision ($NewValue=DB_NOVALUE) | |
Get/set the current number of digits after the decimal point. More... | |
PointDecimalDigits ($NewValue=DB_NOVALUE) | |
Get/set the total number of digits a point field should store. More... | |
DefaultValue ($NewValue=DB_NOVALUE) | |
Get/set default value. More... | |
UpdateMethod ($NewValue=DB_NOVALUE) | |
Get/set method by which field is updated. More... | |
GetPossibleValues ($MaxNumberOfValues=NULL, $Offset=0) | |
get possible values (only meaningful for Trees, Controlled Names, Options, Flags, and Users) More... | |
GetCountOfPossibleValues () | |
Get count of possible values (only meaningful for Trees, Controlled Names, Options, and Users) More... | |
GetIdForValue ($Value) | |
Get ID for specified value (only meaningful for Trees / Controlled Names / Options) More... | |
GetValueForId ($Id) | |
Get value for specified ID (only meaningful for Trees / Controlled Names / Options) More... | |
ValueUseCount ($Value) | |
Check how many times a specific value is currently used for this field. More... | |
HasItemLevelQualifiers ($NewValue=DB_NOVALUE) | |
Get/set whether field uses item-level qualifiers. More... | |
AssociatedQualifierList () | |
Get list of qualifiers associated with field. More... | |
UnassociatedQualifierList () | |
Get list of qualifiers not associated with field. More... | |
AddQualifier ($Qualifier) | |
Associate qualifier with field. More... | |
UnassociateWithQualifier ($QualifierIdOrObject) | |
Delete a qualifier association. More... | |
GetFactory () | |
Retrieve item factory object for this field. More... | |
UserCanView ($User, $AllowHooksToModify=TRUE) | |
Determine if a user can view a specified field in the absence of a resource. More... | |
ReferenceableSchemaIds ($Ids=DB_NOVALUE) | |
Get/set the list of SchemaIds that provide allowable values for a reference field. More... | |
Duplicate () | |
Create duplicate of field. More... | |
__construct ($FieldId) | |
Object contstructor, used to load an existing metadata field. More... | |
SetDefaults () | |
Set defaults values for the field. More... | |
Drop () | |
Remove field from database (only for use by MetadataSchema object). More... | |
Viewable () | |
AssociateWithQualifier ($Qualifier) | |
UserPrivilegeRestrictions ($NewValue=DB_NOVALUE) | |
AuthoringUserIsValue ($NewValue=DB_NOVALUE) | |
EditingUserIsValue ($NewValue=DB_NOVALUE) | |
ViewingUserValue ($NewValue=DB_NOVALUE) | |
AuthoringUserValue ($NewValue=DB_NOVALUE) | |
EditingUserValue ($NewValue=DB_NOVALUE) | |
ViewingUserIsValue ($NewValue=DB_NOVALUE) | |
EnableOnOwnerReturn ($NewValue=DB_NOVALUE) | |
ViewingPrivilege ($NewValue=DB_NOVALUE) | |
AuthoringPrivilege ($NewValue=DB_NOVALUE) | |
EditingPrivilege ($NewValue=DB_NOVALUE) | |
ImagePreviewPrivilege ($NewValue=DB_NOVALUE) | |
TreeBrowsingPrivilege ($NewValue=DB_NOVALUE) | |
Static Public Member Functions | |
static | Create ($SchemaId, $FieldType, $FieldName, $Optional=NULL, $DefaultValue=NULL) |
Create a new metadata field. More... | |
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 | $FieldTypeHumanEnums |
A map of metadata field types to human-readable strings. More... | |
static | $FieldTypeDBEnums |
static | $FieldTypeDBAllowedEnums |
static | $FieldTypePHPEnums |
static | $UpdateTypes |
static | $FixedDefaults |
The metadata field defaults that are the same for all field types. More... | |
static | $TypeBasedDefaults |
The metadata field defaults that vary depending on the field type. More... | |
Object representing a locally-defined type of metadata field.
Definition at line 13 of file MetadataField.php.
MetadataField::__construct | ( | $FieldId | ) |
Object contstructor, used to load an existing metadata field.
To create new fields, use
int | $FieldId | ID of metadata field to load. |
Definition at line 1784 of file MetadataField.php.
References AuthoringPrivileges(), EditingPrivileges(), Id(), MetadataSchema\MDFSTAT_OK, PreviewingPrivileges(), and ViewingPrivileges().
MetadataField::AddQualifier | ( | $Qualifier | ) |
Associate qualifier with field.
mixed | $Qualifier | Qualifer ID, name, or object. |
InvalidArgumentException | If unknown name supplied. |
Definition at line 1410 of file MetadataField.php.
References Id().
Referenced by AssociateWithQualifier().
MetadataField::AjaxThreshold | ( | $NewValue = DB_NOVALUE | ) |
Get/set the number of results necessary to activate the AJAX dropdown.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 891 of file MetadataField.php.
MetadataField::AllowHTML | ( | $NewValue = DB_NOVALUE | ) |
Get/set if this field should allow HTML.
bool | $NewValue | Updated value (OPTIONAL). |
Definition at line 829 of file MetadataField.php.
MetadataField::AllowMultiple | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether to allow multiple values for field.
bool | $NewValue | TRUE to allow multiple values, or FALSE if only one value may be set. (OPTIONAL) |
Definition at line 518 of file MetadataField.php.
Referenced by DefaultValue().
MetadataField::AssociatedQualifierList | ( | ) |
Get list of qualifiers associated with field.
Definition at line 1367 of file MetadataField.php.
Referenced by UnassociatedQualifierList().
MetadataField::AssociateWithQualifier | ( | $Qualifier | ) |
Definition at line 2628 of file MetadataField.php.
References AddQualifier().
MetadataField::AuthoringPrivilege | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2707 of file MetadataField.php.
References AuthoringPrivileges(), and DB_NOVALUE.
MetadataField::AuthoringPrivileges | ( | $NewValue = NULL | ) |
Get/set privileges that allowing authoring values for this field.
object | $NewValue | New PrivilegeSet value. (OPTIONAL) |
Definition at line 359 of file MetadataField.php.
Referenced by __construct(), and AuthoringPrivilege().
MetadataField::AuthoringUserIsValue | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2658 of file MetadataField.php.
MetadataField::AuthoringUserValue | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2674 of file MetadataField.php.
MetadataField::CopyOnResourceDuplication | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether to duplciate this field when a resource is duplicated.
bool | $NewValue | Update setting. |
Definition at line 607 of file MetadataField.php.
|
static |
Create a new metadata field.
int | $SchemaId | ID of schema in which to place field. |
enum | $FieldType | Metadata field type. |
string | $FieldName | Name of metadata field. |
bool | $Optional | If FALSE, field must always have a value. (OPTIONAL, defaults to TRUE) |
mixed | $DefaultValue | Default value for field. |
InvalidArgumentException | When field type is invalid. |
InvalidArgumentException | When field name is duplicates name of another existing field. |
Definition at line 1673 of file MetadataField.php.
Referenced by MetadataSchema\AddField().
MetadataField::DateFormat | ( | $NewValue = DB_NOVALUE | ) |
Get/set the date format.
string | $NewValue | Updated value (OPTIONAL). |
Definition at line 697 of file MetadataField.php.
MetadataField::DBFieldName | ( | ) |
Get base name of database column used to store metadata field value.
(Only valid for some field types.)
Definition at line 444 of file MetadataField.php.
Referenced by Drop(), and HasItemLevelQualifiers().
MetadataField::DefaultAltText | ( | $NewValue = DB_NOVALUE | ) |
Get/set the default alt text for this field.
string | $NewValue | Updated value (OPTIONAL). |
Definition at line 789 of file MetadataField.php.
MetadataField::DefaultQualifier | ( | $NewValue = DB_NOVALUE | ) |
Get/set the default qualifier for this field.
mixed | $NewValue | Updated value (OPTIONAL). |
Definition at line 819 of file MetadataField.php.
MetadataField::DefaultValue | ( | $NewValue = DB_NOVALUE | ) |
Get/set default value.
mixed | $NewValue | Updated value (OPTIONAL). |
Definition at line 983 of file MetadataField.php.
References AllowMultiple(), DB_NOVALUE, MetadataSchema\MDFTYPE_OPTION, MetadataSchema\MDFTYPE_POINT, and Type().
Referenced by Drop().
MetadataField::Description | ( | $NewValue = DB_NOVALUE | ) |
Get/set field description.
string | $NewValue | Updated description. (OPTIONAL) |
Definition at line 454 of file MetadataField.php.
MetadataField::DisplayAsListForAdvancedSearch | ( | $NewValue = DB_NOVALUE | ) |
Get/set if this field should be displayed as a list on the advanced search page.
bool | $NewValue | Updated value (OPTIONAL). |
Definition at line 860 of file MetadataField.php.
MetadataField::Drop | ( | ) |
Remove field from database (only for use by MetadataSchema object).
Definition at line 2008 of file MetadataField.php.
References StdLib\CheckMyCaller(), DATEPRE_BEGINDAY, DATEPRE_BEGINMONTH, DB_NOVALUE, DBFieldName(), DefaultValue(), MetadataFieldOrder\GetOrdersForSchema(), 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_REFERENCE, MetadataSchema\MDFTYPE_TEXT, MetadataSchema\MDFTYPE_TIMESTAMP, MetadataSchema\MDFTYPE_TREE, MetadataSchema\MDFTYPE_URL, MetadataSchema\MDFTYPE_USER, SchemaId(), MetadataSchema\SCHEMAID_DEFAULT, and Type().
MetadataField::Duplicate | ( | ) |
Create duplicate of field.
The new field will be a temporary instance, so if it is to persist, IsTempItem() must be called on it with FALSE. The only difference between the original and the duplicate (other than their IDs and possibly the temporary status) is that the duplicate will have "(duplicate YYMMDD-HHMMSS)" appended to the field name.
Definition at line 1759 of file MetadataField.php.
References Id(), Name(), SchemaId(), and Type().
MetadataField::Editable | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether this field is editable.
bool | $NewValue | TRUE to indicate that field is editable, or FALSE to indicate it non-editable. (OPTIONAL) |
Definition at line 507 of file MetadataField.php.
MetadataField::EditingPrivilege | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2720 of file MetadataField.php.
References DB_NOVALUE, and EditingPrivileges().
MetadataField::EditingPrivileges | ( | $NewValue = NULL | ) |
Get/set privileges that allowing editing values for this field.
object | $NewValue | New PrivilegeSet value. (OPTIONAL) |
Definition at line 378 of file MetadataField.php.
Referenced by __construct(), and EditingPrivilege().
MetadataField::EditingUserIsValue | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2664 of file MetadataField.php.
MetadataField::EditingUserValue | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2679 of file MetadataField.php.
MetadataField::Enabled | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether field is enabled.
bool | $NewValue | TRUE to enable field, or FALSE to disable. (OPTIONAL) |
Definition at line 485 of file MetadataField.php.
Referenced by UserCanView().
MetadataField::EnableOnOwnerReturn | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2689 of file MetadataField.php.
MetadataField::FlagOffLabel | ( | $NewValue = DB_NOVALUE | ) |
Get/set the label displayed when a flag field is 'off'.
string | $NewValue | Updated value (OPTIONAL). |
Definition at line 687 of file MetadataField.php.
Referenced by GetPossibleValues().
MetadataField::FlagOnLabel | ( | $NewValue = DB_NOVALUE | ) |
Get/set the label displayed when a flag field is 'on'.
string | $NewValue | Updated value (OPTIONAL). |
Definition at line 677 of file MetadataField.php.
Referenced by GetPossibleValues().
MetadataField::GetAllowedConversionTypes | ( | ) |
Get metadata field types that this field can be converted to.
Definition at line 201 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_REFERENCE, MetadataSchema\MDFTYPE_TEXT, MetadataSchema\MDFTYPE_TIMESTAMP, MetadataSchema\MDFTYPE_TREE, MetadataSchema\MDFTYPE_URL, MetadataSchema\MDFTYPE_USER, and Type().
MetadataField::GetCountOfPossibleValues | ( | ) |
Get count of possible values (only meaningful for Trees, Controlled Names, Options, and Users)
Definition at line 1143 of file MetadataField.php.
References GetPossibleValues(), Id(), MetadataSchema\MDFTYPE_CONTROLLEDNAME, MetadataSchema\MDFTYPE_FLAG, MetadataSchema\MDFTYPE_OPTION, MetadataSchema\MDFTYPE_TREE, MetadataSchema\MDFTYPE_USER, and Type().
MetadataField::GetDisplayName | ( | ) |
Get display name for field.
Returns label if available, or field name if label is not set for field.
Definition at line 102 of file MetadataField.php.
MetadataField::GetFactory | ( | ) |
Retrieve item factory object for this field.
Definition at line 1470 of file MetadataField.php.
References Id(), MetadataSchema\MDFTYPE_CONTROLLEDNAME, MetadataSchema\MDFTYPE_OPTION, MetadataSchema\MDFTYPE_TREE, and Type().
MetadataField::GetIdForValue | ( | $Value | ) |
Get ID for specified value (only meaningful for Trees / Controlled Names / Options)
string | $Value | Value to search for. |
Definition at line 1184 of file MetadataField.php.
References Id(), MetadataSchema\MDFTYPE_CONTROLLEDNAME, MetadataSchema\MDFTYPE_OPTION, MetadataSchema\MDFTYPE_TREE, and Type().
MetadataField::GetPossibleValues | ( | $MaxNumberOfValues = NULL , |
|
$Offset = 0 |
|||
) |
get possible values (only meaningful for Trees, Controlled Names, Options, Flags, and Users)
integer | NULL | $MaxNumberOfValues | Maximum number of values to get. |
integer | $Offset | Offset into the list of values. |
Definition at line 1065 of file MetadataField.php.
References FlagOffLabel(), FlagOnLabel(), Id(), MetadataSchema\MDFTYPE_CONTROLLEDNAME, MetadataSchema\MDFTYPE_FLAG, MetadataSchema\MDFTYPE_OPTION, MetadataSchema\MDFTYPE_TREE, MetadataSchema\MDFTYPE_USER, Type(), and UserPrivilegeRestrictions().
Referenced by GetCountOfPossibleValues().
MetadataField::GetValueForId | ( | $Id | ) |
Get value for specified ID (only meaningful for Trees / Controlled Names / Options)
int | $Id | ItemId to search for. |
Definition at line 1219 of file MetadataField.php.
References Id(), MetadataSchema\MDFTYPE_CONTROLLEDNAME, MetadataSchema\MDFTYPE_OPTION, MetadataSchema\MDFTYPE_TREE, and Type().
MetadataField::HasItemLevelQualifiers | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether field uses item-level qualifiers.
mixed | $NewValue | Updated value (OPTIONAL). |
Definition at line 1327 of file MetadataField.php.
References DB_NOVALUE, and DBFieldName().
MetadataField::Id | ( | ) |
Get metadata field ID.
Definition at line 434 of file MetadataField.php.
Referenced by __construct(), AddQualifier(), Drop(), Duplicate(), GetCountOfPossibleValues(), GetFactory(), GetIdForValue(), GetPossibleValues(), GetValueForId(), IsTempItem(), PointDecimalDigits(), and PointPrecision().
MetadataField::ImagePreviewPrivilege | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2733 of file MetadataField.php.
References DB_NOVALUE, and ViewingPrivileges().
MetadataField::IncludeInAdvancedSearch | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether to include field in advanced search.
bool | $NewValue | TRUE to include field, or FALSE if field should not be included. (OPTIONAL) |
Definition at line 540 of file MetadataField.php.
MetadataField::IncludeInFacetedSearch | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether to include field in faceted search.
bool | $NewValue | TRUE to include field, or FALSE if field should not be included. (OPTIONAL) |
Definition at line 551 of file MetadataField.php.
MetadataField::IncludeInKeywordSearch | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether to include field in keyword search.
bool | $NewValue | TRUE to include field, or FALSE if field should not be included. (OPTIONAL) |
Definition at line 529 of file MetadataField.php.
MetadataField::IncludeInRecommender | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether to include field in recommender system comparisons.
bool | $NewValue | TRUE to include field, or FALSE if field should not be included. (OPTIONAL) |
Definition at line 597 of file MetadataField.php.
MetadataField::IncludeInSortOptions | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether to include field in search result sort options.
bool | $NewValue | TRUE to include field, or FALSE if field should not be included. (OPTIONAL) |
Definition at line 586 of file MetadataField.php.
MetadataField::Instructions | ( | $NewValue = DB_NOVALUE | ) |
Get/set field instructions.
string | $NewValue | Updated instructions. (OPTIONAL) |
Definition at line 464 of file MetadataField.php.
MetadataField::IsControlledVocabularyField | ( | ) |
Check whether field is a type that uses controlled vocabularies.
Definition at line 74 of file MetadataField.php.
References MetadataSchema\MDFTYPE_CONTROLLEDNAME, MetadataSchema\MDFTYPE_OPTION, MetadataSchema\MDFTYPE_TREE, and Type().
MetadataField::IsTempItem | ( | $NewSetting = NULL | ) |
Get/set whether field is temporary instance.
bool | $NewSetting | If TRUE, field is a temporary instance, or if FALSE, field is non-temporary. (OPTIONAL) |
Definition at line 263 of file MetadataField.php.
References Id(), MetadataSchema\MDFSTAT_ILLEGALNAME, Name(), and SchemaId().
MetadataField::Label | ( | $NewLabel = DB_NOVALUE | ) |
Get/set label for field.
string | $NewLabel | New label for field. (OPTIONAL) |
Definition at line 170 of file MetadataField.php.
References DB_NOVALUE, and MetadataSchema\MDFSTAT_ILLEGALLABEL.
Referenced by GetDisplayName().
MetadataField::MaxDepthForAdvancedSearch | ( | $NewValue = DB_NOVALUE | ) |
Get/set maximum depth of classifications to display in the list view on the AdvancedSearch page.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 871 of file MetadataField.php.
MetadataField::MaxHeight | ( | $NewValue = DB_NOVALUE | ) |
Get/set the max width (in pixels) of images.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 729 of file MetadataField.php.
MetadataField::MaxLength | ( | $NewValue = DB_NOVALUE | ) |
Get/set maximum length to store in a text field.
int | $NewValue | Updated value. |
Definition at line 627 of file MetadataField.php.
MetadataField::MaxPreviewHeight | ( | $NewValue = DB_NOVALUE | ) |
Get/set the max height (in pixels) of thumbnail images.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 749 of file MetadataField.php.
MetadataField::MaxPreviewWidth | ( | $NewValue = DB_NOVALUE | ) |
Get/set the max width (in pixels) of thumbnail images.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 759 of file MetadataField.php.
MetadataField::MaxThumbnailHeight | ( | $NewValue = DB_NOVALUE | ) |
Get/set the max height (in pixels) of thumbnail images.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 769 of file MetadataField.php.
MetadataField::MaxThumbnailWidth | ( | $NewValue = DB_NOVALUE | ) |
Get/set the max width (in pixels) of thumbnail images.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 779 of file MetadataField.php.
MetadataField::MaxValue | ( | $NewValue = DB_NOVALUE | ) |
Get/set the maximum allowed value for a number field.
float | $NewValue | Updated value (OPTIONAL). |
Definition at line 667 of file MetadataField.php.
MetadataField::MaxWidth | ( | $NewValue = DB_NOVALUE | ) |
Get/set the max width (in pixels) of images.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 739 of file MetadataField.php.
MetadataField::MinValue | ( | $NewValue = DB_NOVALUE | ) |
Get/set the minimum value allowed for a number field.
float | $NewValue | Updated value. |
Definition at line 657 of file MetadataField.php.
MetadataField::Name | ( | $NewName = DB_NOVALUE | ) |
Get/set name of field.
Field names are limited to alphanumerics, spaces, and parentheses.
string | $NewName | New field name. (OPTIONAL) |
Definition at line 113 of file MetadataField.php.
References DB_NOVALUE, MetadataSchema\MDFSTAT_DUPLICATENAME, MetadataSchema\MDFSTAT_ILLEGALNAME, and MetadataSchema\MDFSTAT_OK.
Referenced by Duplicate(), GetDisplayName(), IsTempItem(), and SetDefaults().
MetadataField::NumAjaxResults | ( | $NewValue = DB_NOVALUE | ) |
Get/set the maximum number of results to display in an AJAX dropdown.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 902 of file MetadataField.php.
MetadataField::Optional | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether a value is required for this field.
bool | $NewValue | TRUE to require a value, or FALSE to make entering a value optional. (OPTIONAL) |
Definition at line 496 of file MetadataField.php.
MetadataField::OptionListThreshold | ( | $NewValue = DB_NOVALUE | ) |
Get/set the number of results necessary to active option list menus.
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 881 of file MetadataField.php.
MetadataField::Owner | ( | $NewValue = DB_NOVALUE | ) |
Get/set field owner.
string | $NewValue | Updated owner. (OPTIONAL) |
Definition at line 474 of file MetadataField.php.
MetadataField::ParagraphCols | ( | $NewValue = DB_NOVALUE | ) |
Get/set the number of columns to display for a paragraph field.
int | $NewValue | Updated value. |
Definition at line 647 of file MetadataField.php.
MetadataField::ParagraphRows | ( | $NewValue = DB_NOVALUE | ) |
Get/set the number of rows to display for a paragraph field.
int | $NewValue | Updated value. |
Definition at line 637 of file MetadataField.php.
MetadataField::PointDecimalDigits | ( | $NewValue = DB_NOVALUE | ) |
Get/set the total number of digits a point field should store.
integer | $NewValue | Updated value (OPTIONAL). |
Definition at line 953 of file MetadataField.php.
References DB_NOVALUE, Id(), MetadataSchema\MDFTYPE_POINT, and Type().
MetadataField::PointPrecision | ( | $NewValue = DB_NOVALUE | ) |
Get/set the current number of digits after the decimal point.
integer | $NewValue | Updated value (OPTIONAL). |
Definition at line 924 of file MetadataField.php.
References DB_NOVALUE, Id(), MetadataSchema\MDFTYPE_POINT, and Type().
MetadataField::PreviewingPrivileges | ( | $NewValue = NULL | ) |
Get/set privileges that allowing previewing values for this field.
object | $NewValue | New PrivilegeSet value. (OPTIONAL) |
Definition at line 416 of file MetadataField.php.
Referenced by __construct().
MetadataField::RecommenderWeight | ( | $NewValue = DB_NOVALUE | ) |
Get/set the weight this field has for recommendations (higher weights have a larger impact).
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 719 of file MetadataField.php.
MetadataField::ReferenceableSchemaIds | ( | $Ids = DB_NOVALUE | ) |
Get/set the list of SchemaIds that provide allowable values for a reference field.
mixed | $Ids | SchemaId or array/ of SchemaIds that are allowed (OPTIONAL). |
Definition at line 1547 of file MetadataField.php.
References DB_NOVALUE.
MetadataField::RequiredBySPT | ( | $NewValue = DB_NOVALUE | ) |
Get/set 'RequiredBySPT'.
bool | $NewValue | Updated value (OPTIONAL). |
Definition at line 914 of file MetadataField.php.
MetadataField::SchemaId | ( | ) |
Get ID of schema for field.
Definition at line 92 of file MetadataField.php.
Referenced by Drop(), Duplicate(), IsTempItem(), and UserCanView().
MetadataField::SearchGroupLogic | ( | $NewValue = DB_NOVALUE | ) |
Get/set the search group logic, used for both facets and advanced search when more than one value is selected for this field.
bool | $NewValue | One of the SearchEngine::LOGIC_* consts |
Definition at line 563 of file MetadataField.php.
References DB_NOVALUE, SearchEngine\LOGIC_AND, and SearchEngine\LOGIC_OR.
MetadataField::SearchWeight | ( | $NewValue = DB_NOVALUE | ) |
Get/set the weight this field has for search results (higher weights have a larger impact).
int | $NewValue | Updated value (OPTIONAL). |
Definition at line 708 of file MetadataField.php.
MetadataField::SetDefaults | ( | ) |
Set defaults values for the field.
Definition at line 1983 of file MetadataField.php.
References Name(), Type(), and UpdateMethod().
MetadataField::ShowQualifiers | ( | $NewValue = DB_NOVALUE | ) |
Get/set if this field should display qualifiers on EditResource.
bool | $NewValue | Updated value (OPTIONAL). |
Definition at line 809 of file MetadataField.php.
MetadataField::Status | ( | ) |
Get current error status of object.
Definition at line 34 of file MetadataField.php.
MetadataField::TextFieldSize | ( | $NewValue = DB_NOVALUE | ) |
Get/set the width of text fields.
int | $NewValue | Updated value. |
Definition at line 617 of file MetadataField.php.
MetadataField::TreeBrowsingPrivilege | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2746 of file MetadataField.php.
References DB_NOVALUE, and ViewingPrivileges().
MetadataField::Type | ( | $NewValue = DB_NOVALUE | ) |
Get/set type of metadata field (enumerated value).
Types are MDFTYPE_ constants defined in the MetadataSchema class.
enum | $NewValue | New type for field. (OPTIONAL) |
Definition at line 45 of file MetadataField.php.
References DB_NOVALUE.
Referenced by DefaultValue(), Drop(), Duplicate(), GetAllowedConversionTypes(), GetCountOfPossibleValues(), GetFactory(), GetIdForValue(), GetPossibleValues(), GetValueForId(), IsControlledVocabularyField(), PointDecimalDigits(), PointPrecision(), SetDefaults(), and ValueUseCount().
MetadataField::TypeAsName | ( | ) |
Get type of field as string.
Definition at line 64 of file MetadataField.php.
MetadataField::UnassociatedQualifierList | ( | ) |
Get list of qualifiers not associated with field.
Definition at line 1392 of file MetadataField.php.
References AssociatedQualifierList().
MetadataField::UnassociateWithQualifier | ( | $QualifierIdOrObject | ) |
Delete a qualifier association.
mixed | $QualifierIdOrObject | Qualifier to remove from this field. |
Definition at line 1451 of file MetadataField.php.
MetadataField::UpdateMethod | ( | $NewValue = DB_NOVALUE | ) |
Get/set method by which field is updated.
string | $NewValue | New update method. |
Definition at line 1053 of file MetadataField.php.
Referenced by SetDefaults().
MetadataField::UseForOaiSets | ( | $NewValue = DB_NOVALUE | ) |
Get/set if this field should be used to create OAI sets.
bool | $NewValue | Updated value (OPTIONAL). |
Definition at line 849 of file MetadataField.php.
MetadataField::UserCanView | ( | $User, | |
$AllowHooksToModify = TRUE |
|||
) |
Determine if a user can view a specified field in the absence of a resource.
CWUser | $User | User to check. |
bool | $AllowHooksToModify | Should events should be signaled (OPTIONAL, default TRUE) |
Definition at line 1499 of file MetadataField.php.
References Enabled(), SchemaId(), and ViewingPrivileges().
Referenced by Viewable().
MetadataField::UserPrivilegeRestrictions | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2633 of file MetadataField.php.
References DB_NOVALUE.
Referenced by GetPossibleValues().
MetadataField::UsesQualifiers | ( | $NewValue = DB_NOVALUE | ) |
Get/set if this field uses qualifiers.
bool | $NewValue | Updated value (OPTIONAL). |
Definition at line 799 of file MetadataField.php.
MetadataField::UseWysiwygEditor | ( | $NewValue = DB_NOVALUE | ) |
Get/set if this field should enable WYSIWYG editing.
bool | $NewValue | Updated value (OPTIONAL). |
Definition at line 839 of file MetadataField.php.
MetadataField::ValueUseCount | ( | $Value | ) |
Check how many times a specific value is currently used for this field.
This method is not valid for Date fields.
mixed | $Value | Value to check. For Flag, Tree, Option, Image, and Controlled Name fields this must be an ID or an appropriate object. For Point fields this must be an associative array with two values with "X" and "Y" indexes. Date fields are not supported. For other field types, the literal value to check should be passed in. |
Definition at line 1259 of file MetadataField.php.
References MetadataSchema\MDFTYPE_CONTROLLEDNAME, 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, and Type().
MetadataField::Viewable | ( | ) |
Definition at line 2620 of file MetadataField.php.
References UserCanView().
MetadataField::ViewingPrivilege | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2694 of file MetadataField.php.
References DB_NOVALUE, and ViewingPrivileges().
MetadataField::ViewingPrivileges | ( | $NewValue = NULL | ) |
Get/set privileges that allowing viewing values for this field.
object | $NewValue | New PrivilegeSet value. (OPTIONAL) |
Definition at line 397 of file MetadataField.php.
Referenced by __construct(), ImagePreviewPrivilege(), TreeBrowsingPrivilege(), UserCanView(), and ViewingPrivilege().
MetadataField::ViewingUserIsValue | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2684 of file MetadataField.php.
MetadataField::ViewingUserValue | ( | $NewValue = DB_NOVALUE | ) |
Definition at line 2669 of file MetadataField.php.
|
static |
Definition at line 1617 of file MetadataField.php.
Referenced by MetadataSchema\GetAllowedFieldTypes().
|
static |
Definition at line 1600 of file MetadataField.php.
Referenced by MetadataSchema\GetFieldTypes(), and HumanMetadataField\Type().
|
static |
A map of metadata field types to human-readable strings.
Definition at line 1582 of file MetadataField.php.
|
static |
Definition at line 1634 of file MetadataField.php.
Referenced by MetadataSchema\GetFields().
|
static |
The metadata field defaults that are the same for all field types.
Definition at line 1844 of file MetadataField.php.
|
static |
The metadata field defaults that vary depending on the field type.
Definition at line 1896 of file MetadataField.php.
|
static |
Definition at line 1652 of file MetadataField.php.
Referenced by HumanMetadataField\UpdateMethod().
const MetadataField::UPDATEMETHOD_BUTTON = "Button" |
Definition at line 20 of file MetadataField.php.
const MetadataField::UPDATEMETHOD_NOAUTOUPDATE = "NoAutoUpdate" |
Definition at line 18 of file MetadataField.php.
const MetadataField::UPDATEMETHOD_ONRECORDCHANGE = "OnRecordChange" |
Definition at line 22 of file MetadataField.php.
const MetadataField::UPDATEMETHOD_ONRECORDCREATE = "OnRecordCreate" |
Definition at line 19 of file MetadataField.php.
Referenced by Resource\Create().
const MetadataField::UPDATEMETHOD_ONRECORDEDIT = "OnRecordEdit" |
Definition at line 21 of file MetadataField.php.
Referenced by CWUserFactory\CreateNewUser().
const MetadataField::USERISVALUE_AND = 1 |
Definition at line 27 of file MetadataField.php.
const MetadataField::USERISVALUE_OR = -1 |
Definition at line 25 of file MetadataField.php.
const MetadataField::USERISVALUE_UNSET = 0 |
Definition at line 26 of file MetadataField.php.