oxArticle Class Reference

Inheritance diagram for oxArticle:

Inheritance graph
[legend]
Collaboration diagram for oxArticle:

Collaboration graph
[legend]

List of all members.

Detailed Description

Article manager. Creates fully detailed article object, with such information as VAT, discounts, etc.

Definition at line 16 of file oxarticle.php.


Public Member Functions

 __construct ($aParams=null)
 __isset ($sName)
 __get ($sName)
 setId ($sId=null)
 getTableNameForActiveSnippet ($blForceCoreTable=false)
 getActiveCheckQuery ($blForceCoreTable=false)
 getStockCheckQuery ($blForceCoreTable=false)
 getVariantsQuery ($blRemoveNotOrderables, $blForceCoreTable=false)
 getSqlActiveSnippet ($blForceCoreTable=false)
 setSkipAssign ($blSkipAssign)
 disablePriceLoad ($oArticle)
 getItemKey ()
 setItemKey ($sItemKey)
 setNoVariantLoading ($blLoadVariants)
 isBuyable ()
 getPersParams ()
 isOnComparisonList ()
 setOnComparisonList ($blOnList)
 setLoadParentData ($blLoadParentData)
 setSkipAbPrice ($blSkipAbPrice=null)
 getSearchableFields ()
 isMultilingualField ($sFieldName)
 isVisible ()
 assign ($aRecord)
 load ($oxID)
 addToRatingAverage ($iRating)
 getArticleRatingAverage ()
 getReviews ()
 getCrossSelling ()
 getAccessoires ()
 getSimilarProducts ()
 getCustomerAlsoBoughtThisProducts ()
 loadAmountPriceInfo ()
 getSelectLists ($sKeyPrefix=null)
 hasMdVariants ()
 getVariants ($blRemoveNotOrderables=true, $blForceCoreTable=false)
 getSimpleVariants ()
 getAdminVariants ($sLanguage=null)
 getCategory ()
 getCategoryIds ($blActCats=false, $blSkipCache=false)
 getVendor ($blShopCheck=true)
 getVendorId ($blForceReload=false)
 getManufacturerId ($blForceReload=false)
 getManufacturer ($blShopCheck=true)
 inCategory ($sCatNid)
 isAssignedToCategory ($sCatId)
 getTPrice ()
 skipDiscounts ()
 setPrice (oxPrice $oPrice)
 getBasePrice ($dAmount=1)
 getPrice ()
 setArticleUser ($oUser)
 getArticleUser ()
 getBasketPrice ($dAmount, $aSelList, $oBasket)
 applyBasketDiscounts (oxPrice $oPrice, $aDiscounts, $dAmount=1)
 delete ($sOXID=null)
 updateSoldAmount ($dAmount=0)
 disableReminder ()
 save ()
 getPictureGallery ()
 onChange ($sAction=null, $sOXID=null, $sParentID=null)
 getCustomVAT ()
 checkForStock ($dAmount)
 getArticleLongDesc ($sOXID=null)
 setArticleLongDesc ()
 getAttributes ()
 appendLink ($sAddParams)
 getLink ($iLang=null)
 setLinkType ($iType)
 getLinkType ()
 getStdLink ($iLang=null, $aParams=array())
 getMainLink ($iLang=null)
 getStdTagLink ($sTag)
 getTags ()
 saveTags ($sTags)
 addTag ($sTag)
 getMediaUrls ()
 getDynImageDir ()
 getDispSelList ()
 getMoreDetailLink ()
 getToBasketLink ()
 getStockStatus ()
 getDeliveryDate ()
 getFTPrice ()
 getFPrice ()
 getPricePerUnit ()
 isParentNotBuyable ()
 isNotBuyable ()
 setBuyableState ($blBuyable=false)
 getVariantList ()
 setSelectlist ($aSelList)
 getPictureUrl ($iIndex)
 getIconUrl ($iIndex= '')
 getThumbnailUrl ()
 getZoomPictureUrl ($iIndex)
 getFileUrl ()
 getPriceFromPrefix ()
 getArticleVat ()
 applyVats (oxPrice $oPrice)
 applyDiscountsForVariant ($oPrice)
 getParentArticle ()
 getProductId ()
 getProductParentId ()
 isOrderArticle ()
 isVariant ()
 isMdVariant ()
 getSqlForPriceCategories ($sFields= '')
 inPriceCategory ($sCatNid)
 getMdVariants ()
 getMdSubvariants ()

Protected Member Functions

 _hasAnyVariant ($blForceCoreTable=false)
 _getSelectCatIds ($sOXID, $blActCats=false)
 _calculatePrice ($oPrice)
 _setLongDesc ($sDbValue)
 _saveArtLongDesc ($iLang, $sValue)
 _skipSaveFields ()
 _mergeDiscounts ($aDiscounts, $aItemDiscounts)
 _getGroupPrice ()
 _getAmountPrice ($dAmount=1)
 _modifySelectListPrice (&$dPrice, $aChosenList=null)
 _fillAmountPriceList ($oAmPriceList)
 _getVariantsIds ()
 _applyVAT (oxPrice $oPrice, $dVat)
 _applyDiscounts ($oPrice, $aDiscounts)
 _applyCurrency (oxPrice $oPrice, $oCur=null)
 _getIcon ()
 _getAttribsString (&$sAttribs, &$iCnt)
 _getSimList ($sAttribs, $iCnt)
 _generateSimListSearchStr ($sArticleTable, $aList)
 _generateSearchStr ($sOXID, $blSearchPriceCat=false)
 _generateSearchStrForCustomerBought ()
 _generateSelectCatStr ($sOXID, $sCatId, $dPriceFromTo=false)
 _getAmountPriceList ()
 _isFieldEmpty ($sFieldName)
 _assignParentFieldValue ($sFieldName)
 _getParentAricle ()
 _assignParentFieldValues ()
 _assignNotBuyableParent ()
 _assignPictureValues ()
 _assignStock ()
 _assignPrices ()
 _assignPersistentParam ()
 _assignDynImageDir ()
 _assignComparisonListFlag ()
 _assignAttributes ()
 _insert ()
 _update ()
 _deleteRecords ($sOXID)
 _deleteVariantRecords ($sOXID)
 _resetCacheAndArticleCount ($sOxid)
 _deletePics ()
 _onChangeResetCounts ($sOxid, $sVendorId=null, $sManufacturerId=null)
 _onChangeUpdateStock ($sParentID)
 _onChangeUpdateVarCount ($sParentID)
 _onChangeUpdateMinVarPrice ($sParentID)
 _applyRangePrice ()

