Form_Submission Class Reference

Inheritance diagram for Form_Submission:

Public Member Functions
	Form_Submission ($assetid=0)
	canCloneLink ()
	getAnswer ($id)
	getExtraData ($id)
	getName ($id)
	setAnswer ($id, $value)
	setExtraData ($id, Array $data=NULL)
	setError ($error)
	getErrors ()
	flushErrors ()
	isError ()
	getAnswers ()
	setSummary ($question_id, $name, $value)
	getSummary ($q_id=NULL, $value='answer')
	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)
	incrementVersion ($number='micro', $update_parents=TRUE)
	printFrontend ()
	printBody ()
	getKeywordReplacement ($keyword)
	getAvailableKeywords ()
	getIP ()
	setIP ($ip)
	getSubmissionIpAddressKeywordReplacement ()
	_getAllowedLinks ()
Public Member Functions inherited from Asset
	Asset ($assetid=0)
	create (Array &$link)
	load ($assetid)
	_loadDataPaths ()
	reload ()
	canDelete ()
	delete ($release_lock=TRUE, $check_locked=TRUE)
	useSystemVersion ()
	loadSystemVersion ()
	saveSystemVersion ()
	clearSystemVersion ()
	revertToSystemVersion ()
	revertNoticeLinksToSystemVersion ()
	_updated ($update_parents=TRUE)
	type ()
	getTypeAncestors ($include_asset=TRUE)
	incrementVersion ($number='micro', $update_parents=TRUE)
	getLanguages ()
	setLanguages (Array $languages)
	setCharset ($charset)
	setForceSecure ($force_secure)
	remapAssetids (Array $map)
	morph ($new_type_code)
	_morphCleanup ($new_type_code)
	onRequestKeywords (Asset $broadcaster, Array $vars=Array())
	canClone ()
	cloneComponents (Asset $clone, Array $components, $override=FALSE)
	cloneComponentsAdditional (Asset $clone, Array $components)
	cloneLinks (Asset $clone)
	getStatus ()
	getAvailableStatii ()
	getStatusDescription ()
	processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)
	setDate ($date_type, $time=NULL, $userid=NULL)
	lockTypes ()
	canForceablyAcquireLock ($lock_type)
	getEditingLocks ($keywords)
	_getAllowedLinks ()
	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)
	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	canCreateLink (Asset $minor, $link_type, $exclusive)
	canMoveLink (Asset $minor, Asset $old_major, $link_type)
	describeLink ($linkid)
	isDeletableLink ($linkid)
	canDeleteLink ($linkid)
	deleteLink ($linkid, $check_locked=TRUE)
	linksUpdated ()
	canCloneLink ()
	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)
	setAttrValue ($name, $value)
	attr ($name)
&	attrByRef ($name)
	getAttribute ($name, $mute_errors=FALSE)
	getAssetKeywords ($descriptions=FALSE)
	getAvailableKeywords ()
	getKeywordReplacement ($keyword)
	getAssetWebPathKeywordReplacement ()
	getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)
	processCustomKeywords ($keywords=Array())
	getContent ()
	setContent ()
	getEffectiveLastUpdatedTime ($assetids)
	readAccess (Array $assetids=Array())
	writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)
	adminAccess ($lock_type='', Array $assetids=Array())
	backendAccess ()
	liveEditAccess ($lock_type)
	canliveEdit ($lock_type)
	effectiveUnrestricted ()
	checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)
	accessEffective ()
	permissionsUpdated ()
	printFrontend ()
	printFrontendAsset (Asset $asset, $design=NULL)
	getValidProtocols ()
	printHead ()
	printBody ()
	getCurrentPaintLayoutName ()
	getCurrentDesignName ()
	printBodyWithPaintLayout ($layout_id='')
	initLimbo ()
	printLimbo ()
	paintBackend (Backend_Outputter $o)
	getPrefix ()
	processBackend (Backend_Outputter $o, Array &$link)
	getEI ()
	getEditFns ()
	getBackendHref ($screen='', $backend_page=TRUE)
	getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)
	getURLs ()
	getHref ($base_url=NULL, $ignore_rollback=FALSE)
	getWebDataPath ()
	getWebPaths ()
	saveWebPaths ($paths, $auto_add_remaps=TRUE)
	getLookups ($field='')
	getDesignLookups ()
	getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)
	deleteLookupValue ($layout_name, $layout_value)
	setPaintLayouts ($layouts)
	updateLookups ($auto_add_remaps=TRUE)
	setLookupValues (Array $values)
	getAssetStatusDescriptionKeywordReplacement ()
	getAssetStatusColourKeywordReplacement ()
	replaceKeywordsInString ($string)
	fastTrack ($tasks)
	unFastTrack ($tasks)
	shouldFastTrack ($task, $assetid=NULL)
	getFaskTrackedTaskAssetids ($task)
	getDependantParentsURL ()
Public Member Functions inherited from MySource_Object
	MySource_Object ()
	__sleep ()
	__wakeup ()

Additional Inherited Members
Data Fields inherited from Asset
	$id = 0
	$version = ''
	$name = ''
	$short_name = ''
	$status
	$languages = ''
	$charset = ''
	$force_secure = '0'
	$created
	$created_userid
	$updated
	$updated_userid
	$published
	$published_userid
	$status_changed
	$status_changed_userid
	$_is_cacheable = FALSE
	$vars = Array()
	$_available_keywords = Array()
	$data_path_suffix = ''
	$data_path = ''
	$data_path_public = ''
	$_ser_attrs = FALSE
