tx_commerce_article Class Reference

Inheritance diagram for tx_commerce_article:

List of all members.

Public Member Functions
	tx_commerce_article ()
	init ($uid, $lang_uid=0)
	get_title ()
	get_classname ()
	getSubtitle ()
	get_description_extra ()
	getPossiblePriceUids ()
	getPriceScales ($startCount=1)
	getActualPriceforScaleUid ($count)
	getPriceScaleObjects ($startCount=1)
	get_price_gross ()
	get_price_net ()
	get_article_price_uid ()
	getDeliveryCostNet ()
	getDeliveryCostGross ()
	getPriceUid ()
	getPriceObj ()
	get_tax ()
	getEanCode ()
	getRelatedPage ()
	getArticleTypeUid ()
	getImages ()
	getSupplierUid ()
	getSupplierName ()
	load_data ()
	calculateDeliveryCosts ()
	get_parent_product ()
	getParentProductUid ()
	getOrdernumber ()
	get_article_attributes ()
	getAttributeValue ($attribute_uid, $valueListAsUid=false)
	getSpecialPrice ()
	load_prices ()
	returnAssocArray ($prefix='')
	hasStock ($wantedArticles=0, $subType= '', $serviceChain=array())
	getStock ($subType= '', $serviceChain=array())
	reduceStock ($wantedArticles=0, $subType= '', $serviceChain=array())
	get_images ()
	get_article_type_uid ()
	get_ordernumber ()
	get_subtitle ()
	get_eancode ()
	getPricsScaleObjects ($startCount=1)
Public Attributes
	$title
	$subtitle
	$description_extra
	$tax
	$images = array()
	$images_array = array()
	$ordernumber
	$eancode
	$article_type_uid
	$deliveryCostNet
	$deliveryCostGross
	$price_uid
	$prices_uids = array()
	$price
	$prices_loaded = false
	$stock = true
	$classname

---

Constructor & Destructor Documentation

tx_commerce_article::tx_commerce_article (   )

Construcroe Method, calles init method Parameters: uid  integer uid of article lang_uid  integer language uid, default 0

---

Member Function Documentation

tx_commerce_article::calculateDeliveryCosts (   )

Calculates the Net deliverycost for this article Called by $this->load_data() Returns: delivery_cost Just one Hook as there is no sence for mor than one delievery cost claculation

tx_commerce_article::get_article_attributes (   )

Returns the article attributes array ( attribut_uid => array ('title =>' $title, 'value' => $value, 'unit' => $unit), ... ) Author: Sebastian Boettger - Cross Content Media <dev@cross-content.com> Returns: array of arrays

tx_commerce_article::get_article_price_uid (   )

Returns: int valid priceid public

tx_commerce_article::get_article_type_uid (   )

Returns: integer article_type public See also: getArticleTypeUid()

tx_commerce_article::get_classname (   )

tx_commerce_article::get_description_extra (   )

Returns: text description_extra+ public

tx_commerce_article::get_eancode (   )

Returns: string eancode public See also: getEanCode()

tx_commerce_article::get_images (   )

Returns an Array of Images Returns: array; public

tx_commerce_article::get_ordernumber (   )

Returns: string ordernumber public See also: getOrdernumber()

tx_commerce_article::get_parent_product (   )

returns the parent product as object See also: tx_commerce_product Returns: product object

tx_commerce_article::get_price_gross (   )

Returns: double price_gross use locallang public

tx_commerce_article::get_price_net (   )

Returns: double price_net use locallang public

tx_commerce_article::get_subtitle (   )

Returns: string subtitle public ; See also: getSubtitle()

tx_commerce_article::get_tax (   )

Returns: double tax public

tx_commerce_article::get_title (   )

Returns: string title of article public

tx_commerce_article::getActualPriceforScaleUid (  $  count  )

Get the priceUid for a sepcific amount for this article Parameters: count  Count for this article Returns: integer Price Uid When only one scale is given, this should be valid :-)

tx_commerce_article::getArticleTypeUid (   )

Returns: integer article_type public

tx_commerce_article::getAttributeValue (  $  attribute_uid, $  valueListAsUid = false )

Gets the Value from one distinct attribute of this article Returns: Attribute Value

tx_commerce_article::getDeliveryCostGross (   )

Returns: int Delivery Cost for this article public Since: 06.10.2005

tx_commerce_article::getDeliveryCostNet (   )

Returns: int Delivery Cost for this article public Since: 06.10.2005

tx_commerce_article::getEanCode (   )

Returns: string eancode public

tx_commerce_article::getImages (   )

Returns an Array of Images Returns: array; public

tx_commerce_article::getOrdernumber (   )

Returns: string ordernumber public

tx_commerce_article::getParentProductUid (   )

returns the parent Product Uid See also: tx_commerce_product Returns: uid of tx_commerce_products

tx_commerce_article::getPossiblePriceUids (   )

