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.

Definition at line 8 of file oxadminview.php.


Public Member Functions

 __construct ()
 init ()
 addGlobalParams ($oShop=null)
 getServiceUrl ($sLangAbbr=null)
 render ()
 save ()
 resetContentCache ()
 resetCounter ($sCounterType, $sValue=null)
 getNavigation ()
 getViewId ()
 chshp ()
 resetSeoData ($sShopId)

Protected Member Functions

 _getEditShop ($sShopId)
 _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
 $_oEditShop = null

Static Protected Attributes

static $_oNaviTree = null
static $_sAuthUserRights = null

Constructor & Destructor Documentation

oxAdminView.__construct (  ) 

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

Reimplemented in DynExportBase, Login, and oxAdminList.

Definition at line 87 of file oxadminview.php.

Member Function Documentation

oxAdminView._getEditShop ( $  sShopId  )  [protected]

Returns (cached) shop object

Parameters:
object $sShopId shop id
Returns:
oxshop

Definition at line 107 of file oxadminview.php.

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, Attribute_List, Category_List, Delivery_List, DeliverySet_List, Discount_List, Gui, Manufacturer_List, News_List, oxAdminList, SelectList_List, Shop_List, User_List, Vendor_List, and Wrapping_List.

Definition at line 128 of file oxadminview.php.

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.

Definition at line 157 of file oxadminview.php.

oxAdminView.getServiceUrl ( $  sLangAbbr = null  ) 

Returns service URL

Returns:
string

Definition at line 197 of file oxadminview.php.

oxAdminView._getShopVersionNr (  )  [protected]

Returns shop version

Returns:
string

Definition at line 230 of file oxadminview.php.

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.

Definition at line 250 of file oxadminview.php.

oxAdminView._addNavigationHistory ( $  sNode  )  [protected]

Store navigation history parameters to cookie

Parameters:
string $sNode active view id
Returns:
null

Definition at line 281 of file oxadminview.php.

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_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, 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, and Wrapping_Main.

Definition at line 304 of file oxadminview.php.

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

Definition at line 353 of file oxadminview.php.

oxAdminView.save (  ) 

Clears cache

Returns:
string

Reimplemented in Actions_Main, Adminguestbook_Main, Adminlinks_Main, Article_Extend, Article_Main, Article_Pictures, Article_Review, Article_Stock, Attribute_Main, Category_Main, Category_Seo, Category_Text, Content_Main, Country_Main, Delivery_Main, DeliverySet_Main, Discount_Main, dyn_adbutler, dyn_affili24, dyn_affilinet, dyn_affiliwelt, dyn_superclix, dyn_trusted, Language_Main, Manufacturer_Main, Manufacturer_Seo, News_Main, News_Text, Newsletter_Main, Newsletter_Plain, Newsletter_Selection, Object_Seo, Order_Address, Order_Main, Order_Remark, Payment_Main, SelectList_Main, Shop_Config, Shop_Main, Shop_Seo, Statistic_Main, User_Address, User_Extend, User_Main, User_Payment, User_Remark, UserGroup_Main, Vendor_Main, Vendor_Seo, VoucherSerie_Main, and Wrapping_Main.

Definition at line 388 of file oxadminview.php.

oxAdminView.resetContentCache (  ) 

Reset output cache

Returns:
null

Definition at line 397 of file oxadminview.php.

oxAdminView.resetCounter ( $  sCounterType,
$  sValue = null 
)

Resets counters values from cache. Resets price category articles, category articles, vendor articles, manufacturer articles count.

Parameters:
$sCounterType counter type
$sValue reset value
Returns:
null

Definition at line 414 of file oxadminview.php.

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

Definition at line 446 of file oxadminview.php.

oxAdminView._getCountryByCode ( $  sCountryCode  )  [protected]

Get english country name by country iso alpha 2 code

Returns:
boolean

Definition at line 458 of file oxadminview.php.

oxAdminView._authorize (  )  [protected]

performs authorization of admin user

Returns:
boolean

Reimplemented in Login.

Definition at line 478 of file oxadminview.php.

oxAdminView.getNavigation (  ) 

Returns navigation object

Returns:
oxnavigationtree

Definition at line 488 of file oxadminview.php.

oxAdminView.getViewId (  ) 

Current view ID getter helps to identify navigation position

Returns:
string

Reimplemented from oxView.

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

Definition at line 502 of file oxadminview.php.

oxAdminView.chshp (  ) 

Changing active shop

Returns:
string

Definition at line 513 of file oxadminview.php.

oxAdminView.resetSeoData ( $  sShopId  ) 

Marks seo entires as expired (oxseo.oxexpired = 2), leans up tag couds cache

Returns:
null

Definition at line 526 of file oxadminview.php.

Member Data Documentation

oxAdminView.$_aSumType [protected]

Initial value:

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

Definition at line 15 of file oxadminview.php.

oxAdminView.$_sThisTemplate = null [protected]

Reimplemented from oxView.

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, 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, and VoucherSerie_List.

Definition at line 26 of file oxadminview.php.

oxAdminView.$_iDefEdit = 0 [protected]

Reimplemented in Admin_Pricealarm, and PriceAlarm_Send.

Definition at line 34 of file oxadminview.php.

oxAdminView.$_oNaviTree = null [static, protected]

Definition at line 41 of file oxadminview.php.

oxAdminView.$_iEditLang = 0 [protected]

Definition at line 48 of file oxadminview.php.

oxAdminView.$_sShopTitle = " - " [protected]

Definition at line 55 of file oxadminview.php.

oxAdminView.$_sShopVersion = null [protected]

Definition at line 62 of file oxadminview.php.

oxAdminView.$_sServiceUrl = null [protected]

Definition at line 69 of file oxadminview.php.

oxAdminView.$_sAuthUserRights = null [static, protected]

Definition at line 76 of file oxadminview.php.

oxAdminView.$_oEditShop = null [protected]

Active shop object

Returns:

Definition at line 82 of file oxadminview.php.

The documentation for this class was generated from the following file:
Generated on Tue Apr 21 15:48:37 2009 for OXID eShop CE by  doxygen 1.5.5