Inheritance diagram for Comment:

Public Member Functions
	getAssetAttributeNameKeywordReplacement ()

	getAssetAttributeCommentKeywordReplacement ()

	getCommentMaxLengthKeywordReplacement ()

	getCommentMaxRatingKeywordReplacement ()

	getCommentRatingIntegerKeywordReplacement ()

	getCommentRatingKeywordReplacement ()

	_getRatingScaled ()

	_getRatingScaledInteger ()

	_convertIntegerRatingToPercent ($integer)

	_getRatingLimit ()

	getCommentRatingImageHtmlBlockKeywordReplacement ()

	getCommentRatingPercentageKeywordReplacement ()

	getAvailableKeywords ()

	attr ($name)

	setAttrValue ($name, $value)

	_formatValueBasedOnPreference ($value)

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 ()

Protected Member Functions
	_getName ($short_name=FALSE, $contextid=NULL)

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)

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

Detailed Description

Definition at line 42 of file comment.inc.

Member Function Documentation

_convertIntegerRatingToPercent ( $integer )

Convert an integer value to percent based on the current max setting

Parameters

int $integer value to convert to percent

Returns: string private

Definition at line 205 of file comment.inc.

_formatValueBasedOnPreference ( $value )

Format a value based on user preferences

Parameters

string $value the new value of the attribute

Returns: boolean public

Definition at line 388 of file comment.inc.

_getName	(	$short_name = `FALSE`,
		$contextid = `NULL`
	)

protected

Returns name of the asset

Parameters

boolean	$short_name	whether or not we are after the shortname or the full name
int	$contextid	what context to return the name from

Returns: string private

See Also: Asset::_getName()

Definition at line 56 of file comment.inc.

_getRatingLimit ( )

Get the value of the maximum possible rating setting

Returns: string private

Definition at line 230 of file comment.inc.

_getRatingScaled ( )

Get the rating scaled to the current maximum rating setting

Returns: string private

Definition at line 170 of file comment.inc.

_getRatingScaledInteger ( )

Get the rating scaled to the current maximum rating setting rounded to an integer

Returns: string private

Definition at line 190 of file comment.inc.

attr ( $name )

Get the value of an attribute

Parameters

string $name the name of the attribute whose value you want to get

Returns: mixed string|NULL public

Definition at line 328 of file comment.inc.

getAssetAttributeCommentKeywordReplacement ( )

Overwrite the keyword replacement function for the name attribute

Returns: string public

See Also: Asset::getKeywordReplacement()

Definition at line 95 of file comment.inc.

getAssetAttributeNameKeywordReplacement ( )

Overwrite the keyword replacement function for the name attribute

Returns: string public

See Also: Asset::getKeywordReplacement()

Definition at line 81 of file comment.inc.

getAvailableKeywords ( )

Return the keywords for this asset type.

Returns: array public

Definition at line 304 of file comment.inc.

getCommentMaxLengthKeywordReplacement ( )

Get the maximum allowed length of comment input box

Returns the setting from the Global Preferences screen.

Returns: string public

Definition at line 110 of file comment.inc.

getCommentMaxRatingKeywordReplacement ( )

Get the maximum rating keyword replacement

Returns: string public

Definition at line 124 of file comment.inc.

getCommentRatingImageHtmlBlockKeywordReplacement ( )

Get the HTML block for printing the rating stars

Returns: string public

Definition at line 244 of file comment.inc.

getCommentRatingIntegerKeywordReplacement ( )

Get the integer rating keyword replacement

Returns: string public

Definition at line 138 of file comment.inc.

getCommentRatingKeywordReplacement ( )

Get the current rating keyword replacement (may not be an integer)

Returns: string public

Definition at line 154 of file comment.inc.

getCommentRatingPercentageKeywordReplacement ( )

Get the percentage keyword replacement

Returns: string public

Definition at line 288 of file comment.inc.

setAttrValue	(	$name,
		$value
	)

Queue the setting of the value of an attribute

This function sets the value of the attribute locally, but does not database updating. The change is queued awaiting the call of saveAttributes()

Parameters

string	$name	the name of the attribute
string	$value	the new value of the attribute

Returns: boolean public

Definition at line 352 of file comment.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/news/comment/comment.inc

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation