Public Member Functions | Protected Member Functions | Protected Attributes

oxLocator Class Reference

Inheritance diagram for oxLocator:
Collaboration diagram for oxLocator:

List of all members.

Public Member Functions

 __construct ($sType=null)
 setLocatorData ($oCurrArticle, $oLocatorTarget)
 getErrorMessage ()

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

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 $sType locator type

Definition at line 39 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 $iPageNr current page number (user defined or passed by request)
oxlist $oIdList list of article ids (optional)
oxarticle $oArticle active article id (optional)
Returns:
int

Definition at line 445 of file oxlocator.php.

oxLocator._getPageNumber ( $  iPageNr  )  [protected]

Gets current page number.

Parameters:
int $iPageNr page number
Returns:
string $sPageNum

Definition at line 470 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 $oArticle current Article
object $oIdList articles list containing only fake article objects !!!
oxubase $oLocatorTarget oxubase object
Returns:
integer

Definition at line 486 of file oxlocator.php.

oxLocator._loadIdsInList ( $  oCategory,
$  oCurrArticle,
$  sOrderBy = null 
) [protected]

Setting product position in list, amount of articles etc

Parameters:
oxcategory $oCategory active category id
object $oCurrArticle current article
string $sOrderBy order by fields
Returns:
object

Definition at line 399 of file oxlocator.php.

oxLocator._makeLink ( $  sLink,
$  sParams 
) [protected]

Appends urs with currently passed parameters

Parameters:
string $sLink url to add parameters
string $sParams parameters to add to url
Returns:
string

Definition at line 427 of file oxlocator.php.

oxLocator._setListLocatorData ( $  oLocatorTarget,
$  oCurrArticle 
) [protected]

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

Parameters:
oxubase $oLocatorTarget view object
oxarticle $oCurrArticle current article
Returns:
null

Definition at line 72 of file oxlocator.php.

oxLocator._setManufacturerLocatorData ( $  oLocatorTarget,
$  oCurrArticle 
) [protected]

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

Parameters:
oxubase $oLocatorTarget oxubase object
oxarticle $oCurrArticle current article
Returns:
null

Definition at line 165 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 $oLocatorTarget oxubase object
oxarticle $oCurrArticle current article
Returns:
null

Definition at line 341 of file oxlocator.php.

oxLocator._setSearchLocatorData ( $  oLocatorTarget,
$  oCurrArticle 
) [protected]

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

Parameters:
oxubase $oLocatorTarget oxubase object
oxarticle $oCurrArticle current article
Returns:
null

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 $oLocatorTarget oxubase object
oxarticle $oCurrArticle current article
Returns:
null

Definition at line 285 of file oxlocator.php.

oxLocator._setVendorLocatorData ( $  oLocatorTarget,
$  oCurrArticle 
) [protected]

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

Parameters:
oxUBase $oLocatorTarget oxUBase object
oxArticle $oCurrArticle current article
Returns:
null

Definition at line 119 of file oxlocator.php.

oxLocator.getErrorMessage (  ) 

Template variable getter. Returns error message

Returns:
string

Definition at line 527 of file oxlocator.php.

oxLocator.setLocatorData ( $  oCurrArticle,
$  oLocatorTarget 
)

Executes locator method according locator type

Parameters:
oxarticle $oCurrArticle current article
oxubase $oLocatorTarget oxubase object
Returns:
null

Definition at line 55 of file oxlocator.php.

Member Data Documentation

oxLocator.$_oBackProduct = null [protected]

Previous product to currently loaded

Definition at line 21 of file oxlocator.php.

oxLocator.$_oNextProduct = null [protected]

Next product to currently loaded

Definition at line 16 of file oxlocator.php.

oxLocator.$_sErrorMessage = null [protected]

error message

Definition at line 31 of file oxlocator.php.

oxLocator.$_sSearchHandle = null [protected]

search handle

Definition at line 26 of file oxlocator.php.

oxLocator.$_sType = "list" [protected]

Locator type

Definition at line 11 of file oxlocator.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1