Page_Site_Map Class Reference

Inheritance diagram for Page_Site_Map:

Public Member Functions
	__construct ($assetid=0)
	_getAllowedLinks ()
	lockTypes ()
	describeLink ($linkid)
	printBody ()
	_getRootNodeId ()
	_paintUnorderedList ($chunks, &$page_data, $level=1, $generating=FALSE)
	_paintDefault ($chunks=Array(), $page_data, $rootid)
	_defaultRecursePrintAssetList (&$page_data, $parent, $level, $generating=FALSE)
	_getDisplayFormat ($data)
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 ()

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 Page
	_preCreateCheck (Array &$link)
	_createAdditional (Array &$link)
	_getName ($short_name=FALSE)

Detailed Description

Definition at line 31 of file page_site_map.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 41 of file page_site_map.inc.

Member Function Documentation

_defaultRecursePrintAssetList	(	&	$page_data,
			$parent,
			$level,
			$generating = FALSE
	)

Recursively prints a tree of the passed in data

Parameters

array	&$page_data	the data to print in a tree structure
int	$parent	the parent that we are currently at
int	$level	the level of the tree we are printing
boolean	$generating	if TRUE content will be generated for a content file

Returns

boolean private

Definition at line 317 of file page_site_map.inc.

_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 56 of file page_site_map.inc.

_getDisplayFormat

(

$data

)

Returns the display text for a site map item

Parameters

array

$data

Information about the site map item

Returns

boolean private

Definition at line 385 of file page_site_map.inc.

_getRootNodeId

(

)

Get the ID of the effective root node for this page

Returns

int private

Definition at line 187 of file page_site_map.inc.

_paintDefault	(		$chunks = Array(),
			$page_data,
			$rootid
	)

Begins to paint a site map in the default format

Parameters

array	$chunks	chunks of assets to buuild the map with
array	$page_data	data on assets
int	$rootid	id of root asset

Returns

void private

Definition at line 282 of file page_site_map.inc.

_paintUnorderedList	(		$chunks,
		&	$page_data,
			$level = 1,
			$generating = FALSE
	)

Begins to paint a site map in the default format

Parameters

array	$chunks	the level of depth with which to begin processing
array	&$page_data	data on assets
int	$level	Level
boolean	$generating	Generating

Returns

void private

Definition at line 232 of file page_site_map.inc.

describeLink

(

$linkid

)

Return a human readable description of the passed link

Parameters

int

$linkid

the link ID of the link to describe

Returns

string public

Definition at line 88 of file page_site_map.inc.

lockTypes

(

)

Returns a list of lock types available for this asset type

Returns

array public

Definition at line 71 of file page_site_map.inc.

printBody

(

)

Called by the design to print the body of this asset it's up to the kids to override

Returns

boolean public

Definition at line 110 of file page_site_map.inc.

---

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

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