order Class Reference

Inheritance diagram for order:

Collaboration diagram for order:

Public Member Functions
	init ()
	render ()
	execute ()
	getPayment ()
	getBasket ()
	getExecuteFnc ()
	getOrderRemark ()
	getBasketArticles ()
	getDelAddress ()
	getShipSet ()
	isConfirmAGBActive ()
	isConfirmCustInfoActive ()
	isConfirmAGBError ()
	isConfirmCustInfoError ()
	showOrderButtonOnTop ()
	isWrapping ()
	getBreadCrumb ()
	getAddressError ()
	getDeliveryAddressMD5 ()
	getBasketContentMarkGenerator ()
Public Member Functions inherited from oxUBase
	getViewId ()
	showSorting ()
	setComponents ($aComponents=null)
	getComponents ()
	getComponent ($sName)
	setIsOrderStep ($blIsOrderStep=null)
	getIsOrderStep ()
	setActiveCategory ($oCategory)
	getActiveCategory ()
	getListType ()
	getListDisplayType ()
	getCustomListDisplayType ()
	setListType ($sType)
	loadCurrency ()
	dontShowEmptyCategories ()
	showCategoryArticlesCount ()
	isLanguageLoaded ()
	getTopNavigationCatCnt ()
	addRssFeed ($sTitle, $sUrl, $key=null)
	getSortOrderByParameterName ()
	getSortOrderParameterName ()
	getSortIdent ()
	getDefaultSorting ()
	getUserSelectedSorting ()
	getSavedSorting ($sSortIdent)
	setListOrderBy ($sColumn)
	setListOrderDirection ($sDirection)
	getListOrderBy ()
	getListOrderDirection ()
	setMetaDescription ($sDescription)
	setMetaKeywords ($sKeywords)
	getMetaKeywords ()
	getMetaDescription ()
	getActCurrency ()
	setActCurrency ($oCur)
	getCompareItemCount ()
	noIndex ()
	getMenueList ()
	setMenueList ($aMenu)
	getNavigationParams ()
	setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
	getSorting ($sSortIdent)
	getSortingSql ($sIdent)
	getTitleSuffix ()
	getTitlePageSuffix ()
	getTitlePrefix ()
	getPageTitle ()
	getDynUrlParams ()
	getBaseLink ($iLang=null)
	getLink ($iLang=null)
	getCanonicalUrl ()
	getSimilarRecommListIds ()
	getSearchParamForHtml ()
	showSearch ()
	getRssLinks ()
	getSortColumns ()
	setSortColumns ($aSortColumns)
	getEditTags ()
	getRecommSearch ()
	getPaymentList ()
	getActiveRecommList ()
	getAccessoires ()
	getCrossSelling ()
	getSimilarProducts ()
	getAlsoBoughtTheseProducts ()
	getArticleId ()
	getTitle ()
	getActiveLangAbbr ()
	addGlobalParams ($oShop=null)
	getAdditionalParams ()
	generatePageNavigationUrl ()
	getPageNavigation ()
	getPageNavigationLimitedTop ($iPositionCount=7)
	getPageNavigationLimitedBottom ($iPositionCount=11)
	generatePageNavigation ($iPositionCount=0)
	getViewProduct ()
	setViewProduct ($oProduct)
	getViewProductList ()
	getActPage ()
	getActTag ()
	getActVendor ()
	getActManufacturer ()
	setActVendor ($oVendor)
	setActManufacturer ($oManufacturer)
	getActSearch ()
	getCategoryTree ()
	setCategoryTree ($oCatTree)
	getManufacturerTree ()
	setManufacturerTree ($oManufacturerTree)
	getAddUrlParams ()
	getTop5ArticleList ($iCount=null)
	getBargainArticleList ()
	isLowOrderPrice ()
	getMinOrderPrice ()
	getNewsRealStatus ()
	getProduct ()
	getManufacturerlist ()
	setManufacturerlist ($aList)
	setRootVendor ($oVendor)
	getRootVendor ()
	setRootManufacturer ($oManufacturer)
	getRootManufacturer ()
	getVendorId ()
	getManufacturerId ()
	getCatMoreUrl ()
	getCatTreePath ()
	getContentByIdent ($sIdent)
	getContentCategory ()
	getMustFillFields ()
	isFieldRequired ($sField)
	getFormId ()
	canAcceptFormData ()
	getPromoFinishedList ()
	getPromoCurrentList ()
	getPromoFutureList ()
	getShowPromotionList ()
	isEnabledPrivateSales ()
	getFieldValidationErrors ()
	setRootCatChanged ($blRootCatChanged)
	isRootCatChanged ()
	getInvoiceAddress ()
	getDeliveryAddress ()
	setDeliveryAddress ($aDeliveryAddress)
	setInvoiceAddress ($aAddress)
	getActiveUsername ()
	getWishlistUserId ()
	getSearchCatId ()
	getSearchVendor ()
	getSearchManufacturer ()
	getLastProducts ()
	getNewBasketItemMsgType ()
	isActive ($sName)
	isFbWidgetVisible ()
	isEnabledDownloadableFiles ()
	showRememberMe ()
	isVatIncluded ()
	isPriceCalculated ()
	showTags ()
	getWishlistName ()
	getWidgetLink ()
