Page_Related_Asset_Listing Class Reference

Inheritance diagram for Page_Related_Asset_Listing:

Public Member Functions
	__construct ($assetid=0)
	getAssetList ()
	getRelators ()
	getStaticRelators ()
	_getThesaurusFilters ()
	_getCacheKey ()
Public Member Functions inherited from Page_Asset_Listing
	__construct ($assetid=0)
	getAssetList ()
	_getAssetList ($group_by, $logic, $wanted_types, $root_asset_ids, $sort_info, $link_value_wanted=NULL)
	_getSortedAssetLists ($assets_to_list, $sort_info)
	_combineAssets ($logic='OR', $new_assets=Array(), $existing=NULL)
	_combineRootNodes ($assets=Array(), $root_nodes=Array(), $types=Array())
Public Member Functions inherited from Listing_Engine
	__construct ($assetid=0)
	_createAdditional (&$link)
	_createBodycopies ()
	_getDefaultBodycopyContent ($bodycopy_code)
	lockTypes ()
	prepareLink (&$asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	describeLink ($linkid)
	isDeletableLink ($linkid)
	cloneComponentsAdditional (&$clone, $components)
	_getAllowedLinks ()
&	getFolder ($type='type_formats')
	getFormats ($type='type_formats')
	printBody ()
	_getFormUrlComponents ()
	printNoResultsBodycopy (&$keywords)
	printContents ()
	_getCacheKey ()
	_getNumPerPage ()
	getAssetList ()
	sortAssetList ($asset_list, $sort_info)
	filterAssetList (&$todo)
	filterAssetStatuses (&$todo)
	filterAssetTypes (&$todo)
	getAllowedAssetTypeMap ()
	adjustAssetPositions (&$todo)
&	getChunk (&$children, &$replacements, $keywords, $result_page, $num_per_page, $group_by=NULL)
	_getPageList ($total_pages, $current_page, $window_size=NULL)
	_groupChunk (&$todo, &$chunk, &$remaining_count, $num_per_page, $group_limit=NULL)
	printAssetList ($todo)
	_printGroups (&$todo, $group_info)
	_printAssetList ($todo)
	_getShadowAssetKeywordReplacements ($assetid, $bc_keywords)
	_printAsset ($assetid, $list_position, $num_items=0)
&	_getTypeFormatBodycopy ($type_code)
	_getSelectionFieldNamePrefix ($selection_name)
	getSortableAssetInfo ()
	getRootNodes ($reload=TRUE)
	getExtendedAssetKeywordReplacements ()
	isDescending ()
	registerFormField ($field_name)
	getUsedFormFields ()
	getSortInfo ()
	groupAssetsRecursively ($group_levels, $assetids, &$results)
	limitAssetsRecursively (&$results, $limit_array)
	getGroupableParentAssetids ($child_assetid, $restrict_types=Array(), $direct_parent_only=FALSE)
&	convertProxyAssetTypes (&$results)
	_getGroupableParentAssetids ($child_assetid, $restrict_types=Array(), $root_nodes=Array(), $direct_parent_only=FALSE)
	sortGroups ($group_levels, $assetids, &$results)
	reindexGroupFormats ()
	processAssetSelections ()
	getAssetSelectionValue ($selection_name, $assetid)
	getAssetSelectionDefaults ()
	getAssetTargetDefaults ()
	_arrayCountRecursive (&$array, $limit=NULL)
	_getPositionFormats ()
	onRequestKeywords (&$broadcaster, $vars=Array())
	_getGenericSingleAssetFormatKeywords ($type=NULL)
	_getAdditionalSingleAssetFormatKeywords ()
	getAvailableKeywords ()
	_getContentsKeywords ()
	_getTypeFormatsKeywords ()
	_getGroupFolderKeywords ()
	getKeywordReplacement ($original_keyword)
	getContentsKeywordReplacements ($keywords=Array())
	getSortByKeywordReplacement ()
	getSortOrderKeywordReplacement ()
	getSubmitButtonKeywordReplacement ()
	getResetButtonKeywordReplacement ()
	getRootNodesKeywordReplacement ()
	getAssetTargetKeywordReplacement ($name)
	getStructuredRootNodeKeywordReplacement ()
	getSelectAllJSCodeKeywordReplacement ()
	_recurseCheckAllRelations (&$todo, &$relations, $prefix, $limit=NULL)
	_analyseCheckAllRelations ($todo)
	_buildRelationsJS ()
	_getFormSubmitMethod ()
	createNoResultsBodycopy ($enable_on_create=TRUE)
&	getNoResultsBodycopy ($only_if_enabled=TRUE)
	isNoResultsBodycopyEnabled ()
	setUseNoResultsBodycopy ($enabled)
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 Listing_Engine
	$requires_form = FALSE
	$performance_log_file_name = 'performance'
	$performance_threshold = 1000
Protected Member Functions inherited from Listing_Engine
	_getAssetContentsBCKeywordReplacement (Asset $asset, $contextid=NULL)
	_getAssetContentsRawBCKeywordReplacement (Asset $asset, $contextid=NULL)
	_getAssetContentsPaintBCKeywordReplacement (Asset $asset, $paint_layout, $contextid=NULL)

Detailed Description

Definition at line 32 of file page_related_asset_listing.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 42 of file page_related_asset_listing.inc.

Member Function Documentation

_getCacheKey

(

)

Work out the unique cache key to represent the current page Add relatorsid to the parent cache key

Returns

string private

Definition at line 217 of file page_related_asset_listing.inc.

_getThesaurusFilters

(

)

Get the IDs of the thesauruses which are used to filter the related assets

Returns

array protected

Definition at line 197 of file page_related_asset_listing.inc.

getAssetList

(

)

Get the list of assets that should be printed

The return array is in the form Array(assetid => type_code) unless we are grouping by letter, in which case the return array is

Array(assetid => Array(
                    'type_code' => type_code,
                    'first_letter' => first_letter,
                    );
    );

Returns

array protected

Definition at line 65 of file page_related_asset_listing.inc.

getRelators

(

)

Gets the list of current relators

Returns

array public

Definition at line 125 of file page_related_asset_listing.inc.

getStaticRelators

(

)

Gets the asset id's of our relators but ignores dynamic parameters

Returns

array public

Definition at line 178 of file page_related_asset_listing.inc.

---

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

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