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 406 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 |
Definition at line 427 of file oxarticle.php.
oxArticle.__set | ( | $ | sName, | |
$ | sValue | |||
) |
Sets article parameter
string | $sName name of parameter to set | |
mixed | $sValue parameter value |
Definition at line 452 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 3257 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 3227 of file oxarticle.php.
oxArticle._applyRangePrice | ( | ) | [protected] |
Returns minimum brut price from all (already loaded) variants and if aplicable parent article
Definition at line 4167 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 3195 of file oxarticle.php.
oxArticle._assignAttributes | ( | ) | [protected] |
oxArticle._assignComparisonListFlag | ( | ) | [protected] |
Adds a flag if article is on comparisonlist.
Definition at line 3831 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 3687 of file oxarticle.php.
oxArticle._assignParentFieldValue | ( | $ | sFieldName | ) | [protected] |
Assigns parent field values to article
string | $sFieldName field name |
Definition at line 3588 of file oxarticle.php.
oxArticle._assignParentFieldValues | ( | ) | [protected] |
oxArticle._assignPersistentParam | ( | ) | [protected] |
oxArticle._assignPrices | ( | ) | [protected] |
oxArticle._assignStock | ( | ) | [protected] |
oxArticle._calculatePrice | ( | $ | oPrice, | |
$ | dVat = null | |||
) | [protected] |
Calculates price of article (adds taxes, currency and discounts).
oxPrice | $oPrice price object | |
double | $dVat vat value, optional, if passed, bypasses "bl_perfCalcVatOnlyForBasketOrder" config value |
Definition at line 1776 of file oxarticle.php.
oxArticle._deletePics | ( | ) | [protected] |
oxArticle._deleteRecords | ( | $ | sOXID | ) | [protected] |
Deletes records in database
string | $sOXID Article ID |
Definition at line 3900 of file oxarticle.php.
oxArticle._deleteVariantRecords | ( | $ | sOXID | ) | [protected] |
Deletes variant records
string | $sOXID Article ID |
Definition at line 3957 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 3096 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 3385 of file oxarticle.php.
oxArticle._generateSearchStrForCustomerBought | ( | ) | [protected] |
Generates SQL select string for getCustomerAlsoBoughtThisProduct
Definition at line 3409 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 3469 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 3347 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 3038 of file oxarticle.php.
oxArticle._getAmountPriceList | ( | ) | [protected] |
Collecting assigned to article amount-price list
Definition at line 3497 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 3275 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 3007 of file oxarticle.php.
oxArticle._getParentAricle | ( | ) | [protected] |
Get parent article
Definition at line 3658 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 1481 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 3305 of file oxarticle.php.
oxArticle._getVariantsIds | ( | ) | [protected] |
Collects and returns article variants ids.
Definition at line 3155 of file oxarticle.php.
oxArticle._hasAnyVariant | ( | $ | blForceCoreTable = null |
) | [protected] |
Checks if parent has ANY variant assigned
bool | $blForceCoreTable force core table usage |
Definition at line 1095 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 4357 of file oxarticle.php.
oxArticle._insert | ( | ) | [protected] |
Sets article creation date (oxarticle.oxarticles__oxinsert). Then executes parent method parent._insert() and returns insertion status.
Definition at line 3863 of file oxarticle.php.
oxArticle._isFieldEmpty | ( | $ | sFieldName | ) | [protected] |
Detects if field is empty.
string | $sFieldName Field name |
Definition at line 3545 of file oxarticle.php.
oxArticle._loadVariantList | ( | $ | blSimple, | |
$ | blRemoveNotOrderables = true , |
|||
$ | blForceCoreTable = null | |||
) | [protected] |
Loads and returns variants list.
bool | $blSimple If parameter $blSimple - list will be filled with oxSimpleVariant objects, else - oxArticle | |
bool | $blRemoveNotOrderables if true, removes from list not orderable articles, which are out of stock [optional] | |
bool | $blForceCoreTable if true forces core tabel use, default is false [optional] |
Definition at line 1211 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 2989 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 3066 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 4022 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 4094 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 4132 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 4054 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 4112 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 3982 of file oxarticle.php.
oxArticle._saveArtLongDesc | ( | ) | [protected] |
inserts article long description to artextends table
Definition at line 2908 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 2250 of file oxarticle.php.
oxArticle._skipSaveFields | ( | ) | [protected] |
Removes object data fields (oxarticles__oxtimestamp, oxarticles__oxparentid, oxarticles__oxinsert).
Definition at line 2964 of file oxarticle.php.
oxArticle._update | ( | ) | [protected] |
Executes oxarticle._skipSaveFields() and updates article information
Definition at line 3882 of file oxarticle.php.
oxArticle.addTag | ( | $ | sTag | ) |
Adds tag
string | $sTag new tag |
Definition at line 2532 of file oxarticle.php.
oxArticle.addToRatingAverage | ( | $ | iRating | ) |
Calculates and saves product rating average
integer | $iRating new rating value |
Definition at line 863 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 2310 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 2417 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 1863 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 3240 of file oxarticle.php.
oxArticle.applyVats | ( | oxPrice $ | oPrice | ) |
apply article and article use
oxPrice | $oPrice target price |
Definition at line 3212 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 |
Definition at line 799 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 |
Definition at line 2168 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 |
Definition at line 1877 of file oxarticle.php.
oxArticle.disablePriceLoad | ( | ) |
Disables article price loading. Should be called before assign(), or load()
Definition at line 612 of file oxarticle.php.
oxArticle.disableReminder | ( | ) |
Disables reminder functionality for article
Definition at line 1968 of file oxarticle.php.
oxArticle.getAccessoires | ( | ) |
Loads and returns array with accessoires information.
Definition at line 937 of file oxarticle.php.
oxArticle.getActiveCheckQuery | ( | $ | blForceCoreTable = null |
) |
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 493 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 1337 of file oxarticle.php.
oxArticle.getArticleLongDesc | ( | $ | sOxid = null |
) |
Get article long description
string | $sOxid Article ID |
Definition at line 2219 of file oxarticle.php.
oxArticle.getArticleRatingAverage | ( | ) |
oxArticle.getArticleUser | ( | ) |
oxArticle.getArticleVat | ( | ) |
oxArticle.getAttributes | ( | ) |
Loads and returns attribute list associated with this article
Definition at line 2292 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 |
Definition at line 1714 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 2330 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] |
Implements oxIUrl.
Definition at line 2438 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 |
Definition at line 1828 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 1370 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 |
Definition at line 1421 of file oxarticle.php.
oxArticle.getCrossSelling | ( | ) |
Loads and returns array with crosselling information.
Definition at line 923 of file oxarticle.php.
oxArticle.getCustomerAlsoBoughtThisProducts | ( | ) |
Loads and returns articles list, bought by same customer.
Definition at line 998 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 2153 of file oxarticle.php.
oxArticle.getDeliveryDate | ( | ) |
Returns formated delivery date. If the date is not set ('0000-00-00') returns false.
Definition at line 2682 of file oxarticle.php.
oxArticle.getDispSelList | ( | ) |
oxArticle.getDynImageDir | ( | ) |
oxArticle.getFileUrl | ( | ) |
oxArticle.getFNetPrice | ( | ) |
Returns formated product's NETTO price.
Definition at line 2721 of file oxarticle.php.
oxArticle.getFPrice | ( | ) |
oxArticle.getFTPrice | ( | ) |
oxArticle.getFullVariants | ( | $ | blRemoveNotOrderables = true , |
|
$ | blForceCoreTable = null | |||
) |
Returns variant list (list contains oxArticle objects)
bool | $blRemoveNotOrderables if true, removes from list not orderable articles, which are out of stock [optional] | |
bool | $blForceCoreTable if true forces core tabel use, default is false [optional] |
Definition at line 1299 of file oxarticle.php.
oxArticle.getIconUrl | ( | $ | iIndex = 0 |
) |
Returns article icon picture url. If no index specified, will return main icon url.
int | $iIndex picture index |
Definition at line 2823 of file oxarticle.php.
oxArticle.getItemKey | ( | ) |
Returns item key used with oxuserbasket
Definition at line 622 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 2347 of file oxarticle.php.
oxArticle.getLinkType | ( | ) |
oxArticle.getLongDesc | ( | ) |
get long description, parsed through smarty. should only be used by exports or so. In templates use [{oxeval var=$oProduct->getArticleLongDesc()->getRawValue()}]
Definition at line 2261 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
int | $iLang language id [optional] |
Definition at line 2378 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 1568 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 1548 of file oxarticle.php.
oxArticle.getMasterZoomPictureUrl | ( | $ | iIndex | ) |
Get master zoom picture url
int | $iIndex picture index |
Definition at line 4400 of file oxarticle.php.
oxArticle.getMdSubvariants | ( | ) |
Returns first level variants from multidimensional variants list
Definition at line 4345 of file oxarticle.php.
oxArticle.getMdVariants | ( | ) |
Returns multidimensional variant structure
Definition at line 4321 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 4385 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 2010 of file oxarticle.php.
oxArticle.getPictureUrl | ( | $ | iIndex = 1 |
) |
Returns article picture
int | $iIndex picture index |
Definition at line 2802 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 1738 of file oxarticle.php.
oxArticle.getPriceFromPrefix | ( | ) |
Returns string prefix (like "ab") if needed or empty string.
Definition at line 2893 of file oxarticle.php.
oxArticle.getPricePerUnit | ( | ) |
Returns formated price per unit (oxarticle._assignPrices())
Definition at line 2733 of file oxarticle.php.
oxArticle.getProductId | ( | ) |
Returns product id (oxid) (required for interface oxIArticle)
Definition at line 4228 of file oxarticle.php.
oxArticle.getProductParentId | ( | ) |
Returns product parent id (oxparentid)
Definition at line 4238 of file oxarticle.php.
oxArticle.getReviews | ( | ) |
Collects user written reviews about an article.
Definition at line 891 of file oxarticle.php.
oxArticle.getSearchableFields | ( | ) |
Returns an array of article object DB fields, without multilanguage.
Definition at line 728 of file oxarticle.php.
oxArticle.getSelections | ( | $ | iLimit = null , |
|
$ | aFilter = null | |||
) |
Returns product selections lists array (used in azure theme)
int | $iLimit if given - will load limited count of selections [optional] | |
array | $aFilter selection filter [optional] |
Definition at line 1150 of file oxarticle.php.
oxArticle.getSelectLists | ( | $ | sKeyPrefix = null |
) |
Returns all selectlists this article has (used in basic theme and oxbasket)
string | $sKeyPrefix Optionall key prefix |
Definition at line 1046 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 1322 of file oxarticle.php.
oxArticle.getSqlActiveSnippet | ( | $ | blForceCoreTable = null |
) |
Returns SQL select string with checks if items are available
bool | $blForceCoreTable forces core table usage (optional) |
Definition at line 581 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 4282 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 2458 of file oxarticle.php.
oxArticle.getStdTagLink | ( | $ | sTag | ) |
Returns standard product Tag URL
string | $sTag tag |
Definition at line 2478 of file oxarticle.php.
oxArticle.getStockCheckQuery | ( | $ | blForceCoreTable = null |
) |
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 522 of file oxarticle.php.
oxArticle.getStockStatus | ( | ) |
oxArticle.getTags | ( | ) |
oxArticle.getThumbnailUrl | ( | ) |
oxArticle.getToBasketLink | ( | ) |
oxArticle.getTPrice | ( | ) |
oxArticle.getVariantList | ( | ) |
Returns variant lists of current product
Definition at line 2778 of file oxarticle.php.
oxArticle.getVariants | ( | $ | blRemoveNotOrderables = true , |
|
$ | blForceCoreTable = null | |||
) |
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 1312 of file oxarticle.php.
oxArticle.getVariantSelections | ( | $ | aFilterIds = null , |
|
$ | sActVariantId = null , |
|||
$ | iLimit = 0 | |||
) |
Returns variants selections lists array
array | $aFilterIds ids of active selections [optional] | |
string | $sActVariantId active variant id [optional] | |
int | $iLimit limit variant lists count (if non zero, return limited number of multidimensional variant selections) |
Definition at line 1129 of file oxarticle.php.
oxArticle.getVariantsQuery | ( | $ | blRemoveNotOrderables, | |
$ | blForceCoreTable = null | |||
) |
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 557 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 1503 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 1531 of file oxarticle.php.
oxArticle.getZoomPictureUrl | ( | $ | iIndex = '' |
) |
Returns article zoom picture url
int | $iIndex picture index |
Definition at line 2868 of file oxarticle.php.
oxArticle.hasAmountPrice | ( | ) |
oxArticle.hasMdVariants | ( | ) |
Checks if article has multidimensional variants
Definition at line 1115 of file oxarticle.php.
oxArticle.inCategory | ( | $ | sCatNid | ) |
Checks if article is assigned to category $sCatNID.
string | $sCatNid category ID |
Definition at line 1596 of file oxarticle.php.
oxArticle.inPriceCategory | ( | $ | sCatNid | ) |
Checks if artickle is assigned to price category $sCatNID.
string | $sCatNid Price category ID |
Definition at line 4301 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 1609 of file oxarticle.php.
oxArticle.isBuyable | ( | ) |
oxArticle.isMdVariant | ( | ) |
Returns TRUE if product is multidimensional variant, and false if not
Definition at line 4268 of file oxarticle.php.
oxArticle.isMultilingualField | ( | $ | sFieldName | ) |
Returns true if the field is multilanguage
string | $sFieldName Field name |
Definition at line 744 of file oxarticle.php.
oxArticle.isNotBuyable | ( | ) |
oxArticle.isOnComparisonList | ( | ) |
Checks whether article is inluded in comparison list
Definition at line 680 of file oxarticle.php.
oxArticle.isOrderArticle | ( | ) |
Returns false if object is not derived from oxorderarticle class
Definition at line 4248 of file oxarticle.php.
oxArticle.isParentNotBuyable | ( | ) |
oxArticle.isVariant | ( | ) |
Returns TRUE if product is variant, and false if not
Definition at line 4258 of file oxarticle.php.
oxArticle.isVisible | ( | ) |
Checks if article has visible status. Returns TRUE if its visible
Definition at line 760 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 |
Definition at line 842 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 1023 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 2097 of file oxarticle.php.
oxArticle.reduceStock | ( | $ | dAmount, | |
$ | blAllowNegativeStock = false | |||
) |
reduce article stock. return the affected amount
double | $dAmount amount to reduce | |
bool | $blAllowNegativeStock are negative stocks allowed? |
Definition at line 1913 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, saves long description (oxArticle._saveArtLongDesc()) finally save the object using parent.save() method.
Definition at line 1981 of file oxarticle.php.
oxArticle.saveTags | ( | $ | sTags | ) |
Saves article tags
string | $sTags article tag |
Definition at line 2505 of file oxarticle.php.
oxArticle.setArticleLongDesc | ( | $ | sDesc, | |
$ | sOrigValue = null | |||
) |
Save article long description to oxartext table
string | $sDesc description to set | |
string | $sOrigValue base shop value, will be stored in oxField->orignalValue [optional] |
Definition at line 2274 of file oxarticle.php.
oxArticle.setArticleUser | ( | $ | oUser | ) |
sets article user
oxUser | $oUser user to set |
Definition at line 1801 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 2765 of file oxarticle.php.
oxArticle.setId | ( | $ | sId = null |
) |
Sets object ID, additionally sets $this->oxarticles__oxnid field value
string | $sId New ID |
Definition at line 474 of file oxarticle.php.
oxArticle.setItemKey | ( | $ | sItemKey | ) |
Sets item key used with oxuserbasket
string | $sItemKey Item key |
Definition at line 634 of file oxarticle.php.
oxArticle.setLinkType | ( | $ | iType | ) |
Resets details link
int | $iType type of link to load |
Definition at line 2390 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 704 of file oxarticle.php.
oxArticle.setNoVariantLoading | ( | $ | blLoadVariants | ) |
Disables/enables variant loading
bool | $blLoadVariants skip variant loading or not |
Definition at line 646 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 692 of file oxarticle.php.
oxArticle.setPrice | ( | oxPrice $ | oPrice | ) |
Sets the current oxPrice object
oxPrice | $oPrice the new price object |
Definition at line 1701 of file oxarticle.php.
oxArticle.setSelectlist | ( | $ | aSelList | ) |
Sets selectlists of current product
array | $aSelList selectlist |
Definition at line 2790 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 716 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 602 of file oxarticle.php.
oxArticle.skipDiscounts | ( | ) |
Checks if discount should be skipped for this article in basket. Returns true if yes.
Definition at line 1669 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 1938 of file oxarticle.php.
oxArticle.$_aArticleCats = array() [static, protected] |
Definition at line 335 of file oxarticle.php.
oxArticle.$_aArticleManufacturers = array() [static, protected] |
Definition at line 321 of file oxarticle.php.
oxArticle.$_aArticleVendors = array() [static, protected] |
Definition at line 328 of file oxarticle.php.
oxArticle.$_aCategoryCache = null [static, protected] |
Definition at line 390 of file oxarticle.php.
oxArticle.$_aCopyParentField [protected] |
array('oxarticles__oxnonmaterial', 'oxarticles__oxfreeshipping', 'oxarticles__oxremindactive')
Definition at line 353 of file oxarticle.php.
oxArticle.$_aDispSelList [protected] |
Definition at line 213 of file oxarticle.php.
oxArticle.$_aLoadedParents [static, protected] |
Definition at line 199 of file oxarticle.php.
oxArticle.$_aMediaUrls = null [protected] |
Definition at line 192 of file oxarticle.php.
oxArticle.$_aNonCopyParentFields [protected] |
array('oxarticles__oxinsert', 'oxarticles__oxtimestamp', 'oxarticles__oxnid', 'oxarticles__oxid', 'oxarticles__oxparentid')
Definition at line 342 of file oxarticle.php.
oxArticle.$_aPersistParam = null [protected] |
Definition at line 72 of file oxarticle.php.
oxArticle.$_aSelections = array() [static, protected] |
Definition at line 384 of file oxarticle.php.
oxArticle.$_aSelList [static, protected] |
Definition at line 206 of file oxarticle.php.
oxArticle.$_aSeoAddParams = array() [protected] |
Definition at line 258 of file oxarticle.php.
oxArticle.$_aSeoUrls = array() [protected] |
Definition at line 251 of file oxarticle.php.
oxArticle.$_aStdAddParams = array() [protected] |
Definition at line 265 of file oxarticle.php.
oxArticle.$_aStdUrls = array() [protected] |
Definition at line 244 of file oxarticle.php.
oxArticle.$_aVariants = null [protected] |
Definition at line 94 of file oxarticle.php.
oxArticle.$_aVariantSelections = array() [protected] |
Definition at line 378 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.$_blHasAmountPrice = null [static, protected] |
Definition at line 395 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.
Definition at line 117 of file oxarticle.php.
oxArticle.$_blIsOnComparisonList = false [protected] |
Definition at line 128 of file oxarticle.php.
oxArticle.$_blIsRangePrice = false [protected] |
Definition at line 185 of file oxarticle.php.
oxArticle.$_blIsSeoObject = true [protected] |
Definition at line 220 of file oxarticle.php.
oxArticle.$_blLoadParentData = false [protected] |
Variable used to force load parent data in export
Definition at line 159 of file oxarticle.php.
oxArticle.$_blLoadPrice = true [protected] |
Definition at line 141 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 146 of file oxarticle.php.
oxArticle.$_blSkipAssign = false [protected] |
Variable used to force load parent data in export
Definition at line 164 of file oxarticle.php.
oxArticle.$_blSkipDiscounts = null [protected] |
Definition at line 171 of file oxarticle.php.
oxArticle.$_blUseLazyLoading = true [protected] |
Definition at line 38 of file oxarticle.php.
oxArticle.$_dAmountPrice = null [protected] |
Definition at line 314 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 154 of file oxarticle.php.
oxArticle.$_iLinkType = 0 [protected] |
Definition at line 237 of file oxarticle.php.
oxArticle.$_iStockStatus = null [protected] |
Definition at line 293 of file oxarticle.php.
oxArticle.$_oAmountPriceInfo = null [protected] |
Definition at line 307 of file oxarticle.php.
oxArticle.$_oAmountPriceList = null [protected] |
Definition at line 227 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 177 of file oxarticle.php.
oxArticle.$_oLongDesc = null [protected] |
Definition at line 369 of file oxarticle.php.
oxArticle.$_oMdVariants = null [protected] |
Definition at line 362 of file oxarticle.php.
oxArticle.$_oPrice = null [protected] |
Definition at line 58 of file oxarticle.php.
oxArticle.$_oTPrice = null [protected] |
Definition at line 300 of file oxarticle.php.
oxArticle.$_oUser = null [protected] |
Definition at line 134 of file oxarticle.php.
oxArticle.$_sClassName = 'oxarticle' [protected] |
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 272 of file oxarticle.php.
oxArticle.$_sItemKey [protected] |
Definition at line 45 of file oxarticle.php.
oxArticle.$_sMoreDetailLink = null [protected] |
Definition at line 279 of file oxarticle.php.
oxArticle.$_sToBasketLink = null [protected] |
Definition at line 286 of file oxarticle.php.