|
| _setListLocatorData ($oLocatorTarget, $oCurrArticle) |
|
| _setVendorLocatorData ($oLocatorTarget, $oCurrArticle) |
|
| _setManufacturerLocatorData ($oLocatorTarget, $oCurrArticle) |
|
| _setSearchLocatorData ($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) |
|
Locator controller for: category, vendor, manufacturers and search lists.
◆ __construct()
OxidEsales\EshopCommunity\Application\Component\Locator::__construct |
( |
|
$sType = null | ) |
|
Class constructor - sets locator type and parameters posted or loaded from GET/Session
- Parameters
-
◆ _findActPageNumber()
OxidEsales\EshopCommunity\Application\Component\Locator::_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) |
\OxidEsales\Eshop\Core\Model\ListModel | $oIdList | list of article ids (optional) |
\OxidEsales\Eshop\Application\Model\Article | $oArticle | active article id (optional) |
- Returns
- int
◆ _getPageNumber()
OxidEsales\EshopCommunity\Application\Component\Locator::_getPageNumber |
( |
|
$iPageNr | ) |
|
|
protected |
Gets current page number.
- Parameters
-
- Returns
- string $sPageNum
◆ _getProductPos()
OxidEsales\EshopCommunity\Application\Component\Locator::_getProductPos |
( |
|
$oArticle, |
|
|
|
$oIdList, |
|
|
|
$oLocatorTarget |
|
) |
| |
|
protected |
Searches for current article in article list and sets previous/next product ids
- Parameters
-
\OxidEsales\Eshop\Application\Model\Article | $oArticle | current Article |
object | $oIdList | articles list containing only fake article objects !!! |
\OxidEsales\Eshop\Application\Controller\FrontendController | $oLocatorTarget | FrontendController object |
- Returns
- integer
◆ _loadIdsInList()
OxidEsales\EshopCommunity\Application\Component\Locator::_loadIdsInList |
( |
|
$oCategory, |
|
|
|
$oCurrArticle, |
|
|
|
$sOrderBy = null |
|
) |
| |
|
protected |
Setting product position in list, amount of articles etc
- Parameters
-
\OxidEsales\Eshop\Application\Model\Category | $oCategory | active category id |
object | $oCurrArticle | current article |
string | $sOrderBy | order by fields |
- Returns
- object
◆ _makeLink()
OxidEsales\EshopCommunity\Application\Component\Locator::_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
◆ _setListLocatorData()
OxidEsales\EshopCommunity\Application\Component\Locator::_setListLocatorData |
( |
|
$oLocatorTarget, |
|
|
|
$oCurrArticle |
|
) |
| |
|
protected |
Sets details locator data for articles that came from regular list.
- Parameters
-
\OxidEsales\Eshop\Application\Controller\FrontendController | $oLocatorTarget | view object |
\OxidEsales\Eshop\Application\Model\Article | $oCurrArticle | current article |
◆ _setManufacturerLocatorData()
OxidEsales\EshopCommunity\Application\Component\Locator::_setManufacturerLocatorData |
( |
|
$oLocatorTarget, |
|
|
|
$oCurrArticle |
|
) |
| |
|
protected |
Sets details locator data for articles that came from Manufacturer list.
- Parameters
-
\OxidEsales\Eshop\Application\Controller\FrontendController | $oLocatorTarget | FrontendController object |
\OxidEsales\Eshop\Application\Model\Article | $oCurrArticle | current article |
◆ _setRecommlistLocatorData()
OxidEsales\EshopCommunity\Application\Component\Locator::_setRecommlistLocatorData |
( |
|
$oLocatorTarget, |
|
|
|
$oCurrArticle |
|
) |
| |
|
protected |
Sets details locator data for articles that came from recommlist.
Template variables: sSearchTitle, searchparamforhtml
- Parameters
-
\OxidEsales\Eshop\Application\Controller\FrontendController | $oLocatorTarget | FrontendController object |
\OxidEsales\Eshop\Application\Model\Article | $oCurrArticle | current article |
- Deprecated:
- since v5.3 (2016-06-17); Listmania will be moved to an own module.
◆ _setSearchLocatorData()
OxidEsales\EshopCommunity\Application\Component\Locator::_setSearchLocatorData |
( |
|
$oLocatorTarget, |
|
|
|
$oCurrArticle |
|
) |
| |
|
protected |
Sets details locator data for articles that came from search list.
- Parameters
-
\OxidEsales\Eshop\Application\Controller\FrontendController | $oLocatorTarget | FrontendController object |
\OxidEsales\Eshop\Application\Model\Article | $oCurrArticle | current article |
◆ _setVendorLocatorData()
OxidEsales\EshopCommunity\Application\Component\Locator::_setVendorLocatorData |
( |
|
$oLocatorTarget, |
|
|
|
$oCurrArticle |
|
) |
| |
|
protected |
Sets details locator data for articles that came from vendor list.
- Parameters
-
\OxidEsales\Eshop\Application\Controller\FrontendController | $oLocatorTarget | FrontendController object |
\OxidEsales\Eshop\Application\Model\Article | $oCurrArticle | current article |
◆ getErrorMessage()
OxidEsales\EshopCommunity\Application\Component\Locator::getErrorMessage |
( |
| ) |
|
Template variable getter. Returns error message
- Returns
- string
◆ setLocatorData()
OxidEsales\EshopCommunity\Application\Component\Locator::setLocatorData |
( |
|
$oCurrArticle, |
|
|
|
$oLocatorTarget |
|
) |
| |
Executes locator method according locator type
- Parameters
-
\OxidEsales\Eshop\Application\Model\Article | $oCurrArticle | current article |
\OxidEsales\Eshop\Application\Controller\FrontendController | $oLocatorTarget | FrontendController object |
◆ $_oBackProduct
OxidEsales\EshopCommunity\Application\Component\Locator::$_oBackProduct = null |
|
protected |
Previous product to currently loaded
◆ $_oNextProduct
OxidEsales\EshopCommunity\Application\Component\Locator::$_oNextProduct = null |
|
protected |
Next product to currently loaded
◆ $_sErrorMessage
OxidEsales\EshopCommunity\Application\Component\Locator::$_sErrorMessage = null |
|
protected |
◆ $_sSearchHandle
OxidEsales\EshopCommunity\Application\Component\Locator::$_sSearchHandle = null |
|
protected |
◆ $_sType
OxidEsales\EshopCommunity\Application\Component\Locator::$_sType = "list" |
|
protected |
The documentation for this class was generated from the following file: