Page_Poll Class Reference

Inheritance diagram for Page_Poll:

Public Member Functions
	__construct ($assetid=0)
	_createAdditional (&$link)
	prepareLink (&$asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	_getAllowedLinks ()
	printBody ()
&	getFolder ($type='type_formats')
	onRequestKeywords (&$broadcaster, $vars=Array())
	_getQuestionFormatKeywordReplacements ($question)
	_getQuestionFormatKeywords ()
	_getOptionListFormatKeywords ()
	_getResultsFormatKeywords ()
	_getResultsFormatKeywordReplacements ($question)
	_getResultsListFormatKeywords ()
	_getPastQuestionsFormatKeywords ()
	_getPastQuestionFormatKeywordReplacements ($question, $active_question_id)
	_getPastQuestionsListFormatKeywords ()
&	getFormatAsset ($format='question_format')
	_processVote (&$question, $option_ids)
	_componentQuestion (&$question)
	_componentDate (&$question)
	_componentOptionList (&$question)
	_componentVoteButton ($new_window=FALSE)
	_componentVoteButtonJavascript ($new_window=FALSE)
	_newWindowOption ()
	_componentViewResults ()
	_componentViewResultsURL ()
	_componentViewPastQuestions ()
	_componentViewPastQuestionsURL ()
	_componentGraph (&$question)
	_componentGraphHTML (&$question)
Public Member Functions inherited from Page
	__construct ($assetid=0)
	_getAllowedLinks ()
	printBody ()
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 ()

Data Fields
background	__pad0__: <?php echo $question_colour_bar

Protected Member Functions
	_printFormatAsset ($format_bodycopy, $format_type)
Protected Member Functions inherited from Page
	_preCreateCheck (Array &$link)
	_createAdditional (Array &$link)
	_getName ($short_name=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 36 of file page_poll.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 46 of file page_poll.inc.

Member Function Documentation

_componentDate

(

&

$question

)

Prints the formatted creation date of the question

Parameters

object

&$question

The question to grab the creation date from

Returns

string private

Definition at line 704 of file page_poll.inc.

_componentGraph

(

&

$question

)

Will determine which graph function to call, based on the attribute 'poll_style'. As this attribute hasn't been implemented, this function calls the HTML graph straight off.

Parameters

object

&$question

The question to print the graph of

Returns

string private

Definition at line 895 of file page_poll.inc.

_componentGraphHTML

(

&

$question

)

Returns a graph formatted using user-defined colours

Parameters

object

&$question

The question to print the graph of

Returns

string private

Definition at line 910 of file page_poll.inc.

_componentOptionList

(

&

$question

)

Returns a radio button and a label for every option in $question

Parameters

object

&$question

The question containing the options to print

Returns

string private

Definition at line 719 of file page_poll.inc.

_componentQuestion

(

&

$question

)

Prints the name of the question

Parameters

object

&$question

The question to grab the name from

Returns

string private

Definition at line 689 of file page_poll.inc.

_componentViewPastQuestions

(

)

Returns a link to the Previous Questions screen

Returns

string private

Definition at line 857 of file page_poll.inc.

_componentViewPastQuestionsURL

(

)

Returns the URL to the Previous Questions screen

Returns

string private

Definition at line 876 of file page_poll.inc.

_componentViewResults

(

)

Returns a link to the View Results screen

Returns

string private

Definition at line 826 of file page_poll.inc.

_componentViewResultsURL

(

)

Returns the URL to the View Results screen

Returns

string private

Definition at line 844 of file page_poll.inc.

_componentVoteButton

(

$new_window = FALSE

)

Returns a button that submits the vote selected from _componentOptionList()

Parameters

boolean

$new_window

If set to true then results will be displayed in a new browser window

Returns

string private

Definition at line 762 of file page_poll.inc.

_componentVoteButtonJavascript

(

$new_window = FALSE

)

Returns the onClick javascript that submits the vote selected from _componentOptionList() eg. <img src="Foo.jpg" onClick="%vote_button_javascript%" />

Parameters

boolean

$new_window

Open poll results in a new window

Returns

string private

Definition at line 784 of file page_poll.inc.

_createAdditional

(

&

$link

)

Perform any additional processing required during the creation of this asset

Asset listings create bopycopy and folder asset when they are created

Parameters

array

&$link

information used to create the initial link

Returns

boolean private

Definition at line 64 of file page_poll.inc.

_getAllowedLinks

(

)

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

Returns

array private

See Also

Asset::_getAllowedLinks()

Definition at line 154 of file page_poll.inc.

_getOptionListFormatKeywords

(

)

Return array of keywords

Returns

array public

Definition at line 471 of file page_poll.inc.

_getPastQuestionFormatKeywordReplacements	(		$question,
			$active_question_id
	)

keyword replacements

Parameters

object	$question	Question Object
int	$active_question_id	Asset Id of the active question

Returns

array public

Definition at line 571 of file page_poll.inc.

_getPastQuestionsFormatKeywords

(

)

Return array of keywords

Returns

array public

Definition at line 546 of file page_poll.inc.

_getPastQuestionsListFormatKeywords

(

)

Return array of keywords

Returns

array public

Definition at line 594 of file page_poll.inc.

_getQuestionFormatKeywordReplacements

(

$question

)

Keyword replacements

Parameters

object

$question

Question Asset

Returns

array public

Definition at line 408 of file page_poll.inc.

_getQuestionFormatKeywords

(

)

Return array of keywords

Returns

array public

Definition at line 441 of file page_poll.inc.

_getResultsFormatKeywordReplacements

(

$question

)

keyword replacements

Parameters

object

$question

Question Asset

Returns

array public

Definition at line 512 of file page_poll.inc.

_getResultsFormatKeywords

(

)

Return array of keywords

Returns

array public

Definition at line 490 of file page_poll.inc.

_getResultsListFormatKeywords

(

)

Return array of keywords

Returns

array public

Definition at line 525 of file page_poll.inc.

_newWindowOption

(

)

Returns javascript for opening new window on submit

Returns

string private

Definition at line 801 of file page_poll.inc.

_printFormatAsset (   $format_bodycopy,   $format_type  )

protected

Print a format bodycopy Add extra HTML if required (surround the question format with a form tag)

Parameters

object	$format_bodycopy	a format bodycopy
string	$format_type	the format type name

Returns

void protected

Definition at line 314 of file page_poll.inc.

_processVote	(	&	$question,
			$option_ids
	)

Increments the option voted for

Returns TRUE if any valid options were voted for

Parameters

object	&$question	reference to poll_question being voted on
array	$option_ids	key index of the option voted for

Returns

boolean private

Definition at line 645 of file page_poll.inc.

& getFolder

(

$type = 'type_formats'

)

Return a reference to a folder linked to this asset determined by the passed in value on the link

Parameters

string

$type

the value on the link for this folder

Returns

object public

Definition at line 335 of file page_poll.inc.

& getFormatAsset

(

$format = 'question_format'

)

Return a reference to a format linked to this asset

Parameters

string

$format

the value on the link for this folder

Returns

object public

Definition at line 613 of file page_poll.inc.

onRequestKeywords	(	&	$broadcaster,
			$vars = Array()
	)

Returns a list of keywords

Parameters

object	&$broadcaster	Broadcaster
array	$vars	Keywords

Returns

object public

Definition at line 359 of file page_poll.inc.

prepareLink	(	&	$asset,
			$side_of_link,
		&	$link_type,
		&	$value,
		&	$sort_order,
		&	$dependant,
		&	$exclusive
	)

Prepares for linking by checking that the link values are valid for this link

This function will be called if this asset is the major or minor party in the link, so the side_of_link flag should be checked to work out what side of the link this asset is on. The return value should indicate if any of the link fields were changed.

Parameters

object	&$asset	the major or minor asset that we are linking to
string	$side_of_link	the side of the link we are on (major or minor)
string	&$link_type	the type of link we are creating
string	&$value	the value that is to be associated with the link
string	&$sort_order	the position in the links list that this link should take,
string	&$dependant	'0' / '1' on whether the this asset is dependant on the asset that will be linked by the new link
string	&$exclusive	'0' / '1' on whether the this asset is linked exclusivly to the asset that will be linked by the new link

Returns

boolean public

Definition at line 130 of file page_poll.inc.

printBody

(

)

Prints out the body of the asset

Switches between the Voting, Results and Past Questions screen

Returns

void public

See Also

printFrontend()

Definition at line 176 of file page_poll.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/cms/page_templates/page_poll/page_poll.inc