VirtueMartModelInvoice Class Reference

Inheritance diagram for VirtueMartModelInvoice:

Collaboration diagram for VirtueMartModelInvoice:

Public Member Functions
	__construct ()
	createReferencedInvoiceNumber ($orderId, $orderDetails=false, $layout= 'invoice')
	createNewInvoiceNumber ($orderDetails, &$invoiceNumber)
	createStoreNewInvoiceNumberById ($orderId, $orderDetails=false)
	createStoreNewInvoiceNumber ($orderDetails)
	getInvoiceNumbers ($virtuemart_order_id)
	hasInvoice ($order_id)
	getOrder ($orderId)
	renameInvoice ($order_id)
Public Member Functions inherited from VmModel
	__construct ($cidName='cid', $config=array())
	setDebugSql ($b)
	getName ()
	setState ($property, $value=null)
	getState ($property=null, $default=null)
	getTable ($name= '', $prefix= 'Table', $options=array())
	setIdName ($idName)
	getIdName ()
	getId ()
	setId ($id)
	setMainTable ($maintablename, $maintable=0)
	getDefaultOrdering ()
	addvalidOrderingFieldName ($add)
	removevalidOrderingFieldName ($name)
	setDefaultValidOrderingFields ($defaultTable=null)
	_getOrdering ($preTable='')
	checkFilterOrder ($toCheck, $view=0, $task= '')
	checkValidOrderingFieldName ($toCheck)
	checkFilterDir ($toCheck, $view=0, $task= '')
	getPagination ($perRow=5)
	setPaginationLimits ()
	getTotal ()
	setGetCount ($withCount)
	exeSortSearchListQuery ($object, $select, $joinedTables, $whereString= '', $groupBy= '', $orderBy= '', $filter_order_Dir= '', $nbrReturnProducts=false)
	emptyCache ()
	getData ($id=0)
	store (&$data)
	remove ($ids)
	setToggleName ($togglesName)
	toggle ($field, $val=NULL, $cidname=0, $tablename=0, $view=false)
	move ($direction, $filter=null)
	saveorder ($cid=array(), $order, $filter=null)
	addImages ($obj, $limit=0)
	resetErrors ()
Public Member Functions inherited from vObject
	__toString ()
	get ($prop, $def=null)
	set ($prop, $value=null)
	setProperties ($props)

Static Public Member Functions
static	needInvoiceByOrderstatus ($order_status, $confName= 'inv_os', $def=array('C'))
static	checkInvoiceExists ($invoiceNumber, $layout)
static	checkCreateInvoiceNumber ($orderId, $order, $layout= 'invoice')
static	hashOrder ($order)
static	getInvoiceNumber ($virtuemart_order_id)
static	getInvoiceEntry ($virtuemart_order_id, $last=true, $select= '`invoice_number`')
static	getInvoicePath ()
Static Public Member Functions inherited from VmModel
static	addTablePath ($path)
static	addIncludePath ($path= '', $prefix= '')
static	getInstance ($type, $prefix= '', $config=array())
static	getModel ($name=false)
static	joinLangTables ($tablename, $prefix, $on, $method=0)
static	joinLangSelectFields ($langFields, $as=true)
static	joinLangLikeFields ($langFields, $keyword)
static	joinLangLikeField ($searchField, $keyword)

Additional Inherited Members
Public Attributes inherited from VmModel
	$_id = 0
	$_data = null
	$_query = null
	$_total = null
	$_pagination = 0
	$_limit = 0
	$_limitStart = 0
	$_maintable = ''
	$_maintablename = ''
	$_idName = ''
	$_cidName = 'cid'
	$_togglesName = null
	$_selectedOrderingDir = 'DESC'
	$_noLimit = false
	$_tablePreFix = ''
	$_validOrderingFieldName = array()
	$_validFilterDir = array('ASC','DESC')
Protected Member Functions inherited from VmModel
	populateState ()
	_createTable ($name, $prefix= 'Table', $config=array())
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
Static Protected Member Functions inherited from VmModel
static	_createFileName ($type, $parts=array())
Protected Attributes inherited from VmModel
	$__state_set = null
	$name
	$option = null
	$state
	$event_clean_cache = null
	$_maxItems = 1000

Constructor & Destructor Documentation

VirtueMartModelInvoice::__construct

(

)

constructs a VmModel setMainTable defines the maintable of the model

Member Function Documentation

static VirtueMartModelInvoice::checkCreateInvoiceNumber (   $orderId,   $order,   $layout = 'invoice'  )

static

Checks if we need a new invoice and therefore, if we need a new invoice number Actually at the moment unused

Parameters

	$orderId
bool	$orderDetails

static VirtueMartModelInvoice::checkInvoiceExists (   $invoiceNumber,   $layout  )

static

VirtueMartModelInvoice::createNewInvoiceNumber	(		$orderDetails,
		&	$invoiceNumber
	)

returns true if an invoice number has been created returns false if an invoice number has not been created due to some configuration parameters

VirtueMartModelInvoice::createReferencedInvoiceNumber	(		$orderId,
			$orderDetails = false,
			$layout = 'invoice'
	)

VirtueMartModelInvoice::createStoreNewInvoiceNumber

(

$orderDetails

)

VirtueMartModelInvoice::createStoreNewInvoiceNumberById	(		$orderId,
			$orderDetails = false
	)

static VirtueMartModelInvoice::getInvoiceEntry (   $virtuemart_order_id,   $last = true,   $select = '`invoice_number`'  )

static

Author

Valérie Isaksen

Max Milbers

static VirtueMartModelInvoice::getInvoiceNumber (   $virtuemart_order_id )

static

Author

Valérie Isaksen

Max Milbers

Deprecated:

: use the function VirtueMartModelOrders::getInvoiceEntry instead

VirtueMartModelInvoice::getInvoiceNumbers

(

$virtuemart_order_id

)

static VirtueMartModelInvoice::getInvoicePath ( )

static

VirtueMartModelInvoice::getOrder

(

$orderId

)

static VirtueMartModelInvoice::hashOrder (   $order )

static

VirtueMartModelInvoice::hasInvoice

(

$order_id

)

has Invoice

Author

Valérie Isaksen

Parameters

$order_id

Id of the order

Returns

false if there is no invoice, $invoiceTable otherwise

static VirtueMartModelInvoice::needInvoiceByOrderstatus (   $order_status,   $confName = 'inv_os',   $def = array('C')  )

static

VirtueMartModelInvoice::renameInvoice

(

$order_id

)

Rename Invoice (when an order is deleted)

Author

Valérie Isaksen

Max Milbers

Parameters

$order_id

Id of the order

Returns

boolean true if deleted successful, false if there was a problem

---

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

• administrator/components/com_virtuemart/models/invoice.php