Public Member Functions | Protected Member Functions | Protected Attributes

oxArticleList Class Reference

Inheritance diagram for oxArticleList:
Collaboration diagram for oxArticleList:

List of all members.

Public Member Functions

 setCustomSorting ($sSorting)
 enableSelectLists ()
 selectString ($sSelect)
 getHistoryArticles ()
 setHistoryArticles ($aArticlesIds)
 loadHistoryArticles ($sArtId, $iCnt=4)
 sortByIds ($aIds)
 loadNewestArticles ($iLimit=null)
 loadTop5Articles ($iLimit=null)
 loadActionArticles ($sActionID, $iLimit=null)
 loadAktionArticles ($sActionID, $iLimit=null)
 loadArticleCrossSell ($sArticleId)
 loadArticleAccessoires ($sArticleId)
 loadCategoryIds ($sCatId, $aSessionFilter)
 loadCategoryArticles ($sCatId, $aSessionFilter, $iLimit=null)
 loadRecommArticles ($sRecommId, $sArticlesFilter=null)
 loadRecommArticleIds ($sRecommId, $sArticlesFilter)
 loadSearchIds ($sSearchStr= '', $sSearchCat= '', $sSearchVendor= '', $sSearchManufacturer= '')
 loadPriceIds ($dPriceFrom, $dPriceTo)
 loadPriceArticles ($dPriceFrom, $dPriceTo, $oCategory=null)
 loadVendorIDs ($sVendorId)
 loadManufacturerIDs ($sManufacturerId)
 loadVendorArticles ($sVendorId, $oVendor=null)
 loadManufacturerArticles ($sManufacturerId, $oManufacturer=null)
 loadTagArticles ($sTag, $iLang)
 getTagArticleIds ($sTag, $iLang)
 loadIds ($aIds)
 loadOrderArticles ($aOrders)
 loadStockRemindProducts ($aBasketContents)
 renewPriceUpdateTime ()
 updateUpcomingPrices ($blForceUpdate=false)

Protected Member Functions

 _sortByOrderMapCallback ($key1, $key2)
 _getArticleSelect ($sRecommId, $sArticlesFilter=null)
 _createIdListFromSql ($sSql)
 _getFilterIdsSql ($sCatId, $aFilter)
 _getFilterSql ($sCatId, $aFilter)
 _getCategorySelect ($sFields, $sCatId, $aSessionFilter)
 _getCategoryCountSelect ($sCatId, $aSessionFilter)
 _getSearchSelect ($sSearchString)
 _getPriceSelect ($dPriceFrom, $dPriceTo)
 _getVendorSelect ($sVendorId)
 _getManufacturerSelect ($sManufacturerId)
 _canUpdatePrices ()

Protected Attributes

 $_sCustomSorting
 $_sObjectsInListName = 'oxarticle'
 $_blLoadSelectLists = false

Detailed Description

Article list manager. Collects list of article according to collection rules (categories, etc.).

Definition at line 8 of file oxarticlelist.php.


Member Function Documentation

oxArticleList._canUpdatePrices (  )  [protected]

Checks if price update can be executed - current time > next price update time

Returns:
bool

Definition at line 1267 of file oxarticlelist.php.

oxArticleList._createIdListFromSql ( sSql  )  [protected]

fills the list simply with keys of the oxid and the position as value for the given sql

Parameters:
string $sSql SQL select
Returns:
null

Definition at line 959 of file oxarticlelist.php.

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

Definition at line 501 of file oxarticlelist.php.

oxArticleList._getCategoryCountSelect ( sCatId,
aSessionFilter 
) [protected]

Creates SQL Statement to load Articles Count, etc.

Parameters:
string $sCatId Category tree ID
array $aSessionFilter Like array ( catid => array( attrid => value,...))
Returns:
string SQL

Definition at line 1090 of file oxarticlelist.php.

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

Definition at line 1052 of file oxarticlelist.php.

oxArticleList._getFilterIdsSql ( sCatId,
aFilter 
) [protected]

Returns sql to fetch ids of articles fitting current filter

Parameters:
string $sCatId category id
array $aFilter filters for this category
Returns:
string

Definition at line 979 of file oxarticlelist.php.

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

Definition at line 1018 of file oxarticlelist.php.

oxArticleList._getManufacturerSelect ( sManufacturerId  )  [protected]

Builds Manufacturer select SQL statement

Parameters:
string $sManufacturerId Manufacturer ID
Returns:
string

Definition at line 1246 of file oxarticlelist.php.

oxArticleList._getPriceSelect ( dPriceFrom,
dPriceTo 
) [protected]

Builds SQL for selecting articles by price

Parameters:
double $dPriceFrom Starting price
double $dPriceTo Max price
Returns:
string

Definition at line 1195 of file oxarticlelist.php.

oxArticleList._getSearchSelect ( sSearchString  )  [protected]

Forms and returns SQL query string for search in DB.

Parameters:
string $sSearchString searching string
Returns:
string

Definition at line 1121 of file oxarticlelist.php.

oxArticleList._getVendorSelect ( sVendorId  )  [protected]

Builds vendor select SQL statement

Parameters:
string $sVendorId Vendor ID
Returns:
string

Definition at line 1223 of file oxarticlelist.php.

oxArticleList._sortByOrderMapCallback ( key1,
key2 
) [protected]

callback function only used from sortByIds

Parameters:
string $key1 1st key
string $key2 2nd key
See also:
oxArticleList.sortByIds
Returns:
int

Definition at line 160 of file oxarticlelist.php.

oxArticleList.enableSelectLists (  ) 

Call enableSelectLists() for loading select lists in lst articles

Returns:
null

Definition at line 46 of file oxarticlelist.php.

oxArticleList.getHistoryArticles (  ) 

Get history article id's from session or cookie.

Returns:
array

Definition at line 73 of file oxarticlelist.php.

oxArticleList.getTagArticleIds ( sTag,
iLang 
)

Returns array of article ids belonging to current tags

Parameters:
string $sTag current tag
int $iLang active language
Returns:
array

Definition at line 725 of file oxarticlelist.php.

oxArticleList.loadActionArticles ( sActionID,
iLimit = null 
)

Loads shop AktionArticles.

Parameters:
string $sActionID Action id
int $iLimit Select limit
Returns:
null

Definition at line 278 of file oxarticlelist.php.

oxArticleList.loadAktionArticles ( sActionID,
iLimit = null 
)

Loads shop AktionArticles.

Parameters:
string $sActionID Action id
int $iLimit Select limit
Deprecated:
since v5.0.1 (2012-11-15); use oxArticleList.loadActionArticles()
Returns:
null

Definition at line 320 of file oxarticlelist.php.

oxArticleList.loadArticleAccessoires ( sArticleId  ) 

Loads article accessories

Parameters:
string $sArticleId Article id
Returns:
null

Definition at line 385 of file oxarticlelist.php.

oxArticleList.loadArticleCrossSell ( sArticleId  ) 

Loads article cross selling

Parameters:
string $sArticleId Article id
Returns:
null

Definition at line 333 of file oxarticlelist.php.

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,...))
int $iLimit Limit
Returns:
integer total Count of Articles in this Category

Definition at line 433 of file oxarticlelist.php.

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

Definition at line 416 of file oxarticlelist.php.

oxArticleList.loadHistoryArticles ( sArtId,
iCnt = 4 
)

Loads up to 4 history (normally recently seen) articles from session, and adds $sArtId to history. Returns article id array.

Parameters:
string $sArtId Article ID
int $iCnt product count
Returns:
array

Definition at line 113 of file oxarticlelist.php.

oxArticleList.loadIds ( aIds  ) 

Load the list by article ids

Parameters:
array $aIds Article ID array
Returns:
null;

Definition at line 763 of file oxarticlelist.php.

oxArticleList.loadManufacturerArticles ( sManufacturerId,
oManufacturer = null 
)

Loads articles that belongs to Manufacturer, passed by parameter $sManufacturerId. Returns count of selected articles.

Parameters:
string $sManufacturerId Manufacturer ID
object $oManufacturer Active Manufacturer object
Returns:
integer

