oxArticleList Class Reference
List of all members.
Detailed Description
Article list manager. Collects list of article according to collection rules (categories, etc.).
|
Public Member Functions |
| setCustomSorting ($sSorting) |
| enableSelectLists () |
| selectString ($sSelect) |
| loadHistoryArticles ($sArtId) |
| loadNewestArticles ($iLimit=null) |
| loadTop5Articles () |
| loadAktionArticles ($sActionID) |
| loadArticleCrossSell ($sArticleId) |
| loadArticleAccessoires ($sArticleId) |
| loadCategoryIds ($sCatId, $aSessionFilter) |
| loadCategoryArticles ($sCatId, $aSessionFilter, $iLimit=null) |
| loadRecommArticles ($sRecommId, $sArticlesFilter=null) |
| loadRecommArticleIds ($sRecommId, $sArticlesFilter) |
| loadSearchIds ($sSearchStr= '', $sSearchCat= '', $sSearchVendor= '') |
| loadPriceIds ($dPriceFrom, $dPriceTo) |
| loadPriceArticles ($dPriceFrom, $dPriceTo, $oCategory=null) |
| loadVendorIDs ($sVendorId) |
| loadVendorArticles ($sVendorId, $oVendor=null) |
| loadTagArticles ($sTag, $iLang) |
| getTagArticleIds ($sTag, $iLang) |
| loadIds ($aIds) |
| loadOrderArticles ($aOrders) |
Protected Member Functions |
| _getArticleSelect ($sRecommId, $sArticlesFilter=null) |
| _createIdListFromSql ($sSql) |
| _getFilterSql ($sCatId, $aFilter) |
| _getCategorySelect ($sFields, $sCatId, $aSessionFilter) |
| _getSearchSelect ($sSearchString) |
| _getPriceSelect ($dPriceFrom, $dPriceTo) |
| _getVendorSelect ($sVendorId) |
Protected Attributes |
| $_sCustomSorting |
| $_sObjectsInListName = 'oxarticle' |
| $_blLoadSelectLists = false |
| $_blLoadPrice = true |
Member Function Documentation
oxArticleList.setCustomSorting |
( |
$ |
sSorting |
) |
|
Set Custom Sorting, simply an order by....
- Parameters:
-
| string | $sSorting Custom sorting |
- Returns:
- null
oxArticleList.enableSelectLists |
( |
|
) |
|
oxArticleList.selectString |
( |
$ |
sSelect |
) |
|
Loads selectlists for each artile in list if they exists Returns true on success.
- Parameters:
-
| string | $sSelect SQL select string |
- Returns:
- bool
Reimplemented from oxList.
oxArticleList.loadHistoryArticles |
( |
$ |
sArtId |
) |
|
Loads up to 4 history (normally recently seen) articles from session, and adds $sArtId to history. Returns article id array.
- Parameters:
-
- Returns:
- array
oxArticleList.loadNewestArticles |
( |
$ |
iLimit = null |
) |
|
Loads newest shops articles from DB.
- Parameters:
-
- Returns:
- null;
oxArticleList.loadTop5Articles |
( |
|
) |
|
Load top 5 articles
- Returns:
- null
oxArticleList.loadAktionArticles |
( |
$ |
sActionID |
) |
|
Loads shop AktionArticles.
- Parameters:
-
| string | $sActionID Action id |
- Returns:
- null
oxArticleList.loadArticleCrossSell |
( |
$ |
sArticleId |
) |
|
Loads article crosssellings
- Parameters:
-
- Returns:
- null
oxArticleList.loadArticleAccessoires |
( |
$ |
sArticleId |
) |
|
Loads article accessoires
- Parameters:
-
- Returns:
- null
oxArticleList.loadCategoryIds |
( |
$ |
sCatId, |
|
|
$ |
aSessionFilter | |
|
) |
| | |
Loads only ID's and create Fake objects for cmp_categories.
- Parameters:
-
| string | $sCatId Category tree ID |
| array | $aSessionFilter Like array ( catid => array( attrid => value,...)) |
- Returns:
- null
oxArticleList.loadCategoryArticles |
( |
$ |
sCatId, |
|
|
$ |
aSessionFilter, |
|
|
$ |
iLimit = null | |
|
) |
| | |
Loads articles for the give Category
- Parameters:
-
| string | $sCatId Category tree ID |
| array | $aSessionFilter Like array ( catid => array( attrid => value,...)) |
- Returns:
- integer total Count of Articles in this Category
oxArticleList.loadRecommArticles |
( |
$ |
sRecommId, |
|
|
$ |
sArticlesFilter = null | |
|
) |
| | |
Loads articles for the recommlist
- Parameters:
-
| string | $sRecommId Recommlist ID |
| string | $sArticlesFilter Additional filter for recommlist's items |
- Returns:
- integer total Count of Articles in this Category
oxArticleList.loadRecommArticleIds |
( |
$ |
sRecommId, |
|
|
$ |
sArticlesFilter | |
|
) |
| | |
Loads only ID's and create Fake objects.
- Parameters:
-
| string | $sRecommId Recommlist ID |
| string | $sArticlesFilter Additional filter for recommlist's items |
- Returns:
- null
oxArticleList._getArticleSelect |
( |
$ |
sRecommId, |
|
|
$ |
sArticlesFilter = null | |
|
) |
| | [protected] |
Returns the appropriate SQL select
- Parameters:
-
| string | $sRecommId Recommlist ID |
| string | $sArticlesFilter Additional filter for recommlist's items |
- Returns:
- string
oxArticleList.loadSearchIds |
( |
$ |
sSearchStr = '' , |
|
|
$ |
sSearchCat = '' , |
|
|
$ |
sSearchVendor = '' | |
|
) |
| | |
Loads only ID's and create Fake objects for cmp_categories.
- Parameters:
-
| string | $sSearchStr Search string |
| string | $sSearchCat Search within category |
| string | $sSearchVendor Search within vendor |
- Returns:
- null;
oxArticleList.loadPriceIds |
( |
$ |
dPriceFrom, |
|
|
$ |
dPriceTo | |
|
) |
| | |
Loads Id list of appropriate price products
- Parameters:
-
| float | $dPriceFrom Starting price |
| float | $dPriceTo Max price |
- Returns:
- null;
oxArticleList.loadPriceArticles |
( |
$ |
dPriceFrom, |
|
|
$ |
dPriceTo, |
|
|
$ |
oCategory = null | |
|
) |
| | |
Loads articles, that price is bigger than passed $dPriceFrom and smaller than passed $dPriceTo. Returns count of selected articles.
- Parameters:
-
| double | $dPriceFrom Price from |
| double | $dPriceTo Price to |
| object | $oCategory Active category object |
- Returns:
- integer
oxArticleList.loadVendorIDs |
( |
$ |
sVendorId |
) |
|
Loads Products for specified vendor
- Parameters:
-
- Returns:
- null;
oxArticleList.loadVendorArticles |
( |
$ |
sVendorId, |
|
|
$ |
oVendor = null | |
|
) |
| | |
Loads articles that belongs to vendor, passed by parameter $sVendorId. Returns count of selected articles.
- Parameters:
-
| string | $sVendorId Vendor ID |
| object | $oVendor Active vendor object |
- Returns:
- integer
oxArticleList.loadTagArticles |
( |
$ |
sTag, |
|
|
$ |
iLang | |
|
) |
| | |
Loads a list of articles having
- Parameters:
-
| string | $sTag |
| int | $iLang active language |
- Returns:
- int
oxArticleList.getTagArticleIds |
( |
$ |
sTag, |
|
|
$ |
iLang | |
|
) |
| | |
Returns array of article ids belonging to current tags
- Parameters:
-
| string | $sTag current tag |
| int | $iLang active language |
- Returns:
- array
oxArticleList.loadIds |
( |
$ |
aIds |
) |
|
Load the list by article ids
- Parameters:
-
- Returns:
- null;
oxArticleList.loadOrderArticles |
( |
$ |
aOrders |
) |
|
Loads the article list by orders ids
- Parameters:
-
| array | $aOrders user orders array |
- Returns:
- null;
oxArticleList._createIdListFromSql |
( |
$ |
sSql |
) |
[protected] |
fills the list simply with keys of the oxid and the position as value for the given sql
- Parameters:
-
- Returns:
- null
oxArticleList._getFilterSql |
( |
$ |
sCatId, |
|
|
$ |
aFilter | |
|
) |
| | [protected] |
returns filtered articles sql "oxid in (filtered ids)" part
- Parameters:
-
| string | $sCatId category id |
| array | $aFilter filters for this category |
- Returns:
- string
oxArticleList._getCategorySelect |
( |
$ |
sFields, |
|
|
$ |
sCatId, |
|
|
$ |
aSessionFilter | |
|
) |
| | [protected] |
Creates SQL Statement to load Articles, etc.
- Parameters:
-
| string | $sFields Fields which are loaded e.g. "oxid" or "*" etc. |
| string | $sCatId Category tree ID |
| array | $aSessionFilter Like array ( catid => array( attrid => value,...)) |
- Returns:
- string SQL
oxArticleList._getSearchSelect |
( |
$ |
sSearchString |
) |
[protected] |
Forms and returns SQL query string for search in DB.
- Parameters:
-
| string | $sSearchString searching string |
- Returns:
- string
oxArticleList._getPriceSelect |
( |
$ |
dPriceFrom, |
|
|
$ |
dPriceTo | |
|
) |
| | [protected] |
Builds SQL for selecting articles by price
- Parameters:
-
| double | $dPriceFrom Starting price |
| double | $dPriceTo Max price |
- Returns:
- string
oxArticleList._getVendorSelect |
( |
$ |
sVendorId |
) |
[protected] |
Builds vendor select SQL statement
- Parameters:
-
- Returns:
- string
Member Data Documentation
oxArticleList.$_sCustomSorting [protected] |
oxArticleList.$_sObjectsInListName = 'oxarticle' [protected] |
oxArticleList.$_blLoadSelectLists = false [protected] |
oxArticleList.$_blLoadPrice = true [protected] |
The documentation for this class was generated from the following file: