PFFormField Class Reference

Public Member Functions
	getTemplateField ()
	setTemplateField ( $templateField)
	getInputType ()
	setInputType ( $inputType)
	hasFieldArg ( $key)
	getFieldArgs ()
	getFieldArg ( $key)
	setFieldArg ( $key, $value)
	getDefaultValue ()
	isMandatory ()
	setIsMandatory ( $isMandatory)
	isHidden ()
	setIsHidden ( $isHidden)
	isRestricted ()
	setIsRestricted ( $isRestricted)
	holdsTemplate ()
	isList ()
	getPossibleValues ()
	getUseDisplayTitle ()
	getInputName ()
	getLabel ()
	isDisabled ()
	setDescriptionArg ( $key, $value)
	getCurrentValue ( $template_instance_query_values, $form_submitted, $source_is_page, $all_instances_printed)
	setMappedValues ( $mappingType)
	setValuesWithMappingTemplate ()
	setValuesWithMappingProperty ()
	setValuesWithMappingCargoField ()
	labelToValue ( $label)
	valueStringToLabels ( $valueString, $delimiter)
	additionalHTMLForInput ( $cur_value, $field_name, $template_name)
	createMarkup ( $part_of_multiple, $is_last_field_in_template)
	getArgumentsForInputCallSMW (array &$other_args)
	getArgumentsForInputCallCargo (array &$other_args)
	getArgumentsForInputCall (array $default_args=null)

Static Public Member Functions
static	create (PFTemplateField $template_field)
static	newFromFormFieldTag ( $tag_components, $template, $template_in_form, $form_is_disabled)

Public Attributes
	$template_field

Detailed Description

This class is distinct from PFTemplateField in that it represents a template field defined in a form definition - it contains an PFTemplateField object within it (the $template_field variable), along with the other properties for that field that are set within the form.

Member Function Documentation

create()

static PFFormField::create ( PFTemplateField  $template_field )

static

Parameters

PFTemplateField

$template_field

Returns

self

getArgumentsForInputCall()

PFFormField::getArgumentsForInputCall

(

array

$default_args = null

)

Since Semantic Forms uses a hook system for the functions that create HTML inputs, most arguments are contained in the "$other_args" array - create this array, using the attributes of this form field and the template field it corresponds to, if any.

Parameters

array | null

$default_args

Returns

array

getTemplateField()

PFFormField::getTemplateField

(

)

Returns

PFTemplateField

labelToValue()

PFFormField::labelToValue

(

$label

)

Map a label back to a value.

Parameters

string

$label

Returns

string

setTemplateField()

PFFormField::setTemplateField

(

$templateField

)

Parameters

PFTemplateField

$templateField

setValuesWithMappingCargoField()

PFFormField::setValuesWithMappingCargoField

(

)

Helper function to get an array of labels from an array of values given a mapping Cargo table/field.

setValuesWithMappingProperty()

PFFormField::setValuesWithMappingProperty

(

)

Helper function to get an array of labels from an array of values given a mapping property.

setValuesWithMappingTemplate()

PFFormField::setValuesWithMappingTemplate

(

)

Helper function to get an array of labels from an array of values given a mapping template.

valueStringToLabels()

PFFormField::valueStringToLabels	(		$valueString,
			$delimiter
	)

Map a template field value into labels.

Parameters

string	$valueString
string	$delimiter

Returns

string|string[]

---

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

• PF_FormField.php