OXID eShop CE  4.9.9
 All Classes Files Functions Variables Pages
oxLocator Class Reference
+ Inheritance diagram for oxLocator:
+ Collaboration diagram for oxLocator:

Public Member Functions

 __construct ($sType=null)
 setLocatorData ($oCurrArticle, $oLocatorTarget)
 getErrorMessage ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _setListLocatorData ($oLocatorTarget, $oCurrArticle)
 _setVendorLocatorData ($oLocatorTarget, $oCurrArticle)
 _setManufacturerLocatorData ($oLocatorTarget, $oCurrArticle)
 _setSearchLocatorData ($oLocatorTarget, $oCurrArticle)
 _setTagLocatorData ($oLocatorTarget, $oCurrArticle)
 _setRecommlistLocatorData ($oLocatorTarget, $oCurrArticle)
 _loadIdsInList ($oCategory, $oCurrArticle, $sOrderBy=null)
 _makeLink ($sLink, $sParams)
 _findActPageNumber ($iPageNr, $oIdList=null, $oArticle=null)
 _getPageNumber ($iPageNr)
 _getProductPos ($oArticle, $oIdList, $oLocatorTarget)

Protected Attributes

 $_sType = "list"
 $_oNextProduct = null
 $_oBackProduct = null
 $_sSearchHandle = null
 $_sErrorMessage = null

Additional Inherited Members

- Static Protected Attributes inherited from oxSuperCfg
static $_oConfig = null
static $_oSession = null
static $_oRights = null
static $_oActUser = null
static $_blIsAdmin = null

Detailed Description

Locator controller for: category, vendor, manufacturers and search lists.

Definition at line 6 of file oxlocator.php.

Constructor & Destructor Documentation

oxLocator::__construct (   $sType = null)

Class constructor - sets locator type and parameters posted or loaded from GET/Session

Parameters
string$sTypelocator type

Definition at line 40 of file oxlocator.php.

Member Function Documentation

oxLocator::_findActPageNumber (   $iPageNr,
  $oIdList = null,
  $oArticle = null 
)
protected

If page number is not passed trying to fetch it from list of ids. To search for position in list, article ids list and current article id must be passed

Parameters
int$iPageNrcurrent page number (user defined or passed by request)
oxlist$oIdListlist of article ids (optional)
oxarticle$oArticleactive article id (optional)
Returns
int

Definition at line 453 of file oxlocator.php.

oxLocator::_getPageNumber (   $iPageNr)
protected

Gets current page number.

Parameters
int$iPageNrpage number
Returns
string $sPageNum

Definition at line 478 of file oxlocator.php.

oxLocator::_getProductPos (   $oArticle,
  $oIdList,
  $oLocatorTarget 
)
protected

Searches for current article in article list and sets previous/next product ids

Parameters
oxarticle$oArticlecurrent Article
object$oIdListarticles list containing only fake article objects !!!
oxubase$oLocatorTargetoxubase object
Returns
integer

Definition at line 495 of file oxlocator.php.

oxLocator::_loadIdsInList (   $oCategory,
  $oCurrArticle,
  $sOrderBy = null 
)
protected

Setting product position in list, amount of articles etc

Parameters
oxcategory$oCategoryactive category id
object$oCurrArticlecurrent article
string$sOrderByorder by fields
Returns
object

Definition at line 406 of file oxlocator.php.

oxLocator::_makeLink (   $sLink,
  $sParams 
)
protected

Appends urs with currently passed parameters

Parameters
string$sLinkurl to add parameters
string$sParamsparameters to add to url
Returns
string

Definition at line 434 of file oxlocator.php.

oxLocator::_setListLocatorData (   $oLocatorTarget,
  $oCurrArticle 
)
protected

Sets details locator data for articles that came from regular list.

Parameters
oxUBase$oLocatorTargetview object
oxArticle$oCurrArticlecurrent article

Definition at line 69 of file oxlocator.php.

oxLocator::_setManufacturerLocatorData (   $oLocatorTarget,
  $oCurrArticle 
)
protected

Sets details locator data for articles that came from Manufacturer list.

Parameters
oxubase$oLocatorTargetoxubase object
oxarticle$oCurrArticlecurrent article

Definition at line 163 of file oxlocator.php.

oxLocator::_setRecommlistLocatorData (   $oLocatorTarget,
  $oCurrArticle 
)
protected

Sets details locator data for articles that came from recommlist.

Template variables: sSearchTitle, searchparamforhtml

Parameters
oxubase$oLocatorTargetoxubase object
oxarticle$oCurrArticlecurrent article

Definition at line 344 of file oxlocator.php.

oxLocator::_setSearchLocatorData (   $oLocatorTarget,
  $oCurrArticle 
)
protected

Sets details locator data for articles that came from search list.

Parameters
oxubase$oLocatorTargetoxubase object
oxarticle$oCurrArticlecurrent article

Definition at line 219 of file oxlocator.php.

oxLocator::_setTagLocatorData (   $oLocatorTarget,
  $oCurrArticle 
)
protected

Sets details locator data for articles that came from tag list.

Parameters
oxubase$oLocatorTargetoxubase object
oxarticle$oCurrArticlecurrent article

Definition at line 286 of file oxlocator.php.

oxLocator::_setVendorLocatorData (   $oLocatorTarget,
  $oCurrArticle 
)
protected

Sets details locator data for articles that came from vendor list.

Parameters
oxUBase$oLocatorTargetoxUBase object
oxArticle$oCurrArticlecurrent article

Definition at line 117 of file oxlocator.php.

oxLocator::getErrorMessage ( )

Template variable getter. Returns error message

Returns
string

Definition at line 538 of file oxlocator.php.

oxLocator::setLocatorData (   $oCurrArticle,
  $oLocatorTarget 
)

Executes locator method according locator type

Parameters
oxarticle$oCurrArticlecurrent article
oxubase$oLocatorTargetoxubase object

Definition at line 54 of file oxlocator.php.

Member Data Documentation

oxLocator::$_oBackProduct = null
protected

Previous product to currently loaded

Definition at line 22 of file oxlocator.php.

oxLocator::$_oNextProduct = null
protected

Next product to currently loaded

Definition at line 17 of file oxlocator.php.

oxLocator::$_sErrorMessage = null
protected

error message

Definition at line 32 of file oxlocator.php.

oxLocator::$_sSearchHandle = null
protected

search handle

Definition at line 27 of file oxlocator.php.

oxLocator::$_sType = "list"
protected

Locator type

Definition at line 12 of file oxlocator.php.


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