Class: CustomFieldInterface_1_0

Source Location: /modules/customfield/classes/CustomFieldInterface_1_0.class

Class CustomFieldInterface_1_0

Class Overview

This is an interface for the custom field module. Modules that wish to create custom fields or set field values can utilize an implementation of this interface.

Located in /modules/customfield/classes/CustomFieldInterface_1_0.class [line 37]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
CustomFieldHelper	A helper class for the Custom Field module.

[ Top ]

Method Summary

array	createCustomFields()	Create new custom fields
GalleryStatus	setCustomFieldValues()	Set custom field values for an item; overwrites all existing field values.

[ Top ]

Methods

createCustomFields [line 47]

array createCustomFields(
array
$fieldNames, [int
$containerId = 0] 
)

Create new custom fields

Parameters:

array	$fieldNames:	of string field names
int	$containerId:	id of container; for album-specific settings

API Tags:

Return:

GalleryStatus a status code, array(string duplicate field names)

Redefined in descendants as:

CustomFieldHelper::createCustomFields()

[ Top ]

setCustomFieldValues [line 58]

GalleryStatus setCustomFieldValues(
int
$itemId, array
$data 
)

Set custom field values for an item; overwrites all existing field values.

Parameters:

int	$itemId:
array	$data:	field values

API Tags:

Return:

a status code

Redefined in descendants as:

CustomFieldHelper::setCustomFieldValues()

[ Top ]

Documentation generated on Sat, 21 Nov 2009 04:34:41 -0800 by phpDocumentor 1.3.0RC6

	CustomField Classes

[ class tree: CustomField ] [ index: CustomField ] [ all elements ]