Protected Attributes

 $_sCoreTbl = 'oxarticles'
 $_sClassName = 'oxarticle'
 $_blUseLazyLoading = true
 $_sItemKey
 $_blCalcPrice = true
 $_oPrice = null
 $_dArticleVat = null
 $_aPersistParam = null
 $_blNotBuyable = false
 $_blLoadVariants = true
 $_aVariants = null
 $_aVariantsWithNotOrderables = null
 $_blNotBuyableParent = false
 $_blHasVariants = false
 $_blHasMdVariants = false
 $_iVarStock = 0
 $_oVariantList = array()
 $_blIsOnComparisonList = false
 $_oUser = null
 $_blLoadPrice = true
 $_blSkipAbPrice = false
 $_fPricePerUnit = null
 $_blLoadParentData = false
 $_blSkipAssign = false
 $_blSkipDiscounts = null
 $_oAttributeList = null
 $_blIsRangePrice = false
 $_aMediaUrls = null
 $_aDispSelList
 $_blIsSeoObject = true
 $_oAmountPriceList = null
 $_iLinkType = 0
 $_sStdLink = null
 $_sDynImageDir = null
 $_sMoreDetailLink = null
 $_sToBasketLink = null
 $_iStockStatus = null
 $_oTPrice = null
 $_oAmountPriceInfo = null
 $_dAmountPrice = null
 $_sDetailLink = null
 $_aNonCopyParentFields
 $_aCopyParentField
 $_oMdVariants = null

Static Protected Attributes

static $_aLoadedParents
static $_aSelList
static $_aArticleManufacturers = array()
static $_aArticleVendors = array()
static $_aArticleCats = array()

Constructor & Destructor Documentation

oxArticle.__construct ( $  aParams = null  ) 

Class constructor, sets shop ID for article (oxconfig.getShopId()), initiates parent constructor (parent.oxI18n()).

Parameters:
array $aParams The array of names and values of oxArticle instance properties to be set on object instantiation
Returns:
null

Definition at line 368 of file oxarticle.php.

Member Function Documentation

oxArticle.__isset ( $  sName  ) 

Magic isset, deals with article long description

Parameters:
string $sName Variable name
Returns:
string

Reimplemented from oxBase.

Definition at line 388 of file oxarticle.php.

oxArticle.__get ( $  sName  ) 

Magic getter, deals with deprecated values and long description which is loaded on demand. Additionally it sets default value for unknown picture fields

Parameters:
string $sName Variable name
Returns:
mixed

Reimplemented from oxBase.

Definition at line 406 of file oxarticle.php.

oxArticle.setId ( $  sId = null  ) 

Sets object ID, additionally sets $this->oxarticles__oxnid field value

Parameters:
string $sId New ID
Returns:
null

Reimplemented from oxBase.

Definition at line 534 of file oxarticle.php.

oxArticle.getTableNameForActiveSnippet ( $  blForceCoreTable = false  ) 

Returns name of table used when building active snippet query

Parameters:
bool $blForceCoreTable force core table usage
Returns:
string

Definition at line 551 of file oxarticle.php.

oxArticle.getActiveCheckQuery ( $  blForceCoreTable = false  ) 

Returns part of sql query used in active snippet. Query checks if product "oxactive = 1". If config option "blUseTimeCheck" is TRUE additionally checks if "oxactivefrom < current data < oxactiveto"

Parameters:
bool $blForceCoreTable force core table usage
Returns:
string

Definition at line 567 of file oxarticle.php.

oxArticle.getStockCheckQuery ( $  blForceCoreTable = false  ) 

Returns part of sql query used in active snippet. If config option "blUseStock" is TRUE checks if "oxstockflag != 2 or ( oxstock + oxvarstock ) > 0". If config option "blVariantParentBuyable" is TRUE checks if product has variants, and if has - checks is there at least one variant which is buyable. If config option option "blUseTimeCheck" is TRUE additionally checks if variants "oxactivefrom < current data < oxactiveto"

Parameters:
bool $blForceCoreTable force core table usage
Returns:
string

Definition at line 596 of file oxarticle.php.

oxArticle.getVariantsQuery ( $  blRemoveNotOrderables,
$  blForceCoreTable = false 
)

Returns part of query which checks if product is variant of current object. Additionally if config option "blUseStock" is TRUE checks stock state "( oxstock > 0 or ( oxstock <= 0 and ( oxstockflag = 1 or oxstockflag = 4 ) )"

Parameters:
bool $blRemoveNotOrderables remove or leave non orderable products
bool $blForceCoreTable force core table usage
Returns:
string

Definition at line 631 of file oxarticle.php.

oxArticle.getSqlActiveSnippet ( $  blForceCoreTable = false  ) 

Returns SQL select string with checks if items are available

Parameters:
bool $blForceCoreTable forces core table usage (optional)
Returns:
string

Reimplemented from oxI18n.

Definition at line 651 of file oxarticle.php.

oxArticle.setSkipAssign ( $  blSkipAssign  ) 

Assign condition setter. In case article assignment is skipped ($_blSkipAssign = true), it does not perform additional

Parameters:
bool $blSkipAssign Whether to skip assign process for the article
Returns:
null

Definition at line 672 of file oxarticle.php.

oxArticle.disablePriceLoad ( $  oArticle  ) 

Disables article price loading. Should be called before assign(), or load()

Parameters:
objetc $oArticle article object
Returns:
null

Definition at line 684 of file oxarticle.php.

oxArticle.getItemKey (  ) 

Returns item key used with oxuserbasket

Returns:
string

Definition at line 694 of file oxarticle.php.

oxArticle.setItemKey ( $  sItemKey  ) 

Sets item key used with oxuserbasket

Parameters:
string $sItemKey Item key
Returns:
null

Definition at line 706 of file oxarticle.php.

oxArticle.setNoVariantLoading ( $  blLoadVariants  ) 

Disables/enables variant loading

Parameters:
bool $blLoadVariants skip variant loading or not
Returns:
null

Definition at line 718 of file oxarticle.php.

