Design_Area_Menu_Type Class Reference

Inheritance diagram for Design_Area_Menu_Type:

Public Member Functions
	__construct ($assetid=0)
	_getAllowedLinks ()
	setAttrValue ($name, $value)
	attr ($name)
	getVarReferences ()
	setVarReferenceValues (Array $var_ref_values)
	getSubMenuLink ()
&	getSubMenu ()
&	getParentMenu ()
	linksUpdated ()
	settingExists ($name)
	printInitCode ()
	printStaticInitOutput ()
	printInitOutput ()
	printDataCollection ()
	printVar ($var, Array $args, $value_prefix='', $value_suffix='')
	_settingHasPHPCode ($setting_name)
	_getSettingsArray ()
	getProtectedAttrs ()
Public Member Functions inherited from Design_Area
	__construct ($assetid=0)
	_updated ($update_parents=TRUE)
	lockTypes ()
	processBackend (Backend_Outputter $o, Array &$link)
&	getDesigns ()
	getVarReferences ()
	setVarReferenceValues (Array $var_ref_values)
	attr ($name)
	getProtectedAttrs ()
	printVar ($var, Array $args)
	printInitCode ()
	printPaintingCode ()
	printAreaCode ()
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
	_printInitCode ()
	_printPaintingCode ()
	_printContentItemCode (Array $element)
Protected Member Functions inherited from Design_Area
	_preCreateCheck (Array &$link)
	_getName ($short_name=FALSE)
	_escapeVar ($value, Array $args)
	_safeStringLiteral ($string)
	_canBeCached ()
	_canInit ()
	_printInitCode ()
	_printPaintingCode ()
	_printContentItemCode (Array $item)
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 31 of file design_area_menu_type.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

string

$assetid

The asset ID of the asset to load

Definition at line 41 of file design_area_menu_type.inc.

Member Function Documentation

_getAllowedLinks

(

)

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

Returns

array private

See Also

Asset::_getAllowLinks()

Definition at line 55 of file design_area_menu_type.inc.

_getSettingsArray

(

)

Returns the settings array that will be need to be var_exported

Returns

array public

Definition at line 741 of file design_area_menu_type.inc.

_printContentItemCode ( Array  $element )

protected

Print code that outputs a given element from this DA's contents

Parameters

array

$element

An entry from our contents array

Returns

void private

Definition at line 786 of file design_area_menu_type.inc.

_printInitCode ( )

protected

Print code that initialises this design area and should always be printed in place of the AREA tag

Returns

void protected

Definition at line 380 of file design_area_menu_type.inc.

_printPaintingCode ( )

protected

Print code that actually results in HTML output to the browser for this design area This function is called at the AREA tag if print != no, and at the point of any PRINT tags that reference this area.

This function can be overridden (partially) by children

Returns

void protected

Definition at line 426 of file design_area_menu_type.inc.

_settingHasPHPCode

(

$setting_name

)

Returns the settings array that will be need to be var_exported

Parameters

string

$setting_name

Setting name

Returns

boolean public

Definition at line 722 of file design_area_menu_type.inc.

attr

(

$name

)

Easy way to get the value of an attribute

Parameters

string

$name

The name of the attribute to get the value for

Returns

mixed string|NULL public

Definition at line 169 of file design_area_menu_type.inc.

& getParentMenu

(

)

Returns the parent menu for this menu (assuming it is a sub menu)

Returns

mixed object|NULL public

Definition at line 301 of file design_area_menu_type.inc.

getProtectedAttrs

(

)

Get the names of attributes for this DA that cannot be set in the parse file

Design Area attributes that are not mentioned in the parse file are normally set to defaults when parsing the design. Attributes returned by this function are exempted from that process.

Returns

array public

Definition at line 767 of file design_area_menu_type.inc.

& getSubMenu

(

)

Returns the sub menu for this menu (if any)

Returns

mixed object|NULL public

Definition at line 281 of file design_area_menu_type.inc.

getSubMenuLink

(

)

Returns the link to the sub menu for this menu (if any)

Returns

array public

Definition at line 265 of file design_area_menu_type.inc.

getVarReferences

(

)

Returns an array of Array(id_name => Array(var)) for all var references that are needed by this design area

Returns

array public

Definition at line 195 of file design_area_menu_type.inc.

linksUpdated

(

)

Called whenever any type of link is changed, allows caching of objects, links and other stuff to occur but not cause integrity issues during script execution returns true it it's successfull

Returns

void private

Definition at line 325 of file design_area_menu_type.inc.

printDataCollection

(

)

Outputs the way for this menu type to get their information and place it in the $GLOBALS['MENU_DATA'] array

Returns

void public

Definition at line 521 of file design_area_menu_type.inc.

printInitCode

(

)

Print code that initialises this design area and should always be printed in place of the AREA tag

This public version is overridden here only because menus print some code that is shared by all menu DAs and should never be cached

Returns

void public

Definition at line 359 of file design_area_menu_type.inc.

printInitOutput

(

)

Performs any outputting needed to intialise this instance of the menu type

Returns

void public

Definition at line 483 of file design_area_menu_type.inc.

printStaticInitOutput

(

)

Performs any outputting needed to by all design areas of this menu type

NOTE: assumes PHP tags are open

Returns

void public

Definition at line 453 of file design_area_menu_type.inc.

printVar	(		$var,
		Array	$args,
			$value_prefix = '',
			$value_suffix = ''
	)

Outputs the var either as straight HTML or PHP code, depending on the type

Parameters

string	$var	the name of the var to print out
array	$args	array of any extra arguments that existed in the print command
string	$value_prefix	PHP code to wrap put before the value before outputting it
string	$value_suffix	PHP code to wrap put after the value before outputting it

Returns

void public

Definition at line 552 of file design_area_menu_type.inc.

setAttrValue	(		$name,
			$value
	)

Set the value for the passed variable to the passed value

Parameters

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

Returns

boolean public

Definition at line 76 of file design_area_menu_type.inc.

settingExists

(

$name

)

Returns whether the passed setting exists or not

Parameters

string

$name

Setting name

Returns

boolean public

Definition at line 342 of file design_area_menu_type.inc.

setVarReferenceValues

(

Array

$var_ref_values

)

Sets the values for the var references values (registered in $this->var_references)

Parameters

array

$var_ref_values

array of values - Array(id_name => Array(var => [value]))

Returns

void public

Definition at line 225 of file design_area_menu_type.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/core/assets/designs/design_areas/menu/design_area_menu_type/design_area_menu_type.inc