Design_Css Class Reference

Inheritance diagram for Design_Css:

Public Member Functions
	__construct ($assetid=0)
	__wakeup ()
	_getAllowedLinks ()
	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0')
	deleteLink ($linkid)
	deleteExistingLink ($linkid)
	printFrontend ()
	getParentDesign ()
	printVar ($var, Array $args)
	_getDesignFileHeader ()
	processBackend (Backend_Outputter $o, Array &$link)
	generateDesignFile ($do_customisations=TRUE)
	updateCustomisations ()
	_updateCacheFile ()
	getCacheFileId ()
	_createCacheFile ()
	getDesignAreaLink ($id_name='')
	paint (Asset $ASSET, $FILE_URLS=Array())
	saveAttributes ()
	_setCacheFileEnabled ($enabled)
Public Member Functions inherited from Design
	__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
	_preCreateCheck (Array &$link)
	_createAdditional (Array &$link)
Protected Member Functions inherited from Design
	_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 33 of file design_css.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 43 of file design_css.inc.

Member Function Documentation

__wakeup

(

)

Wakeup.

Definition at line 56 of file design_css.inc.

_createAdditional ( Array &  $link )

protected

Perform any additional processing required during the creation of this asset

For example, creating other child assets should be performed in this method

Parameters

array

&$link

information used to create the initial link

Returns

boolean private

Definition at line 111 of file design_css.inc.

_createCacheFile

(

)

Creates the cache file asset that this CSS asset will display in the cache

Returns

File public

Definition at line 589 of file design_css.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 135 of file design_css.inc.

_getDesignFileHeader

(

)

Prints the header for the output

Returns

void public

Definition at line 417 of file design_css.inc.

_preCreateCheck ( Array &  $link )

protected

Perform any pre-validation required during the creation of this asset

CSS Files ensure their name is valid before they are created

Parameters

array

&$link

information used to create the initial link

Returns

boolean private

Definition at line 74 of file design_css.inc.

_setCacheFileEnabled

(

$enabled

)

Enable or disable the cache file, by setting or clearing its web paths

Parameters

boolean

$enabled

Whether the cache should be enabled

Returns

void public

Definition at line 750 of file design_css.inc.

_updateCacheFile

(

)

Creates / updates the static file for this css design

Returns

boolean public

Definition at line 524 of file design_css.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 182 of file design_css.inc.

deleteExistingLink

(

$linkid

)

Does the actual removing of the link for the customisation

The default deleteLink() replaces the (Type-2) links of any customised design files with a Type-3 to the uncustomised version. This screws things around when creating the customised versions in the first place.

Parameters

int

$linkid

the link id of the link to remove

Returns

boolean public

Definition at line 319 of file design_css.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 250 of file design_css.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 482 of file design_css.inc.

getCacheFileId

(

)

Gets the static cache file asset id of this CSS asset

Returns

string public

Definition at line 573 of file design_css.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 637 of file design_css.inc.

getParentDesign

(

)

Returns the parent design/design_customisation that this customisation is customising

Returns

Design_CSS public

Definition at line 372 of file design_css.inc.

paint	(	Asset	$ASSET,
			$FILE_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

Returns

void public

Definition at line 659 of file design_css.inc.

printFrontend

(

)

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

Returns

void public

Definition at line 355 of file design_css.inc.

printVar	(		$var,
		Array	$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 389 of file design_css.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 434 of file design_css.inc.

saveAttributes

(

)

Save attrs to the DB

Returns

void public

Definition at line 731 of file design_css.inc.

updateCustomisations

(

)

Updates each of our customisations from ourselves

Returns

void public

Definition at line 500 of file design_css.inc.

---

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

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