oxArticle.isBuyable (  ) 

Checks if article is buyable.

Returns:
bool

Definition at line 728 of file oxarticle.php.

oxArticle.getPersParams (  ) 

Get persistent parameters

Returns:
array

Definition at line 742 of file oxarticle.php.

oxArticle.isOnComparisonList (  ) 

Checks whether article is inluded in comparison list

Returns:
bool

Definition at line 752 of file oxarticle.php.

oxArticle.setOnComparisonList ( $  blOnList  ) 

Set if article is inluded in comparison list

Parameters:
bool $blOnList Whether is article on the list
Returns:
null

Definition at line 764 of file oxarticle.php.

oxArticle.setLoadParentData ( $  blLoadParentData  ) 

A setter for $_blLoadParentData (whether article parent info should be laoded fully) class variable

Parameters:
bool $blLoadParentData Whether to load parent data
Returns:
null

Definition at line 776 of file oxarticle.php.

oxArticle.setSkipAbPrice ( $  blSkipAbPrice = null  ) 

Set _blSkipAbPrice value. If is set to true, then "From price" is not calculated for this object.

Parameters:
bool $blSkipAbPrice Whether to skip "From" price loading
Returns:
null

Definition at line 788 of file oxarticle.php.

oxArticle.getSearchableFields (  ) 

Returns an array of article object DB fields, without multilanguage.

Returns:
array

Definition at line 798 of file oxarticle.php.

oxArticle.isMultilingualField ( $  sFieldName  ) 

Returns true if the field is multilanguage

Parameters:
string $sFieldName Field name
Returns:
bool

Reimplemented from oxI18n.

Definition at line 814 of file oxarticle.php.

oxArticle.isVisible (  ) 

Checks if article has visible status. Returns TRUE if its visible

Returns:
bool

Definition at line 830 of file oxarticle.php.

oxArticle.assign ( $  aRecord  ) 

Assigns to oxarticle object some base parameters/values (such as detaillink, moredetaillink, etc).

Parameters:
string $aRecord Array representing current field values
Returns:
null

Reimplemented from oxI18n.

Definition at line 872 of file oxarticle.php.

oxArticle.load ( $  oxID  ) 

Loads object data from DB (object data ID must be passed to method). Converts dates (oxarticle.oxarticles__oxinsert, oxarticle.oxarticles__oxtimestamp) to international format (oxutils.php oxUtilsDate.getInstance()->formatDBDate(...)). Returns true if article was loaded successfully.

Parameters:
string $oxID Article object ID
Returns:
bool

Reimplemented from oxBase.

Definition at line 915 of file oxarticle.php.

oxArticle.addToRatingAverage ( $  iRating  ) 

Calculates and saves product rating average

Parameters:
integer $iRating new rating value
Returns:
null

Definition at line 936 of file oxarticle.php.

oxArticle.getArticleRatingAverage (  ) 

Returns product rating average

Returns:
double

Definition at line 953 of file oxarticle.php.

oxArticle.getReviews (  ) 

Collects user written reviews about an article.

Returns:
oxList

Definition at line 963 of file oxarticle.php.

oxArticle.getCrossSelling (  ) 

Loads and returns array with crosselling information.

Returns:
array

Definition at line 997 of file oxarticle.php.

oxArticle.getAccessoires (  ) 

Loads and returns array with accessoires information.

Returns:
array

Definition at line 1011 of file oxarticle.php.

oxArticle.getSimilarProducts (  ) 

Returns a list of similar products.

Returns:
array

Definition at line 1034 of file oxarticle.php.

oxArticle.getCustomerAlsoBoughtThisProducts (  ) 

Loads and returns articles list, bought by same customer.

Returns:
array

Definition at line 1077 of file oxarticle.php.

oxArticle.loadAmountPriceInfo (  ) 

Returns list object with info about article price that depends on amount in basket. Takes data from oxprice2article table. Returns false if such info is not set.

Returns:
mixed

Definition at line 1102 of file oxarticle.php.

oxArticle.getSelectLists ( $  sKeyPrefix = null  ) 

Returns all selectlists this article has.

Parameters:
string $sKeyPrefix Optionall key prefix
Returns:
array

Implements oxIArticle.

Definition at line 1130 of file oxarticle.php.

oxArticle._hasAnyVariant ( $  blForceCoreTable = false  )  [protected]

Checks if parent has ANY variant assigned

Parameters:
bool $blForceCoreTable force core table usage
Returns:
bool

Definition at line 1187 of file oxarticle.php.

oxArticle.hasMdVariants (  ) 

Checks if article has multidimensional variants

Returns:
bool

Definition at line 1198 of file oxarticle.php.

oxArticle.getVariants ( $  blRemoveNotOrderables = true,
$  blForceCoreTable = false 
)

Collects and returns article variants.

Parameters:
bool $blRemoveNotOrderables if true, removes from list not orderable articles, which are out of stock
Returns:
array

Definition at line 1210 of file oxarticle.php.

oxArticle.getSimpleVariants (  ) 

Simple way to get variants without quering oxarticle table first. This is basically used for lists.

Returns:
null

Definition at line 1286 of file oxarticle.php.

oxArticle.getAdminVariants ( $  sLanguage = null  ) 

Loads article variants and returns variants list object. Article language may be set by passing with parameter, or GET/POST/Session variable.

Parameters:
string $sLanguage shop language.
Returns:
object

Definition at line 1301 of file oxarticle.php.

oxArticle.getCategory (  ) 

Loads and returns article category object. First tries to load assigned category and is such category does not exist, tries to load category by price

Returns:
oxcategory

Definition at line 1333 of file oxarticle.php.

oxArticle.getCategoryIds ( $  blActCats = false,
$  blSkipCache = false 
)

Returns ID's of categories where this article is assigned

Parameters:
bool $blActCats select categories if all parents are active
bool $blSkipCache Whether to skip cache
Returns:
array

Implements oxIArticle.

Definition at line 1375 of file oxarticle.php.

oxArticle._getSelectCatIds ( $  sOXID,
$  blActCats = false 
) [protected]

Returns query for article categories select

Parameters:
string $sOXID article id
bool $blActCats select categories if all parents are active
Returns:
string

Definition at line 1414 of file oxarticle.php.

oxArticle.getVendor ( $  blShopCheck = true  ) 

Returns current article vendor object. If $blShopCheck = false, then vendor loading will fallback to oxI18n object and blReadOnly parameter will be set to true if vendor is not assigned to current shop

Parameters:
bool $blShopCheck Set false if shop check is not required (default is true)
Returns:
object

Definition at line 1436 of file oxarticle.php.

oxArticle.getVendorId ( $  blForceReload = false  ) 

Returns article object vendor ID. Result is cached into self::$_aArticleVendors

Parameters:
bool $blForceReload reloads id even if it is cached
Returns:
string

Definition at line 1462 of file oxarticle.php.

oxArticle.getManufacturerId ( $  blForceReload = false  ) 

Returns article object Manufacturer ID. Result is cached into self::$_aArticleManufacturers

Parameters:
bool $blForceReload reloads id even if it is cached
Returns:
string

Definition at line 1484 of file oxarticle.php.

oxArticle.getManufacturer ( $  blShopCheck = true  ) 

Returns current article Manufacturer object. If $blShopCheck = false, then Manufacturer blReadOnly parameter will be set to true. If Manufacturer is not assigned to current shop

Parameters:
bool $blShopCheck Set false if shop check is not required (default is true)
Returns:
object

Definition at line 1507 of file oxarticle.php.

oxArticle.inCategory ( $  sCatNid  ) 

Checks if article is assigned to category $sCatNID.

Parameters:
string $sCatNid category ID
Returns:
bool

Definition at line 1535 of file oxarticle.php.

oxArticle.isAssignedToCategory ( $  sCatId  ) 

Checks if article is assigned to passed category (even checks if this category is "price category"). Returns true on success.

Parameters:
string $sCatId category ID
Returns:
bool

Definition at line 1548 of file oxarticle.php.

oxArticle.getTPrice (  ) 

Returns T price

Returns:
oxPrice

Definition at line 1584 of file oxarticle.php.

oxArticle.skipDiscounts (  ) 

Checks if discount should be skipped for this article in basket. Returns true if yes.

Returns:
bool

Implements oxIArticle.

Definition at line 1608 of file oxarticle.php.

oxArticle.setPrice ( oxPrice $  oPrice  ) 

Sets the current oxPrice object

Parameters:
oxPrice $oPrice the new price object
Returns:
null

Definition at line 1631 of file oxarticle.php.

oxArticle.getBasePrice ( $  dAmount = 1  ) 

Returns base article price from database. Price may differ according to users group Override this function if you want e.g. different prices for diff. usergroups.

Parameters:
double $dAmount article amount. Default is 1
Returns:
double

Implements oxIArticle.

Definition at line 1644 of file oxarticle.php.

oxArticle.getPrice (  ) 

Calculates and returns price of article (adds taxes and discounts).

Returns:
oxPrice

Implements oxIArticle.

Definition at line 1666 of file oxarticle.php.

oxArticle._calculatePrice ( $  oPrice  )  [protected]

Calculates price of article (adds taxes, currency and discounts).

Parameters:
oxPrice $oPrice price object
Returns:
oxPrice

Definition at line 1700 of file oxarticle.php.

oxArticle.setArticleUser ( $  oUser  ) 

sets article user

Parameters:
oxUser $oUser user to set
Returns:
null

Definition at line 1725 of file oxarticle.php.

oxArticle.getArticleUser (  ) 

return article user

Returns:
oxUser

Definition at line 1735 of file oxarticle.php.

oxArticle.getBasketPrice ( $  dAmount,
$  aSelList,
$  oBasket 
)

Creates, calculates and returns oxprice object for basket product.

Parameters:
double $dAmount Amount
string $aSelList Selection list
object $oBasket User shopping basket object
Returns:
oxPrice

Implements oxIArticle.

Definition at line 1752 of file oxarticle.php.

oxArticle.applyBasketDiscounts ( oxPrice $  oPrice,
$  aDiscounts,
$  dAmount = 1 
)

Applies discoutns which are supposed to be applied on amounts greater than zero. Returns applied discounts.

Parameters:
oxPrice $oPrice Old article price
array $aDiscounts Discount array
amount $dAmount Amount in basket
Deprecated:
use oxDiscountList.applyBasketDiscounts() instead
Returns:
array

Definition at line 1797 of file oxarticle.php.

oxArticle.delete ( $  sOXID = null  ) 

Deletes record and other information related to this article such as images from DB, also removes variants. Returns true on success.

Parameters:
string $sOXID Article id
Returns:
bool

Reimplemented from oxBase.

Definition at line 1811 of file oxarticle.php.

oxArticle.updateSoldAmount ( $  dAmount = 0  ) 

Recursive function. Updates quantity of sold articles. Return true on success

Parameters:
double $dAmount Number of articles sold
Returns:
bool

Definition at line 1842 of file oxarticle.php.

oxArticle.disableReminder (  ) 

Disables reminder functionality for article

Returns:
bool

Definition at line 1872 of file oxarticle.php.

oxArticle.save (  ) 

Makes sure that image values (oxpic1 - oxpic12, oxthumb, oxicon) are only base name by striping any dir information and leave only original file name and finally save the object using parent.save() method.

Returns:
bool

Reimplemented from oxBase.

Definition at line 1884 of file oxarticle.php.

oxArticle.getPictureGallery (  ) 

collect article pics, icons, zoompic and puts it all in an array structure of array (ActPicID, ActPic, MorePics, Pics, Icons, ZoomPic)

Returns:
array

Definition at line 1920 of file oxarticle.php.

oxArticle.onChange ( $  sAction = null,
$  sOXID = null,
$  sParentID = null 
)

This function is triggered whenever article is saved or deleted or after the stock is changed. Originally we need to update the oxstock for possible article parent in case parent is not buyable Plus you may want to extend this function to update some extended information. Call oxArticle.onChange($sAction, $sOXID) with ID parameter as static method when changes are executed over SQL. (or use module class instead of oxArticle if such exists)

Parameters:
string $sAction Action constant
string $sOXID Article ID
string $sParentID Parent ID
Returns:
null

Definition at line 1998 of file oxarticle.php.

oxArticle.getCustomVAT (  ) 

Returns custom article VAT value if possible By default value is taken from oxarticle__oxvat field

Returns:
double

Definition at line 2048 of file oxarticle.php.

oxArticle.checkForStock ( $  dAmount  ) 

