OxidEsales\EshopCommunity\Application\Component\Locator Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Component\Locator:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Component\Locator:

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)
	_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.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Component\Locator::__construct

(

$sType = null

)

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

Parameters

string

$sType

locator type

Member Function Documentation

_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)
ListModel	$oIdList	list of article ids (optional)
Article	$oArticle	active article id (optional)

Returns

int

Deprecated:

underscore prefix violates PSR12, will be renamed to "findActPageNumber" in next major

_getPageNumber()

OxidEsales\EshopCommunity\Application\Component\Locator::_getPageNumber (   $iPageNr )

protected

Gets current page number.

Parameters

int

$iPageNr

page number

Returns

string $sPageNum

Deprecated:

underscore prefix violates PSR12, will be renamed to "getPageNumber" in next major

_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

Article	$oArticle	current Article
object	$oIdList	articles list containing only fake article objects !!!
FrontendController	$oLocatorTarget	FrontendController object

Returns

integer

Deprecated:

underscore prefix violates PSR12, will be renamed to "getProductPos" in next major

_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

Deprecated:

underscore prefix violates PSR12, will be renamed to "loadIdsInList" in next major

_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

Deprecated:

underscore prefix violates PSR12, will be renamed to "makeLink" in next major

_setListLocatorData()

OxidEsales\EshopCommunity\Application\Component\Locator::_setListLocatorData (   $oLocatorTarget,   $oCurrArticle  )

protected

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

Parameters

FrontendController	$oLocatorTarget	view object
Article	$oCurrArticle	current article

Deprecated:

underscore prefix violates PSR12, will be renamed to "setListLocatorData" in next major

_setManufacturerLocatorData()

OxidEsales\EshopCommunity\Application\Component\Locator::_setManufacturerLocatorData (   $oLocatorTarget,   $oCurrArticle  )

protected

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

Parameters

FrontendController	$oLocatorTarget	FrontendController object
Article	$oCurrArticle	current article

Deprecated:

underscore prefix violates PSR12, will be renamed to "setManufacturerLocatorData" in next major

_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

FrontendController	$oLocatorTarget	FrontendController object
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

FrontendController	$oLocatorTarget	FrontendController object
Article	$oCurrArticle	current article

Deprecated:

underscore prefix violates PSR12, will be renamed to "setSearchLocatorData" in next major

_setVendorLocatorData()

OxidEsales\EshopCommunity\Application\Component\Locator::_setVendorLocatorData (   $oLocatorTarget,   $oCurrArticle  )

protected

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

Parameters

FrontendController	$oLocatorTarget	FrontendController object
Article	$oCurrArticle	current article

Deprecated:

underscore prefix violates PSR12, will be renamed to "setVendorLocatorData" in next major

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

Article	$oCurrArticle	current article
FrontendController	$oLocatorTarget	FrontendController object

Member Data Documentation

$_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

error message

$_sSearchHandle

OxidEsales\EshopCommunity\Application\Component\Locator::$_sSearchHandle = null

protected

search handle

$_sType

OxidEsales\EshopCommunity\Application\Component\Locator::$_sType = "list"

protected

Locator type

---

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

• /oxideshop-ce/source/Application/Component/Locator.php