VirtueMartModelCustom Class Reference

Inheritance diagram for VirtueMartModelCustom:

Collaboration diagram for VirtueMartModelCustom:

Public Member Functions
	__construct ()
	getCustom ($id=0)
	getCustoms ($custom_parent_id, $search=false)
	displayCustomSelection ()
	getCustomsList ($publishedOnly=FALSE)
	getParentList ($excludedId=0)
	createClone ($id)
	saveChildCustomRelation ($table, $datas)
	store (&$data)
	remove ($ids)
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	getCustomTypes ()
static	setParameterableByFieldType (&$table, $type, $custom_element=0, $custom_jplugin_id=0)
static	getVarsToPush ($type)
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

VirtueMartModelCustom::__construct

(

)

constructs a VmModel setMainTable defines the maintable of the model

Author

Max Milbers

Member Function Documentation

VirtueMartModelCustom::createClone

(

$id

)

Creates a clone of a given custom id

Author

Max Milbers

Parameters

int

$virtuemart_product_id

VirtueMartModelCustom::displayCustomSelection

(

)

Displays a possibility to select created custom

Author

Max Milbers

Patrick Kohl

VirtueMartModelCustom::getCustom

(

$id = 0

)

Gets a single custom by virtuemart_custom_id

Parameters

string	$type
string	$mime	mime type of custom, use for exampel image

Returns

customobject

VirtueMartModelCustom::getCustoms	(		$custom_parent_id,
			$search = false
	)

Retrieve a list of customs from the database. This is meant only for backend use

Author

Kohl Patrick

Max Milbers

Returns

object List of custom objects

VirtueMartModelCustom::getCustomsList

(

$publishedOnly = FALSE

)

Retrieve a list of layouts from the default and chosen templates directory.

We may use here the getCustoms function of the custom model or write something simular

Author

Max Milbers

Parameters

name	of the view

Returns

object List of flypage objects

static VirtueMartModelCustom::getCustomTypes ( )

static

Returns

autorized Types of data

VirtueMartModelCustom::getParentList

(

$excludedId = 0

)

Enter description here ...

Parameters

unknown_type

$excludedId

Returns

unknown|multitype:

static VirtueMartModelCustom::getVarsToPush (   $type )

static

VirtueMartModelCustom::remove

(

$ids

)

Delete all record ids selected

Author

Max Milbers

Returns

boolean True is the delete was successful, false otherwise.

VirtueMartModelCustom::saveChildCustomRelation	(		$table,
			$datas
	)

static VirtueMartModelCustom::setParameterableByFieldType ( &  $table,   $type,   $custom_element = 0,   $custom_jplugin_id = 0  )

static

Sets the xParams field and $varsToPush to the used table object, called in the store functions Customfields::storeProductCustomfields and custom store

Parameters

	$table
	$type
int	$custom_element
int	$custom_jplugin_id

VirtueMartModelCustom::store

(

&

$data

)

---

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

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