Checks if stock configuration allows to buy user chosen amount $dAmount

Parameters:
double $dAmount buyable amount
Returns:
mixed

Implements oxIArticle.

Definition at line 2062 of file oxarticle.php.

oxArticle.getArticleLongDesc ( $  sOXID = null  ) 

Get article long description

Parameters:
string $sOXID Article ID
Returns:
object $oField field object

Definition at line 2115 of file oxarticle.php.

oxArticle._setLongDesc ( $  sDbValue  )  [protected]

set given value to object's oxlongdesc - also prepare it (parse throug smarty)

Parameters:
string $sDbValue value to set
Returns:
null

Definition at line 2152 of file oxarticle.php.

oxArticle.setArticleLongDesc (  ) 

Save article long description to oxartext table

Returns:
null

Definition at line 2181 of file oxarticle.php.

oxArticle.getAttributes (  ) 

Loads and returns attribute list associated with this article

Returns:
object

Definition at line 2221 of file oxarticle.php.

oxArticle.appendLink ( $  sAddParams  ) 

Appends current article link with additional request parameters

Parameters:
string $sAddParams additional parameters which needs to be added to product url
Returns:
null

Definition at line 2244 of file oxarticle.php.

oxArticle.getLink ( $  iLang = null  ) 

Gets article link

Parameters:
int $iLang required language. optional
Returns:
string

Implements oxIUrl.

Definition at line 2259 of file oxarticle.php.

oxArticle.setLinkType ( $  iType  ) 

Resets details link

Parameters:
int $iType type of link to load
Returns:
null

Definition at line 2292 of file oxarticle.php.

oxArticle.getLinkType (  ) 

Get link type

Returns:
int

Definition at line 2306 of file oxarticle.php.

oxArticle.getStdLink ( $  iLang = null,
$  aParams = array() 
)

Returns standard URL to product

Parameters:
int $iLang required language. optional
array $aParams additional params to use [optional]
Returns:
string

Implements oxIUrl.

Definition at line 2320 of file oxarticle.php.

oxArticle.getMainLink ( $  iLang = null  ) 

Returns main object URL. If SEO is ON returned link will be in SEO form, else URL will have dynamic form

Parameters:
int $iLang language id [optional]
Returns:
string

Definition at line 2379 of file oxarticle.php.

oxArticle.getStdTagLink ( $  sTag  ) 

Returns standard product Tag URL

Parameters:
string $sTag tag
Returns:
string

Definition at line 2401 of file oxarticle.php.

oxArticle.getTags (  ) 

Returns article tags

Returns:
string;

Definition at line 2412 of file oxarticle.php.

oxArticle.saveTags ( $  sTags  ) 

Saves article tags

Parameters:
string $sTags article tag
Returns:
bool

Definition at line 2429 of file oxarticle.php.

oxArticle.addTag ( $  sTag  ) 

Adds tag

Parameters:
string $sTag new tag
Returns:
bool

Definition at line 2448 of file oxarticle.php.

oxArticle.getMediaUrls (  ) 

Return article media URL

Returns:
unknown

Definition at line 2468 of file oxarticle.php.

oxArticle.getDynImageDir (  ) 

Get image url

Returns:
array

Definition at line 2489 of file oxarticle.php.

oxArticle.getDispSelList (  ) 

Returns select lists to display

Returns:
array

Definition at line 2499 of file oxarticle.php.

oxArticle.getMoreDetailLink (  ) 

Get more details link

Returns:
string

Definition at line 2514 of file oxarticle.php.

oxArticle.getToBasketLink (  ) 

Get to basket link

Returns:
string

Definition at line 2537 of file oxarticle.php.

oxArticle.getStockStatus (  ) 

Get stock status

Returns:
integer

Definition at line 2578 of file oxarticle.php.

oxArticle.getDeliveryDate (  ) 

Returns formated delivery date. If the date is not set ('0000-00-00') returns false.

Returns:
string | bool

Definition at line 2588 of file oxarticle.php.

oxArticle.getFTPrice (  ) 

Returns rounded T price.

Returns:
double | bool

Definition at line 2602 of file oxarticle.php.

oxArticle.getFPrice (  ) 

Returns formated product's price.

Returns:
double

Definition at line 2618 of file oxarticle.php.

oxArticle.getPricePerUnit (  ) 

Returns formated price per unit (oxarticle._assignPrices())

Returns:
string

Definition at line 2632 of file oxarticle.php.

oxArticle.isParentNotBuyable (  ) 

Returns true if parent is not buyable

Returns:
bool

Definition at line 2642 of file oxarticle.php.

oxArticle.isNotBuyable (  ) 

Returns true if article is not buyable

Returns:
bool

Definition at line 2652 of file oxarticle.php.

oxArticle.setBuyableState ( $  blBuyable = false  ) 

Sets product state - buyable or not

Parameters:
bool $blBuyable state - buyable or not (default false)
Returns:
null

Definition at line 2664 of file oxarticle.php.

oxArticle.getVariantList (  ) 

Returns variant lists of current product

Returns:
object

Definition at line 2674 of file oxarticle.php.

oxArticle.setSelectlist ( $  aSelList  ) 

Sets selectlists of current product

Parameters:
array $aSelList selectlist
Returns:
object

Definition at line 2686 of file oxarticle.php.

oxArticle.getPictureUrl ( $  iIndex  ) 

Returns article picture

Parameters:
int $iIndex picture index
Returns:
string

Definition at line 2698 of file oxarticle.php.

oxArticle.getIconUrl ( $  iIndex = ''  ) 

Returns article icon picture url

Parameters:
int $iIndex picture index
Returns:
string

Definition at line 2710 of file oxarticle.php.

oxArticle.getThumbnailUrl (  ) 

Returns article thumbnail picture url

Returns:
string

Definition at line 2731 of file oxarticle.php.

oxArticle.getZoomPictureUrl ( $  iIndex  ) 

Returns article zoom picture url

Parameters:
int $iIndex picture index
Returns:
string

Definition at line 2744 of file oxarticle.php.

oxArticle.getFileUrl (  ) 

Returns article file url

Returns:
string

Definition at line 2754 of file oxarticle.php.

oxArticle.getPriceFromPrefix (  ) 

Returns string prefix (like "ab") if needed or empty string.

Returns:
string