Protected Member Functions inherited from Asset
	_preCreateCheck (Array &$link)
	_createAdditional (Array &$link)
	_abortCreate ($trigger_level_changed=FALSE, $linkid=0)
	_loadVars ()
	_getName ($short_name=FALSE, $contextid=NULL)
	_getKeywordReplacement ($keyword)
	_checkPermissionAccess ($perm, $assetids=Array(), $only_workflow=TRUE)
	makeAndSaveInitialWebPath ($path, $parent_link=NULL)

Detailed Description

Definition at line 31 of file form_submission.inc.

Member Function Documentation

_getAllowedLinks

(

)

Returns an array of all the permitted link type, the type asset and the cardinality

Returns

array private

See Also

Asset::_getAllowLinks()

Definition at line 611 of file form_submission.inc.

canCloneLink

(

)

Return TRUE if this link can be cloned

Returns

boolean public

Definition at line 55 of file form_submission.inc.

flushErrors

(

)

flush the errors in the store

Returns

boolean public

Definition at line 214 of file form_submission.inc.

Form_Submission

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 41 of file form_submission.inc.

getAnswer

(

$id

)

returns the answer of an question

Parameters

int

$id

the id of the question

Returns

mixed boolean|string public

Definition at line 70 of file form_submission.inc.

getAnswers

(

)

returns the answers for question in the form:

Returns

array public

Definition at line 249 of file form_submission.inc.

getAvailableKeywords

(

)

Return the keywords for this asset type.

This function is called in asset-listing situations like the asset listing, search page etc The return value is in the form:

Array(
  'name' => 'description' => 'the asset name',
);

Returns

array public

Definition at line 540 of file form_submission.inc.

getErrors

(

)

get the form errors from the store

Returns

array public

Definition at line 200 of file form_submission.inc.

getExtraData

(

$id

)

returns the Extra Data of an question - returns an empty array if not exist

Parameters

int

$id

the id of the question

Returns

Array public

Definition at line 89 of file form_submission.inc.

getIP

(

)

returns the IP of a submission

Returns

mixed boolean|string public

Definition at line 558 of file form_submission.inc.

getKeywordReplacement

(

$keyword

)

Get bodycopy keyword replacement

Provides a mechanism for providing keyword replacement functions by looking up the function named 'getKeywordNameKeywordReplacement' so an asset wishing to add support for 'best_ever' custom keyword should implement a function getBestEverKeywordReplacement() which returns a replacement string

Parameters

string

$keyword

Keyword to find a replacement for

Returns

string public

Definition at line 440 of file form_submission.inc.

getName

(

$id

)

returns the name of an question

Parameters

int

$id

the id of the question

Returns

string public

Definition at line 108 of file form_submission.inc.

getSubmissionIpAddressKeywordReplacement

(

)

Get the IP of the submission

Returns

string public

Definition at line 597 of file form_submission.inc.

getSummary	(		$q_id = NULL,
			$value = 'answer'
	)

returns an Array with summary information

Parameters

int	$q_id	Question id
string	$value	Value

Returns

array public

Definition at line 294 of file form_submission.inc.

incrementVersion	(		$number = 'micro',
			$update_parents = TRUE
	)

Increments the version number of the asset based on the part of the version passed in

This will override incrementVersion() so the parents of form submissions never get version increases linked to stuff that form submissions do. This is for speed purposes, and generally cuts out half the number of queries required to create a new submission

Parameters

string	$number	the part of the version to update (major|minor|micro)
boolean	$update_parents	should we go through an update all our dependant parents as well ? NOTE: this is passed to incrementVersion to let it know that the parents should have their versions updated as well.

Returns

boolean public

Definition at line 346 of file form_submission.inc.

isError

(

)

returns true if there is a form error

Returns

boolean public

Definition at line 235 of file form_submission.inc.

printBody

(

)

Called by the design to print the body of this asset

Returns

void public

Definition at line 396 of file form_submission.inc.

printFrontend

(

)

Called to be printed before the design is finished

Returns

void public

Definition at line 359 of file form_submission.inc.

saveAttributes	(		$dont_run_updated = FALSE,
			$log_message = TRUE
	)

Save attributes set with setAttrValue to the database

Parameters

boolean	$dont_run_updated	if true this->_updated() won't be run
boolean	$log_message	if FALSE attrubutes change won't be logged in system log

Returns

boolean public

See Also

asset::setAttrValue()

Definition at line 319 of file form_submission.inc.

setAnswer	(		$id,
			$value
	)

sets the answer of a question in this submission object

Parameters

int	$id	the id of the question
mixed	$value	the value of the question

Returns

boolean public

Definition at line 128 of file form_submission.inc.

setError

(

$error

)

set a form error into the error store

Parameters

string

$error

the error to set

Returns

boolean public

Definition at line 177 of file form_submission.inc.

setExtraData	(		$id,
		Array	$data = NULL
	)

sets the Extra Data for a question's response

Parameters

int	$id	the id of the question
Array	$data	the Extra Data of the question

Returns

boolean public

Definition at line 153 of file form_submission.inc.

setIP

(

$ip

)

sets the IP of a submission object

Parameters

string

$ip

the ip of the user who submitted

Returns

boolean public

Definition at line 575 of file form_submission.inc.

setSummary	(		$question_id,
			$name,
			$value
	)

sets a summary about a question used to print a complete summary of the answers of this form

Parameters

int	$question_id	the id of the question
string	$name	the name of the question
string	$value	the value of the question

Returns

boolean public

Definition at line 267 of file form_submission.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/cms/form/form_submission/form_submission.inc