Article manager. Creates fully detailed article object, with such information as VAT, discounts, etc.
Definition at line 17 of file oxarticle.php.
oxArticle.__construct | ( | $ | aParams = null |
) |
Class constructor, sets shop ID for article (oxconfig.getShopId()), initiates parent constructor (parent.oxI18n()).
array | $aParams The array of names and values of oxArticle instance properties to be set on object instantiation |
Definition at line 383 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
string | $sName Variable name |
Reimplemented from oxBase.
Definition at line 421 of file oxarticle.php.
oxArticle.__isset | ( | $ | sName | ) |
Magic isset, deals with article long description
string | $sName Variable name |
Reimplemented from oxBase.
Definition at line 403 of file oxarticle.php.
oxArticle._applyCurrency | ( | oxPrice $ | oPrice, | |
$ | oCur = null | |||
) | [protected] |
Applies currency factor
oxPrice | $oPrice Price object | |
object | $oCur Currency object |
Definition at line 3266 of file oxarticle.php.
oxArticle._applyDiscounts | ( | $ | oPrice, | |
$ | aDiscounts | |||
) | [protected] |
Applies discounts which should be applied in general case (for 0 amount)
oxprice | $oPrice Price object | |
array | $aDiscounts Discount list |
Definition at line 3236 of file oxarticle.php.
oxArticle._applyRangePrice | ( | ) | [protected] |
Returns minimum brut price from all (already loaded) variants and if aplicable parent article
Definition at line 4250 of file oxarticle.php.
oxArticle._applyVAT | ( | oxPrice $ | oPrice, | |
$ | dVat | |||
) | [protected] |
Applies VAT to article
oxPrice | $oPrice Price object | |
double | $dVat VAT percent |
Definition at line 3202 of file oxarticle.php.
oxArticle._assignAllPictureValues | ( | ) | [protected] |
oxArticle._assignAttributes | ( | ) | [protected] |
oxArticle._assignComparisonListFlag | ( | ) | [protected] |
Adds a flag if article is on comparisonlist.
Definition at line 3930 of file oxarticle.php.
oxArticle._assignDynImageDir | ( | ) | [protected] |
oxArticle._assignNotBuyableParent | ( | ) | [protected] |
if we have variants then depending on config option the parent may be non buyable
Definition at line 3714 of file oxarticle.php.
oxArticle._assignParentFieldValue | ( | $ | sFieldName | ) | [protected] |
Assigns parent field values to article
string | $sFieldName field name |
Definition at line 3600 of file oxarticle.php.
oxArticle._assignParentFieldValues | ( | ) | [protected] |
oxArticle._assignPersistentParam | ( | ) | [protected] |
oxArticle._assignPictureValues | ( | $ | sName = '' |
) | [protected] |
Assigns picture values to article.
string | $sName field name |
Definition at line 3754 of file oxarticle.php.
oxArticle._assignPrices | ( | ) | [protected] |
oxArticle._assignStock | ( | ) | [protected] |
oxArticle._calculatePrice | ( | $ | oPrice | ) | [protected] |
Calculates price of article (adds taxes, currency and discounts).
oxPrice | $oPrice price object |
Definition at line 1738 of file oxarticle.php.
oxArticle._deletePics | ( | ) | [protected] |
oxArticle._deleteRecords | ( | $ | sOXID | ) | [protected] |
Deletes records in database
string | $sOXID Article ID |
Definition at line 3999 of file oxarticle.php.
oxArticle._deleteVariantRecords | ( | $ | sOXID | ) | [protected] |
Deletes variant records
string | $sOXID Article ID |
Definition at line 4055 of file oxarticle.php.
oxArticle._fillAmountPriceList | ( | $ | oAmPriceList | ) | [protected] |
Fills amount price list object and sets amount price for article object
object | $oAmPriceList Amount (staffel) price list |
Definition at line 3109 of file oxarticle.php.
oxArticle._generateImages | ( | $ | iIndex | ) | [protected] |
Generates article pictures from master picture. Calls oxPictureHandler.generateArticlePictures for pictures generation.
int | $iIndex field index |
Definition at line 4451 of file oxarticle.php.
oxArticle._generateSearchStr | ( | $ | sOXID, | |
$ | blSearchPriceCat = false | |||
) | [protected] |
Generates SearchString for getCategory()
string | $sOXID Article ID | |
bool | $blSearchPriceCat Whether to perform the search within price categories |
Definition at line 3394 of file oxarticle.php.
oxArticle._generateSearchStrForCustomerBought | ( | ) | [protected] |
Generates SQL select string for getCustomerAlsoBoughtThisProduct
Definition at line 3417 of file oxarticle.php.
oxArticle._generateSelectCatStr | ( | $ | sOXID, | |
$ | sCatId, | |||
$ | dPriceFromTo = false | |||
) | [protected] |
Generates select string for isAssignedToCategory()
string | $sOXID Article ID | |
string | $sCatId Category ID | |
bool | $dPriceFromTo Article price for price categories |
Definition at line 3477 of file oxarticle.php.
oxArticle._generateSimListSearchStr | ( | $ | sArticleTable, | |
$ | aList | |||
) | [protected] |
Generates search string for similar list.
string | $sArticleTable Article table name | |
array | $aList A list of original articles |
Definition at line 3356 of file oxarticle.php.
oxArticle._getAmountPrice | ( | $ | dAmount = 1 |
) | [protected] |
Modifies article price depending on given amount. Takes data from oxprice2article table.
double | $dAmount Basket amount |
Definition at line 3052 of file oxarticle.php.
oxArticle._getAmountPriceList | ( | ) | [protected] |
Collecting assigned to article amount-price list
Definition at line 3506 of file oxarticle.php.
oxArticle._getAttribsString | ( | &$ | sAttribs, | |
&$ | iCnt | |||
) | [protected] |
gets attribs string
string | &$sAttribs Attribute selection snippet | |
int | &$iCnt The number of selected attributes |
Definition at line 3284 of file oxarticle.php.
oxArticle._getGroupPrice | ( | ) | [protected] |
get user Group A, B or C price, returns db price if user is not in groups
Definition at line 3021 of file oxarticle.php.
oxArticle._getIconName | ( | $ | iIndex = '' |
) | [protected] |
Returns article picture icon file name. If no index specified, will return main icon file name.
int | $iIndex picture index |
Definition at line 2817 of file oxarticle.php.
oxArticle._getParentAricle | ( | ) | [protected] |
Get parent article
Definition at line 3666 of file oxarticle.php.
oxArticle._getPictureName | ( | $ | iIndex = '' |
) | [protected] |
Returns article main picture file name
int | $iIndex picture index |
Definition at line 2768 of file oxarticle.php.
oxArticle._getSelectCatIds | ( | $ | sOXID, | |
$ | blActCats = false | |||
) | [protected] |
Returns query for article categories select
string | $sOXID article id | |
bool | $blActCats select categories if all parents are active |
Definition at line 1447 of file oxarticle.php.
oxArticle._getSimList | ( | $ | sAttribs, | |
$ | iCnt | |||
) | [protected] |
Gets similar list.
string | $sAttribs Attribute selection snippet | |
int | $iCnt Similar list article count |
Definition at line 3314 of file oxarticle.php.
oxArticle._getThumbnailName | ( | ) | [protected] |
oxArticle._getVariantsIds | ( | ) | [protected] |
Collects and returns article variants ids.
Definition at line 3168 of file oxarticle.php.
oxArticle._getZoomPictureName | ( | $ | iIndex = '' |
) | [protected] |
Returns article zoom picture file name
int | $iIndex zoom picture index |
Definition at line 2909 of file oxarticle.php.
oxArticle._hasAnyVariant | ( | $ | blForceCoreTable = false |
) | [protected] |
Checks if parent has ANY variant assigned
bool | $blForceCoreTable force core table usage |
Definition at line 1198 of file oxarticle.php.
oxArticle._hasGeneratedImage | ( | $ | iIndex | ) | [protected] |
Checks if article already has generated images from master picture specified by index.
int | $iIndex master picture index |
Definition at line 4485 of file oxarticle.php.
oxArticle._hasMasterImage | ( | $ | iIndex | ) | [protected] |
Checks if article has uplodaded master image for selected picture
int | $iIndex master picture index |
Definition at line 4501 of file oxarticle.php.
oxArticle._insert | ( | ) | [protected] |
Sets article creation date (oxarticle.oxarticles__oxinsert). Then executes parent method parent._insert() and returns insertion status.
Reimplemented from oxBase.
Definition at line 3962 of file oxarticle.php.
oxArticle._isFieldEmpty | ( | $ | sFieldName | ) | [protected] |
Detects if field is empty.
string | $sFieldName Field name |
Definition at line 3556 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.
Definition at line 3003 of file oxarticle.php.
oxArticle._modifySelectListPrice | ( | $ | dPrice, | |
$ | aChosenList = null | |||
) | [protected] |
Modifies article price according to selected select list value
double | $dPrice Modifyable price | |
array | $aChosenList Selection list array |
Definition at line 3080 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.
string | $sOxid object to reset id ID | |
string | $sVendorId Vendor ID | |
string | $sManufacturerId Manufacturer ID |
Definition at line 4118 of file oxarticle.php.
oxArticle._onChangeStockResetCount | ( | $ | sOxid | ) | [protected] |
Resets article count cache when stock value is zero and article goes offline.
string | $sOxid product id |
Definition at line 4188 of file oxarticle.php.
oxArticle._onChangeUpdateMinVarPrice | ( | $ | sParentID | ) | [protected] |
Updates variant min price. This method is supposed to be called on article change triger.
string | $sParentID Parent ID |
Definition at line 4224 of file oxarticle.php.
oxArticle._onChangeUpdateStock | ( | $ | sParentID | ) | [protected] |
Updates article stock. This method is supposed to be called on article change triger.
string | $sParentID product parent id |
Definition at line 4150 of file oxarticle.php.
oxArticle._onChangeUpdateVarCount | ( | $ | sParentID | ) | [protected] |
Updates variant count. This method is supposed to be called on article change triger.
string | $sParentID Parent ID |
Definition at line 4206 of file oxarticle.php.
oxArticle._resetCacheAndArticleCount | ( | $ | sOxid | ) | [protected] |
Resets cache and article count in vendor and category
string | $sOxid reset article id |
Definition at line 4078 of file oxarticle.php.
oxArticle._saveArtLongDesc | ( | $ | iLang, | |
$ | sValue | |||
) | [protected] |
inserts article long description to artextends table
int | $iLang language | |
string | $sValue long description |
Definition at line 2960 of file oxarticle.php.
oxArticle._setLongDesc | ( | $ | sDbValue | ) | [protected] |
set given value to object's oxlongdesc - also prepare it (parse throug smarty)
string | $sDbValue value to set |
Definition at line 2203 of file oxarticle.php.
oxArticle._skipSaveFields | ( | ) | [protected] |
Removes object data fields (oxarticles__oxtimestamp, oxarticles__oxparentid, oxarticles__oxinsert).
Definition at line 2978 of file oxarticle.php.
oxArticle._update | ( | ) | [protected] |
Executes oxarticle._skipSaveFields() and updates article information
Reimplemented from oxI18n.
Definition at line 3981 of file oxarticle.php.
oxArticle.addTag | ( | $ | sTag | ) |
Adds tag
string | $sTag new tag |
Definition at line 2505 of file oxarticle.php.
oxArticle.addToRatingAverage | ( | $ | iRating | ) |
Calculates and saves product rating average
integer | $iRating new rating value |
Definition at line 958 of file oxarticle.php.
oxArticle.appendLink | ( | $ | sAddParams, | |
$ | iLang = null | |||
) |
Appends article seo url with additional request parameters
string | $sAddParams additional parameters which needs to be added to product url | |
int | $iLang language id |
Definition at line 2290 of file oxarticle.php.
oxArticle.appendStdLink | ( | $ | sAddParams, | |
$ | iLang = null | |||
) |
Appends article dynemic url with additional request parameters
string | $sAddParams additional parameters which needs to be added to product url | |
int | $iLang language id |
Definition at line 2397 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.
oxPrice | $oPrice Old article price | |
array | $aDiscounts Discount array | |
amount | $dAmount Amount in basket |
Definition at line 1835 of file oxarticle.php.
oxArticle.applyDiscountsForVariant | ( | $ | oPrice | ) |
Applies discounts which should be applied in general case (for 0 amount)
oxprice | $oPrice Price object |
Definition at line 3249 of file oxarticle.php.
oxArticle.applyVats | ( | oxPrice $ | oPrice | ) |
apply article and article use
oxPrice | $oPrice target price |
Definition at line 3219 of file oxarticle.php.
oxArticle.assign | ( | $ | aRecord | ) |
Assigns to oxarticle object some base parameters/values (such as detaillink, moredetaillink, etc).
string | $aRecord Array representing current field values |
Reimplemented from oxI18n.
Definition at line 892 of file oxarticle.php.
oxArticle.checkForStock | ( | $ | dAmount, | |
$ | dArtStockAmount = 0 | |||
) |
Checks if stock configuration allows to buy user chosen amount $dAmount
double | $dAmount buyable amount | |
double | $dArtStockAmount stock amount |
Implements oxIArticle.
Definition at line 2113 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.
string | $sOXID Article id |
Reimplemented from oxBase.
Definition at line 1849 of file oxarticle.php.
oxArticle.disablePriceLoad | ( | $ | oArticle | ) |
Disables article price loading. Should be called before assign(), or load()
objetc | $oArticle article object |
Definition at line 704 of file oxarticle.php.
oxArticle.disableReminder | ( | ) |
Disables reminder functionality for article
Definition at line 1910 of file oxarticle.php.
oxArticle.getAccessoires | ( | ) |
Loads and returns array with accessoires information.
Definition at line 1033 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"
bool | $blForceCoreTable force core table usage |
Definition at line 583 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.
string | $sLanguage shop language. |
Definition at line 1313 of file oxarticle.php.
oxArticle.getArticleLongDesc | ( | $ | sOXID = null |
) |
Get article long description
string | $sOXID Article ID |
Definition at line 2166 of file oxarticle.php.
oxArticle.getArticleRatingAverage | ( | ) |
oxArticle.getArticleUser | ( | ) |
oxArticle.getArticleVat | ( | ) |
oxArticle.getAttributes | ( | ) |
Loads and returns attribute list associated with this article
Definition at line 2272 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.
double | $dAmount article amount. Default is 1 |
Implements oxIArticle.
Definition at line 1677 of file oxarticle.php.
oxArticle.getBaseSeoLink | ( | $ | iLang, | |
$ | blMain = false | |||
) |
Returns raw article seo url
int | $iLang language id | |
bool | $blMain force to return main url [optional] |
Definition at line 2310 of file oxarticle.php.
oxArticle.getBaseStdLink | ( | $ | iLang, | |
$ | blAddId = true , |
|||
$ | blFull = true | |||
) |
Returns base dynamic url: shopurl/index.php?cl=details
int | $iLang language id | |
bool | $blAddId add current object id to url or not [optional] | |
bool | $blFull return full including domain name [optional] |
Definition at line 2418 of file oxarticle.php.
oxArticle.getBasketPrice | ( | $ | dAmount, | |
$ | aSelList, | |||
$ | oBasket | |||
) |
Creates, calculates and returns oxprice object for basket product.
double | $dAmount Amount | |
string | $aSelList Selection list | |
object | $oBasket User shopping basket object |
Implements oxIArticle.
Definition at line 1790 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
Definition at line 1345 of file oxarticle.php.
oxArticle.getCategoryIds | ( | $ | blActCats = false , |
|
$ | blSkipCache = false | |||
) |
Returns ID's of categories where this article is assigned
bool | $blActCats select categories if all parents are active | |
bool | $blSkipCache Whether to skip cache |
Implements oxIArticle.
Definition at line 1387 of file oxarticle.php.
oxArticle.getCrossSelling | ( | ) |
Loads and returns array with crosselling information.
Definition at line 1019 of file oxarticle.php.
oxArticle.getCustomerAlsoBoughtThisProducts | ( | ) |
Loads and returns articles list, bought by same customer.
Definition at line 1094 of file oxarticle.php.
oxArticle.getCustomVAT | ( | ) |
Returns custom article VAT value if possible By default value is taken from oxarticle__oxvat field
Definition at line 2098 of file oxarticle.php.
oxArticle.getDeliveryDate | ( | ) |
Returns formated delivery date. If the date is not set ('0000-00-00') returns false.
Definition at line 2642 of file oxarticle.php.
oxArticle.getDispSelList | ( | ) |
oxArticle.getDynImageDir | ( | ) |
oxArticle.getFileUrl | ( | ) |
oxArticle.getFPrice | ( | ) |
oxArticle.getFTPrice | ( | ) |
oxArticle.getIconUrl | ( | $ | iIndex = '' |
) |
Returns article icon picture url. If no index specified, will return main icon url.
int | $iIndex picture index |
Definition at line 2787 of file oxarticle.php.
oxArticle.getItemKey | ( | ) |
Returns item key used with oxuserbasket
Definition at line 714 of file oxarticle.php.
oxArticle.getLink | ( | $ | iLang = null , |
|
$ | blMain = false | |||
) |
Gets article link
int | $iLang language id [optional] | |
bool | $blMain force to return main url [optional] |
Definition at line 2327 of file oxarticle.php.
oxArticle.getLinkType | ( | ) |
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
int | $iLang language id [optional] |
Definition at line 2358 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
bool | $blShopCheck Set false if shop check is not required (default is true) |
Definition at line 1540 of file oxarticle.php.
oxArticle.getManufacturerId | ( | $ | blForceReload = false |
) |
Returns article object Manufacturer ID. Result is cached into self.$_aArticleManufacturers
bool | $blForceReload reloads id even if it is cached |
Definition at line 1517 of file oxarticle.php.
oxArticle.getMdSubvariants | ( | ) |
Returns first level variants from multidimensional variants list
Definition at line 4437 of file oxarticle.php.
oxArticle.getMdVariants | ( | ) |
Returns multidimensional variant structure
Definition at line 4413 of file oxarticle.php.
oxArticle.getMediaUrls | ( | ) |
oxArticle.getMoreDetailLink | ( | ) |
oxArticle.getParentArticle | ( | ) |
oxArticle.getPersParams | ( | ) |
oxArticle.getPictureFieldValue | ( | $ | sFieldName, | |
$ | iIndex = null | |||
) |
Return article picture file name
string | $sFieldName article picture field name | |
int | $iIndex article picture index |
Definition at line 4526 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)
Definition at line 1953 of file oxarticle.php.
oxArticle.getPictureUrl | ( | $ | iIndex = '' |
) |
Returns article picture
int | $iIndex picture index |
Definition at line 2747 of file oxarticle.php.
oxArticle.getPrice | ( | $ | dAmount = 1 |
) |
Calculates and returns price of article (adds taxes and discounts).
double | $dAmount article amount |
Definition at line 1701 of file oxarticle.php.
oxArticle.getPriceFromPrefix | ( | ) |
Returns string prefix (like "ab") if needed or empty string.
Definition at line 2942 of file oxarticle.php.
oxArticle.getPricePerUnit | ( | ) |
Returns formated price per unit (oxarticle._assignPrices())
Definition at line 2681 of file oxarticle.php.
oxArticle.getProductId | ( | ) |
Returns product id (oxid) (required for interface oxIArticle)
Implements oxIArticle.
Definition at line 4320 of file oxarticle.php.
oxArticle.getProductParentId | ( | ) |
Returns product parent id (oxparentid)
Implements oxIArticle.
Definition at line 4330 of file oxarticle.php.
oxArticle.getReviews | ( | ) |
Collects user written reviews about an article.
Definition at line 985 of file oxarticle.php.
oxArticle.getSearchableFields | ( | ) |
Returns an array of article object DB fields, without multilanguage.
Definition at line 818 of file oxarticle.php.
oxArticle.getSelectLists | ( | $ | sKeyPrefix = null |
) |
Returns all selectlists this article has.
string | $sKeyPrefix Optionall key prefix |
Implements oxIArticle.
Definition at line 1143 of file oxarticle.php.
oxArticle.getSimilarProducts | ( | ) |
oxArticle.getSimpleVariants | ( | ) |
Simple way to get variants without quering oxarticle table first. This is basically used for lists.
Definition at line 1298 of file oxarticle.php.
oxArticle.getSqlActiveSnippet | ( | $ | blForceCoreTable = false |
) |
Returns SQL select string with checks if items are available
bool | $blForceCoreTable forces core table usage (optional) |
Reimplemented from oxI18n.
Definition at line 671 of file oxarticle.php.
oxArticle.getSqlForPriceCategories | ( | $ | sFields = '' |
) |
get Sql for loading price categories which include this article
string | $sFields fields to load from oxcategories |
Definition at line 4374 of file oxarticle.php.
oxArticle.getStdLink | ( | $ | iLang = null , |
|
$ | aParams = array() | |||
) |
Returns standard URL to product
int | $iLang required language. optional | |
array | $aParams additional params to use [optional] |
Implements oxIUrl.
Definition at line 2438 of file oxarticle.php.
oxArticle.getStdTagLink | ( | $ | sTag | ) |
Returns standard product Tag URL
string | $sTag tag |
Definition at line 2458 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"
bool | $blForceCoreTable force core table usage |
Definition at line 612 of file oxarticle.php.
oxArticle.getStockStatus | ( | ) |
oxArticle.getTableNameForActiveSnippet | ( | $ | blForceCoreTable = false |
) |
Returns name of table used when building active snippet query
bool | $blForceCoreTable force core table usage |
Definition at line 567 of file oxarticle.php.
oxArticle.getTags | ( | ) |
oxArticle.getThumbnailUrl | ( | ) |
oxArticle.getToBasketLink | ( | ) |
oxArticle.getTPrice | ( | ) |
oxArticle.getVariantList | ( | ) |
Returns variant lists of current product
Definition at line 2723 of file oxarticle.php.
oxArticle.getVariants | ( | $ | blRemoveNotOrderables = true , |
|
$ | blForceCoreTable = false | |||
) |
Collects and returns article variants.
bool | $blRemoveNotOrderables if true, removes from list not orderable articles, which are out of stock | |
bool | $blForceCoreTable if true forces core tabel use, default is false [optional] |
Definition at line 1222 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 ) )"
bool | $blRemoveNotOrderables remove or leave non orderable products | |
bool | $blForceCoreTable force core table usage |
Definition at line 647 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
bool | $blShopCheck Set false if shop check is not required (default is true) |
Definition at line 1469 of file oxarticle.php.
oxArticle.getVendorId | ( | $ | blForceReload = false |
) |
Returns article object vendor ID. Result is cached into self.$_aArticleVendors
bool | $blForceReload reloads id even if it is cached |
Definition at line 1495 of file oxarticle.php.
oxArticle.getZoomPictureUrl | ( | $ | iIndex = '' |
) |
Returns article zoom picture url
int | $iIndex picture index |
Definition at line 2884 of file oxarticle.php.
oxArticle.hasMdVariants | ( | ) |
Checks if article has multidimensional variants
Definition at line 1209 of file oxarticle.php.
oxArticle.inCategory | ( | $ | sCatNid | ) |
Checks if article is assigned to category $sCatNID.
string | $sCatNid category ID |
Definition at line 1568 of file oxarticle.php.
oxArticle.inPriceCategory | ( | $ | sCatNid | ) |
Checks if artickle is assigned to price category $sCatNID.
string | $sCatNid Price category ID |
Definition at line 4393 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.
string | $sCatId category ID |
Definition at line 1581 of file oxarticle.php.
oxArticle.isBuyable | ( | ) |
oxArticle.isMdVariant | ( | ) |
Returns TRUE if product is multidimensional variant, and false if not
Definition at line 4360 of file oxarticle.php.
oxArticle.isMultilingualField | ( | $ | sFieldName | ) |
Returns true if the field is multilanguage
string | $sFieldName Field name |
Reimplemented from oxI18n.
Definition at line 834 of file oxarticle.php.
oxArticle.isNotBuyable | ( | ) |
oxArticle.isOnComparisonList | ( | ) |
Checks whether article is inluded in comparison list
Definition at line 772 of file oxarticle.php.
oxArticle.isOrderArticle | ( | ) |
Returns false if object is not derived from oxorderarticle class
Implements oxIArticle.
Definition at line 4340 of file oxarticle.php.
oxArticle.isParentNotBuyable | ( | ) |
oxArticle.isVariant | ( | ) |
Returns TRUE if product is variant, and false if not
Definition at line 4350 of file oxarticle.php.
oxArticle.isVisible | ( | ) |
Checks if article has visible status. Returns TRUE if its visible
Definition at line 850 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.
string | $oxID Article object ID |
Reimplemented from oxBase.
Definition at line 937 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.
Definition at line 1119 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)
string | $sAction Action constant | |
string | $sOXID Article ID | |
string | $sParentID Parent ID |
Definition at line 2042 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.
Reimplemented from oxBase.
Definition at line 1922 of file oxarticle.php.
oxArticle.saveTags | ( | $ | sTags | ) |
Saves article tags
string | $sTags article tag |
Definition at line 2486 of file oxarticle.php.
oxArticle.setArticleLongDesc | ( | ) |
Save article long description to oxartext table
Definition at line 2232 of file oxarticle.php.
oxArticle.setArticleUser | ( | $ | oUser | ) |
sets article user
oxUser | $oUser user to set |
Definition at line 1763 of file oxarticle.php.
oxArticle.setBuyableState | ( | $ | blBuyable = false |
) |
Sets product state - buyable or not
bool | $blBuyable state - buyable or not (default false) |
Definition at line 2713 of file oxarticle.php.
oxArticle.setId | ( | $ | sId = null |
) |
Sets object ID, additionally sets $this->oxarticles__oxnid field value
string | $sId New ID |
Reimplemented from oxBase.
Definition at line 550 of file oxarticle.php.
oxArticle.setItemKey | ( | $ | sItemKey | ) |
Sets item key used with oxuserbasket
string | $sItemKey Item key |
Definition at line 726 of file oxarticle.php.
oxArticle.setLinkType | ( | $ | iType | ) |
Resets details link
int | $iType type of link to load |
Definition at line 2370 of file oxarticle.php.
oxArticle.setLoadParentData | ( | $ | blLoadParentData | ) |
A setter for $_blLoadParentData (whether article parent info should be laoded fully) class variable
bool | $blLoadParentData Whether to load parent data |
Definition at line 796 of file oxarticle.php.
oxArticle.setNoVariantLoading | ( | $ | blLoadVariants | ) |
Disables/enables variant loading
bool | $blLoadVariants skip variant loading or not |
Definition at line 738 of file oxarticle.php.
oxArticle.setOnComparisonList | ( | $ | blOnList | ) |
Set if article is inluded in comparison list
bool | $blOnList Whether is article on the list |
Definition at line 784 of file oxarticle.php.
oxArticle.setPrice | ( | oxPrice $ | oPrice | ) |
Sets the current oxPrice object
oxPrice | $oPrice the new price object |
Definition at line 1664 of file oxarticle.php.
oxArticle.setSelectlist | ( | $ | aSelList | ) |
Sets selectlists of current product
array | $aSelList selectlist |
Definition at line 2735 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.
bool | $blSkipAbPrice Whether to skip "From" price loading |
Definition at line 808 of file oxarticle.php.
oxArticle.setSkipAssign | ( | $ | blSkipAssign | ) |
Assign condition setter. In case article assignment is skipped ($_blSkipAssign = true), it does not perform additional
bool | $blSkipAssign Whether to skip assign process for the article |
Definition at line 692 of file oxarticle.php.
oxArticle.skipDiscounts | ( | ) |
Checks if discount should be skipped for this article in basket. Returns true if yes.
Implements oxIArticle.
Definition at line 1641 of file oxarticle.php.
oxArticle.updateAmountOfGeneratedPictures | ( | $ | iTotalGenerated | ) |
Updates count of how many master pictures where used for images generation.
int | $iTotalGenerated total generated images |
Definition at line 4469 of file oxarticle.php.
oxArticle.updateSoldAmount | ( | $ | dAmount = 0 |
) |
Recursive function. Updates quantity of sold articles. Return true on success
double | $dAmount Number of articles sold |
Definition at line 1880 of file oxarticle.php.
oxArticle.$_aArticleCats = array() [static, protected] |
Definition at line 346 of file oxarticle.php.
oxArticle.$_aArticleManufacturers = array() [static, protected] |
Definition at line 332 of file oxarticle.php.
oxArticle.$_aArticleVendors = array() [static, protected] |
Definition at line 339 of file oxarticle.php.
oxArticle.$_aCopyParentField [protected] |
array('oxarticles__oxnonmaterial', 'oxarticles__oxfreeshipping', 'oxarticles__oxremindactive')
Definition at line 364 of file oxarticle.php.
oxArticle.$_aDispSelList [protected] |
Definition at line 224 of file oxarticle.php.
oxArticle.$_aLoadedParents [static, protected] |
Definition at line 210 of file oxarticle.php.
oxArticle.$_aMediaUrls = null [protected] |
Definition at line 203 of file oxarticle.php.
oxArticle.$_aNonCopyParentFields [protected] |
array('oxarticles__oxinsert', 'oxarticles__oxtimestamp', 'oxarticles__oxnid', 'oxarticles__oxid', 'oxarticles__oxparentid')
Definition at line 353 of file oxarticle.php.
oxArticle.$_aPersistParam = null [protected] |
Definition at line 72 of file oxarticle.php.
oxArticle.$_aSelList [static, protected] |
Definition at line 217 of file oxarticle.php.
oxArticle.$_aSeoAddParams = array() [protected] |
Definition at line 269 of file oxarticle.php.
oxArticle.$_aSeoUrls = array() [protected] |
Definition at line 262 of file oxarticle.php.
oxArticle.$_aStdAddParams = array() [protected] |
Definition at line 276 of file oxarticle.php.
oxArticle.$_aStdUrls = array() [protected] |
Definition at line 255 of file oxarticle.php.
oxArticle.$_aVariants = null [protected] |
Definition at line 94 of file oxarticle.php.
oxArticle.$_aVariantsWithNotOrderables = null [protected] |
Definition at line 101 of file oxarticle.php.
oxArticle.$_blCalcPrice = true [protected] |
Definition at line 52 of file oxarticle.php.
oxArticle.$_blHasMdVariants = false [protected] |
$_blHasVariants is set to true if article has multidimensional variants.
Definition at line 122 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 117 of file oxarticle.php.
oxArticle.$_blIsOnComparisonList = false [protected] |
Definition at line 139 of file oxarticle.php.
oxArticle.$_blIsRangePrice = false [protected] |
Definition at line 196 of file oxarticle.php.
oxArticle.$_blIsSeoObject = true [protected] |
Reimplemented from oxBase.
Definition at line 231 of file oxarticle.php.
oxArticle.$_blLoadParentData = false [protected] |
Variable used to force load parent data in export
Definition at line 170 of file oxarticle.php.
oxArticle.$_blLoadPrice = true [protected] |
Definition at line 152 of file oxarticle.php.
oxArticle.$_blLoadVariants = true [protected] |
Definition at line 87 of file oxarticle.php.
oxArticle.$_blNotBuyable = false [protected] |
Definition at line 79 of file oxarticle.php.
oxArticle.$_blNotBuyableParent = false [protected] |
Definition at line 111 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 157 of file oxarticle.php.
oxArticle.$_blSkipAssign = false [protected] |
Variable used to force load parent data in export
Definition at line 175 of file oxarticle.php.
oxArticle.$_blSkipDiscounts = null [protected] |
Definition at line 182 of file oxarticle.php.
oxArticle.$_blUseLazyLoading = true [protected] |
Reimplemented from oxBase.
Definition at line 38 of file oxarticle.php.
oxArticle.$_dAmountPrice = null [protected] |
Definition at line 325 of file oxarticle.php.
oxArticle.$_dArticleVat = null [protected] |
Definition at line 65 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 165 of file oxarticle.php.
oxArticle.$_iLinkType = 0 [protected] |
Definition at line 248 of file oxarticle.php.
oxArticle.$_iStockStatus = null [protected] |
Definition at line 304 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 127 of file oxarticle.php.
oxArticle.$_oAmountPriceInfo = null [protected] |
Definition at line 318 of file oxarticle.php.
oxArticle.$_oAmountPriceList = null [protected] |
Definition at line 238 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 188 of file oxarticle.php.
oxArticle.$_oMdVariants = null [protected] |
Definition at line 373 of file oxarticle.php.
oxArticle.$_oPrice = null [protected] |
Definition at line 58 of file oxarticle.php.
oxArticle.$_oTPrice = null [protected] |
Definition at line 311 of file oxarticle.php.
oxArticle.$_oUser = null [protected] |
Definition at line 145 of file oxarticle.php.
oxArticle.$_oVariantList = array() [protected] |
Definition at line 133 of file oxarticle.php.
oxArticle.$_sClassName = 'oxarticle' [protected] |
Reimplemented from oxI18n.
Definition at line 31 of file oxarticle.php.
oxArticle.$_sCoreTbl = 'oxarticles' [protected] |
Definition at line 24 of file oxarticle.php.
oxArticle.$_sDynImageDir = null [protected] |
Definition at line 283 of file oxarticle.php.
oxArticle.$_sItemKey [protected] |
Definition at line 45 of file oxarticle.php.
oxArticle.$_sMoreDetailLink = null [protected] |
Definition at line 290 of file oxarticle.php.
oxArticle.$_sToBasketLink = null [protected] |
Definition at line 297 of file oxarticle.php.