Definition at line 2764 of file oxarticle.php.

oxArticle._saveArtLongDesc ( $  iLang,
$  sValue 
) [protected]

inserts article long description to artextends table

Parameters:
int $iLang language
string $sValue long description
Returns:
null

Definition at line 2782 of file oxarticle.php.

oxArticle._skipSaveFields (  )  [protected]

Removes object data fields (oxarticles__oxtimestamp, oxarticles__oxparentid, oxarticles__oxinsert).

Returns:
null

Definition at line 2801 of file oxarticle.php.

oxArticle._mergeDiscounts ( $  aDiscounts,
$  aItemDiscounts 
) [protected]

Merges two discount arrays. If there are two the same discounts, discount values will be added.

Parameters:
array $aDiscounts Discount array
array $aItemDiscounts Discount array
Returns:
array $aDiscounts

Definition at line 2826 of file oxarticle.php.

oxArticle._getGroupPrice (  )  [protected]

get user Group A, B or C price, returns db price if user is not in groups

Returns:
double

Definition at line 2844 of file oxarticle.php.

oxArticle._getAmountPrice ( $  dAmount = 1  )  [protected]

Modifies article price depending on given amount. Takes data from oxprice2article table.

Parameters:
double $dAmount Basket amount
Returns:
bool | null

Definition at line 2875 of file oxarticle.php.

oxArticle._modifySelectListPrice ( &$  dPrice,
$  aChosenList = null 
) [protected]

Modifies article price according to selected select list value

Parameters:
double &$dPrice Modifyable price
array $aChosenList Selection list array
Returns:
double

Definition at line 2903 of file oxarticle.php.

oxArticle._fillAmountPriceList ( $  oAmPriceList  )  [protected]

Fills amount price list object and sets amount price for article object

Parameters:
object $oAmPriceList Amount (staffel) price list
Returns:
object

Definition at line 2932 of file oxarticle.php.

oxArticle._getVariantsIds (  )  [protected]

Collects and returns article variants ids.

Returns:
array

Definition at line 2991 of file oxarticle.php.

oxArticle.getArticleVat (  ) 

retrieve article VAT (cached)

Returns:
double

Definition at line 3009 of file oxarticle.php.

oxArticle._applyVAT ( oxPrice $  oPrice,
$  dVat 
) [protected]

Applies VAT to article

Parameters:
oxPrice $oPrice Price object
double $dVat VAT percent
Returns:
null

Definition at line 3025 of file oxarticle.php.

oxArticle.applyVats ( oxPrice $  oPrice  ) 

apply article and article use

Parameters:
oxPrice $oPrice target price
Returns:
null

Definition at line 3042 of file oxarticle.php.

oxArticle._applyDiscounts ( $  oPrice,
$  aDiscounts 
) [protected]

Applies discounts which should be applied in general case (for 0 amount)

Parameters:
oxprice $oPrice Price object
array $aDiscounts Discount list
Deprecated:
use oxDiscountList.applyDiscounts() instead
Returns:
null

Definition at line 3059 of file oxarticle.php.

oxArticle.applyDiscountsForVariant ( $  oPrice  ) 

Applies discounts which should be applied in general case (for 0 amount)

Parameters:
oxprice $oPrice Price object
Returns:
null

Definition at line 3072 of file oxarticle.php.

oxArticle._applyCurrency ( oxPrice $  oPrice,
$  oCur = null 
) [protected]

Applies currency factor

Parameters:
oxPrice $oPrice Price object
object $oCur Currency object
Returns:
null

Definition at line 3089 of file oxarticle.php.

oxArticle._getIcon (  )  [protected]

Returns path of icon file ("/0/".$this->oxarticles__oxicon->value) or if icon is not generated yet - tries to generate this file (if no GD lib available and oxarticles__oxthumb is not set as default icon sets "/0/nopic_ico.jpg")and updates DB article field "oxicon".

Returns:
string

Definition at line 3106 of file oxarticle.php.

oxArticle._getAttribsString ( &$  sAttribs,
&$  iCnt 
) [protected]

gets attribs string

Parameters:
string &$sAttribs Attribute selection snippet
int &$iCnt The number of selected attributes
Returns:
null;

Definition at line 3176 of file oxarticle.php.

oxArticle._getSimList ( $  sAttribs,
$  iCnt 
) [protected]

Gets similar list.

Parameters:
string $sAttribs Attribute selection snippet
int $iCnt Similar list article count
Returns:
array

Definition at line 3206 of file oxarticle.php.

oxArticle._generateSimListSearchStr ( $  sArticleTable,
$  aList 
) [protected]

Generates search string for similar list.

Parameters:
string $sArticleTable Article table name
array $aList A list of original articles
Returns:
string

Definition at line 3248 of file oxarticle.php.

oxArticle._generateSearchStr ( $  sOXID,
$  blSearchPriceCat = false 
) [protected]

Generates SearchString for getCategory()

Parameters:
string $sOXID Article ID
bool $blSearchPriceCat Whether to perform the search within price categories
Returns:
string

Definition at line 3286 of file oxarticle.php.

oxArticle._generateSearchStrForCustomerBought (  )  [protected]

Generates SQL select string for getCustomerAlsoBoughtThisProduct

Returns:
string

Definition at line 3309 of file oxarticle.php.

oxArticle._generateSelectCatStr ( $  sOXID,
$  sCatId,
$  dPriceFromTo = false 
) [protected]

Generates select string for isAssignedToCategory()

Parameters:
string $sOXID Article ID
string $sCatId Category ID
bool $dPriceFromTo Article price for price categories
Returns:
string

Definition at line 3369 of file oxarticle.php.

oxArticle._getAmountPriceList (  )  [protected]

Collecting assigned to article amount-price list

Returns:
oxList

Definition at line 3398 of file oxarticle.php.

oxArticle._isFieldEmpty ( $  sFieldName  )  [protected]

Detects if field is empty.

Parameters:
string $sFieldName Field name
Returns:
bool

Definition at line 3448 of file oxarticle.php.

oxArticle._assignParentFieldValue ( $  sFieldName  )  [protected]

Assigns parent field values to article

Parameters:
string $sFieldName field name
Returns:
null;

Definition at line 3492 of file oxarticle.php.

oxArticle.getParentArticle (  ) 

Get parent article

Returns:
oxArticle

