Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes

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 ()
 executeFunction ($sFunction)
 getAdditionalParams ()
 getTrustedShopId ()
 getTSExcellenceId ()
 getCharSet ()
 getShopVersion ()
 getShopEdition ()
 getRevision ()
 getPackageInfo ()
 getShopFullEdition ()
 isDemoVersion ()
 isDemoShop ()
 showNewsletter ()
 setShowNewsletter ($blShow)
 getShopLogo ()
 setShopLogo ($sLogo)
 getActCategory ()
 setActCategory ($oCategory)
 getCategoryId ()
 setCategoryId ($sCategoryId)
 getErrorDestination ()
 getActionClassName ()
 isConnectedWithFb ()
 getFbUserId ()
 showFbConnectToAccountMsg ()
 isMall ()
 showRdfa ()

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
Returns:
string

Definition at line 546 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 251 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
Returns:
null

Definition at line 277 of file oxview.php.

oxView.executeFunction ( sFunction  ) 

Executes method (creates class and then executes). Returns executed function result.

Parameters:
string $sFunction name of function to execute
Exceptions:
oxSystemComponentException system component exception
Returns:
mixed

Definition at line 512 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

Deprecated:
since v5.0.4 (2013-02-11); use oxUBase.getActiveCategory();
Returns:
oxCategory

Reimplemented in Article_Seo.

Definition at line 806 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 878 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 587 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 842 of file oxview.php.

oxView.getCharSet (  ) 

Returns active charset

Returns:
string

Definition at line 648 of file oxview.php.

oxView.getClassLocation (  ) 

Get location of a executed class file

Returns:
string

Definition at line 431 of file oxview.php.

oxView.getClassName (  ) 

Returns class name of current class

Returns:
string

Definition at line 352 of file oxview.php.

oxView.getErrorDestination (  ) 

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

Returns:
null

Reimplemented in Basket.

Definition at line 868 of file oxview.php.

oxView.getFbUserId (  ) 

Gets get Facebook user id

Returns:
int

Definition at line 905 of file oxview.php.

oxView.getFncName (  ) 

Returns name of current action function

Returns:
string

Definition at line 374 of file oxview.php.

oxView.getIsCallForCache (  ) 

Get cache sign to enable/disable use of cache

Returns:
bool

Definition at line 214 of file oxview.php.

oxView.getIsComponent (  ) 

Get flag if this objcet is a component

Returns:
bool

Definition at line 497 of file oxview.php.

oxView.getPackageInfo (  ) 

Returns shop package info

Returns:
string

Definition at line 694 of file oxview.php.

oxView.getParent (  ) 

Get parent object

Returns:
null

Definition at line 475 of file oxview.php.

oxView.getRevision (  ) 

Returns shop revision

Returns:
string

Definition at line 684 of file oxview.php.

oxView.getShopEdition (  ) 

Returns shop edition

Returns:
string

Definition at line 674 of file oxview.php.

oxView.getShopFullEdition (  ) 

Returns shop full edition

Returns:
string

Definition at line 704 of file oxview.php.

oxView.getShopLogo (  ) 

Template variable getter. Returns shop logo from config option

Returns:
string

Definition at line 776 of file oxview.php.

oxView.getShopVersion (  ) 

Returns shop version

Returns:
string

Definition at line 661 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 453 of file oxview.php.

oxView.getTrustedShopId (  ) 

Returns shop id in classic trusted shops

Returns:
string

Definition at line 597 of file oxview.php.

oxView.getTSExcellenceId (  ) 

Returns shop id in trusted shops if excellence product is ordered

Returns:
string

Definition at line 627 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 396 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 408 of file oxview.php.

oxView.getViewId (  ) 

Returns view ID (currently it returns NULL)

Returns:
string

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

Definition at line 224 of file oxview.php.

oxView.getViewParameter ( sKey  ) 

Get parameters to controllers

Parameters:
string $sKey parameter key
Returns:
array

Definition at line 190 of file oxview.php.

oxView.init (  ) 

Initiates all components stored, executes oxview.addGlobalParams.

Returns:
null

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

Definition at line 160 of file oxview.php.

oxView.isConnectedWithFb (  ) 

Checks if user is connected via Facebook connect

Returns:
bool

Definition at line 888 of file oxview.php.

oxView.isDemoShop (  ) 

Returns if current shop is demoshop

Returns:
string

Definition at line 738 of file oxview.php.

oxView.isDemoVersion (  ) 

Returns if current shop is demo version

Returns:
string

Definition at line 725 of file oxview.php.

oxView.isMall (  ) 

Returns if shop is mall

Returns:
bool

Definition at line 937 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, oxwCategoryTree, oxwCookieNote, 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_Main, 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, Discount_Articles, Discount_Main, Discount_Users, dyn_econda, dyn_trusted, dyn_trusted_ratings, DynExportBase, Dynscreen_List, EFire_Downloader, EFire_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, Navigation, 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_Main, 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_License, 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, Download, GuestBook, Invite, ManufacturerList, order, oxStart, oxUBase, Payment, RecommAdd, RecommList, Register, Review, Rss, Search, Start, Tag, Tags, Thankyou, Tpl, User, and VendorList.

