oxRecommList Class Reference
Detailed Description
Recommendation list manager class.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 () | |
| getLink () | |
| setArticlesFilter ($sArticlesFilter) | |
Protected Member Functions | |
| _getArticleSelect () | |
| _loadFirstArticles (oxList $oRecommList, $aIds) | |
| _getSearchSelect ($sSearchStr) | |
Protected Attributes | |
| $_sClassName = 'oxRecommList' | |
| $_oArticles = null | |
| $_sArticlesFilter = '' | |
Constructor & Destructor Documentation
| oxRecommList.__construct | ( | ) |
Class constructor, initiates parent constructor (parent.oxBase()).
- Returns:
- null
Reimplemented from oxBase.
Member Function Documentation
| oxRecommList.getArticles | ( | $ | iStart = null, |
|
| $ | iNrofArticles = null, |
|||
| $ | blReload = false | |||
| ) |
Returns list of recommendation list items
- Parameters:
-
integer $iStart start for sql limit integer $iNrofArticles nr of items per page bool $blReload if TRUE forces to reload list
- Returns:
- oxList
| oxRecommList.getArtCount | ( | ) |
Returns count of recommendation list items
- Parameters:
-
integer $iStart start for sql limit integer $iNrofArticles nr of items per page bool $blReload if TRUE forces to reload list
- Returns:
- array of oxUserBasketItems
| oxRecommList._getArticleSelect | ( | ) | [protected] |
Returns the appropriate SQL select
- Returns:
- string
| oxRecommList.getFirstArticle | ( | ) |
returns first article from this list's article list
- Returns:
- oxArticle
| oxRecommList.delete | ( | $ | sOXID = null |
) |
Removes articles from the recommlist and deletes list
- Parameters:
-
string $sOXID Object ID(default null)
- Returns:
- bool
Reimplemented from oxBase.
| oxRecommList.getArtDescription | ( | $ | sOXID | ) |
Returns article description for recommendation list
- Parameters:
-
string $sOXID Object ID
- Returns:
- string
| oxRecommList.removeArticle | ( | $ | sOXID | ) |
Remove article from recommendation list
- Parameters:
-
string $sOXID Object ID
- Returns:
- bool
| oxRecommList.addArticle | ( | $ | sOXID, | |
| $ | sDesc | |||
| ) |
Add article to recommendation list
- Parameters:
-
string $sOXID Object ID string $sDesc recommended article description
- Returns:
- bool
| oxRecommList.getRecommListsByIds | ( | $ | aArticleIds | ) |
get recommendation lists wich include given article ids also sort these lists by these criterias: 1. show lists, that has more requested articles first 2. show lists, that have more any articles
- Parameters:
-
array $aIds Object IDs
- Returns:
- oxList
| 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 $oRecommList recommendation list array $aIds article ids
| oxRecommList.getSearchRecommLists | ( | $ | sSearchStr | ) |
Returns user recommendation list objects
- Parameters:
-
string $sSearchStr Search string
- Returns:
- object oxlist with oxrecommlist objects
| oxRecommList.getSearchRecommListCount | ( | $ | sSearchStr | ) |
Returns the amount of lists according to search parameters.
- Parameters:
-
string $sSearchStr Search string
- Returns:
- int
| oxRecommList._getSearchSelect | ( | $ | sSearchStr | ) | [protected] |
Returns the appropriate SQL select according to search parameters
- Parameters:
-
string $sSearchStr Search string
- Returns:
- string
| oxRecommList.addToRatingAverage | ( | $ | iRating | ) |
Calculates and saves product rating average
- Parameters:
-
integer $iRating new rating value
- Returns:
- null
| oxRecommList.getLink | ( | ) |
return url to this recomm list page
- Returns:
- string
| oxRecommList.setArticlesFilter | ( | $ | sArticlesFilter | ) |
set sql filter for article loading
- Parameters:
-
string $sArticlesFilter
Member Data Documentation
oxRecommList.$_sClassName = 'oxRecommList' [protected] |
Reimplemented from oxBase.
oxRecommList.$_oArticles = null [protected] |
oxRecommList.$_sArticlesFilter = '' [protected] |
The documentation for this class was generated from the following file:
- core/oxrecommlist.php
