Bodycopy Class Reference

Inheritance diagram for Bodycopy:

Public Member Functions
	__construct ($assetid=0)
	lockTypes ()
	create (Array &$link, $bc_data=Array())
	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	_getAllowedLinks ()
	processStatusChange ($new_status, $update_parents=TRUE)
	paintBackend (Backend_Outputter $o)
	printFrontend ()
	printBody ()
	_getName ($short_name=FALSE, $contextid=NULL)
&	getContainers ()
	isEmpty ()
	getKeywords ()
	getContent ()
	getRawBodycopyContent ()
	setKeywordReplacements ($replacements=Array())
	_compareLink ($current_link, $before_links)
	_cleanupSafeEdit ()
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 ()

Data Fields
	$keyword_replacements = Array()
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
Data Fields inherited from MySource_Object
	$_tmp

Protected Member Functions
	_preCreateCheck (Array $link)
	_createAdditional (Array &$link)
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)

Detailed Description

Definition at line 30 of file bodycopy.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 46 of file bodycopy.inc.

Member Function Documentation

_cleanupSafeEdit

(

)

Cleaning up files after coming out of Safe Edit

Returns

void private

Definition at line 560 of file bodycopy.inc.

_compareLink	(		$current_link,
			$before_links
	)

Compares the before and after state to check for div/table removal

Parameters

array	$current_link	The info about the current link
array	$before_links	An array of all the before links

Returns

boolean private

Definition at line 532 of file bodycopy.inc.

_createAdditional ( Array &  $link )

protected

Perform any additional processing required during the creation of this asset

Bodycopies create a DIV when they are created

Parameters

array

&$link

information used to create the initial link

Returns

boolean private

Definition at line 125 of file bodycopy.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 185 of file bodycopy.inc.

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

Get the name or short name of the asset

Parameters

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

Returns

string private

See Also

Asset::_getName()

Definition at line 391 of file bodycopy.inc.

_preCreateCheck ( Array  $link )

protected

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

Bodycopies 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 100 of file bodycopy.inc.

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

Create this asset

Parameters

array	&$link	information used to create the initial link
array	$bc_data	details for this bodycopy ['attributes']['identifier'] => id for the default div container ['content'] => html content for the default div container

Returns

mixed int|boolean public

See Also

Asset::create()

Definition at line 80 of file bodycopy.inc.

& getContainers

(

)

To get all of the containers linked to this bodycopy

Returns an array of Bodycopy_Container objects

Returns

array public

Definition at line 417 of file bodycopy.inc.

getContent

(

)

Returns the raw content of this bodycopy

Returns

string public

Definition at line 472 of file bodycopy.inc.

getKeywords

(

)

To get the keywords that exist in the content of the bodycopy.

Returns

array public

Definition at line 456 of file bodycopy.inc.

getRawBodycopyContent

(

)

Get the raw content of this bodycopy

Returns

string public

Definition at line 485 of file bodycopy.inc.

isEmpty

(

)

Determine if there is no content in this bodycopy

Returns

boolean public

Definition at line 437 of file bodycopy.inc.

lockTypes

(

)

Returns a list of lock types available for this asset type

Returns

array public

Definition at line 59 of file bodycopy.inc.

paintBackend

(

Backend_Outputter

$o

)

Prints out the backend interface for the asset

Parameters

object

&$o

Backend_Outputter instance to use for painting

Returns

void public

Definition at line 281 of file bodycopy.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

object	&$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 exclusivly to the asset that will be linked by the new link

Returns

boolean public

Definition at line 164 of file bodycopy.inc.

printBody

(

)

Called by the design to print the body of this asset

Returns

boolean public

Definition at line 339 of file bodycopy.inc.

printFrontend

(

)

Prints out the Frontend for this asset

Returns

void public

Definition at line 310 of file bodycopy.inc.

processStatusChange	(		$new_status,
			$update_parents = TRUE
	)

Provides extra checking and disable invalid status change on errors

Parameters

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

Returns

boolean public

Definition at line 208 of file bodycopy.inc.

setKeywordReplacements

(

$replacements = Array()

)

Sets the Array of keywords with their replacements

Parameters

array

$replacements

an array with the keyword as the key and the replacement as the value

Returns

boolean public

Definition at line 512 of file bodycopy.inc.

---

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

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