Public Member Functions inherited from oxView
	setViewParameters ($aParams=null)
	getViewParameter ($sKey)
	setIsCallForCache ($blIsCallForCache=null)
	getIsCallForCache ()
	addTplParam ($sPara, $sValue)
	getBelboonParam ()
	getViewConfig ()
	getTemplateName ()
	setTemplateName ($sTemplate)
	setClassName ($sClassName)
	getClassName ()
	setFncName ($sFncName)
	getFncName ()
	setViewData ($aViewData=null)
	getViewData ()
	getViewDataElement ($sParamId=null)
	setClassLocation ($sClassLocation=null)
	getClassLocation ()
	setThisAction ($sThisAction=null)
	getThisAction ()
	setParent ($oParent=null)
	getParent ()
	setIsComponent ($blIsComponent=null)
	getIsComponent ()
	executeFunction ($sFunction)
	getTrustedShopId ()
	getTSExcellenceId ()
	getCharSet ()
	getShopVersion ()
	getShopEdition ()
	getRevision ()
	getPackageInfo ()
	getShopFullEdition ()
	isDemoVersion ()
	isBetaVersion ()
	isRCVersion ()
	showBetaNote ()
	isDemoShop ()
	showNewsletter ()
	setShowNewsletter ($blShow)
	getShopLogo ()
	setShopLogo ($sLogo)
	getActCategory ()
	setActCategory ($oCategory)
	getCategoryId ()
	setCategoryId ($sCategoryId)
	getErrorDestination ()
	getActionClassName ()
	isConnectedWithFb ()
	getFbUserId ()
	showFbConnectToAccountMsg ()
	isMall ()
	showRdfa ()
	getSidForWidget ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	__construct ()
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_getNextStep ($iSuccess)
	_validateTermsAndConditions ()
Protected Member Functions inherited from oxUBase
	_getComponentNames ()
	_processRequest ()
	_getMetaFromSeo ($sDataType)
	_getMetaFromContent ($sMetaIdent)
	_forceNoIndex ()
	_setNrOfArtPerPage ()
	_getSeoObjectId ()
	_prepareMetaDescription ($sMeta, $iLength=1024, $blRemoveDuplicatedWords=false)
	_prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
	_removeDuplicatedWords ($aInput, $aSkipTags=array())
	_getSubject ($iLang)
	_getRequestParams ($blAddPageNr=true)
	_getSeoRequestParams ()
	_addPageNrParam ($sUrl, $iPage, $iLang=null)
	_canRedirect ()
Protected Member Functions inherited from oxView
	_executeNewAction ($sNewAction)

Protected Attributes
	$_oPayment = null
	$_oBasket = null
	$_sOrderRemark = null
	$_oBasketArtList = null
	$_sRemoteAddress = null
	$_oDelAddress = null
	$_oShipSet = null
	$_blConfirmAGB = null
	$_blShowOrderButtonOnTop = null
	$_blConfirmAGBError = null
	$_blConfirmCustInfo = null
	$_blConfirmCustInfoError = null
	$_sThisTemplate = 'page/checkout/order.tpl'
	$_blIsOrderStep = true
	$_iWrapCnt = null
Protected Attributes inherited from oxUBase
	$_blFbWidgetsOn = null
	$_sRemoveMetaChars = '.\+*?[^]$(){}=!<>|:&'
	$_oaComponents = array()
	$_blIsOrderStep = false
	$_sListType = null
	$_aListDisplayTypes = array('grid', 'line', 'infogrid')
	$_sListDisplayType = null
	$_sCustomListDisplayType = null
	$_oActCategory = null
	$_oActManufacturer = null
	$_oActVendor = null
	$_oActiveRecommList = null
	$_oActSearch = null
	$_blShowSorting = false
	$_blLoadCurrency = null
	$_blLoadManufacturerTree = null
	$_blDontShowEmptyCats = null
	$_blLoadLanguage = null
	$_iTopCatNavItmCnt = null
	$_aRssLinks = null
	$_sListOrderBy = null
	$_sListOrderDir = null
	$_sMetaDescription = null
	$_sMetaKeywords = null
	$_sMetaDescriptionIdent = null
	$_sMetaKeywordsIdent = null
	$_sAdditionalParams = null
	$_oActCurrency = null
	$_blEnabledPrivateSales = null
	$_blCommonAdded = false
	$_iViewIndexState = VIEW_INDEXSTATE_INDEX
	$_blForceNoIndex = false
	$_iCompItemsCnt = null
	$_sContentId = null
	$_oContent = null
	$_sViewResetID = null
	$_aMenueList = null
	$_aComponentNames
	$_aUserComponentNames = array()
	$_oProduct = null
	$_iActPage = null
	$_aArticleList = null
	$_oManufacturerTree = null
	$_oCategoryTree = null
	$_aTop5ArticleList = null
	$_aBargainArticleList = null
	$_blLowOrderPrice = null
	$_sMinOrderPrice = null
	$_iNewsRealStatus = null
	$_aBlockRedirectParams = array('fnc', 'stoken', 'force_sid', 'force_admin_sid')
	$_oRootVendor = null
	$_sVendorId = null
	$_aManufacturerlist = null
	$_oRootManufacturer = null
	$_sManufacturerId = null
	$_blNewsSubscribed = null
	$_oDelAddress = null
	$_sCatTreePath = null
	$_aContents = array()
	$_blTop5Action = false
	$_blBargainAction = false
	$_aMustFillFields = null
	$_blShowTagCloud = true
	$_blRootCatChanged = false
	$_aInvoiceAddress = null
	$_aDeliveryAddress = null
	$_sActiveUsername = null
	$_blLoadComponents = true
	$_aSortColumns = null
Protected Attributes inherited from oxView
	$_aViewData = array()
	$_sClassLocation = null
	$_sThisAction = null
	$_oParent = null
	$_blIsComponent = false
	$_sThisTemplate = null
	$_sViewId = null
	$_sClass = null
	$_sFnc = null
	$_sTrustedShopId = null
	$_sTSExcellenceId = null
	$_sCharSet = null
	$_sVersion = null
	$_blDemoVersion = null
	$_blDemoShop = null
	$_iNewsStatus = null
	$_sShopLogo = null
	$_sCategoryId = null
	$_oClickCat = null
	$_blIsCallForCache = false
	$_oViewConf = null

Additional Inherited Members
Static Protected Attributes inherited from oxUBase
static	$_aCollectedComponentNames = null

Detailed Description

Order manager. Arranges user ordering data, checks/validates it, on success stores ordering data to DB.

Definition at line 7 of file order.php.

Member Function Documentation

order::_getNextStep (   $iSuccess )

protected

Returns next order step. If ordering was sucessfull - returns string "thankyou" (possible additional parameters), otherwise - returns string "payment" with additional error parameters.

Parameters

integer

$iSuccess

status code

Returns

string $sNextStep partial parameter url for next step

Definition at line 543 of file order.php.

order::_validateTermsAndConditions ( )

protected

Validates whether necessary terms and conditions checkboxes were checked.

Returns

bool

Definition at line 587 of file order.php.

order::execute

(

)

Checks for order rules confirmation ("ord_agb", "ord_custinfo" form values)(if no rules agreed - returns to order view), loads basket contents (plus applied price/amount discount if available - checks for stock, checks user data (if no data is set - returns to user login page). Stores order info to database (oxorder::finalizeOrder()). According to sum for items automatically assigns user to special user group ( oxuser::onOrderExecute(); if this option is not disabled in admin). Finally you will be redirected to next page (order::_getNextStep()).

Returns

string

Definition at line 193 of file order.php.

order::getAddressError

(

)

Return error number

Returns

int

Definition at line 494 of file order.php.

order::getBasket

(

)

Template variable getter. Returns active basket

Returns

oxBasket

Definition at line 284 of file order.php.

order::getBasketArticles

(

)

Template variable getter. Returns basket article list

Returns

object

Definition at line 328 of file order.php.

order::getBasketContentMarkGenerator

(

)

Method returns object with explanation marks for articles in basket.

Returns

oxBasketContentMarkGenerator

Definition at line 526 of file order.php.

order::getBreadCrumb

(

)

Returns Bread Crumb - you are here page1/page2/page3...

Returns

array

Reimplemented from oxUBase.

Definition at line 475 of file order.php.

order::getDelAddress

(

)

Template variable getter. Returns delivery address

Returns

object

Definition at line 345 of file order.php.

order::getDeliveryAddressMD5

(

)

Return users setted delivery address md5

Returns

string

Definition at line 504 of file order.php.

order::getExecuteFnc

(

)

Template variable getter. Returns execution function name

Returns

string

Definition at line 301 of file order.php.

order::getOrderRemark

(

)

Template variable getter. Returns user remark

Returns

string

Definition at line 311 of file order.php.

order::getPayment

(

)

Template variable getter. Returns payment object

Returns

object

Definition at line 251 of file order.php.

order::getShipSet

(

)

Template variable getter. Returns shipping set

Returns

object

Definition at line 361 of file order.php.

order::init

(

)

Loads basket oxsession::getBasket(), sets $this->oBasket->blCalcNeeded = true to recalculate, sets back basket to session oxsession::setBasket(), executes parent::init().

Reimplemented from oxUBase.

Definition at line 121 of file order.php.

order::isConfirmAGBActive

(

)

Template variable getter. Returns if option "blConfirmAGB" is on

Returns

bool

Definition at line 381 of file order.php.

order::isConfirmAGBError

(

)

Template variable getter. Returns if option "blConfirmAGB" was not set

Returns

bool

Definition at line 416 of file order.php.

order::isConfirmCustInfoActive

(

)

Template variable getter. Returns if option "blConfirmCustInfo" is on.

Deprecated:

since v5.1.6 (2014-05-28); Not used anymore

Returns

bool

Definition at line 398 of file order.php.

order::isConfirmCustInfoError

(

)

Template variable getter. Returns if option "blConfirmCustInfo" was not set.

Deprecated:

since v5.1.6 (2014-05-28); Not used anymore

Returns

bool

Definition at line 428 of file order.php.

order::isWrapping

(

)

Returns wrapping options availability state (TRUE/FALSE)

Returns

bool

Definition at line 453 of file order.php.

order::render

(

)

Executes parent::render(), if basket is empty - redirects to main page and exits the script (oxorder::validateOrder()). Loads and passes payment info to template engine. Refreshes basket articles info by additionally loading each article object (oxorder::getProdFromBasket()), adds customer addressing/delivering data (oxorder::getDelAddressInfo()) and delivery sets info (oxorder::getShipping()). Returns name of template to render order::_sThisTemplate.

Returns

string

Reimplemented from oxUBase.

Definition at line 144 of file order.php.

order::showOrderButtonOnTop

(

)

Template variable getter. Returns if option "blShowOrderButtonOnTop" is on

Returns

bool

Definition at line 438 of file order.php.

Member Data Documentation

order::$_blConfirmAGB = null

protected

Definition at line 64 of file order.php.

order::$_blConfirmAGBError = null

protected

Definition at line 78 of file order.php.

order::$_blConfirmCustInfo = null

protected

Definition at line 86 of file order.php.

order::$_blConfirmCustInfoError = null

protected

Definition at line 94 of file order.php.

order::$_blIsOrderStep = true

protected

Definition at line 108 of file order.php.

order::$_blShowOrderButtonOnTop = null

protected

Definition at line 71 of file order.php.

order::$_iWrapCnt = null

protected

Count of wrapping + cards options

Definition at line 113 of file order.php.

order::$_oBasket = null

protected

Definition at line 22 of file order.php.

order::$_oBasketArtList = null

protected

Definition at line 36 of file order.php.

order::$_oDelAddress = null

protected

Definition at line 50 of file order.php.

order::$_oPayment = null

protected

Definition at line 15 of file order.php.

order::$_oShipSet = null

protected

Definition at line 57 of file order.php.

order::$_sOrderRemark = null

protected

Definition at line 29 of file order.php.

order::$_sRemoteAddress = null

protected

Definition at line 43 of file order.php.

order::$_sThisTemplate = 'page/checkout/order.tpl'

protected

Definition at line 101 of file order.php.

---

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

• application/controllers/order.php