Product Class Reference

Inheritance diagram for Product:

Public Member Functions
	__construct ($assetid=0)
	__wakeup ()
	_loadVars ()
	setAttrValue ($name, $value)
	printFrontend ()
	printBody ()
	processSelection ()
	getActiveCartAssetid ()
	getAssetKeywords ($descriptions=FALSE)
	getPrice ()
Public Member Functions inherited from Page
	__construct ($assetid=0)
	_getAllowedLinks ()
	printBody ()
Public Member Functions inherited from Asset
	Asset ($assetid=0)
	create (Array &$link)
	load ($assetid)
	_loadDataPaths ()
	reload ()
	canDelete ()
	delete ($release_lock=TRUE, $check_locked=TRUE)
	useSystemVersion ()
	loadSystemVersion ()
	saveSystemVersion ()
	clearSystemVersion ()
	revertToSystemVersion ()
	revertNoticeLinksToSystemVersion ()
	_updated ($update_parents=TRUE)
	type ()
	getTypeAncestors ($include_asset=TRUE)
	incrementVersion ($number='micro', $update_parents=TRUE)
	getLanguages ()
	setLanguages (Array $languages)
	setCharset ($charset)
	setForceSecure ($force_secure)
	remapAssetids (Array $map)
	morph ($new_type_code)
	_morphCleanup ($new_type_code)
	onRequestKeywords (Asset $broadcaster, Array $vars=Array())
	canClone ()
	cloneComponents (Asset $clone, Array $components, $override=FALSE)
	cloneComponentsAdditional (Asset $clone, Array $components)
	cloneLinks (Asset $clone)
	getStatus ()
	getAvailableStatii ()
	getStatusDescription ()
	processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)
	setDate ($date_type, $time=NULL, $userid=NULL)
	lockTypes ()
	canForceablyAcquireLock ($lock_type)
	getEditingLocks ($keywords)
	_getAllowedLinks ()
	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)
	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	canCreateLink (Asset $minor, $link_type, $exclusive)
	canMoveLink (Asset $minor, Asset $old_major, $link_type)
	describeLink ($linkid)
	isDeletableLink ($linkid)
	canDeleteLink ($linkid)
	deleteLink ($linkid, $check_locked=TRUE)
	linksUpdated ()
	canCloneLink ()
	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)
	setAttrValue ($name, $value)
	attr ($name)
&	attrByRef ($name)
	getAttribute ($name, $mute_errors=FALSE)
	getAssetKeywords ($descriptions=FALSE)
	getAvailableKeywords ()
	getKeywordReplacement ($keyword)
	getAssetWebPathKeywordReplacement ()
	getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)
	processCustomKeywords ($keywords=Array())
	getContent ()
	setContent ()
	getEffectiveLastUpdatedTime ($assetids)
	readAccess (Array $assetids=Array())
	writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)
	adminAccess ($lock_type='', Array $assetids=Array())
	backendAccess ()
	liveEditAccess ($lock_type)
	canliveEdit ($lock_type)
	effectiveUnrestricted ()
	checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)
	accessEffective ()
	permissionsUpdated ()
	printFrontend ()
	printFrontendAsset (Asset $asset, $design=NULL)
	getValidProtocols ()
	printHead ()
	printBody ()
	getCurrentPaintLayoutName ()
	getCurrentDesignName ()
	printBodyWithPaintLayout ($layout_id='')
	initLimbo ()
	printLimbo ()
	paintBackend (Backend_Outputter $o)
	getPrefix ()
	processBackend (Backend_Outputter $o, Array &$link)
	getEI ()
	getEditFns ()
	getBackendHref ($screen='', $backend_page=TRUE)
	getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)
	getURLs ()
	getHref ($base_url=NULL, $ignore_rollback=FALSE)
	getWebDataPath ()
	getWebPaths ()
	saveWebPaths ($paths, $auto_add_remaps=TRUE)
	getLookups ($field='')
	getDesignLookups ()
	getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)
	deleteLookupValue ($layout_name, $layout_value)
	setPaintLayouts ($layouts)
	updateLookups ($auto_add_remaps=TRUE)
	setLookupValues (Array $values)
	getAssetStatusDescriptionKeywordReplacement ()
	getAssetStatusColourKeywordReplacement ()
	replaceKeywordsInString ($string)
	fastTrack ($tasks)
	unFastTrack ($tasks)
	shouldFastTrack ($task, $assetid=NULL)
	getFaskTrackedTaskAssetids ($task)
	getDependantParentsURL ()
Public Member Functions inherited from MySource_Object
	MySource_Object ()
	__sleep ()
	__wakeup ()

Protected Member Functions
	_getName ($short_name=FALSE, $contextid=NULL)
Protected Member Functions inherited from Page
	_preCreateCheck (Array &$link)
	_createAdditional (Array &$link)
	_getName ($short_name=FALSE)
Protected Member Functions inherited from Asset
	_preCreateCheck (Array &$link)
	_createAdditional (Array &$link)
	_abortCreate ($trigger_level_changed=FALSE, $linkid=0)
	_loadVars ()
	_getName ($short_name=FALSE, $contextid=NULL)
	_getKeywordReplacement ($keyword)
	_checkPermissionAccess ($perm, $assetids=Array(), $only_workflow=TRUE)
	makeAndSaveInitialWebPath ($path, $parent_link=NULL)

Additional Inherited Members
Data Fields inherited from Asset
	$id = 0
	$version = ''
	$name = ''
	$short_name = ''
	$status
	$languages = ''
	$charset = ''
	$force_secure = '0'
	$created
	$created_userid
	$updated
	$updated_userid
	$published
	$published_userid
	$status_changed
	$status_changed_userid
	$_is_cacheable = FALSE
	$vars = Array()
	$_available_keywords = Array()
	$data_path_suffix = ''
	$data_path = ''
	$data_path_public = ''
	$_ser_attrs = FALSE

Detailed Description

Definition at line 32 of file product.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Returns

void public

Definition at line 44 of file product.inc.

Member Function Documentation

__wakeup

(

)

Wakeup.

It's important to load components when restored from a serialised state by Deja Vu.

public

Definition at line 60 of file product.inc.

_getName (   $short_name = FALSE,   $contextid = NULL  )

protected

Returns name of the asset

Parameters

boolean	$short_name	whether or not we are after the shortname or the full name
int	$contextid	what context to return the name from

Returns

string private

See Also

Asset::_getName()

Definition at line 94 of file product.inc.

_loadVars

(

)

Load the vars for this asset/ asset type into the vars array

If the asset has no asset ID, this function just loads the default values for the asset type.

Returns

void private

Definition at line 75 of file product.inc.

getActiveCartAssetid

(

)

Get the assetid of the active cart, depending on the current lineage

Returns

mixed {string|boolean} the assetid of the active cart or false if nothing is found public

Potential useless function

Definition at line 256 of file product.inc.

getAssetKeywords

(

$descriptions = FALSE

)

Return the keywords with their replacements

The return value is in the form:

Array(
    'name' => Array (
         'value' => 'page',
         'description' => 'the asset name',
    ),
)

Parameters

boolean

$descriptions

if TRUE descriptions will be included in the array

Returns

array public

Potential useless function

Definition at line 309 of file product.inc.

getPrice

(

)

Return the product's price

Returns

array public

Implements Buyable.

Definition at line 350 of file product.inc.

printBody

(

)

Prints out the body of the asset

Returns

void public

Potential useless function

Definition at line 181 of file product.inc.

printFrontend

(

)

Prints out the Frontend for this asset it's up to the kids to override

Returns

void public

Potential useless function

Definition at line 155 of file product.inc.

processSelection

(

)

Handles finding which cart to add the order to and return a boolean indicating success

Returns

boolean public

Potential useless function

Definition at line 219 of file product.inc.

setAttrValue	(		$name,
			$value
	)

Queue the setting of the value of an attribute

Parameters

string	$name	the name of the attribute
string	$value	the new value of the attribute

Returns

boolean public

See Also

saveAttributes()

Asset::setAttrValue()

Definition at line 123 of file product.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/ecommerce/product/product.inc