oxView Class Reference
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.init | ( | ) |
Initiates all components stored, executes oxview.addGlobalParams.
- Returns:
- null
Reimplemented in Adminlinks_List, Attribute_List, Category_List, Delivery_List, DeliverySet_List, Discount_List, Gui, List_User, Manufacturer_List, News_List, oxAdminList, oxAdminView, SelectList_List, Shop_List, User_List, Vendor_List, Wrapping_List, Content, Details, Order, oxcmp_categories, oxcmp_cur, oxcmp_lang, oxcmp_user, oxUBase, Payment, Review, Rss, Search, Start, Tag, and Thankyou.
Definition at line 126 of file oxview.php.
| oxView.getViewId | ( | ) |
Returns view ID (currently it returns NULL)
- Returns:
- string
Reimplemented in dyn_affiliwelt, dyn_econda, dyn_interface, dyn_ipayment, dyn_trusted, DynExportBase, Dynscreen, Login, oxAdminView, aList, Content, Details, and oxUBase.
Definition at line 142 of file oxview.php.
| oxView.render | ( | ) |
Returns name of template to render
- Returns:
- string current view template file name
Reimplemented in Actions_Main, AdminGuestbook_List, Adminguestbook_Main, Adminlinks_Main, Article_Attribute, Article_Crossselling, Article_Extend, Article_List, Article_Main, Article_Overview, Article_Pictures, Article_Review, Article_Seo, Article_Stock, Article_Userdef, Article_Variant, Attribute_Category, Attribute_Main, Category_List, Category_Main, Category_Order, Category_Pictures, Category_Seo, Category_Text, Category_Update, 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_adbutler, dyn_affili24, dyn_affilinet, dyn_affiliwelt, dyn_econda, dyn_ipayment, dyn_superclix, dyn_trusted, DynExportBase, Dynscreen_List, EFire_Downloader, EFire_List, GenExport_Main, GenImport_Main, Gui, Language_List, Language_Main, List_Order, List_Review, List_User, Login, Manufacturer_Main, Manufacturer_Seo, Navigation, News_Main, News_Text, Newsletter_Main, Newsletter_Plain, Newsletter_Preview, Newsletter_Selection, Newsletter_Send, Object_Seo, Order_Address, Order_Article, Order_List, Order_Main, Order_Overview, Order_Package, Order_Remark, oxAdminDetails, oxAdminList, oxAdminView, oxChangeView, Payment_Country, Payment_Main, Payment_Overview, PriceAlarm_List, 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, Tools, Tools_Main, User_Address, User_Article, User_Extend, User_Main, User_Overview, User_Payment, User_Remark, UserGroup_List, UserGroup_Main, Vendor_Main, Vendor_Seo, VoucherSerie_Export, VoucherSerie_Groups, VoucherSerie_Main, Wrapping_List, Wrapping_Main, Account, Account_Newsletter, Account_Noticelist, Account_Order, Account_Password, Account_Recommlist, Account_User, Account_Wishlist, aList, Basket, Compare, Contact, Content, Details, ForgotPwd, GuestBook, Help, Info, Links, ManufacturerList, MoreDetails, News, Newsletter, Order, oxcmp_basket, oxcmp_categories, oxcmp_cur, oxcmp_lang, oxcmp_news, oxcmp_shop, oxcmp_user, oxcmp_utils, oxStart, oxUBase, Payment, Pricealarm, RecommAdd, RecommList, Register, Review, Rss, Search, Start, Suggest, Tag, Tags, Thankyou, Tpl, User, VendorList, Wishlist, and Wrapping.
Definition at line 151 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 169 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 213 of file oxview.php.
| oxView._setAdditionalParams | ( | ) | [protected] |
Sets additional parameters: cl, searchparam, searchcnid, searchvendor, searchmanufacturer, cnid.
Template variables: additionalparams
- Returns:
- null
Definition at line 229 of file oxview.php.
| oxView.getViewConfig | ( | ) |
| oxView.getTemplateName | ( | ) |
Returns current view template file name
- Returns:
- string
Reimplemented in aList, and Info.
Definition at line 253 of file oxview.php.
| oxView.setClassName | ( | $ | sClassName | ) |
Current view class name setter.
- Parameters:
-
string $sClassName current view class name
- Returns:
- null
Definition at line 265 of file oxview.php.
| oxView.getClassName | ( | ) |
| oxView.setFncName | ( | $ | sFncName | ) |
Set current view action function name
- Parameters:
-
string $sFncName action function name
- Returns:
- null
Definition at line 287 of file oxview.php.
| oxView.getFncName | ( | ) |
| 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 309 of file oxview.php.
| oxView.getViewData | ( | ) |
| oxView.getViewDataElement | ( | $ | sParamId = null |
) |
Get view data single array element
- Parameters:
-
string $sParamId view data array key
- Returns:
- mixed
Definition at line 331 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 345 of file oxview.php.
| oxView.getClassLocation | ( | ) |
| oxView.setThisAction | ( | $ | sThisAction = null |
) |
Set name of running class method
- Parameters:
-
string $sThisAction name of running class method
- Returns:
- null
Definition at line 366 of file oxview.php.
| oxView.getThisAction | ( | ) |
| 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 388 of file oxview.php.
| oxView.getParent | ( | ) |
| 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 410 of file oxview.php.
| oxView.getIsComponent | ( | ) |
| 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 435 of file oxview.php.
| oxView._executeNewAction | ( | $ | sNewAction | ) | [protected] |
Formats header for new controller action
Input example: "[component_name@]view_name[/function_name]?param1=val1¶m2=val2" Parameters in [] are optional.
- Parameters:
-
string $sNewAction new action params
- Returns:
- string
Definition at line 470 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 515 of file oxview.php.
| oxView.getTrustedShopId | ( | ) |
| oxView.getCharSet | ( | ) |
| oxView.getShopVersion | ( | ) |
| oxView.getShopEdition | ( | ) |
| oxView.getShopFullEdition | ( | ) |
| oxView.isDemoVersion | ( | ) |
| oxView.isDemoShop | ( | ) |
| oxView.showNewsletter | ( | ) |
Template variable getter. Returns if newsletter can be displayed (for _right.tpl)
- Returns:
- integer
Definition at line 628 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 643 of file oxview.php.
| oxView.getShopLogo | ( | ) |
Template variable getter. Returns shop logo
- Returns:
- string
Definition at line 653 of file oxview.php.
| oxView.setShopLogo | ( | $ | sLogo | ) |
Sets shop logo
- Parameters:
-
string $sLogo shop logo url
- Returns:
- null
Definition at line 665 of file oxview.php.
Member Data Documentation
oxView.$_aViewData = array() [protected] |
Definition at line 14 of file oxview.php.
oxView.$_sClassLocation = null [protected] |
Definition at line 21 of file oxview.php.
oxView.$_sThisAction = null [protected] |
Definition at line 28 of file oxview.php.
oxView.$_oParent = null [protected] |
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.$_sThisTemplate = null [protected] |
Reimplemented in 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, Attribute, Attribute_List, Category, Country, Delivery, Delivery_List, DeliverySet, DeliverySet_List, 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, oxChangeView, Payment_List, SelectList, SelectList_List, Shop_Config, Shop_Performance, Shop_System, Statistic, Statistic_List, sysreq, sysreq_list, Tools_List, User_List, UserGroup, Vendor, Vendor_List, VoucherSerie, VoucherSerie_List, Account, Account_Newsletter, Account_Noticelist, Account_Order, Account_Password, Account_Recommlist, Account_User, Account_Wishlist, aList, Basket, Compare, Contact, Content, Details, ForgotPwd, GuestBook, GuestbookEntry, Help, 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.$_sViewId = null [protected] |
Definition at line 56 of file oxview.php.
oxView.$_sClass = null [protected] |
Definition at line 63 of file oxview.php.
oxView.$_sFnc = null [protected] |
Definition at line 70 of file oxview.php.
oxView.$_blExecuted = false [static, protected] |
Definition at line 77 of file oxview.php.
oxView.$_sTrustedShopId = null [protected] |
Definition at line 83 of file oxview.php.
oxView.$_sCharSet = null [protected] |
Definition at line 89 of file oxview.php.
oxView.$_sVersion = null [protected] |
Definition at line 95 of file oxview.php.
oxView.$_blDemoVersion = null [protected] |
Definition at line 101 of file oxview.php.
oxView.$_blDemoShop = null [protected] |
Definition at line 107 of file oxview.php.
oxView.$_iNewsStatus = null [protected] |
Definition at line 113 of file oxview.php.
oxView.$_sShopLogo = null [protected] |
Definition at line 119 of file oxview.php.
The documentation for this class was generated from the following file:
- views/oxview.php
