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 |
) |
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 453 of file oxarticle.php.
oxArticle.__get | ( | $ | sName | ) |
Magic getter, deals with values which are loaded on demand. Additionally it sets default value for unknown picture fields
string | $sName Variable name |
Definition at line 472 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 489 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 3816 of file oxarticle.php.
oxArticle._assignComparisonListFlag | ( | ) | [protected] |
Adds a flag if article is on comparisonlist.
Definition at line 4282 of file oxarticle.php.
oxArticle._assignDynImageDir | ( | ) | [protected] |
assigns dynimagedir to article
Definition at line 4267 of file oxarticle.php.
oxArticle._assignNotBuyableParent | ( | ) | [protected] |
if we have variants then depending on config option the parent may be non buyable
Definition at line 4171 of file oxarticle.php.
oxArticle._assignParentDependFields | ( | ) | [protected] |
Set parent field value to child - variants
Definition at line 4929 of file oxarticle.php.
oxArticle._assignParentFieldValue | ( | $ | sFieldName | ) | [protected] |
Assigns parent field values to article
string | $sFieldName field name |
Definition at line 4104 of file oxarticle.php.
oxArticle._assignParentFieldValues | ( | ) | [protected] |
Assigns parent field values to article
Definition at line 4154 of file oxarticle.php.
oxArticle._assignPersistentParam | ( | ) | [protected] |
assigns persistent param to article
Definition at line 4255 of file oxarticle.php.
oxArticle._assignStock | ( | ) | [protected] |
Assigns stock status to article
Definition at line 4184 of file oxarticle.php.
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 3453 of file oxarticle.php.
oxArticle._deletePics | ( | ) | [protected] |
Delete pics
Definition at line 4422 of file oxarticle.php.
oxArticle._deleteRecords | ( | $ | sOXID | ) | [protected] |
Deletes records in database
string | $sOXID Article ID |
Definition at line 4343 of file oxarticle.php.
oxArticle._deleteVariantRecords | ( | $ | sOXID | ) | [protected] |
Deletes variant records
string | $sOXID Article ID |
Definition at line 4401 of file oxarticle.php.
oxArticle._fillAmountPriceList | ( | $ | aAmPriceList | ) | [protected] |
Fills amount price list object and sets amount price for article object
array | $aAmPriceList Amount price list |
Definition at line 3703 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 3914 of file oxarticle.php.
oxArticle._generateSearchStrForCustomerBought | ( | ) | [protected] |
Generates SQL select string for getCustomerAlsoBoughtThisProduct
Definition at line 3939 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 3999 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 3891 of file oxarticle.php.
oxArticle._getActiveCategorySelectSnippet | ( | ) | [protected] |
Returns active category select snippet
Definition at line 3413 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 3645 of file oxarticle.php.
oxArticle._getAmountPriceList | ( | ) | [protected] |
Collecting assigned to article amount-price list
Definition at line 4028 of file oxarticle.php.
oxArticle._getAttribsString | ( | &$ | sAttributeSql, | |
&$ | iCnt | |||
) | [protected] |
gets attribs string
string | &$sAttributeSql Attribute selection snippet | |
int | &$iCnt The number of selected attributes |
Definition at line 3832 of file oxarticle.php.
oxArticle._getCategoryIdsSelect | ( | $ | blActCats = false |
) | [protected] |
Returns query for article categories select
bool | $blActCats select categories if all parents are active |
Definition at line 3387 of file oxarticle.php.
oxArticle._getCopyParentFields | ( | ) | [protected] |
Returns array of fields which should not changed in variants
Definition at line 4921 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 3623 of file oxarticle.php.
oxArticle._getPrice | ( | ) | [protected] |
oxArticle._getPriceForView | ( | $ | oPrice | ) | [protected] |
Depending on view mode prepare price for viewing
oxPrice | $oPrice price object |
Definition at line 4661 of file oxarticle.php.
oxArticle._getPriceObject | ( | $ | blCalculationModeNetto = null |
) | [protected] |
Depending on view mode prepare oxPrice object
bool | $blCalculationModeNetto - if calculation mode netto - true |
Definition at line 4636 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 3431 of file oxarticle.php.
oxArticle._getSimList | ( | $ | sAttributeSql, | |
$ | iCnt | |||
) | [protected] |
Gets similar list.
string | $sAttributeSql Attribute selection snippet | |
int | $iCnt Similar list article count |
Definition at line 3857 of file oxarticle.php.
oxArticle._getSubShopVarMaxPrice | ( | ) | [protected] |
oxArticle._getSubShopVarMinPrice | ( | ) | [protected] |
oxArticle._getUserPriceSufix | ( | ) | [protected] |
oxArticle._getVariantsIds | ( | $ | blActiveVariants = true |
) | [protected] |
Collects and returns active/all variant ids of article.
bool | $blActiveVariants Parameter to load only active variants. |
Definition at line 3773 of file oxarticle.php.
oxArticle._getVarMaxPrice | ( | ) | [protected] |
oxArticle._getVarMinPrice | ( | ) | [protected] |
oxArticle._hasAnyVariant | ( | $ | blForceCoreTable = null |
) | [protected] |
Checks if parent has ANY variant assigned
bool | $blForceCoreTable force core table usage |
Definition at line 3484 of file oxarticle.php.
oxArticle._hasMasterImage | ( | $ | iIndex | ) | [protected] |
Checks if article has uploaded master image for selected picture
int | $iIndex master picture index |
Definition at line 4589 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 4299 of file oxarticle.php.
oxArticle._isFieldEmpty | ( | $ | sFieldName | ) | [protected] |
Detects if field is empty.
string | $sFieldName Field name |
Definition at line 4060 of file oxarticle.php.
oxArticle._isImageField | ( | $ | sFieldName | ) | [protected] |
Detects if field is an image field by field name
string | $sFieldName Field name |
Definition at line 4144 of file oxarticle.php.
oxArticle._isPriceViewModeNetto | ( | ) | [protected] |
Checks and return true if price view mode is netto
Definition at line 4617 of file oxarticle.php.
oxArticle._isStockStatusChanged | ( | ) | [protected] |
Check if stock status has changed since loading the article
Definition at line 3504 of file oxarticle.php.
oxArticle._isVisibilityChanged | ( | ) | [protected] |
Check if visibility has changed since loading the article
Definition at line 3514 of file oxarticle.php.
oxArticle._loadFromDb | ( | $ | sOXID | ) | [protected] |
Get data from db
string | $sOXID id |
Definition at line 4883 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 table use, default is false [optional] |
Definition at line 3275 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 3604 of file oxarticle.php.
oxArticle._modifySelectListPrice | ( | $ | dPrice, | |
$ | aChosenList = null | |||
) | [protected] |
Modifies article price according to selected select list value
double | $dPrice Modifiable price | |
array | $aChosenList Selection list array |
Definition at line 3673 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 trigger.
string | $sOxid object to reset id ID | |
string | $sVendorId Vendor ID | |
string | $sManufacturerId Manufacturer ID |
Definition at line 4450 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 4512 of file oxarticle.php.
oxArticle._onChangeUpdateStock | ( | $ | sParentID | ) | [protected] |
Updates article stock. This method is supposed to be called on article change trigger.
string | $sParentID product parent id |
Definition at line 4474 of file oxarticle.php.
oxArticle._onChangeUpdateVarCount | ( | $ | sParentID | ) | [protected] |
Updates variant count. This method is supposed to be called on article change trigger.
string | $sParentID Parent ID |
Definition at line 4529 of file oxarticle.php.
oxArticle._preparePrice | ( | $ | dPrice, | |
$ | dVat, | |||
$ | blCalculationModeNetto = null | |||
) | [protected] |
Depending on view mode prepare price before calculation
double | $dPrice - price | |
double | $dVat - VAT | |
bool | $blCalculationModeNetto - if calculation mode netto - true |
Definition at line 4682 of file oxarticle.php.
oxArticle._saveArtLongDesc | ( | ) | [protected] |
inserts article long description to artextends table
Definition at line 3524 of file oxarticle.php.
oxArticle._saveSortingFieldValuesOnLoad | ( | ) | [protected] |
Saves values of sorting fields on article load.
Definition at line 4944 of file oxarticle.php.
oxArticle._selectCategoryIds | ( | $ | sSql, | |
$ | sField | |||
) | [protected] |
Selects category IDs from given SQL statement and ID field name
string | $sSql sql statement | |
string | $sField category ID field name |
Definition at line 3363 of file oxarticle.php.
oxArticle._setVarMinMaxPrice | ( | $ | sParentId | ) | [protected] |
Updates variant min price. This method is supposed to be called on article change trigger.
string | $sParentId Parent ID |
Definition at line 4547 of file oxarticle.php.
oxArticle._skipSaveFields | ( | ) | [protected] |
Removes object data fields (oxarticles__oxtimestamp, oxarticles__oxparentid, oxarticles__oxinsert).
Definition at line 3578 of file oxarticle.php.
oxArticle._update | ( | ) | [protected] |
Executes oxarticle._skipSaveFields() and updates article information
Definition at line 4319 of file oxarticle.php.
oxArticle._updateParentDependFields | ( | ) | [protected] |
Set parent field value to child - variants in DB
Definition at line 4899 of file oxarticle.php.
oxArticle.addToRatingAverage | ( | $ | iRating | ) |
Calculates and saves product rating average
integer | $iRating new rating value |
Definition at line 1105 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 2466 of file oxarticle.php.
oxArticle.appendStdLink | ( | $ | sAddParams, | |
$ | iLang = null | |||
) |
Appends article dynamic url with additional request parameters
string | $sAddParams additional parameters which needs to be added to product url | |
int | $iLang language id |
Definition at line 2571 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 2964 of file oxarticle.php.
oxArticle.applyVats | ( | oxPrice $ | oPrice | ) |
apply article and article use
oxPrice | $oPrice target price |
Definition at line 2954 of file oxarticle.php.
oxArticle.assign | ( | $ | aRecord | ) |
Assigns to oxarticle object some base parameters/values (such as detaillink, moredetaillink, etc).
array | $aRecord Array representing current field values |
Definition at line 1017 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 2324 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 2024 of file oxarticle.php.
oxArticle.disablePriceLoad | ( | ) |
Disables article price loading. Should be called before assign(), or load()
Definition at line 678 of file oxarticle.php.
oxArticle.disableReminder | ( | ) |
Disables reminder functionality for article
Definition at line 2115 of file oxarticle.php.
oxArticle.enablePriceLoad | ( | ) |
Enable article price loading, if disabled.
Definition at line 686 of file oxarticle.php.
oxArticle.getAccessoires | ( | ) |
Loads and returns array with accessories information.
Definition at line 1227 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 531 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 1556 of file oxarticle.php.
oxArticle.getArticleFiles | ( | $ | blAddFromParent = false |
) |
Return article downloadable file list (oxlist of oxfile)
bool | $blAddFromParent - return with parent files if not buyable |
Definition at line 3212 of file oxarticle.php.
oxArticle.getArticleRatingAverage | ( | $ | blIncludeVariants = false |
) |
Returns product rating average
bool | $blIncludeVariants - include variant ratings |
Definition at line 1146 of file oxarticle.php.
oxArticle.getArticleRatingCount | ( | $ | blIncludeVariants = false |
) |
Returns product rating count
bool | $blIncludeVariants - include variant ratings |
Definition at line 1164 of file oxarticle.php.
oxArticle.getArticleUser | ( | ) |
oxArticle.getArticleVat | ( | ) |
oxArticle.getAttributes | ( | ) |
Loads and returns attribute list associated with this article
Definition at line 2434 of file oxarticle.php.
oxArticle.getAttributesDisplayableInBasket | ( | ) |
Loads and returns displayable in basket/order attributes list associated with this article
Definition at line 2449 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 1898 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 2592 of file oxarticle.php.
oxArticle.getBasketPrice | ( | $ | dAmount, | |
$ | aSelList, | |||
$ | oBasket | |||
) |
Creates, calculates and returns oxPrice object for basket product.
float | $dAmount Amount | |
string | $aSelList Selection list | |
object | $oBasket User shopping basket object |
Definition at line 1991 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 1589 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 1640 of file oxarticle.php.
oxArticle.getCrossSelling | ( | ) |
Loads and returns array with cross selling information.
Definition at line 1213 of file oxarticle.php.
oxArticle.getCustomerAlsoBoughtThisProducts | ( | ) |
Loads and returns articles list, bought by same customer.
Definition at line 1288 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 2309 of file oxarticle.php.
oxArticle.getDeliveryDate | ( | ) |
Returns formatted delivery date. If the date is not set ('0000-00-00') returns false.
Definition at line 2749 of file oxarticle.php.
oxArticle.getDispSelList | ( | ) |
oxArticle.getDynImageDir | ( | ) |
oxArticle.getFMinPrice | ( | ) |
Returns formatted article min price
Definition at line 851 of file oxarticle.php.
oxArticle.getFNetPrice | ( | ) |
Returns formatted product's NETTO price.
Definition at line 2811 of file oxarticle.php.
oxArticle.getFPrice | ( | ) |
Returns formatted product's price.
Definition at line 2782 of file oxarticle.php.
oxArticle.getFTPrice | ( | ) |
Returns rounded T price.
Definition at line 2765 of file oxarticle.php.
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 table use, default is false [optional] |
Definition at line 1517 of file oxarticle.php.
oxArticle.getFUnitPrice | ( | ) |
Returns formatted price per unit
Definition at line 810 of file oxarticle.php.
oxArticle.getFVarMinPrice | ( | ) |
Returns formatted min article variant price
Definition at line 869 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 2887 of file oxarticle.php.
oxArticle.getItemKey | ( | ) |
Returns item key used with oxuserbasket
Definition at line 696 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 2505 of file oxarticle.php.
oxArticle.getLinkType | ( | ) |
oxArticle.getLoadParentData | ( | ) |
oxArticle.getLongDesc | ( | ) |
get long description, parsed through smarty. should only be used by exports or so. In templates use [{oxeval var=$oProduct->getLongDescription()->getRawValue()}]
Definition at line 2409 of file oxarticle.php.
oxArticle.getLongDescription | ( | ) |
Get article long description
Definition at line 2374 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 2536 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 1731 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 1710 of file oxarticle.php.
oxArticle.getMasterZoomPictureUrl | ( | $ | iIndex | ) |
Get master zoom picture url
int | $iIndex picture index |
Definition at line 3178 of file oxarticle.php.
oxArticle.getMdSubvariants | ( | ) |
Returns first level variants from multidimensional variants list
Definition at line 3149 of file oxarticle.php.
oxArticle.getMdVariants | ( | ) |
Returns multidimensional variant structure
Definition at line 3125 of file oxarticle.php.
oxArticle.getMediaUrls | ( | ) |
oxArticle.getMinPrice | ( | ) |
Returns article min price in calculation included variants
Definition at line 910 of file oxarticle.php.
oxArticle.getMoreDetailLink | ( | ) |
oxArticle.getParentArticle | ( | ) |
oxArticle.getParentId | ( | ) |
Returns product parent id (oxparentid)
Definition at line 3040 of file oxarticle.php.
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 3162 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 2162 of file oxarticle.php.
oxArticle.getPictureUrl | ( | $ | iIndex = 1 |
) |
Returns article picture
int | $iIndex picture index |
Definition at line 2865 of file oxarticle.php.
oxArticle.getPrice | ( | $ | dAmount = 1 |
) |
Calculates and returns price of article (adds taxes and discounts).
float | $dAmount article amount |
Definition at line 1923 of file oxarticle.php.
oxArticle.getProductId | ( | ) |
Returns product id (oxid) (required for interface oxIArticle)
Definition at line 3030 of file oxarticle.php.
oxArticle.getReviews | ( | ) |
Collects user written reviews about an article.
Definition at line 1181 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 1457 of file oxarticle.php.
oxArticle.getSelectLists | ( | $ | sKeyPrefix = null |
) |
Returns all selectlists this article has (used in oxbasket)
string | $sKeyPrefix Optional key prefix |
Definition at line 1337 of file oxarticle.php.
oxArticle.getSimilarProducts | ( | ) |
oxArticle.getSimpleVariants | ( | ) |
Simple way to get variants without querying oxArticle table first. This is basically used for lists.
Definition at line 1541 of file oxarticle.php.
oxArticle.getSize | ( | ) |
Return Size of product: length*width*height
Definition at line 627 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 653 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 3084 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 2613 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 560 of file oxarticle.php.
oxArticle.getStockStatus | ( | ) |
oxArticle.getThumbnailUrl | ( | $ | bSsl = null |
) |
Returns article thumbnail picture url
bool | $bSsl to force SSL |
Definition at line 2915 of file oxarticle.php.
oxArticle.getToBasketLink | ( | ) |
oxArticle.getTPrice | ( | ) |
oxArticle.getUnitName | ( | ) |
Returns oxarticles__oxunitname value processed by oxLang.translateString()
Definition at line 3198 of file oxarticle.php.
oxArticle.getUnitPrice | ( | ) |
oxArticle.getUnitQuantity | ( | ) |
oxArticle.getVariantIds | ( | $ | blActiveVariants = true |
) |
Collects and returns active/all variant ids of article.
bool | $blActiveVariants Parameter to load only active variants. |
Definition at line 3740 of file oxarticle.php.
oxArticle.getVariants | ( | $ | blRemoveNotOrderables = true , |
|
$ | blForceCoreTable = null | |||
) |
Collects and returns article variants. Note: Only active variants are returned by this method. If you need full variant list use oxArticle.getAdminVariants()
bool | $blRemoveNotOrderables if true, removes from list not orderable articles, which are out of stock | |
bool | $blForceCoreTable if true forces core table use, default is false [optional] |
Definition at line 1531 of file oxarticle.php.
oxArticle.getVariantsCount | ( | ) |
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 1430 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 595 of file oxarticle.php.
oxArticle.getVarMinPrice | ( | ) |
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 1667 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 1692 of file oxarticle.php.
oxArticle.getWeight | ( | ) |
oxArticle.getZoomPictureUrl | ( | $ | iIndex = '' |
) |
Returns article zoom picture url
int | $iIndex picture index |
Definition at line 2938 of file oxarticle.php.
oxArticle.hasAmountPrice | ( | ) |
oxArticle.hasDownloadableAgreement | ( | ) |
Returns if article has downloadable agreement with which customer will have to agree.
Definition at line 1416 of file oxarticle.php.
oxArticle.hasIntangibleAgreement | ( | ) |
Returns if article has intangible agreement with which customer will have to agree.
Definition at line 1406 of file oxarticle.php.
oxArticle.hasMdVariants | ( | ) |
Checks if article has multidimensional variants
Definition at line 1396 of file oxarticle.php.
oxArticle.hasSortingFieldsChanged | ( | ) |
Checks whether sorting fields changed from last article loading.
Definition at line 1083 of file oxarticle.php.
oxArticle.inCategory | ( | $ | sCatNid | ) |
Checks if article is assigned to category $sCatNID.
string | $sCatNid category ID |
Definition at line 1760 of file oxarticle.php.
oxArticle.inPriceCategory | ( | $ | sCatNid | ) |
Checks if article is assigned to price category $sCatNID.
string | $sCatNid Price category ID |
Definition at line 3104 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 1773 of file oxarticle.php.
oxArticle.isBuyable | ( | ) |
oxArticle.isDownloadable | ( | ) |
Returns oxarticles__oxisdownloadable value
Definition at line 3239 of file oxarticle.php.
oxArticle.isInList | ( | ) |
Checks whether object is in list or not It's needed for oxArticle so that it can pass this to widgets
Definition at line 500 of file oxarticle.php.
oxArticle.isMdVariant | ( | ) |
Returns TRUE if product is multidimensional variant, and false if not
Definition at line 3070 of file oxarticle.php.
oxArticle.isMultilingualField | ( | $ | sFieldName | ) |
Returns true if the field is multilanguage
string | $sFieldName Field name |
Definition at line 793 of file oxarticle.php.
oxArticle.isNotBuyable | ( | ) |
oxArticle.isOnComparisonList | ( | ) |
Checks whether article is inluded in comparison list
Definition at line 750 of file oxarticle.php.
oxArticle.isOrderArticle | ( | ) |
Returns false if object is not derived from oxorderarticle class
Definition at line 3050 of file oxarticle.php.
oxArticle.isParentNotBuyable | ( | ) |
oxArticle.isRangePrice | ( | ) |
Returns true if article has variant with different price
Definition at line 937 of file oxarticle.php.
oxArticle.isVariant | ( | ) |
Returns TRUE if product is variant, and false if not
Definition at line 3060 of file oxarticle.php.
oxArticle.isVisible | ( | ) |
Checks if article has visible status. Returns TRUE if its visible
Definition at line 977 of file oxarticle.php.
oxArticle.load | ( | $ | sOXID | ) |
Loads object data from DB (object data ID must be passed to method). Converts dates (oxarticle.oxarticles__oxinsert) to international format (oxutils.php oxRegistry.get("oxUtilsDate")->formatDBDate(...)). Returns true if article was loaded successfully.
string | $sOXID Article object ID |
Definition at line 1055 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 1313 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 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 2250 of file oxarticle.php.
oxArticle.reduceStock | ( | $ | dAmount, | |
$ | blAllowNegativeStock = false | |||
) |
Reduce article stock. return the affected amount
float | $dAmount amount to reduce | |
bool | $blAllowNegativeStock are negative stocks allowed? |
Definition at line 2061 of file oxarticle.php.
oxArticle.resetParent | ( | ) |
Changes article variant to parent article
Definition at line 2142 of file oxarticle.php.
oxArticle.resetRemindStatus | ( | ) |
Resets oxremindactive status. If remindActive status is 2, reminder is already sent.
Definition at line 2795 of file oxarticle.php.
oxArticle.save | ( | ) |
(oxArticle._saveArtLongDesc()) save the object using parent.save() method.
Definition at line 2127 of file oxarticle.php.
oxArticle.setArticleLongDesc | ( | $ | sDesc | ) |
Save article long description to oxartext table
string | $sDesc description to set |
Definition at line 2421 of file oxarticle.php.
oxArticle.setArticleUser | ( | $ | oUser | ) |
sets article user
oxUser | $oUser user to set |
Definition at line 1963 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 2843 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 512 of file oxarticle.php.
oxArticle.setItemKey | ( | $ | sItemKey | ) |
Sets item key used with oxuserbasket
string | $sItemKey Item key |
Definition at line 706 of file oxarticle.php.
oxArticle.setLinkType | ( | $ | iType | ) |
Resets details link
int | $iType type of link to load |
Definition at line 2546 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 770 of file oxarticle.php.
oxArticle.setNoVariantLoading | ( | $ | blLoadVariants | ) |
Disables/enables variant loading
bool | $blLoadVariants skip variant loading or not |
Definition at line 716 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 760 of file oxarticle.php.
oxArticle.setPrice | ( | oxPrice $ | oPrice | ) |
Sets the current oxPrice object
oxPrice | $oPrice the new price object |
Definition at line 1885 of file oxarticle.php.
oxArticle.setRangePrice | ( | $ | blIsRangePrice = true |
) |
Setter to set if article has range price
bool | $blIsRangePrice - true if range, else false |
Definition at line 967 of file oxarticle.php.
oxArticle.setRatingAverage | ( | $ | iRating | ) |
Set product rating average
integer | $iRating new rating value |
Definition at line 1124 of file oxarticle.php.
oxArticle.setRatingCount | ( | $ | iRatingCnt | ) |
Set product rating count
integer | $iRatingCnt new rating count |
Definition at line 1134 of file oxarticle.php.
oxArticle.setSelectlist | ( | $ | aSelList | ) |
Sets selectlists of current product
array | $aSelList selectlist |
Definition at line 2853 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 670 of file oxarticle.php.
oxArticle.skipDiscounts | ( | ) |
Checks if discount should be skipped for this article in basket. Returns true if yes.
Definition at line 1854 of file oxarticle.php.
oxArticle.updateSoldAmount | ( | $ | dAmount = 0 |
) |
Recursive function. Updates quantity of sold articles. Return true on success
float | $dAmount Number of articles sold |
Definition at line 2087 of file oxarticle.php.
oxArticle.updateVariantsRemind | ( | ) |
Updates article variants oxremindactive field, as variants inherit this setting from parent
Definition at line 3006 of file oxarticle.php.
oxArticle.$_aArticleCats = array() [static, protected] |
Definition at line 364 of file oxarticle.php.
oxArticle.$_aArticleFiles = null [protected] |
Definition at line 436 of file oxarticle.php.
oxArticle.$_aArticleManufacturers = array() [static, protected] |
Definition at line 350 of file oxarticle.php.
oxArticle.$_aArticleVendors = array() [static, protected] |
Definition at line 357 of file oxarticle.php.
oxArticle.$_aCategoryCache = null [static, protected] |
Definition at line 422 of file oxarticle.php.
oxArticle.$_aCopyParentField [protected] |
array('oxarticles__oxnonmaterial', 'oxarticles__oxfreeshipping', 'oxarticles__oxisdownloadable', 'oxarticles__oxshowcustomagreement')
Definition at line 382 of file oxarticle.php.
oxArticle.$_aDispSelList [protected] |
Definition at line 228 of file oxarticle.php.
oxArticle.$_aLoadedParents [static, protected] |
Definition at line 214 of file oxarticle.php.
oxArticle.$_aMediaUrls = null [protected] |
Definition at line 207 of file oxarticle.php.
oxArticle.$_aNonCopyParentFields [protected] |
array('oxarticles__oxinsert', 'oxarticles__oxtimestamp', 'oxarticles__oxnid', 'oxarticles__oxid', 'oxarticles__oxparentid')
Definition at line 371 of file oxarticle.php.
oxArticle.$_aPersistParam = null [protected] |
Definition at line 84 of file oxarticle.php.
oxArticle.$_aSelections = array() [static, protected] |
Definition at line 415 of file oxarticle.php.
oxArticle.$_aSelList [static, protected] |
Definition at line 221 of file oxarticle.php.
oxArticle.$_aSeoAddParams = array() [protected] |
Definition at line 273 of file oxarticle.php.
oxArticle.$_aSeoUrls = array() [protected] |
Definition at line 266 of file oxarticle.php.
oxArticle.$_aSortingFieldsOnLoad = array() [protected] |
Definition at line 315 of file oxarticle.php.
oxArticle.$_aStdAddParams = array() [protected] |
Definition at line 280 of file oxarticle.php.
oxArticle.$_aStdUrls = array() [protected] |
Definition at line 259 of file oxarticle.php.
oxArticle.$_aVariants = null [protected] |
Definition at line 106 of file oxarticle.php.
oxArticle.$_aVariantSelections = array() [protected] |
Definition at line 408 of file oxarticle.php.
oxArticle.$_aVariantsWithNotOrderables = null [protected] |
Definition at line 113 of file oxarticle.php.
oxArticle.$_blAllowEmptyParentId = false [protected] |
Variable used to determine if setting parentId to empty value is allowed
Definition at line 174 of file oxarticle.php.
oxArticle.$_blCalcPrice = true [protected] |
Definition at line 48 of file oxarticle.php.
oxArticle.$_blCanUpdateAnyField = null [protected] |
Definition at line 443 of file oxarticle.php.
oxArticle.$_blHasAmountPrice = null [static, protected] |
Definition at line 429 of file oxarticle.php.
oxArticle.$_blHasMdVariants = false [protected] |
$_blHasVariants is set to true if article has multidimensional variants.
Definition at line 134 of file oxarticle.php.
oxArticle.$_blHasVariants = false [protected] |
$_blHasVariants is set to true if article has any variants.
Definition at line 129 of file oxarticle.php.
oxArticle.$_blIsOnComparisonList = false [protected] |
Definition at line 141 of file oxarticle.php.
oxArticle.$_blIsRangePrice = null [protected] |
Definition at line 200 of file oxarticle.php.
oxArticle.$_blIsSeoObject = true [protected] |
Definition at line 235 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.$_blLoadPrice = true [protected] |
Definition at line 156 of file oxarticle.php.
oxArticle.$_blLoadVariants = true [protected] |
Definition at line 99 of file oxarticle.php.
oxArticle.$_blNotBuyable = false [protected] |
Definition at line 91 of file oxarticle.php.
oxArticle.$_blNotBuyableParent = false [protected] |
Definition at line 123 of file oxarticle.php.
oxArticle.$_blSkipAssign = false [protected] |
Variable used to force load parent data in export
Definition at line 179 of file oxarticle.php.
oxArticle.$_blSkipDiscounts = null [protected] |
Definition at line 186 of file oxarticle.php.
oxArticle.$_blUseLazyLoading = true [protected] |
Definition at line 33 of file oxarticle.php.
oxArticle.$_dAmountPrice = null [protected] |
Definition at line 343 of file oxarticle.php.
oxArticle.$_dArticleVat = null [protected] |
Definition at line 77 of file oxarticle.php.
oxArticle.$_dVarMaxPrice = null [protected] |
Definition at line 70 of file oxarticle.php.
oxArticle.$_dVarMinPrice = null [protected] |
Definition at line 63 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.$_iLinkType = 0 [protected] |
Definition at line 252 of file oxarticle.php.
oxArticle.$_iStockStatus = null [protected] |
Definition at line 322 of file oxarticle.php.
oxArticle.$_iStockStatusOnLoad = null [protected] |
Definition at line 308 of file oxarticle.php.
oxArticle.$_oAmountPriceInfo = null [protected] |
Definition at line 336 of file oxarticle.php.
oxArticle.$_oAmountPriceList = null [protected] |
Definition at line 242 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 192 of file oxarticle.php.
oxArticle.$_oLongDesc = null [protected] |
Definition at line 399 of file oxarticle.php.
oxArticle.$_oMdVariants = null [protected] |
Definition at line 392 of file oxarticle.php.
oxArticle.$_oPrice = null [protected] |
Definition at line 55 of file oxarticle.php.
oxArticle.$_oTPrice = null [protected] |
Definition at line 329 of file oxarticle.php.
oxArticle.$_oUser = null [protected] |
Definition at line 148 of file oxarticle.php.
oxArticle.$_sClassName = 'oxarticle' [protected] |
Definition at line 26 of file oxarticle.php.
oxArticle.$_sDynImageDir = null [protected] |
Definition at line 287 of file oxarticle.php.
oxArticle.$_sItemKey [protected] |
Definition at line 40 of file oxarticle.php.
oxArticle.$_sMoreDetailLink = null [protected] |
Definition at line 294 of file oxarticle.php.
oxArticle.$_sToBasketLink = null [protected] |
Definition at line 301 of file oxarticle.php.