Definition at line 233 of file oxview.php.

oxView.setActCategory ( oCategory  ) 

Active category setter

Parameters:
oxCategory $oCategory active category
Deprecated:
since v5.0.4 (2013-02-11); use oxUBase.getActiveCategory();
Returns:
null

Definition at line 832 of file oxview.php.

oxView.setCategoryId ( sCategoryId  ) 

Category ID setter

Parameters:
string $sCategoryId Id of category to cache
Returns:
null

Definition at line 858 of file oxview.php.

oxView.setClassLocation ( sClassLocation = null  ) 

Set location of a executed class file

Parameters:
string $sClassLocation location of a executed class file
Returns:
null

Definition at line 422 of file oxview.php.

oxView.setClassName ( sClassName  ) 

Current view class name setter.

Parameters:
string $sClassName current view class name
Returns:
null

Definition at line 342 of file oxview.php.

oxView.setFncName ( sFncName  ) 

Set current view action function name

Parameters:
string $sFncName action function name
Returns:
null

Definition at line 364 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
Returns:
null

Definition at line 204 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
Returns:
null

Definition at line 487 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
Returns:
null

Definition at line 465 of file oxview.php.

oxView.setShopLogo ( sLogo  ) 

Sets shop logo

Parameters:
string $sLogo shop logo url
Returns:
null

Definition at line 792 of file oxview.php.

oxView.setShowNewsletter ( blShow  ) 

Sets if to show newsletter

Parameters:
bool $blShow if TRUE - newsletter subscription box will be shown
Returns:
null

Definition at line 766 of file oxview.php.

oxView.setTemplateName ( sTemplate  ) 

Sets current view template file name

Parameters:
string $sTemplate template name
Returns:
null

Definition at line 330 of file oxview.php.

oxView.setThisAction ( sThisAction = null  ) 

Set name of running class method

Parameters:
string $sThisAction name of running class method
Returns:
null

Definition at line 443 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
Returns:
null

Definition at line 386 of file oxview.php.

oxView.setViewParameters ( aParams = null  ) 

Add parameters to controllers

Parameters:
array $aParams view parameters array.
Returns:
null

Definition at line 178 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 919 of file oxview.php.

oxView.showNewsletter (  ) 

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

Returns:
integer

Definition at line 751 of file oxview.php.

oxView.showRdfa (  ) 

Returns if page has rdfa

Returns:
bool

Reimplemented in Content, and Details.

Definition at line 947 of file oxview.php.


Member Data Documentation

oxView.$_aViewData = array() [protected]

Definition at line 14 of file oxview.php.

oxView.$_blDemoShop = null [protected]

Definition at line 113 of file oxview.php.

oxView.$_blDemoVersion = null [protected]

Definition at line 107 of file oxview.php.

oxView.$_blExecuted = false [static, protected]

Definition at line 77 of file oxview.php.

oxView.$_blIsCallForCache = false [protected]

Definition at line 145 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 42 of file oxview.php.

oxView.$_iNewsStatus = null [protected]

Definition at line 119 of file oxview.php.

oxView.$_oClickCat = null [protected]

Definition at line 138 of file oxview.php.

oxView.$_oParent = null [protected]

Definition at line 35 of file oxview.php.

oxView.$_oViewConf = null [protected]

Definition at line 152 of file oxview.php.

oxView.$_sCategoryId = null [protected]

Definition at line 132 of file oxview.php.

oxView.$_sCharSet = null [protected]

Definition at line 95 of file oxview.php.

oxView.$_sClass = null [protected]

Definition at line 63 of file oxview.php.

oxView.$_sClassLocation = null [protected]

Definition at line 21 of file oxview.php.

oxView.$_sFnc = null [protected]

Definition at line 70 of file oxview.php.

oxView.$_sShopLogo = null [protected]

Definition at line 125 of file oxview.php.

oxView.$_sThisAction = null [protected]

Definition at line 28 of file oxview.php.

oxView.$_sThisTemplate = null [protected]

Reimplemented in oxwBetaNote, oxwCategoryTree, oxwCookieNote, oxwCurrencyList, oxwInformation, oxwLanguageList, oxwManufacturerList, oxwMiniBasket, oxwRecommendation, 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, Discount, Discount_List, DynExportBase, Dynscreen, Dynscreen_Local, Efire, EFire_Downloader, 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 49 of file oxview.php.

oxView.$_sTrustedShopId = null [protected]

Definition at line 83 of file oxview.php.

oxView.$_sTSExcellenceId = null [protected]

Definition at line 89 of file oxview.php.

oxView.$_sVersion = null [protected]

Definition at line 101 of file oxview.php.

oxView.$_sViewId = null [protected]

Definition at line 56 of file oxview.php.


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