Definition at line 667 of file oxarticlelist.php.

oxArticleList.loadManufacturerIDs ( sManufacturerId  ) 

Loads Products for specified Manufacturer

Parameters:
string $sManufacturerId Manufacturer id
Returns:
null;

Definition at line 635 of file oxarticlelist.php.

oxArticleList.loadNewestArticles ( iLimit = null  ) 

Loads newest shops articles from DB.

Parameters:
int $iLimit Select limit
Returns:
null;

Definition at line 192 of file oxarticlelist.php.

oxArticleList.loadOrderArticles ( aOrders  ) 

Loads the article list by orders ids

Parameters:
array $aOrders user orders array
Returns:
null;

Definition at line 792 of file oxarticlelist.php.

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

Definition at line 600 of file oxarticlelist.php.

oxArticleList.loadPriceIds ( dPriceFrom,
dPriceTo 
)

Loads Id list of appropriate price products

Parameters:
float $dPriceFrom Starting price
float $dPriceTo Max price
Returns:
null;

Definition at line 584 of file oxarticlelist.php.

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

Definition at line 482 of file oxarticlelist.php.

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

Definition at line 468 of file oxarticlelist.php.

oxArticleList.loadSearchIds ( sSearchStr = '',
sSearchCat = '',
sSearchVendor = '',
sSearchManufacturer = '' 
)

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
string $sSearchManufacturer Search within manufacturer
Returns:
null;

Definition at line 523 of file oxarticlelist.php.

oxArticleList.loadStockRemindProducts ( aBasketContents  ) 

Loads list of low stock state products

Parameters:
array $aBasketContents product ids array
Returns:
null

Definition at line 834 of file oxarticlelist.php.

oxArticleList.loadTagArticles ( sTag,
iLang 
)

Loads a list of articles having

Parameters:
string $sTag Searched tag
int $iLang Active language
Returns:
int

Definition at line 683 of file oxarticlelist.php.

oxArticleList.loadTop5Articles ( iLimit = null  ) 

Load top 5 articles

Parameters:
int $iLimit Select limit
Returns:
null

Definition at line 237 of file oxarticlelist.php.

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

Definition at line 650 of file oxarticlelist.php.

oxArticleList.loadVendorIDs ( sVendorId  ) 

Loads Products for specified vendor

Parameters:
string $sVendorId Vendor id
Returns:
null;

Definition at line 622 of file oxarticlelist.php.

oxArticleList.renewPriceUpdateTime (  ) 

Calculates, updates and returns next price renew time

Returns:
int

Definition at line 866 of file oxarticlelist.php.

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.

Definition at line 59 of file oxarticlelist.php.

oxArticleList.setCustomSorting ( sSorting  ) 

Set Custom Sorting, simply an order by....

Parameters:
string $sSorting Custom sorting
Returns:
null

Definition at line 36 of file oxarticlelist.php.

oxArticleList.setHistoryArticles ( aArticlesIds  ) 

Set history article id's to session or cookie

Parameters:
array $aArticlesIds array history article ids
Returns:
null

Definition at line 93 of file oxarticlelist.php.

oxArticleList.sortByIds ( aIds  ) 

sort this list by given order.

Parameters:
array $aIds ordered ids
Returns:
null

Definition at line 144 of file oxarticlelist.php.

oxArticleList.updateUpcomingPrices ( blForceUpdate = false  ) 

Updates prices where new price > 0, update time != '0000-00-00 00:00:00' and <= CURRENT_TIMESTAMP. Returns update execution state (result of oxDb.execute())

Parameters:
bool $blForceUpdate if true, forces price update without timeout check, default value is FALSE
Returns:
mixed

Definition at line 897 of file oxarticlelist.php.


Member Data Documentation

oxArticleList.$_blLoadSelectLists = false [protected]

Definition at line 27 of file oxarticlelist.php.

oxArticleList.$_sCustomSorting [protected]

Definition at line 13 of file oxarticlelist.php.

oxArticleList.$_sObjectsInListName = 'oxarticle' [protected]

Reimplemented from oxList.

Definition at line 20 of file oxarticlelist.php.


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