Definition at line 3559 of file oxarticle.php.

oxArticle._getParentAricle (  )  [protected]

Get parent article

Deprecated:
since version 4.2
Returns:
oxArticle

Definition at line 3585 of file oxarticle.php.

oxArticle._assignParentFieldValues (  )  [protected]

Assigns parent field values to article

Returns:
null;

Definition at line 3595 of file oxarticle.php.

oxArticle._assignNotBuyableParent (  )  [protected]

if we have variants then depending on config option the parent may be non buyable

Returns:
null

Definition at line 3633 of file oxarticle.php.

oxArticle._assignPictureValues (  )  [protected]

Assigns picture values to article

Returns:
null

Definition at line 3647 of file oxarticle.php.

oxArticle._assignStock (  )  [protected]

Assigns stock status to article

Returns:
null

Definition at line 3710 of file oxarticle.php.

oxArticle._assignPrices (  )  [protected]

Assigns prices to article

Returns:
null

Definition at line 3775 of file oxarticle.php.

oxArticle._assignPersistentParam (  )  [protected]

assigns persistent param to article

Returns:
null;

Definition at line 3803 of file oxarticle.php.

oxArticle._assignDynImageDir (  )  [protected]

assigns dynimagedir to article

Returns:
null;

Definition at line 3817 of file oxarticle.php.

oxArticle._assignComparisonListFlag (  )  [protected]

Adds a flag if article is on comparisonlist.

Returns:
null;

Definition at line 3834 of file oxarticle.php.

oxArticle._assignAttributes (  )  [protected]

Assigns atttibutes to article

Returns:
null;

Definition at line 3849 of file oxarticle.php.

oxArticle._insert (  )  [protected]

Sets article creation date (oxarticle.oxarticles__oxinsert). Then executes parent method parent._insert() and returns insertion status.

Returns:
bool

Reimplemented from oxBase.

Definition at line 3866 of file oxarticle.php.

oxArticle._update (  )  [protected]

Executes oxarticle._skipSaveFields() and updates article information

Returns:
bool

Reimplemented from oxI18n.

Definition at line 3885 of file oxarticle.php.

oxArticle._deleteRecords ( $  sOXID  )  [protected]

Deletes records in database

Parameters:
string $sOXID Article ID
Returns:
int

Definition at line 3903 of file oxarticle.php.

oxArticle._deleteVariantRecords ( $  sOXID  )  [protected]

Deletes variant records

Parameters:
string $sOXID Article ID
Returns:
null

Definition at line 3959 of file oxarticle.php.

oxArticle._resetCacheAndArticleCount ( $  sOxid  )  [protected]

Resets cache and article count in vendor and category

Parameters:
string $sOxid reset article id
Deprecated:
since Jan 21, 2009
Returns:
null

Definition at line 3982 of file oxarticle.php.

oxArticle._deletePics (  )  [protected]

Delete pics

Returns:
null

Definition at line 3992 of file oxarticle.php.

oxArticle._onChangeResetCounts ( $  sOxid,
$  sVendorId = null,
$  sManufacturerId = null 
) [protected]

Resets category and vendor counts. This method is supposed to be called on article change triger.

Parameters:
string $sOxid object to reset id ID
string $sVendorId Vendor ID
string $sManufacturerId Manufacturer ID
Returns:
null

Definition at line 4035 of file oxarticle.php.

oxArticle._onChangeUpdateStock ( $  sParentID  )  [protected]

Updates article stock. This method is supposed to be called on article change triger.

Parameters:
string $sParentID product parent id
Returns:
null

Definition at line 4067 of file oxarticle.php.

oxArticle._onChangeUpdateVarCount ( $  sParentID  )  [protected]

Updates variant count. This method is supposed to be called on article change triger.

Parameters:
string $sParentID Parent ID
Returns:
null

Definition at line 4105 of file oxarticle.php.

oxArticle._onChangeUpdateMinVarPrice ( $  sParentID  )  [protected]

Updates variant min price. This method is supposed to be called on article change triger.

Parameters:
string $sParentID Parent ID
Returns:
null

Definition at line 4123 of file oxarticle.php.

oxArticle._applyRangePrice (  )  [protected]

Returns minimum brut price from all (already loaded) variants and if aplicable parent article

Returns:
null;

Definition at line 4149 of file oxarticle.php.

oxArticle.getProductId (  ) 

Returns product id (oxid) (required for interface oxIArticle)

Returns:
string

Implements oxIArticle.

Definition at line 4219 of file oxarticle.php.

oxArticle.getProductParentId (  ) 

Returns product parent id (oxparentid)

Returns:
string

Implements oxIArticle.

Definition at line 4229 of file oxarticle.php.

oxArticle.isOrderArticle (  ) 

Returns false if object is not derived from oxorderarticle class

Returns:
bool

Implements oxIArticle.

Definition at line 4239 of file oxarticle.php.

oxArticle.isVariant (  ) 

Returns TRUE if product is variant, and false if not

Returns:
bool

Definition at line 4249 of file oxarticle.php.

oxArticle.isMdVariant (  ) 

Returns TRUE if product is multidimensional variant, and false if not

Returns:
bool

Definition at line 4259 of file oxarticle.php.

oxArticle.getSqlForPriceCategories ( $  sFields = ''  ) 

get Sql for loading price categories which include this article

Parameters:
string $sFields fields to load from oxcategories
Returns:
string

Definition at line 4273 of file oxarticle.php.

oxArticle.inPriceCategory ( $  sCatNid  ) 

Checks if artickle is assigned to price category $sCatNID.

Parameters:
string $sCatNid Price category ID
Returns:
bool

Definition at line 4292 of file oxarticle.php.

oxArticle.getMdVariants (  ) 

Returns multidimensional variant structure

Returns:
OxMdVariants

Definition at line 4312 of file oxarticle.php.

oxArticle.getMdSubvariants (  ) 

Returns first level variants from multidimensional variants list

Returns:
OxMdVariants

Definition at line 4336 of file oxarticle.php.

Member Data Documentation

oxArticle.$_sCoreTbl = 'oxarticles' [protected]

Definition at line 23 of file oxarticle.php.

oxArticle.$_sClassName = 'oxarticle' [protected]

Reimplemented from oxI18n.

Definition at line 30 of file oxarticle.php.