Get Article all possivle prices as UDI Array Returns: array or priceUid

tx_commerce_article::getPriceObj (   )

Get the price Object Returns: object price

tx_commerce_article::getPriceScaleObjects (  $  startCount = 1  )

Get Article price scales Parameters: $startcount  Count where to start with teh listing of the sacles, default 1 Returns: array or prices grouped by the different scales

tx_commerce_article::getPriceScales (  $  startCount = 1  )

Get Article price scales Parameters: $startcount  Count where to start with th listing of the sacles, default 1 Returns: array or priceUid grouped by the different scales

tx_commerce_article::getPriceUid (   )

Returns the price Uid Returns: Uid of tx_commerce_price See also: tx_commerce_price Since: 11.10.05

tx_commerce_article::getPricsScaleObjects (  $  startCount = 1  )

Get Article price scales Parameters: $startcount  Count where to start with teh listing of the sacles, default 1 Deprecated: See also: getPriceScaleObjects()

tx_commerce_article::getRelatedPage (   )

Returns the related page for the product Returns: int; public

tx_commerce_article::getSpecialPrice (   )

returns the default price Object, which doesn't have any start or stoptime Since: 03.01.2007 Check Class valiable article_loaded for more performace Author: Volker Graubaum Returns: the price_uid

tx_commerce_article::getStock (  $  subType = '', $  serviceChain = array() )

Returns the number of articles in Stock with calling one or more Services. if no Service is found or the hasStock Method is not implemented in Service, it always returns one. Parameters: $serviceChain=array()  mixed List of service keys which should be exluded in the search for a service. Array or comma list. $subType=''  string Sub type like file extensions or similar. Defined by the service. Returns: integer amount of articles in stock

tx_commerce_article::getSubtitle (   )

Returns: string subtitle public

tx_commerce_article::getSupplierName (   )

returns the Supplier Name of an Article, if set Author: Ingo Schmitt <is@marketing-factory.de> Returns: string Name of the supplier

tx_commerce_article::getSupplierUid (   )

Returns the Supplier UID of the Article if set Author: Joerg Sprung <jsp@marketing-factory.de> Returns: integer UID of supplier

tx_commerce_article::hasStock (  $  wantedArticles = 0, $  subType = '', $  serviceChain = array() )

Returns the avalibility of wanted amount of articles. Parameters: $wantedArticles  = 0 Integer amount of Articles which should be added to basket $serviceChain=array()  mixed List of service keys which should be exluded in the search for a service. Array or comma list. $subType=''  string Sub type like file extensions or similar. Defined by the service. Returns: boolean avalibility of wanted amount of articles

tx_commerce_article::init (  $  uid, $  lang_uid = 0 )

Init Method, called by constructor Parameters: uid  integer uid of article lang_uid  integer language uid, default 0

tx_commerce_article::load_data (   )

Loads the data and divides comma sparated images in array public Returns: void Reimplemented from tx_commerce_element_alib.

tx_commerce_article::load_prices (   )

Gets the price of this article and stores in private variable Since: 28.08.2005 Check Class valiable article_loaded for more performace Author: Volker Graubaum Returns: the price_uid

tx_commerce_article::reduceStock (  $  wantedArticles = 0, $  subType = '', $  serviceChain = array() )

substract the wanted Articles from stock. If you have more than one stock which is handled to more than one Service please implement the Service due to Reference on $wantedArticles so you can reduce this amount steplike. Parameters: $wantedArticles  = 0 Integer amount of Articles which should reduced from stock $serviceChain=array()  mixed List of service keys which should be exluded in the search for a service. Array or comma list. $subType=''  string Sub type like file extensions or similar. Defined by the service. Returns: boolean Decribes the result of going through the chains

tx_commerce_article::returnAssocArray (  $  prefix = ''  )

Returns the data of this object als array Parameters: prefix  Prefix for the keys or returnung array optional Returns: array Assoc Arry of data public Since: 2006 07 27 Reimplemented from tx_commerce_element_alib.

---

Member Data Documentation

tx_commerce_article::$article_type_uid

tx_commerce_article::$classname

tx_commerce_article::$deliveryCostGross

tx_commerce_article::$deliveryCostNet

tx_commerce_article::$description_extra

tx_commerce_article::$eancode

tx_commerce_article::$images = array()

tx_commerce_article::$images_array = array()

tx_commerce_article::$ordernumber

tx_commerce_article::$price

Price object private

tx_commerce_article::$price_uid

uid from actual article price private

tx_commerce_article::$prices_loaded = false

if the price is loaded from the database private

tx_commerce_article::$prices_uids = array()

List of all price uids concerning this article private

tx_commerce_article::$stock = true

tx_commerce_article::$subtitle

tx_commerce_article::$tax

tx_commerce_article::$title

---

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

• C:/develop/projects/t3shop/typo3conf/ext/commerce/lib/class.tx_commerce_article.php

---