Report_Asset_Statuses Class Reference

Inheritance diagram for Report_Asset_Statuses:

Public Member Functions
	__construct ($assetid=0)
	getAssetMapLinks ()
	getLinks ($assetid, $link_types, $type_code='', $strict_type_code=TRUE, $side_of_link='major', $sort_by=NULL)
	getParents ($assetid, $type_code='', $strict_type_code=TRUE)
	getChildren ($assetid, $type_code='', $strict_type_code=TRUE, $dependant=NULL, $sort_by=NULL)
	getLineageFromURL ($assetid, $protocol, $url)
	setPermission ($assetid, $userid, $permission, $granted)
	deletePermission ($assetid, $userid, $permission)
	getAssetInfo ($assetids, $type_code=Array(), $strict_type_code=TRUE, $field='')
	assetExists ($assetids)
	getLink ($assetid, $link_type=NULL, $type_code='', $strict_type_code=TRUE, $value=NULL, $side_of_link='major', $exclusive=NULL)
	getLinkById ($linkid, $assetid=0, $side_of_link='major')
	countLinks ($assetid, $side_of_link='major', $link_types=0, $type_code='', $strict_type_code=TRUE, $ignore_linkid=0)
	getLinkByAsset ($assetid, $other_assetid, $link_types=NULL, $value=NULL, $side_of_link='major', $force_array=FALSE, $dependant=NULL, $exclusive=NULL)
	getAllChildLinks ($assetid, $link_type=0)
	updateLink ($linkid, $link_type=NULL, $value=NULL, $sort_order=NULL)
	deleteAssetLink ($linkid, $moving=FALSE)
	createAssetLink (&$major, &$minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE)
Public Member Functions inherited from Report
	__construct ($assetid=0)
	lockTypes ()
	_getAllowedLinks ()
	printBody ()
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 ()

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
Protected Member Functions inherited from Report
	_getName ($short_name=FALSE, $contextid=NULL)

Detailed Description

Definition at line 32 of file report_asset_statuses.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 42 of file report_asset_statuses.inc.

Member Function Documentation

assetExists

(

$assetids

)

Determine if the passed assetid or assetids refer(s) to a valid asset in the system

Note that this will always return FALSE if you pass it a shadow asset

Parameters

mixed

$assetids

the ID of the asset we are going to the check for existence or an array of assetids we want to check

Returns

mixed boolean|array public

Definition at line 223 of file report_asset_statuses.inc.

countLinks	(		$assetid,
			$side_of_link = 'major',
			$link_types = 0,
			$type_code = '',
			$strict_type_code = TRUE,
			$ignore_linkid = 0
	)

Return the number of links in the system that involve the specified asset

Can be restricted by either link type afnd/or asset type code

Parameters

int	$assetid	id of the the $side_of_link asset
string	$side_of_link	Which side of the link this (the current) asset is on ('major' or 'minor')
int	$link_types	integer that can be the product of bitwise operations on the SQ_LINK_* constants
mixed	$type_code	the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes
int	$ignore_linkid	ignore the link represented by this link id when returning the count

Returns

int public

Definition at line 297 of file report_asset_statuses.inc.

createAssetLink	(	&	$major,
		&	$minor,
			$link_type,
			$value = '',
			$sort_order = NULL,
			$dependant = '0',
			$exclusive = '0',
			$moving = FALSE
	)

Create a link between the two supplied assets

Parameters

object	&$major	the major asset that we are linking from
object	&$minor	the minor asset that we are linking to
string	$link_type	the type of link this is
string	$value	the value that is to be associated with this link
string	$sort_order	the position in the links list that this link should take, if null or less than zero places at end of list
string	$dependant	'0' / '1' - whether the minor asset is dependant on the major
string	$exclusive	'0' / '1' - whether the major asset is to be the minor's only parent
boolean	$moving	whether or not this asset is being moved

Returns

int public

Definition at line 400 of file report_asset_statuses.inc.

deleteAssetLink	(		$linkid,
			$moving = FALSE
	)

Remove a link by id

Parameters

int	$linkid	the link id of the link to remove
boolean	$moving	TRUE if this delete is part of a move operation

Returns

boolean public

Definition at line 377 of file report_asset_statuses.inc.

deletePermission	(		$assetid,
			$userid,
			$permission
	)

Deletes a permission with the passed user or user_group

Parameters

int	$assetid	the assetid for asset whose permissions to delete
int	$userid	the id of the user or user_group to remove the permission from
string	$permission	the permission code you are deleting

Returns

boolean public

Definition at line 184 of file report_asset_statuses.inc.

getAllChildLinks	(		$assetid,
			$link_type = 0
	)

Get details of the links from the specified asset to all its children

Parameters

string	$assetid	the assetid of the asset to find the child links for
int	$link_type	the type of links to get

Returns

array public

Definition at line 340 of file report_asset_statuses.inc.

getAssetInfo	(		$assetids,
			$type_code = Array(),
			$strict_type_code = TRUE,
			$field = ''
	)

Returns an array of information about assets of the passed codes

If one value in $field then the return value is Array(assetid => '[field]'), otherwise Array(assetid => Array())

Parameters

array	$assetids	an array of assets to limit
mixed	$type_code	an asset type code, or array of typecodes, to limit results to
boolean	$strict_type_code	ensure returned assets are of the passed type codes
string	$field	single field from the asset table to return (along with the assetid) Default is all fields

Returns

array public

Definition at line 205 of file report_asset_statuses.inc.

getAssetMapLinks

(

)

Return all links in a format the asset map can read

Returns

array public

Definition at line 55 of file report_asset_statuses.inc.

getChildren	(		$assetid,
			$type_code = '',
			$strict_type_code = TRUE,
			$dependant = NULL,
			$sort_by = NULL
	)

Get all asset ids that are below the passed assetid in the various trees in which it exists

Parameters

int	$assetid	the id of the asset to get its children for
string | array	$type_code	the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes
boolean	$dependant	if TRUE, results will be filtered to assets that are dependants. If FALSE, results will all not be dependants. If NULL, results will not be filtered
string	$sort_by	a field in the asset table you would like the results sorted by (eg. name, short_name etc)

Returns

array public

See Also

Asset_Manager::getChildren()

Definition at line 131 of file report_asset_statuses.inc.

getLineageFromURL	(		$assetid,
			$protocol,
			$url
	)

Returns an array of assetid's + info in the order that they propogate out from THIS BRIDGE'S url

Parameters

string	$assetid	the id of the last asset in the lineage
string	$protocol	the protocol to match -> null means it is ignored
string	$url	the url to check for -> null defaults it to current url

Returns

array public

Definition at line 149 of file report_asset_statuses.inc.

getLink	(		$assetid,
			$link_type = NULL,
			$type_code = '',
			$strict_type_code = TRUE,
			$value = NULL,
			$side_of_link = 'major',
			$exclusive = NULL
	)

Get details of a link with the specified characteristics

Parameters

int	$assetid	id of the the $side_of_link asset
int	$link_type	integer that should be a single integer of the SQ_LINK_* constants
mixed	$type_code	the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding an asset that is just a $type_code or potentially an inherited type or $type_code and any of it's sub-classes
string	$value	the value that is associated with this link
string	$side_of_link	Which side of the link this (the current) asset is on ('major' or 'minor')
boolean	$exclusive	The exclusive status for the link must be this (if not null)

Returns

array public

Definition at line 251 of file report_asset_statuses.inc.

getLinkByAsset	(		$assetid,
			$other_assetid,
			$link_types = NULL,
			$value = NULL,
			$side_of_link = 'major',
			$force_array = FALSE,
			$dependant = NULL,
			$exclusive = NULL
	)

Get details of the link(s) between the two specified assets

Parameters

int	$assetid	id of the the $side_of_link asset
int	$other_assetid	the asset on the other side of the link
int	$link_types	integer that can be the product of bitwise operations on the SQ_LINK_* constants
string	$value	the value that is associated with this link
string	$side_of_link	Which side of the link the first assetid is on ('major' or 'minor')
boolean	$force_array	force the results to return an array of links even if there is only one link
boolean	$dependant	The dependant status for all the links must be this (if not null)
boolean	$exclusive	The exclusive status for all the links must be this (if not null)

Returns

array public

Definition at line 324 of file report_asset_statuses.inc.

getLinkById	(		$linkid,
			$assetid = 0,
			$side_of_link = 'major'
	)

Get details of the link with specified linkid

Parameters

int	$linkid	id of the link were returning
int	$assetid	id of the the $side_of_link asset if zero no check is made and both major and minor information is returned
string	$side_of_link	Which side of the link the asset represented by $assetid is on ('major' or 'minor')

Returns

array public

Definition at line 269 of file report_asset_statuses.inc.

getLinks	(		$assetid,
			$link_types,
			$type_code = '',
			$strict_type_code = TRUE,
			$side_of_link = 'major',
			$sort_by = NULL
	)

Return all links that this asset has to other assets

Parameters

int	$assetid	id of the the $side_of_link asset
int	$link_types	integer that can be the product of bitwise operations on the SQ_LINK_* constants
string | array	$type_code	the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes
string	$side_of_link	Which side of the link this (the current) asset is on ('major' or 'minor')
string	$sort_by	a field in the asset table you would like the results sorted by (eg. name, short_name etc)

Returns

array public

See Also

Asset_Manager::getLinks()

Definition at line 83 of file report_asset_statuses.inc.

getParents	(		$assetid,
			$type_code = '',
			$strict_type_code = TRUE
	)

Get all asset ids that are above the passed assetid in the various trees in which it exists

Parameters

int	$assetid	the id of the asset to get its parents for
string | array	$type_code	the type of asset that is linked (eg 'User', 'User_Group', etc) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes

Returns

array public

See Also

Asset_Manager::getParents()

Definition at line 103 of file report_asset_statuses.inc.

setPermission	(		$assetid,
			$userid,
			$permission,
			$granted
	)

Sets a permission for the passed user or user_group

Parameters

int	$assetid	the assetid for asset whose permissions to set
int	$userid	the id of the user or user_group to add the permission for
string	$permission	the permission code you are adding
boolean	$granted	whether this permission grants access or not

Returns

boolean public

Definition at line 167 of file report_asset_statuses.inc.

updateLink	(		$linkid,
			$link_type = NULL,
			$value = NULL,
			$sort_order = NULL
	)

Update the details of an existing link

If any of the detail vars are NULL they are not updated.

Parameters

int	$linkid	the link id of the link to update
int	$link_type	the type of the link (one of the SQ_LINK_* constants)
string	$value	the value to place on the link
int	$sort_order	the position in the links list that this link should take, if less than zero places at end of list

Returns

boolean public

Definition at line 361 of file report_asset_statuses.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/cms/reports/report_asset_statuses/report_asset_statuses.inc