Inheritance diagram for Page_Asset_Builder:

Public Member Functions
	__construct ($assetid=0)

	_createAdditional (&$link)

	saveAttributes ($dont_run_updated=FALSE)

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

	isDeletableLink ($linkid)

	_getAllowedLinks ()

	printBody ()

	_printBody ()

	getFormCaptchaKeywordReplacement ()

	getFormCaptchaImageKeywordReplacement ()

	getFormCaptchaFieldKeywordReplacement ()

	getFormCaptchaLinkKeywordReplacement ()

	_processGlobalActions ()

	_abortAssetCreate ($linkid=0)

	getSelectedCreateLocations ()

	getAllSelectableCreateLocations ()

	_getMetadataSchemasToApply ()

	getFixedCreateLocations ()

	getRuleMatchCreateLocations ($create_type, $attributes=Array())

	getCreateLocations ($create_type)

	getAdditionalCreateLocations ()

	getDynamicCreateLocations ()

	_sanitiseLocationSetName ($set_name)

	_modifyCreateLink (&$link)

	_setCreateStatus (&$new_asset)

	_loadAssetReplacements ()

	_loadCreateReplacements ()

	_printContents ()

	_errorHandler ($err_no, $err_msg, $err_file, $err_line)

	_getBodycopies ()

	onRequestKeywords (&$broadcaster, $vars=Array())

	_getNotLoggedInKeywords ()

	_getLoggedInKeywords ()

	_getCreatedKeywords ()

	_getSelectableLocationKeywords ()

	_getDynamicLocationKeywords ()

	getLoginInviteKeywordReplacement ()

	getLoginErrorKeywordReplacement ()

	getLoginFormKeywordReplacement ()

	getCreatedAssetidKeywordReplacement ()

	getCreatedAssetNameKeywordReplacement ()

	getCreatedAssetShortNameKeywordReplacement ()

	getCreatedAssetUrlKeywordReplacement ()

	getCreatedAssetEditKeywordReplacement ()

	getCreatedAssetBackendKeywordReplacement ()

	getCreateErrorKeywordReplacement ()

	getCreateInviteKeywordReplacement ()

	getCreateFormKeywordReplacement ()

&	_getCreateFormLayout ($type_code)

Public Member Functions inherited from Page
	__construct ($assetid=0)

	_getAllowedLinks ()

	printBody ()

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
	$_current_state = ''

	$_errors = Array()

	$_replacements = Array()

	$_default_state = 'create'

Additional Inherited Members
Protected Member Functions inherited from Page
	_preCreateCheck (Array &$link)

	_createAdditional (Array &$link)

	_getName ($short_name=FALSE)

Detailed Description

Definition at line 38 of file page_asset_builder.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 73 of file page_asset_builder.inc.

Member Function Documentation

_createAdditional ( & $link )

Perform any additional processing required during the creation of this asset

Asset builders create bodycopy assets when they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 91 of file page_asset_builder.inc.

_errorHandler	(	$err_no,
		$err_msg,
		$err_file,
		$err_line
	)

This function captures all errors and warnings that occur to hide them from the user

Parameters

int	$err_no	The type of error (E_*)
string	$err_msg	The error message
string	$err_file	The file the error occured in
string	$err_line	The line the error occured on

Returns: void private

See Also: HIPO_Job::process()

Definition at line 1646 of file page_asset_builder.inc.

_getAllowedLinks ( )

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

Returns: array private

See Also: Asset::_getAllowLinks()

Definition at line 229 of file page_asset_builder.inc.

_getBodycopies ( )

Return an array of bodycopies that need to be created

Returns: array private

Definition at line 1692 of file page_asset_builder.inc.

_getCreatedKeywords ( )

Get the keyword used in created bodycopy

Returns: array protected

Definition at line 1837 of file page_asset_builder.inc.

& _getCreateFormLayout ( $type_code )

Get the create form layout, if available, for a certain create type

Parameters

string $type_code The type code to get the layout for

Returns: object private

Definition at line 2267 of file page_asset_builder.inc.

_getDynamicLocationKeywords ( )

Get the keyword used to select dynamic create locations

Returns: array protected

Definition at line 1877 of file page_asset_builder.inc.

_getLoggedInKeywords ( )

Get the keyword used in logged_in bodycopy

Returns: array protected

Definition at line 1804 of file page_asset_builder.inc.

_getMetadataSchemasToApply ( )

Get the IDs of the metadata schemas that should be applied to newly-created assets

Returns: array protected

Definition at line 1112 of file page_asset_builder.inc.

_getNotLoggedInKeywords ( )

Get the keyword used in not_logged_in bodycopy

Returns: array protected

Definition at line 1767 of file page_asset_builder.inc.

_getSelectableLocationKeywords ( )

Get the keyword used to select selectable create locations

Returns: array protected

Definition at line 1859 of file page_asset_builder.inc.

_loadAssetReplacements ( )

Loads keyword replacements for the newly created asset, into the Asset Builder

Returns: void private

Definition at line 1413 of file page_asset_builder.inc.

_loadCreateReplacements ( )

Loads keyword replacements for the create asset interface, into the Asset Builder

Returns: void private

Definition at line 1431 of file page_asset_builder.inc.

_modifyCreateLink ( & $link )

Takes the default link that was created and allows for adjustments if necessary

Parameters

array &$link the current link array

Returns: void private

Definition at line 1363 of file page_asset_builder.inc.

_printBody ( )

Prints the Asset Builder form and contents

Returns: void public

Definition at line 312 of file page_asset_builder.inc.

_printContents ( )

Print the contents of the Asset Builder page with replaced keywords

Returns: boolean public

Definition at line 1579 of file page_asset_builder.inc.

_processGlobalActions ( )

Process any global Asset Builder actions

