Inheritance diagram for Ecommerce_Delivery_Method:

Public Member Functions
	Ecommerce_Delivery_Method ($assetid=0)

	getInputInterface ()

	processInputInterface ()

	getState ()

	setState ($state=Array())

	validateState ()

	processDelivery ()

	getSummary ()

	getReceipt ($html=false)

	getReceiptSummary ()

	getConfirmationSummary ()

	getDeliveryMethodXML ()

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
	$state

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

Detailed Description

Definition at line 34 of file ecommerce_delivery_method.inc.

Member Function Documentation

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

protected

Returns 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 return the name from

Returns: string private

See Also: Asset::_getName()

Definition at line 192 of file ecommerce_delivery_method.inc.

Ecommerce_Delivery_Method ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 49 of file ecommerce_delivery_method.inc.

getConfirmationSummary ( )

Returns a confirmation summary that can be used by the checkout to be printed on the frontend

Parameters

string $html set to true for HTML format, set to false for text format

Returns: string public

Definition at line 248 of file ecommerce_delivery_method.inc.

getDeliveryMethodXML ( )

Get the XML representation of the delivery method to store in the order_xml attribute of Ecommerce Order asset

Returns: string public

Definition at line 261 of file ecommerce_delivery_method.inc.

getInputInterface ( )

Paint Input Interface

Produce an interface for obtaining the values required by this delivery method

Returns: string html representation of the interface public

Definition at line 65 of file ecommerce_delivery_method.inc.

getReceipt ( $html = false )

Returns a receipt that can be used by the checkout to genearate order summary

Parameters

string $html set to true for HTML format, set to false for text format

Returns: string public

Definition at line 218 of file ecommerce_delivery_method.inc.

getReceiptSummary ( )

Returns a receipt summary that can be used by the checkout to be printed on the frontend

Parameters

string $html set to true for HTML format, set to false for text format

Returns: string public

Definition at line 233 of file ecommerce_delivery_method.inc.

getState ( )

Get State

Get the complete session state of this asset. This state can later be used to pass to setState in order to complete the processing. getState can be called any time, but is most effective when called when the state is set - after either setState or processInput was called. If state is not set will return an empty array, which is a valid state.

See Also: Ecommerce_Delivery_Method::setState()

Returns: void public

Definition at line 102 of file ecommerce_delivery_method.inc.

getSummary ( )

Get Textual Representation of delivery information (read-only)

This information is used in receipts and order summaries

Returns: string formatted summary public

Definition at line 175 of file ecommerce_delivery_method.inc.

processDelivery ( )

Process Delivery

This function contains the business logic for processing the delivery Positive output - delivery was processed successfully Negative output - delivery Processing failed and can be retried later. Negative outcome should be the result of not being able to perform the delivery, not because the input is incorrect. Correctness of input should be ensured by validateState()

Returns: boolean whether delivery was processed public

Definition at line 160 of file ecommerce_delivery_method.inc.

processInputInterface ( )

Process Input

The interface painted by paintInputInterface is processed here to populate the state of this delivery method. After successfully processing the input the delivery method is ready to process itself.

Returns: mixed boolean|array whether the input is valid or not public

Definition at line 82 of file ecommerce_delivery_method.inc.

setState ( $state = Array() )

Set State

Allows this asset's state to be re-created from the state container Accepts information produced by getState

See Also: Ecommerce_Delivery_Method::getState()

Parameters

array $state State information

Returns: void public

Definition at line 122 of file ecommerce_delivery_method.inc.

validateState ( )

Validate State

Determines whether the state is valid after using setState or processInput Positive response means that all the input is valid and the delivery is ready to be processed.

Returns: boolean whether delivery is ready to be processed public

Definition at line 141 of file ecommerce_delivery_method.inc.

Field Documentation

$state

Container for state information

Definition at line 40 of file ecommerce_delivery_method.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/ecommerce/delivery_methods/ecommerce_delivery_method/ecommerce_delivery_method.inc

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Member Function Documentation

Field Documentation