Order Class Reference

Inheritance diagram for Order:

Public Member Functions
	Order ($assetid=0)
	_getAllowedLinks ()
	total ()
	itemCount ()
	lineCount ()
	getLines ()
	createLine ($product_assetid, $price, $quantity=1)
	buildLinesFromCart ($cart_items, $clear_after=true)
Public Member Functions inherited from Form_Submission
	Form_Submission ($assetid=0)
	canCloneLink ()
	getAnswer ($id)
	getExtraData ($id)
	getName ($id)
	setAnswer ($id, $value)
	setExtraData ($id, Array $data=NULL)
	setError ($error)
	getErrors ()
	flushErrors ()
	isError ()
	getAnswers ()
	setSummary ($question_id, $name, $value)
	getSummary ($q_id=NULL, $value='answer')
	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)
	incrementVersion ($number='micro', $update_parents=TRUE)
	printFrontend ()
	printBody ()
	getKeywordReplacement ($keyword)
	getAvailableKeywords ()
	getIP ()
	setIP ($ip)
	getSubmissionIpAddressKeywordReplacement ()
	_getAllowedLinks ()
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 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 31 of file order.inc.

Member Function Documentation

_getAllowedLinks

(

)

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

See Also

Asset::_getAllowLinks() private

Definition at line 58 of file order.inc.

buildLinesFromCart	(		$cart_items,
			$clear_after = true
	)

Build an order based on items in a cart

Parameters

	object	Ecommerce_Cart &$cart the cart to convert
boolean	$clear_after	whether the cart should be cleared after transferring

Returns

boolean indicating success public

Definition at line 198 of file order.inc.

createLine	(		$product_assetid,
			$price,
			$quantity = 1
	)

Creates an Order Line asset and links it underneath this asset

Parameters

int	$product_assetid	the assetid of the product this orderline represents
int	$price	the per item price of the product
int	$quantity	quantity of product requested default: 1

Returns

boolean indicating success public

Definition at line 157 of file order.inc.

getLines

(

)

Gets an array of order lines residing underneath this asset

Order lines are to be TYPE_3 linked to its parent order, as it does not need to be separately viewed on the backend

Returns

Array(string) an array of assetids public

Definition at line 132 of file order.inc.

itemCount

(

)

Calculate a simple count of items of this order

Returns

int public

Definition at line 94 of file order.inc.

lineCount

(

)

Calculate a simple count of lines in this order

Returns

int public

Definition at line 115 of file order.inc.

Order

(

$assetid = 0

)

Constructor

Parameters

string

$assetid

the assetid of the asset to load into this object

Returns

void public

Definition at line 43 of file order.inc.

total

(

)

Calculate a simple total of this order

Returns

double public

Definition at line 73 of file order.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/ecommerce/orders/order/order.inc