oxArticle.$_blUseLazyLoading = true [protected]

Reimplemented from oxBase.

Definition at line 37 of file oxarticle.php.

oxArticle.$_sItemKey [protected]

Definition at line 44 of file oxarticle.php.

oxArticle.$_blCalcPrice = true [protected]

Definition at line 51 of file oxarticle.php.

oxArticle.$_oPrice = null [protected]

Definition at line 57 of file oxarticle.php.

oxArticle.$_dArticleVat = null [protected]

Definition at line 64 of file oxarticle.php.

oxArticle.$_aPersistParam = null [protected]

Definition at line 71 of file oxarticle.php.

oxArticle.$_blNotBuyable = false [protected]

Definition at line 78 of file oxarticle.php.

oxArticle.$_blLoadVariants = true [protected]

Definition at line 86 of file oxarticle.php.

oxArticle.$_aVariants = null [protected]

Definition at line 93 of file oxarticle.php.

oxArticle.$_aVariantsWithNotOrderables = null [protected]

Definition at line 100 of file oxarticle.php.

oxArticle.$_blNotBuyableParent = false [protected]

Definition at line 110 of file oxarticle.php.

oxArticle.$_blHasVariants = false [protected]

$_blHasVariants is set to true if article has any variants. As an opposite to $_oVariantList this works even if variants are not active

Definition at line 116 of file oxarticle.php.

oxArticle.$_blHasMdVariants = false [protected]

$_blHasVariants is set to true if article has multidimensional variants.

Definition at line 121 of file oxarticle.php.

oxArticle.$_iVarStock = 0 [protected]

Indicates how many variants this article has "on stock" (very large number for unlimited)

Definition at line 126 of file oxarticle.php.

oxArticle.$_oVariantList = array() [protected]

Definition at line 132 of file oxarticle.php.

oxArticle.$_blIsOnComparisonList = false [protected]

Definition at line 138 of file oxarticle.php.

oxArticle.$_oUser = null [protected]

Definition at line 144 of file oxarticle.php.

oxArticle.$_blLoadPrice = true [protected]

Definition at line 151 of file oxarticle.php.

oxArticle.$_blSkipAbPrice = false [protected]

If $_blSkipAbPrice is set to true, then "From price" is not calculated for this object.

Definition at line 156 of file oxarticle.php.

oxArticle.$_fPricePerUnit = null [protected]

$_fPricePerUnit holds price per unit value in active shop currency. $_fPricePerUnit is calculated from oxArticle.oxarticles__oxunitquantity->value and from oxArticle.oxarticles__oxuniname->value. If either one of these values is empty then $_fPricePerUnit is not calculated. Example: In case when product price is 10 EUR and product quantity is 0.5 (liters) then $_fPricePerUnit would be 20,00

Definition at line 164 of file oxarticle.php.

oxArticle.$_blLoadParentData = false [protected]

Variable used to force load parent data in export

Definition at line 169 of file oxarticle.php.

oxArticle.$_blSkipAssign = false [protected]

Variable used to force load parent data in export

Definition at line 174 of file oxarticle.php.

oxArticle.$_blSkipDiscounts = null [protected]

Definition at line 181 of file oxarticle.php.

oxArticle.$_oAttributeList = null [protected]

Object holding the list of attributes and attribute values associated with this article Attributes are loaded only when bl_perfLoadAttributes config option is set to true

Definition at line 187 of file oxarticle.php.

oxArticle.$_blIsRangePrice = false [protected]

Definition at line 195 of file oxarticle.php.

oxArticle.$_aMediaUrls = null [protected]

Definition at line 202 of file oxarticle.php.

oxArticle.$_aLoadedParents [static, protected]

Definition at line 209 of file oxarticle.php.

oxArticle.$_aSelList [static, protected]

Definition at line 216 of file oxarticle.php.

oxArticle.$_aDispSelList [protected]

Definition at line 223 of file oxarticle.php.

oxArticle.$_blIsSeoObject = true [protected]

Reimplemented from oxBase.

Definition at line 230 of file oxarticle.php.

oxArticle.$_oAmountPriceList = null [protected]

Definition at line 237 of file oxarticle.php.

oxArticle.$_iLinkType = 0 [protected]

Definition at line 247 of file oxarticle.php.

oxArticle.$_sStdLink = null [protected]

Definition at line 254 of file oxarticle.php.

oxArticle.$_sDynImageDir = null [protected]

Definition at line 261 of file oxarticle.php.

oxArticle.$_sMoreDetailLink = null [protected]

Definition at line 268 of file oxarticle.php.

oxArticle.$_sToBasketLink = null [protected]

Definition at line 275 of file oxarticle.php.

oxArticle.$_iStockStatus = null [protected]

Definition at line 282 of file oxarticle.php.

oxArticle.$_oTPrice = null [protected]

Definition at line 289 of file oxarticle.php.

oxArticle.$_oAmountPriceInfo = null [protected]

Definition at line 296 of file oxarticle.php.

oxArticle.$_dAmountPrice = null [protected]

Definition at line 303 of file oxarticle.php.

oxArticle.$_sDetailLink = null [protected]

Definition at line 310 of file oxarticle.php.

oxArticle.$_aArticleManufacturers = array() [static, protected]

Definition at line 317 of file oxarticle.php.

oxArticle.$_aArticleVendors = array() [static, protected]

Definition at line 324 of file oxarticle.php.

oxArticle.$_aArticleCats = array() [static, protected]

Definition at line 331 of file oxarticle.php.

oxArticle.$_aNonCopyParentFields [protected]

Initial value:

 array('oxarticles__oxinsert',
                                             'oxarticles__oxtimestamp',
                                             'oxarticles__oxnid',
                                             'oxarticles__oxid',
                                             'oxarticles__oxparentid')

Definition at line 338 of file oxarticle.php.

oxArticle.$_aCopyParentField [protected]

Initial value:

 array('oxarticles__oxnonmaterial',
                                         'oxarticles__oxfreeshipping',
                                         'oxarticles__oxremindactive')

Definition at line 349 of file oxarticle.php.

oxArticle.$_oMdVariants = null [protected]

Definition at line 358 of file oxarticle.php.

The documentation for this class was generated from the following file:
Generated on Mon Oct 26 20:09:42 2009 for OXID eShop CE by  doxygen 1.5.5