VirtueMartModelMedia Class Reference

Inheritance diagram for VirtueMartModelMedia:

Collaboration diagram for VirtueMartModelMedia:

Public Member Functions
	__construct ()
	getFile ($type=0, $mime=0)
	createMediaByIds ($virtuemart_media_ids, $type='', $mime='', $limit=0)
	createVoidMedia ($type, $mime)
	getFiles ($onlyPublished=false, $noLimit=false, $virtuemart_product_id=null, $cat_id=null, $where=array(), $nbr=false)
	storeMedia ($dataI, $type)
	store (&$data)
	attachImages ($objects, $type, $mime='', $limit=0)
	remove ($ids)
	removeFiles ($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)

Additional Inherited Members
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)
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

VirtueMartModelMedia::__construct

(

)

constructs a VmModel setMainTable defines the maintable of the model

Author

Max Milbers

Member Function Documentation

VirtueMartModelMedia::attachImages	(		$objects,
			$type,
			$mime = '',
			$limit = 0
	)

VirtueMartModelMedia::createMediaByIds	(		$virtuemart_media_ids,
			$type = '',
			$mime = '',
			$limit = 0
	)

Kind of getFiles, it creates a bunch of image objects by an array of virtuemart_media_id

Author

Max Milbers

Parameters

int	$virtuemart_media_id
string	$type
string	$mime

VirtueMartModelMedia::createVoidMedia	(		$type,
			$mime
	)

VirtueMartModelMedia::getFile	(		$type = 0,
			$mime = 0
	)

Gets a single media by virtuemart_media_id must be adjusted to new pattern, using first param as id to get

Parameters

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

Returns

mediaobject

VirtueMartModelMedia::getFiles	(		$onlyPublished = false,
			$noLimit = false,
			$virtuemart_product_id = null,
			$cat_id = null,
			$where = array(),
			$nbr = false
	)

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

Author

Max Milbers

Parameters

boolean	$onlyPublished	True to only retrieve the published files, false otherwise
boolean	$noLimit	True if no record count limit is used, false otherwise

Returns

object List of media objects

VirtueMartModelMedia::remove

(

$ids

)

VirtueMartModelMedia::removeFiles

(

$ids

)

VirtueMartModelMedia::store

(

&

$data

)

Store an entry of a mediaItem, this means in end effect every media file in the shop images, videos, pdf, zips, exe, ...

Author

Max Milbers

VirtueMartModelMedia::storeMedia	(		$dataI,
			$type
	)

This function stores a media and updates then the refered table

Author

Max Milbers

Patrick Kohl

Parameters

array	$data	Data from a from
string	$type	type of the media category,product,manufacturer,shop, ...

---

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

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