ContactWebFormsUtil Class Reference

Static Public Member Functions
static	getAllAttributes ()
static	getPlacedAttributes (ContactWebForm $contactWebForm)
static	getNonPlacedAttributes (ContactWebForm $contactWebForm)
static	resolvePlacedAttributesForWebFormAttributesElement (ContactWebForm $contactWebForm, $model)
static	resolvePlacedAttributeByName ($webFormAttributeForm, $model, $attributeName, $attributeData)
static	getEmbedScript ($id)
static	resolveWebFormAttributes ($contactWebFormAttributes)
static	getCustomDisplayLabels (ContactWebForm $contactWebForm)
static	getCustomRequiredFields (ContactWebForm $contactWebForm)
static	resolveWebFormWithAllRequiredAttributes ($contactWebFormAttributes, $allAttributes=array())
static	excludeHiddenAttributes (ContactWebForm $contactWebForm, $resolvedWebFormAttributes=array())
static	resolveHiddenAttributesForContactModel ($postVariableName, ContactWebForm $contactWebForm)
static	resolveHiddenAttributesForContactWebFormEntryModel ($webFormEntryAttributes=array(), ContactWebForm $contactWebForm)
static	renderHiddenAttributeElement ($model, $attributeName, $form, $elementType, $params)
static	getPlacedAttributeContent ($attributeData)
static	sanitizeHiddenAttributeValue ($attributeName, $value)
static	getResolvedModuleIdForContactWebFormEntry (Contact $contact)
Static Public Attributes
static	$restrictHiddenControlAttributes

---

Detailed Description

Helper class with functions to assist in working with ContactWebForms module

Definition at line 40 of file ContactWebFormsUtil.php.

---

Member Function Documentation

static getAllAttributes

(

)

[static]

Get list of all index and derived attributes that can be placed on any web form

Returns:

array of all attributes

Definition at line 54 of file ContactWebFormsUtil.php.

static getPlacedAttributes

(

ContactWebForm $

contactWebForm

)

[static]

Parameters:

ContactWebForm

$contactWebForm

Returns:

array of placed attributes on given web form

Definition at line 75 of file ContactWebFormsUtil.php.

static getNonPlacedAttributes

(

ContactWebForm $

contactWebForm

)

[static]

Parameters:

ContactWebForm

$contactWebForm

Returns:

array of attributes that are not placed on given web form

Definition at line 99 of file ContactWebFormsUtil.php.

static resolvePlacedAttributesForWebFormAttributesElement	(	ContactWebForm $	contactWebForm,
		$	model
	)			[static]

Parameters:

	ContactWebForm	$contactWebForm
	$model

Returns:

array of formulated placed attributes, used by SortableContactWebFormAttributesElement

Definition at line 120 of file ContactWebFormsUtil.php.

static resolvePlacedAttributeByName	(	$	webFormAttributeForm,
		$	model,
		$	attributeName,
		$	attributeData
	)			[static]

Parameters:

	$webFormAttributeForm
	$model
	$attributeName
	$attributeData

Returns:

array

Definition at line 153 of file ContactWebFormsUtil.php.

static getEmbedScript

(

$

id

)

[static]

Parameters:

integer

$id

Returns:

string

Definition at line 227 of file ContactWebFormsUtil.php.

static resolveWebFormAttributes

(

$

contactWebFormAttributes

)

[static]

Parameters:

$contactWebFormAttributes

Returns:

array of placed attributes' name

Definition at line 241 of file ContactWebFormsUtil.php.

static getCustomDisplayLabels

(

ContactWebForm $

contactWebForm

)

[static]

Parameters:

ContactWebForm

$contactWebForm

Returns:

array of placed attributes having custom labels

Definition at line 257 of file ContactWebFormsUtil.php.

static getCustomRequiredFields

(

ContactWebForm $

contactWebForm

)

[static]

Parameters:

ContactWebForm

$contactWebForm

Returns:

array of rules for custom required attributes

Definition at line 279 of file ContactWebFormsUtil.php.

static resolveWebFormWithAllRequiredAttributes	(	$	contactWebFormAttributes,
		$	allAttributes = array()
	)			[static]

Parameters:

	$contactWebFormAttributes
	array	$allAttributes

Returns:

array of required attributes - custom field required attributes and custom required attributes

Definition at line 301 of file ContactWebFormsUtil.php.

static excludeHiddenAttributes	(	ContactWebForm $	contactWebForm,
		$	resolvedWebFormAttributes = array()
	)			[static]

Parameters:

	$contactWebForm
	array	$resolvedWebFormAttributes

Returns:

array of web form attributes, excluding custom hidden attributes

Definition at line 323 of file ContactWebFormsUtil.php.

static resolveHiddenAttributesForContactModel	(	$	postVariableName,
		ContactWebForm $	contactWebForm
	)			[static]

Parameters:

	$postVariableName
	$contactWebForm

Definition at line 354 of file ContactWebFormsUtil.php.

static resolveHiddenAttributesForContactWebFormEntryModel	(	$	webFormEntryAttributes = array(),
		ContactWebForm $	contactWebForm
	)			[static]

Parameters:

	array	$webFormEntryAttributes
	$contactWebForm

Returns:

array of resolved web form attributes, for web form entry model

Definition at line 382 of file ContactWebFormsUtil.php.

static renderHiddenAttributeElement	(	$	model,
		$	attributeName,
		$	form,
		$	elementType,
		$	params
	)			[static]

Parameters:

	$model
	$attributeName
	$form
	$elementType
	$params

Returns:

mixed

Definition at line 405 of file ContactWebFormsUtil.php.

static getPlacedAttributeContent

(

$

attributeData

)

[static]

Parameters:

$attributeData

Returns:

string

Definition at line 429 of file ContactWebFormsUtil.php.

static sanitizeHiddenAttributeValue	(	$	attributeName,
		$	value
	)			[static]

Parameters:

	$attributeName
	$value

Returns:

string

Definition at line 457 of file ContactWebFormsUtil.php.

---

Field Documentation

$restrictHiddenControlAttributes [static]

Initial value:

 array('Address',
                                                               'EmailAddressInformation',
                                                               'MultiSelectDropDown',
                                                               'CurrencyValue',
                                                               'DropDownDependency',
                                                               'CalculatedNumber',
                                                               'TagCloud')

Definition at line 42 of file ContactWebFormsUtil.php.

---

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

• /home/apizurmo/zurmo/app/protected/modules/contactWebForms/utils/ContactWebFormsUtil.php