oxAdminView Class Reference

Inheritance diagram for oxAdminView:

Inheritance graph
[legend]
Collaboration diagram for oxAdminView:

Collaboration graph
[legend]

List of all members.


Detailed Description

Main "view" class. Organizes multilanguage, parameters fetching, DB managing, file checking and processing, etc.

Public Member Functions

 __construct ()
 init ()
 addGlobalParams ($oShop=null)
 getServiceUrl ($sLangAbbr=null)
 render ()
 autosave ()
 save ()
 getNavigation ()
 getViewId ()
 chshp ()

Protected Member Functions

 _getShopVersionNr ()
 _setupNavigation ($sNode)
 _addNavigationHistory ($sNode)
 _getMaxUploadFileInfo ($iMaxFileSize, $blFormatted=false)
 _allowAdminEdit ($sUserId)
 _getCountryByCode ($sCountryCode)
 _authorize ()

Protected Attributes

 $_aSumType
 $_sThisTemplate = null
 $_iDefEdit = 0
 $_iEditLang = 0
 $_sShopTitle = " - "
 $_sShopVersion = null
 $_sServiceUrl = null

Static Protected Attributes

static $_oNaviTree = null

Constructor & Destructor Documentation

oxAdminView.__construct (  ) 

Creates oxshop object and loads shop data, sets title of shop

Reimplemented in DynExportBase, Login, and oxAdminList.


Member Function Documentation

oxAdminView.init (  ) 

Sets some shop configuration parameters (such as language), creates some list object (depends on subclass) and executes parent method parent.Init().

Returns:
null

Reimplemented from oxView.

Reimplemented in Adminlinks_list, Article_list, Attribute_list, Category_list, Delivery_list, deliveryset_list, Discount_list, gui, News_list, oxAdminList, Selectlist_list, Shop_list, User_list, Vendor_list, and Wrapping_list.

oxAdminView.addGlobalParams ( oShop = null  ) 

Sets some global parameters to Smarty engine (such as self link, etc.), returns modified shop object.

Parameters:
object $oShop Object to modify some parameters
Returns:
object

Reimplemented from oxView.

oxAdminView.getServiceUrl ( sLangAbbr = null  ) 

Returns service URL

Returns:
string

oxAdminView._getShopVersionNr (  )  [protected]

Returns shop version

Returns:
string

oxAdminView._setupNavigation ( sNode  )  [protected]

Sets-up navigation parameters

Parameters:
string $sNode active view id
Returns:
null

Reimplemented in dynscreen, Newsletter_send, oxAdminDetails, oxAdminList, and pricealarm_send.

oxAdminView._addNavigationHistory ( sNode  )  [protected]

Store navigation history parameters to cookie

Parameters:
string $sNode active view id
Returns:
null

oxAdminView.render (  ) 

Executes parent method parent.render(), passes configuration data to Smarty engine.

Returns:
string

Reimplemented from oxView.

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_etracker, dyn_ipayment, dyn_superclix, dyn_trusted, DynExportBase, dynscreen_list, efire_downloader, EFire_List, genExport_main, gui, List_Order, List_Review, List_User, Login, Main, 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, 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, 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, and Wrapping_main.

oxAdminView._getMaxUploadFileInfo ( iMaxFileSize,
blFormatted = false 
) [protected]

Returns maximum allowed size of upload file and formatted size equivalent

Parameters:
int $iMaxFileSize recommended maximum size of file (normalu value is taken from php ini, otherwise sets 2MB)
Returns:
array

oxAdminView.autosave (  ) 

Object saving function. currently used for autosaving feature.

Returns:
string

oxAdminView.save (  ) 

oxAdminView._allowAdminEdit ( sUserId  )  [protected]

Checks if current $sUserId user is not an admin and checks if user is able to be edited by logged in user. This method does not perform full rights check.

Parameters:
string $sUserId user id
Returns:
bool

oxAdminView._getCountryByCode ( sCountryCode  )  [protected]

Get english country name by country iso alpha 2 code

Returns:
boolean

oxAdminView._authorize (  )  [protected]

performs authorization of admin user

Returns:
boolean

Reimplemented in Login.

oxAdminView.getNavigation (  ) 

Returns navigation object

Returns:
oxnavigationtree

oxAdminView.getViewId (  ) 

Current view ID getter helps to identify navigation position

Returns:
string

Reimplemented from oxView.

Reimplemented in dyn_affiliwelt, dyn_econda, dyn_etracker, dyn_interface, dyn_ipayment, dyn_trusted, DynExportBase, dynscreen, and Login.

oxAdminView.chshp (  ) 

Changing active shop

Returns:
string


Member Data Documentation

oxAdminView.$_aSumType [protected]

Initial value:

 array(
                                0 => 'abs',
                                1 => '%',
                                2 => 'itm'
                                )

oxAdminView.$_sThisTemplate = null [protected]

oxAdminView.$_iDefEdit = 0 [protected]

Reimplemented in admin_pricealarm, and pricealarm_send.

oxAdminView.$_oNaviTree = null [static, protected]

oxAdminView.$_iEditLang = 0 [protected]

oxAdminView.$_sShopTitle = " - " [protected]

oxAdminView.$_sShopVersion = null [protected]

oxAdminView.$_sServiceUrl = null [protected]


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

Generated on Wed Oct 29 23:43:05 2008 for OXID eShop CE by  doxygen 1.5.5