oxAdminView Class Reference

Inheritance diagram for oxAdminView:

Collaboration diagram for oxAdminView:

Public Member Functions
	__construct ()
	init ()
	addGlobalParams ($oShop=null)
	getServiceUrl ($sLangAbbr=null)
	render ()
	save ()
	resetContentCache ($blForceReset=null)
	resetCounter ($sCounterType, $sValue=null)
	getNavigation ()
	getViewId ()
	chshp ()
	resetSeoData ($sShopId)
	getPreviewId ()
	getEditObjectId ()
	setEditObjectId ($sId)
Public Member Functions inherited from oxView
	setViewParameters ($aParams=null)
	getViewParameter ($sKey)
	setIsCallForCache ($blIsCallForCache=null)
	getIsCallForCache ()
	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 ()
	isBetaVersion ()
	isRCVersion ()
	showBetaNote ()
	isDemoShop ()
	showNewsletter ()
	setShowNewsletter ($blShow)
	getShopLogo ()
	setShopLogo ($sLogo)
	getActCategory ()
	setActCategory ($oCategory)
	getCategoryId ()
	setCategoryId ($sCategoryId)
	getErrorDestination ()
	getActionClassName ()
	isConnectedWithFb ()
	getFbUserId ()
	showFbConnectToAccountMsg ()
	isMall ()
	showRdfa ()
	getSidForWidget ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_getEditShop ($sShopId)
	_getServiceProtocol ()
	_getShopVersionNr ()
	_setupNavigation ($sNode)
	_addNavigationHistory ($sNode)
	_getMaxUploadFileInfo ($iMaxFileSize, $blFormatted=false)
	_allowAdminEdit ($sUserId)
	_getCountryByCode ($sCountryCode)
	_authorize ()
Protected Member Functions inherited from oxView
	_executeNewAction ($sNewAction)

Protected Attributes
	$_aSumType
	$_sThisTemplate = null
	$_iDefEdit = 0
	$_iEditLang = 0
	$_sShopTitle = " - "
	$_sShopVersion = null
	$_sServiceUrl = null
	$_oEditShop = null
	$_sEditObjectId = null
Protected Attributes inherited from oxView
	$_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	$_oNaviTree = null
static	$_sAuthUserRights = null
Static Protected Attributes inherited from oxView
static	$_blExecuted = false
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

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

Definition at line 8 of file oxadminview.php.

Constructor & Destructor Documentation

oxAdminView::__construct

(

)

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

Reimplemented from oxSuperCfg.

Reimplemented in DynExportBase, Diagnostics_Main, VoucherSerie_Export, and Login.

Definition at line 94 of file oxadminview.php.

Member Function Documentation

oxAdminView::_addNavigationHistory (   $sNode )

protected

Store navigation history parameters to cookie

Parameters

string

$sNode

active view id

Returns

null

Definition at line 299 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 470 of file oxadminview.php.

oxAdminView::_authorize ( )

protected

performs authorization of admin user

Returns

boolean

Reimplemented in Login.

Definition at line 519 of file oxadminview.php.

oxAdminView::_getCountryByCode (   $sCountryCode )

protected

Get english country name by country iso alpha 2 code

Parameters

string

$sCountryCode

Country code

Returns

boolean

Definition at line 484 of file oxadminview.php.

oxAdminView::_getEditShop (   $sShopId )

protected

Returns (cached) shop object

Parameters

object

$sShopId

shop id

Returns

oxshop

Definition at line 115 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)
bool	$blFormatted	Return formated

Returns

array

Definition at line 372 of file oxadminview.php.

oxAdminView::_getServiceProtocol ( )

protected

Returns service url protocol: "https" is admin works in ssl mode, "http" if no ssl

Returns

string

Definition at line 204 of file oxadminview.php.

oxAdminView::_getShopVersionNr ( )

protected

Returns shop version

Returns

string

Definition at line 248 of file oxadminview.php.

oxAdminView::_setupNavigation (   $sNode )

protected

Sets-up navigation parameters

Parameters

string

$sNode

active view id

Returns

null

Reimplemented in oxAdminList, oxAdminDetails, Newsletter_Send, PriceAlarm_Send, and Dynscreen.

Definition at line 268 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 165 of file oxadminview.php.

oxAdminView::chshp

(

)

Changing active shop

Returns

string

Reimplemented in Navigation.

Definition at line 557 of file oxadminview.php.

oxAdminView::getEditObjectId

(

)

Returns active/editable object id

Returns

string

Reimplemented in Shop_Config.

Definition at line 599 of file oxadminview.php.

oxAdminView::getNavigation

(

)

Returns navigation object

Returns

oxnavigationtree

Definition at line 533 of file oxadminview.php.

oxAdminView::getPreviewId

(

)

Returns id which is used for product preview in shop during administration

Returns

string

Definition at line 589 of file oxadminview.php.

oxAdminView::getServiceUrl

(

$sLangAbbr = null

)

Returns service URL

Parameters

string

$sLangAbbr

language abbr.

Returns

string

Definition at line 216 of file oxadminview.php.

oxAdminView::getViewId

(

)

Current view ID getter helps to identify navigation position

Returns

string

Reimplemented from oxView.

Reimplemented in DynExportBase, Login, VoucherSerie_Main, dyn_trusted_ratings, dyn_trusted, Dynscreen, dyn_econda, Efire, and dyn_interface.

Definition at line 546 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 Shop_List, User_List, and List_User.

Definition at line 136 of file oxadminview.php.

oxAdminView::render

(

)

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

Returns

string

Reimplemented from oxView.

Reimplemented in oxAdminList, DynExportBase, Diagnostics_Main, Language_List, GenImport_Main, User_Payment, Shop_List, Category_List, Language_Main, List_Order, Order_Article, AdminGuestbook_List, dyn_trusted, VoucherSerie_Main, List_Review, Order_List, Actions_List, Country_List, List_User, GenExport_Main, Shop_License, Article_List, Content_List, Article_Files, UserGroup_List, Wrapping_List, Shop_Config, oxAdminDetails, SelectList_Main, Shop_Main, Article_Extend, Login, Module_List, Order_Downloads, User_Address, Article_Variant, dyn_trusted_ratings, Newsletter_Selection, Newsletter_Send, Payment_Main, PriceAlarm_Send, Shop_System, EFire_Downloader, News_Main, Shop_Seo, Delivery_Articles, Navigation, dyn_econda, Module_Config, Theme_Config, User_Main, Article_Crossselling, Module_Main, Theme_Main, VoucherSerie_Groups, Actions_Main, Article_Attribute, Article_Main, Article_Overview, Article_Pictures, Article_Review, Article_Stock, Attribute_Category, Attribute_Main, Category_Main, Delivery_Main, Delivery_Users, DeliverySet_Main, DeliverySet_Payment, DeliverySet_Users, Discount_Articles, Discount_Users, Module, Newsletter_Main, Newsletter_Plain, Newsletter_Preview, Order_Address, Order_Main, Order_Overview, Order_Package, Order_Remark, Payment_Country, PriceAlarm_Mail, PriceAlarm_Main, Shop, Statistic_Main, Theme, User_Remark, UserGroup_Main, Wrapping_Main, Adminguestbook_Main, Adminlinks_Main, Category_Order, Category_Pictures, Category_Text, Content_Main, Country_Main, Discount_Main, Dynscreen_List, EFire_List, Manufacturer_Main, Module_SortList, Statistic_Service, SystemInfo, Theme_List, Tools, Tools_Main, User_Article, User_Extend, Vendor_Main, Object_Seo, sysreq_main, Article_Userdef, News_Text, and User_Overview.

Definition at line 322 of file oxadminview.php.

oxAdminView::resetContentCache

(

$blForceReset = null

)

Reset output cache

Parameters

bool

$blForceReset

if true, forces reset

Returns

null

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

string	$sCounterType	counter type
string	$sValue	reset value

Returns

null

Definition at line 439 of file oxadminview.php.

oxAdminView::resetSeoData

(

$sShopId

)

Marks seo entires as expired, cleans up tag clouds cache

Parameters

string

$sShopId

Shop id

Returns

null

Definition at line 571 of file oxadminview.php.

oxAdminView::save

(

)

Clears cache

Returns

string

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

Definition at line 407 of file oxadminview.php.

oxAdminView::setEditObjectId

(

$sId

)

Sets editable object id

Parameters

string

$sId

object id

Returns

string

Definition at line 616 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::$_iDefEdit = 0

protected

Definition at line 34 of file oxadminview.php.

oxAdminView::$_iEditLang = 0

protected

Definition at line 48 of file oxadminview.php.

oxAdminView::$_oEditShop = null

protected

Active shop object

Returns

Definition at line 82 of file oxadminview.php.

oxAdminView::$_oNaviTree = null

staticprotected

Definition at line 41 of file oxadminview.php.

oxAdminView::$_sAuthUserRights = null

staticprotected

Definition at line 76 of file oxadminview.php.

oxAdminView::$_sEditObjectId = null

protected

Definition at line 89 of file oxadminview.php.

oxAdminView::$_sServiceUrl = null

protected

Definition at line 69 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::$_sThisTemplate = null

protected

Definition at line 26 of file oxadminview.php.

---

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

• application/controllers/admin/oxadminview.php