Inheritance diagram for Bodycopy_Container:

Public Member Functions
	__construct ($assetid=0)

	create (Array &$link, Array $bc_data=Array())

	lockTypes ()

	paintBackend (Backend_Outputter $o)

	saveSystemVersion ()

	processStatusChange ($new_status, $update_parent=TRUE)

	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)

	deleteLink ($linkid)

	_getAllowedLinks ()

	describeLink ($linkid)

	printBody ($keyword_replacements=NULL)

	isEmpty ()

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)

	_getName ($short_name=FALSE, $contextid=NULL)

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 bodycopy_container.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 41 of file bodycopy_container.inc.

Member Function Documentation

_getAllowedLinks ( )

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

Returns: array private

See Also: Asset::_getAllowLinks()

Definition at line 315 of file bodycopy_container.inc.

_getName	(	$short_name = `FALSE`,
		$contextid = `NULL`
	)

protected

Returns name of the asset

Parameters

boolean	$short_name	whether or not we are after the short name or the full name
int	$contextid	what context to return the name from

Returns: string private

See Also: Asset::_getName()

Definition at line 529 of file bodycopy_container.inc.

_preCreateCheck ( Array & $link )

protected

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

Bodycopy containers ensure a name has been set before they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 80 of file bodycopy_container.inc.

create	(	Array &	$link,
		Array	$bc_data = `Array()`
	)

Create this asset

Returns linkid if successful or FALSE on failure

Parameters

array	&$link	information used to create the initial link
array	$bc_data	bodycopy data submitted to help create this div

Returns: mixed int|boolean public

Definition at line 60 of file bodycopy_container.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 284 of file bodycopy_container.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 343 of file bodycopy_container.inc.

isEmpty ( )

Determine if there is no content in this container

Returns: boolean public

Definition at line 553 of file bodycopy_container.inc.

lockTypes ( )

Returns a list of lock types available for this asset type

Returns: array public

Definition at line 101 of file bodycopy_container.inc.

paintBackend ( Backend_Outputter $o )

Prints out the backend interface for the asset. Used for displaying the div properties screen if needed.

Parameters

Backend_Outputter $o The Backend Outputter instance

Returns: void public

Definition at line 119 of file bodycopy_container.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

Bodycopy_Container	$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 263 of file bodycopy_container.inc.

printBody ( $keyword_replacements = NULL )

Called by the design to print the body of this asset

Parameters

mixed(array|null) $keyword_replacements some replacements for keywords in the content, pass an array of replacements or null for the container to attempt the replacements itself

Returns: void public

Definition at line 364 of file bodycopy_container.inc.

processStatusChange	(	$new_status,
		$update_parent = `TRUE`
	)

Processes the changes required when a new status is set

Parameters

int	$new_status	the new status to set for this asset
boolean	$update_parent	Specify if we want to update the parent as well

Returns: boolean public

Definition at line 211 of file bodycopy_container.inc.

saveSystemVersion ( )

Saves a copy of this asset at this point in time

This copy gets used when the asset is live and the user does not have write access

Returns: boolean public

Definition at line 155 of file bodycopy_container.inc.

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

/Users/webmaster/Desktop/squiz_matrix/core/assets/bodycopy/bodycopy_container/bodycopy_container.inc

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation