OXID eShop CE  4.10.0
 All Classes Namespaces Files Functions Variables Pages
oxRecommList Class Reference
+ Inheritance diagram for oxRecommList:
+ Collaboration diagram for oxRecommList:

Public Member Functions

 __construct ()
 getArticles ($iStart=null, $iNrofArticles=null, $blReload=false)
 getArtCount ()
 getFirstArticle ()
 delete ($sOXID=null)
 getArtDescription ($sOXID)
 removeArticle ($sOXID)
 addArticle ($sOXID, $sDesc)
 getRecommListsByIds ($aArticleIds)
 getSearchRecommLists ($sSearchStr)
 getSearchRecommListCount ($sSearchStr)
 addToRatingAverage ($iRating)
 getReviews ()
 getBaseSeoLink ($iLang, $iPage=0)
 getLink ($iLang=null)
 getStdLink ($iLang=null, $aParams=array())
 getBaseStdLink ($iLang, $blAddId=true, $blFull=true)
 setArticlesFilter ($sArticlesFilter)
 save ()
- Public Member Functions inherited from oxBase
 getUseSkipSaveFields ()
 setUseSkipSaveFields ($blUseSkipSaveFields)
 __set ($sName, $sValue)
 __get ($sName)
 __isset ($mVar)
 __clone ()
 oxClone ($oObject)
 getUpdateSeo ()
 setUpdateSeo ($blUpdateSeo)
 init ($sTableName=null, $blForceAllFields=false)
 assign ($dbRecord)
 getClassName ()
 getCoreTableName ()
 getId ()
 setId ($sOXID=null)
 setShopId ($iShopId)
 getShopId ()
 getViewName ($blForceCoreTableUsage=null)
 modifyCacheKey ($sCacheKey, $blOverride=false)
 disableLazyLoading ()
 isDerived ()
 setIsDerived ($blVal)
 isMultilang ()
 load ($sOXID)
 isLoaded ()
 buildSelectString ($aWhere=null)
 assignRecord ($sSelect)
 getFieldData ($sFieldName)
 getSelectFields ($blForceCoreTableUsage=null)
 allowDerivedUpdate ()
 allowDerivedDelete ()
 exists ($sOXID=null)
 getSqlActiveSnippet ($blForceCoreTable=null)
 beforeUpdate ($sOXID=null)
 onChange ($iAction=null, $sOXID=null)
 setInList ()
 isOx ()
 isReadOnly ()
 setReadOnly ($blReadOnly)
 getFieldNames ()
 addFieldName ($sName)
 getLanguage ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _getArticleSelect ()
 _loadFirstArticles (oxList $oRecommList, $aIds)
 _getSearchSelect ($sSearchStr)
- Protected Member Functions inherited from oxBase
 _setUpdateSeoOnFieldChange ($sField)
 _removeElement2ShopRelations ($sOxId)
 _isInList ()
 _getObjectViewName ($sTable, $sShopID=null)
 _getTableFields ($sTable, $blReturnSimple=false)
 _getAllFields ($blReturnSimple=false)
 _initDataStructure ($blForceFullStructure=false)
 _getNonCachedFieldNames ($blForceFullStructure=false)
 _getFieldStatus ($sFieldName)
 _addField ($sName, $iStatus, $sType=null, $sLength=null)
 _getFieldLongName ($sFieldName)
 _setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
 _canFieldBeNull ($sFieldName)
 _getFieldDefaultValue ($sFieldName)
 _getUpdateFieldValue ($sFieldName, $oField)
 _getUpdateFields ($blUseSkipSaveFields=true)
 _update ()
 _insert ()
 _isDisabledFieldCache ()
 _addSkippedSaveFieldsForMapping ()
 _disableLazyLoadingForCaching ()

Protected Attributes

 $_sClassName = 'oxRecommList'
 $_oArticles = null
 $_sArticlesFilter = ''
 $_aSeoUrls = array()
- Protected Attributes inherited from oxBase
 $_sOXID = null
 $_iShopId = null
 $_blIsSimplyClonable = true
 $_sClassName = 'oxbase'
 $_sCoreTable = null
 $_sViewTable = null
 $_aFieldNames = array('oxid' => 0)
 $_sCacheKey = null
 $_blUseLazyLoading = false
 $_aSkipSaveFields = array('oxtimestamp')
 $_blUseSkipSaveFields = true
 $_sExistKey = 'oxid'
 $_blIsDerived = null
 $_blIsSeoObject = false
 $_blUpdateSeo = true
 $_blReadOnly = false
 $_blIsInList = false
 $_isLoaded = false
 $_aInnerLazyCache = null
 $_blEmployMultilanguage = false

Additional Inherited Members

- Static Protected Attributes inherited from oxBase
static $_blDisableFieldCaching = array()

Detailed Description

Recommendation list manager class.

Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.

Definition at line 8 of file oxrecommlist.php.

Constructor & Destructor Documentation

oxRecommList::__construct ( )

Class constructor, initiates parent constructor (parent::oxBase()).

Returns
null

Reimplemented from oxBase.

Definition at line 44 of file oxrecommlist.php.

Member Function Documentation

oxRecommList::_getArticleSelect ( )
protected

Returns the appropriate SQL select

Returns
string

Definition at line 99 of file oxrecommlist.php.

oxRecommList::_getSearchSelect (   $sSearchStr)
protected

Returns the appropriate SQL select according to search parameters

Parameters
string$sSearchStrSearch string
Returns
string

Definition at line 359 of file oxrecommlist.php.

oxRecommList::_loadFirstArticles ( oxList  $oRecommList,
  $aIds 
)
protected

loads first articles to recomm list also ordering them and clearing not usable list objects ordering priorities:

  1. first show articles from our search
  2. do not shown articles as 1st, which are shown in other recomm lists as 1st
Parameters
oxList$oRecommListrecommendation list
array$aIdsarticle ids

Definition at line 270 of file oxrecommlist.php.

oxRecommList::addArticle (   $sOXID,
  $sDesc 
)

Add article to recommendation list

Parameters
string$sOXIDObject ID
string$sDescrecommended article description
Returns
bool

Definition at line 196 of file oxrecommlist.php.

oxRecommList::addToRatingAverage (   $iRating)

Calculates and saves product rating average

Parameters
integer$iRatingnew rating value

Definition at line 377 of file oxrecommlist.php.

oxRecommList::delete (   $sOXID = null)

Removes articles from the recommlist and deletes list

Parameters
string$sOXIDObject ID(default null)
Returns
bool

Reimplemented from oxBase.

Definition at line 131 of file oxrecommlist.php.

oxRecommList::getArtCount ( )

Returns count of recommendation list items

Returns
array of oxUserBasketItems

Definition at line 83 of file oxrecommlist.php.

oxRecommList::getArtDescription (   $sOXID)

Returns article description for recommendation list

Parameters
string$sOXIDObject ID
Returns
string

Definition at line 158 of file oxrecommlist.php.

oxRecommList::getArticles (   $iStart = null,
  $iNrofArticles = null,
  $blReload = false 
)

Returns list of recommendation list items

Parameters
integer$iStartstart for sql limit
integer$iNrofArticlesnr of items per page
bool$blReloadif TRUE forces to reload list
Returns
oxList

Definition at line 59 of file oxrecommlist.php.

oxRecommList::getBaseSeoLink (   $iLang,
  $iPage = 0 
)

Returns raw recommlist seo url

Parameters
int$iLanglanguage id
int$iPagepage number [optional]
Returns
string

Definition at line 411 of file oxrecommlist.php.

oxRecommList::getBaseStdLink (   $iLang,
  $blAddId = true,
  $blFull = true 
)

Returns base dynamic recommlist url: shopurl/index.php?cl=recommlist

Parameters
int$iLanglanguage id
bool$blAddIdadd current object id to url or not
bool$blFullreturn full including domain name [optional]
Returns
string

Implements oxIUrl.

Definition at line 471 of file oxrecommlist.php.

oxRecommList::getFirstArticle ( )

returns first article from this list's article list

Returns
oxArticle

Definition at line 114 of file oxrecommlist.php.

oxRecommList::getLink (   $iLang = null)

return url to this recomm list page

Parameters
int$iLanglanguage id [optional]
Returns
string

Implements oxIUrl.

Definition at line 428 of file oxrecommlist.php.

oxRecommList::getRecommListsByIds (   $aArticleIds)

get recommendation lists which include given article ids also sort these lists by these criteria:

  1. show lists, that has more requested articles first
  2. show lists, that have more any articles
Parameters
array$aArticleIdsObject IDs
Returns
oxList

Definition at line 221 of file oxrecommlist.php.

oxRecommList::getReviews ( )

Collects user written reviews about an article.

Returns
oxList

Definition at line 391 of file oxrecommlist.php.

oxRecommList::getSearchRecommListCount (   $sSearchStr)

Returns the amount of lists according to search parameters.

Parameters
string$sSearchStrSearch string
Returns
int

Definition at line 338 of file oxrecommlist.php.

oxRecommList::getSearchRecommLists (   $sSearchStr)

Returns user recommendation list objects

Parameters
string$sSearchStrSearch string
Returns
object oxlist with oxrecommlist objects

Definition at line 310 of file oxrecommlist.php.

oxRecommList::getStdLink (   $iLang = null,
  $aParams = array() 
)

Returns standard (dynamic) object URL

Parameters
int$iLanglanguage id [optional]
array$aParamsadditional params to use [optional]
Returns
string

Implements oxIUrl.

Definition at line 453 of file oxrecommlist.php.

oxRecommList::removeArticle (   $sOXID)

Remove article from recommendation list

Parameters
string$sOXIDObject ID
Returns
bool

Definition at line 177 of file oxrecommlist.php.

oxRecommList::save ( )

Save this Object to database, insert or update as needed.

Returns
mixed

Reimplemented from oxBase.

Definition at line 497 of file oxrecommlist.php.

oxRecommList::setArticlesFilter (   $sArticlesFilter)

set sql filter for article loading

Parameters
string$sArticlesFilterarticle filter

Definition at line 487 of file oxrecommlist.php.

Member Data Documentation

oxRecommList::$_aSeoUrls = array()
protected

Definition at line 37 of file oxrecommlist.php.

oxRecommList::$_oArticles = null
protected

Definition at line 23 of file oxrecommlist.php.

oxRecommList::$_sArticlesFilter = ''
protected

Definition at line 30 of file oxrecommlist.php.

oxRecommList::$_sClassName = 'oxRecommList'
protected

Definition at line 16 of file oxrecommlist.php.


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