Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Ecommerce_Order Class Reference
Inheritance diagram for Ecommerce_Order:
Asset MySource_Object

Public Member Functions

 Ecommerce_Order ($assetid=0)
 
 _createAdditional (&$link)
 
 _getAllowedLinks ()
 
 create (&$link)
 
 setAttrValue ($name, $value)
 
 _linkProducts ($products)
 
 setOrderStatus ($status, $message='')
 
 getOrderStatus ()
 
 getAvailableKeywords ()
 
 _getCheckoutAssetId ()
 
 getCheckoutAssetidKeywordReplacement ()
 
 getOrderSummaryKeywordReplacement ()
 
 getStatusKeywordReplacement ()
 
 getStatusMessageKeywordReplacement ()
 
 getEditUrlKeywordReplacement ()
 
 getOrderXmlKeywordReplacement ()
 
 getOrderGrandTotalKeywordReplacement ()
 
getDeliveryMethod ()
 
 appendAuditLog ($msg)
 
- 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 34 of file ecommerce_order.inc.

Member Function Documentation

_createAdditional ( $link)

Perform any additional processing required during the creation of this asset

Orders add a default web path when they are created

Parameters
array&$linkinformation used to create the initial link

private

Returns
boolean

Definition at line 64 of file ecommerce_order.inc.

_getAllowedLinks ( )

Returns an array of all the permitted links type, the type asset and the cardinality In the form

Array('[link_type]' => Array('[type_code]' => Array('card' => [cardinality], 'exclusive' => [exclusive]))); Where: link_type = SQ_LINK_TYPE_1|SQ_LINK_TYPE_2|SQ_LINK_TYPE_3|SQ_LINK_NOTICE cardinality = [max number of links]|'M' exclusive = true|false

Returns
array private

Definition at line 91 of file ecommerce_order.inc.

_getCheckoutAssetId ( )

Get checkout asset id

Get the asset id of checkout that created this order

Returns
int private

Definition at line 331 of file ecommerce_order.inc.

_linkProducts (   $products)

Link products to this order

Parameters
$productsarray of products
Returns
boolean private

Definition at line 152 of file ecommerce_order.inc.

appendAuditLog (   $msg)

Append a message to the Audit History Log of this Order

Parameters
$msgThe message to be added
Returns
void public

Definition at line 475 of file ecommerce_order.inc.

create ( $link)

Create this asset

Parameters
array&$linkinformation used to create the initial link
See Also
Asset::create()
Returns
mixed int or false public

Definition at line 110 of file ecommerce_order.inc.

Ecommerce_Order (   $assetid = 0)

Constructor

Parameters
string$assetidthe assetid of the asset to load into this object
Returns
void public

Definition at line 46 of file ecommerce_order.inc.

getAvailableKeywords ( )

Return the keywords for this asset type.

This function is called in order to get the list of available keywords for this asset.

The return value is in the form:

Array(
  'keyword' => 'description'
);

public

Returns
array

Definition at line 306 of file ecommerce_order.inc.

getCheckoutAssetidKeywordReplacement ( )

Get checkout_assetid keyword replacement

This function assumes there is only one checkout form associated with this ecommerce order.

Returns
int public

Definition at line 351 of file ecommerce_order.inc.

& getDeliveryMethod ( )

Get the delivery method related to this order, if set

Returns
object Ecommerce_Delivery_Method or null public

Definition at line 456 of file ecommerce_order.inc.

getEditUrlKeywordReplacement ( )

Get edit_url keyword replacement

Returns
int public

Definition at line 403 of file ecommerce_order.inc.

getOrderGrandTotalKeywordReplacement ( )

Get order_grand_total keyword replacement

Returns
int public

Definition at line 443 of file ecommerce_order.inc.

getOrderStatus ( )

Return the status of order

Returns
array public

Definition at line 275 of file ecommerce_order.inc.

getOrderSummaryKeywordReplacement ( )

Get order_summary keyword replacement

Returns
string public

Definition at line 364 of file ecommerce_order.inc.

getOrderXmlKeywordReplacement ( )

Get order_xml keyword replacement

Returns
string public

Definition at line 430 of file ecommerce_order.inc.

getStatusKeywordReplacement ( )

Get status keyword replacement

Returns
int public

Definition at line 377 of file ecommerce_order.inc.

getStatusMessageKeywordReplacement ( )

Get status_message keyword replacement

Returns
int public

Definition at line 390 of file ecommerce_order.inc.

setAttrValue (   $name,
  $value 
)

Set Attribute Value

Parameters
$namename of attribute
$valuevalue of attribute
Returns
boolean public

Definition at line 126 of file ecommerce_order.inc.

setOrderStatus (   $status,
  $message = '' 
)

Set the status of order

Parameters
$statusstatus constant defined in order
Returns
boolean public

Definition at line 197 of file ecommerce_order.inc.


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