These actions include logging into the system and creating an asset

Returns: boolean private

Definition at line 466 of file page_asset_builder.inc.

_sanitiseLocationSetName ( $set_name )

Sanitises the passed create location set name

Parameters

string $set_name the name to sanitise

Returns: string private

Definition at line 1348 of file page_asset_builder.inc.

_setCreateStatus ( & $new_asset )

Set the status of the newly created asset

Parameters

object &$new_asset the newly created asset

Returns: boolean private

Definition at line 1378 of file page_asset_builder.inc.

getAdditionalCreateLocations ( )

Get a list of additional create locations from the REQUEST var

Also ensures the passed additional locations are valid by checking the allowed additional create locations that have been set in the asset

Returns: array protected

Definition at line 1255 of file page_asset_builder.inc.

getAllSelectableCreateLocations ( )

Get all the create locations that could ever be selected by the user, with their max link type

Returns: array protected

Definition at line 1086 of file page_asset_builder.inc.

getCreatedAssetBackendKeywordReplacement ( )

Get created_asset_backend keyword replacement

Returns: string public

Definition at line 2054 of file page_asset_builder.inc.

getCreatedAssetEditKeywordReplacement ( )

Get created_asset_edit keyword replacement

Returns: string public

Definition at line 2036 of file page_asset_builder.inc.

getCreatedAssetidKeywordReplacement ( )

Get created_assetid keyword replacement

Returns: string public

Definition at line 1963 of file page_asset_builder.inc.

getCreatedAssetNameKeywordReplacement ( )

Get created_asset_name keyword replacement

Returns: string public

Definition at line 1981 of file page_asset_builder.inc.

getCreatedAssetShortNameKeywordReplacement ( )

Get created_asset_short_name keyword replacement

Returns: string public

Definition at line 2000 of file page_asset_builder.inc.

getCreatedAssetUrlKeywordReplacement ( )

Get created_asset_url keyword replacement

Returns: string public

Definition at line 2018 of file page_asset_builder.inc.

getCreateErrorKeywordReplacement ( )

Get create_error keyword replacement

Returns: string public

Definition at line 2072 of file page_asset_builder.inc.

getCreateFormKeywordReplacement ( )

Get create_form keyword replacement

Returns: string public

Definition at line 2098 of file page_asset_builder.inc.

getCreateInviteKeywordReplacement ( )

Get create_invite keyword replacement

Returns: string public

Definition at line 2085 of file page_asset_builder.inc.

getCreateLocations ( $create_type )

Get the relevant create locations for a new asset

Parameters

string $create_type the type of asset we are getting create locations for

Returns: array protected

Definition at line 1220 of file page_asset_builder.inc.

getDynamicCreateLocations ( )

Get a list of dynamic create locations from the REQUEST var

Returns: array protected

Definition at line 1314 of file page_asset_builder.inc.

getFixedCreateLocations ( )

Get the fixed create locations

Just included for completeness & consistency

Returns: array protected

Definition at line 1133 of file page_asset_builder.inc.

getFormCaptchaFieldKeywordReplacement ( )

Form Captcha Field keyword replacement

Returns: string public

Definition at line 434 of file page_asset_builder.inc.

getFormCaptchaImageKeywordReplacement ( )

Form Captcha Image keyword replacement

Returns: string public

Definition at line 390 of file page_asset_builder.inc.

getFormCaptchaKeywordReplacement ( )

Form Captcha keyword replacement

Returns: string public

Definition at line 344 of file page_asset_builder.inc.

getFormCaptchaLinkKeywordReplacement ( )

Form Captcha Link keyword replacement

Returns: string public

Definition at line 449 of file page_asset_builder.inc.

getLoginErrorKeywordReplacement ( )

Get login_invite keyword replacement

Returns: string public

Definition at line 1911 of file page_asset_builder.inc.

getLoginFormKeywordReplacement ( )

Get login_form keyword replacement

Returns: string public

Definition at line 1924 of file page_asset_builder.inc.

getLoginInviteKeywordReplacement ( )

Get login_invite keyword replacement

Returns: string public

Definition at line 1898 of file page_asset_builder.inc.

getRuleMatchCreateLocations	(	$create_type,
		$attributes = `Array()`
	)

Get the create locations determined by rule matches

Parameters

string	$create_type	The type of the asset being created
array	$attributes	The attributes of the new asset. (If blank, attributes read from POST)

Returns: array protected

Definition at line 1149 of file page_asset_builder.inc.

getSelectedCreateLocations ( )

Get the selectable create locations that the user has actually selected for the new asset

Returns: array protected

Definition at line 1046 of file page_asset_builder.inc.

isDeletableLink ( $linkid )

Returns TRUE if we can delete the passed link, or a string with the error msg

Parameters

int $linkid the link id of the link to remove

Returns: mixed boolean|string public

Definition at line 208 of file page_asset_builder.inc.

onRequestKeywords	(	&	$broadcaster,
			$vars = `Array()`
	)

Add valid keywords for this asset to an array of keywords when asked

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster we add keywords to the $vars['keywords'] array

Returns: boolean public

Definition at line 1729 of file page_asset_builder.inc.

prepareLink	(	&	$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 187 of file page_asset_builder.inc.

printBody ( )

Called by the design to print the body of this asset

Returns: void public

Definition at line 245 of file page_asset_builder.inc.

saveAttributes ( $dont_run_updated = FALSE )

Save attributes set with setAttrValue to the database

Parameters

boolean $dont_run_updated if TRUE this->_updated() won't be run (THIS IS ONLY EVER CALLED FROM Asset::create())

Returns: boolean public

See Also: setAttrValue()

Definition at line 123 of file page_asset_builder.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/cms/page_templates/page_asset_builder/page_asset_builder.inc

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation