OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos Class Reference

Public Member Functions
	__construct ($sPathToFile="", $sScriptFileName="emos2.js")
	prettyPrint ()
	toString ()
	addContent ($sContent)
	addOrderProcess ($sProcessStep)
	addSiteId ($sIiteId)
	addLangId ($sLangId)
	addCountryId ($sCountryId)
	addPageId ($sPageId)
	addSearch ($sQueryString, $iNumberOfHits)
	addRegister ($sUserId, $sResult)
	addLogin ($sUserId, $sResult)
	addContact ($sContactType)
	addDownload ($sDownloadLabel)
	addEmosBasketPageArray ($aBasket)
	addDetailView ($oItem)
	removeFromBasket ($oItem)
	addToBasket ($oItem)
	addEmosBillingPageArray ($sBillingId="", $sCustomerNumber="", $iTotal=0, $sCountry="", $sCip="", $sCity="")
	_prepareScript ()

Protected Member Functions
	_setEmosBillingArray ($sBillingId="", $sCustomerNumber="", $iTotal=0, $sCountry="", $sCip="", $sCity="")
	_setEmosECPageArray ($oItem, $sEvent)
	_emos_ItemFormat ($oItem)
	_emos_DataFormat ($sStr)
	_addJsFormat ($sVarName, $mContents)
	_jsEncode ($mContents)

Protected Attributes
	$_sIncScript = ""
	$_sPrescript = ""
	$_sPostscript = ""
	$_sPathToFile = ""
	$_sScriptFileName = "emos2.js"
	$_content = null
	$_orderProcess = null
	$_siteid = null
	$_langid = null
	$_countryid = null
	$_pageid = null
	$_searchQuery = null
	$_searchNumberOfHits = null
	$_registerUser = null
	$_registerResult = null
	$_loginUser = null
	$_loginResult = null
	$_scontact = null
	$_download = null
	$_billing = null
	$_ecEvent = null
	$_br = ""
	$_tab = ""

Detailed Description

PHP Helper Class to construct a ECONDA Monitor statement for the later inclusion in a HTML/PHP Page.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::__construct	(		$sPathToFile = "",
			$sScriptFileName = "emos2.js"
	)

Constructor Sets the path to the emos2.js js-bib and prepares the later calls

Parameters

string	$sPathToFile	The path to the js-bib (/opt/myjs)
string	$sScriptFileName	If we want to have annother Filename than emos2.js you can set it here

Member Function Documentation

_addJsFormat()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::_addJsFormat (   $sVarName,   $mContents  )

protected

Formats a line in JS format

Parameters

string	$sVarName	Variable name
mixed	$mContents	Variable value

Returns

string

_emos_DataFormat()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::_emos_DataFormat (   $sStr )

protected

formats data/values/params by eliminating named entities and xml-entities

Parameters

string

$sStr

data input to format

Returns

null

_emos_ItemFormat()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::_emos_ItemFormat (   $oItem )

protected

formats data/values/params by eliminating named entities and xml-entities

Parameters

\OxidEsales\Eshop\Core\Smarty\Plugin\EmosItem

$oItem

item to format its parameters

Returns

null

_jsEncode()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::_jsEncode (   $mContents )

protected

Encode contents $mContents to string for JS export

Parameters

mixed

$mContents

Input contents

Returns

string

_prepareScript()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::_prepareScript

(

)

formats up the connector script in a Econda ver 2 JS format

_setEmosBillingArray()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::_setEmosBillingArray (   $sBillingId = "",   $sCustomerNumber = "",   $iTotal = 0,   $sCountry = "",   $sCip = "",   $sCity = ""  )

protected

set a emosBillingArray

Parameters

string	$sBillingId	billing id
string	$sCustomerNumber	customer number
int	$iTotal	total number
string	$sCountry	customer country title
string	$sCip	customer ip
string	$sCity	customer city title

_setEmosECPageArray()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::_setEmosECPageArray (   $oItem,   $sEvent  )

protected

constructs a emosECPageArray of given $sEvent type

Parameters

\OxidEsales\Eshop\Core\Smarty\Plugin\EmosItem	$oItem	an instance of class EMOS_Item
string	$sEvent	Type of this event ("view","c_rmv","c_add")

addContact()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addContact

(

$sContactType

)

sets contact tracking

Parameters

string

$sContactType

contant type

addContent()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addContent

(

$sContent

)

sets content tracking

Parameters

string

$sContent

content to add

addCountryId()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addCountryId

(

$sCountryId

)

sets country tracking

Parameters

string

$sCountryId

country id to add

addDetailView()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addDetailView

(

$oItem

)

adds a detailView to the preScript

Parameters

\OxidEsales\Eshop\Core\Smarty\Plugin\EmosItem

$oItem

item to add to view

addDownload()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addDownload

(

$sDownloadLabel

)

sets download tracking

Parameters

string

$sDownloadLabel

download label

addEmosBasketPageArray()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addEmosBasketPageArray

(

$aBasket

)

adds a emosBasket Page Array to the preScript

Parameters

array

$aBasket

basket items

Returns

null

addEmosBillingPageArray()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addEmosBillingPageArray	(		$sBillingId = "",
			$sCustomerNumber = "",
			$iTotal = 0,
			$sCountry = "",
			$sCip = "",
			$sCity = ""
	)

constructs a emosBillingPageArray of given $sEvent type

Parameters

string	$sBillingId	billing id
string	$sCustomerNumber	customer number
int	$iTotal	total number
string	$sCountry	customer country title
string	$sCip	customer ip
string	$sCity	customer city title

addLangId()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addLangId

(

$sLangId

)

sets language tracking

Parameters

string

$sLangId

language id to add

addLogin()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addLogin	(		$sUserId,
			$sResult
	)

sets login tracking The userid gets a md5() to fullfilll german datenschutzgesetz

Parameters

string	$sUserId	user id
string	$sResult	login result

addOrderProcess()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addOrderProcess

(

$sProcessStep

)

sets orderprocess tracking

Parameters

string

$sProcessStep

process step to add

addPageId()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addPageId

(

$sPageId

)

adds tracker Page ID

Parameters

string

$sPageId

page id to add

addRegister()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addRegister	(		$sUserId,
			$sResult
	)

sets registration tracking The userid gets a md5() to fullfilll german datenschutzgesetz

Parameters

string	$sUserId	user id
string	$sResult	registration result

addSearch()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addSearch	(		$sQueryString,
			$iNumberOfHits
	)

sets search tracking

Parameters

string	$sQueryString	query string
int	$iNumberOfHits	number of hits

addSiteId()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addSiteId

(

$sIiteId

)

sets siteid tracking

Parameters

string

$sIiteId

site id to add

addToBasket()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::addToBasket

(

$oItem

)

adds a addToBasket to the preScript

Parameters

\OxidEsales\Eshop\Core\Smarty\Plugin\EmosItem

$oItem

item to add to basket

prettyPrint()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::prettyPrint

(

)

switch on pretty printing of generated code. If not called, the output will be in one line of html.

removeFromBasket()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::removeFromBasket

(

$oItem

)

adds a removeFromBasket to the preScript

Parameters

\OxidEsales\Eshop\Core\Smarty\Plugin\EmosItem

$oItem

item to remove from basket

toString()

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::toString

(

)

returns the whole statement

Returns

string

Member Data Documentation

$_billing

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_billing = null

protected

$_br

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_br = ""

protected

$_content

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_content = null

protected

$_countryid

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_countryid = null

protected

$_download

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_download = null

protected

$_ecEvent

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_ecEvent = null

protected

$_langid

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_langid = null

protected

$_loginResult

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_loginResult = null

protected

$_loginUser

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_loginUser = null

protected

$_orderProcess

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_orderProcess = null

protected

$_pageid

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_pageid = null

protected

$_registerResult

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_registerResult = null

protected

$_registerUser

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_registerUser = null

protected

$_scontact

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_scontact = null

protected

$_searchNumberOfHits

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_searchNumberOfHits = null

protected

$_searchQuery

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_searchQuery = null

protected

$_sIncScript

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_sIncScript = ""

protected

$_siteid

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_siteid = null

protected

$_sPathToFile

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_sPathToFile = ""

protected

$_sPostscript

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_sPostscript = ""

protected

$_sPrescript

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_sPrescript = ""

protected

$_sScriptFileName

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_sScriptFileName = "emos2.js"

protected

$_tab

OxidEsales\EshopCommunity\Core\Smarty\Plugin\Emos::$_tab = ""

protected

---

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

• /oxideshop-ce/source/Core/Smarty/Plugin/Emos.php