Design Class Reference

Inheritance diagram for Design:

Public Member Functions
	__construct ($assetid=0)
	cloneComponentsAdditional (Asset $clone, Array $components)
	cloneDependantAdditional (Asset $clone)
	_getAllowedLinks ()
	printFrontend ()
	moveLinkPos ($linkid, $sort_order=-1)
	linksUpdated ()
	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0')
	deleteLink ($linkid)
	getAssociatedFile ($filename)
	getStylesheets ()
	getDesignAreaLink ($id_name='')
	getDesignArea ($id_name)
	getParentDesign ()
	processBackend (Backend_Outputter $o, Array &$link)
	updateCustomisations ()
	printVar ($var, $args)
	paint (Asset $ASSET, Array $FILE_URLS=Array(), Array $CSS_URLS=Array())
	generateDesignFile ($do_customisations=TRUE)
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
	_createAdditional (Array &$link)
	_getDesignFileHeader ()
	_writeDesignFile ($str)
	_setupVarReferences ()
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.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 41 of file design.inc.

Member Function Documentation

_createAdditional ( Array &  $link )

protected

Perform any additional processing required during the creation of this asset

Designs set an initial web path when they are created

Parameters

array

&$link

information used to create the initial link

Returns

boolean private

Definition at line 58 of file design.inc.

_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 202 of file design.inc.

_getDesignFileHeader ( )

protected

Get the header for the design file

Returns

string private

Definition at line 1131 of file design.inc.

_setupVarReferences ( )

protected

Set up the var references between DAs in our design

Returns

void private

Definition at line 1232 of file design.inc.

_writeDesignFile (   $str )

protected

Write the design file for the parse file given

Parameters

string

$str

The parse file contents

Returns

boolean private

Definition at line 1183 of file design.inc.

cloneComponentsAdditional	(	Asset	$clone,
		Array	$components
	)

Perform any additional processing required during the cloning of this asset

This function is being called by asset_manager after the dependants of asset have been cloned.

Parameters

Asset	$clone	the clone asset shell
array	$components	the wanted components to clone eg. Array( 'attributes', 'metadata_schemas', 'metadata', 'workflow', 'permissions', 'data', ); or alternately Array('all');

Returns

boolean public

Definition at line 105 of file design.inc.

cloneDependantAdditional

(

Asset

$clone

)

Perform any additional processing required during the cloning of components of this asset

Returns

boolean public

Definition at line 165 of file design.inc.

createLink	(	Asset	$minor,
			$link_type,
			$value = '',
			$sort_order = NULL,
			$dependant = '0',
			$exclusive = '0'
	)

Creates a link between this asset and the passed asset, of a certain type and returns the linkid of the created link

Parameters

Asset	$minor	the minor asset that we are linking to
string	$link_type	the type of link this is
string	$value	the value that is to be associated with this link
string	$sort_order	the position in the links list that this link should take, if NULL or less than zero places at end of list
string	$dependant	'0' / '1' on whether the this asset is dependant on the asset that will be linked by this new link
string	$exclusive	'0' / '1' on whether the this asset is linked exclusivly to the asset that will be linked by this new link

Returns

int public

Definition at line 332 of file design.inc.

deleteLink

(

$linkid

)

Removes a link where this asset is the major player

Parameters

int

$linkid

the link id of the link to remove

Returns

boolean public

Definition at line 405 of file design.inc.

generateDesignFile

(

$do_customisations = TRUE

)

(Re)Generates the design file

Parameters

boolean

$do_customisations

Generate design files for any customisations

Returns

boolean public

Definition at line 1051 of file design.inc.

getAssociatedFile

(

$filename

)

Returns the file asset associated with this design that has the passed filename

Parameters

string

$filename

the name of the file to look for

Returns

mixed object|NULL public

Definition at line 470 of file design.inc.

getDesignArea

(

$id_name

)

Returns a design area for the given id_name

Parameters

string

$id_name

the id of the design area to get

Returns

mixed object|NULL public

Definition at line 557 of file design.inc.

getDesignAreaLink

(

$id_name = ''

)

Returns the link information for the design area with the given id_name or all design area links

Parameters

string

$id_name

the id of the design area to get if blank returns links for all design areas

Returns

mixed array|NULL public

Definition at line 530 of file design.inc.

getParentDesign

(

)

Returns the parent design/design_customisation that this customisation is customising

Returns

mixed object|NULL public

Definition at line 582 of file design.inc.

getStylesheets

(

)

Get all the stylesheets attached to this design

Returns

array public

Definition at line 497 of file design.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 successful

Returns

void private

Definition at line 262 of file design.inc.

moveLinkPos	(		$linkid,
			$sort_order = -1
	)

Moves a link from one place in this assets links order to another position

Parameters

int	$linkid	the link id of the link to move about
string	$sort_order	the position in the links list that this link should take, if less than zero places at end of list

Returns

boolean public

See Also

Asset::moveLinkPos()

Definition at line 246 of file design.inc.

paint	(	Asset	$ASSET,
		Array	$FILE_URLS = Array(),
		Array	$CSS_URLS = Array()
	)

Paints out our design

Parameters

Asset	$ASSET	the asset that we are going to print the body for
array	$FILE_URLS	an array of filename => URL to use to print files in the design doesnt need to be passed in unless some URLs are overridden by a customisation of the design
array	$CSS_URLS	an array of filename => URL to use to print css in the design doesnt need to be passed in unless some URLs are overridden by a customisation of the design

Returns

void public

Definition at line 978 of file design.inc.

prepareLink	(	Asset	$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

Asset	$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 exclusively to the asset that will be linked by the new link

Returns

boolean public

Definition at line 294 of file design.inc.

printFrontend

(

)

Prints out the Frontend for this asset it's up to the kids to override

Returns

void public

Definition at line 229 of file design.inc.

printVar	(		$var,
			$args
	)

Outputs the either as straight HTML or PHP code for the var, 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

Returns

void public

Definition at line 660 of file design.inc.

processBackend	(	Backend_Outputter	$o,
		Array &	$link
	)

Processes a backend submission from this asset, returns TRUE if all OK

Parameters

Backend_Outputter	$o	Backend Outputter
array	&$link	information used to create the initial link

Returns

boolean public

Definition at line 598 of file design.inc.

updateCustomisations

(

)

Updates each of our customisations from ourselves

Returns

void public

Definition at line 633 of file design.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/core/assets/designs/design/design.inc