Inheritance diagram for Page_Multiple_Page:

Public Member Functions
	__construct ($assetid=0)

	_getAllowedLinks ()

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

	printBody ()

	printPage (&$asset)

	getContent ()

	lockTypes ()

	getEditingLocks ($keywords)

	getNumberofPages ()

	getPageLinks ()

&	getPageAsset ($page_number)

	getPageIds ()

	linksUpdated ()

	getPageNewWebpaths (&$page, $order)

	getAvailableKeywords ()

	createChildPage ($name='page', $link_type=SQ_LINK_TYPE_2)

	getCurrentPageId ()

&	getCurrentPage ()

	getKeywordReplacement ($value)

&	getFirstPageAsset ()

	printFrontend ()

	paintTOC ($ordered=FALSE, $link_current=FALSE)

	paintNavSelectionList ($link_current=FALSE)

	sortOrder ($linkid, $sort_order, $switch)

	cloneComponents (&$clone, $components, $override=FALSE)

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 ()

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

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

	_createAdditional (Array &$link)

	_getName ($short_name=FALSE)

Detailed Description

Definition at line 32 of file page_multiple_page.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 42 of file page_multiple_page.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 57 of file page_multiple_page.inc.

cloneComponents	(	&	$clone,
			$components,
			$override = `FALSE`
	)

Clones certain specified components of the asset

Parameters

object	&$clone	the clone asset shell
array	$components	the wanted components to clone eg. Array( 'attributes', 'metadata_schemas', 'metadata', 'workflow', 'permissions', 'data', 'content_tags', 'roles', ); or alternately Array('all');
boolean	$override	whether or not to override the existing permission, metadata schemas, workflow schemas with the new ones.

Returns: boolean public

See Also: asset::cloneComponents()

Definition at line 848 of file page_multiple_page.inc.

createChildPage	(	$name = `'page'`,
		$link_type = `SQ_LINK_TYPE_2`
	)

Create a new Child Page Underneath this

Parameters

string	$name	The name of the new page to create
int	$link_type	The link type to create it with

Returns: array public

Definition at line 411 of file page_multiple_page.inc.

getAvailableKeywords ( )

Return the keywords for this asset type.

Returns: array public

Definition at line 373 of file page_multiple_page.inc.

getContent ( )

Returns the raw content of this asset

Returns: string public

Definition at line 150 of file page_multiple_page.inc.

& getCurrentPage ( )

Analyses the current URL, and works out what page we need to find. This comes in handy when we need to perform functions without having the printbody() or printPage() functions called, like Paint Layout keywords

Returns: string public

Definition at line 465 of file page_multiple_page.inc.

getCurrentPageId ( )

Return the index (1-based) of the Multiple Page Page corresponding to the current URL If the current URL is the Multiple Page itself, return 1 Return 0 if no match found

Analyses the current URL, and works out what page we need to find. This comes in handy when we need to perform functions without having the printbody() or printPage() functions called, like Paint Layout keywords

Returns: string public

Definition at line 434 of file page_multiple_page.inc.

getEditingLocks ( $keywords )

Return any locks that are needed for editing, based on a set of custom keywords

Parameters

array $keywords the keywords to govern what locks are required

Returns: array public

Definition at line 181 of file page_multiple_page.inc.

& getFirstPageAsset ( )

Retrieves the first page for the series

Returns: void public

Definition at line 690 of file page_multiple_page.inc.

getKeywordReplacement ( $value )

Replaces all keywords for both itself and the child Instantiates the current page asset if it doesnt exist.

Parameters

string $value The Value of the keyword that needs replacing

Returns: array public

Definition at line 481 of file page_multiple_page.inc.

getNumberofPages ( )

Get the number of pages we currently have

Returns: int public

See Also: Asset::processCustomKeywords()

Definition at line 200 of file page_multiple_page.inc.

& getPageAsset ( $page_number )

Get a multiple page page that resides underneath us

Parameters

int $page_number The number of page you wish to retrieve

Returns: object public

Definition at line 231 of file page_multiple_page.inc.

getPageIds ( )

Get the IDs of all the pages that reside underneath

Returns: object public

Definition at line 252 of file page_multiple_page.inc.

getPageLinks ( )

Get links to all the page children of this asset

Returns: int public

See Also: Asset::processCustomKeywords()

Definition at line 214 of file page_multiple_page.inc.

getPageNewWebpaths	(	&	$page,
			$order
	)

Return the new webpaths for a page under this asset It will remove all numeric paths and if there are no paths left it will set it to $order

Parameters

object	&$page	a reference to an asset
int	$order	a number

Returns: array protected

Definition at line 352 of file page_multiple_page.inc.

linksUpdated ( )

Allow any required processesing to occur when any link is updated for the asset

Returns: void protected

Definition at line 274 of file page_multiple_page.inc.

lockTypes ( )

Returns a list of lock types available for this asset type

Returns: array public

Definition at line 164 of file page_multiple_page.inc.

paintNavSelectionList ( $link_current = FALSE )

Prints a Selection List with onChange event to navigate between pages.

Parameters

boolean $link_current Show current page as a link?

Returns: string public

Definition at line 772 of file page_multiple_page.inc.

paintTOC	(	$ordered = `FALSE`,
		$link_current = `FALSE`
	)

Prints out a Table of Contents for this set of pages

Parameters

boolean	$ordered	Whether to display an OL or UL
boolean	$link_current	Show current page as a link?

Returns: string public

Definition at line 723 of file page_multiple_page.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 86 of file page_multiple_page.inc.

printBody ( )

Called by the design to print the body of this asset

Returns: void public

Definition at line 106 of file page_multiple_page.inc.

printFrontend ( )

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

Returns: void public

Definition at line 705 of file page_multiple_page.inc.

printPage ( & $asset )

Called by the child pages, when their url is accessed

Parameters

object &$asset The asset object of the page to print

Returns: void public

Definition at line 124 of file page_multiple_page.inc.

sortOrder	(	$linkid,
		$sort_order,
		$switch
	)

Prints a Selection List with onChange event to navigate between pages.

Parameters

int	$linkid	The id of the link being passed
int	$sort_order	The order of the link to be changed
boolean	$switch	Boolean value to determine whether saveWebPath() should be executed.

Returns: string public

Definition at line 816 of file page_multiple_page.inc.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation