oxView Class Reference

Inheritance diagram for oxView:

Collaboration diagram for oxView:

List of all members.

Public Member Functions
	init ()
	setViewParameters ($aParams=null)
	getViewParameter ($sKey)
	setIsCallForCache ($blIsCallForCache=null)
	getIsCallForCache ()
	getViewId ()
	render ()
	addGlobalParams ($oShop=null)
	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 ()
	getAdditionalParams ()
	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 ()
Protected Member Functions
	_executeNewAction ($sNewAction)
Protected Attributes
	$_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
Static Protected Attributes
static	$_blExecuted = false

---

Detailed Description

Base view class. Collects and passes data to template engine, sets some global configuration parameters.

Definition at line 7 of file oxview.php.

---

Member Function Documentation

oxView._executeNewAction

(

$

sNewAction

)

[protected]

Formats header for new controller action

Input example: "view_name?param1=val1&param2=val2" => "cl=view_name&param1=val1&param2=val2"

Parameters:

string

$sNewAction new action params

Definition at line 528 of file oxview.php.

oxView.addGlobalParams

(

$

oShop = null

)

Sets and caches default parameters for shop object and returns it.

Template variables: isdemoversion, shop, isdemoversion, version, iShopID_TrustedShops, urlsign

Parameters:

oxShop

$oShop current shop object

Returns:

object $oShop current shop object

Reimplemented in oxAdminView, and oxUBase.

Definition at line 253 of file oxview.php.

oxView.addTplParam	(	$	sPara,
		$	sValue
	)

Sets value to parameter used by template engine.

Parameters:

	string	$sPara name of parameter to pass
	string	$sValue value of parameter

Definition at line 277 of file oxview.php.

oxView.getActCategory

(

)

Returns active category set by categories component; if category is not set by component - will create category object and will try to load by id passed by request

Returns:

oxCategory

Reimplemented in Article_Seo.

Definition at line 841 of file oxview.php.

oxView.getActionClassName

(

)

Returns name of a view class, which will be active for an action (given a generic fnc, e.g. logout)

Returns:

string

Reimplemented in Thankyou.

Definition at line 905 of file oxview.php.

oxView.getAdditionalParams

(

)

Template variable getter. Returns additional params for url

Returns:

string

Reimplemented in oxUBase, RecommList, and Review.

Definition at line 569 of file oxview.php.

oxView.getBelboonParam

(

)

Returns belboon parameter

Returns:

string $sBelboon

Definition at line 287 of file oxview.php.

oxView.getCategoryId

(

)

Get category ID

Returns:

string

Definition at line 873 of file oxview.php.

oxView.getCharSet

(

)

Returns active charset

Returns:

string

Definition at line 632 of file oxview.php.

oxView.getClassLocation

(

)

Get location of a executed class file

Returns:

string

Definition at line 422 of file oxview.php.

oxView.getClassName

(

)

Returns class name of current class

Returns:

string

Definition at line 348 of file oxview.php.

oxView.getErrorDestination

(

)

Returns a name of the view variable containing the error/exception messages

Reimplemented in Basket.

Definition at line 895 of file oxview.php.

oxView.getFbUserId

(

)

Gets get Facebook user id

Returns:

int

Definition at line 933 of file oxview.php.

oxView.getFncName

(

)

Returns name of current action function

Returns:

string

Definition at line 368 of file oxview.php.

oxView.getIsCallForCache

(

)

Get cache sign to enable/disable use of cache

Returns:

bool

Definition at line 218 of file oxview.php.

oxView.getIsComponent

(

)

Get flag if this object is a component

Returns:

bool

Definition at line 482 of file oxview.php.

oxView.getPackageInfo

(

)

Returns shop package info

Returns:

string

Definition at line 680 of file oxview.php.

oxView.getParent

(

)

Get parent object

Returns:

null

Definition at line 462 of file oxview.php.

oxView.getRevision

(

)

Returns shop revision

Returns:

string

Definition at line 670 of file oxview.php.

oxView.getShopEdition

(

)

Returns shop edition

Returns:

string

Definition at line 660 of file oxview.php.

oxView.getShopFullEdition

(

)

Returns shop full edition

Returns:

string

Definition at line 690 of file oxview.php.

oxView.getShopLogo

(

)

Template variable getter. Returns shop logo from config option

Deprecated:

since v5.1.0 (2013-09-23); Use oxViewConfig.getShopLogo().

Returns:

string

Definition at line 813 of file oxview.php.

oxView.getShopVersion

(

)

Returns shop version

Returns:

string

Definition at line 646 of file oxview.php.

oxView.getSidForWidget

(

)

Returns session ID, but only in case it is needed to be included for widget calls. This basically happens on session change, when session cookie is not equals to the actual session ID.

Returns:

string

Definition at line 989 of file oxview.php.

oxView.getTemplateName

(

)

Returns current view template file name

Returns:

string

Reimplemented in aList.

Definition at line 318 of file oxview.php.

oxView.getThisAction

(

)

Get name of running class method

Returns:

string

Definition at line 442 of file oxview.php.

oxView.getTrustedShopId

(

)

Returns shop id in classic trusted shops

Returns:

string

Definition at line 579 of file oxview.php.

oxView.getTSExcellenceId

(

)

Returns shop id in trusted shops if excellence product is ordered

Returns:

string

Definition at line 610 of file oxview.php.

oxView.getViewConfig

(

)

Returns view config object

Returns:

oxViewConfig

Definition at line 304 of file oxview.php.

oxView.getViewData

(

)

Get view data

Returns:

array

Definition at line 388 of file oxview.php.

oxView.getViewDataElement

(

$

sParamId = null

)

Get view data single array element

Parameters:

string

$sParamId view data array key

Returns:

mixed

Definition at line 400 of file oxview.php.

oxView.getViewId

(

)

Returns view ID (currently it returns NULL)

Reimplemented in dyn_econda, dyn_interface, dyn_trusted, dyn_trusted_ratings, DynExportBase, Dynscreen, Login, oxAdminView, VoucherSerie_Main, aList, Content, Details, oxUBase, and Review.

Definition at line 226 of file oxview.php.

oxView.getViewParameter

(

$

sKey

)

Get parameters to controllers

Parameters:

string

$sKey parameter key

Returns:

string

Definition at line 196 of file oxview.php.

oxView.init

(

)

Initiates all components stored, executes oxView.addGlobalParams.

Reimplemented in oxcmp_basket, oxcmp_categories, oxcmp_cur, oxcmp_user, oxWidget, List_User, oxAdminView, Shop_List, User_List, Download, order, oxUBase, Payment, Review, and Thankyou.

Definition at line 168 of file oxview.php.

oxView.isBetaVersion

(

)

Returns if current shop is beta version.

Returns:

bool

Definition at line 725 of file oxview.php.

oxView.isConnectedWithFb

(

)

Checks if user is connected via Facebook connect

Returns:

bool

Definition at line 915 of file oxview.php.

oxView.isDemoShop

(

)

Returns if current shop is demo shop

Returns:

string

Definition at line 773 of file oxview.php.

oxView.isDemoVersion

(

)

Returns if current shop is demo version

Returns:

string

Definition at line 711 of file oxview.php.

oxView.isMall

(

)

Returns if shop is mall

Returns:

bool

Definition at line 966 of file oxview.php.

oxView.isRCVersion

(

)

Returns if current shop is release candidate version.

Returns:

bool

Definition at line 741 of file oxview.php.

oxView.render

(

)

Returns name of template to render

Returns:

string current view template file name

Reimplemented in oxcmp_basket, oxcmp_categories, oxcmp_cur, oxcmp_lang, oxcmp_news, oxcmp_shop, oxcmp_user, oxcmp_utils, oxwArticleBox, oxwCategoryTree, oxwCookieNote, oxwRating, oxwReview, Account, Account_Newsletter, Account_Noticelist, Account_Order, Account_Password, Account_Recommlist, Account_User, Account_Wishlist, Actions_List, Actions_Main, AdminGuestbook_List, Adminguestbook_Main, Adminlinks_Main, Article_Attribute, Article_Crossselling, Article_Extend, Article_Files, Article_List, Article_Main, Article_Overview, Article_Pictures, Article_Review, Article_Stock, Article_Userdef, Article_Variant, Attribute_Category, Attribute_Main, Category_List, Category_Order, Category_Pictures, Category_Text, Content_List, Content_Main, Country_List, Country_Main, Delivery_Articles, Delivery_Main, Delivery_Users, DeliverySet_Main, DeliverySet_Payment, DeliverySet_Users, Diagnostics_Main, Discount_Articles, Discount_Main, Discount_Users, dyn_econda, dyn_trusted, dyn_trusted_ratings, DynExportBase, Dynscreen_List, GenExport_Main, GenImport_Main, Language_List, Language_Main, List_Order, List_Review, List_User, Login, Manufacturer_Main, Module, Module_Config, Module_List, Module_Main, Module_SortList, News_Main, News_Text, Newsletter_Main, Newsletter_Plain, Newsletter_Preview, Newsletter_Selection, Newsletter_Send, Object_Seo, Order_Address, Order_Article, Order_Downloads, Order_List, Order_Overview, Order_Package, Order_Remark, oxAdminDetails, oxAdminList, oxAdminView, Payment_Country, Payment_Main, PriceAlarm_Mail, PriceAlarm_Main, PriceAlarm_Send, SelectList_Main, Shop, Shop_Config, Shop_List, Shop_Main, Shop_Seo, Shop_System, Statistic_Main, Statistic_Service, sysreq_main, SystemInfo, Theme, Theme_Config, Theme_List, Theme_Main, Tools, Tools_Main, User_Address, User_Article, User_Extend, User_Main, User_Overview, User_Payment, User_Remark, UserGroup_List, UserGroup_Main, Vendor_Main, VoucherSerie_Groups, VoucherSerie_Main, Wrapping_List, Wrapping_Main, aList, Basket, ClearCookies, Content, Details, GuestBook, Invite, ManufacturerList, order, oxStart, oxUBase, Payment, RecommAdd, Register, Review, Rss, Search, Start, Tag, Tags, Thankyou, Tpl, User, and VendorList.

Definition at line 235 of file oxview.php.

oxView.setActCategory

(

$

oCategory

)

Active category setter

Parameters:

oxCategory

$oCategory active category

Definition at line 863 of file oxview.php.

oxView.setCategoryId

(

$

sCategoryId

)

Category ID setter

Parameters:

string

$sCategoryId Id of category to cache

Definition at line 887 of file oxview.php.

oxView.setClassLocation

(

$

sClassLocation = null

)

Set location of a executed class file

Parameters:

string

$sClassLocation location of a executed class file

Definition at line 412 of file oxview.php.

oxView.setClassName

(

$

sClassName

)

Current view class name setter.

Parameters:

string

$sClassName current view class name

Definition at line 338 of file oxview.php.

oxView.setFncName

(

$

sFncName

)

Set current view action function name

Parameters:

string

$sFncName action function name

Definition at line 358 of file oxview.php.

oxView.setIsCallForCache

(

$

blIsCallForCache = null

)

Set cache sign to enable/disable use of cache

Parameters:

bool

$blIsCallForCache cache sign to enable/disable use of cache

Definition at line 208 of file oxview.php.

oxView.setIsComponent

(

$

blIsComponent = null

)

Set flag if this object is a component or not

Parameters:

bool

$blIsComponent flag if this object is a component

Definition at line 472 of file oxview.php.

oxView.setParent

(

$

oParent = null

)

Set parent object. If this is a component we will have our parent view here.

Parameters:

object

$oParent parent object

Definition at line 452 of file oxview.php.

oxView.setShopLogo

(

$

sLogo

)

Sets shop logo

Parameters:

string

$sLogo shop logo url

Deprecated:

since v5.1.0 (2013-09-23); Use oxViewConfig.setShopLogo().

Definition at line 829 of file oxview.php.

oxView.setShowNewsletter

(

$

blShow

)

Sets if to show newsletter

Parameters:

bool

$blShow if TRUE - newsletter subscription box will be shown

Definition at line 801 of file oxview.php.

oxView.setTemplateName

(

$

sTemplate

)

Sets current view template file name

Parameters:

string

$sTemplate template name

Definition at line 328 of file oxview.php.

oxView.setThisAction

(

$

sThisAction = null

)

Set name of running class method

Parameters:

string

$sThisAction name of running class method

Definition at line 432 of file oxview.php.

oxView.setViewData

(

$

aViewData = null

)

Set array of data that is passed to template engine - array( "varName" => "varValue")

Parameters:

array

$aViewData array of data that is passed to template engine

Definition at line 378 of file oxview.php.

oxView.setViewParameters

(

$

aParams = null

)

Add parameters to controllers

Parameters:

array

$aParams view parameters array.

Definition at line 184 of file oxview.php.

oxView.showBetaNote

(

)

Template variable getter. Returns if beta note can be displayed (for header.tpl)

Returns:

bool

Definition at line 757 of file oxview.php.

oxView.showFbConnectToAccountMsg

(

)

Returns true if popup message about connecting your existing account to Facebook account must be shown

Returns:

bool

Definition at line 948 of file oxview.php.

oxView.showNewsletter

(

)

Template variable getter. Returns if newsletter can be displayed (for _right.tpl)

Returns:

integer

Definition at line 787 of file oxview.php.

oxView.showRdfa

(

)

Returns if page has rdfa

Returns:

bool

Reimplemented in Content, and Details.

Definition at line 976 of file oxview.php.

---

Member Data Documentation

oxView.$_aViewData = array() [protected]

Definition at line 15 of file oxview.php.

oxView.$_blDemoShop = null [protected]

Definition at line 120 of file oxview.php.

oxView.$_blDemoVersion = null [protected]

Definition at line 113 of file oxview.php.

oxView.$_blExecuted = false [static, protected]

Definition at line 78 of file oxview.php.

oxView.$_blIsCallForCache = false [protected]

Definition at line 155 of file oxview.php.

oxView.$_blIsComponent = false [protected]

Reimplemented in oxcmp_basket, oxcmp_categories, oxcmp_cur, oxcmp_lang, oxcmp_news, oxcmp_shop, oxcmp_user, and oxcmp_utils.

Definition at line 43 of file oxview.php.

oxView.$_iNewsStatus = null [protected]

Definition at line 127 of file oxview.php.

oxView.$_oClickCat = null [protected]

Definition at line 148 of file oxview.php.

oxView.$_oParent = null [protected]

Definition at line 36 of file oxview.php.

oxView.$_oViewConf = null [protected]

Definition at line 162 of file oxview.php.

oxView.$_sCategoryId = null [protected]

Definition at line 141 of file oxview.php.

oxView.$_sCharSet = null [protected]

Definition at line 99 of file oxview.php.

oxView.$_sClass = null [protected]

Definition at line 64 of file oxview.php.

oxView.$_sClassLocation = null [protected]

Definition at line 22 of file oxview.php.

oxView.$_sFnc = null [protected]

Definition at line 71 of file oxview.php.

oxView.$_sShopLogo = null [protected]

Definition at line 134 of file oxview.php.

oxView.$_sThisAction = null [protected]

Definition at line 29 of file oxview.php.

oxView.$_sThisTemplate = null [protected]

Reimplemented in oxwArticleDetails, oxwBetaNote, oxwCategoryTree, oxwCookieNote, oxwCurrencyList, oxwInformation, oxwLanguageList, oxwManufacturerList, oxwMiniBasket, oxwRating, oxwRecommendation, oxwReview, oxwServiceList, oxwServiceMenu, oxwTagCloud, oxwVendorList, Account, Account_Downloads, Account_Newsletter, Account_Noticelist, Account_Order, Account_Password, Account_Recommlist, Account_User, Account_Wishlist, Actions, Actions_List, Admin_Content, Admin_Guestbook, Admin_Links, Admin_News, Admin_Newsletter, Admin_Order, Admin_Payment, Admin_Pricealarm, Admin_Start, Admin_User, Admin_Wrapping, AdminGuestbook_List, Adminlinks_List, Article, Article_Files, Attribute, Attribute_List, Category, Category_Update, Country, Delivery, Delivery_List, DeliverySet, DeliverySet_List, deliveryset_rdfa, Diagnostics, Diagnostics_List, Discount, Discount_List, DynExportBase, Dynscreen, Dynscreen_Local, GenExport_Do, GenExport_Main, GenImport, GenImport_Main, Language, Manufacturer, Manufacturer_List, News_List, Newsletter_List, oxAdminView, Payment_List, payment_rdfa, PriceAlarm_List, SelectList, SelectList_List, Shop_Config, Shop_License, Shop_Performance, shop_rdfa, Shop_System, Statistic, Statistic_List, sysreq, sysreq_list, Tools_List, User_List, UserGroup, Vendor, Vendor_List, VoucherSerie, VoucherSerie_Export, VoucherSerie_Generate, VoucherSerie_List, VoucherSerie_Main, aList, Basket, ClearCookies, Compare, Contact, Content, Details, ExceptionError, ForgotPwd, GuestBook, GuestbookEntry, Invite, Links, MoreDetails, News, Newsletter, order, Payment, Pricealarm, RecommAdd, RecommList, Register, Review, Rss, Search, Start, Suggest, Tags, Thankyou, User, Wishlist, and Wrapping.

Definition at line 50 of file oxview.php.

oxView.$_sTrustedShopId = null [protected]

Definition at line 85 of file oxview.php.

oxView.$_sTSExcellenceId = null [protected]

Definition at line 92 of file oxview.php.

oxView.$_sVersion = null [protected]

Definition at line 106 of file oxview.php.

oxView.$_sViewId = null [protected]

Definition at line 57 of file oxview.php.

---

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

• core/oxview.php